Class CategoryRows

Category list table Collection of CategoryRow. Each element of the collection represents one row in the Category table.

Inheritance
System.Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
CategoryRows
Implements
System.Collections.Generic.IEnumerable<INestedPersist>
System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class CategoryRows : 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 CategoryRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) CategoryRows CategoryRows.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(CategoryRows.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 CategoryRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, CategoryTableInfo) 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 CategoryRow given its index in the collection.

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

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

Methods

Add(CategoryRow)

Add one CategoryRow to the collection.

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

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

The index of the added CategoryRow.

AddNew()

Add a new instance of CategoryRow added to the collection.

Declaration
public CategoryRow AddNew()
Returns
Type Description
CategoryRow

A new instance of CategoryRow added to the collection.

AddRange(IEnumerable<CategoryRow>)

Add a range of CategoryRow to the collection.

Declaration
public CategoryRows AddRange(IEnumerable<CategoryRow> rows)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<CategoryRow> rows
Returns
Type Description
CategoryRows

The updated CategoryRows collection object.

CreateChild()

Create a new instance of CategoryRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of CategoryRow
Overrides

CreateNew()

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

Declaration
public static CategoryRows CreateNew()
Returns
Type Description
CategoryRows

A new instance of the CategoryRows object.

Find(Predicate<CategoryRow>)

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

Declaration
public CategoryRow Find(Predicate<CategoryRow> condition)
Parameters
Type Name Description
System.Predicate<CategoryRow> condition
Returns
Type Description
CategoryRow

FindAll(Predicate<CategoryRow>)

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

Declaration
public CategoryRows FindAll(Predicate<CategoryRow> condition)
Parameters
Type Name Description
System.Predicate<CategoryRow> condition
Returns
Type Description
CategoryRows

ForEach(Action<CategoryRow>)

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

Declaration
public void ForEach(Action<CategoryRow> whatToDo)
Parameters
Type Name Description
System.Action<CategoryRow> whatToDo

GetFromCustomSearch(CategoryRows.CustomSearch)

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

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

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

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

GetFromReader(SoDataReader, CategoryTableInfo)

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

SoDataReader positioned to a valid database row.
CategoryTableInfo tableInfo

CategoryTableInfo 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
CategoryRows

Remove(CategoryRow)

Removes the given CategoryRow from the collection

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

the CategoryRow to be removed

ToArray()

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

ToString()

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

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

Implements

System.Collections.Generic.IEnumerable<T>
System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList

Extension Methods

EnumUtil.MapEnums<From, To>(From)