Class QuickReplyRows

Personal quick reply text fragments Collection of QuickReplyRow. Each element of the collection represents one row in the QuickReply table.

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

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

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

Methods

Add(QuickReplyRow)

Add one QuickReplyRow to the collection.

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

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

The index of the added QuickReplyRow.

AddNew()

Add a new instance of QuickReplyRow added to the collection.

Declaration
public QuickReplyRow AddNew()
Returns
Type Description
QuickReplyRow

A new instance of QuickReplyRow added to the collection.

AddRange(IEnumerable<QuickReplyRow>)

Add a range of QuickReplyRow to the collection.

Declaration
public QuickReplyRows AddRange(IEnumerable<QuickReplyRow> rows)
Parameters
Type Name Description
IEnumerableQuickReplyRow rows
Returns
Type Description
QuickReplyRows

The updated QuickReplyRows collection object.

CreateChild()

Create a new instance of QuickReplyRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of QuickReplyRow
Overrides

CreateNew()

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

Declaration
public static QuickReplyRows CreateNew()
Returns
Type Description
QuickReplyRows

A new instance of the QuickReplyRows object.

Find(Predicate<QuickReplyRow>)

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

Declaration
public QuickReplyRow Find(Predicate<QuickReplyRow> condition)
Parameters
Type Name Description
PredicateQuickReplyRow condition
Returns
Type Description
QuickReplyRow

FindAll(Predicate<QuickReplyRow>)

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

Declaration
public QuickReplyRows FindAll(Predicate<QuickReplyRow> condition)
Parameters
Type Name Description
PredicateQuickReplyRow condition
Returns
Type Description
QuickReplyRows

ForEach(Action<QuickReplyRow>)

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

Declaration
public void ForEach(Action<QuickReplyRow> whatToDo)
Parameters
Type Name Description
ActionQuickReplyRow whatToDo

GetFromCustomSearchAsync(CustomSearch, CancellationToken)

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

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

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

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

GetFromIdxRankAsync(short, CancellationToken)

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

Declaration
public static Task<QuickReplyRows> GetFromIdxRankAsync(short rank, CancellationToken cancellationToken = default)
Parameters
Type Name Description
short rank
CancellationToken cancellationToken
Returns
Type Description
TaskQuickReplyRows

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

GetFromReaderAsync(SoDataReader, QuickReplyTableInfo, CancellationToken)

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

SoDataReader positioned to a valid database row.
QuickReplyTableInfo tableInfo

QuickReplyTableInfo 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
TaskQuickReplyRows

Remove(QuickReplyRow)

Removes the given QuickReplyRow from the collection

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

the QuickReplyRow to be removed

ToArray()

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

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