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