Class DocTmplGroupLinkRows

User group link table for DocTmpl, for MDO item hiding Collection of DocTmplGroupLinkRow. Each element of the collection represents one row in the DocTmplGroupLink table.

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

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

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

Methods

Add(DocTmplGroupLinkRow)

Add one DocTmplGroupLinkRow to the collection.

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

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

The index of the added DocTmplGroupLinkRow.

AddNew()

Add a new instance of DocTmplGroupLinkRow added to the collection.

Declaration
public DocTmplGroupLinkRow AddNew()
Returns
Type Description
DocTmplGroupLinkRow

A new instance of DocTmplGroupLinkRow added to the collection.

AddRange(IEnumerable<DocTmplGroupLinkRow>)

Add a range of DocTmplGroupLinkRow to the collection.

Declaration
public DocTmplGroupLinkRows AddRange(IEnumerable<DocTmplGroupLinkRow> rows)
Parameters
Type Name Description
IEnumerable<DocTmplGroupLinkRow> rows
Returns
Type Description
DocTmplGroupLinkRows

The updated DocTmplGroupLinkRows collection object.

CreateChild()

Create a new instance of DocTmplGroupLinkRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of DocTmplGroupLinkRow
Overrides

CreateNew()

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

Declaration
public static DocTmplGroupLinkRows CreateNew()
Returns
Type Description
DocTmplGroupLinkRows

A new instance of the DocTmplGroupLinkRows object.

Find(Predicate<DocTmplGroupLinkRow>)

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

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

FindAll(Predicate<DocTmplGroupLinkRow>)

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

Declaration
public DocTmplGroupLinkRows FindAll(Predicate<DocTmplGroupLinkRow> condition)
Parameters
Type Name Description
Predicate<DocTmplGroupLinkRow> condition
Returns
Type Description
DocTmplGroupLinkRows

ForEach(Action<DocTmplGroupLinkRow>)

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

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

GetFromCustomSearch(DocTmplGroupLinkRows.CustomSearch)

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

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

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

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

GetFromIdxDocTmplId(Int32)

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

Declaration
public static DocTmplGroupLinkRows GetFromIdxDocTmplId(int docTmplId)
Parameters
Type Name Description
Int32 docTmplId
Returns
Type Description
DocTmplGroupLinkRows

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

GetFromIdxGroupId(Int32)

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

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

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

GetFromReader(SoDataReader, DocTmplGroupLinkTableInfo)

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

SoDataReader positioned to a valid database row.
DocTmplGroupLinkTableInfo tableInfo

DocTmplGroupLinkTableInfo 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
DocTmplGroupLinkRows

Remove(DocTmplGroupLinkRow)

Removes the given DocTmplGroupLinkRow from the collection

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

the DocTmplGroupLinkRow to be removed

ToArray()

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

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)