Class ForeignDeviceRows

Middle level of Foreign Key system Collection of ForeignDeviceRow. Each element of the collection represents one row in the ForeignDevice table.

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

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

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

Add one ForeignDeviceRow to the collection.

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

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

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

Declaration
public ForeignDeviceRow AddNew()
Returns
Type Description
ForeignDeviceRow

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

Add a range of ForeignDeviceRow to the collection.

Declaration
public ForeignDeviceRows AddRange(IEnumerable<ForeignDeviceRow> rows)
Parameters
Type Name Description
IEnumerable<ForeignDeviceRow> rows
Returns
Type Description
ForeignDeviceRows

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

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

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

Declaration
public static ForeignDeviceRows CreateNew()
Returns
Type Description
ForeignDeviceRows

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

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

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

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

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

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

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

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

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

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

GetFromIdxDeviceId(string)

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

Declaration
public static ForeignDeviceRows GetFromIdxDeviceId(string deviceId)
Parameters
Type Name Description
string deviceId
Returns
Type Description
ForeignDeviceRows

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

GetFromIdxForeignappId(int)

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

Declaration
public static ForeignDeviceRows GetFromIdxForeignappId(int foreignappId)
Parameters
Type Name Description
int foreignappId
Returns
Type Description
ForeignDeviceRows

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

GetFromIdxName(string)

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

Declaration
public static ForeignDeviceRows GetFromIdxName(string name)
Parameters
Type Name Description
string name
Returns
Type Description
ForeignDeviceRows

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

GetFromIdxOwnerId(int)

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

Declaration
public static ForeignDeviceRows GetFromIdxOwnerId(int ownerId)
Parameters
Type Name Description
int ownerId
Returns
Type Description
ForeignDeviceRows

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

GetFromReader(SoDataReader, ForeignDeviceTableInfo)

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

SoDataReader positioned to a valid database row.
ForeignDeviceTableInfo tableInfo

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

Removes the given ForeignDeviceRow from the collection

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

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

Middle level of Foreign Key system Collection of ForeignDeviceRow. Each element of the collection represents one row in the ForeignDevice table.

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