Class PriorityRows
Priority list table. Used with appointments: low, high. Collection of PriorityRow. Each element of the collection represents one row in the Priority table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class PriorityRows : 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 PriorityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) PriorityRows PriorityRows.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.
Properties
this[int]
Get a PriorityRow given its index in the collection.
Declaration
public PriorityRow this[int index] { get; }
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | Index of the PriorityRow in the collection |
Property Value
| Type | Description |
|---|---|
| PriorityRow |
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 PriorityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) PriorityRows PriorityRows.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.
Methods
Add(PriorityRow)
Add one PriorityRow to the collection.
Declaration
public int Add(PriorityRow row)
Parameters
| Type | Name | Description |
|---|---|---|
| PriorityRow | row | An instance of PriorityRow to be added to the collection. |
Returns
| Type | Description |
|---|---|
| int | The index of the added PriorityRow. |
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 PriorityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) PriorityRows PriorityRows.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.
AddNew()
Add a new instance of PriorityRow added to the collection.
Declaration
public PriorityRow AddNew()
Returns
| Type | Description |
|---|---|
| PriorityRow | A new instance of PriorityRow 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 PriorityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) PriorityRows PriorityRows.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.
AddRange(IEnumerable<PriorityRow>)
Add a range of PriorityRow to the collection.
Declaration
public PriorityRows AddRange(IEnumerable<PriorityRow> rows)
Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<PriorityRow> | rows |
Returns
| Type | Description |
|---|---|
| PriorityRows | The updated PriorityRows 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 PriorityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) PriorityRows PriorityRows.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.
CreateChild()
Create a new instance of PriorityRow
Declaration
protected override TableRowBase CreateChild()
Returns
| Type | Description |
|---|---|
| TableRowBase | New instance of PriorityRow |
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 PriorityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) PriorityRows PriorityRows.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.
CreateNew()
Create a new instance of the PriorityRows object. This collection will contain no rows.
Declaration
public static PriorityRows CreateNew()
Returns
| Type | Description |
|---|---|
| PriorityRows | A new instance of the PriorityRows 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 PriorityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) PriorityRows PriorityRows.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.
Find(Predicate<PriorityRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public PriorityRow Find(Predicate<PriorityRow> condition)
Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<PriorityRow> | condition |
Returns
| Type | Description |
|---|---|
| PriorityRow |
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 PriorityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) PriorityRows PriorityRows.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.
FindAll(Predicate<PriorityRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public PriorityRows FindAll(Predicate<PriorityRow> condition)
Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<PriorityRow> | condition |
Returns
| Type | Description |
|---|---|
| PriorityRows |
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 PriorityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) PriorityRows PriorityRows.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.
ForEach(Action<PriorityRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<PriorityRow> whatToDo)
Parameters
| Type | Name | Description |
|---|---|---|
| Action<PriorityRow> | 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 PriorityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) PriorityRows PriorityRows.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.
GetFromCustomSearchAsync(CustomSearch, CancellationToken)
Create a new instance of the PriorityRows 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 PriorityRow objects representing each row will be returned.
Declaration
public static Task<PriorityRows> GetFromCustomSearchAsync(PriorityRows.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| PriorityRows.CustomSearch | query | The custom search to execute against the database |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<PriorityRows> | A new instance of the PriorityRows 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 PriorityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) PriorityRows PriorityRows.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.
GetFromReaderAsync(SoDataReader, PriorityTableInfo, CancellationToken)
Create a new instance of the PriorityRows 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 PriorityRow 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<PriorityRows> GetFromReaderAsync(SoDataReader reader, PriorityTableInfo tableInfo, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | SoDataReader positioned to a valid database row. |
| PriorityTableInfo | tableInfo | PriorityTableInfo 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<PriorityRows> |
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 PriorityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) PriorityRows PriorityRows.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.
Remove(PriorityRow)
Removes the given PriorityRow from the collection
Declaration
public void Remove(PriorityRow row)
Parameters
| Type | Name | Description |
|---|---|---|
| PriorityRow | row | the PriorityRow 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 PriorityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) PriorityRows PriorityRows.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.
ToArray()
Priority list table. Used with appointments: low, high. Collection of PriorityRow. Each element of the collection represents one row in the Priority table.
Declaration
public PriorityRow[] ToArray()
Returns
| Type | Description |
|---|---|
| PriorityRow[] |
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 PriorityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) PriorityRows PriorityRows.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.
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 PriorityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) PriorityRows PriorityRows.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.