Class HeadingRows
Heading items for all MDO lists, lists that are grouped and filtered. Collection of HeadingRow. Each element of the collection represents one row in the Heading table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class HeadingRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IEnumerable, IList, ICollection, INotifyCollectionChanged, IBindingListRemarks
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
HeadingRow to it, and use methods like
to operate on the whole collection. - You can create a (nested) HeadingRows HeadingRows.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(HeadingRows.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.
Properties
Item[Int32]
Get a HeadingRow given its index in the collection.
Declaration
public HeadingRow this[int index] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | Index of the HeadingRow in the collection |
Property Value
| Type | Description |
|---|---|
| HeadingRow |
Methods
Add(HeadingRow)
Add one HeadingRow to the collection.
Declaration
public int Add(HeadingRow row)Parameters
| Type | Name | Description |
|---|---|---|
| HeadingRow | row | An instance of HeadingRow to be added to the collection. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The index of the added HeadingRow. |
AddNew()
Add a new instance of HeadingRow added to the collection.
Declaration
public HeadingRow AddNew()Returns
| Type | Description |
|---|---|
| HeadingRow | A new instance of HeadingRow added to the collection. |
AddRange(IEnumerable<HeadingRow>)
Add a range of HeadingRow to the collection.
Declaration
public HeadingRows AddRange(IEnumerable<HeadingRow> rows)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<HeadingRow> | rows |
Returns
| Type | Description |
|---|---|
| HeadingRows | The updated HeadingRows collection object. |
CreateChild()
Create a new instance of HeadingRow
Declaration
protected override TableRowBase CreateChild()Returns
| Type | Description |
|---|---|
| TableRowBase | New instance of HeadingRow |
Overrides
CreateNew()
Create a new instance of the HeadingRows object. This collection will contain no rows.
Declaration
public static HeadingRows CreateNew()Returns
| Type | Description |
|---|---|
| HeadingRows | A new instance of the HeadingRows object. |
Find(Predicate<HeadingRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public HeadingRow Find(Predicate<HeadingRow> condition)Parameters
| Type | Name | Description |
|---|---|---|
| System.Predicate<HeadingRow> | condition |
Returns
| Type | Description |
|---|---|
| HeadingRow |
FindAll(Predicate<HeadingRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public HeadingRows FindAll(Predicate<HeadingRow> condition)Parameters
| Type | Name | Description |
|---|---|---|
| System.Predicate<HeadingRow> | condition |
Returns
| Type | Description |
|---|---|
| HeadingRows |
ForEach(Action<HeadingRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<HeadingRow> whatToDo)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<HeadingRow> | whatToDo |
GetFromCustomSearch(HeadingRows.CustomSearch)
Create a new instance of the HeadingRows 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 HeadingRow objects representing each row will be returned.
Declaration
public static HeadingRows GetFromCustomSearch(HeadingRows.CustomSearch query)Parameters
| Type | Name | Description |
|---|---|---|
| HeadingRows.CustomSearch | query | The custom search to execute against the database |
Returns
| Type | Description |
|---|---|
| HeadingRows | A new instance of the HeadingRows object, reflecting the result of the query. |
GetFromIdxListTableId(Int16)
Create a new instance of the HeadingRow object, by querying the database table via the index 'IDXHeadingListTableId'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static HeadingRows GetFromIdxListTableId(short listTableId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int16 | listTableId |
Returns
| Type | Description |
|---|---|
| HeadingRows | Row object that represents the result of the search. |
Remarks
This method represents one of the unique indexes on the Heading table. Non-unique indexes have corresponding inner classes and methods in the HeadingRows collection, since they may return more than one row.
GetFromIdxName(String)
Create a new instance of the HeadingRow object, by querying the database table via the index 'IDXHeadingName'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static HeadingRows GetFromIdxName(string name)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name |
Returns
| Type | Description |
|---|---|
| HeadingRows | Row object that represents the result of the search. |
Remarks
This method represents one of the unique indexes on the Heading table. Non-unique indexes have corresponding inner classes and methods in the HeadingRows collection, since they may return more than one row.
GetFromReader(SoDataReader, HeadingTableInfo)
Create a new instance of the HeadingRows 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 HeadingRow 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 HeadingRows GetFromReader(SoDataReader reader, HeadingTableInfo tableInfo)Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | SoDataReader positioned to a valid database row. |
| HeadingTableInfo | tableInfo | HeadingTableInfo 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 |
|---|---|
| HeadingRows |
Remove(HeadingRow)
Removes the given HeadingRow from the collection
Declaration
public void Remove(HeadingRow row)Parameters
| Type | Name | Description |
|---|---|---|
| HeadingRow | row | the HeadingRow to be removed |
ToArray()
Declaration
public HeadingRow[] ToArray()Returns
| Type | Description |
|---|---|
| HeadingRow[] |
ToString()
For debugging: Number of members, and the first (up to) 5 items
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String |