Class SalutationRows

Academic title for Person Collection of SalutationRow. Each element of the collection represents one row in the Salutation table.

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

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

Index of the SalutationRow in the collection
Property Value
Type Description
SalutationRow
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 SalutationRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SalutationRows SalutationRows.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(CustomSearch) 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 SalutationRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SalutationTableInfo) 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(SalutationRow)

Add one SalutationRow to the collection.

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

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

The index of the added SalutationRow.
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 SalutationRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SalutationRows SalutationRows.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(CustomSearch) 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 SalutationRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SalutationTableInfo) 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 SalutationRow added to the collection.

Declaration
public SalutationRow AddNew()
Returns
Type Description
SalutationRow

A new instance of SalutationRow 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 SalutationRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SalutationRows SalutationRows.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(CustomSearch) 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 SalutationRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SalutationTableInfo) 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<SalutationRow>)

Add a range of SalutationRow to the collection.

Declaration
public SalutationRows AddRange(IEnumerable<SalutationRow> rows)
Parameters
Type Name Description
IEnumerable<SalutationRow> rows
Returns
Type Description
SalutationRows

The updated SalutationRows 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 SalutationRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SalutationRows SalutationRows.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(CustomSearch) 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 SalutationRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SalutationTableInfo) 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 SalutationRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SalutationRow
Overrides
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 SalutationRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SalutationRows SalutationRows.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(CustomSearch) 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 SalutationRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SalutationTableInfo) 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 SalutationRows object. This collection will contain no rows.

Declaration
public static SalutationRows CreateNew()
Returns
Type Description
SalutationRows

A new instance of the SalutationRows 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 SalutationRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SalutationRows SalutationRows.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(CustomSearch) 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 SalutationRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SalutationTableInfo) 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<SalutationRow>)

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

Declaration
public SalutationRow Find(Predicate<SalutationRow> condition)
Parameters
Type Name Description
Predicate<SalutationRow> condition
Returns
Type Description
SalutationRow
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 SalutationRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SalutationRows SalutationRows.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(CustomSearch) 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 SalutationRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SalutationTableInfo) 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<SalutationRow>)

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

Declaration
public SalutationRows FindAll(Predicate<SalutationRow> condition)
Parameters
Type Name Description
Predicate<SalutationRow> condition
Returns
Type Description
SalutationRows
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 SalutationRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SalutationRows SalutationRows.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(CustomSearch) 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 SalutationRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SalutationTableInfo) 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<SalutationRow>)

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

Declaration
public void ForEach(Action<SalutationRow> whatToDo)
Parameters
Type Name Description
Action<SalutationRow> 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 SalutationRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SalutationRows SalutationRows.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(CustomSearch) 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 SalutationRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SalutationTableInfo) 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).

GetFromCustomSearch(CustomSearch)

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

Declaration
public static SalutationRows GetFromCustomSearch(SalutationRows.CustomSearch query)
Parameters
Type Name Description
SalutationRows.CustomSearch query

The custom search to execute against the database
Returns
Type Description
SalutationRows

A new instance of the SalutationRows 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 SalutationRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SalutationRows SalutationRows.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(CustomSearch) 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 SalutationRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SalutationTableInfo) 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).

GetFromReader(SoDataReader, SalutationTableInfo)

Create a new instance of the SalutationRows 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 SalutationRow 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 SalutationRows GetFromReader(SoDataReader reader, SalutationTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
SalutationTableInfo tableInfo

SalutationTableInfo 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.
Returns
Type Description
SalutationRows
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 SalutationRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SalutationRows SalutationRows.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(CustomSearch) 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 SalutationRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SalutationTableInfo) 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(SalutationRow)

Removes the given SalutationRow from the collection

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

the SalutationRow 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 SalutationRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SalutationRows SalutationRows.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(CustomSearch) 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 SalutationRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SalutationTableInfo) 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()

Academic title for Person Collection of SalutationRow. Each element of the collection represents one row in the Salutation table.

Declaration
public SalutationRow[] ToArray()
Returns
Type Description
SalutationRow[]
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 SalutationRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SalutationRows SalutationRows.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(CustomSearch) 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 SalutationRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SalutationTableInfo) 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
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 SalutationRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SalutationRows SalutationRows.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(CustomSearch) 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 SalutationRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SalutationTableInfo) 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

Extension Methods