Class UserGroupRows

public class UserGroupRows : 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 UserGroupRow to it, and use methods like to operate on the whole collection.
You can create a (nested) UserGroupRows UserGroupRows.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(UserGroupRows.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 UserGroupRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, UserGroupTableInfo) 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 UserGroupRow given its index in the collection.

Declaration

public UserGroupRow this[int index] { get; }

Parameters

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

Property Value

Type	Description
UserGroupRow

Methods

Add(UserGroupRow)

Add one UserGroupRow to the collection.

Declaration

public int Add(UserGroupRow row)

Parameters

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

Returns

Type	Description
Int32	The index of the added UserGroupRow.

AddNew()

Add a new instance of UserGroupRow added to the collection.

Declaration

public UserGroupRow AddNew()

Returns

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

AddRange(IEnumerable<UserGroupRow>)

Add a range of UserGroupRow to the collection.

Declaration

public UserGroupRows AddRange(IEnumerable<UserGroupRow> rows)

Parameters

Type	Name	Description
IEnumerable<UserGroupRow>	rows

Returns

Type	Description
UserGroupRows	The updated UserGroupRows collection object.

CreateChild()

Create a new instance of UserGroupRow

Declaration

protected override TableRowBase CreateChild()

Returns

Type	Description
TableRowBase	New instance of UserGroupRow

Overrides

TableRowsBase.CreateChild()

CreateNew()

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

Declaration

public static UserGroupRows CreateNew()

Returns

Type	Description
UserGroupRows	A new instance of the UserGroupRows object.

Find(Predicate<UserGroupRow>)

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

Declaration

public UserGroupRow Find(Predicate<UserGroupRow> condition)

Parameters

Type	Name	Description
Predicate<UserGroupRow>	condition

Returns

Type	Description
UserGroupRow

FindAll(Predicate<UserGroupRow>)

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

Declaration

public UserGroupRows FindAll(Predicate<UserGroupRow> condition)

Parameters

Type	Name	Description
Predicate<UserGroupRow>	condition

Returns

Type	Description
UserGroupRows

ForEach(Action<UserGroupRow>)

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

Declaration

public void ForEach(Action<UserGroupRow> whatToDo)

Parameters

Type	Name	Description
Action<UserGroupRow>	whatToDo

GetFromCustomSearch(UserGroupRows.CustomSearch)

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

Declaration

public static UserGroupRows GetFromCustomSearch(UserGroupRows.CustomSearch query)

Parameters

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

Returns

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

GetFromReader(SoDataReader, UserGroupTableInfo)

Create a new instance of the UserGroupRows 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 UserGroupRow 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 UserGroupRows GetFromReader(SoDataReader reader, UserGroupTableInfo tableInfo)

Parameters

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