Class ConfigRows
This table contains certain system-wide configuration values. Collection of ConfigRow. Each element of the collection represents one row in the Config table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class ConfigRows : 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 ConfigRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ConfigRows ConfigRows.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 ConfigRow given its index in the collection.
Declaration
public ConfigRow this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
int | index | Index of the ConfigRow in the collection |
Property Value
Type | Description |
---|---|
ConfigRow |
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 ConfigRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ConfigRows ConfigRows.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(ConfigRow)
Add one ConfigRow to the collection.
Declaration
public int Add(ConfigRow row)
Parameters
Type | Name | Description |
---|---|---|
ConfigRow | row | An instance of ConfigRow to be added to the collection. |
Returns
Type | Description |
---|---|
int | The index of the added ConfigRow. |
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 ConfigRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ConfigRows ConfigRows.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 ConfigRow added to the collection.
Declaration
public ConfigRow AddNew()
Returns
Type | Description |
---|---|
ConfigRow | A new instance of ConfigRow 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 ConfigRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ConfigRows ConfigRows.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<ConfigRow>)
Add a range of ConfigRow to the collection.
Declaration
public ConfigRows AddRange(IEnumerable<ConfigRow> rows)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<ConfigRow> | rows |
Returns
Type | Description |
---|---|
ConfigRows | The updated ConfigRows 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 ConfigRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ConfigRows ConfigRows.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 ConfigRow
Declaration
protected override TableRowBase CreateChild()
Returns
Type | Description |
---|---|
TableRowBase | New instance of ConfigRow |
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 ConfigRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ConfigRows ConfigRows.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 ConfigRows object. This collection will contain no rows.
Declaration
public static ConfigRows CreateNew()
Returns
Type | Description |
---|---|
ConfigRows | A new instance of the ConfigRows 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 ConfigRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ConfigRows ConfigRows.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<ConfigRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public ConfigRow Find(Predicate<ConfigRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<ConfigRow> | condition |
Returns
Type | Description |
---|---|
ConfigRow |
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 ConfigRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ConfigRows ConfigRows.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<ConfigRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public ConfigRows FindAll(Predicate<ConfigRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<ConfigRow> | condition |
Returns
Type | Description |
---|---|
ConfigRows |
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 ConfigRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ConfigRows ConfigRows.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<ConfigRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<ConfigRow> whatToDo)
Parameters
Type | Name | Description |
---|---|---|
Action<ConfigRow> | 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 ConfigRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ConfigRows ConfigRows.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 ConfigRows 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 ConfigRow objects representing each row will be returned.
Declaration
public static ConfigRows GetFromCustomSearch(ConfigRows.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
ConfigRows.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
ConfigRows | A new instance of the ConfigRows 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 ConfigRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ConfigRows ConfigRows.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.
GetFromReader(SoDataReader, ConfigTableInfo)
Create a new instance of the ConfigRows 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 ConfigRow 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 ConfigRows GetFromReader(SoDataReader reader, ConfigTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
ConfigTableInfo | tableInfo | ConfigTableInfo 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 |
---|---|
ConfigRows |
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 ConfigRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ConfigRows ConfigRows.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(ConfigRow)
Removes the given ConfigRow from the collection
Declaration
public void Remove(ConfigRow row)
Parameters
Type | Name | Description |
---|---|---|
ConfigRow | row | the ConfigRow 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 ConfigRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ConfigRows ConfigRows.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 certain system-wide configuration values. Collection of ConfigRow. Each element of the collection represents one row in the Config table.
Declaration
public ConfigRow[] ToArray()
Returns
Type | Description |
---|---|
ConfigRow[] |
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 ConfigRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ConfigRows ConfigRows.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 ConfigRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ConfigRows ConfigRows.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.