Class EmailFolderRows

Corresponds to an email folder on a mail server Collection of EmailFolderRow. Each element of the collection represents one row in the EmailFolder table.

Inheritance
Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
EmailFolderRows
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class EmailFolderRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IList, ICollection, IEnumerable, INotifyCollectionChanged, IBindingList
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 EmailFolderRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) EmailFolderRows EmailFolderRows.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(EmailFolderRows.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.
Unique indexes are handled through the EmailFolderRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, EmailFolderTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

Properties

Item[Int32]

Get a EmailFolderRow given its index in the collection.

Declaration
public EmailFolderRow this[int index] { get; }
Parameters
Type Name Description
Int32 index

Index of the EmailFolderRow in the collection
Property Value
Type Description
EmailFolderRow

Methods

Add(EmailFolderRow)

Add one EmailFolderRow to the collection.

Declaration
public int Add(EmailFolderRow row)
Parameters
Type Name Description
EmailFolderRow row

An instance of EmailFolderRow to be added to the collection.
Returns
Type Description
Int32

The index of the added EmailFolderRow.

AddNew()

Add a new instance of EmailFolderRow added to the collection.

Declaration
public EmailFolderRow AddNew()
Returns
Type Description
EmailFolderRow

A new instance of EmailFolderRow added to the collection.

AddRange(IEnumerable<EmailFolderRow>)

Add a range of EmailFolderRow to the collection.

Declaration
public EmailFolderRows AddRange(IEnumerable<EmailFolderRow> rows)
Parameters
Type Name Description
IEnumerable<EmailFolderRow> rows
Returns
Type Description
EmailFolderRows

The updated EmailFolderRows collection object.

CreateChild()

Create a new instance of EmailFolderRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of EmailFolderRow
Overrides

CreateNew()

Create a new instance of the EmailFolderRows object. This collection will contain no rows.

Declaration
public static EmailFolderRows CreateNew()
Returns
Type Description
EmailFolderRows

A new instance of the EmailFolderRows object.

Find(Predicate<EmailFolderRow>)

Apply the predicate to each element of the collection and return the first row that matches; if no match then return null

Declaration
public EmailFolderRow Find(Predicate<EmailFolderRow> condition)
Parameters
Type Name Description
Predicate<EmailFolderRow> condition
Returns
Type Description
EmailFolderRow

FindAll(Predicate<EmailFolderRow>)

Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection

Declaration
public EmailFolderRows FindAll(Predicate<EmailFolderRow> condition)
Parameters
Type Name Description
Predicate<EmailFolderRow> condition
Returns
Type Description
EmailFolderRows

ForEach(Action<EmailFolderRow>)

Method that iterates over all members and applies the action parameter to each of them

Declaration
public void ForEach(Action<EmailFolderRow> whatToDo)
Parameters
Type Name Description
Action<EmailFolderRow> whatToDo

GetFromCustomSearch(EmailFolderRows.CustomSearch)

Create a new instance of the EmailFolderRows 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 EmailFolderRow objects representing each row will be returned.

Declaration
public static EmailFolderRows GetFromCustomSearch(EmailFolderRows.CustomSearch query)
Parameters
Type Name Description
EmailFolderRows.CustomSearch query

The custom search to execute against the database
Returns
Type Description
EmailFolderRows

A new instance of the EmailFolderRows object, reflecting the result of the query.

GetFromIdxAccountId(Int32)

Create a new instance of the EmailFolderRow object, by querying the database table via the index 'IDXEmail_folderAccount_id'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static EmailFolderRows GetFromIdxAccountId(int accountId)
Parameters
Type Name Description
Int32 accountId
Returns
Type Description
EmailFolderRows

Row object that represents the result of the search. 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 EmailFolder table. Non-unique indexes have corresponding inner classes and methods in the EmailFolderRows collection, since they may return more than one row.

GetFromReader(SoDataReader, EmailFolderTableInfo)

Create a new instance of the EmailFolderRows 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 EmailFolderRow 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 EmailFolderRows GetFromReader(SoDataReader reader, EmailFolderTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
EmailFolderTableInfo tableInfo

EmailFolderTableInfo 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
EmailFolderRows

Remove(EmailFolderRow)

Removes the given EmailFolderRow from the collection

Declaration
public void Remove(EmailFolderRow row)
Parameters
Type Name Description
EmailFolderRow row

the EmailFolderRow to be removed

ToArray()

Declaration
public EmailFolderRow[] ToArray()
Returns
Type Description
EmailFolderRow[]

ToString()

For debugging: Number of members, and the first (up to) 5 items

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)