Class SORFieldRows

SuperOffice reporter data Collection of SORFieldRow. Each element of the collection represents one row in the SORField table.

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

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

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

Add one SORFieldRow to the collection.

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

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

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

Declaration
public SORFieldRow AddNew()
Returns
Type Description
SORFieldRow

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

Add a range of SORFieldRow to the collection.

Declaration
public SORFieldRows AddRange(IEnumerable<SORFieldRow> rows)
Parameters
Type Name Description
IEnumerable<SORFieldRow> rows
Returns
Type Description
SORFieldRows

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

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SORFieldRow
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 SORFieldRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SORFieldRows SORFieldRows.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 SORFieldRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SORFieldTableInfo) 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 SORFieldRows object. This collection will contain no rows.

Declaration
public static SORFieldRows CreateNew()
Returns
Type Description
SORFieldRows

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

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

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

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

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

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

Declaration
public void ForEach(Action<SORFieldRow> whatToDo)
Parameters
Type Name Description
Action<SORFieldRow> 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 SORFieldRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SORFieldRows SORFieldRows.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 SORFieldRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SORFieldTableInfo) 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 SORFieldRows 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 SORFieldRow objects representing each row will be returned.

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

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

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

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

Declaration
public static SORFieldRows GetFromIdxFieldType(string fieldType)
Parameters
Type Name Description
string fieldType
Returns
Type Description
SORFieldRows

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

GetFromIdxSORSectionId(int)

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

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

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

GetFromIdxVisible(short)

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

Declaration
public static SORFieldRows GetFromIdxVisible(short visible)
Parameters
Type Name Description
short visible
Returns
Type Description
SORFieldRows

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

GetFromReader(SoDataReader, SORFieldTableInfo)

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

SoDataReader positioned to a valid database row.
SORFieldTableInfo tableInfo

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

Removes the given SORFieldRow from the collection

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

the SORFieldRow 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 SORFieldRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SORFieldRows SORFieldRows.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 SORFieldRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SORFieldTableInfo) 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 SORFieldRow. Each element of the collection represents one row in the SORField table.

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