Class MsFilterMailRows
This table connects mail filters (ms_filter) to mailboxes (mail_in_filter). Collection of MsFilterMailRow. Each element of the collection represents one row in the MsFilterMail table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class MsFilterMailRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IEnumerable, IList, ICollection, 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
MsFilterMailRow to it, and use methods like
to operate on the whole collection. - You can create a (nested) MsFilterMailRows MsFilterMailRows.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(MsFilterMailRows.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 MsFilterMailRow given its index in the collection.
Declaration
public MsFilterMailRow this[int index] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | Index of the MsFilterMailRow in the collection |
Property Value
| Type | Description |
|---|---|
| MsFilterMailRow |
Methods
Add(MsFilterMailRow)
Add one MsFilterMailRow to the collection.
Declaration
public int Add(MsFilterMailRow row)Parameters
| Type | Name | Description |
|---|---|---|
| MsFilterMailRow | row | An instance of MsFilterMailRow to be added to the collection. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The index of the added MsFilterMailRow. |
AddNew()
Add a new instance of MsFilterMailRow added to the collection.
Declaration
public MsFilterMailRow AddNew()Returns
| Type | Description |
|---|---|
| MsFilterMailRow | A new instance of MsFilterMailRow added to the collection. |
AddRange(IEnumerable<MsFilterMailRow>)
Add a range of MsFilterMailRow to the collection.
Declaration
public MsFilterMailRows AddRange(IEnumerable<MsFilterMailRow> rows)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IEnumerable<MsFilterMailRow> | rows |
Returns
| Type | Description |
|---|---|
| MsFilterMailRows | The updated MsFilterMailRows collection object. |
CreateChild()
Create a new instance of MsFilterMailRow
Declaration
protected override TableRowBase CreateChild()Returns
| Type | Description |
|---|---|
| TableRowBase | New instance of MsFilterMailRow |
Overrides
CreateNew()
Create a new instance of the MsFilterMailRows object. This collection will contain no rows.
Declaration
public static MsFilterMailRows CreateNew()Returns
| Type | Description |
|---|---|
| MsFilterMailRows | A new instance of the MsFilterMailRows object. |
Find(Predicate<MsFilterMailRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public MsFilterMailRow Find(Predicate<MsFilterMailRow> condition)Parameters
| Type | Name | Description |
|---|---|---|
| System.Predicate<MsFilterMailRow> | condition |
Returns
| Type | Description |
|---|---|
| MsFilterMailRow |
FindAll(Predicate<MsFilterMailRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public MsFilterMailRows FindAll(Predicate<MsFilterMailRow> condition)Parameters
| Type | Name | Description |
|---|---|---|
| System.Predicate<MsFilterMailRow> | condition |
Returns
| Type | Description |
|---|---|
| MsFilterMailRows |
ForEach(Action<MsFilterMailRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<MsFilterMailRow> whatToDo)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<MsFilterMailRow> | whatToDo |
GetFromCustomSearch(MsFilterMailRows.CustomSearch)
Create a new instance of the MsFilterMailRows 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 MsFilterMailRow objects representing each row will be returned.
Declaration
public static MsFilterMailRows GetFromCustomSearch(MsFilterMailRows.CustomSearch query)Parameters
| Type | Name | Description |
|---|---|---|
| MsFilterMailRows.CustomSearch | query | The custom search to execute against the database |
Returns
| Type | Description |
|---|---|
| MsFilterMailRows | A new instance of the MsFilterMailRows object, reflecting the result of the query. |
GetFromIdxMailInFilterId(Int32)
Create a new instance of the MsFilterMailRow object, by querying the database table via the index 'IDXMs_filter_mailMail_in_filter_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static MsFilterMailRows GetFromIdxMailInFilterId(int mailInFilterId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | mailInFilterId |
Returns
| Type | Description |
|---|---|
| MsFilterMailRows | Row object that represents the result of the search. |
Remarks
This method represents one of the unique indexes on the MsFilterMail table. Non-unique indexes have corresponding inner classes and methods in the MsFilterMailRows collection, since they may return more than one row.
GetFromIdxMailSorterId(Int32)
Create a new instance of the MsFilterMailRow object, by querying the database table via the index 'IDXMs_filter_mailMail_sorter_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static MsFilterMailRows GetFromIdxMailSorterId(int mailSorterId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | mailSorterId |
Returns
| Type | Description |
|---|---|
| MsFilterMailRows | Row object that represents the result of the search. |
Remarks
This method represents one of the unique indexes on the MsFilterMail table. Non-unique indexes have corresponding inner classes and methods in the MsFilterMailRows collection, since they may return more than one row.
GetFromReader(SoDataReader, MsFilterMailTableInfo)
Create a new instance of the MsFilterMailRows 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 MsFilterMailRow 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 MsFilterMailRows GetFromReader(SoDataReader reader, MsFilterMailTableInfo tableInfo)Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | SoDataReader positioned to a valid database row. |
| MsFilterMailTableInfo | tableInfo | MsFilterMailTableInfo 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 |
|---|---|
| MsFilterMailRows |
Remove(MsFilterMailRow)
Removes the given MsFilterMailRow from the collection
Declaration
public void Remove(MsFilterMailRow row)Parameters
| Type | Name | Description |
|---|---|---|
| MsFilterMailRow | row | the MsFilterMailRow to be removed |
ToArray()
Declaration
public MsFilterMailRow[] ToArray()Returns
| Type | Description |
|---|---|
| MsFilterMailRow[] |
ToString()
For debugging: Number of members, and the first (up to) 5 items
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String |