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