Class MsFilterRows

This table contains email filters. These are the filters allowing you to do advanced parsing of incomming emails. Collection of MsFilterRow. Each element of the collection represents one row in the MsFilter table.

Inheritance
System.Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
MsFilterRows
Implements
System.Collections.Generic.IEnumerable<INestedPersist>
System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class MsFilterRows : 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 MsFilterRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) MsFilterRows MsFilterRows.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(MsFilterRows.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 MsFilterRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, MsFilterTableInfo) 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 MsFilterRow given its index in the collection.

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

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

Methods

Add(MsFilterRow)

Add one MsFilterRow to the collection.

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

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

The index of the added MsFilterRow.

AddNew()

Add a new instance of MsFilterRow added to the collection.

Declaration
public MsFilterRow AddNew()
Returns
Type Description
MsFilterRow

A new instance of MsFilterRow added to the collection.

AddRange(IEnumerable<MsFilterRow>)

Add a range of MsFilterRow to the collection.

Declaration
public MsFilterRows AddRange(IEnumerable<MsFilterRow> rows)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<MsFilterRow> rows
Returns
Type Description
MsFilterRows

The updated MsFilterRows collection object.

CreateChild()

Create a new instance of MsFilterRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of MsFilterRow
Overrides

CreateNew()

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

Declaration
public static MsFilterRows CreateNew()
Returns
Type Description
MsFilterRows

A new instance of the MsFilterRows object.

Find(Predicate<MsFilterRow>)

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

Declaration
public MsFilterRow Find(Predicate<MsFilterRow> condition)
Parameters
Type Name Description
System.Predicate<MsFilterRow> condition
Returns
Type Description
MsFilterRow

FindAll(Predicate<MsFilterRow>)

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

Declaration
public MsFilterRows FindAll(Predicate<MsFilterRow> condition)
Parameters
Type Name Description
System.Predicate<MsFilterRow> condition
Returns
Type Description
MsFilterRows

ForEach(Action<MsFilterRow>)

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

Declaration
public void ForEach(Action<MsFilterRow> whatToDo)
Parameters
Type Name Description
System.Action<MsFilterRow> whatToDo

GetFromCustomSearch(MsFilterRows.CustomSearch)

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

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

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

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

GetFromIdxAutofaqReplyCategory(Int32)

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

Declaration
public static MsFilterRows GetFromIdxAutofaqReplyCategory(int autofaqReplyCategory)
Parameters
Type Name Description
System.Int32 autofaqReplyCategory
Returns
Type Description
MsFilterRows

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 MsFilter table. Non-unique indexes have corresponding inner classes and methods in the MsFilterRows collection, since they may return more than one row.

GetFromIdxBodyTemplate(Int32)

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

Declaration
public static MsFilterRows GetFromIdxBodyTemplate(int bodyTemplate)
Parameters
Type Name Description
System.Int32 bodyTemplate
Returns
Type Description
MsFilterRows

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 MsFilter table. Non-unique indexes have corresponding inner classes and methods in the MsFilterRows collection, since they may return more than one row.

GetFromIdxEjscript(Int32)

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

Declaration
public static MsFilterRows GetFromIdxEjscript(int ejscript)
Parameters
Type Name Description
System.Int32 ejscript
Returns
Type Description
MsFilterRows

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 MsFilter table. Non-unique indexes have corresponding inner classes and methods in the MsFilterRows collection, since they may return more than one row.

GetFromIdxNewCategory(Int32)

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

Declaration
public static MsFilterRows GetFromIdxNewCategory(int newCategory)
Parameters
Type Name Description
System.Int32 newCategory
Returns
Type Description
MsFilterRows

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 MsFilter table. Non-unique indexes have corresponding inner classes and methods in the MsFilterRows collection, since they may return more than one row.

GetFromIdxNewOwner(Int32)

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

Declaration
public static MsFilterRows GetFromIdxNewOwner(int newOwner)
Parameters
Type Name Description
System.Int32 newOwner
Returns
Type Description
MsFilterRows

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 MsFilter table. Non-unique indexes have corresponding inner classes and methods in the MsFilterRows collection, since they may return more than one row.

GetFromIdxNewPriority(Int32)

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

Declaration
public static MsFilterRows GetFromIdxNewPriority(int newPriority)
Parameters
Type Name Description
System.Int32 newPriority
Returns
Type Description
MsFilterRows

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 MsFilter table. Non-unique indexes have corresponding inner classes and methods in the MsFilterRows collection, since they may return more than one row.

GetFromIdxReplyTemplate(Int32)

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

Declaration
public static MsFilterRows GetFromIdxReplyTemplate(int replyTemplate)
Parameters
Type Name Description
System.Int32 replyTemplate
Returns
Type Description
MsFilterRows

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 MsFilter table. Non-unique indexes have corresponding inner classes and methods in the MsFilterRows collection, since they may return more than one row.

GetFromReader(SoDataReader, MsFilterTableInfo)

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

SoDataReader positioned to a valid database row.
MsFilterTableInfo tableInfo

MsFilterTableInfo 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
MsFilterRows

Remove(MsFilterRow)

Removes the given MsFilterRow from the collection

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

the MsFilterRow to be removed

ToArray()

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

ToString()

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

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

Implements

System.Collections.Generic.IEnumerable<T>
System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList

Extension Methods

EnumUtil.MapEnums<From, To>(From)