Class DocumentList
DocumentList implements the document list in SuperOffice.
Implements
Inherited Members
Namespace: SuperOffice.CRM.Archives
Assembly: SoDataBase.dll
Syntax
public sealed class DocumentList : ListBase<DocumentList.DocumentListQuery, DocumentListItem>, IList, ICollection, IList<DocumentListItem>, ICollection<DocumentListItem>, IEnumerable<DocumentListItem>, IEnumerableMethods
DocumentExist(int)
Checks if the document described by the document exist in the list.
Declaration
public bool DocumentExist(int documentId)Parameters
| Type | Name | Description |
|---|---|---|
| int | documentId | The document |
Returns
| Type | Description |
|---|---|
| bool | True/false |
GetDocument(int)
Returns the document described by the document_id.
Declaration
public Document GetDocument(int documentId)Parameters
| Type | Name | Description |
|---|---|---|
| int | documentId | The document in question |
Returns
| Type | Description |
|---|---|
| Document | The Document |
GetDocumentListItem(int)
Will return the DocumentListItem described by the documentId.
Declaration
public DocumentListItem GetDocumentListItem(int documentId)Parameters
| Type | Name | Description |
|---|---|---|
| int | documentId | The person |
Returns
| Type | Description |
|---|---|
| DocumentListItem | The document. |
OnLoadAsync(DocumentListQuery, SoDataReader, CancellationToken)
Responsible for reading each row with data from the SoDataReader and insert the object each row represents into the class' collection.
Declaration
protected override Task OnLoadAsync(DocumentList.DocumentListQuery query, SoDataReader reader, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentList.DocumentListQuery | query | |
| SoDataReader | reader | The reader which contains all data in the list. |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task |