Class EmailRows
Email addresses for contacts, projects and persons Collection of EmailRow. Each element of the collection represents one row in the Email table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class EmailRows : 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 EmailRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) EmailRows EmailRows.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 EmailRow given its index in the collection.
Declaration
public EmailRow this[int index] { get; }
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | Index of the EmailRow in the collection |
Property Value
| Type | Description |
|---|---|
| EmailRow |
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 EmailRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) EmailRows EmailRows.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(EmailRow)
Add one EmailRow to the collection.
Declaration
public int Add(EmailRow row)
Parameters
| Type | Name | Description |
|---|---|---|
| EmailRow | row | An instance of EmailRow to be added to the collection. |
Returns
| Type | Description |
|---|---|
| int | The index of the added EmailRow. |
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 EmailRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) EmailRows EmailRows.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 EmailRow added to the collection.
Declaration
public EmailRow AddNew()
Returns
| Type | Description |
|---|---|
| EmailRow | A new instance of EmailRow 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 EmailRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) EmailRows EmailRows.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<EmailRow>)
Add a range of EmailRow to the collection.
Declaration
public EmailRows AddRange(IEnumerable<EmailRow> rows)
Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<EmailRow> | rows |
Returns
| Type | Description |
|---|---|
| EmailRows | The updated EmailRows 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 EmailRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) EmailRows EmailRows.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 EmailRow
Declaration
protected override TableRowBase CreateChild()
Returns
| Type | Description |
|---|---|
| TableRowBase | New instance of EmailRow |
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 EmailRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) EmailRows EmailRows.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 EmailRows object. This collection will contain no rows.
Declaration
public static EmailRows CreateNew()
Returns
| Type | Description |
|---|---|
| EmailRows | A new instance of the EmailRows 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 EmailRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) EmailRows EmailRows.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<EmailRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public EmailRow Find(Predicate<EmailRow> condition)
Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<EmailRow> | condition |
Returns
| Type | Description |
|---|---|
| EmailRow |
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 EmailRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) EmailRows EmailRows.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<EmailRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public EmailRows FindAll(Predicate<EmailRow> condition)
Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<EmailRow> | condition |
Returns
| Type | Description |
|---|---|
| EmailRows |
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 EmailRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) EmailRows EmailRows.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<EmailRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<EmailRow> whatToDo)
Parameters
| Type | Name | Description |
|---|---|---|
| Action<EmailRow> | 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 EmailRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) EmailRows EmailRows.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 EmailRows 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 EmailRow objects representing each row will be returned.
Declaration
public static Task<EmailRows> GetFromCustomSearchAsync(EmailRows.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| EmailRows.CustomSearch | query | The custom search to execute against the database |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<EmailRows> | A new instance of the EmailRows 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 EmailRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) EmailRows EmailRows.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.
GetFromIdxAppointmentIdAsync(int, CancellationToken)
Create a new instance of the EmailRow object, by querying the database table via the index 'IDXEmailAppointment_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<EmailRows> GetFromIdxAppointmentIdAsync(int appointmentId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | appointmentId | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<EmailRows> | 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 Email table. Non-unique indexes have corresponding inner classes and methods in the EmailRows collection, since they may return more than one row.
GetFromIdxContactIdAsync(int, CancellationToken)
Create a new instance of the EmailRow object, by querying the database table via the index 'IDXEmailContact_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<EmailRows> GetFromIdxContactIdAsync(int contactId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | contactId | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<EmailRows> | 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 Email table. Non-unique indexes have corresponding inner classes and methods in the EmailRows collection, since they may return more than one row.
GetFromIdxDbiAgentIdAsync(int, CancellationToken)
Create a new instance of the EmailRow object, by querying the database table via the index 'IDXEmailDbi_agent_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<EmailRows> GetFromIdxDbiAgentIdAsync(int dbiAgentId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | dbiAgentId | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<EmailRows> | 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 Email table. Non-unique indexes have corresponding inner classes and methods in the EmailRows collection, since they may return more than one row.
GetFromIdxEmailAddressAsync(string, CancellationToken)
Create a new instance of the EmailRow object, by querying the database table via the index 'IDXEmailEmail_address'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<EmailRows> GetFromIdxEmailAddressAsync(string emailAddress, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | emailAddress | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<EmailRows> | 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 Email table. Non-unique indexes have corresponding inner classes and methods in the EmailRows collection, since they may return more than one row.
GetFromIdxPersonIdAsync(int, CancellationToken)
Create a new instance of the EmailRow object, by querying the database table via the index 'IDXEmailPerson_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<EmailRows> GetFromIdxPersonIdAsync(int personId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | personId | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<EmailRows> | 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 Email table. Non-unique indexes have corresponding inner classes and methods in the EmailRows collection, since they may return more than one row.
GetFromIdxProjectIdAsync(int, CancellationToken)
Create a new instance of the EmailRow object, by querying the database table via the index 'IDXEmailProject_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<EmailRows> GetFromIdxProjectIdAsync(int projectId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | projectId | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<EmailRows> | 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 Email table. Non-unique indexes have corresponding inner classes and methods in the EmailRows collection, since they may return more than one row.
GetFromIdxProtocolAsync(string, CancellationToken)
Create a new instance of the EmailRow object, by querying the database table via the index 'IDXEmailProtocol'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<EmailRows> GetFromIdxProtocolAsync(string protocol, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | protocol | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<EmailRows> | 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 Email table. Non-unique indexes have corresponding inner classes and methods in the EmailRows collection, since they may return more than one row.
GetFromIdxRankAsync(short, CancellationToken)
Create a new instance of the EmailRow object, by querying the database table via the index 'IDXEmailRank'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<EmailRows> GetFromIdxRankAsync(short rank, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| short | rank | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<EmailRows> | 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 Email table. Non-unique indexes have corresponding inner classes and methods in the EmailRows collection, since they may return more than one row.
GetFromIdxReservedId1Async(int, CancellationToken)
Create a new instance of the EmailRow object, by querying the database table via the index 'IDXEmailReserved_id1'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<EmailRows> GetFromIdxReservedId1Async(int reservedId1, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | reservedId1 | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<EmailRows> | 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 Email table. Non-unique indexes have corresponding inner classes and methods in the EmailRows collection, since they may return more than one row.
GetFromIdxReservedId2Async(int, CancellationToken)
Create a new instance of the EmailRow object, by querying the database table via the index 'IDXEmailReserved_id2'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<EmailRows> GetFromIdxReservedId2Async(int reservedId2, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | reservedId2 | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<EmailRows> | 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 Email table. Non-unique indexes have corresponding inner classes and methods in the EmailRows collection, since they may return more than one row.
GetFromReaderAsync(SoDataReader, EmailTableInfo, CancellationToken)
Create a new instance of the EmailRows 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 EmailRow 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<EmailRows> GetFromReaderAsync(SoDataReader reader, EmailTableInfo tableInfo, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | SoDataReader positioned to a valid database row. |
| EmailTableInfo | tableInfo | EmailTableInfo 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<EmailRows> |
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 EmailRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) EmailRows EmailRows.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(EmailRow)
Removes the given EmailRow from the collection
Declaration
public void Remove(EmailRow row)
Parameters
| Type | Name | Description |
|---|---|---|
| EmailRow | row | the EmailRow 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 EmailRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) EmailRows EmailRows.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()
Email addresses for contacts, projects and persons Collection of EmailRow. Each element of the collection represents one row in the Email table.
Declaration
public EmailRow[] ToArray()
Returns
| Type | Description |
|---|---|
| EmailRow[] |
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 EmailRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) EmailRows EmailRows.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 EmailRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) EmailRows EmailRows.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.