Class UDDocSmallRows
User-defined fields Collection of UDDocSmallRow. Each element of the collection represents one row in the UDDocSmall table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class UDDocSmallRows : 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 UDDocSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDDocSmallRows UDDocSmallRows.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 UDDocSmallRow given its index in the collection.
Declaration
public UDDocSmallRow this[int index] { get; }
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | Index of the UDDocSmallRow in the collection |
Property Value
| Type | Description |
|---|---|
| UDDocSmallRow |
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 UDDocSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDDocSmallRows UDDocSmallRows.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(UDDocSmallRow)
Add one UDDocSmallRow to the collection.
Declaration
public int Add(UDDocSmallRow row)
Parameters
| Type | Name | Description |
|---|---|---|
| UDDocSmallRow | row | An instance of UDDocSmallRow to be added to the collection. |
Returns
| Type | Description |
|---|---|
| int | The index of the added UDDocSmallRow. |
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 UDDocSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDDocSmallRows UDDocSmallRows.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 UDDocSmallRow added to the collection.
Declaration
public UDDocSmallRow AddNew()
Returns
| Type | Description |
|---|---|
| UDDocSmallRow | A new instance of UDDocSmallRow 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 UDDocSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDDocSmallRows UDDocSmallRows.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<UDDocSmallRow>)
Add a range of UDDocSmallRow to the collection.
Declaration
public UDDocSmallRows AddRange(IEnumerable<UDDocSmallRow> rows)
Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<UDDocSmallRow> | rows |
Returns
| Type | Description |
|---|---|
| UDDocSmallRows | The updated UDDocSmallRows 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 UDDocSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDDocSmallRows UDDocSmallRows.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 UDDocSmallRow
Declaration
protected override TableRowBase CreateChild()
Returns
| Type | Description |
|---|---|
| TableRowBase | New instance of UDDocSmallRow |
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 UDDocSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDDocSmallRows UDDocSmallRows.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 UDDocSmallRows object. This collection will contain no rows.
Declaration
public static UDDocSmallRows CreateNew()
Returns
| Type | Description |
|---|---|
| UDDocSmallRows | A new instance of the UDDocSmallRows 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 UDDocSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDDocSmallRows UDDocSmallRows.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<UDDocSmallRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public UDDocSmallRow Find(Predicate<UDDocSmallRow> condition)
Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<UDDocSmallRow> | condition |
Returns
| Type | Description |
|---|---|
| UDDocSmallRow |
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 UDDocSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDDocSmallRows UDDocSmallRows.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<UDDocSmallRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public UDDocSmallRows FindAll(Predicate<UDDocSmallRow> condition)
Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<UDDocSmallRow> | condition |
Returns
| Type | Description |
|---|---|
| UDDocSmallRows |
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 UDDocSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDDocSmallRows UDDocSmallRows.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<UDDocSmallRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<UDDocSmallRow> whatToDo)
Parameters
| Type | Name | Description |
|---|---|---|
| Action<UDDocSmallRow> | 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 UDDocSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDDocSmallRows UDDocSmallRows.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 UDDocSmallRows 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 UDDocSmallRow objects representing each row will be returned.
Declaration
public static Task<UDDocSmallRows> GetFromCustomSearchAsync(UDDocSmallRows.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| UDDocSmallRows.CustomSearch | query | The custom search to execute against the database |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<UDDocSmallRows> | A new instance of the UDDocSmallRows 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 UDDocSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDDocSmallRows UDDocSmallRows.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.
GetFromIdxDouble01Async(double, CancellationToken)
Create a new instance of the UDDocSmallRow object, by querying the database table via the index 'IDXUdDocSmallDouble01'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<UDDocSmallRows> GetFromIdxDouble01Async(double double01, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| double | double01 | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<UDDocSmallRows> | 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 UDDocSmall table. Non-unique indexes have corresponding inner classes and methods in the UDDocSmallRows collection, since they may return more than one row.
GetFromIdxDouble02Async(double, CancellationToken)
Create a new instance of the UDDocSmallRow object, by querying the database table via the index 'IDXUdDocSmallDouble02'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<UDDocSmallRows> GetFromIdxDouble02Async(double double02, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| double | double02 | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<UDDocSmallRows> | 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 UDDocSmall table. Non-unique indexes have corresponding inner classes and methods in the UDDocSmallRows collection, since they may return more than one row.
GetFromIdxDouble03Async(double, CancellationToken)
Create a new instance of the UDDocSmallRow object, by querying the database table via the index 'IDXUdDocSmallDouble03'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<UDDocSmallRows> GetFromIdxDouble03Async(double double03, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| double | double03 | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<UDDocSmallRows> | 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 UDDocSmall table. Non-unique indexes have corresponding inner classes and methods in the UDDocSmallRows collection, since they may return more than one row.
GetFromIdxDouble04Async(double, CancellationToken)
Create a new instance of the UDDocSmallRow object, by querying the database table via the index 'IDXUdDocSmallDouble04'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<UDDocSmallRows> GetFromIdxDouble04Async(double double04, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| double | double04 | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<UDDocSmallRows> | 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 UDDocSmall table. Non-unique indexes have corresponding inner classes and methods in the UDDocSmallRows collection, since they may return more than one row.
GetFromIdxLong01Async(int, CancellationToken)
Create a new instance of the UDDocSmallRow object, by querying the database table via the index 'IDXUdDocSmallLong01'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<UDDocSmallRows> GetFromIdxLong01Async(int long01, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | long01 | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<UDDocSmallRows> | 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 UDDocSmall table. Non-unique indexes have corresponding inner classes and methods in the UDDocSmallRows collection, since they may return more than one row.
GetFromIdxLong02Async(int, CancellationToken)
Create a new instance of the UDDocSmallRow object, by querying the database table via the index 'IDXUdDocSmallLong02'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<UDDocSmallRows> GetFromIdxLong02Async(int long02, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | long02 | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<UDDocSmallRows> | 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 UDDocSmall table. Non-unique indexes have corresponding inner classes and methods in the UDDocSmallRows collection, since they may return more than one row.
GetFromIdxLong03Async(int, CancellationToken)
Create a new instance of the UDDocSmallRow object, by querying the database table via the index 'IDXUdDocSmallLong03'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<UDDocSmallRows> GetFromIdxLong03Async(int long03, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | long03 | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<UDDocSmallRows> | 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 UDDocSmall table. Non-unique indexes have corresponding inner classes and methods in the UDDocSmallRows collection, since they may return more than one row.
GetFromIdxLong04Async(int, CancellationToken)
Create a new instance of the UDDocSmallRow object, by querying the database table via the index 'IDXUdDocSmallLong04'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<UDDocSmallRows> GetFromIdxLong04Async(int long04, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | long04 | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<UDDocSmallRows> | 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 UDDocSmall table. Non-unique indexes have corresponding inner classes and methods in the UDDocSmallRows collection, since they may return more than one row.
GetFromIdxString01Async(string, CancellationToken)
Create a new instance of the UDDocSmallRow object, by querying the database table via the index 'IDXUdDocSmallString01'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<UDDocSmallRows> GetFromIdxString01Async(string string01, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | string01 | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<UDDocSmallRows> | 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 UDDocSmall table. Non-unique indexes have corresponding inner classes and methods in the UDDocSmallRows collection, since they may return more than one row.
GetFromIdxString02Async(string, CancellationToken)
Create a new instance of the UDDocSmallRow object, by querying the database table via the index 'IDXUdDocSmallString02'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<UDDocSmallRows> GetFromIdxString02Async(string string02, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | string02 | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<UDDocSmallRows> | 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 UDDocSmall table. Non-unique indexes have corresponding inner classes and methods in the UDDocSmallRows collection, since they may return more than one row.
GetFromIdxString03Async(string, CancellationToken)
Create a new instance of the UDDocSmallRow object, by querying the database table via the index 'IDXUdDocSmallString03'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<UDDocSmallRows> GetFromIdxString03Async(string string03, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | string03 | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<UDDocSmallRows> | 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 UDDocSmall table. Non-unique indexes have corresponding inner classes and methods in the UDDocSmallRows collection, since they may return more than one row.
GetFromIdxString04Async(string, CancellationToken)
Create a new instance of the UDDocSmallRow object, by querying the database table via the index 'IDXUdDocSmallString04'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<UDDocSmallRows> GetFromIdxString04Async(string string04, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | string04 | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<UDDocSmallRows> | 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 UDDocSmall table. Non-unique indexes have corresponding inner classes and methods in the UDDocSmallRows collection, since they may return more than one row.
GetFromReaderAsync(SoDataReader, UDDocSmallTableInfo, CancellationToken)
Create a new instance of the UDDocSmallRows 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 UDDocSmallRow 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<UDDocSmallRows> GetFromReaderAsync(SoDataReader reader, UDDocSmallTableInfo tableInfo, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | SoDataReader positioned to a valid database row. |
| UDDocSmallTableInfo | tableInfo | UDDocSmallTableInfo 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<UDDocSmallRows> |
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 UDDocSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDDocSmallRows UDDocSmallRows.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(UDDocSmallRow)
Removes the given UDDocSmallRow from the collection
Declaration
public void Remove(UDDocSmallRow row)
Parameters
| Type | Name | Description |
|---|---|---|
| UDDocSmallRow | row | the UDDocSmallRow 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 UDDocSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDDocSmallRows UDDocSmallRows.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()
User-defined fields Collection of UDDocSmallRow. Each element of the collection represents one row in the UDDocSmall table.
Declaration
public UDDocSmallRow[] ToArray()
Returns
| Type | Description |
|---|---|
| UDDocSmallRow[] |
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 UDDocSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDDocSmallRows UDDocSmallRows.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 UDDocSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDDocSmallRows UDDocSmallRows.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.