Class UDefFieldRows

Definition table for user-defined fields; one row in this table corresponds to one generation of one field. The user defined fields that are in use, and earlier versions of user defined fields. ColumnId refers to the field type; see UDXXXSmall or UDXXXLarge for the referring ID. Preferences prefsection='System', prefkey='CurrentUdefVersioncontact' (or CurrentUdefVersionperson, project, sale), gives you the current version of user defined fields. prefkey='AdminUdefVersion<...>' gives you the current version that's being edited. If Current version = admin version, no editing has been done since the last Publish of user defined field was performed. Collection of UDefFieldRow. Each element of the collection represents one row in the UDefField table.

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

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

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

Methods

Add(UDefFieldRow)

Add one UDefFieldRow to the collection.

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

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

The index of the added UDefFieldRow.

AddNew()

Add a new instance of UDefFieldRow added to the collection.

Declaration
public UDefFieldRow AddNew()
Returns
Type Description
UDefFieldRow

A new instance of UDefFieldRow added to the collection.

AddRange(IEnumerable<UDefFieldRow>)

Add a range of UDefFieldRow to the collection.

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

The updated UDefFieldRows collection object.

CreateChild()

Create a new instance of UDefFieldRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of UDefFieldRow
Overrides

CreateNew()

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

Declaration
public static UDefFieldRows CreateNew()
Returns
Type Description
UDefFieldRows

A new instance of the UDefFieldRows object.

Find(Predicate<UDefFieldRow>)

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

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

FindAll(Predicate<UDefFieldRow>)

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

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

ForEach(Action<UDefFieldRow>)

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

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

GetFromCustomSearch(UDefFieldRows.CustomSearch)

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

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

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

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

GetFromIdxOwnerTableId(Int16)

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

Declaration
public static UDefFieldRows GetFromIdxOwnerTableId(short ownerTableId)
Parameters
Type Name Description
System.Int16 ownerTableId
Returns
Type Description
UDefFieldRows

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

GetFromReader(SoDataReader, UDefFieldTableInfo)

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

SoDataReader positioned to a valid database row.
UDefFieldTableInfo tableInfo

UDefFieldTableInfo 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
UDefFieldRows

Remove(UDefFieldRow)

Removes the given UDefFieldRow from the collection

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

the UDefFieldRow to be removed

ToArray()

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

ToString()

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

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

Implements

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

Extension Methods

EnumUtil.MapEnums<From, To>(From)