Class SORFCTRows

SuperOffice reporter data Collection of SORFCTRow. Each element of the collection represents one row in the SORFCT table.

Inheritance
object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
SORFCTRows
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class SORFCTRows : 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 SORFCTRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SORFCTRows SORFCTRows.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.
Unique indexes are handled through the SORFCTRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SORFCTTableInfo) 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

this[int]

Get a SORFCTRow given its index in the collection.

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

Index of the SORFCTRow in the collection
Property Value
Type Description
SORFCTRow
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 SORFCTRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SORFCTRows SORFCTRows.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.
Unique indexes are handled through the SORFCTRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SORFCTTableInfo) 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).

Methods

Add(SORFCTRow)

Add one SORFCTRow to the collection.

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

An instance of SORFCTRow to be added to the collection.
Returns
Type Description
int

The index of the added SORFCTRow.
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 SORFCTRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SORFCTRows SORFCTRows.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.
Unique indexes are handled through the SORFCTRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SORFCTTableInfo) 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).

AddNew()

Add a new instance of SORFCTRow added to the collection.

Declaration
public SORFCTRow AddNew()
Returns
Type Description
SORFCTRow

A new instance of SORFCTRow 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 SORFCTRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SORFCTRows SORFCTRows.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.
Unique indexes are handled through the SORFCTRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SORFCTTableInfo) 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).

AddRange(IEnumerable<SORFCTRow>)

Add a range of SORFCTRow to the collection.

Declaration
public SORFCTRows AddRange(IEnumerable<SORFCTRow> rows)
Parameters
Type Name Description
IEnumerable<SORFCTRow> rows
Returns
Type Description
SORFCTRows

The updated SORFCTRows 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 SORFCTRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SORFCTRows SORFCTRows.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.
Unique indexes are handled through the SORFCTRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SORFCTTableInfo) 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).

CreateChild()

Create a new instance of SORFCTRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SORFCTRow
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 SORFCTRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SORFCTRows SORFCTRows.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.
Unique indexes are handled through the SORFCTRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SORFCTTableInfo) 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).

CreateNew()

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

Declaration
public static SORFCTRows CreateNew()
Returns
Type Description
SORFCTRows

A new instance of the SORFCTRows 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 SORFCTRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SORFCTRows SORFCTRows.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.
Unique indexes are handled through the SORFCTRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SORFCTTableInfo) 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).

Find(Predicate<SORFCTRow>)

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

Declaration
public SORFCTRow Find(Predicate<SORFCTRow> condition)
Parameters
Type Name Description
Predicate<SORFCTRow> condition
Returns
Type Description
SORFCTRow
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 SORFCTRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SORFCTRows SORFCTRows.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.
Unique indexes are handled through the SORFCTRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SORFCTTableInfo) 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).

FindAll(Predicate<SORFCTRow>)

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

Declaration
public SORFCTRows FindAll(Predicate<SORFCTRow> condition)
Parameters
Type Name Description
Predicate<SORFCTRow> condition
Returns
Type Description
SORFCTRows
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 SORFCTRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SORFCTRows SORFCTRows.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.
Unique indexes are handled through the SORFCTRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SORFCTTableInfo) 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).

ForEach(Action<SORFCTRow>)

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

Declaration
public void ForEach(Action<SORFCTRow> whatToDo)
Parameters
Type Name Description
Action<SORFCTRow> 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 SORFCTRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SORFCTRows SORFCTRows.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.
Unique indexes are handled through the SORFCTRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SORFCTTableInfo) 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).

GetFromCustomSearch(CustomSearch)

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

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

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

A new instance of the SORFCTRows 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 SORFCTRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SORFCTRows SORFCTRows.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.
Unique indexes are handled through the SORFCTRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SORFCTTableInfo) 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).

GetFromIdxFieldType(short)

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

Declaration
public static SORFCTRows GetFromIdxFieldType(short fieldType)
Parameters
Type Name Description
short fieldType
Returns
Type Description
SORFCTRows

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

GetFromIdxSORSectionId(int)

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

Declaration
public static SORFCTRows GetFromIdxSORSectionId(int sORSectionId)
Parameters
Type Name Description
int sORSectionId
Returns
Type Description
SORFCTRows

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

GetFromReader(SoDataReader, SORFCTTableInfo)

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

SoDataReader positioned to a valid database row.
SORFCTTableInfo tableInfo

SORFCTTableInfo 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
SORFCTRows
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 SORFCTRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SORFCTRows SORFCTRows.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.
Unique indexes are handled through the SORFCTRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SORFCTTableInfo) 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).

Remove(SORFCTRow)

Removes the given SORFCTRow from the collection

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

the SORFCTRow 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 SORFCTRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SORFCTRows SORFCTRows.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.
Unique indexes are handled through the SORFCTRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SORFCTTableInfo) 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).

ToArray()

SuperOffice reporter data Collection of SORFCTRow. Each element of the collection represents one row in the SORFCT table.

Declaration
public SORFCTRow[] ToArray()
Returns
Type Description
SORFCTRow[]
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 SORFCTRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SORFCTRows SORFCTRows.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.
Unique indexes are handled through the SORFCTRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SORFCTTableInfo) 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).

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 SORFCTRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SORFCTRows SORFCTRows.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.
Unique indexes are handled through the SORFCTRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SORFCTTableInfo) 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).

Implements

Extension Methods