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