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

object

NestedPersist

NestedPersistFacade

NestedCollectionPersist

TableRowsBase

HeadingRows

Implements

INestedPersist

IEnumerable<INestedPersist>

INotifyCollectionChanged

IBindingList

IList

ICollection

IEnumerable

Inherited Members

TableRowsBase._innerList

TableRowsBase._allHasBeenMarkedForDelete

TableRowsBase._sentries

TableRowsBase._idx

TableRowsBase.OnIndexChanged(IdxBase)

TableRowsBase.LoadAsync(IdxBase, CancellationToken)

TableRowsBase.RowsLoadAsync(CancellationToken)

TableRowsBase.RowsLoadAsync(ITableRowLoadHandlerFactory, CancellationToken)

TableRowsBase.DeleteAsync()

TableRowsBase.GetEnumerator()

TableRowsBase.Add(TableRowBase)

TableRowsBase.Remove(TableRowBase)

TableRowsBase.Clear()

TableRowsBase.Sort(IComparer)

TableRowsBase.GetPrimaryKeys()

TableRowsBase.OnAdded(object, int)

TableRowsBase.CopyTo(Array, int)

TableRowsBase.IndexOf(object)

TableRowsBase.Contains(object)

TableRowsBase.AddIndex(PropertyDescriptor)

TableRowsBase.ApplySort(PropertyDescriptor, ListSortDirection)

TableRowsBase.Find(PropertyDescriptor, object)

TableRowsBase.RemoveIndex(PropertyDescriptor)

TableRowsBase.RemoveSort()

TableRowsBase.Load(IdxBase)

TableRowsBase.RowsLoad()

TableRowsBase.RowsLoad(ITableRowLoadHandlerFactory)

TableRowsBase.Sentries

TableRowsBase.IsDirty

TableRowsBase.Index

TableRowsBase.Count

TableRowsBase.IsMarkedForDelete

TableRowsBase.IsFixedSize

TableRowsBase.IsReadOnly

TableRowsBase.AllowEdit

TableRowsBase.AllowNew

TableRowsBase.AllowRemove

TableRowsBase.IsSorted

TableRowsBase.SortDirection

TableRowsBase.SortProperty

TableRowsBase.SupportsChangeNotification

TableRowsBase.SupportsSearching

TableRowsBase.SupportsSorting

TableRowsBase._onCollectionChanged

TableRowsBase.CollectionChanged

TableRowsBase.ListChanged

NestedCollectionPersist.GetFacadingItems()

NestedCollectionPersist.IsDeleted

NestedPersistFacade.OnPreIdUpdateAsync()

NestedPersistFacade.OnPrimaryKeyRequestAsync(PKContainer)

NestedPersistFacade.OnPrimaryKeyUpdateAsync(PKContainer)

NestedPersistFacade.OnIdUpdateAsync()

NestedPersistFacade.OnSaveAsync(BatchSave)

NestedPersistFacade.OnSavedAsync(bool)

NestedPersist._saveOwner

NestedPersist._isSaving

NestedPersist.SetSaveOwner(INestedPersist)

NestedPersist.SaveAsync()

NestedPersist.IsSaving

NestedPersist.OnElementSaved

NestedPersist.OnElementIdUpdate

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SuperOffice.CRM.Rows

Assembly: SoDataBase.dll

Syntax

public class HeadingRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, INotifyCollectionChanged, IBindingList, IList, ICollection, IEnumerable

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 HeadingRow to it, and use methods like Save 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 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 HeadingRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.HeadingRows.GetFromReader 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

this[int]

Get a HeadingRow given its index in the collection.

Declaration

public HeadingRow this[int index] { get; }

Parameters

Type	Name	Description
int	index	Index of the HeadingRow in the collection

Property Value

Type	Description
HeadingRow

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 HeadingRow to it, and use methods like Save 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 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 HeadingRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.HeadingRows.GetFromReader 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).

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
int	The index of the added HeadingRow.

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 HeadingRow to it, and use methods like Save 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 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 HeadingRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.HeadingRows.GetFromReader 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).

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.

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 HeadingRow to it, and use methods like Save 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 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 HeadingRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.HeadingRows.GetFromReader 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).

AddRange(IEnumerable<HeadingRow>)

Add a range of HeadingRow to the collection.

Declaration

public HeadingRows AddRange(IEnumerable<HeadingRow> rows)

Parameters

Type	Name	Description
IEnumerable<HeadingRow>	rows

Returns

Type	Description
HeadingRows	The updated HeadingRows collection object.

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 HeadingRow to it, and use methods like Save 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 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 HeadingRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.HeadingRows.GetFromReader 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).

CreateChild()

Create a new instance of HeadingRow

Declaration

protected override TableRowBase CreateChild()

Returns

Type	Description
TableRowBase	New instance of HeadingRow

Overrides

TableRowsBase.CreateChild()

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 HeadingRow to it, and use methods like Save 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 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 HeadingRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.HeadingRows.GetFromReader 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).

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.

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 HeadingRow to it, and use methods like Save 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 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 HeadingRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.HeadingRows.GetFromReader 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).

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
Predicate<HeadingRow>	condition

Returns

Type	Description
HeadingRow

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 HeadingRow to it, and use methods like Save 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 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 HeadingRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.HeadingRows.GetFromReader 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).

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
Predicate<HeadingRow>	condition

Returns

Type	Description
HeadingRows

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 HeadingRow to it, and use methods like Save 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 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 HeadingRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.HeadingRows.GetFromReader 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).

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
Action<HeadingRow>	whatToDo

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 HeadingRow to it, and use methods like Save 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 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 HeadingRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.HeadingRows.GetFromReader 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).

GetFromCustomSearchAsync(CustomSearch, CancellationToken)

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 Task<HeadingRows> GetFromCustomSearchAsync(HeadingRows.CustomSearch query, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
HeadingRows.CustomSearch	query	The custom search to execute against the database
CancellationToken	cancellationToken

Returns

Type	Description
Task<HeadingRows>	A new instance of the HeadingRows object, reflecting the result of the query.

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 HeadingRow to it, and use methods like Save 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 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 HeadingRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.HeadingRows.GetFromReader 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).

GetFromIdxListTableIdAsync(short, CancellationToken)

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 Task<HeadingRows> GetFromIdxListTableIdAsync(short listTableId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
short	listTableId
CancellationToken	cancellationToken

Returns

Type	Description
Task<HeadingRows>	Row object that represents the result of the search. IsNew 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 Heading table. Non-unique indexes have corresponding inner classes and methods in the HeadingRows collection, since they may return more than one row.

GetFromIdxNameAsync(string, CancellationToken)

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 Task<HeadingRows> GetFromIdxNameAsync(string name, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name
CancellationToken	cancellationToken

Returns

Type	Description
Task<HeadingRows>	Row object that represents the result of the search. IsNew 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 Heading table. Non-unique indexes have corresponding inner classes and methods in the HeadingRows collection, since they may return more than one row.

GetFromReaderAsync(SoDataReader, HeadingTableInfo, CancellationToken)

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 Task<HeadingRows> GetFromReaderAsync(SoDataReader reader, HeadingTableInfo tableInfo, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken

Returns

Type	Description
Task<HeadingRows>

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 HeadingRow to it, and use methods like Save 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 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 HeadingRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.HeadingRows.GetFromReader 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).

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

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 HeadingRow to it, and use methods like Save 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 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 HeadingRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.HeadingRows.GetFromReader 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).

ToArray()

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.

Declaration

public HeadingRow[] ToArray()

Returns

Type	Description
HeadingRow[]

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 HeadingRow to it, and use methods like Save 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 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 HeadingRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.HeadingRows.GetFromReader 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).

ToString()

For debugging: Number of members, and the first (up to) 5 items

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

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 HeadingRow to it, and use methods like Save 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 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 HeadingRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.HeadingRows.GetFromReader 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).

Implements

INestedPersist

IEnumerable<T>

INotifyCollectionChanged

IBindingList

IList

ICollection

IEnumerable

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)