Class OLEViewTextRows

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

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

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

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

Methods

Add(OLEViewTextRow)

Add one OLEViewTextRow to the collection.

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

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

The index of the added OLEViewTextRow.

AddNew()

Add a new instance of OLEViewTextRow added to the collection.

Declaration
public OLEViewTextRow AddNew()
Returns
Type Description
OLEViewTextRow

A new instance of OLEViewTextRow added to the collection.

AddRange(IEnumerable<OLEViewTextRow>)

Add a range of OLEViewTextRow to the collection.

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

The updated OLEViewTextRows collection object.

CreateChild()

Create a new instance of OLEViewTextRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of OLEViewTextRow
Overrides

CreateNew()

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

Declaration
public static OLEViewTextRows CreateNew()
Returns
Type Description
OLEViewTextRows

A new instance of the OLEViewTextRows object.

Find(Predicate<OLEViewTextRow>)

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

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

FindAll(Predicate<OLEViewTextRow>)

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

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

ForEach(Action<OLEViewTextRow>)

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

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

GetFromCustomSearch(OLEViewTextRows.CustomSearch)

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

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

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

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

GetFromIdxLanguageId(Int32)

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

Declaration
public static OLEViewTextRows GetFromIdxLanguageId(int languageId)
Parameters
Type Name Description
System.Int32 languageId
Returns
Type Description
OLEViewTextRows

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

GetFromIdxName(String)

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

Declaration
public static OLEViewTextRows GetFromIdxName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
OLEViewTextRows

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

GetFromIdxOLEViewId(Int32)

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

Declaration
public static OLEViewTextRows GetFromIdxOLEViewId(int oLEViewId)
Parameters
Type Name Description
System.Int32 oLEViewId
Returns
Type Description
OLEViewTextRows

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

GetFromIdxOLEViewIdLanguageId(Int32, Int32)

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

Declaration
public static OLEViewTextRows GetFromIdxOLEViewIdLanguageId(int oLEViewId, int languageId)
Parameters
Type Name Description
System.Int32 oLEViewId
System.Int32 languageId
Returns
Type Description
OLEViewTextRows

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

GetFromReader(SoDataReader, OLEViewTextTableInfo)

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

SoDataReader positioned to a valid database row.
OLEViewTextTableInfo tableInfo

OLEViewTextTableInfo 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
OLEViewTextRows

Remove(OLEViewTextRow)

Removes the given OLEViewTextRow from the collection

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

the OLEViewTextRow to be removed

ToArray()

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

ToString()

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

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

Implements

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

Extension Methods

EnumUtil.MapEnums<From, To>(From)