Class PrefDescLineRows

Preference description - multiple choice line - drives the Preference GUI. May be used by third-party developers to add system preferences to be updated from SuperOffice Maintenance client, instead of ini-files. Collection of PrefDescLineRow. Each element of the collection represents one row in the PrefDescLine table.

Inheritance
object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
PrefDescLineRows
Inherited Members
Namespace: SuperOfficeCRMRows
Assembly: SoDataBase.dll
Syntax
public class PrefDescLineRows : 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 PrefDescLineRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) PrefDescLineRows PrefDescLineRows.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 PrefDescLineRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.PrefDescLineRows.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 PrefDescLineRow given its index in the collection.

Declaration
public PrefDescLineRow this[int index] { get; }
Parameters
Type Name Description
int index

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

Methods

Add(PrefDescLineRow)

Add one PrefDescLineRow to the collection.

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

An instance of PrefDescLineRow to be added to the collection.
Returns
Type Description
int

The index of the added PrefDescLineRow.

AddNew()

Add a new instance of PrefDescLineRow added to the collection.

Declaration
public PrefDescLineRow AddNew()
Returns
Type Description
PrefDescLineRow

A new instance of PrefDescLineRow added to the collection.

AddRange(IEnumerable<PrefDescLineRow>)

Add a range of PrefDescLineRow to the collection.

Declaration
public PrefDescLineRows AddRange(IEnumerable<PrefDescLineRow> rows)
Parameters
Type Name Description
IEnumerablePrefDescLineRow rows
Returns
Type Description
PrefDescLineRows

The updated PrefDescLineRows collection object.

CreateChild()

Create a new instance of PrefDescLineRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of PrefDescLineRow
Overrides

CreateNew()

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

Declaration
public static PrefDescLineRows CreateNew()
Returns
Type Description
PrefDescLineRows

A new instance of the PrefDescLineRows object.

Find(Predicate<PrefDescLineRow>)

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

Declaration
public PrefDescLineRow Find(Predicate<PrefDescLineRow> condition)
Parameters
Type Name Description
PredicatePrefDescLineRow condition
Returns
Type Description
PrefDescLineRow

FindAll(Predicate<PrefDescLineRow>)

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

Declaration
public PrefDescLineRows FindAll(Predicate<PrefDescLineRow> condition)
Parameters
Type Name Description
PredicatePrefDescLineRow condition
Returns
Type Description
PrefDescLineRows

ForEach(Action<PrefDescLineRow>)

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

Declaration
public void ForEach(Action<PrefDescLineRow> whatToDo)
Parameters
Type Name Description
ActionPrefDescLineRow whatToDo

GetFromCustomSearchAsync(CustomSearch, CancellationToken)

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

Declaration
public static Task<PrefDescLineRows> GetFromCustomSearchAsync(PrefDescLineRows.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PrefDescLineRowsCustomSearch query

The custom search to execute against the database
CancellationToken cancellationToken
Returns
Type Description
TaskPrefDescLineRows

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

GetFromIdxPrefDescIdAsync(int, CancellationToken)

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

Declaration
public static Task<PrefDescLineRows> GetFromIdxPrefDescIdAsync(int prefDescId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int prefDescId
CancellationToken cancellationToken
Returns
Type Description
TaskPrefDescLineRows

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

GetFromIdxPrefValueAsync(string, CancellationToken)

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

Declaration
public static Task<PrefDescLineRows> GetFromIdxPrefValueAsync(string prefValue, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string prefValue
CancellationToken cancellationToken
Returns
Type Description
TaskPrefDescLineRows

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

GetFromReaderAsync(SoDataReader, PrefDescLineTableInfo, CancellationToken)

Create a new instance of the PrefDescLineRows 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 PrefDescLineRow 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<PrefDescLineRows> GetFromReaderAsync(SoDataReader reader, PrefDescLineTableInfo tableInfo, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
PrefDescLineTableInfo tableInfo

PrefDescLineTableInfo 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
TaskPrefDescLineRows

Remove(PrefDescLineRow)

Removes the given PrefDescLineRow from the collection

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

the PrefDescLineRow to be removed

ToArray()

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

ToString()

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

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Implements

Extension Methods