Class ExtraTablesRows

This table contains entries for the extra tables in the system. Collection of ExtraTablesRow. Each element of the collection represents one row in the ExtraTables table.

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

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

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

Methods

Add(ExtraTablesRow)

Add one ExtraTablesRow to the collection.

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

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

The index of the added ExtraTablesRow.

AddNew()

Add a new instance of ExtraTablesRow added to the collection.

Declaration
public ExtraTablesRow AddNew()
Returns
Type Description
ExtraTablesRow

A new instance of ExtraTablesRow added to the collection.

AddRange(IEnumerable<ExtraTablesRow>)

Add a range of ExtraTablesRow to the collection.

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

The updated ExtraTablesRows collection object.

CreateChild()

Create a new instance of ExtraTablesRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of ExtraTablesRow
Overrides

CreateNew()

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

Declaration
public static ExtraTablesRows CreateNew()
Returns
Type Description
ExtraTablesRows

A new instance of the ExtraTablesRows object.

Find(Predicate<ExtraTablesRow>)

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

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

FindAll(Predicate<ExtraTablesRow>)

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

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

ForEach(Action<ExtraTablesRow>)

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

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

GetFromCustomSearch(ExtraTablesRows.CustomSearch)

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

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

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

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

GetFromIdxDisplayField(Int32)

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

Declaration
public static ExtraTablesRows GetFromIdxDisplayField(int displayField)
Parameters
Type Name Description
System.Int32 displayField
Returns
Type Description
ExtraTablesRows

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

GetFromIdxFullnameField(Int32)

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

Declaration
public static ExtraTablesRows GetFromIdxFullnameField(int fullnameField)
Parameters
Type Name Description
System.Int32 fullnameField
Returns
Type Description
ExtraTablesRows

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

GetFromIdxHierarchyId(Int32)

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

Declaration
public static ExtraTablesRows GetFromIdxHierarchyId(int hierarchyId)
Parameters
Type Name Description
System.Int32 hierarchyId
Returns
Type Description
ExtraTablesRows

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

GetFromIdxParentField(Int32)

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

Declaration
public static ExtraTablesRows GetFromIdxParentField(int parentField)
Parameters
Type Name Description
System.Int32 parentField
Returns
Type Description
ExtraTablesRows

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

GetFromIdxScreenChooserAll(Int32)

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

Declaration
public static ExtraTablesRows GetFromIdxScreenChooserAll(int screenChooserAll)
Parameters
Type Name Description
System.Int32 screenChooserAll
Returns
Type Description
ExtraTablesRows

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

GetFromIdxScreenChooserEdit(Int32)

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

Declaration
public static ExtraTablesRows GetFromIdxScreenChooserEdit(int screenChooserEdit)
Parameters
Type Name Description
System.Int32 screenChooserEdit
Returns
Type Description
ExtraTablesRows

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

GetFromIdxScreenChooserEntry(Int32)

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

Declaration
public static ExtraTablesRows GetFromIdxScreenChooserEntry(int screenChooserEntry)
Parameters
Type Name Description
System.Int32 screenChooserEntry
Returns
Type Description
ExtraTablesRows

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

GetFromReader(SoDataReader, ExtraTablesTableInfo)

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

SoDataReader positioned to a valid database row.
ExtraTablesTableInfo tableInfo

ExtraTablesTableInfo 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
ExtraTablesRows

Remove(ExtraTablesRow)

Removes the given ExtraTablesRow from the collection

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

the ExtraTablesRow to be removed

ToArray()

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

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)