Interface IGroup

Группа.

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

Properties

ElementFactory

Возвращает конструктор компонентов.

Declaration
IElementFactory ElementFactory { get; }
Property Value
Type Description
IElementFactory

Elements

Возвращает коллекцию элементов группы.

Declaration
IApiReadOnlyCollection<IElement> Elements { get; }
Property Value
Type Description
IApiReadOnlyCollection<IElement>

HasElementFactory

Возвращает или задает признак существует ли конструктор компонентов. Если задать true, в свойстве ElementFactory появится конструктор компонентов; если задать false, в свойстве ElementFactory будет null.

Declaration
bool HasElementFactory { get; set; }
Property Value
Type Description
bool

ParentCatalog

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

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

ParentGroup

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

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

Statistic

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

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

Статистика.

Methods

AddElement(IElement)

Включает элемент в группу (множественная классификация элемента).

Declaration
IMultiCatalogedItem AddElement(IElement element)
Parameters
Type Name Description
IElement element

Элемент.
Returns
Type Description
IMultiCatalogedItem

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

AddElement(IElement, Guid)

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

Declaration
IMultiCatalogedItem AddElement(IElement element, Guid multiCatalogedItemId)
Parameters
Type Name Description
IElement element

Элемент.
Guid multiCatalogedItemId

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

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

CanAddElement(IElement)

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

Declaration
bool CanAddElement(IElement element)
Parameters
Type Name Description
IElement element

Элемент.
Returns
Type Description
bool

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

CanMoveTo(IGroupOwner)

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

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

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

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

CopyTo(IGroupOwner, string, ClassificationCopyingOptions)

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

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

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

Имя копии.
ClassificationCopyingOptions options

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

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

CreateElement(string, Guid?, ObjectStorageType, Protection)

Создает элемент.

Declaration
IElement CreateElement(string name, Guid? id = null, ObjectStorageType storageType = ObjectStorageType.Persistent, Protection protection = Protection.None)
Parameters
Type Name Description
string name

Имя элемента.
Guid? id

Уникальный идентификатор элемента.
ObjectStorageType storageType

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

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

Созданный элемент.

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

Создает группу.

Declaration
IGroup CreateGroup(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
IGroup

Созданная группа.

MoveTo(IGroupOwner)

Перемещает группу в другую группу.

Declaration
bool MoveTo(IGroupOwner groupOwner)
Parameters
Type Name Description
IGroupOwner groupOwner

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

true если группа была перемещена; иначе false.

RemoveElement(IElement)

Исключает элемент из группы (множественная классификация элемента).

Declaration
bool RemoveElement(IElement element)
Parameters
Type Name Description
IElement element

Элемент.
Returns
Type Description
bool

true если элемент был успешно исключен; иначе false.

Extension Methods

See Also