Class SListElementRows

public class SListElementRows : 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 SListElementRow to it, and use methods like to operate on the whole collection.
You can create a (nested) SListElementRows SListElementRows.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(SListElementRows.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.

Unique indexes are handled through the SListElementRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SListElementTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

Properties

Item[Int32]

Get a SListElementRow given its index in the collection.

Declaration

public SListElementRow this[int index] { get; }

Parameters

Type	Name	Description
Int32	index	Index of the SListElementRow in the collection

Property Value

Type	Description
SListElementRow

Methods

Add(SListElementRow)

Add one SListElementRow to the collection.

Declaration

public int Add(SListElementRow row)

Parameters

Type	Name	Description
SListElementRow	row	An instance of SListElementRow to be added to the collection.

Returns

Type	Description
Int32	The index of the added SListElementRow.

AddNew()

Add a new instance of SListElementRow added to the collection.

Declaration

public SListElementRow AddNew()

Returns

Type	Description
SListElementRow	A new instance of SListElementRow added to the collection.

AddRange(IEnumerable<SListElementRow>)

Add a range of SListElementRow to the collection.

Declaration

public SListElementRows AddRange(IEnumerable<SListElementRow> rows)

Parameters

Type	Name	Description
IEnumerable<SListElementRow>	rows

Returns

Type	Description
SListElementRows	The updated SListElementRows collection object.

CreateChild()

Create a new instance of SListElementRow

Declaration

protected override TableRowBase CreateChild()

Returns

Type	Description
TableRowBase	New instance of SListElementRow

Overrides

TableRowsBase.CreateChild()

CreateNew()

Create a new instance of the SListElementRows object. This collection will contain no rows.

Declaration

public static SListElementRows CreateNew()

Returns

Type	Description
SListElementRows	A new instance of the SListElementRows object.

Find(Predicate<SListElementRow>)

Apply the predicate to each element of the collection and return the first row that matches; if no match then return null

Declaration

public SListElementRow Find(Predicate<SListElementRow> condition)

Parameters

Type	Name	Description
Predicate<SListElementRow>	condition

Returns

Type	Description
SListElementRow

FindAll(Predicate<SListElementRow>)

Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection

Declaration

public SListElementRows FindAll(Predicate<SListElementRow> condition)

Parameters

Type	Name	Description
Predicate<SListElementRow>	condition

Returns

Type	Description
SListElementRows

ForEach(Action<SListElementRow>)

Method that iterates over all members and applies the action parameter to each of them

Declaration

public void ForEach(Action<SListElementRow> whatToDo)

Parameters

Type	Name	Description
Action<SListElementRow>	whatToDo

GetFromCustomSearch(SListElementRows.CustomSearch)

Create a new instance of the SListElementRows 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 SListElementRow objects representing each row will be returned.

Declaration

public static SListElementRows GetFromCustomSearch(SListElementRows.CustomSearch query)

Parameters

Type	Name	Description
SListElementRows.CustomSearch	query	The custom search to execute against the database

Returns

Type	Description
SListElementRows	A new instance of the SListElementRows object, reflecting the result of the query.

GetFromIdxAddress(String)

Create a new instance of the SListElementRow object, by querying the database table via the index 'IDXS_list_elementAddress'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration

public static SListElementRows GetFromIdxAddress(string address)

Parameters

Type	Name	Description
String	address

Returns

Type	Description
SListElementRows	Row object that represents the result of the search. will be true if the query did not match any row in the table

Remarks

This method represents one of the unique indexes on the SListElement table. Non-unique indexes have corresponding inner classes and methods in the SListElementRows collection, since they may return more than one row.

GetFromIdxListId(Int32)

Create a new instance of the SListElementRow object, by querying the database table via the index 'IDXS_list_elementList_id'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration

public static SListElementRows GetFromIdxListId(int listId)

Parameters

Type	Name	Description
Int32	listId

Returns

Type	Description
SListElementRows	Row object that represents the result of the search. will be true if the query did not match any row in the table

Remarks

GetFromIdxSms(String)

Create a new instance of the SListElementRow object, by querying the database table via the index 'IDXS_list_elementSms'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration

public static SListElementRows GetFromIdxSms(string sms)

Parameters

Type	Name	Description
String	sms

Returns

Type	Description
SListElementRows	Row object that represents the result of the search. will be true if the query did not match any row in the table

Remarks

GetFromReader(SoDataReader, SListElementTableInfo)

Create a new instance of the SListElementRows 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 SListElementRow 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 SListElementRows GetFromReader(SoDataReader reader, SListElementTableInfo tableInfo)

Parameters

Type	Name	Description
SoDataReader	reader	SoDataReader positioned to a valid database row.
SListElementTableInfo	tableInfo	SListElementTableInfo 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.