Class UDDocSmallRows

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

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

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

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

Methods

Add(UDDocSmallRow)

Add one UDDocSmallRow to the collection.

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

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

The index of the added UDDocSmallRow.

AddNew()

Add a new instance of UDDocSmallRow added to the collection.

Declaration
public UDDocSmallRow AddNew()
Returns
Type Description
UDDocSmallRow

A new instance of UDDocSmallRow added to the collection.

AddRange(IEnumerable<UDDocSmallRow>)

Add a range of UDDocSmallRow to the collection.

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

The updated UDDocSmallRows collection object.

CreateChild()

Create a new instance of UDDocSmallRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of UDDocSmallRow
Overrides

CreateNew()

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

Declaration
public static UDDocSmallRows CreateNew()
Returns
Type Description
UDDocSmallRows

A new instance of the UDDocSmallRows object.

Find(Predicate<UDDocSmallRow>)

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

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

FindAll(Predicate<UDDocSmallRow>)

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

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

ForEach(Action<UDDocSmallRow>)

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

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

GetFromCustomSearch(UDDocSmallRows.CustomSearch)

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

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

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

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

GetFromIdxDouble01(Double)

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

Declaration
public static UDDocSmallRows GetFromIdxDouble01(double double01)
Parameters
Type Name Description
System.Double double01
Returns
Type Description
UDDocSmallRows

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

GetFromIdxDouble02(Double)

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

Declaration
public static UDDocSmallRows GetFromIdxDouble02(double double02)
Parameters
Type Name Description
System.Double double02
Returns
Type Description
UDDocSmallRows

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

GetFromIdxDouble03(Double)

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

Declaration
public static UDDocSmallRows GetFromIdxDouble03(double double03)
Parameters
Type Name Description
System.Double double03
Returns
Type Description
UDDocSmallRows

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

GetFromIdxDouble04(Double)

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

Declaration
public static UDDocSmallRows GetFromIdxDouble04(double double04)
Parameters
Type Name Description
System.Double double04
Returns
Type Description
UDDocSmallRows

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

GetFromIdxLong01(Int32)

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

Declaration
public static UDDocSmallRows GetFromIdxLong01(int long01)
Parameters
Type Name Description
System.Int32 long01
Returns
Type Description
UDDocSmallRows

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

GetFromIdxLong02(Int32)

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

Declaration
public static UDDocSmallRows GetFromIdxLong02(int long02)
Parameters
Type Name Description
System.Int32 long02
Returns
Type Description
UDDocSmallRows

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

GetFromIdxLong03(Int32)

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

Declaration
public static UDDocSmallRows GetFromIdxLong03(int long03)
Parameters
Type Name Description
System.Int32 long03
Returns
Type Description
UDDocSmallRows

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

GetFromIdxLong04(Int32)

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

Declaration
public static UDDocSmallRows GetFromIdxLong04(int long04)
Parameters
Type Name Description
System.Int32 long04
Returns
Type Description
UDDocSmallRows

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

GetFromIdxString01(String)

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

Declaration
public static UDDocSmallRows GetFromIdxString01(string string01)
Parameters
Type Name Description
System.String string01
Returns
Type Description
UDDocSmallRows

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

GetFromIdxString02(String)

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

Declaration
public static UDDocSmallRows GetFromIdxString02(string string02)
Parameters
Type Name Description
System.String string02
Returns
Type Description
UDDocSmallRows

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

GetFromIdxString03(String)

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

Declaration
public static UDDocSmallRows GetFromIdxString03(string string03)
Parameters
Type Name Description
System.String string03
Returns
Type Description
UDDocSmallRows

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

GetFromIdxString04(String)

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

Declaration
public static UDDocSmallRows GetFromIdxString04(string string04)
Parameters
Type Name Description
System.String string04
Returns
Type Description
UDDocSmallRows

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

GetFromReader(SoDataReader, UDDocSmallTableInfo)

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

SoDataReader positioned to a valid database row.
UDDocSmallTableInfo tableInfo

UDDocSmallTableInfo 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
UDDocSmallRows

Remove(UDDocSmallRow)

Removes the given UDDocSmallRow from the collection

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

the UDDocSmallRow to be removed

ToArray()

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

ToString()

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

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

Implements

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

Extension Methods

EnumUtil.MapEnums<From, To>(From)