Class UDPersonLargeRows

User-defined fields Collection of UDPersonLargeRow. Each element of the collection represents one row in the UDPersonLarge table.

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

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

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

Methods

Add(UDPersonLargeRow)

Add one UDPersonLargeRow to the collection.

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

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

The index of the added UDPersonLargeRow.

AddNew()

Add a new instance of UDPersonLargeRow added to the collection.

Declaration
public UDPersonLargeRow AddNew()
Returns
Type Description
UDPersonLargeRow

A new instance of UDPersonLargeRow added to the collection.

AddRange(IEnumerable<UDPersonLargeRow>)

Add a range of UDPersonLargeRow to the collection.

Declaration
public UDPersonLargeRows AddRange(IEnumerable<UDPersonLargeRow> rows)
Parameters
Type Name Description
IEnumerable<UDPersonLargeRow> rows
Returns
Type Description
UDPersonLargeRows

The updated UDPersonLargeRows collection object.

CreateChild()

Create a new instance of UDPersonLargeRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of UDPersonLargeRow
Overrides

CreateNew()

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

Declaration
public static UDPersonLargeRows CreateNew()
Returns
Type Description
UDPersonLargeRows

A new instance of the UDPersonLargeRows object.

Find(Predicate<UDPersonLargeRow>)

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

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

FindAll(Predicate<UDPersonLargeRow>)

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

Declaration
public UDPersonLargeRows FindAll(Predicate<UDPersonLargeRow> condition)
Parameters
Type Name Description
Predicate<UDPersonLargeRow> condition
Returns
Type Description
UDPersonLargeRows

ForEach(Action<UDPersonLargeRow>)

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

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

GetFromCustomSearch(UDPersonLargeRows.CustomSearch)

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

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

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

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

GetFromIdxString41(String)

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

Declaration
public static UDPersonLargeRows GetFromIdxString41(string string41)
Parameters
Type Name Description
String string41
Returns
Type Description
UDPersonLargeRows

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

GetFromIdxString42(String)

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

Declaration
public static UDPersonLargeRows GetFromIdxString42(string string42)
Parameters
Type Name Description
String string42
Returns
Type Description
UDPersonLargeRows

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

GetFromIdxString43(String)

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

Declaration
public static UDPersonLargeRows GetFromIdxString43(string string43)
Parameters
Type Name Description
String string43
Returns
Type Description
UDPersonLargeRows

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

GetFromIdxString44(String)

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

Declaration
public static UDPersonLargeRows GetFromIdxString44(string string44)
Parameters
Type Name Description
String string44
Returns
Type Description
UDPersonLargeRows

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

GetFromReader(SoDataReader, UDPersonLargeTableInfo)

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

SoDataReader positioned to a valid database row.
UDPersonLargeTableInfo tableInfo

UDPersonLargeTableInfo 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
UDPersonLargeRows

Remove(UDPersonLargeRow)

Removes the given UDPersonLargeRow from the collection

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

the UDPersonLargeRow to be removed

ToArray()

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

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)