Class UDContactLargeRows

User-defined fields for contact (long strings) Collection of UDContactLargeRow. Each element of the collection represents one row in the UDContactLarge table.

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

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

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

Methods

Add(UDContactLargeRow)

Add one UDContactLargeRow to the collection.

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

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

The index of the added UDContactLargeRow.

AddNew()

Add a new instance of UDContactLargeRow added to the collection.

Declaration
public UDContactLargeRow AddNew()
Returns
Type Description
UDContactLargeRow

A new instance of UDContactLargeRow added to the collection.

AddRange(IEnumerable<UDContactLargeRow>)

Add a range of UDContactLargeRow to the collection.

Declaration
public UDContactLargeRows AddRange(IEnumerable<UDContactLargeRow> rows)
Parameters
Type Name Description
IEnumerable<UDContactLargeRow> rows
Returns
Type Description
UDContactLargeRows

The updated UDContactLargeRows collection object.

CreateChild()

Create a new instance of UDContactLargeRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of UDContactLargeRow
Overrides

CreateNew()

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

Declaration
public static UDContactLargeRows CreateNew()
Returns
Type Description
UDContactLargeRows

A new instance of the UDContactLargeRows object.

Find(Predicate<UDContactLargeRow>)

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

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

FindAll(Predicate<UDContactLargeRow>)

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

Declaration
public UDContactLargeRows FindAll(Predicate<UDContactLargeRow> condition)
Parameters
Type Name Description
Predicate<UDContactLargeRow> condition
Returns
Type Description
UDContactLargeRows

ForEach(Action<UDContactLargeRow>)

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

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

GetFromCustomSearch(UDContactLargeRows.CustomSearch)

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

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

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

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

GetFromIdxString41(String)

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

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

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

GetFromIdxString42(String)

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

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

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

GetFromIdxString43(String)

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

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

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

GetFromIdxString44(String)

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

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

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

GetFromReader(SoDataReader, UDContactLargeTableInfo)

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

SoDataReader positioned to a valid database row.
UDContactLargeTableInfo tableInfo

UDContactLargeTableInfo 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
UDContactLargeRows

Remove(UDContactLargeRow)

Removes the given UDContactLargeRow from the collection

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

the UDContactLargeRow to be removed

ToArray()

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

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)