Class ExtAppHeadingLinkRows

Heading link table for ExtApp, for MDO headers Collection of ExtAppHeadingLinkRow. Each element of the collection represents one row in the ExtAppHeadingLink table.

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

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

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

Methods

Add(ExtAppHeadingLinkRow)

Add one ExtAppHeadingLinkRow to the collection.

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

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

The index of the added ExtAppHeadingLinkRow.

AddNew()

Add a new instance of ExtAppHeadingLinkRow added to the collection.

Declaration
public ExtAppHeadingLinkRow AddNew()
Returns
Type Description
ExtAppHeadingLinkRow

A new instance of ExtAppHeadingLinkRow added to the collection.

AddRange(IEnumerable<ExtAppHeadingLinkRow>)

Add a range of ExtAppHeadingLinkRow to the collection.

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

The updated ExtAppHeadingLinkRows collection object.

CreateChild()

Create a new instance of ExtAppHeadingLinkRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of ExtAppHeadingLinkRow
Overrides

CreateNew()

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

Declaration
public static ExtAppHeadingLinkRows CreateNew()
Returns
Type Description
ExtAppHeadingLinkRows

A new instance of the ExtAppHeadingLinkRows object.

Find(Predicate<ExtAppHeadingLinkRow>)

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

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

FindAll(Predicate<ExtAppHeadingLinkRow>)

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

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

ForEach(Action<ExtAppHeadingLinkRow>)

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

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

GetFromCustomSearch(ExtAppHeadingLinkRows.CustomSearch)

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

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

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

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

GetFromIdxExtAppId(Int32)

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

Declaration
public static ExtAppHeadingLinkRows GetFromIdxExtAppId(int extAppId)
Parameters
Type Name Description
System.Int32 extAppId
Returns
Type Description
ExtAppHeadingLinkRows

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

GetFromIdxHeadingId(Int32)

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

Declaration
public static ExtAppHeadingLinkRows GetFromIdxHeadingId(int headingId)
Parameters
Type Name Description
System.Int32 headingId
Returns
Type Description
ExtAppHeadingLinkRows

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

GetFromReader(SoDataReader, ExtAppHeadingLinkTableInfo)

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

SoDataReader positioned to a valid database row.
ExtAppHeadingLinkTableInfo tableInfo

ExtAppHeadingLinkTableInfo 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
ExtAppHeadingLinkRows

Remove(ExtAppHeadingLinkRow)

Removes the given ExtAppHeadingLinkRow from the collection

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

the ExtAppHeadingLinkRow to be removed

ToArray()

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

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)