Class CompanyRows

Information on license and owner of this SuperOffice database. This table should only have 1 row. This table contains encrypted license information. Changing it will disable login for all users and require you to restore the database from backup. Collection of CompanyRow. Each element of the collection represents one row in the Company table.

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

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

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

Methods

Add(CompanyRow)

Add one CompanyRow to the collection.

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

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

The index of the added CompanyRow.

AddNew()

Add a new instance of CompanyRow added to the collection.

Declaration
public CompanyRow AddNew()
Returns
Type Description
CompanyRow

A new instance of CompanyRow added to the collection.

AddRange(IEnumerable<CompanyRow>)

Add a range of CompanyRow to the collection.

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

The updated CompanyRows collection object.

CreateChild()

Create a new instance of CompanyRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of CompanyRow
Overrides

CreateNew()

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

Declaration
public static CompanyRows CreateNew()
Returns
Type Description
CompanyRows

A new instance of the CompanyRows object.

Find(Predicate<CompanyRow>)

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

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

FindAll(Predicate<CompanyRow>)

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

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

ForEach(Action<CompanyRow>)

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

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

GetFromCustomSearch(CompanyRows.CustomSearch)

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

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

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

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

GetFromReader(SoDataReader, CompanyTableInfo)

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

SoDataReader positioned to a valid database row.
CompanyTableInfo tableInfo

CompanyTableInfo 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
CompanyRows

Remove(CompanyRow)

Removes the given CompanyRow from the collection

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

the CompanyRow to be removed

ToArray()

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

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)