Class FormRows

A form which can be published on a webpage and submitted by visitors Collection of FormRow. Each element of the collection represents one row in the Form table.

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

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

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

Methods

Add(FormRow)

Add one FormRow to the collection.

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

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

The index of the added FormRow.

AddNew()

Add a new instance of FormRow added to the collection.

Declaration
public FormRow AddNew()
Returns
Type Description
FormRow

A new instance of FormRow added to the collection.

AddRange(IEnumerable<FormRow>)

Add a range of FormRow to the collection.

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

The updated FormRows collection object.

CreateChild()

Create a new instance of FormRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of FormRow
Overrides

CreateNew()

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

Declaration
public static FormRows CreateNew()
Returns
Type Description
FormRows

A new instance of the FormRows object.

Find(Predicate<FormRow>)

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

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

FindAll(Predicate<FormRow>)

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

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

ForEach(Action<FormRow>)

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

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

GetFromCustomSearch(FormRows.CustomSearch)

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

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

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

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

GetFromIdxFormKey(String)

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

Declaration
public static FormRows GetFromIdxFormKey(string formKey)
Parameters
Type Name Description
System.String formKey
Returns
Type Description
FormRows

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

GetFromIdxResponseShipmentId(Int32)

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

Declaration
public static FormRows GetFromIdxResponseShipmentId(int responseShipmentId)
Parameters
Type Name Description
System.Int32 responseShipmentId
Returns
Type Description
FormRows

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

GetFromIdxScriptId(Int32)

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

Declaration
public static FormRows GetFromIdxScriptId(int scriptId)
Parameters
Type Name Description
System.Int32 scriptId
Returns
Type Description
FormRows

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

GetFromReader(SoDataReader, FormTableInfo)

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

SoDataReader positioned to a valid database row.
FormTableInfo tableInfo

FormTableInfo 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
FormRows

Remove(FormRow)

Removes the given FormRow from the collection

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

the FormRow to be removed

ToArray()

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

ToString()

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

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

Implements

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

Extension Methods

EnumUtil.MapEnums<From, To>(From)