Show / Hide Table of Contents

Class DocumentList

DocumentList implements the document list in SuperOffice.

Inheritance
Object
ListBase<DocumentList.DocumentListQuery, DocumentListItem>
DocumentList
Implements
IEnumerable
IEnumerable<DocumentListItem>
IList
ICollection
IList<DocumentListItem>
ICollection<DocumentListItem>
Inherited Members
ListBase<DocumentList.DocumentListQuery, DocumentListItem>.CopyTo(Array, Int32)
ListBase<DocumentList.DocumentListQuery, DocumentListItem>.CopyTo(DocumentListItem[], Int32)
ListBase<DocumentList.DocumentListQuery, DocumentListItem>.IndexOf(DocumentListItem)
ListBase<DocumentList.DocumentListQuery, DocumentListItem>.Contains(DocumentListItem)
ListBase<DocumentList.DocumentListQuery, DocumentListItem>.OnLoad(DocumentList.DocumentListQuery, SoDataReader)
ListBase<DocumentList.DocumentListQuery, DocumentListItem>.GetEnumerator()
ListBase<DocumentList.DocumentListQuery, DocumentListItem>.Item[Int32]
ListBase<DocumentList.DocumentListQuery, DocumentListItem>.ListCollection
ListBase<DocumentList.DocumentListQuery, DocumentListItem>.Count
ListBase<DocumentList.DocumentListQuery, DocumentListItem>.IsFixedSize
ListBase<DocumentList.DocumentListQuery, DocumentListItem>.IsReadOnly
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

System.Collections.IEnumerable
System.Collections.Generic.IEnumerable<T>
System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IList<T>
System.Collections.Generic.ICollection<T>

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top