Class SMessageblockRows

Contains a block of a mailing message, that can be reused in a mailing Collection of SMessageblockRow. Each element of the collection represents one row in the SMessageblock table.

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

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

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

Methods

Add(SMessageblockRow)

Add one SMessageblockRow to the collection.

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

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

The index of the added SMessageblockRow.

AddNew()

Add a new instance of SMessageblockRow added to the collection.

Declaration
public SMessageblockRow AddNew()
Returns
Type Description
SMessageblockRow

A new instance of SMessageblockRow added to the collection.

AddRange(IEnumerable<SMessageblockRow>)

Add a range of SMessageblockRow to the collection.

Declaration
public SMessageblockRows AddRange(IEnumerable<SMessageblockRow> rows)
Parameters
Type Name Description
IEnumerableSMessageblockRow rows
Returns
Type Description
SMessageblockRows

The updated SMessageblockRows collection object.

CreateChild()

Create a new instance of SMessageblockRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SMessageblockRow
Overrides

CreateNew()

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

Declaration
public static SMessageblockRows CreateNew()
Returns
Type Description
SMessageblockRows

A new instance of the SMessageblockRows object.

Find(Predicate<SMessageblockRow>)

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

Declaration
public SMessageblockRow Find(Predicate<SMessageblockRow> condition)
Parameters
Type Name Description
PredicateSMessageblockRow condition
Returns
Type Description
SMessageblockRow

FindAll(Predicate<SMessageblockRow>)

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

Declaration
public SMessageblockRows FindAll(Predicate<SMessageblockRow> condition)
Parameters
Type Name Description
PredicateSMessageblockRow condition
Returns
Type Description
SMessageblockRows

ForEach(Action<SMessageblockRow>)

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

Declaration
public void ForEach(Action<SMessageblockRow> whatToDo)
Parameters
Type Name Description
ActionSMessageblockRow whatToDo

GetFromCustomSearchAsync(CustomSearch, CancellationToken)

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

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

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

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

GetFromReaderAsync(SoDataReader, SMessageblockTableInfo, CancellationToken)

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

SoDataReader positioned to a valid database row.
SMessageblockTableInfo tableInfo

SMessageblockTableInfo 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
TaskSMessageblockRows

Remove(SMessageblockRow)

Removes the given SMessageblockRow from the collection

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

the SMessageblockRow to be removed

ToArray()

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

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