Class MailInFilterRows
This table contains entries for the mailboxes the eJournal system is fetching mail from (POP3 or IMAP). Collection of MailInFilterRow. Each element of the collection represents one row in the MailInFilter table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class MailInFilterRows : 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 MailInFilterRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MailInFilterRows MailInFilterRows.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 MailInFilterRow given its index in the collection.
Declaration
public MailInFilterRow this[int index] { get; }
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | Index of the MailInFilterRow in the collection |
Property Value
| Type | Description |
|---|---|
| MailInFilterRow |
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 MailInFilterRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MailInFilterRows MailInFilterRows.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(MailInFilterRow)
Add one MailInFilterRow to the collection.
Declaration
public int Add(MailInFilterRow row)
Parameters
| Type | Name | Description |
|---|---|---|
| MailInFilterRow | row | An instance of MailInFilterRow to be added to the collection. |
Returns
| Type | Description |
|---|---|
| int | The index of the added MailInFilterRow. |
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 MailInFilterRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MailInFilterRows MailInFilterRows.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 MailInFilterRow added to the collection.
Declaration
public MailInFilterRow AddNew()
Returns
| Type | Description |
|---|---|
| MailInFilterRow | A new instance of MailInFilterRow 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 MailInFilterRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MailInFilterRows MailInFilterRows.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<MailInFilterRow>)
Add a range of MailInFilterRow to the collection.
Declaration
public MailInFilterRows AddRange(IEnumerable<MailInFilterRow> rows)
Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<MailInFilterRow> | rows |
Returns
| Type | Description |
|---|---|
| MailInFilterRows | The updated MailInFilterRows 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 MailInFilterRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MailInFilterRows MailInFilterRows.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 MailInFilterRow
Declaration
protected override TableRowBase CreateChild()
Returns
| Type | Description |
|---|---|
| TableRowBase | New instance of MailInFilterRow |
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 MailInFilterRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MailInFilterRows MailInFilterRows.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 MailInFilterRows object. This collection will contain no rows.
Declaration
public static MailInFilterRows CreateNew()
Returns
| Type | Description |
|---|---|
| MailInFilterRows | A new instance of the MailInFilterRows 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 MailInFilterRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MailInFilterRows MailInFilterRows.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<MailInFilterRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public MailInFilterRow Find(Predicate<MailInFilterRow> condition)
Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<MailInFilterRow> | condition |
Returns
| Type | Description |
|---|---|
| MailInFilterRow |
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 MailInFilterRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MailInFilterRows MailInFilterRows.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<MailInFilterRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public MailInFilterRows FindAll(Predicate<MailInFilterRow> condition)
Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<MailInFilterRow> | condition |
Returns
| Type | Description |
|---|---|
| MailInFilterRows |
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 MailInFilterRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MailInFilterRows MailInFilterRows.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<MailInFilterRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<MailInFilterRow> whatToDo)
Parameters
| Type | Name | Description |
|---|---|---|
| Action<MailInFilterRow> | 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 MailInFilterRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MailInFilterRows MailInFilterRows.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 MailInFilterRows 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 MailInFilterRow objects representing each row will be returned.
Declaration
public static Task<MailInFilterRows> GetFromCustomSearchAsync(MailInFilterRows.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| MailInFilterRows.CustomSearch | query | The custom search to execute against the database |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<MailInFilterRows> | A new instance of the MailInFilterRows 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 MailInFilterRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MailInFilterRows MailInFilterRows.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.
GetFromIdxCategoryIdAsync(int, CancellationToken)
Create a new instance of the MailInFilterRow object, by querying the database table via the index 'IDXMail_in_filterCategory_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<MailInFilterRows> GetFromIdxCategoryIdAsync(int categoryId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | categoryId | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<MailInFilterRows> | Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table |
Remarks
This method represents one of the unique indexes on the MailInFilter table. Non-unique indexes have corresponding inner classes and methods in the MailInFilterRows collection, since they may return more than one row.
GetFromIdxLanguageIdAsync(int, CancellationToken)
Create a new instance of the MailInFilterRow object, by querying the database table via the index 'IDXMail_in_filterLanguage_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<MailInFilterRows> GetFromIdxLanguageIdAsync(int languageId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | languageId | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<MailInFilterRows> | Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table |
Remarks
This method represents one of the unique indexes on the MailInFilter table. Non-unique indexes have corresponding inner classes and methods in the MailInFilterRows collection, since they may return more than one row.
GetFromIdxPriorityAsync(int, CancellationToken)
Create a new instance of the MailInFilterRow object, by querying the database table via the index 'IDXMail_in_filterPriority'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<MailInFilterRows> GetFromIdxPriorityAsync(int priority, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | priority | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<MailInFilterRows> | Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table |
Remarks
This method represents one of the unique indexes on the MailInFilter table. Non-unique indexes have corresponding inner classes and methods in the MailInFilterRows collection, since they may return more than one row.
GetFromIdxReplyTemplateIdAsync(int, CancellationToken)
Create a new instance of the MailInFilterRow object, by querying the database table via the index 'IDXMail_in_filterReply_template_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<MailInFilterRows> GetFromIdxReplyTemplateIdAsync(int replyTemplateId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | replyTemplateId | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<MailInFilterRows> | Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table |
Remarks
This method represents one of the unique indexes on the MailInFilter table. Non-unique indexes have corresponding inner classes and methods in the MailInFilterRows collection, since they may return more than one row.
GetFromReaderAsync(SoDataReader, MailInFilterTableInfo, CancellationToken)
Create a new instance of the MailInFilterRows 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 MailInFilterRow 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<MailInFilterRows> GetFromReaderAsync(SoDataReader reader, MailInFilterTableInfo tableInfo, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | SoDataReader positioned to a valid database row. |
| MailInFilterTableInfo | tableInfo | MailInFilterTableInfo 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<MailInFilterRows> |
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 MailInFilterRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MailInFilterRows MailInFilterRows.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(MailInFilterRow)
Removes the given MailInFilterRow from the collection
Declaration
public void Remove(MailInFilterRow row)
Parameters
| Type | Name | Description |
|---|---|---|
| MailInFilterRow | row | the MailInFilterRow 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 MailInFilterRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MailInFilterRows MailInFilterRows.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()
This table contains entries for the mailboxes the eJournal system is fetching mail from (POP3 or IMAP). Collection of MailInFilterRow. Each element of the collection represents one row in the MailInFilter table.
Declaration
public MailInFilterRow[] ToArray()
Returns
| Type | Description |
|---|---|
| MailInFilterRow[] |
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 MailInFilterRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MailInFilterRows MailInFilterRows.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 MailInFilterRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MailInFilterRows MailInFilterRows.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.