Class ExtFieldRows

This table contains entries mapping an external field to an internal field. Used for database integration. Collection of ExtFieldRow. Each element of the collection represents one row in the ExtField table.

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

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

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

Methods

Add(ExtFieldRow)

Add one ExtFieldRow to the collection.

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

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

The index of the added ExtFieldRow.

AddNew()

Add a new instance of ExtFieldRow added to the collection.

Declaration
public ExtFieldRow AddNew()
Returns
Type Description
ExtFieldRow

A new instance of ExtFieldRow added to the collection.

AddRange(IEnumerable<ExtFieldRow>)

Add a range of ExtFieldRow to the collection.

Declaration
public ExtFieldRows AddRange(IEnumerable<ExtFieldRow> rows)
Parameters
Type Name Description
IEnumerable<ExtFieldRow> rows
Returns
Type Description
ExtFieldRows

The updated ExtFieldRows collection object.

CreateChild()

Create a new instance of ExtFieldRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of ExtFieldRow
Overrides

CreateNew()

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

Declaration
public static ExtFieldRows CreateNew()
Returns
Type Description
ExtFieldRows

A new instance of the ExtFieldRows object.

Find(Predicate<ExtFieldRow>)

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

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

FindAll(Predicate<ExtFieldRow>)

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

Declaration
public ExtFieldRows FindAll(Predicate<ExtFieldRow> condition)
Parameters
Type Name Description
Predicate<ExtFieldRow> condition
Returns
Type Description
ExtFieldRows

ForEach(Action<ExtFieldRow>)

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

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

GetFromCustomSearch(ExtFieldRows.CustomSearch)

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

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

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

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

GetFromIdxExtTable(Int32)

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

Declaration
public static ExtFieldRows GetFromIdxExtTable(int extTable)
Parameters
Type Name Description
Int32 extTable
Returns
Type Description
ExtFieldRows

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

GetFromReader(SoDataReader, ExtFieldTableInfo)

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

SoDataReader positioned to a valid database row.
ExtFieldTableInfo tableInfo

ExtFieldTableInfo 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
ExtFieldRows

Remove(ExtFieldRow)

Removes the given ExtFieldRow from the collection

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

the ExtFieldRow to be removed

ToArray()

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

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)