Interface IDocumentGroup

Группа документов.

Inherited Members
Namespace: Ascon.Polynom.Api
Assembly: Ascon.Polynom.Api.dll
Syntax
public interface IDocumentGroup : IMultiGroup, IBaseGroup, ILocateableApiObject, IAbleToHaveChangeableName, IAbleToHaveName, IAbleToHaveDescription, IReferenceEntry, IConceptAppointer, IDeleteableApiObject, IGroupWithSecurity, IStructureItemWithSecurity, IFormulaAppointer, IAbleToHaveId, IStructureItemWithTableSettings, IAbleToHaveClassId, IAbleToHaveIcon, IDocumentGroupOwner, IBaseGroupOwner, IPropertyOwnerScope, IStructureItem, IApiObject, IApiEntity, INotifyPropertyChanged

Properties

Documents

Возвращает коллекцию документов.

Declaration
IApiReadOnlyCollection<IDocument> Documents { get; }
Property Value
Type Description
IApiReadOnlyCollection<IDocument>

ParentCatalog

Возвращает каталог, в котором находится данная группа.

Declaration
IDocumentCatalog ParentCatalog { get; }
Property Value
Type Description
IDocumentCatalog

ParentGroup

Возвращает группу, в которой находится данная группа.

Declaration
IDocumentGroup ParentGroup { get; }
Property Value
Type Description
IDocumentGroup

Statistic

Возвращает статистику.

Declaration
IReadOnlyList<IStatisticItem> Statistic { get; }
Property Value
Type Description
IReadOnlyList<IStatisticItem>

Статистика.

Methods

AddDocument(IDocument)

Добавляет документ в группу (множественная классификация документа).

Declaration
IMultiCatalogedItem AddDocument(IDocument document)
Parameters
Type Name Description
IDocument document

Документ.
Returns
Type Description
IMultiCatalogedItem

Множественно классифицированный документ

AddDocument(IDocument, Guid)

Добавляет документ в группу (множественная классификация документа с заданным id).

Declaration
IMultiCatalogedItem AddDocument(IDocument document, Guid multiCatalogedItemId)
Parameters
Type Name Description
IDocument document

Документ.
Guid multiCatalogedItemId

Id создаваемого элемента множественной классификации.
Returns
Type Description
IMultiCatalogedItem

Множественно классифицированный документ

CanAddDocument(IDocument)

Определяет, можно ли добавить документ в группу (множественная классификация документа).

Declaration
bool CanAddDocument(IDocument document)
Parameters
Type Name Description
IDocument document

Документ.
Returns
Type Description
bool

true, если документ можно добавить в другую группу; иначе false.

CanMoveTo(IDocumentGroupOwner)

Определяет, можно ли переместить группу в другую группу.

Declaration
bool CanMoveTo(IDocumentGroupOwner groupOwner)
Parameters
Type Name Description
IDocumentGroupOwner groupOwner

Группа или каталог, в которую перемещается данная группа.
Returns
Type Description
bool

true если группу можно переместить; иначе false.

CopyTo(IDocumentGroupOwner, string, ClassificationCopyingOptions)

Копирует группу в другую группу или каталог.

Declaration
IDocumentGroup CopyTo(IDocumentGroupOwner groupOwner, string nameOfTheCopy, ClassificationCopyingOptions options = ClassificationCopyingOptions.None)
Parameters
Type Name Description
IDocumentGroupOwner groupOwner

Группа или каталог, в которую копируется данная группа.
string nameOfTheCopy

Имя копии.
ClassificationCopyingOptions options

Опции копирования.
Returns
Type Description
IDocumentGroup

Копия группы.

CreateDocument(string, string, string, DateTime?, Guid?, ObjectStorageType, Protection)

Создает документ.

Declaration
IDocument CreateDocument(string name, string description = null, string designation = null, DateTime? creationDate = null, Guid? id = null, ObjectStorageType storageType = ObjectStorageType.Persistent, Protection protection = Protection.None)
Parameters
Type Name Description
string name

Имя.
string description

Описание.
string designation

Обозначение.
DateTime? creationDate

Дата создания.
Guid? id

Идентификатор.
ObjectStorageType storageType

Тип хранения.
Protection protection

Маркер защиты.
Returns
Type Description
IDocument

Созданный документ.

CreateDocumentGroup(string, bool?, int?, Guid?, ObjectStorageType)

Создает группу документов.

Declaration
IDocumentGroup CreateDocumentGroup(string name, bool? isEntry = null, int? iconCode = null, Guid? id = null, ObjectStorageType storageType = ObjectStorageType.Persistent)
Parameters
Type Name Description
string name

Имя группы.
bool? isEntry

true, если группа точка входа.
int? iconCode

Код иконки группы.
Guid? id

Уникальный идентификатор группы.
ObjectStorageType storageType

Тип хранения.
Returns
Type Description
IDocumentGroup

Созданную группу документов.

MoveTo(IDocumentGroupOwner)

Перемещает группу в другую группу или каталог.

Declaration
void MoveTo(IDocumentGroupOwner groupOwner)
Parameters
Type Name Description
IDocumentGroupOwner groupOwner

Группа или каталог, в которую перемещается данная группа.

RemoveDocument(IDocument)

Удаляет элемент из группы.

Declaration
bool RemoveDocument(IDocument document)
Parameters
Type Name Description
IDocument document

Документ.
Returns
Type Description
bool

true, если документ был найден в коллекции; иначе false.

See Also