Class DocTmplRows

DocTmpl list table. Describes templates available for writing new documents. Collection of DocTmplRow. Each element of the collection represents one row in the DocTmpl table.

Inheritance
System.Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
DocTmplRows
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 DocTmplRows : 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 DocTmplRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) DocTmplRows DocTmplRows.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(DocTmplRows.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 DocTmplRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, DocTmplTableInfo) 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 DocTmplRow given its index in the collection.

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

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

Methods

Add(DocTmplRow)

Add one DocTmplRow to the collection.

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

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

The index of the added DocTmplRow.

AddNew()

Add a new instance of DocTmplRow added to the collection.

Declaration
public DocTmplRow AddNew()
Returns
Type Description
DocTmplRow

A new instance of DocTmplRow added to the collection.

AddRange(IEnumerable<DocTmplRow>)

Add a range of DocTmplRow to the collection.

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

The updated DocTmplRows collection object.

CreateChild()

Create a new instance of DocTmplRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of DocTmplRow
Overrides

CreateNew()

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

Declaration
public static DocTmplRows CreateNew()
Returns
Type Description
DocTmplRows

A new instance of the DocTmplRows object.

Find(Predicate<DocTmplRow>)

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

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

FindAll(Predicate<DocTmplRow>)

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

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

ForEach(Action<DocTmplRow>)

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

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

GetFromCustomSearch(DocTmplRows.CustomSearch)

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

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

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

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

GetFromReader(SoDataReader, DocTmplTableInfo)

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

SoDataReader positioned to a valid database row.
DocTmplTableInfo tableInfo

DocTmplTableInfo 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
DocTmplRows

Remove(DocTmplRow)

Removes the given DocTmplRow from the collection

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

the DocTmplRow to be removed

ToArray()

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

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)