Class MessageIdRows
This table links an email message id to an eJournal item Collection of MessageIdRow. Each element of the collection represents one row in the MessageId table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class MessageIdRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, 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 MessageIdRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MessageIdRows MessageIdRows.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(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
this[int]
Get a MessageIdRow given its index in the collection.
Declaration
public MessageIdRow this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
int | index | Index of the MessageIdRow in the collection |
Property Value
Type | Description |
---|---|
MessageIdRow |
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 MessageIdRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MessageIdRows MessageIdRows.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(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.
Methods
Add(MessageIdRow)
Add one MessageIdRow to the collection.
Declaration
public int Add(MessageIdRow row)
Parameters
Type | Name | Description |
---|---|---|
MessageIdRow | row | An instance of MessageIdRow to be added to the collection. |
Returns
Type | Description |
---|---|
int | The index of the added MessageIdRow. |
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 MessageIdRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MessageIdRows MessageIdRows.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(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.
AddNew()
Add a new instance of MessageIdRow added to the collection.
Declaration
public MessageIdRow AddNew()
Returns
Type | Description |
---|---|
MessageIdRow | A new instance of MessageIdRow 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 MessageIdRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MessageIdRows MessageIdRows.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(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.
AddRange(IEnumerable<MessageIdRow>)
Add a range of MessageIdRow to the collection.
Declaration
public MessageIdRows AddRange(IEnumerable<MessageIdRow> rows)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<MessageIdRow> | rows |
Returns
Type | Description |
---|---|
MessageIdRows | The updated MessageIdRows 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 MessageIdRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MessageIdRows MessageIdRows.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(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.
CreateChild()
Create a new instance of MessageIdRow
Declaration
protected override TableRowBase CreateChild()
Returns
Type | Description |
---|---|
TableRowBase | New instance of MessageIdRow |
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 MessageIdRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MessageIdRows MessageIdRows.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(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.
CreateNew()
Create a new instance of the MessageIdRows object. This collection will contain no rows.
Declaration
public static MessageIdRows CreateNew()
Returns
Type | Description |
---|---|
MessageIdRows | A new instance of the MessageIdRows 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 MessageIdRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MessageIdRows MessageIdRows.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(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.
Find(Predicate<MessageIdRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public MessageIdRow Find(Predicate<MessageIdRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<MessageIdRow> | condition |
Returns
Type | Description |
---|---|
MessageIdRow |
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 MessageIdRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MessageIdRows MessageIdRows.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(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.
FindAll(Predicate<MessageIdRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public MessageIdRows FindAll(Predicate<MessageIdRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<MessageIdRow> | condition |
Returns
Type | Description |
---|---|
MessageIdRows |
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 MessageIdRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MessageIdRows MessageIdRows.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(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.
ForEach(Action<MessageIdRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<MessageIdRow> whatToDo)
Parameters
Type | Name | Description |
---|---|---|
Action<MessageIdRow> | 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 MessageIdRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MessageIdRows MessageIdRows.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(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.
GetFromCustomSearch(CustomSearch)
Create a new instance of the MessageIdRows 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 MessageIdRow objects representing each row will be returned.
Declaration
public static MessageIdRows GetFromCustomSearch(MessageIdRows.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
MessageIdRows.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
MessageIdRows | A new instance of the MessageIdRows 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 MessageIdRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MessageIdRows MessageIdRows.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(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.
GetFromIdxDomain(int)
Create a new instance of the MessageIdRow object, by querying the database table via the index 'IDXMessage_idDomain'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static MessageIdRows GetFromIdxDomain(int domain)
Parameters
Type | Name | Description |
---|---|---|
int | domain |
Returns
Type | Description |
---|---|
MessageIdRows | 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 MessageId table. Non-unique indexes have corresponding inner classes and methods in the MessageIdRows collection, since they may return more than one row.
GetFromIdxItemId(int)
Create a new instance of the MessageIdRow object, by querying the database table via the index 'IDXMessage_idItem_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static MessageIdRows GetFromIdxItemId(int itemId)
Parameters
Type | Name | Description |
---|---|---|
int | itemId |
Returns
Type | Description |
---|---|
MessageIdRows | 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 MessageId table. Non-unique indexes have corresponding inner classes and methods in the MessageIdRows collection, since they may return more than one row.
GetFromIdxMessageId(string)
Create a new instance of the MessageIdRow object, by querying the database table via the index 'IDXMessage_idMessageId'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static MessageIdRows GetFromIdxMessageId(string messageId)
Parameters
Type | Name | Description |
---|---|---|
string | messageId |
Returns
Type | Description |
---|---|
MessageIdRows | 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 MessageId table. Non-unique indexes have corresponding inner classes and methods in the MessageIdRows collection, since they may return more than one row.
GetFromReader(SoDataReader, MessageIdTableInfo)
Create a new instance of the MessageIdRows 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 MessageIdRow 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 MessageIdRows GetFromReader(SoDataReader reader, MessageIdTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
MessageIdTableInfo | tableInfo | MessageIdTableInfo 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 |
---|---|
MessageIdRows |
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 MessageIdRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MessageIdRows MessageIdRows.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(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.
Remove(MessageIdRow)
Removes the given MessageIdRow from the collection
Declaration
public void Remove(MessageIdRow row)
Parameters
Type | Name | Description |
---|---|---|
MessageIdRow | row | the MessageIdRow 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 MessageIdRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MessageIdRows MessageIdRows.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(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.
ToArray()
This table links an email message id to an eJournal item Collection of MessageIdRow. Each element of the collection represents one row in the MessageId table.
Declaration
public MessageIdRow[] ToArray()
Returns
Type | Description |
---|---|
MessageIdRow[] |
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 MessageIdRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MessageIdRows MessageIdRows.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(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.
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 MessageIdRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) MessageIdRows MessageIdRows.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(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.