Список COM интерфейсов

IObjectUI

Интерфейс, описывающий свойства клиентских объектов СУБП (функций, шлюзов).

Свойства и методы Тип Параметры Описание

Свойства и методы	Тип	Описание
`Data`	`string`	Задаёт или возвращает данные объекта (функции, шлюза).
`Icon`	`IPictureDisp`	Возвращает иконку объекта.
`TypeName`	`string`	Возвращает название данного типа объектов.
`ID`	`string`	Возвращает идентификатор объекта.

Data

string

Задаёт или возвращает данные объекта (функции, шлюза).

Icon

IPictureDisp

Возвращает иконку объекта.

TypeName

string

Возвращает название данного типа объектов.

ID

string

Возвращает идентификатор объекта.

IDVObjectUI

Данный интерфейс реализуется всеми объектами, использующими Docsvision. Предоставляет доступ к сессии.

Свойства и методы Тип Параметры Описание

Свойства и методы	Тип	Параметры	Описание
`UserSession`	`IDispatch`		Задаёт или возвращает сессию.
`Host`	`IDispatch`		Задаёт или возвращает хост Docsvision.

UserSession

IDispatch

Задаёт или возвращает сессию.

Host

IDispatch

Задаёт или возвращает хост Docsvision.

IObjectLocalize

Дополнительный интерфейс для объектов, поддерживающих локализацию.

Свойства и методы Тип Параметры Описание

Свойства и методы	Тип	Параметры	Описание
`GetLocaleID`	`long`		Получает идентификатор текущей локализации.
`SetLocaleID`		`(long) LocaleID`	Устанавливает идентификатор текущей локализации.

GetLocaleID

long

Получает идентификатор текущей локализации.

SetLocaleID

(long) LocaleID

Устанавливает идентификатор текущей локализации.

IGateInit

Интерфейс клиентского компонента шлюза. Определяет возможность инициализации компонента шлюза с передачей в него начальных данных.

Свойства и методы Тип Параметры Описание

Свойства и методы	Тип	Параметры	Описание
`Initialize`		`(string) Data` — данные шлюза	Инициализирует шлюз, передавая данные, сохранённые в настройках шлюза в справочнике шлюза, как правило, xml -описание шлюза.

Initialize

(string) Data — данные шлюза

Инициализирует шлюз, передавая данные, сохранённые в настройках шлюза в справочнике шлюза, как правило, xml -описание шлюза.

IGateUI

Интерфейс клиентского компонента шлюза. Реализует свойства и методы для работы с доступными типами переменных.

Свойства и методы Тип Параметры Описание

Свойства и методы	Тип	Параметры	Описание
`GetObjectTypes`	`IobjectType Collection`		Коллекция описаний типов объектов, поддерживаемых шлюзом.
`GetMethods`	`Imethod Collection`		Коллекция описаний методов, поддерживаемых шлюзом.
`SelectObject`	`bool`	`(long) hWnd` — идентификатор родительского окна `(long) TypeID` — идентификатор типа объекта `(string) ObjectID` — выходной параметр, идентификатор и значение объекта в шлюзе	Выбор объекта в шлюзе. Метод позволяет выбрать и вернуть идентификатор объекта указанного типа. Измененное значение возвращается в параметре `ObjectID`. Метод возвращает `true`, если значение было выбрано, иначе `false`.
`ShowObject`		`(long) hWnd` — идентификатор родительского окна `(long) TypeID` — идентификатор типа объекта `(string) ObjectID` — выходной параметр, идентификатор\значение объекта в шлюзе	Отображение объекта в шлюзе. Метод позволяет активизировать объект по его идентификатору и типу. Может быть поддержано не для всех типов объектов.
`GetObjectDisplayValue`	`string`	`(long) TypeID` — идентификатор типа объекта `(string) ObjectID` — выходной параметр, идентификатор и значение объекта в шлюзе	Возвращает отображаемое значение объекта по его типу и идентификатору.
`GetObjectReference`	`string`	`(long) hWnd` — идентификатор родительского окна `(long) TypeID` — идентификатор типа объекта `(string) ObjectID` — выходной параметр, идентификатор\значение объекта в шлюзе	Возвращает строку-ссылку на объект в шлюзе.
`GetQuickSearchValues`	`IDispatch`	`(long) TypeID` — идентификатор типа объекта `(string) ObjectID` — выходной параметр, идентификатор и значение объекта в шлюзе	Возвращает коллекцию идентификаторов объектов, найденных по строке, заданной параметром `SearchFor`.

GetObjectTypes

IobjectType Collection

Коллекция описаний типов объектов, поддерживаемых шлюзом.

GetMethods

Imethod Collection

Коллекция описаний методов, поддерживаемых шлюзом.

SelectObject

bool

(long) hWnd — идентификатор родительского окна

(long) TypeID — идентификатор типа объекта

(string) ObjectID — выходной параметр, идентификатор и значение объекта в шлюзе

Выбор объекта в шлюзе. Метод позволяет выбрать и вернуть идентификатор объекта указанного типа. Измененное значение возвращается в параметре ObjectID. Метод возвращает true, если значение было выбрано, иначе false.

ShowObject

(long) hWnd — идентификатор родительского окна

(long) TypeID — идентификатор типа объекта

(string) ObjectID — выходной параметр, идентификатор\значение объекта в шлюзе

Отображение объекта в шлюзе. Метод позволяет активизировать объект по его идентификатору и типу. Может быть поддержано не для всех типов объектов.

GetObjectDisplayValue

string

(long) TypeID — идентификатор типа объекта

(string) ObjectID — выходной параметр, идентификатор и значение объекта в шлюзе

Возвращает отображаемое значение объекта по его типу и идентификатору.

GetObjectReference

string

(long) hWnd — идентификатор родительского окна

(long) TypeID — идентификатор типа объекта

(string) ObjectID — выходной параметр, идентификатор\значение объекта в шлюзе

Возвращает строку-ссылку на объект в шлюзе.

GetQuickSearchValues

IDispatch

(long) TypeID — идентификатор типа объекта

(string) ObjectID — выходной параметр, идентификатор и значение объекта в шлюзе

Возвращает коллекцию идентификаторов объектов, найденных по строке, заданной параметром SearchFor.

IFunctionUI

Интерфейс клиентского компонента шлюза. Реализует методы, вызываемые карточкой бизнес-процесса при работе с функцией.

Свойства и методы Тип Параметры Описание

Свойства и методы	Тип	Параметры	Описание
`GetRequiredGates`	`string`		Возвращает список идентификаторов необходимых шлюзов (разделенных запятой).
`AllowExecute`	`string`		Выполняет проверку на наличие всех необходимых для запуска функции данных. Возвращает `true`, если функция готова к выполнению, иначе `false`.

GetRequiredGates

string

Возвращает список идентификаторов необходимых шлюзов (разделенных запятой).

AllowExecute

string

Выполняет проверку на наличие всех необходимых для запуска функции данных. Возвращает true, если функция готова к выполнению, иначе false.

IExportableFunctionUI

Клиентский интерфейс для функций, обладающих собственным механизмом экспорта/импорта в XML.

Свойства и методы Тип Параметры Описание

Свойства и методы	Тип	Параметры	Описание
`Export`	`string`		Вызывается при экспорте функции. Возвращает данные для экспорта в виде строки.
`Import`		`(string) Data` — данные функции	Вызывается при импорте функции.

Export

string

Вызывается при экспорте функции. Возвращает данные для экспорта в виде строки.

Import

(string) Data — данные функции

Вызывается при импорте функции.

IStateFunctionUI

Клиентский интерфейс для функций, обладающих собственным набором состояний.

Свойства и методы Тип Параметры Описание

Свойства и методы	Тип	Описание
`CurrentIcon`	`IPictureDisp`	Возвращает иконку для текущего состояния.
`CurrentName`	`string`	Возвращает локализованное название текущего состояния.
`CurrentColor`	`long`	Возвращает цвет иконки для текущего состояния (в формате OLE Color).
`CurrentFunction`	`IDispatch`	Задаёт или возвращает данные о состоянии функции.

CurrentIcon

IPictureDisp

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

CurrentName

string

Возвращает локализованное название текущего состояния.

CurrentColor

long

Возвращает цвет иконки для текущего состояния (в формате OLE Color).

CurrentFunction

IDispatch

Задаёт или возвращает данные о состоянии функции.