Class TagsRows

MDO List of tags for Service entities Collection of TagsRow. Each element of the collection represents one row in the Tags table.

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

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

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

Methods

Add(TagsRow)

Add one TagsRow to the collection.

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

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

The index of the added TagsRow.

AddNew()

Add a new instance of TagsRow added to the collection.

Declaration
public TagsRow AddNew()
Returns
Type Description
TagsRow

A new instance of TagsRow added to the collection.

AddRange(IEnumerable<TagsRow>)

Add a range of TagsRow to the collection.

Declaration
public TagsRows AddRange(IEnumerable<TagsRow> rows)
Parameters
Type Name Description
IEnumerable<TagsRow> rows
Returns
Type Description
TagsRows

The updated TagsRows collection object.

CreateChild()

Create a new instance of TagsRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of TagsRow
Overrides

CreateNew()

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

Declaration
public static TagsRows CreateNew()
Returns
Type Description
TagsRows

A new instance of the TagsRows object.

Find(Predicate<TagsRow>)

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

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

FindAll(Predicate<TagsRow>)

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

Declaration
public TagsRows FindAll(Predicate<TagsRow> condition)
Parameters
Type Name Description
Predicate<TagsRow> condition
Returns
Type Description
TagsRows

ForEach(Action<TagsRow>)

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

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

GetFromCustomSearch(TagsRows.CustomSearch)

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

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

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

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

GetFromReader(SoDataReader, TagsTableInfo)

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

SoDataReader positioned to a valid database row.
TagsTableInfo tableInfo

TagsTableInfo 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
TagsRows

Remove(TagsRow)

Removes the given TagsRow from the collection

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

the TagsRow to be removed

ToArray()

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

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)