Show / Hide Table of Contents

Class DocumentCollection

The document-specific section of information about a document

There is always a corresponding appointment record; the relation between appointment and document is navigable in both directions. A document-type appointment record always has a corresponding document record.

Collection of Document. Each element of the collection represents one entity based on Document.
Inheritance
Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
EntityCollectionBase
DocumentCollection
Implements
INestedPersist
IEnumerable<INestedPersist>
ISoCollection
IEnumerable
IList
ICollection
INotifyCollectionChanged
IBindingList
Inherited Members
EntityCollectionBase._innerList
EntityCollectionBase.Delete()
EntityCollectionBase.GetEnumerator()
EntityCollectionBase.Add(EntityBase)
EntityCollectionBase.ISoCollection.Add(ISoItem)
EntityCollectionBase.ISoCollection.AddNew()
EntityCollectionBase.Remove(EntityBase)
EntityCollectionBase.CopyTo(Array, Int32)
EntityCollectionBase.IndexOf(Object)
EntityCollectionBase.Contains(Object)
EntityCollectionBase.AddIndex(PropertyDescriptor)
EntityCollectionBase.ApplySort(PropertyDescriptor, ListSortDirection)
EntityCollectionBase.Find(PropertyDescriptor, Object)
EntityCollectionBase.RemoveIndex(PropertyDescriptor)
EntityCollectionBase.RemoveSort()
EntityCollectionBase.IsDirty
EntityCollectionBase.Count
EntityCollectionBase.IsFixedSize
EntityCollectionBase.IsReadOnly
EntityCollectionBase.AllowEdit
EntityCollectionBase.AllowNew
EntityCollectionBase.AllowRemove
EntityCollectionBase.IsSorted
EntityCollectionBase.SortDirection
EntityCollectionBase.SortProperty
EntityCollectionBase.SupportsChangeNotification
EntityCollectionBase.SupportsSearching
EntityCollectionBase.SupportsSorting
EntityCollectionBase.CollectionChanged
EntityCollectionBase.ListChanged
NestedCollectionPersist.GetFacadingItems()
NestedCollectionPersist.IsDeleted
NestedPersistFacade.OnPreIdUpdate()
NestedPersistFacade.OnPrimaryKeyRequest(PKContainer)
NestedPersistFacade.OnPrimaryKeyUpdate(PKContainer)
NestedPersistFacade.OnIdUpdate()
NestedPersistFacade.OnSave(BatchSave)
NestedPersistFacade.OnSaved(Boolean)
NestedPersist._saveOwner
NestedPersist._isSaving
NestedPersist.SetSaveOwner(INestedPersist)
NestedPersist.Save()
NestedPersist.INestedPersist.OnPreIdUpdate()
NestedPersist.INestedPersist.OnPrimaryKeyRequest(PKContainer)
NestedPersist.INestedPersist.OnPrimaryKeyUpdate(PKContainer)
NestedPersist.INestedPersist.OnIdUpdate()
NestedPersist.INestedPersist.OnSave(BatchSave)
NestedPersist.INestedPersist.OnSaved(Boolean)
NestedPersist.add_OnElementSaved(OnSaved)
NestedPersist.remove_OnElementSaved(OnSaved)
NestedPersist.add_OnElementIdUpdate(OnIdUpdate)
NestedPersist.remove_OnElementIdUpdate(OnIdUpdate)
NestedPersist.IsSaving
NestedPersist.IsMarkedForDelete
NestedPersist.OnElementSaved
NestedPersist.OnElementIdUpdate
Namespace: SuperOffice.CRM.Entities
Assembly: SoDataBase.dll
Syntax
public class DocumentCollection : EntityCollectionBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IEnumerable, IList, ICollection, ITableRowLoadHandlerFactory, INotifyCollectionChanged, IBindingList
Remarks

Entity 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 to it, and use methods like to operate on the whole collection.
  • You can create a (nested) DocumentCollection DocumentCollection.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(DocumentCollection.CustomSearch) method to apply the query to the database and obtain the result as an EntityCollection 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.
Unique indexes are handled through the Document object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Document are:
Index fieldsNested index class name
DocumentIdDocumentId:

Primary key

Nested index class: Document.IdxDocumentId

Static Get method: GetFromIdxDocumentId(Int32)
Non-unique indexes on table Document are:
Index fieldsNested index class name
OurRefOurRef:

Our reference, searchable field from free-text search

Nested index class: DocumentCollection.IdxOurRef

Static Get method: GetFromIdxOurRef(String)
Userdef2IdUserdef2Id:

User-defined fields

Nested index class: DocumentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(Int32)
UserdefIdUserdefId:

User-defined fields

Nested index class: DocumentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(Int32)
ExtrefExtref:

External reference (notes ID, email ID, other ID used by the archive provider)

Nested index class: DocumentCollection.IdxExtref

Static Get method: GetFromIdxExtref(String)
HeaderHeader:

Visible document name

Nested index class: DocumentCollection.IdxHeader

Static Get method: GetFromIdxHeader(String)
SearchnameSearchname:

For future use

Nested index class: DocumentCollection.IdxSearchname

Static Get method: GetFromIdxSearchname(String)
ArchiveProviderArchiveProvider:

Reference to archive provider; for future use, and the Notes Link

Nested index class: DocumentCollection.IdxArchiveProvider

Static Get method: GetFromIdxArchiveProvider(Int32)

Constructors

DocumentCollection(DocumentCollection.DocumentCollectionIdx)

Constructor for class DocumentCollection.
This object represents a collection of rows in table 'document'. Table contact: Documents, this table is an extension of the Appointment table

Declaration
protected DocumentCollection(DocumentCollection.DocumentCollectionIdx idx)
Parameters
Type Name Description
DocumentCollection.DocumentCollectionIdx idx
Remarks

Entity 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 to it, and use methods like to operate on the whole collection.
  • You can create a (nested) DocumentCollection DocumentCollection.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(DocumentCollection.CustomSearch) method to apply the query to the database and obtain the result as an EntityCollection 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.
Unique indexes are handled through the Document object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Document are:
Index fieldsNested index class name
DocumentIdDocumentId:

Primary key

Nested index class: Document.IdxDocumentId

Static Get method: GetFromIdxDocumentId(Int32)
Non-unique indexes on table Document are:
Index fieldsNested index class name
OurRefOurRef:

Our reference, searchable field from free-text search

Nested index class: DocumentCollection.IdxOurRef

Static Get method: GetFromIdxOurRef(String)
Userdef2IdUserdef2Id:

User-defined fields

Nested index class: DocumentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(Int32)
UserdefIdUserdefId:

User-defined fields

Nested index class: DocumentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(Int32)
ExtrefExtref:

External reference (notes ID, email ID, other ID used by the archive provider)

Nested index class: DocumentCollection.IdxExtref

Static Get method: GetFromIdxExtref(String)
HeaderHeader:

Visible document name

Nested index class: DocumentCollection.IdxHeader

Static Get method: GetFromIdxHeader(String)
SearchnameSearchname:

For future use

Nested index class: DocumentCollection.IdxSearchname

Static Get method: GetFromIdxSearchname(String)
ArchiveProviderArchiveProvider:

Reference to archive provider; for future use, and the Notes Link

Nested index class: DocumentCollection.IdxArchiveProvider

Static Get method: GetFromIdxArchiveProvider(Int32)

Fields

_idx

Fetcher class the collection is based on

Declaration
protected DocumentCollection.DocumentCollectionIdx _idx
Field Value
Type Description
DocumentCollection.DocumentCollectionIdx
Remarks

Entity 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 to it, and use methods like to operate on the whole collection.
  • You can create a (nested) DocumentCollection DocumentCollection.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(DocumentCollection.CustomSearch) method to apply the query to the database and obtain the result as an EntityCollection 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.
Unique indexes are handled through the Document object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Document are:
Index fieldsNested index class name
DocumentIdDocumentId:

Primary key

Nested index class: Document.IdxDocumentId

Static Get method: GetFromIdxDocumentId(Int32)
Non-unique indexes on table Document are:
Index fieldsNested index class name
OurRefOurRef:

Our reference, searchable field from free-text search

Nested index class: DocumentCollection.IdxOurRef

Static Get method: GetFromIdxOurRef(String)
Userdef2IdUserdef2Id:

User-defined fields

Nested index class: DocumentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(Int32)
UserdefIdUserdefId:

User-defined fields

Nested index class: DocumentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(Int32)
ExtrefExtref:

External reference (notes ID, email ID, other ID used by the archive provider)

Nested index class: DocumentCollection.IdxExtref

Static Get method: GetFromIdxExtref(String)
HeaderHeader:

Visible document name

Nested index class: DocumentCollection.IdxHeader

Static Get method: GetFromIdxHeader(String)
SearchnameSearchname:

For future use

Nested index class: DocumentCollection.IdxSearchname

Static Get method: GetFromIdxSearchname(String)
ArchiveProviderArchiveProvider:

Reference to archive provider; for future use, and the Notes Link

Nested index class: DocumentCollection.IdxArchiveProvider

Static Get method: GetFromIdxArchiveProvider(Int32)

_rows

Row objects that the collection is based on.

Declaration
protected DocumentRows _rows
Field Value
Type Description
DocumentRows
Remarks

Entity 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 to it, and use methods like to operate on the whole collection.
  • You can create a (nested) DocumentCollection DocumentCollection.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(DocumentCollection.CustomSearch) method to apply the query to the database and obtain the result as an EntityCollection 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.
Unique indexes are handled through the Document object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Document are:
Index fieldsNested index class name
DocumentIdDocumentId:

Primary key

Nested index class: Document.IdxDocumentId

Static Get method: GetFromIdxDocumentId(Int32)
Non-unique indexes on table Document are:
Index fieldsNested index class name
OurRefOurRef:

Our reference, searchable field from free-text search

Nested index class: DocumentCollection.IdxOurRef

Static Get method: GetFromIdxOurRef(String)
Userdef2IdUserdef2Id:

User-defined fields

Nested index class: DocumentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(Int32)
UserdefIdUserdefId:

User-defined fields

Nested index class: DocumentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(Int32)
ExtrefExtref:

External reference (notes ID, email ID, other ID used by the archive provider)

Nested index class: DocumentCollection.IdxExtref

Static Get method: GetFromIdxExtref(String)
HeaderHeader:

Visible document name

Nested index class: DocumentCollection.IdxHeader

Static Get method: GetFromIdxHeader(String)
SearchnameSearchname:

For future use

Nested index class: DocumentCollection.IdxSearchname

Static Get method: GetFromIdxSearchname(String)
ArchiveProviderArchiveProvider:

Reference to archive provider; for future use, and the Notes Link

Nested index class: DocumentCollection.IdxArchiveProvider

Static Get method: GetFromIdxArchiveProvider(Int32)

Properties

Index

Retrieve the index for DocumentCollection

Declaration
public DocumentCollection.DocumentCollectionIdx Index { get; }
Property Value
Type Description
DocumentCollection.DocumentCollectionIdx
Remarks

Entity 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 to it, and use methods like to operate on the whole collection.
  • You can create a (nested) DocumentCollection DocumentCollection.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(DocumentCollection.CustomSearch) method to apply the query to the database and obtain the result as an EntityCollection 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.
Unique indexes are handled through the Document object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Document are:
Index fieldsNested index class name
DocumentIdDocumentId:

Primary key

Nested index class: Document.IdxDocumentId

Static Get method: GetFromIdxDocumentId(Int32)
Non-unique indexes on table Document are:
Index fieldsNested index class name
OurRefOurRef:

Our reference, searchable field from free-text search

Nested index class: DocumentCollection.IdxOurRef

Static Get method: GetFromIdxOurRef(String)
Userdef2IdUserdef2Id:

User-defined fields

Nested index class: DocumentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(Int32)
UserdefIdUserdefId:

User-defined fields

Nested index class: DocumentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(Int32)
ExtrefExtref:

External reference (notes ID, email ID, other ID used by the archive provider)

Nested index class: DocumentCollection.IdxExtref

Static Get method: GetFromIdxExtref(String)
HeaderHeader:

Visible document name

Nested index class: DocumentCollection.IdxHeader

Static Get method: GetFromIdxHeader(String)
SearchnameSearchname:

For future use

Nested index class: DocumentCollection.IdxSearchname

Static Get method: GetFromIdxSearchname(String)
ArchiveProviderArchiveProvider:

Reference to archive provider; for future use, and the Notes Link

Nested index class: DocumentCollection.IdxArchiveProvider

Static Get method: GetFromIdxArchiveProvider(Int32)

Item[Int32]

Get a Document from the collection from its zero-based index.

Declaration
public Document this[int index] { get; }
Parameters
Type Name Description
Int32 index

Zero-based index in the collection.

Property Value
Type Description
Document
Remarks

Entity 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 to it, and use methods like to operate on the whole collection.
  • You can create a (nested) DocumentCollection DocumentCollection.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(DocumentCollection.CustomSearch) method to apply the query to the database and obtain the result as an EntityCollection 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.
Unique indexes are handled through the Document object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Document are:
Index fieldsNested index class name
DocumentIdDocumentId:

Primary key

Nested index class: Document.IdxDocumentId

Static Get method: GetFromIdxDocumentId(Int32)
Non-unique indexes on table Document are:
Index fieldsNested index class name
OurRefOurRef:

Our reference, searchable field from free-text search

Nested index class: DocumentCollection.IdxOurRef

Static Get method: GetFromIdxOurRef(String)
Userdef2IdUserdef2Id:

User-defined fields

Nested index class: DocumentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(Int32)
UserdefIdUserdefId:

User-defined fields

Nested index class: DocumentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(Int32)
ExtrefExtref:

External reference (notes ID, email ID, other ID used by the archive provider)

Nested index class: DocumentCollection.IdxExtref

Static Get method: GetFromIdxExtref(String)
HeaderHeader:

Visible document name

Nested index class: DocumentCollection.IdxHeader

Static Get method: GetFromIdxHeader(String)
SearchnameSearchname:

For future use

Nested index class: DocumentCollection.IdxSearchname

Static Get method: GetFromIdxSearchname(String)
ArchiveProviderArchiveProvider:

Reference to archive provider; for future use, and the Notes Link

Nested index class: DocumentCollection.IdxArchiveProvider

Static Get method: GetFromIdxArchiveProvider(Int32)

Rows

The ecapsulated object DocumentRows.

Declaration
public DocumentRows Rows { get; }
Property Value
Type Description
DocumentRows
Remarks

Entity 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 to it, and use methods like to operate on the whole collection.
  • You can create a (nested) DocumentCollection DocumentCollection.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(DocumentCollection.CustomSearch) method to apply the query to the database and obtain the result as an EntityCollection 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.
Unique indexes are handled through the Document object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Document are:
Index fieldsNested index class name
DocumentIdDocumentId:

Primary key

Nested index class: Document.IdxDocumentId

Static Get method: GetFromIdxDocumentId(Int32)
Non-unique indexes on table Document are:
Index fieldsNested index class name
OurRefOurRef:

Our reference, searchable field from free-text search

Nested index class: DocumentCollection.IdxOurRef

Static Get method: GetFromIdxOurRef(String)
Userdef2IdUserdef2Id:

User-defined fields

Nested index class: DocumentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(Int32)
UserdefIdUserdefId:

User-defined fields

Nested index class: DocumentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(Int32)
ExtrefExtref:

External reference (notes ID, email ID, other ID used by the archive provider)

Nested index class: DocumentCollection.IdxExtref

Static Get method: GetFromIdxExtref(String)
HeaderHeader:

Visible document name

Nested index class: DocumentCollection.IdxHeader

Static Get method: GetFromIdxHeader(String)
SearchnameSearchname:

For future use

Nested index class: DocumentCollection.IdxSearchname

Static Get method: GetFromIdxSearchname(String)
ArchiveProviderArchiveProvider:

Reference to archive provider; for future use, and the Notes Link

Nested index class: DocumentCollection.IdxArchiveProvider

Static Get method: GetFromIdxArchiveProvider(Int32)

Sentries

The collection of sentries that are guarding this collection of rows. This collection is used by RDB entities which return HDB collections.

For example, the contact.Faxes returns a PhoneRows collection in which each row will need to check the contact's sentry for permission to read/write their field

Declaration
public override SentryCollection Sentries { get; }
Property Value
Type Description
SentryCollection
Overrides
EntityCollectionBase.Sentries
Remarks

Entity 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 to it, and use methods like to operate on the whole collection.
  • You can create a (nested) DocumentCollection DocumentCollection.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(DocumentCollection.CustomSearch) method to apply the query to the database and obtain the result as an EntityCollection 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.
Unique indexes are handled through the Document object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Document are:
Index fieldsNested index class name
DocumentIdDocumentId:

Primary key

Nested index class: Document.IdxDocumentId

Static Get method: GetFromIdxDocumentId(Int32)
Non-unique indexes on table Document are:
Index fieldsNested index class name
OurRefOurRef:

Our reference, searchable field from free-text search

Nested index class: DocumentCollection.IdxOurRef

Static Get method: GetFromIdxOurRef(String)
Userdef2IdUserdef2Id:

User-defined fields

Nested index class: DocumentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(Int32)
UserdefIdUserdefId:

User-defined fields

Nested index class: DocumentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(Int32)
ExtrefExtref:

External reference (notes ID, email ID, other ID used by the archive provider)

Nested index class: DocumentCollection.IdxExtref

Static Get method: GetFromIdxExtref(String)
HeaderHeader:

Visible document name

Nested index class: DocumentCollection.IdxHeader

Static Get method: GetFromIdxHeader(String)
SearchnameSearchname:

For future use

Nested index class: DocumentCollection.IdxSearchname

Static Get method: GetFromIdxSearchname(String)
ArchiveProviderArchiveProvider:

Reference to archive provider; for future use, and the Notes Link

Nested index class: DocumentCollection.IdxArchiveProvider

Static Get method: GetFromIdxArchiveProvider(Int32)

Methods

Add(Document)

Add one Document to the collection.

Declaration
public int Add(Document document)
Parameters
Type Name Description
Document document

An instance of Document to be added to the collection.

Returns
Type Description
Int32

The index of the added Document.

Remarks

Entity 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 to it, and use methods like to operate on the whole collection.
  • You can create a (nested) DocumentCollection DocumentCollection.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(DocumentCollection.CustomSearch) method to apply the query to the database and obtain the result as an EntityCollection 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.
Unique indexes are handled through the Document object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Document are:
Index fieldsNested index class name
DocumentIdDocumentId:

Primary key

Nested index class: Document.IdxDocumentId

Static Get method: GetFromIdxDocumentId(Int32)
Non-unique indexes on table Document are:
Index fieldsNested index class name
OurRefOurRef:

Our reference, searchable field from free-text search

Nested index class: DocumentCollection.IdxOurRef

Static Get method: GetFromIdxOurRef(String)
Userdef2IdUserdef2Id:

User-defined fields

Nested index class: DocumentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(Int32)
UserdefIdUserdefId:

User-defined fields

Nested index class: DocumentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(Int32)
ExtrefExtref:

External reference (notes ID, email ID, other ID used by the archive provider)

Nested index class: DocumentCollection.IdxExtref

Static Get method: GetFromIdxExtref(String)
HeaderHeader:

Visible document name

Nested index class: DocumentCollection.IdxHeader

Static Get method: GetFromIdxHeader(String)
SearchnameSearchname:

For future use

Nested index class: DocumentCollection.IdxSearchname

Static Get method: GetFromIdxSearchname(String)
ArchiveProviderArchiveProvider:

Reference to archive provider; for future use, and the Notes Link

Nested index class: DocumentCollection.IdxArchiveProvider

Static Get method: GetFromIdxArchiveProvider(Int32)

AddNew()

Get a new instance of Document added to the collection.

Declaration
public Document AddNew()
Returns
Type Description
Document

A new instance of Document added to the collection.

Remarks

Entity 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 to it, and use methods like to operate on the whole collection.
  • You can create a (nested) DocumentCollection DocumentCollection.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(DocumentCollection.CustomSearch) method to apply the query to the database and obtain the result as an EntityCollection 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.
Unique indexes are handled through the Document object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Document are:
Index fieldsNested index class name
DocumentIdDocumentId:

Primary key

Nested index class: Document.IdxDocumentId

Static Get method: GetFromIdxDocumentId(Int32)
Non-unique indexes on table Document are:
Index fieldsNested index class name
OurRefOurRef:

Our reference, searchable field from free-text search

Nested index class: DocumentCollection.IdxOurRef

Static Get method: GetFromIdxOurRef(String)
Userdef2IdUserdef2Id:

User-defined fields

Nested index class: DocumentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(Int32)
UserdefIdUserdefId:

User-defined fields

Nested index class: DocumentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(Int32)
ExtrefExtref:

External reference (notes ID, email ID, other ID used by the archive provider)

Nested index class: DocumentCollection.IdxExtref

Static Get method: GetFromIdxExtref(String)
HeaderHeader:

Visible document name

Nested index class: DocumentCollection.IdxHeader

Static Get method: GetFromIdxHeader(String)
SearchnameSearchname:

For future use

Nested index class: DocumentCollection.IdxSearchname

Static Get method: GetFromIdxSearchname(String)
ArchiveProviderArchiveProvider:

Reference to archive provider; for future use, and the Notes Link

Nested index class: DocumentCollection.IdxArchiveProvider

Static Get method: GetFromIdxArchiveProvider(Int32)

CreateChild()

Create a new instance of Document

Declaration
protected override EntityBase CreateChild()
Returns
Type Description
EntityBase

New instance of Document

Overrides
EntityCollectionBase.CreateChild()
Remarks

Entity 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 to it, and use methods like to operate on the whole collection.
  • You can create a (nested) DocumentCollection DocumentCollection.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(DocumentCollection.CustomSearch) method to apply the query to the database and obtain the result as an EntityCollection 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.
Unique indexes are handled through the Document object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Document are:
Index fieldsNested index class name
DocumentIdDocumentId:

Primary key

Nested index class: Document.IdxDocumentId

Static Get method: GetFromIdxDocumentId(Int32)
Non-unique indexes on table Document are:
Index fieldsNested index class name
OurRefOurRef:

Our reference, searchable field from free-text search

Nested index class: DocumentCollection.IdxOurRef

Static Get method: GetFromIdxOurRef(String)
Userdef2IdUserdef2Id:

User-defined fields

Nested index class: DocumentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(Int32)
UserdefIdUserdefId:

User-defined fields

Nested index class: DocumentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(Int32)
ExtrefExtref:

External reference (notes ID, email ID, other ID used by the archive provider)

Nested index class: DocumentCollection.IdxExtref

Static Get method: GetFromIdxExtref(String)
HeaderHeader:

Visible document name

Nested index class: DocumentCollection.IdxHeader

Static Get method: GetFromIdxHeader(String)
SearchnameSearchname:

For future use

Nested index class: DocumentCollection.IdxSearchname

Static Get method: GetFromIdxSearchname(String)
ArchiveProviderArchiveProvider:

Reference to archive provider; for future use, and the Notes Link

Nested index class: DocumentCollection.IdxArchiveProvider

Static Get method: GetFromIdxArchiveProvider(Int32)

CreateNew()

Create a new instance of the DocumentCollection.

Declaration
public static DocumentCollection CreateNew()
Returns
Type Description
DocumentCollection

A new instance of the DocumentCollection.

Remarks

Entity 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 to it, and use methods like to operate on the whole collection.
  • You can create a (nested) DocumentCollection DocumentCollection.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(DocumentCollection.CustomSearch) method to apply the query to the database and obtain the result as an EntityCollection 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.
Unique indexes are handled through the Document object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Document are:
Index fieldsNested index class name
DocumentIdDocumentId:

Primary key

Nested index class: Document.IdxDocumentId

Static Get method: GetFromIdxDocumentId(Int32)
Non-unique indexes on table Document are:
Index fieldsNested index class name
OurRefOurRef:

Our reference, searchable field from free-text search

Nested index class: DocumentCollection.IdxOurRef

Static Get method: GetFromIdxOurRef(String)
Userdef2IdUserdef2Id:

User-defined fields

Nested index class: DocumentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(Int32)
UserdefIdUserdefId:

User-defined fields

Nested index class: DocumentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(Int32)
ExtrefExtref:

External reference (notes ID, email ID, other ID used by the archive provider)

Nested index class: DocumentCollection.IdxExtref

Static Get method: GetFromIdxExtref(String)
HeaderHeader:

Visible document name

Nested index class: DocumentCollection.IdxHeader

Static Get method: GetFromIdxHeader(String)
SearchnameSearchname:

For future use

Nested index class: DocumentCollection.IdxSearchname

Static Get method: GetFromIdxSearchname(String)
ArchiveProviderArchiveProvider:

Reference to archive provider; for future use, and the Notes Link

Nested index class: DocumentCollection.IdxArchiveProvider

Static Get method: GetFromIdxArchiveProvider(Int32)

GetFromCustomSearch(DocumentCollection.CustomSearch)

Create a new instance of the DocumentCollection 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 DocumentRow objects representing each row will be returned.

Declaration
public static DocumentCollection GetFromCustomSearch(DocumentCollection.CustomSearch query)
Parameters
Type Name Description
DocumentCollection.CustomSearch query

The custom search to execute against the database

Returns
Type Description
DocumentCollection

A new instance of the DocumentCollection object, reflecting the result of the query.

Remarks

Entity 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 to it, and use methods like to operate on the whole collection.
  • You can create a (nested) DocumentCollection DocumentCollection.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(DocumentCollection.CustomSearch) method to apply the query to the database and obtain the result as an EntityCollection 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.
Unique indexes are handled through the Document object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Document are:
Index fieldsNested index class name
DocumentIdDocumentId:

Primary key

Nested index class: Document.IdxDocumentId

Static Get method: GetFromIdxDocumentId(Int32)
Non-unique indexes on table Document are:
Index fieldsNested index class name
OurRefOurRef:

Our reference, searchable field from free-text search

Nested index class: DocumentCollection.IdxOurRef

Static Get method: GetFromIdxOurRef(String)
Userdef2IdUserdef2Id:

User-defined fields

Nested index class: DocumentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(Int32)
UserdefIdUserdefId:

User-defined fields

Nested index class: DocumentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(Int32)
ExtrefExtref:

External reference (notes ID, email ID, other ID used by the archive provider)

Nested index class: DocumentCollection.IdxExtref

Static Get method: GetFromIdxExtref(String)
HeaderHeader:

Visible document name

Nested index class: DocumentCollection.IdxHeader

Static Get method: GetFromIdxHeader(String)
SearchnameSearchname:

For future use

Nested index class: DocumentCollection.IdxSearchname

Static Get method: GetFromIdxSearchname(String)
ArchiveProviderArchiveProvider:

Reference to archive provider; for future use, and the Notes Link

Nested index class: DocumentCollection.IdxArchiveProvider

Static Get method: GetFromIdxArchiveProvider(Int32)

GetFromIdxArchiveProvider(Int32)

Create a new instance of the DocumentRows object, and populate it with DocumentRow objects based on the result of a query on the table Document. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static DocumentCollection GetFromIdxArchiveProvider(int archiveProvider)
Parameters
Type Name Description
Int32 archiveProvider

Reference to archive provider; for future use, and the Notes Link

Returns
Type Description
DocumentCollection

New DocumentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXDocArchiveProvider. Unique indexes have corresponding Create methods directly on the DocumentRow object, since such indexes always return zero or one rows.

GetFromIdxExtref(String)

Create a new instance of the DocumentRows object, and populate it with DocumentRow objects based on the result of a query on the table Document. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static DocumentCollection GetFromIdxExtref(string extref)
Parameters
Type Name Description
String extref

External reference (notes ID, email ID, other ID used by the archive provider)

Returns
Type Description
DocumentCollection

New DocumentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXDocExtref. Unique indexes have corresponding Create methods directly on the DocumentRow object, since such indexes always return zero or one rows.

GetFromIdxHeader(String)

Create a new instance of the DocumentRows object, and populate it with DocumentRow objects based on the result of a query on the table Document. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static DocumentCollection GetFromIdxHeader(string header)
Parameters
Type Name Description
String header

Visible document name

Returns
Type Description
DocumentCollection

New DocumentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXDocHeader. Unique indexes have corresponding Create methods directly on the DocumentRow object, since such indexes always return zero or one rows.

GetFromIdxOurRef(String)

Create a new instance of the DocumentRows object, and populate it with DocumentRow objects based on the result of a query on the table Document. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static DocumentCollection GetFromIdxOurRef(string ourRef)
Parameters
Type Name Description
String ourRef

Our reference, searchable field from free-text search

Returns
Type Description
DocumentCollection

New DocumentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXDocOur_ref. Unique indexes have corresponding Create methods directly on the DocumentRow object, since such indexes always return zero or one rows.

GetFromIdxSearchname(String)

Create a new instance of the DocumentRows object, and populate it with DocumentRow objects based on the result of a query on the table Document. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static DocumentCollection GetFromIdxSearchname(string searchname)
Parameters
Type Name Description
String searchname

For future use

Returns
Type Description
DocumentCollection

New DocumentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXDocSname. Unique indexes have corresponding Create methods directly on the DocumentRow object, since such indexes always return zero or one rows.

GetFromIdxUserdef2Id(Int32)

Create a new instance of the DocumentRows object, and populate it with DocumentRow objects based on the result of a query on the table Document. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static DocumentCollection GetFromIdxUserdef2Id(int userdef2Id)
Parameters
Type Name Description
Int32 userdef2Id

User-defined fields

Returns
Type Description
DocumentCollection

New DocumentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXDocUdef2_id. Unique indexes have corresponding Create methods directly on the DocumentRow object, since such indexes always return zero or one rows.

GetFromIdxUserdefId(Int32)

Create a new instance of the DocumentRows object, and populate it with DocumentRow objects based on the result of a query on the table Document. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static DocumentCollection GetFromIdxUserdefId(int userdefId)
Parameters
Type Name Description
Int32 userdefId

User-defined fields

Returns
Type Description
DocumentCollection

New DocumentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXDocUdef_id. Unique indexes have corresponding Create methods directly on the DocumentRow object, since such indexes always return zero or one rows.

Remove(Document)

Removes the given Document from the collection

Declaration
public void Remove(Document document)
Parameters
Type Name Description
Document document

the Document to be removed

Remarks

Entity 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 to it, and use methods like to operate on the whole collection.
  • You can create a (nested) DocumentCollection DocumentCollection.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(DocumentCollection.CustomSearch) method to apply the query to the database and obtain the result as an EntityCollection 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.
Unique indexes are handled through the Document object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Document are:
Index fieldsNested index class name
DocumentIdDocumentId:

Primary key

Nested index class: Document.IdxDocumentId

Static Get method: GetFromIdxDocumentId(Int32)
Non-unique indexes on table Document are:
Index fieldsNested index class name
OurRefOurRef:

Our reference, searchable field from free-text search

Nested index class: DocumentCollection.IdxOurRef

Static Get method: GetFromIdxOurRef(String)
Userdef2IdUserdef2Id:

User-defined fields

Nested index class: DocumentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(Int32)
UserdefIdUserdefId:

User-defined fields

Nested index class: DocumentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(Int32)
ExtrefExtref:

External reference (notes ID, email ID, other ID used by the archive provider)

Nested index class: DocumentCollection.IdxExtref

Static Get method: GetFromIdxExtref(String)
HeaderHeader:

Visible document name

Nested index class: DocumentCollection.IdxHeader

Static Get method: GetFromIdxHeader(String)
SearchnameSearchname:

For future use

Nested index class: DocumentCollection.IdxSearchname

Static Get method: GetFromIdxSearchname(String)
ArchiveProviderArchiveProvider:

Reference to archive provider; for future use, and the Notes Link

Nested index class: DocumentCollection.IdxArchiveProvider

Static Get method: GetFromIdxArchiveProvider(Int32)

ToArray()

The document-specific section of information about a document

There is always a corresponding appointment record; the relation between appointment and document is navigable in both directions. A document-type appointment record always has a corresponding document record.

Collection of Document. Each element of the collection represents one entity based on Document.
Declaration
public Document[] ToArray()
Returns
Type Description
Document[]
Remarks

Entity 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 to it, and use methods like to operate on the whole collection.
  • You can create a (nested) DocumentCollection DocumentCollection.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(DocumentCollection.CustomSearch) method to apply the query to the database and obtain the result as an EntityCollection 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.
Unique indexes are handled through the Document object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Document are:
Index fieldsNested index class name
DocumentIdDocumentId:

Primary key

Nested index class: Document.IdxDocumentId

Static Get method: GetFromIdxDocumentId(Int32)
Non-unique indexes on table Document are:
Index fieldsNested index class name
OurRefOurRef:

Our reference, searchable field from free-text search

Nested index class: DocumentCollection.IdxOurRef

Static Get method: GetFromIdxOurRef(String)
Userdef2IdUserdef2Id:

User-defined fields

Nested index class: DocumentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(Int32)
UserdefIdUserdefId:

User-defined fields

Nested index class: DocumentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(Int32)
ExtrefExtref:

External reference (notes ID, email ID, other ID used by the archive provider)

Nested index class: DocumentCollection.IdxExtref

Static Get method: GetFromIdxExtref(String)
HeaderHeader:

Visible document name

Nested index class: DocumentCollection.IdxHeader

Static Get method: GetFromIdxHeader(String)
SearchnameSearchname:

For future use

Nested index class: DocumentCollection.IdxSearchname

Static Get method: GetFromIdxSearchname(String)
ArchiveProviderArchiveProvider:

Reference to archive provider; for future use, and the Notes Link

Nested index class: DocumentCollection.IdxArchiveProvider

Static Get method: GetFromIdxArchiveProvider(Int32)

ToString()

For debugging: Number of members, and the first (up to) 5 items

Declaration
public override string ToString()
Returns
Type Description
String
Remarks

Entity 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 to it, and use methods like to operate on the whole collection.
  • You can create a (nested) DocumentCollection DocumentCollection.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(DocumentCollection.CustomSearch) method to apply the query to the database and obtain the result as an EntityCollection 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.
Unique indexes are handled through the Document object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Document are:
Index fieldsNested index class name
DocumentIdDocumentId:

Primary key

Nested index class: Document.IdxDocumentId

Static Get method: GetFromIdxDocumentId(Int32)
Non-unique indexes on table Document are:
Index fieldsNested index class name
OurRefOurRef:

Our reference, searchable field from free-text search

Nested index class: DocumentCollection.IdxOurRef

Static Get method: GetFromIdxOurRef(String)
Userdef2IdUserdef2Id:

User-defined fields

Nested index class: DocumentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(Int32)
UserdefIdUserdefId:

User-defined fields

Nested index class: DocumentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(Int32)
ExtrefExtref:

External reference (notes ID, email ID, other ID used by the archive provider)

Nested index class: DocumentCollection.IdxExtref

Static Get method: GetFromIdxExtref(String)
HeaderHeader:

Visible document name

Nested index class: DocumentCollection.IdxHeader

Static Get method: GetFromIdxHeader(String)
SearchnameSearchname:

For future use

Nested index class: DocumentCollection.IdxSearchname

Static Get method: GetFromIdxSearchname(String)
ArchiveProviderArchiveProvider:

Reference to archive provider; for future use, and the Notes Link

Nested index class: DocumentCollection.IdxArchiveProvider

Static Get method: GetFromIdxArchiveProvider(Int32)

Implements

INestedPersist
System.Collections.Generic.IEnumerable<T>
ISoCollection
System.Collections.IEnumerable
System.Collections.IList
System.Collections.ICollection
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList

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