Class UDDocLargeRows

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

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

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

Index of the UDDocLargeRow in the collection
Property Value
Type Description
UDDocLargeRow
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 UDDocLargeRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) UDDocLargeRows UDDocLargeRows.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(UDDocLargeRows.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 UDDocLargeRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, UDDocLargeTableInfo) 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).

Methods

Add(UDDocLargeRow)

Add one UDDocLargeRow to the collection.

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

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

The index of the added UDDocLargeRow.
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 UDDocLargeRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) UDDocLargeRows UDDocLargeRows.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(UDDocLargeRows.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 UDDocLargeRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, UDDocLargeTableInfo) 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).

AddNew()

Add a new instance of UDDocLargeRow added to the collection.

Declaration
public UDDocLargeRow AddNew()
Returns
Type Description
UDDocLargeRow

A new instance of UDDocLargeRow added to the collection.
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 UDDocLargeRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) UDDocLargeRows UDDocLargeRows.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(UDDocLargeRows.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 UDDocLargeRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, UDDocLargeTableInfo) 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).

AddRange(IEnumerable<UDDocLargeRow>)

Add a range of UDDocLargeRow to the collection.

Declaration
public UDDocLargeRows AddRange(IEnumerable<UDDocLargeRow> rows)
Parameters
Type Name Description
IEnumerable<UDDocLargeRow> rows
Returns
Type Description
UDDocLargeRows

The updated UDDocLargeRows collection object.
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 UDDocLargeRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) UDDocLargeRows UDDocLargeRows.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(UDDocLargeRows.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 UDDocLargeRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, UDDocLargeTableInfo) 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).

CreateChild()

Create a new instance of UDDocLargeRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of UDDocLargeRow
Overrides
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 UDDocLargeRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) UDDocLargeRows UDDocLargeRows.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(UDDocLargeRows.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 UDDocLargeRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, UDDocLargeTableInfo) 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).

CreateNew()

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

Declaration
public static UDDocLargeRows CreateNew()
Returns
Type Description
UDDocLargeRows

A new instance of the UDDocLargeRows object.
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 UDDocLargeRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) UDDocLargeRows UDDocLargeRows.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(UDDocLargeRows.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 UDDocLargeRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, UDDocLargeTableInfo) 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).

Find(Predicate<UDDocLargeRow>)

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

Declaration
public UDDocLargeRow Find(Predicate<UDDocLargeRow> condition)
Parameters
Type Name Description
Predicate<UDDocLargeRow> condition
Returns
Type Description
UDDocLargeRow
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 UDDocLargeRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) UDDocLargeRows UDDocLargeRows.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(UDDocLargeRows.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 UDDocLargeRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, UDDocLargeTableInfo) 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).

FindAll(Predicate<UDDocLargeRow>)

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

Declaration
public UDDocLargeRows FindAll(Predicate<UDDocLargeRow> condition)
Parameters
Type Name Description
Predicate<UDDocLargeRow> condition
Returns
Type Description
UDDocLargeRows
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 UDDocLargeRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) UDDocLargeRows UDDocLargeRows.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(UDDocLargeRows.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 UDDocLargeRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, UDDocLargeTableInfo) 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).

ForEach(Action<UDDocLargeRow>)

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

Declaration
public void ForEach(Action<UDDocLargeRow> whatToDo)
Parameters
Type Name Description
Action<UDDocLargeRow> whatToDo
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 UDDocLargeRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) UDDocLargeRows UDDocLargeRows.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(UDDocLargeRows.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 UDDocLargeRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, UDDocLargeTableInfo) 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).

GetFromCustomSearch(UDDocLargeRows.CustomSearch)

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

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

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

A new instance of the UDDocLargeRows object, reflecting the result of the query.
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 UDDocLargeRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) UDDocLargeRows UDDocLargeRows.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(UDDocLargeRows.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 UDDocLargeRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, UDDocLargeTableInfo) 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).

GetFromIdxString41(String)

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

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

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

GetFromIdxString42(String)

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

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

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

GetFromIdxString43(String)

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

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

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

GetFromIdxString44(String)

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

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

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

GetFromReader(SoDataReader, UDDocLargeTableInfo)

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

SoDataReader positioned to a valid database row.
UDDocLargeTableInfo tableInfo

UDDocLargeTableInfo 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
UDDocLargeRows
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 UDDocLargeRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) UDDocLargeRows UDDocLargeRows.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(UDDocLargeRows.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 UDDocLargeRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, UDDocLargeTableInfo) 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).

Remove(UDDocLargeRow)

Removes the given UDDocLargeRow from the collection

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

the UDDocLargeRow to be removed
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 UDDocLargeRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) UDDocLargeRows UDDocLargeRows.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(UDDocLargeRows.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 UDDocLargeRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, UDDocLargeTableInfo) 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).

ToArray()

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

Declaration
public UDDocLargeRow[] ToArray()
Returns
Type Description
UDDocLargeRow[]
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 UDDocLargeRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) UDDocLargeRows UDDocLargeRows.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(UDDocLargeRows.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 UDDocLargeRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, UDDocLargeTableInfo) 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).

ToString()

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

Declaration
public override string ToString()
Returns
Type Description
String
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 UDDocLargeRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) UDDocLargeRows UDDocLargeRows.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(UDDocLargeRows.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 UDDocLargeRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, UDDocLargeTableInfo) 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).

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)