Class TagsGroupLinkRows

User group link table for Tags, for MDO item hiding Collection of TagsGroupLinkRow. Each element of the collection represents one row in the TagsGroupLink table.

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

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

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

Methods

Add(TagsGroupLinkRow)

Add one TagsGroupLinkRow to the collection.

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

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

The index of the added TagsGroupLinkRow.

AddNew()

Add a new instance of TagsGroupLinkRow added to the collection.

Declaration
public TagsGroupLinkRow AddNew()
Returns
Type Description
TagsGroupLinkRow

A new instance of TagsGroupLinkRow added to the collection.

AddRange(IEnumerable<TagsGroupLinkRow>)

Add a range of TagsGroupLinkRow to the collection.

Declaration
public TagsGroupLinkRows AddRange(IEnumerable<TagsGroupLinkRow> rows)
Parameters
Type Name Description
IEnumerable<TagsGroupLinkRow> rows
Returns
Type Description
TagsGroupLinkRows

The updated TagsGroupLinkRows collection object.

CreateChild()

Create a new instance of TagsGroupLinkRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of TagsGroupLinkRow
Overrides

CreateNew()

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

Declaration
public static TagsGroupLinkRows CreateNew()
Returns
Type Description
TagsGroupLinkRows

A new instance of the TagsGroupLinkRows object.

Find(Predicate<TagsGroupLinkRow>)

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

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

FindAll(Predicate<TagsGroupLinkRow>)

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

Declaration
public TagsGroupLinkRows FindAll(Predicate<TagsGroupLinkRow> condition)
Parameters
Type Name Description
Predicate<TagsGroupLinkRow> condition
Returns
Type Description
TagsGroupLinkRows

ForEach(Action<TagsGroupLinkRow>)

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

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

GetFromCustomSearch(TagsGroupLinkRows.CustomSearch)

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

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

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

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

GetFromIdxGroupId(Int32)

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

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

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

GetFromIdxTagsId(Int32)

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

Declaration
public static TagsGroupLinkRows GetFromIdxTagsId(int tagsId)
Parameters
Type Name Description
Int32 tagsId
Returns
Type Description
TagsGroupLinkRows

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

GetFromReader(SoDataReader, TagsGroupLinkTableInfo)

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

SoDataReader positioned to a valid database row.
TagsGroupLinkTableInfo tableInfo

TagsGroupLinkTableInfo 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
TagsGroupLinkRows

Remove(TagsGroupLinkRow)

Removes the given TagsGroupLinkRow from the collection

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

the TagsGroupLinkRow to be removed

ToArray()

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

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)