Class UDListRows

List table for user-defined lists, contains all user-defined lists. Note - MDO mode for userdefinede lists are either turned on or off, you may not have it on for one userdefined list and off for the others. Collection of UDListRow. Each element of the collection represents one row in the UDList table.

Inheritance
System.Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
UDListRows
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 UDListRows : 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 UDListRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) UDListRows UDListRows.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(UDListRows.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 UDListRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, UDListTableInfo) 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 UDListRow given its index in the collection.

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

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

Methods

Add(UDListRow)

Add one UDListRow to the collection.

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

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

The index of the added UDListRow.

AddNew()

Add a new instance of UDListRow added to the collection.

Declaration
public UDListRow AddNew()
Returns
Type Description
UDListRow

A new instance of UDListRow added to the collection.

AddRange(IEnumerable<UDListRow>)

Add a range of UDListRow to the collection.

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

The updated UDListRows collection object.

CreateChild()

Create a new instance of UDListRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of UDListRow
Overrides

CreateNew()

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

Declaration
public static UDListRows CreateNew()
Returns
Type Description
UDListRows

A new instance of the UDListRows object.

Find(Predicate<UDListRow>)

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

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

FindAll(Predicate<UDListRow>)

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

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

ForEach(Action<UDListRow>)

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

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

GetFromCustomSearch(UDListRows.CustomSearch)

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

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

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

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

GetFromIdxName(String)

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

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

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

GetFromReader(SoDataReader, UDListTableInfo)

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

SoDataReader positioned to a valid database row.
UDListTableInfo tableInfo

UDListTableInfo 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
UDListRows

Remove(UDListRow)

Removes the given UDListRow from the collection

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

the UDListRow to be removed

ToArray()

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

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)