Interface IReference
Справочник.
Inherited Members
Namespace: Ascon.Polynom.Api
Assembly: Ascon.Polynom.Api.dll
Syntax
public interface IReference : IDeleteableApiObject, IPropertyOwnerScope, ILocateableApiObject, IAbleToHaveId, IAbleToHaveChangeableName, IAbleToHaveName, IAbleToHaveIcon, IAbleToHaveDescription, IStructureItem, IApiObject, IApiEntity, INotifyPropertyChanged
Properties
Catalogs
Возвращает список каталогов.
Declaration
IApiReadOnlyCollection<ICatalog> Catalogs { get; }
Property Value
| Type | Description |
|---|---|
| IApiReadOnlyCollection<ICatalog> |
DocumentCatalog
Возвращает каталог документов.
Declaration
IDocumentCatalog DocumentCatalog { get; }
Property Value
| Type | Description |
|---|---|
| IDocumentCatalog |
Entries
Возвращает коллекцию точек входа для данного справочника.
Declaration
IApiReadOnlyCollection<IReferenceEntry> Entries { get; }
Property Value
| Type | Description |
|---|---|
| IApiReadOnlyCollection<IReferenceEntry> |
Security
Настройки безопасности.
Declaration
IReferenceSecurity Security { get; }
Property Value
| Type | Description |
|---|---|
| IReferenceSecurity |
ViewpointCatalog
Возвращает каталог представлений.
Declaration
IViewpointCatalog ViewpointCatalog { get; }
Property Value
| Type | Description |
|---|---|
| IViewpointCatalog |
Methods
AddEntry(IReferenceEntry)
Добавляет точку входа.
Declaration
void AddEntry(IReferenceEntry entry)
Parameters
| Type | Name | Description |
|---|---|---|
| IReferenceEntry | entry | Узел, который будет точкой входа. |
Copy(string, ClassificationCopyingOptions)
Создаёт копию справочника.
Declaration
IReference Copy(string nameOfTheCopy, ClassificationCopyingOptions options)
Parameters
| Type | Name | Description |
|---|---|---|
| string | nameOfTheCopy | Имя копии. |
| ClassificationCopyingOptions | options | Опции копирования. |
Returns
| Type | Description |
|---|---|
| IReference | Копия справочника. |
CreateCatalog(string, int?, bool?, Guid?, ObjectStorageType)
Создает каталог.
Declaration
ICatalog CreateCatalog(string name, int? iconCode = null, bool? isEntry = null, Guid? id = null, ObjectStorageType storageType = ObjectStorageType.Persistent)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Имя каталога. |
| int? | iconCode | Код иконки. |
| bool? | isEntry | true, если каталог точка входа. |
| Guid? | id | Уникальный идентификатор. |
| ObjectStorageType | storageType | Тип хранения. |
Returns
| Type | Description |
|---|---|
| ICatalog | Созданный каталог. |
RemoveEntry(IReferenceEntry)
Удаляет точку входа.
Declaration
void RemoveEntry(IReferenceEntry entry)
Parameters
| Type | Name | Description |
|---|---|---|
| IReferenceEntry | entry | Узел для удаления. |