Class OLESubjectTextRows

Control data table for the OLE DB Provider Collection of OLESubjectTextRow. Each element of the collection represents one row in the OLESubjectText table.

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

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

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

Methods

Add(OLESubjectTextRow)

Add one OLESubjectTextRow to the collection.

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

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

The index of the added OLESubjectTextRow.

AddNew()

Add a new instance of OLESubjectTextRow added to the collection.

Declaration
public OLESubjectTextRow AddNew()
Returns
Type Description
OLESubjectTextRow

A new instance of OLESubjectTextRow added to the collection.

AddRange(IEnumerable<OLESubjectTextRow>)

Add a range of OLESubjectTextRow to the collection.

Declaration
public OLESubjectTextRows AddRange(IEnumerable<OLESubjectTextRow> rows)
Parameters
Type Name Description
IEnumerable<OLESubjectTextRow> rows
Returns
Type Description
OLESubjectTextRows

The updated OLESubjectTextRows collection object.

CreateChild()

Create a new instance of OLESubjectTextRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of OLESubjectTextRow
Overrides

CreateNew()

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

Declaration
public static OLESubjectTextRows CreateNew()
Returns
Type Description
OLESubjectTextRows

A new instance of the OLESubjectTextRows object.

Find(Predicate<OLESubjectTextRow>)

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

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

FindAll(Predicate<OLESubjectTextRow>)

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

Declaration
public OLESubjectTextRows FindAll(Predicate<OLESubjectTextRow> condition)
Parameters
Type Name Description
Predicate<OLESubjectTextRow> condition
Returns
Type Description
OLESubjectTextRows

ForEach(Action<OLESubjectTextRow>)

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

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

GetFromCustomSearch(OLESubjectTextRows.CustomSearch)

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

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

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

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

GetFromIdxLanguageId(Int32)

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

Declaration
public static OLESubjectTextRows GetFromIdxLanguageId(int languageId)
Parameters
Type Name Description
Int32 languageId
Returns
Type Description
OLESubjectTextRows

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

GetFromIdxName(String)

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

Declaration
public static OLESubjectTextRows GetFromIdxName(string name)
Parameters
Type Name Description
String name
Returns
Type Description
OLESubjectTextRows

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

GetFromIdxOLESubjectId(Int32)

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

Declaration
public static OLESubjectTextRows GetFromIdxOLESubjectId(int oLESubjectId)
Parameters
Type Name Description
Int32 oLESubjectId
Returns
Type Description
OLESubjectTextRows

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

GetFromIdxOLESubjectIdLanguageId(Int32, Int32)

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

Declaration
public static OLESubjectTextRows GetFromIdxOLESubjectIdLanguageId(int oLESubjectId, int languageId)
Parameters
Type Name Description
Int32 oLESubjectId
Int32 languageId
Returns
Type Description
OLESubjectTextRows

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

GetFromReader(SoDataReader, OLESubjectTextTableInfo)

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

SoDataReader positioned to a valid database row.
OLESubjectTextTableInfo tableInfo

OLESubjectTextTableInfo 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
OLESubjectTextRows

Remove(OLESubjectTextRow)

Removes the given OLESubjectTextRow from the collection

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

the OLESubjectTextRow to be removed

ToArray()

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

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)