Class SequenceRows
next_id to be used for each table Collection of SequenceRow. Each element of the collection represents one row in the Sequence table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class SequenceRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IList, ICollection, IEnumerable, INotifyCollectionChanged, IBindingList
Remarks
Row collections can be created in several ways.
- Use the static CreateNew() method to create a new, empty collection. You can then add objects of type
SequenceRow to it, and use methods like
to operate on the whole collection. - You can create a (nested) SequenceRows SequenceRows.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(SequenceRows.CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
- For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Properties
Item[Int32]
Get a SequenceRow given its index in the collection.
Declaration
public SequenceRow this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | Index of the SequenceRow in the collection |
Property Value
Type | Description |
---|---|
SequenceRow |
Methods
Add(SequenceRow)
Add one SequenceRow to the collection.
Declaration
public int Add(SequenceRow row)
Parameters
Type | Name | Description |
---|---|---|
SequenceRow | row | An instance of SequenceRow to be added to the collection. |
Returns
Type | Description |
---|---|
Int32 | The index of the added SequenceRow. |
AddNew()
Add a new instance of SequenceRow added to the collection.
Declaration
public SequenceRow AddNew()
Returns
Type | Description |
---|---|
SequenceRow | A new instance of SequenceRow added to the collection. |
AddRange(IEnumerable<SequenceRow>)
Add a range of SequenceRow to the collection.
Declaration
public SequenceRows AddRange(IEnumerable<SequenceRow> rows)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<SequenceRow> | rows |
Returns
Type | Description |
---|---|
SequenceRows | The updated SequenceRows collection object. |
CreateChild()
Create a new instance of SequenceRow
Declaration
protected override TableRowBase CreateChild()
Returns
Type | Description |
---|---|
TableRowBase | New instance of SequenceRow |
Overrides
CreateNew()
Create a new instance of the SequenceRows object. This collection will contain no rows.
Declaration
public static SequenceRows CreateNew()
Returns
Type | Description |
---|---|
SequenceRows | A new instance of the SequenceRows object. |
Find(Predicate<SequenceRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public SequenceRow Find(Predicate<SequenceRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<SequenceRow> | condition |
Returns
Type | Description |
---|---|
SequenceRow |
FindAll(Predicate<SequenceRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public SequenceRows FindAll(Predicate<SequenceRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<SequenceRow> | condition |
Returns
Type | Description |
---|---|
SequenceRows |
ForEach(Action<SequenceRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<SequenceRow> whatToDo)
Parameters
Type | Name | Description |
---|---|---|
Action<SequenceRow> | whatToDo |
GetFromCustomSearch(SequenceRows.CustomSearch)
Create a new instance of the SequenceRows object, and populate it with data from a custom search. If the search returns no results, an empty collection will be returned; if the result contains rows, a collection of SequenceRow objects representing each row will be returned.
Declaration
public static SequenceRows GetFromCustomSearch(SequenceRows.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
SequenceRows.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
SequenceRows | A new instance of the SequenceRows object, reflecting the result of the query. |
GetFromReader(SoDataReader, SequenceTableInfo)
Create a new instance of the SequenceRows object, and populate it with data from a reader. If the search returns no results, an empty collection will be returned; if the result contains rows, a collection of SequenceRow objects representing each row will be returned.
Note that the internal logic starts by calling reader.Read(), which is correct if you hand the method the result of an ExecuteReader(), but if the reader has already been advanced one or more rows, the current row will be skipped and collection population will start with the next row.
Declaration
public static SequenceRows GetFromReader(SoDataReader reader, SequenceTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
SequenceTableInfo | tableInfo | SequenceTableInfo instance used in the query that is the source of the reader. The fields used from the reader will be those owned by this tableinfo object. |
Returns
Type | Description |
---|---|
SequenceRows |
Remove(SequenceRow)
Removes the given SequenceRow from the collection
Declaration
public void Remove(SequenceRow row)
Parameters
Type | Name | Description |
---|---|---|
SequenceRow | row | the SequenceRow to be removed |
ToArray()
Declaration
public SequenceRow[] ToArray()
Returns
Type | Description |
---|---|
SequenceRow[] |
ToString()
For debugging: Number of members, and the first (up to) 5 items
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
String |