Class ExternalDocumentRows
This table stores documents which can be viewed externaly, through the customer module Collection of ExternalDocumentRow. Each element of the collection represents one row in the ExternalDocument table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class ExternalDocumentRows : 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 ExternalDocumentRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExternalDocumentRows ExternalDocumentRows.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 ExternalDocumentRow given its index in the collection.
Declaration
public ExternalDocumentRow this[int index] { get; }
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | Index of the ExternalDocumentRow in the collection |
Property Value
| Type | Description |
|---|---|
| ExternalDocumentRow |
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 ExternalDocumentRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExternalDocumentRows ExternalDocumentRows.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(ExternalDocumentRow)
Add one ExternalDocumentRow to the collection.
Declaration
public int Add(ExternalDocumentRow row)
Parameters
| Type | Name | Description |
|---|---|---|
| ExternalDocumentRow | row | An instance of ExternalDocumentRow to be added to the collection. |
Returns
| Type | Description |
|---|---|
| int | The index of the added ExternalDocumentRow. |
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 ExternalDocumentRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExternalDocumentRows ExternalDocumentRows.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 ExternalDocumentRow added to the collection.
Declaration
public ExternalDocumentRow AddNew()
Returns
| Type | Description |
|---|---|
| ExternalDocumentRow | A new instance of ExternalDocumentRow 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 ExternalDocumentRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExternalDocumentRows ExternalDocumentRows.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<ExternalDocumentRow>)
Add a range of ExternalDocumentRow to the collection.
Declaration
public ExternalDocumentRows AddRange(IEnumerable<ExternalDocumentRow> rows)
Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<ExternalDocumentRow> | rows |
Returns
| Type | Description |
|---|---|
| ExternalDocumentRows | The updated ExternalDocumentRows 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 ExternalDocumentRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExternalDocumentRows ExternalDocumentRows.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 ExternalDocumentRow
Declaration
protected override TableRowBase CreateChild()
Returns
| Type | Description |
|---|---|
| TableRowBase | New instance of ExternalDocumentRow |
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 ExternalDocumentRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExternalDocumentRows ExternalDocumentRows.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 ExternalDocumentRows object. This collection will contain no rows.
Declaration
public static ExternalDocumentRows CreateNew()
Returns
| Type | Description |
|---|---|
| ExternalDocumentRows | A new instance of the ExternalDocumentRows 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 ExternalDocumentRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExternalDocumentRows ExternalDocumentRows.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<ExternalDocumentRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public ExternalDocumentRow Find(Predicate<ExternalDocumentRow> condition)
Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<ExternalDocumentRow> | condition |
Returns
| Type | Description |
|---|---|
| ExternalDocumentRow |
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 ExternalDocumentRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExternalDocumentRows ExternalDocumentRows.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<ExternalDocumentRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public ExternalDocumentRows FindAll(Predicate<ExternalDocumentRow> condition)
Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<ExternalDocumentRow> | condition |
Returns
| Type | Description |
|---|---|
| ExternalDocumentRows |
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 ExternalDocumentRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExternalDocumentRows ExternalDocumentRows.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<ExternalDocumentRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<ExternalDocumentRow> whatToDo)
Parameters
| Type | Name | Description |
|---|---|---|
| Action<ExternalDocumentRow> | 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 ExternalDocumentRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExternalDocumentRows ExternalDocumentRows.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 ExternalDocumentRows 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 ExternalDocumentRow objects representing each row will be returned.
Declaration
public static Task<ExternalDocumentRows> GetFromCustomSearchAsync(ExternalDocumentRows.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| ExternalDocumentRows.CustomSearch | query | The custom search to execute against the database |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ExternalDocumentRows> | A new instance of the ExternalDocumentRows 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 ExternalDocumentRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExternalDocumentRows ExternalDocumentRows.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.
GetFromIdxAttachmentIdAsync(int, CancellationToken)
Create a new instance of the ExternalDocumentRow object, by querying the database table via the index 'IDXExternal_documentAttachment_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ExternalDocumentRows> GetFromIdxAttachmentIdAsync(int attachmentId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | attachmentId | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ExternalDocumentRows> | 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 ExternalDocument table. Non-unique indexes have corresponding inner classes and methods in the ExternalDocumentRows collection, since they may return more than one row.
GetFromIdxChangedByAsync(int, CancellationToken)
Create a new instance of the ExternalDocumentRow object, by querying the database table via the index 'IDXExternal_documentChanged_by'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ExternalDocumentRows> GetFromIdxChangedByAsync(int changedBy, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | changedBy | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ExternalDocumentRows> | 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 ExternalDocument table. Non-unique indexes have corresponding inner classes and methods in the ExternalDocumentRows collection, since they may return more than one row.
GetFromIdxCreatedByAsync(int, CancellationToken)
Create a new instance of the ExternalDocumentRow object, by querying the database table via the index 'IDXExternal_documentCreated_by'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ExternalDocumentRows> GetFromIdxCreatedByAsync(int createdBy, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | createdBy | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ExternalDocumentRows> | 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 ExternalDocument table. Non-unique indexes have corresponding inner classes and methods in the ExternalDocumentRows collection, since they may return more than one row.
GetFromIdxHierarchyIdAsync(int, CancellationToken)
Create a new instance of the ExternalDocumentRow object, by querying the database table via the index 'IDXExternal_documentHierarchy_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ExternalDocumentRows> GetFromIdxHierarchyIdAsync(int hierarchyId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | hierarchyId | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ExternalDocumentRows> | 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 ExternalDocument table. Non-unique indexes have corresponding inner classes and methods in the ExternalDocumentRows collection, since they may return more than one row.
GetFromIdxSMessageAsync(int, CancellationToken)
Create a new instance of the ExternalDocumentRow object, by querying the database table via the index 'IDXExternal_documentS_message'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ExternalDocumentRows> GetFromIdxSMessageAsync(int sMessage, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | sMessage | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ExternalDocumentRows> | 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 ExternalDocument table. Non-unique indexes have corresponding inner classes and methods in the ExternalDocumentRows collection, since they may return more than one row.
GetFromIdxTitleAsync(string, CancellationToken)
Create a new instance of the ExternalDocumentRow object, by querying the database table via the index 'IDXExternal_documentTitle'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ExternalDocumentRows> GetFromIdxTitleAsync(string title, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | title | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ExternalDocumentRows> | 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 ExternalDocument table. Non-unique indexes have corresponding inner classes and methods in the ExternalDocumentRows collection, since they may return more than one row.
GetFromReaderAsync(SoDataReader, ExternalDocumentTableInfo, CancellationToken)
Create a new instance of the ExternalDocumentRows 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 ExternalDocumentRow 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<ExternalDocumentRows> GetFromReaderAsync(SoDataReader reader, ExternalDocumentTableInfo tableInfo, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | SoDataReader positioned to a valid database row. |
| ExternalDocumentTableInfo | tableInfo | ExternalDocumentTableInfo 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<ExternalDocumentRows> |
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 ExternalDocumentRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExternalDocumentRows ExternalDocumentRows.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(ExternalDocumentRow)
Removes the given ExternalDocumentRow from the collection
Declaration
public void Remove(ExternalDocumentRow row)
Parameters
| Type | Name | Description |
|---|---|---|
| ExternalDocumentRow | row | the ExternalDocumentRow 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 ExternalDocumentRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExternalDocumentRows ExternalDocumentRows.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 documents which can be viewed externaly, through the customer module Collection of ExternalDocumentRow. Each element of the collection represents one row in the ExternalDocument table.
Declaration
public ExternalDocumentRow[] ToArray()
Returns
| Type | Description |
|---|---|
| ExternalDocumentRow[] |
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 ExternalDocumentRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExternalDocumentRows ExternalDocumentRows.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 ExternalDocumentRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ExternalDocumentRows ExternalDocumentRows.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.