Class WordRelationsRows

This table shows which word are used in which FAQ entry, and how many times they are used in each Collection of WordRelationsRow. Each element of the collection represents one row in the WordRelations table.

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

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

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

Methods

Add(WordRelationsRow)

Add one WordRelationsRow to the collection.

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

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

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

AddNew()

Add a new instance of WordRelationsRow added to the collection.

Declaration
public WordRelationsRow AddNew()
Returns
Type Description
WordRelationsRow

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

AddRange(IEnumerable<WordRelationsRow>)

Add a range of WordRelationsRow to the collection.

Declaration
public WordRelationsRows AddRange(IEnumerable<WordRelationsRow> rows)
Parameters
Type Name Description
IEnumerable<WordRelationsRow> rows
Returns
Type Description
WordRelationsRows

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

CreateChild()

Create a new instance of WordRelationsRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of WordRelationsRow
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 WordRelationsRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) WordRelationsRows WordRelationsRows.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 WordRelationsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.WordRelationsRows.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).

CreateNew()

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

Declaration
public static WordRelationsRows CreateNew()
Returns
Type Description
WordRelationsRows

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

Find(Predicate<WordRelationsRow>)

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

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

FindAll(Predicate<WordRelationsRow>)

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

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

ForEach(Action<WordRelationsRow>)

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

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

GetFromCustomSearchAsync(CustomSearch, CancellationToken)

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

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

The custom search to execute against the database
CancellationToken cancellationToken
Returns
Type Description
Task<WordRelationsRows>

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

GetFromIdxEntryIdAsync(int, CancellationToken)

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

Declaration
public static Task<WordRelationsRows> GetFromIdxEntryIdAsync(int entryId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int entryId
CancellationToken cancellationToken
Returns
Type Description
Task<WordRelationsRows>

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

GetFromIdxEntryWordIdAsync(int, CancellationToken)

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

Declaration
public static Task<WordRelationsRows> GetFromIdxEntryWordIdAsync(int entryWordId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int entryWordId
CancellationToken cancellationToken
Returns
Type Description
Task<WordRelationsRows>

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

GetFromReaderAsync(SoDataReader, WordRelationsTableInfo, CancellationToken)

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

SoDataReader positioned to a valid database row.
WordRelationsTableInfo tableInfo

WordRelationsTableInfo 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
Task<WordRelationsRows>
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 WordRelationsRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) WordRelationsRows WordRelationsRows.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 WordRelationsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.WordRelationsRows.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).

Remove(WordRelationsRow)

Removes the given WordRelationsRow from the collection

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

the WordRelationsRow 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 WordRelationsRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) WordRelationsRows WordRelationsRows.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 WordRelationsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.WordRelationsRows.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).

ToArray()

This table shows which word are used in which FAQ entry, and how many times they are used in each Collection of WordRelationsRow. Each element of the collection represents one row in the WordRelations table.

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

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 WordRelationsRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) WordRelationsRows WordRelationsRows.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 WordRelationsRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.WordRelationsRows.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).

Implements

Extension Methods