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