Class ImportFieldRows

Import object types - see localetext for names Collection of ImportFieldRow. Each element of the collection represents one row in the ImportField table.

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

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

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

Methods

Add(ImportFieldRow)

Add one ImportFieldRow to the collection.

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

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

The index of the added ImportFieldRow.

AddNew()

Add a new instance of ImportFieldRow added to the collection.

Declaration
public ImportFieldRow AddNew()
Returns
Type Description
ImportFieldRow

A new instance of ImportFieldRow added to the collection.

AddRange(IEnumerable<ImportFieldRow>)

Add a range of ImportFieldRow to the collection.

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

The updated ImportFieldRows collection object.

CreateChild()

Create a new instance of ImportFieldRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of ImportFieldRow
Overrides

CreateNew()

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

Declaration
public static ImportFieldRows CreateNew()
Returns
Type Description
ImportFieldRows

A new instance of the ImportFieldRows object.

Find(Predicate<ImportFieldRow>)

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

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

FindAll(Predicate<ImportFieldRow>)

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

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

ForEach(Action<ImportFieldRow>)

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

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

GetFromCustomSearch(ImportFieldRows.CustomSearch)

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

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

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

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

GetFromIdxImportObjectId(Int32)

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

Declaration
public static ImportFieldRows GetFromIdxImportObjectId(int importObjectId)
Parameters
Type Name Description
System.Int32 importObjectId
Returns
Type Description
ImportFieldRows

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

GetFromReader(SoDataReader, ImportFieldTableInfo)

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

SoDataReader positioned to a valid database row.
ImportFieldTableInfo tableInfo

ImportFieldTableInfo 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
ImportFieldRows

Remove(ImportFieldRow)

Removes the given ImportFieldRow from the collection

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

the ImportFieldRow to be removed

ToArray()

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

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)