Class UDefFieldGLRows

User group link table for UDefField, for MDO item hiding Collection of UDefFieldGLRow. Each element of the collection represents one row in the UDefFieldGL table.

Inheritance
Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
UDefFieldGLRows
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class UDefFieldGLRows : 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 UDefFieldGLRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) UDefFieldGLRows UDefFieldGLRows.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(UDefFieldGLRows.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 UDefFieldGLRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, UDefFieldGLTableInfo) 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 UDefFieldGLRow given its index in the collection.

Declaration
public UDefFieldGLRow this[int index] { get; }
Parameters
Type Name Description
Int32 index

Index of the UDefFieldGLRow in the collection
Property Value
Type Description
UDefFieldGLRow

Methods

Add(UDefFieldGLRow)

Add one UDefFieldGLRow to the collection.

Declaration
public int Add(UDefFieldGLRow row)
Parameters
Type Name Description
UDefFieldGLRow row

An instance of UDefFieldGLRow to be added to the collection.
Returns
Type Description
Int32

The index of the added UDefFieldGLRow.

AddNew()

Add a new instance of UDefFieldGLRow added to the collection.

Declaration
public UDefFieldGLRow AddNew()
Returns
Type Description
UDefFieldGLRow

A new instance of UDefFieldGLRow added to the collection.

AddRange(IEnumerable<UDefFieldGLRow>)

Add a range of UDefFieldGLRow to the collection.

Declaration
public UDefFieldGLRows AddRange(IEnumerable<UDefFieldGLRow> rows)
Parameters
Type Name Description
IEnumerable<UDefFieldGLRow> rows
Returns
Type Description
UDefFieldGLRows

The updated UDefFieldGLRows collection object.

CreateChild()

Create a new instance of UDefFieldGLRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of UDefFieldGLRow
Overrides

CreateNew()

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

Declaration
public static UDefFieldGLRows CreateNew()
Returns
Type Description
UDefFieldGLRows

A new instance of the UDefFieldGLRows object.

Find(Predicate<UDefFieldGLRow>)

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

Declaration
public UDefFieldGLRow Find(Predicate<UDefFieldGLRow> condition)
Parameters
Type Name Description
Predicate<UDefFieldGLRow> condition
Returns
Type Description
UDefFieldGLRow

FindAll(Predicate<UDefFieldGLRow>)

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

Declaration
public UDefFieldGLRows FindAll(Predicate<UDefFieldGLRow> condition)
Parameters
Type Name Description
Predicate<UDefFieldGLRow> condition
Returns
Type Description
UDefFieldGLRows

ForEach(Action<UDefFieldGLRow>)

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

Declaration
public void ForEach(Action<UDefFieldGLRow> whatToDo)
Parameters
Type Name Description
Action<UDefFieldGLRow> whatToDo

GetFromCustomSearch(UDefFieldGLRows.CustomSearch)

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

Declaration
public static UDefFieldGLRows GetFromCustomSearch(UDefFieldGLRows.CustomSearch query)
Parameters
Type Name Description
UDefFieldGLRows.CustomSearch query

The custom search to execute against the database
Returns
Type Description
UDefFieldGLRows

A new instance of the UDefFieldGLRows object, reflecting the result of the query.

GetFromIdxGroupId(Int32)

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

Declaration
public static UDefFieldGLRows GetFromIdxGroupId(int groupId)
Parameters
Type Name Description
Int32 groupId
Returns
Type Description
UDefFieldGLRows

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 UDefFieldGL table. Non-unique indexes have corresponding inner classes and methods in the UDefFieldGLRows collection, since they may return more than one row.

GetFromIdxUDefFieldId(Int32)

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

Declaration
public static UDefFieldGLRows GetFromIdxUDefFieldId(int uDefFieldId)
Parameters
Type Name Description
Int32 uDefFieldId
Returns
Type Description
UDefFieldGLRows

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 UDefFieldGL table. Non-unique indexes have corresponding inner classes and methods in the UDefFieldGLRows collection, since they may return more than one row.

GetFromReader(SoDataReader, UDefFieldGLTableInfo)

Create a new instance of the UDefFieldGLRows 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 UDefFieldGLRow 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 UDefFieldGLRows GetFromReader(SoDataReader reader, UDefFieldGLTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
UDefFieldGLTableInfo tableInfo

UDefFieldGLTableInfo 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
UDefFieldGLRows

Remove(UDefFieldGLRow)

Removes the given UDefFieldGLRow from the collection

Declaration
public void Remove(UDefFieldGLRow row)
Parameters
Type Name Description
UDefFieldGLRow row

the UDefFieldGLRow to be removed

ToArray()

Declaration
public UDefFieldGLRow[] ToArray()
Returns
Type Description
UDefFieldGLRow[]

ToString()

For debugging: Number of members, and the first (up to) 5 items

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)