Справочник встроенных подпрограмм и функций ORACLE FORMS DEVELOPER

GET_LIST_ELEMENT_COUNT - возвращает значение, определяющее кол-во элементов в элементе списка, включая элементы, содержащие NULL -значения.

Параметры:

• list_id - уникальный идентификатор, который Forms Builder связывает с элементом списка при создании. Функция поиска идентификатора - FIND_ITEM. Тип данных идентификатора - ITEM.
• list_name - имя элемента списка. Тип данных - VARCHAR2.

GET_LIST_ELEMENT_LABEL - возвращает информацию о метке элемента.

Параметры:

• list_id - уникальный идентификатор, который Forms Builder связывает с элементом списка при создании. Функция поиска идентификатора - FIND_ITEM. Тип данных идентификатора - ITEM.
• list_name - имя элемента списка. Тип данных - VARCHAR2.
• list_index - специфицирует значение индекса элемента списка, то есть номер, под которым будет добавлен элемент в список элементов. Начинается с 1.

GET_LIST_ELEMENT_VALUE - возвращает значение элемента в элементе списка.

Параметры:

• list_id - уникальный идентификатор, который Forms Builder связывает с элементом списка при создании. Функция поиска идентификатора - FIND_ITEM. Тип данных идентификатора - ITEM.
• list_name - имя элемента списка. Тип данных - VARCHAR2.
• list_index - специфицирует значение индекса элемента списка, то есть номер, под которым будет добавлен элемент в список элементов. Начинается с 1.

GET_LOV_PROPERTY - возвращает в качестве значения информацию о свойстве LOV.

Параметры:

• lov_id - уникальный идентификатор, который Forms Builder связывает со списком значений ( LOV ) при создании. Функция поиска идентификатора - FIND_LOV. Тип данных идентификатора - LOV.
• lov_name - имя списка значений. Тип данных - Varchar2.
• Property - название свойства, информацию о котором мы хотим получить. Ниже перечислены возможные значения этого свойства:
  • AUTO_REFRESH - возвращает TRUE, если автоматическое обновление включено (выполнять запрос для заполнения LOV повторно), если False, то, соответственно, автообновление отключено.
  • GROUP_NAME - возвращает имя группы записей, на которой базируется LOV.
  • HEIGHT - возвращает высоту LOV.
  • WIDTH - возвращает ширину LOV.
  • X_POS - возвращает позицию по "Х" положения LOV на вид-картинке или дисплее.
  • Y_POS - возвращает позицию по "Y" положения LOV на вид-картинке или дисплее.

GET_MENU_ITEM_PROPERTY - возвращает состояние элемента меню относительно рассматриваемого свойства.

Параметры:

• menuitem_id - уникальный идентификатор, который Forms Builder связывает с элементом меню при создании. Функция поиска идентификатора - FIND_MENU_ITEM. Тип данных - MenuItem.
• menu_name.menuitem_name - имя элемента меню ( MenuItem ). Тип данных - VARCHAR2.
• Property - название свойства, информацию о котором мы хотим получить. Ниже перечислены возможные значения этого свойства:
  • CHECKED - возвращает True, если check box элемента меню помечен ( checked ), и False, если не помечен ( unchecked ).
  • ENABLED - возвращает True, если элемент меню доступен, и False, если недоступен.
  • ICON_NAME - возвращает имя файла, который содержит иконку, ассоциированную с элементом.
  • LABEL - возвращает строку метки элемента меню.
  • VISIBLE - возвращает True, если элемент виден, False - если не виден.

GET_MESSAGE - возвращает текущее сообщение соответствующего типа.

GET_PARAMETER_ATTR - возвращает текущее значение и тип выбранного параметра в выбранном листе параметров (parameter list).

Параметры:

• list or name - определяет либо идентификатор листа параметров (parameter list), либо имя списка параметров. Тип данных для списка параметров - PARAMLIST.
• Key - имя параметра символьного типа.
• Paramtype - тип выходного параметра. Типы параметров:
  • DATA_PARAMETER
  • TEXT_PARAMETER
• value - значение выходного параметра; если это, к примеру, текстовый параметр, то значением параметра будет актуальное ему значение.

GET_PARAMETER_LIST - функция поиска идентификатора ( ID ) списка параметров. Тип возвращаемых данных - ParamList. Параметры: name - имя списка параметров. Тип данных - Varchar2.

GET_RADIO_BUTTON_PROPERTY - возвращает информацию об указанной радиокнопке.

Параметры:

• Iitem_name - определяет имя элемента. Тип данных - VARCHAR2.
• Item_id - уникальный идентификатор, который Forms Builder связывает с элементом списка при создании. Используйте также FIND_ ITEM для поиска данного идентификатора.
• button_name - определяет имя радиокнопки, свойства которой нас интересуют.
• Property - название свойства, информацию о котором мы хотим получить. Ниже перечислены возможные значения этого свойства:
  • BACKGROUND_COLOR - цвет заднего фона.
  • ENABLED - возвращает True, если элемент меню доступен, и False, если недоступен.
  • FILL_PATTERN - тип заливки, использованной для заполнения региона.
  • FONT_NAME - название шрифта.
  • FONT_SIZE - размер шрифта.
  • FONT_SPACING - расстояние между буквами - кернинг.
  • FONT_STYLE - стиль шрифта.

GET_RECORD_PROPERTY - возвращает значение свойства существующей записи, то есть номер записи принимаемый параметром функции record_number должен существовать.

Параметры:

• record_number - определяет запись в блоке, для которой нужно получить информацию.
• block_name - определяет блок, содержащий целевую запись.
• Property - определяет свойство, значение которого мы хотим проверить: NEW, CHANGED, QUERY.

GET_TAB_PAGE_PROPERTY - возвращает значение свойств для указанной вкладки.

• tab_page_id - уникальный идентификатор, который Forms Builder связывает со страницей вкладки при создании. Функция поиска уникального идентификатора - FIND_TAB_PAGE. Тип данных - TAB_PAGE.
• tab page_name - имя страницы вкладки.
• Property - название свойства, информацию о котором мы хотим получить. Ниже перечислены возможные значения этого свойства:
  • BACKGROUND_COLOR - цвет заднего фона.
  • ENABLED - возвращает True, если элемент меню доступен, и False, если недоступен.
  • FILL_PATTERN - тип заливки, использованной для заполнения региона.
  • FONT_NAME - название шрифта.
  • FONT_SIZE - размер шрифта.
  • FONT_SPACING - расстояние между буквами - кернинг.
  • FONT_STYLE - стиль шрифта.
  • FONT_WEIGHT - вес шрифта.

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

Параметры:

• item_name - специфицирует имя объекта, данное ему на этапе проектирования. Тип данных - VARCHAR2.
• Item_id - уникальный идентификатор, который Forms Builder связывает с элементом при создании. Функция поиска идентификатора - FIND_ITEM.
• Node - определяет узел.

GET_TREE_PROPERTY - возвращает значение свойства дерева.

Параметры:

• item_name - специфицирует имя объекта, данное ему на этапе проектирования. Тип данных - VARCHAR2.
• Item_id - уникальный идентификатор, который Forms Builder связывает с элементом при создании. Функция поиска идентификатора - FIND_ITEM.
• Property - название свойства, информацию о котором мы хотим получить. Ниже перечислены возможные значения этого свойства:
  • DATASOURCE - возвращает источник, использованный для заполнения дерева. Возвращает EXTERNAL, если свойство установлено каким-либо другим способом.
  • RECORD_GROUP - возвращает наименование группы записей, использованной для заполнения иерархического дерева, причем текст запроса может быть создан как на этапе проектирования, так и с помощью SET_TREE_PROPERTY.
  • QUERY_TEXT - возвращает текст запроса, использованного для заполнения иерархического дерева, причем текст запроса может быть создан как на этапе проектирования, так и с помощью SET_TREE_PROPERTY.
  • NODE_COUNT - возвращает число ячеек источника иерархического дерева.
  • SELECTION_COUNT - возвращает число выделенных ячеек.
  • ALLOW_EMPTY_BRANCHES - разрешено ли существование пустых узлов.
  • ALLOW_MULTI-SELECT - разрешено ли множественное выделение.

GET_TREE_SELECTION - возвращает узел данных, помеченный как выделенный, причем выделение отмечается как индекс в списке индексов выделенных элементов.

Параметры:

• item_name - специфицирует имя объекта, данное ему на этапе проектирования. Тип данных - VARCHAR2.
• Item_id - уникальный идентификатор, который Forms Builder связывает с элементом при создании. Функция поиска идентификатора - FIND_ITEM. Selection - определяет выделение единичного узла.

GET_WINDOW_PROPERTY - возвращает текущие установки помеченного вами окна.

Параметры:

• window_id - уникальный идентификатор, который Forms Builder связывает с окном при создании. Функция поиска идентификатора - FIND_WINDOW.
• window_name - имя окна, заданное на этапе проектирования.
• Property - название свойства, информацию о котором мы хотим получить. Ниже перечислены возможные значения этого свойства:
  • BACKGROUND_COLOR - цвет заднего фона.
  • ENABLED - возвращает True, если элемент меню доступен, и False, если недоступен.
  • FILL_PATTERN - тип заливки, использованной для заполнения региона.
  • FONT_NAME - название шрифта.
  • FONT_SIZE - размер шрифта.
  • FONT_SPACING - расстояние между буквами - кернинг.
  • HEIGHT - возвращает высоту окна.
  • HIDE_ON_EXIT - скрывается ли окно при выходе.
  • ICON_NAME - возвращает имя файла картинки, ассоциированной с окном в минимизированном режиме.
  • TITLE - возвращает название окна
  • VISIBLE - возвращает True, если окно видимо, и False, если не видимо.
  • WHITE_ON_BLACK - белое на черном. True - белое на черном.
  • WIDTH - возвращает ширину окна.
  • WINDOW_HANDLE - возвращает уникальную константу, которая используется для привязки к объекту. Актуально только для платформ Windows, иначе возвращает "0".
  • WIDOW_SIZE - возвращает высоту и ширину окна.
  • WINDOW_STATE - возвращает текущее состояние отображения окна: NORMAL, MAXIMIZE или MINIMIZE.
  • X_POS - возвращает позицию по "Х" положения окна на дисплее.
  • Y_POS - возвращает позицию по "Y" положения окна на дисплее.

GO_BLOCK (block_name) - переходит к указанному блоку. Тип данных - Varchar2.

Параметры:

• block_name - имя блока, к которому нужно перейти.

GO_FORM (form_name) - переходит к указанной форме. Тип данных - Varchar2.

Параметры:

• form_name - имя формы, к которой надо перейти.

GO_ITEM (item_name) - переходит к указанному элементу.

• item_name - имя элемента, к которому надо перейти.

GO_RECORD (record_number) - переходит к указанной записи по ее номеру.

Пример:

TO_NUMBER(:SYSTEM.TRIGGER_RECORD+8), а также используя другие системные переменные: SYSTEM.CURSOR_RECORD и SYSTEM.TRIGGER_RECORD.

HELP - выдает поясняющее сообщение о текущем поле в строке сообщений. Если такое сообщение уже выведено, HELP выводит детальный help-экран для данного поля.

HIDE_MENU - заставляет текущее меню исчезать (но не выходить из него), если оно в данный момент было выведено на экран, открывая ту часть вывода формы, которая была закрыта этим меню. Меню снова выведется на экран при вызове упакованной процедуры SHOW_MENU или при нажатии оператором функциональной клавиши [Menu].

HIDE_VIEW - скрывает указанную вид-картинку ( Canvas ).

Параметры:

• view_id - уникальный идентификатор, который Forms Builder связывает с вид-картинкой ( Canvas ) при создании. Функция поиска идентификатора - FIND_VIEW.
• view_name - имя вид-картинки ( Canvas ).

HIDE_WINDOW - скрывает указанное окно. HIDE_WINDOW эквивалентно свойству окно VISIBLE, установленному в False ( No ).

Параметры:

• window_id - уникальный идентификатор, который Forms Builder связывает с окном при создании. Функция поиска идентификатора - FIND_WINDOW.
• window_name - имя окна, заданное на этапе проектирования.

HOST ('system_command' [, NOSCREEN]) - выполняет указанную команду ОС. Если вы используете параметр NO_SCREEN, Forms не очищает экран и не запрашивает у оператора выход из команды.

ID_NULL - возвращает булево ( BOOLEAN ) значение, если идентификатор ( ID ) объекта доступен.

Параметры:

• object_id - идентификаторы нижеперечисленных объектов, состояние которых нужно проверить:
  • Alert ;
  • Block ;
  • Canvas ;
  • Editor ;
  • FormModule ;
  • GroupColumn ;
  • Item ;
  • LOV ;
  • MenuItem ;
  • ParamList ;
  • RecordGroup ;
  • Relation ;
  • Timer ;
  • Viewport ;
  • Window.