Class CopilotDataSourceSettingRows

Stores specific configuration values for each data source Collection of CopilotDataSourceSettingRow. Each element of the collection represents one row in the CopilotDataSourceSetting table.

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

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

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

Methods

Add(CopilotDataSourceSettingRow)

Add one CopilotDataSourceSettingRow to the collection.

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

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

The index of the added CopilotDataSourceSettingRow.

AddNew()

Add a new instance of CopilotDataSourceSettingRow added to the collection.

Declaration
public CopilotDataSourceSettingRow AddNew()
Returns
Type Description
CopilotDataSourceSettingRow

A new instance of CopilotDataSourceSettingRow added to the collection.

AddRange(IEnumerable<CopilotDataSourceSettingRow>)

Add a range of CopilotDataSourceSettingRow to the collection.

Declaration
public CopilotDataSourceSettingRows AddRange(IEnumerable<CopilotDataSourceSettingRow> rows)
Parameters
Type Name Description
IEnumerableCopilotDataSourceSettingRow rows
Returns
Type Description
CopilotDataSourceSettingRows

The updated CopilotDataSourceSettingRows collection object.

CreateChild()

Create a new instance of CopilotDataSourceSettingRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of CopilotDataSourceSettingRow
Overrides

CreateNew()

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

Declaration
public static CopilotDataSourceSettingRows CreateNew()
Returns
Type Description
CopilotDataSourceSettingRows

A new instance of the CopilotDataSourceSettingRows object.

Find(Predicate<CopilotDataSourceSettingRow>)

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

Declaration
public CopilotDataSourceSettingRow Find(Predicate<CopilotDataSourceSettingRow> condition)
Parameters
Type Name Description
PredicateCopilotDataSourceSettingRow condition
Returns
Type Description
CopilotDataSourceSettingRow

FindAll(Predicate<CopilotDataSourceSettingRow>)

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

Declaration
public CopilotDataSourceSettingRows FindAll(Predicate<CopilotDataSourceSettingRow> condition)
Parameters
Type Name Description
PredicateCopilotDataSourceSettingRow condition
Returns
Type Description
CopilotDataSourceSettingRows

ForEach(Action<CopilotDataSourceSettingRow>)

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

Declaration
public void ForEach(Action<CopilotDataSourceSettingRow> whatToDo)
Parameters
Type Name Description
ActionCopilotDataSourceSettingRow whatToDo

GetFromCustomSearchAsync(CustomSearch, CancellationToken)

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

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

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

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

GetFromReaderAsync(SoDataReader, CopilotDataSourceSettingTableInfo, CancellationToken)

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

SoDataReader positioned to a valid database row.
CopilotDataSourceSettingTableInfo tableInfo

CopilotDataSourceSettingTableInfo 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
TaskCopilotDataSourceSettingRows

Remove(CopilotDataSourceSettingRow)

Removes the given CopilotDataSourceSettingRow from the collection

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

the CopilotDataSourceSettingRow to be removed

ToArray()

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

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