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>, IEnumerable, IEnumerable<DocumentListItem>, IList, ICollection, IList<DocumentListItem>, ICollection<DocumentListItem>Methods
DocumentExist(Int32)
Checks if the document described by the document exist in the list.
Declaration
public bool DocumentExist(int documentId)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | documentId | The document |
Returns
| Type | Description |
|---|---|
| Boolean | True/false |
GetDocument(Int32)
Returns the document described by the document_id.
Declaration
public Document GetDocument(int documentId)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | documentId | The document in question |
Returns
| Type | Description |
|---|---|
| Document | The Document |
GetDocumentListItem(Int32)
Will return the DocumentListItem described by the documentId.
Declaration
public DocumentListItem GetDocumentListItem(int documentId)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | documentId | The person |
Returns
| Type | Description |
|---|---|
| DocumentListItem | The document. |
OnLoad(DocumentList.DocumentListQuery, SoDataReader)
Responsible for reading each row with data from the SoDataReader and insert the object each row represents into the class' collection.
Declaration
protected override void OnLoad(DocumentList.DocumentListQuery query, SoDataReader reader)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentList.DocumentListQuery | query | |
| SoDataReader | reader | The reader which contains all data in the list. |
Overrides
SuperOffice.CRM.Lists.ListBase<SuperOffice.CRM.Archives.DocumentList.DocumentListQuery, SuperOffice.CRM.Archives.DocumentListItem>.OnLoad(SuperOffice.CRM.Archives.DocumentList.DocumentListQuery, SuperOffice.Data.SoDataReader)
Implements
Extension Methods
EnumUtil.MapEnums<From, To>(From)