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
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class UDefFieldGLRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, INotifyCollectionChanged, IBindingList, IList, ICollection, IEnumerable
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 Save 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(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
this[int]
Get a UDefFieldGLRow given its index in the collection.
Declaration
public UDefFieldGLRow this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
int | index | Index of the UDefFieldGLRow in the collection |
Property Value
Type | Description |
---|---|
UDefFieldGLRow |
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 Save 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(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.
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 |
---|---|
int | The index of the added UDefFieldGLRow. |
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 Save 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(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.
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. |
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 Save 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(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.
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. |
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 Save 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(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.
CreateChild()
Create a new instance of UDefFieldGLRow
Declaration
protected override TableRowBase CreateChild()
Returns
Type | Description |
---|---|
TableRowBase | New instance of UDefFieldGLRow |
Overrides
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 Save 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(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.
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. |
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 Save 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(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.
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 |
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 Save 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(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.
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 |
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 Save 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(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.
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 |
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 Save 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(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.
GetFromCustomSearch(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. |
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 Save 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(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.
GetFromIdxGroupId(int)
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 |
---|---|---|
int | groupId |
Returns
Type | Description |
---|---|
UDefFieldGLRows | Row object that represents the result of the search. IsNew 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(int)
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 |
---|---|---|
int | uDefFieldId |
Returns
Type | Description |
---|---|
UDefFieldGLRows | Row object that represents the result of the search. IsNew 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 |
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 Save 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(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.
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 |
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 Save 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(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.
ToArray()
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.
Declaration
public UDefFieldGLRow[] ToArray()
Returns
Type | Description |
---|---|
UDefFieldGLRow[] |
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 Save 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(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.
ToString()
For debugging: Number of members, and the first (up to) 5 items
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string |
Overrides
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 Save 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(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.