Class ForeignKeyRows
Foreign Key - enables storage of arbitrary extra key information for every table/row in SuperOffice. You may use this table to store your extra information instead of using the dictionary SDK to create your own tables. Collection of ForeignKeyRow. Each element of the collection represents one row in the ForeignKey table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class ForeignKeyRows : 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 ForeignKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ForeignKeyRows ForeignKeyRows.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.
Properties
this[int]
Get a ForeignKeyRow given its index in the collection.
Declaration
public ForeignKeyRow this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
int | index | Index of the ForeignKeyRow in the collection |
Property Value
Type | Description |
---|---|
ForeignKeyRow |
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 ForeignKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ForeignKeyRows ForeignKeyRows.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.
Methods
Add(ForeignKeyRow)
Add one ForeignKeyRow to the collection.
Declaration
public int Add(ForeignKeyRow row)
Parameters
Type | Name | Description |
---|---|---|
ForeignKeyRow | row | An instance of ForeignKeyRow to be added to the collection. |
Returns
Type | Description |
---|---|
int | The index of the added ForeignKeyRow. |
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 ForeignKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ForeignKeyRows ForeignKeyRows.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.
AddNew()
Add a new instance of ForeignKeyRow added to the collection.
Declaration
public ForeignKeyRow AddNew()
Returns
Type | Description |
---|---|
ForeignKeyRow | A new instance of ForeignKeyRow 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 ForeignKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ForeignKeyRows ForeignKeyRows.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.
AddRange(IEnumerable<ForeignKeyRow>)
Add a range of ForeignKeyRow to the collection.
Declaration
public ForeignKeyRows AddRange(IEnumerable<ForeignKeyRow> rows)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<ForeignKeyRow> | rows |
Returns
Type | Description |
---|---|
ForeignKeyRows | The updated ForeignKeyRows 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 ForeignKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ForeignKeyRows ForeignKeyRows.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.
CreateChild()
Create a new instance of ForeignKeyRow
Declaration
protected override TableRowBase CreateChild()
Returns
Type | Description |
---|---|
TableRowBase | New instance of ForeignKeyRow |
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 ForeignKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ForeignKeyRows ForeignKeyRows.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.
CreateNew()
Create a new instance of the ForeignKeyRows object. This collection will contain no rows.
Declaration
public static ForeignKeyRows CreateNew()
Returns
Type | Description |
---|---|
ForeignKeyRows | A new instance of the ForeignKeyRows 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 ForeignKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ForeignKeyRows ForeignKeyRows.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.
Find(Predicate<ForeignKeyRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public ForeignKeyRow Find(Predicate<ForeignKeyRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<ForeignKeyRow> | condition |
Returns
Type | Description |
---|---|
ForeignKeyRow |
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 ForeignKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ForeignKeyRows ForeignKeyRows.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.
FindAll(Predicate<ForeignKeyRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public ForeignKeyRows FindAll(Predicate<ForeignKeyRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<ForeignKeyRow> | condition |
Returns
Type | Description |
---|---|
ForeignKeyRows |
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 ForeignKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ForeignKeyRows ForeignKeyRows.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.
ForEach(Action<ForeignKeyRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<ForeignKeyRow> whatToDo)
Parameters
Type | Name | Description |
---|---|---|
Action<ForeignKeyRow> | 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 ForeignKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ForeignKeyRows ForeignKeyRows.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.
GetFromCustomSearch(CustomSearch)
Create a new instance of the ForeignKeyRows 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 ForeignKeyRow objects representing each row will be returned.
Declaration
public static ForeignKeyRows GetFromCustomSearch(ForeignKeyRows.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
ForeignKeyRows.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
ForeignKeyRows | A new instance of the ForeignKeyRows 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 ForeignKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ForeignKeyRows ForeignKeyRows.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.
GetFromIdxForeigndeviceId(int)
Create a new instance of the ForeignKeyRow object, by querying the database table via the index 'IDXFkKeyForeigndevice_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ForeignKeyRows GetFromIdxForeigndeviceId(int foreigndeviceId)
Parameters
Type | Name | Description |
---|---|---|
int | foreigndeviceId |
Returns
Type | Description |
---|---|
ForeignKeyRows | 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 ForeignKey table. Non-unique indexes have corresponding inner classes and methods in the ForeignKeyRows collection, since they may return more than one row.
GetFromIdxRecordId(int)
Create a new instance of the ForeignKeyRow object, by querying the database table via the index 'IDXFkKeyRecord_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ForeignKeyRows GetFromIdxRecordId(int recordId)
Parameters
Type | Name | Description |
---|---|---|
int | recordId |
Returns
Type | Description |
---|---|
ForeignKeyRows | 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 ForeignKey table. Non-unique indexes have corresponding inner classes and methods in the ForeignKeyRows collection, since they may return more than one row.
GetFromIdxSeqno(int)
Create a new instance of the ForeignKeyRow object, by querying the database table via the index 'IDXFkKeySeqno'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ForeignKeyRows GetFromIdxSeqno(int seqno)
Parameters
Type | Name | Description |
---|---|---|
int | seqno |
Returns
Type | Description |
---|---|
ForeignKeyRows | 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 ForeignKey table. Non-unique indexes have corresponding inner classes and methods in the ForeignKeyRows collection, since they may return more than one row.
GetFromIdxSubkey(string)
Create a new instance of the ForeignKeyRow object, by querying the database table via the index 'IDXFkKeySubkey'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ForeignKeyRows GetFromIdxSubkey(string subkey)
Parameters
Type | Name | Description |
---|---|---|
string | subkey |
Returns
Type | Description |
---|---|
ForeignKeyRows | 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 ForeignKey table. Non-unique indexes have corresponding inner classes and methods in the ForeignKeyRows collection, since they may return more than one row.
GetFromIdxSubvalue(string)
Create a new instance of the ForeignKeyRow object, by querying the database table via the index 'IDXFkKeySubvalue'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ForeignKeyRows GetFromIdxSubvalue(string subvalue)
Parameters
Type | Name | Description |
---|---|---|
string | subvalue |
Returns
Type | Description |
---|---|
ForeignKeyRows | 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 ForeignKey table. Non-unique indexes have corresponding inner classes and methods in the ForeignKeyRows collection, since they may return more than one row.
GetFromReader(SoDataReader, ForeignKeyTableInfo)
Create a new instance of the ForeignKeyRows 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 ForeignKeyRow 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 ForeignKeyRows GetFromReader(SoDataReader reader, ForeignKeyTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
ForeignKeyTableInfo | tableInfo | ForeignKeyTableInfo 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 |
---|---|
ForeignKeyRows |
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 ForeignKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ForeignKeyRows ForeignKeyRows.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.
Remove(ForeignKeyRow)
Removes the given ForeignKeyRow from the collection
Declaration
public void Remove(ForeignKeyRow row)
Parameters
Type | Name | Description |
---|---|---|
ForeignKeyRow | row | the ForeignKeyRow 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 ForeignKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ForeignKeyRows ForeignKeyRows.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.
ToArray()
Foreign Key - enables storage of arbitrary extra key information for every table/row in SuperOffice. You may use this table to store your extra information instead of using the dictionary SDK to create your own tables. Collection of ForeignKeyRow. Each element of the collection represents one row in the ForeignKey table.
Declaration
public ForeignKeyRow[] ToArray()
Returns
Type | Description |
---|---|
ForeignKeyRow[] |
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 ForeignKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ForeignKeyRows ForeignKeyRows.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.
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 ForeignKeyRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ForeignKeyRows ForeignKeyRows.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.