Interface IDocument
Документ.
Inherited Members
Namespace: Ascon.Polynom.Api
Assembly: Ascon.Polynom.Api.dll
Syntax
public interface IDocument : IGroupPropertyOwner, IBaseGroupMember, IAbleToHaveChangeableName, IAbleToHaveDescription, IDeleteableApiObject, ILocateableApiObject, ISerialNumberOwner, IApplicableApiObject, IAbleToHaveUniqueId, IAbleToBeFavorite, IFilesOwner, IPropertyOwner, IPropertyValueOwner, IAbleToHaveId, IAbleToBeRecent, IAbleToHaveName, IApiObject, IApiEntity, INotifyPropertyChanged
Properties
CreationDate
Возвращает или задает дату создания.
Declaration
DateTime CreationDate { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime |
Designation
Возвращает или задает обозначение.
Declaration
string Designation { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
DocumentOwners
Возвращает коллекцию владельцев документа.
Declaration
IApiReadOnlyCollection<IDocumentOwner> DocumentOwners { get; }
Property Value
| Type | Description |
|---|---|
| IApiReadOnlyCollection<IDocumentOwner> |
Elements
Возвращает коллекцию элементов, к которым привязан документ.
Declaration
IApiReadOnlyCollection<IElement> Elements { get; }
Property Value
| Type | Description |
|---|---|
| IApiReadOnlyCollection<IElement> |
OwnerGroup
Возвращает или задает группу-владельца документа.
Declaration
IDocumentGroup OwnerGroup { get; set; }
Property Value
| Type | Description |
|---|---|
| IDocumentGroup |
Methods
CanMoveTo(IDocumentGroup)
Возвращает признак, можно ли переместить документ в другую группу.
Declaration
bool CanMoveTo(IDocumentGroup destinationGroup)
Parameters
| Type | Name | Description |
|---|---|---|
| IDocumentGroup | destinationGroup | Целевая группа. |
Returns
| Type | Description |
|---|---|
| bool | Признак, можно ли переместить документ. |
CopyTo(IDocumentGroup, string, ClassificationItemCopyingOptions)
Копирует документ в указанную группу.
Declaration
IDocument CopyTo(IDocumentGroup destinationGroup, string nameOfTheCopy, ClassificationItemCopyingOptions options = ClassificationItemCopyingOptions.None)
Parameters
| Type | Name | Description |
|---|---|---|
| IDocumentGroup | destinationGroup | Целевая группа. |
| string | nameOfTheCopy | Имя копии. |
| ClassificationItemCopyingOptions | options | Опции копирования. |
Returns
| Type | Description |
|---|---|
| IDocument | Копия группы. |
LinkDocumentOwner(IDocumentOwner)
Привязывает владельца к документу.
Declaration
void LinkDocumentOwner(IDocumentOwner documentOwner)
Parameters
| Type | Name | Description |
|---|---|---|
| IDocumentOwner | documentOwner | Объект-владелец документа. |
MoveTo(IDocumentGroup)
Перемещает документ в указанную группу.
Declaration
void MoveTo(IDocumentGroup destinationGroup)
Parameters
| Type | Name | Description |
|---|---|---|
| IDocumentGroup | destinationGroup | Целевая группа. |
UnlinkDocumentOwner(IDocumentOwner)
Отвязывает владельца от документа.
Declaration
bool UnlinkDocumentOwner(IDocumentOwner documentOwner)
Parameters
| Type | Name | Description |
|---|---|---|
| IDocumentOwner | documentOwner | Объект-владелец документа. |
Returns
| Type | Description |
|---|---|
| bool | true, если документ был в коллекции; иначе false. |