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