Class ComptrRows
Comptr list table. List of all possible competitors (sale). Collection of ComptrRow. Each element of the collection represents one row in the Comptr table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class ComptrRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IList, ICollection, IEnumerable, INotifyCollectionChanged, IBindingListRemarks
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
ComptrRow to it, and use methods like
to operate on the whole collection. - You can create a (nested) ComptrRows ComptrRows.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(ComptrRows.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.
Properties
Item[Int32]
Get a ComptrRow given its index in the collection.
Declaration
public ComptrRow this[int index] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | index | Index of the ComptrRow in the collection |
Property Value
| Type | Description |
|---|---|
| ComptrRow |
Methods
Add(ComptrRow)
Add one ComptrRow to the collection.
Declaration
public int Add(ComptrRow row)Parameters
| Type | Name | Description |
|---|---|---|
| ComptrRow | row | An instance of ComptrRow to be added to the collection. |
Returns
| Type | Description |
|---|---|
| Int32 | The index of the added ComptrRow. |
AddNew()
Add a new instance of ComptrRow added to the collection.
Declaration
public ComptrRow AddNew()Returns
| Type | Description |
|---|---|
| ComptrRow | A new instance of ComptrRow added to the collection. |
AddRange(IEnumerable<ComptrRow>)
Add a range of ComptrRow to the collection.
Declaration
public ComptrRows AddRange(IEnumerable<ComptrRow> rows)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<ComptrRow> | rows |
Returns
| Type | Description |
|---|---|
| ComptrRows | The updated ComptrRows collection object. |
CreateChild()
Create a new instance of ComptrRow
Declaration
protected override TableRowBase CreateChild()Returns
| Type | Description |
|---|---|
| TableRowBase | New instance of ComptrRow |
Overrides
CreateNew()
Create a new instance of the ComptrRows object. This collection will contain no rows.
Declaration
public static ComptrRows CreateNew()Returns
| Type | Description |
|---|---|
| ComptrRows | A new instance of the ComptrRows object. |
Find(Predicate<ComptrRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public ComptrRow Find(Predicate<ComptrRow> condition)Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<ComptrRow> | condition |
Returns
| Type | Description |
|---|---|
| ComptrRow |
FindAll(Predicate<ComptrRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public ComptrRows FindAll(Predicate<ComptrRow> condition)Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<ComptrRow> | condition |
Returns
| Type | Description |
|---|---|
| ComptrRows |
ForEach(Action<ComptrRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<ComptrRow> whatToDo)Parameters
| Type | Name | Description |
|---|---|---|
| Action<ComptrRow> | whatToDo |
GetFromCustomSearch(ComptrRows.CustomSearch)
Create a new instance of the ComptrRows 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 ComptrRow objects representing each row will be returned.
Declaration
public static ComptrRows GetFromCustomSearch(ComptrRows.CustomSearch query)Parameters
| Type | Name | Description |
|---|---|---|
| ComptrRows.CustomSearch | query | The custom search to execute against the database |
Returns
| Type | Description |
|---|---|
| ComptrRows | A new instance of the ComptrRows object, reflecting the result of the query. |
GetFromReader(SoDataReader, ComptrTableInfo)
Create a new instance of the ComptrRows 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 ComptrRow 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 ComptrRows GetFromReader(SoDataReader reader, ComptrTableInfo tableInfo)Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | SoDataReader positioned to a valid database row. |
| ComptrTableInfo | tableInfo | ComptrTableInfo 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 |
|---|---|
| ComptrRows |
Remove(ComptrRow)
Removes the given ComptrRow from the collection
Declaration
public void Remove(ComptrRow row)Parameters
| Type | Name | Description |
|---|---|---|
| ComptrRow | row | the ComptrRow to be removed |
ToArray()
Declaration
public ComptrRow[] ToArray()Returns
| Type | Description |
|---|---|
| ComptrRow[] |
ToString()
For debugging: Number of members, and the first (up to) 5 items
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| String |