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