Class ExtraTablesRows
This table contains entries for the extra tables in the system. Collection of ExtraTablesRow. Each element of the collection represents one row in the ExtraTables table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class ExtraTablesRows : 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 ExtraTablesRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExtraTablesRows ExtraTablesRows.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 ExtraTablesRow given its index in the collection.
Declaration
public ExtraTablesRow this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
int | index | Index of the ExtraTablesRow in the collection |
Property Value
Type | Description |
---|---|
ExtraTablesRow |
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 ExtraTablesRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExtraTablesRows ExtraTablesRows.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(ExtraTablesRow)
Add one ExtraTablesRow to the collection.
Declaration
public int Add(ExtraTablesRow row)
Parameters
Type | Name | Description |
---|---|---|
ExtraTablesRow | row | An instance of ExtraTablesRow to be added to the collection. |
Returns
Type | Description |
---|---|
int | The index of the added ExtraTablesRow. |
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 ExtraTablesRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExtraTablesRows ExtraTablesRows.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 ExtraTablesRow added to the collection.
Declaration
public ExtraTablesRow AddNew()
Returns
Type | Description |
---|---|
ExtraTablesRow | A new instance of ExtraTablesRow 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 ExtraTablesRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExtraTablesRows ExtraTablesRows.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<ExtraTablesRow>)
Add a range of ExtraTablesRow to the collection.
Declaration
public ExtraTablesRows AddRange(IEnumerable<ExtraTablesRow> rows)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<ExtraTablesRow> | rows |
Returns
Type | Description |
---|---|
ExtraTablesRows | The updated ExtraTablesRows 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 ExtraTablesRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExtraTablesRows ExtraTablesRows.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 ExtraTablesRow
Declaration
protected override TableRowBase CreateChild()
Returns
Type | Description |
---|---|
TableRowBase | New instance of ExtraTablesRow |
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 ExtraTablesRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExtraTablesRows ExtraTablesRows.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 ExtraTablesRows object. This collection will contain no rows.
Declaration
public static ExtraTablesRows CreateNew()
Returns
Type | Description |
---|---|
ExtraTablesRows | A new instance of the ExtraTablesRows 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 ExtraTablesRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExtraTablesRows ExtraTablesRows.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<ExtraTablesRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public ExtraTablesRow Find(Predicate<ExtraTablesRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<ExtraTablesRow> | condition |
Returns
Type | Description |
---|---|
ExtraTablesRow |
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 ExtraTablesRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExtraTablesRows ExtraTablesRows.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<ExtraTablesRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public ExtraTablesRows FindAll(Predicate<ExtraTablesRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<ExtraTablesRow> | condition |
Returns
Type | Description |
---|---|
ExtraTablesRows |
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 ExtraTablesRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExtraTablesRows ExtraTablesRows.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<ExtraTablesRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<ExtraTablesRow> whatToDo)
Parameters
Type | Name | Description |
---|---|---|
Action<ExtraTablesRow> | 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 ExtraTablesRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExtraTablesRows ExtraTablesRows.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 ExtraTablesRows 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 ExtraTablesRow objects representing each row will be returned.
Declaration
public static ExtraTablesRows GetFromCustomSearch(ExtraTablesRows.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
ExtraTablesRows.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
ExtraTablesRows | A new instance of the ExtraTablesRows 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 ExtraTablesRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExtraTablesRows ExtraTablesRows.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.
GetFromIdxDisplayField(int)
Create a new instance of the ExtraTablesRow object, by querying the database table via the index 'IDXExtra_tablesDisplay_field'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ExtraTablesRows GetFromIdxDisplayField(int displayField)
Parameters
Type | Name | Description |
---|---|---|
int | displayField |
Returns
Type | Description |
---|---|
ExtraTablesRows | 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 ExtraTables table. Non-unique indexes have corresponding inner classes and methods in the ExtraTablesRows collection, since they may return more than one row.
GetFromIdxFullnameField(int)
Create a new instance of the ExtraTablesRow object, by querying the database table via the index 'IDXExtra_tablesFullname_field'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ExtraTablesRows GetFromIdxFullnameField(int fullnameField)
Parameters
Type | Name | Description |
---|---|---|
int | fullnameField |
Returns
Type | Description |
---|---|
ExtraTablesRows | 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 ExtraTables table. Non-unique indexes have corresponding inner classes and methods in the ExtraTablesRows collection, since they may return more than one row.
GetFromIdxHierarchyId(int)
Create a new instance of the ExtraTablesRow object, by querying the database table via the index 'IDXExtra_tablesHierarchy_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ExtraTablesRows GetFromIdxHierarchyId(int hierarchyId)
Parameters
Type | Name | Description |
---|---|---|
int | hierarchyId |
Returns
Type | Description |
---|---|
ExtraTablesRows | 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 ExtraTables table. Non-unique indexes have corresponding inner classes and methods in the ExtraTablesRows collection, since they may return more than one row.
GetFromIdxParentField(int)
Create a new instance of the ExtraTablesRow object, by querying the database table via the index 'IDXExtra_tablesParent_field'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ExtraTablesRows GetFromIdxParentField(int parentField)
Parameters
Type | Name | Description |
---|---|---|
int | parentField |
Returns
Type | Description |
---|---|
ExtraTablesRows | 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 ExtraTables table. Non-unique indexes have corresponding inner classes and methods in the ExtraTablesRows collection, since they may return more than one row.
GetFromIdxScreenChooserAll(int)
Create a new instance of the ExtraTablesRow object, by querying the database table via the index 'IDXExtra_tablesScreen_chooser_all'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ExtraTablesRows GetFromIdxScreenChooserAll(int screenChooserAll)
Parameters
Type | Name | Description |
---|---|---|
int | screenChooserAll |
Returns
Type | Description |
---|---|
ExtraTablesRows | 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 ExtraTables table. Non-unique indexes have corresponding inner classes and methods in the ExtraTablesRows collection, since they may return more than one row.
GetFromIdxScreenChooserEdit(int)
Create a new instance of the ExtraTablesRow object, by querying the database table via the index 'IDXExtra_tablesScreen_chooser_edit'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ExtraTablesRows GetFromIdxScreenChooserEdit(int screenChooserEdit)
Parameters
Type | Name | Description |
---|---|---|
int | screenChooserEdit |
Returns
Type | Description |
---|---|
ExtraTablesRows | 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 ExtraTables table. Non-unique indexes have corresponding inner classes and methods in the ExtraTablesRows collection, since they may return more than one row.
GetFromIdxScreenChooserEntry(int)
Create a new instance of the ExtraTablesRow object, by querying the database table via the index 'IDXExtra_tablesScreen_chooser_entry'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ExtraTablesRows GetFromIdxScreenChooserEntry(int screenChooserEntry)
Parameters
Type | Name | Description |
---|---|---|
int | screenChooserEntry |
Returns
Type | Description |
---|---|
ExtraTablesRows | 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 ExtraTables table. Non-unique indexes have corresponding inner classes and methods in the ExtraTablesRows collection, since they may return more than one row.
GetFromReader(SoDataReader, ExtraTablesTableInfo)
Create a new instance of the ExtraTablesRows 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 ExtraTablesRow 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 ExtraTablesRows GetFromReader(SoDataReader reader, ExtraTablesTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
ExtraTablesTableInfo | tableInfo | ExtraTablesTableInfo 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 |
---|---|
ExtraTablesRows |
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 ExtraTablesRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExtraTablesRows ExtraTablesRows.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(ExtraTablesRow)
Removes the given ExtraTablesRow from the collection
Declaration
public void Remove(ExtraTablesRow row)
Parameters
Type | Name | Description |
---|---|---|
ExtraTablesRow | row | the ExtraTablesRow 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 ExtraTablesRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExtraTablesRows ExtraTablesRows.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()
This table contains entries for the extra tables in the system. Collection of ExtraTablesRow. Each element of the collection represents one row in the ExtraTables table.
Declaration
public ExtraTablesRow[] ToArray()
Returns
Type | Description |
---|---|
ExtraTablesRow[] |
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 ExtraTablesRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExtraTablesRows ExtraTablesRows.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 ExtraTablesRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExtraTablesRows ExtraTablesRows.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.