Визуальные компоненты: различия между версиями

Материал из Intellex
Перейти к навигации Перейти к поиску
м (Wiki переименовал страницу Компоненты в Визуальные компоненты без оставления перенаправления)
Строка 788: Строка 788:
|}
|}


== Произвольный ввод ==
=== Числовое поле (edit) ===
'''Произвольный ввод''' - это визуальное действие, которое позволяет пользователю заполнить поля документа произвольным значением.
Компонент для ввода числовых данных (numedit).
 
[[Файл:Числовое поле.png|без|обрамить]]
Пример отображения компонента "Произвольный ввод"
'''Свойства'''
 
=== Основные свойства ===
{| class="wikitable"
{| class="wikitable"
!Свойство
|'''Название атрибута'''
! colspan="1" |Наличие значения
|'''Тип данных'''
!Назначение
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступ из скрипта'''
|'''Описание'''
|-
|-
|Параметр
| colspan="1" |displayformat
| colspan="1" |Обязательно
| colspan="1" |перечислимый
|'''Описание:''' атрибут предназначен для выбора из списка соответствующего параметра, заданного в структуре документа.
| colspan="1" |нет
| colspan="1" |number
| colspan="1" |нет
| colspan="1" |нет
| colspan="1" |Формат отображения данных:


'''Допустимые значения''': статичная строка
* currency - отображение денег
 
* number - отображение произвольного числа
''Примечание: В списке содержатся только те параметры, которые соответствуют уровню блока в структуре документа.''
|-
|-
|Описание
| colspan="1" |totalDigits
| colspan="1" |Не обязательно
| colspan="1" |число
|'''Описание:''' атрибут позволяет задать имя для визуального компонента. По умолчанию, если описание не задано, то элемент на форме будет отображаться без названия.
| colspan="1" |нет
 
| colspan="1" |
'''Допустимые значения:''' статичная строка
| colspan="1" |нет
|-
| colspan="1" |нет
|Назначение
| colspan="1" |Допустимая длина числа
| colspan="1" |Не обязательно
|'''Описание:''' атрибут предназначен для описания параметра в спецификации.


'''Допустимые значения:''' статичная строка
Мин. - 1 (oracle), макс. - 38 (oracle)
|}


=== Свойства применимости ===
Если значение не задано, оно считается равным максимальному
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
|-
| colspan="1" |Скрывать если
| colspan="1" |fractionDigits
| colspan="1" |Не обязательно
| colspan="1" |число
| colspan="1" |'''Описание:''' атрибут предназначен для скрытия связанного сдействием визуального элемента на форме.
| colspan="1" |нет
 
| colspan="1" |
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
| colspan="1" |нет
 
| colspan="1" |нет
* Истина - элемент скрывается на форме
| colspan="1" |Допустимая длина дробной части
* Ложь - элемент отображается
* NULL - элемент отображается
 
''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
{| class="wikitable"
|
(DOC_NUM_PARAM>10) AND (DOC_LOG_PARAM = FALSE)
|}
|-
| colspan="1" |Выполнять если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на возможность изменять значение параметра при помощи визуального компонента. Выражение имеет логический тип.
 
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
 
* Истина - элемент доступен для редактирования
* Ложь - элемент не доступен для редактирования
* NULL - элемент доступен
 
''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
{| class="wikitable"
|
IF(DOC_NUM_PAR = 10, TRUE, FALSE)
|}
|}
 
=== Зависимости визуального компонента от типа параметра ===
{| class="wikitable"
!Тип
!Описание
|-
|Строка
|Позволяет ввести в компонент строку
|-
| colspan="1" |Число
| colspan="1" |Позволяет вводить в компонент только числовое значение
|-
| colspan="1" |Дата
| colspan="1" |Позволяет выбрать дату или ввести с клавиатуры
|-
| colspan="1" |Дата и время
| colspan="1" |Позволяет выбрать дату со временем
|-
|Логический
|Позволяет выбрать значение True или False
|}
 
== Отображение значения ==
'''Отображение значения''' - это визуальное действие, которое позволяет пользователю отображать значение поля документа
 
 
Пример отображения компонента "Произвольный текст"
 
=== Основные свойства ===
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
|Параметр
| colspan="1" |Обязательно
|'''Описание:''' атрибут предназначен для выбора из списка соответствующего параметра, заданного в структуре документа.
 
'''Допустимые значения:''' статичная строка. В списке содержатся только те параметры, которые соответствуют уровню блока в структуре документа.
|-
|Описание
| colspan="1" |Не обязательно
|'''Описание:''' атрибут позволяет задать имя для визуального компонента. По умолчанию, если описание не задано, то элемент на форме будет отображаться без названия.
 
'''Допустимые значения:''' статичная строка
 
По умолчанию, если описание не задано, то элемент на форме будет отображаться без названия.
|-
|Назначение
| colspan="1" |Не обязательно
|'''Описание:''' атрибут предназначен для описания параметра в спецификации.
 
'''Допустимые значения:''' статичная строка
|}
 
=== Свойства применимости ===
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
| colspan="1" |Скрывать если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для визуального скрытия элемента на форме.
 
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
 
* Истина - элемент скрывается на форме
* Ложь - элемент отображается и недоступен для редактирования значения.
* NULL - элемент отображается и недоступен для редактирования значения.
 
''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
{| class="wikitable"
|
(DOC_NUM_PARAM>10) AND (DOC_LOG_PARAM = FALSE)
|}
|-
| colspan="1" |Выполнять если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на доступность к данному компоненту.
 
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
 
* Истина - элемент отображается и недоступен для редактирования
* Ложь - элемент отображается и недоступен для редактирования
* NULL - элемент отображается и недоступен для редактирования
 
''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
{| class="wikitable"
|
IF(DOC_NUM_PAR = 10, TRUE, FALSE)
|}
|}
 
=== Зависимости визуального компонента от типа параметра ===
{| class="wikitable"
!Тип
!Описание
|-
|Строка
|Позволяет отобразить в компонент строку
|-
| colspan="1" |Число
| colspan="1" |Позволяет отобразить в компонент числовое значение
|-
| colspan="1" |Дата
| colspan="1" |Позволяет отобразить в компонент дату
|-
| colspan="1" |Дата и время
| colspan="1" |Позволяет отобразить в компонент дату со временем
|-
|Логический
|Позволяет отобразить в компонент значение True или False(в чекбоксе)
|}
 
== Выбор из списка ==
'''Выбор из списка''' - это визуальное действие, которое разрешает пользователю заполнить поле документа одним значением из списка допустимых значений.
 
Пример отображения компонента "Выбор из списка"
 
=== Основные свойства ===
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
|Тип выбора
| colspan="1" |Обязательно
|'''Описание:''' позволяет настроить выпадающий список для выбора значение из грида.
 
'''Допустимые значения''':
 
* Из грида. Позволяет использовать в качестве списка данные из таблицы своего документа.
* Из апп-функции. Позволяет использовать апп-функцию, при выборе значения из выпадающего списка. Апп-функция должна возвращать курсор.
* Из локального справочника. Позволяет использовать локальные справочники в качестве входных параметров.
* Из общего справочника. Позволяет использовать общие справочники в качестве входных параметров.
 
''По умолчанию установлено значение "Из апп-функции"''
|-
|Параметр
| colspan="1" |Обязательно
|'''Описание:''' атрибут предназначен для указания параметра, в которых будет сохранен идентификатор из справочника
 
'''Допустимые значения''': число
 
|-
| colspan="1" |Описание
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут позволяет задать имя для визуального компонента. По умолчанию, если описание не задано, то элемент на форме будет отображаться без названия.
 
'''Допустимые значения:''' статичная строка
|-
| colspan="1" |Назначение
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для описания параметра в спецификации.
 
'''Допустимые значения:''' статичная строка
|}
Свойства применимости
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
| colspan="1" |Скрывать если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для визуального скрытия элемента на форме.
 
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
 
* Истина - элемент скрывается на форме
* Ложь - элемент отображается и недоступен для редактирования значения.
* NULL - элемент отображается и недоступен для редактирования значения. ''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
|-
| colspan="1" |Выполнять если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на доступность к данному компоненту.
 
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
 
* Истина - элемент отображается и недоступен для редактирования
* Ложь - элемент отображается и недоступен для редактирования
* NULL - элемент отображается и недоступен для редактирования
 
''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
|}
 
=== Свойства для типа выбора - "из грида" ===
Данные свойства предназначены, когда требуется заполнить выпадающий список на основе колонок грида.
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
| colspan="1" |Имя грида
| colspan="1" |Обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для выбора грида из списка, который будет использоваться для "Выпадающего списка"
 
'''Допустимые значения:''' статичная строка
|-
| colspan="1" |Условия выбора строк
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для задания выражения, при котором будут отображаться строки в выпадающем списке.
 
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
 
* Истина - выбор строк разрешен
* Ложь - выбор строк запрещен
* NULL - выбор строк разрешен
 
''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
|}
 
=== Свойства для типа выбора - "из апп-функции" ===
Данные свойства предназначены, когда требуется заполнить выпадающий список с помощью апп-функции
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
|Апп-функция
| colspan="1" |Не обязательно
|'''Описание:''' Атрибут предназначен для выбора апп-функции, по которой будет выбираться значение из списка. Апп-функция должны иметь тип 1, т.е. возвращать курсор.
 
'''Допустимые значения:'''  статичная строка
|-
| colspan="1" |Начать поиск с
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для задания минимального количества символов, после ввода которых будет осуществляться поиск. Значение может принимать только числовой тип
 
'''Допустимые значения:''' число
 
''Примечание: если выражение не задано, то условие по умолчанию поиск осуществляется сразу''
|-
| colspan="1" |Входной параметр
| colspan="1" |Обязательно для(Наименование\Идентификатор\Код)
| colspan="1" |'''Описание:''' предназначен для передачи входных параметров
 
'''Допустимые значения:''' статичная строка
|-
| colspan="1" |Значение
| colspan="1" |Обязательно для(Наименование\Идентификатор\Код)
| colspan="1" |'''Описание:''' предназначен для указания значения(выражения)
 
'''Допустимые значения:''' статичная строка
|-
| colspan="1" |Параметр документа
| colspan="1" |Обязательно(для Идентификатора и Наименования)
| colspan="1" |'''Описание:''' атрибут предназначен для указания выходных параметров при выборе значения я из списка
 
'''Допустимые значения:''' статичная строка
|-
| colspan="1" |Описание колонки
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут задает название для колонки(в случае если используется multisublistchoise) В других случаях название не влияет на компонент
 
'''Допустимые значения:''' статичная строка
|}
 
=== Свойства для типа выбора - "из локального справочника" ===
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
|Справочник
| colspan="1" |Не обязательно
|'''Описание:''' атрибут предназначен для выбора локального справочника
 
'''Допустимые значения:''' название справочника
|-
| colspan="1" |Параметр документа
| colspan="1" |Обязательно(для Идентификатора и Наименования)
| colspan="1" |'''Описание:''' атрибут предназначен для указания выходных параметров при выборе значения я из списка
 
'''Допустимые значения:''' статичная строка
|-
| colspan="1" |Описание колонки
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут задает название для колонки(в случае если используется multisublistchoise) В других случаях название не влияет на компонент
 
'''Допустимые значения:''' статичная строка
|}
 
=== Свойства для типа выбора - "общего справочника" ===
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
|Справочник
| colspan="1" |Не обязательно
|'''Описание:''' Атрибут предназначен для выбора общего справочника
 
'''Допустимые значения:''' статичная строка
|-
| colspan="1" |Параметр документа
| colspan="1" |Обязательно(для Идентификатора и Наименования)
| colspan="1" |'''Описание:''' Атрибут предназначен для указания выходных параметров при выборе значения я из списка
 
'''Допустимые значения:''' статичная строка
|-
| colspan="1" |Описание колонки
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' Атрибут задает название для колонки(в случае если используется multisublistchoise) В других случаях название не влияет на компонент
 
'''Допустимые значения:''' статичная строка
|}
 
== Апп-функция ==
Апп-функция - это действие, которое позволяет изменять поля документа через БД. Поля документа передаются в апп-функцию в качестве входных и выходных параметров.
 
Пример отображения компонента "Апп-функция"
 
=== Основные свойства ===
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
|Апп-функция
| colspan="1" |Обязательно
|'''Описание:''' позволяет выбрать имя апп-функции
 
'''Допустимые значения''': статичная строка, для апп-функции с CALL_TYPE = 1 или 2
|-
|Выполняется
| colspan="1" |Обязательно
|'''Описание:''' атрибут позволяет указать, каким образом будет выполняться апп-функция(автоматически или по нажатию на кнопку)
 
'''Допустимые значения''':
 
* Автоматически - означает, что данная апп-функция будет выполняться всегда(если условия выполнения не запрещают)
* По желание пользователя - в этом случае, пользователю предоставляется возможность запустить выполнение данной апп-функции с помощью кнопки, отображаемой на форме документа
 
''По умолчанию всегда установлено значение "Автоматически"''
|-
| colspan="1" |Описание
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут позволяет задать имя для визуального компонента. По умолчанию, если описание не задано, то элемент на форме будет отображаться без названия.
 
'''Допустимые значения:''' статичная строка
|-
| colspan="1" |Назначение
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для описания параметра в спецификации.
 
'''Допустимые значения:''' статичная строка
|}


=== Свойства применимости ===
Мин. - 1 (oracle), макс. - 10 (oracle)
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
| colspan="1" |Скрывать если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для визуального скрытия элемента на форме.


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
Если значение не задано, оно считается равным максимальному
 
* Истина - элемент скрывается на форме
* Ложь - элемент отображается и недоступен для редактирования значения.
* NULL - элемент отображается и недоступен для редактирования значения. ''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
|-
|-
| colspan="1" |Выполнять если
| colspan="1" |withDischarges
| colspan="1" |Не обязательно
| colspan="1" |булеан
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на доступность к данному компоненту.
| colspan="1" |нет
 
| colspan="1" |true
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
| colspan="1" |нет
 
| colspan="1" |нет
* Истина - элемент отображается и недоступен для редактирования
| colspan="1" |Разделить число на разряды
* Ложь - элемент отображается и недоступен для редактирования
* NULL - элемент отображается и недоступен для редактирования
 
''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
|}
 
== Изменить весь документ ==
Изменить весь документ - это действие, которое позволяет одной операцией изменить все поля документа включая вложенные таблицы.
 
=== Основные свойства ===
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
|-
|Апп-функция
| colspan="1" |incDecButtonsNeeded
| colspan="1" |Обязательно
| colspan="1" |булеан
|'''Описание:''' позволяет выбрать имя апп-функции, которая будет использоваться для изменения документа
| colspan="1" |нет
 
| colspan="1" |false
'''Допустимые значения''': статичная строка, для апп-функции с CALL_TYPE = 2
| colspan="1" |нет
|-
| colspan="1" |нет
|Выполняется
| colspan="1" |Управляет отображением кнопок увеличения\уменьшения значения на 1.
| colspan="1" |Обязательно
|'''Описание:''' атрибут позволяет указать, каким образом будет выполняться апп-функция(автоматически или по нажатию на кнопку)
 
'''Допустимые значения''':
 
* Автоматически - означает, что данная апп-функция будет выполняться всегда(если условия выполнения не запрещают)
* По желание пользователя - в этом случае, пользователю предоставляется возможность запустить выполнение данной апп-функции с помощью кнопки, отображаемой на форме документа
 
''По умолчанию всегда установлено значение "По желанию пользователя"''
|-
| colspan="1" |Описание
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут позволяет задать имя для визуального компонента. По умолчанию, если описание не задано, то элемент на форме будет отображаться без названия.
 
'''Допустимые значения:''' статичная строка
|-
| colspan="1" |Назначение
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для описания параметра в спецификации.
 
'''Допустимые значения:''' статичная строка
|}
|}


=== Свойства применимости ===
=== Текстовое поле ввода (numedit) ===
Компонент для ввода текстовых данных (edit).
[[Файл:Текстовое поле.png|без|обрамить]]
'''Свойства'''
{| class="wikitable"
{| class="wikitable"
!Свойство
|'''Название атрибута'''
! colspan="1" |Наличие значения
|'''Тип данных'''
!Назначение
|'''Обязательность'''
|'''Значение по умолчанию'''
| colspan="1" |'''Может содержать скрипт'''
| colspan="1" |'''Доступ из скрипта'''
|'''Описание'''
|-
|-
| colspan="1" |Скрывать если
| colspan="1" |password
| colspan="1" |Не обязательно
| colspan="1" |булеан
| colspan="1" |'''Описание:''' атрибут предназначен для визуального скрытия элемента на форме.
| colspan="1" |нет
 
| colspan="1" |false
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
| colspan="1" |нет
 
| colspan="1" |да
* Истина - элемент скрывается на форме
| colspan="1" |При истинном значении текст отображается в зашифрованном виде
* Ложь - элемент отображается и недоступен для редактирования значения.
* NULL - элемент отображается и недоступен для редактирования значения. ''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
|-
| colspan="1" |Выполнять если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на доступность к данному компоненту.
 
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
 
* Истина - элемент отображается и недоступен для редактирования
* Ложь - элемент отображается и недоступен для редактирования
* NULL - элемент отображается и недоступен для редактирования
 
''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
|}
 
== Проверка ==
Проверка - это не визуальное действие, которое позволяет проверить правильность заполнения полей документа и при необходимости выдать сообщение об ошибке.
 
=== Основные свойства ===
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
|-
|Параметр
| colspan="1" |maxlength
| colspan="1" |Обязательно
| colspan="1" |число
|'''Описание:''' Атрибут позволяет выбрать параметр, для которого будет осуществляться проверка
| colspan="1" |нет
| colspan="1" |0
| colspan="1" |нет
| colspan="1" |да
| colspan="1" |Наибольшая возможная длина текста. Если введено число символов больше, чем заданная максимальная длина, то текст обрезается до размера, указанного в maxlength.


'''Допустимые значения()''':
В случае отсутствия этого атрибута или его нулевого или отрицательного значения длина текста ничем не ограничена.
 
* число
* строка
* дата
* дата со временем
* логический
 
''Примечание: по умолчанию указано значение <Не выбран>''
|-
|-
|Тип сообщения
| colspan="1" |immediateChange
| colspan="1" |Обязательно
| colspan="1" |булеан
|'''Описание:''' Атрибут позволяет выбрать вид сообщения, который будет появляться в случае выполнения выражения
| colspan="1" |нет
 
| colspan="1" |false
'''Допустимые значения''':
| colspan="1" |нет
 
| colspan="1" |нет
* Ошибка - появляется сообщение красного цвета, в верху формы, если значение выражение Истина. Запрещает сохранение документа и переход в другие состояния, пока выражение Истинно
| colspan="1" |Требование XM-документу реагировать на каждое изменение соджержимого строки ввода и немедленно производить соответствующие расчеты.
* Предупреждение - появляется диалоговое окно(Ок/Отмена), если значение выражение Истина
* Информация - появляется сообщение зеленого цвета, в верху формы, если значение выражение Истина
 
''По умолчанию всегда установлено значение "Ошибка"''
|-
|-
| colspan="1" |Выражение
| colspan="1" |mask
| colspan="1" |строка
| colspan="1" |нет
| colspan="1" |
| colspan="1" |
| colspan="1" |'''Описание:''' Данный атрибут позволяет ввести выражение, при истинном значении которого, будет выдаваться сообщение
| colspan="1" |нет
 
| colspan="1" |нет
'''Допустимые значения''':  статичная строка
| colspan="1" |Маска ввода. Содержит шаблон, по которому будет форматировано значение поля.
|-
| colspan="1" |Сообщение
| colspan="1" |Обязательно
| colspan="1" |'''Описание:''' Данный атрибут позволяет задать сообщение, которое будет выдаваться в случае если выражение = Истина


'''Допустимые значения:''' статичная строка
Шаблоны бывают двух видов - маска и обычное регулярное выражение.
|-
| colspan="1" |Назначение
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для описания параметра в спецификации.


'''Допустимые значения:''' статичная строка
1) Шаблон типа "Маска":
|}


=== Свойства применимости ===
0 - любое число
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
| colspan="1" |Скрывать если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для визуального скрытия элемента на форме.


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
a (латинская) - любая буква


* Истина - элемент скрывается на форме
<nowiki>*</nowiki> - любой символ
* Ложь - элемент отображается и недоступен для редактирования значения.
* NULL - элемент отображается и недоступен для редактирования значения. ''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
|-
| colspan="1" |Выполнять если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на доступность к данному компоненту.


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
[] - все, что внутри, к вводу необязательно


* Истина - элемент отображается и недоступен для редактирования
{} -все, что внутри, останется в value у поля. Используется для тех символов, которые уже являются частью маски изначально - например, знаки пунктуации. Так, данные, введенные по маске 000-000 не будут в итоге содержать дефиса (он будет добавляться только в саму маску поля, без передачи в БД\хранилище при сохранении), а по 000{-}000 - будут.
* Ложь - элемент отображается и недоступен для редактирования
* NULL - элемент отображается и недоступен для редактирования


''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
Если какой-то из вышеперечисленных символов нужно вставить буквально, его надо экранировать обратным слешем - \ (то есть \0 позволит только ноль вставить).
|}


== Проверка данных поддокумента (CheckRows) ==
Данное действие позволяет проверить корректность заполнения всех строк указанного поддокумента и вывести сообщение об ошибке в родительском (относительно поддокумента) окне.


=== Основные свойства ===
Также существует возможность вставить в шаблон типа "Маска" регулярное выражение с квантификатором. Само регулярное выражение должно записываться в круглых скобках, например:
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
|Поддокумент
| colspan="1" |Обязательно
|'''Описание:''' Атрибут позволяет выбрать таблицу, для строк которой будут последовательно осуществляться вложенные в неё действия


'''Допустимые значения''':
([A-Z])


* таблица
Такая запись будет соответствовать одному символу. Если символов несколько, то добавляется квантификатор в круглых скобках, следующих за скобками с RegExp:
|-
|Сообщение
| colspan="1" |Обязательно
|'''Описание:''' Атрибут позволяет задать сообщение, которое будет отображаться в случае наличия ошибки в одной из строк проверяемой таблицы


'''Допустимые значения''':
([A-Z])(4) - нужно ввести строго 4 символа.


* Строка
([A-Z])(1,4) - минимум один, максимум 4.
* Формула


''Примечание: после указанного текста ошибки будет отображён текст ошибки, возникшей в проверяемой строке вложенной таблицы''
Квантификатор не может быть открытый, т.к. шаблон типа "Маска" подразумевает точное указание количества символов.
|-
| colspan="1" |Описание
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для описания параметра в спецификации.


'''Допустимые значения:''' статичная строка
Если необходимо сделать круглую скобку частью маски, то ее нужно экранировать обратным слешем - \. Пример:
|}


=== Свойства применимости ===
\(([A-Z])(1, 4)\) - ввод пользователя будет обрамлен круглыми скобками.
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
| colspan="1" |Скрывать если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для визуального скрытия элемента на форме.


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
2) Шаблон типа "Регулярное выражение":


* Истина - элемент скрывается на форме
RegExp нужно вводить в поле как обычное регулярное выражение, но оно должно быть таким, чтобы поддерживался промежуточный ввод. Например:
* Ложь - элемент отображается и недоступен для редактирования значения.
* NULL - элемент отображается и недоступен для редактирования значения. ''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
|-
| colspan="1" |Выполнять если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на доступность к данному компоненту.


'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
^\d{1,2}\/\d{1,2}\/\d{4}$ - не поддерживается, т.к. предполагает одновременное наличие минимум 6 символов.


* Истина - элемент отображается и недоступен для редактирования
^\d{0,2}\/?\d{0,2}\/?\d{0,4}$ - поддерживается, т.к. допускает промежуточный ввод.
* Ложь - элемент отображается и недоступен для редактирования
* NULL - элемент отображается и недоступен для редактирования


''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
^\d{1,2}\/?\d{0,2}\/?\d{0,4}$ - тоже поддерживается, т.к. первым символом будет введено число - и строка будет соответствовать RegExp.
|}


== Присвоение ==
Для правильной интерпретации следует добавлять в начало выражения - ^, а в конец - $.
Присвоение - действие, которое позволяет одной операцией изменить все поля документа.


=== Основные свойства ===
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
| colspan="1" |Параметр
| colspan="1" |Обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для выбора параметра, для которого будет срабатывать присвоение


'''Допустимые значения:''' любой параметр из перечисленных типов(строка, число, дата, дата со временем, логический)
В целом, шаблон типа "Маска" следует использовать для более строгих форматов, а RegExp - для более открытых (только цифры, буквы и т.п.)
|-
| colspan="1" |Выражение
| colspan="1" |Обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для задания вычислимого выражение к выбранному параметру


'''Допустимые значения:''' результат выражения должен соответствовать типу параметра
|-
|-
| colspan="1" |Выполняется
| colspan="1" |maskType
| colspan="1" |Обязательно
| colspan="1" |строка
| colspan="1" |'''Описание:''' атрибут позволяет указать каким образом будет выполняться присвоение значения (автоматически или по нажатию на кнопку)
| colspan="1" |нет
 
| colspan="1" |pattern
* Автоматически - означает, что данная апп-функция будет выполняться всегда(если условия выполнения не запрещают)
| colspan="1" |нет
* По желание пользователя - в этом случае, пользователю предоставляется возможность запустить выполнение данной апп-функции с помощью кнопки, отображаемой на форме документа
| colspan="1" |нет
 
| colspan="1" |Тип маски ввода. Содержит строку, по которой определяется тип маски - шаблон библиотеки IMask или RegExp.
''По умолчанию всегда установлено значение "Автоматически"''
|-
| colspan="1" |Описание
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут позволяет задать имя для визуального компонента. По умолчанию, если описание не задано, то элемент на форме будет отображаться без названия.
 
'''Допустимые значения:''' статичная строка
|}
 
=== Свойства применимости ===
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
| colspan="1" |Скрывать если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для визуального скрытия элемента на форме.
 
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
 
* Истина - элемент скрывается на форме
* Ложь - элемент отображается и недоступен для редактирования значения.
* NULL - элемент отображается и недоступен для редактирования значения. ''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
|-
| colspan="1" |Выполнять если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на доступность к данному компоненту.
 
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
 
* Истина - элемент отображается и недоступен для редактирования
* Ложь - элемент отображается и недоступен для редактирования
* NULL - элемент отображается и недоступен для редактирования
 
''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
|}
|}
== Открытие фильтра на редактирование (editFilter) ==
Открытие фильтра на редактирование - действие, которое позволяет получить фильтр документа, открыть окно редактирования и по нажатию кнопки "Сохранить" передать фильтр документа и его описание в параметры.
=== Основные свойства ===
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
| colspan="1" |Параметр (param)
| colspan="1" |Необязательно
| colspan="1" |'''Описание:''' атрибут предназначен для выбора параметра, для которого будет срабатывать присвоение выходного значения фильтра.
'''Допустимые значения:''' параметр типа строка.
|-
| colspan="1" |Параметр описания ограничений фильтра (paramDescr)
| colspan="1" |Необязательно
| colspan="1" |'''Описание:''' атрибут предназначен для выбора параметра, для которого будет срабатывать присвоение выходного значения описания фильтра.
'''Допустимые значения:''' параметр типа строка.
|-
| colspan="1" |Наименование фильтра (caption)
| colspan="1" |Необязательно
| colspan="1" |'''Описание:''' атрибут позволяет задать заголовок (наименование) окна редактора фильтра.
'''Допустимые значения''': формула, результат - строка или STRING_NULL.
|-
| colspan="1" |Тип юниверса (universeType)
| colspan="1" |Обязательно
| colspan="1" |'''Описание:''' Атрибут предназначен для выбора типа.
'''Допустимые значения:'''
* ETRAN - BO юниверс
* DOCUNV - XM юниверс
''По умолчанию задано значение DOCUNV''
|-
| colspan="1" |ИД юниверса (universeId)
| colspan="1" |Обязательно
| colspan="1" |'''Описание:''' Атрибут позволяет ввести ИД юниверса (для типа ETRAN )
'''Допустимые значения:''' статичное число
|-
| colspan="1" |Ключевое слово (bo_unitype)
| colspan="1" |Обязательно
| colspan="1" |'''Описание:''' атрибут позволяет задать ключевое слово дополнительно к ИД юниверса
'''Допустимые значения''': формула, результат - строка или STRING_NULL.
|-
| colspan="1" |Тип документа (docTypeId)
| colspan="1" |Обязательно
| colspan="1" |'''Описание:''' Атрибут позволяет выбрать тип документа (для типа DOCUNV)
'''Допустимые значения:''' статичное число
|-
| colspan="1" |Описание (description)
| colspan="1" |Обязательно
| colspan="1" |'''Описание:''' атрибут позволяет задать имя для визуального компонента. По умолчанию, если описание не задано, то элемент на форме будет отображаться без названия.
'''Допустимые значения:''' статичная строка
|-
| colspan="1" |Режим редактирования фильтра (editmode)
| colspan="1" |Необязательно
| colspan="1" |'''Описание:''' Задает режим редактирования фильтра (что можем менять)
'''Допустимые значения:'''
* full - Полное (поля, группировка и ограничения)
* where - Только ограничения
''По умолчанию задано значение where''
|-
| colspan="1" |Список полей (selstr)
| colspan="1" |Необязательно
| colspan="1" |'''Описание:''' атрибут предназначен для выбора параметра, для которого будет срабатывать для получения входного и присвоение выходного значения полей фильтра (для типа ETRAN ).
'''Допустимые значения:''' параметр типа строка.
|-
| colspan="1" |Список полей группировки (groupstr)
| colspan="1" |Необязательно
| colspan="1" |'''Описание:''' атрибут предназначен для выбора параметра, для которого будет срабатывать для получения входного и присвоение выходного значения полей группировки фильтра (для типа ETRAN ).
'''Допустимые значения:''' параметр типа строка.
|}
=== Свойства применимости ===
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
| colspan="1" |Скрывать если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для визуального скрытия элемента на форме.
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
* Истина - элемент скрывается на форме
* Ложь - элемент отображается и недоступен для редактирования значения.
* NULL - элемент отображается и недоступен для редактирования значения. ''Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.''
|-
| colspan="1" |Выполнять если
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для задания условия, значение которого влияет на доступность к данному компоненту.
'''Допустимые значения''': формула, результат - логический тип. Если значение равно:
* Истина - элемент отображается и недоступен для редактирования
* Ложь - элемент отображается и недоступен для редактирования
* NULL - элемент отображается и недоступен для редактирования
''Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.''
|}
== Внешнее действие ==
Внешнее действие - это действие позволяющее открыть другой документ/режим/печатную форму.
=== Основные свойства ===
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
|Тип
| colspan="1" |Обязательно
|'''Описание:''' атрибут предназначен для выбора одного из 4х возможных внешних действии.
'''Допустимые значения''':
* Печатная форма
* Создать документ
* Открыть документ
* Открыть режим
''По умолчанию тип не выбран''
|-
| colspan="1" |Описание
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут позволяет задать имя для визуального компонента. По умолчанию, если описание не задано, то элемент на форме будет отображаться без названия.
'''Допустимые значения:''' статичная строка
|-
| colspan="1" |Назначение
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' атрибут предназначен для описания параметра в спецификации.
'''Допустимые значения:''' статичная строка
|}
=== Основные свойства для Печатной формы ===
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
| colspan="1" |Формат данных
| colspan="1" |Обязательно
| colspan="1" |'''Описание:''' Атрибут предназначен для выбора формата данных.
'''Допустимые значения:'''
* XLS - позволяет сохранять печатную форму в формате XLS
* PDF - позволяет сохранять печатную форму в формате PDF
''По умолчанию задано значение XLS''
|-
| colspan="1" |Идентификатор отчета
| colspan="1" |Обязательно
| colspan="1" |'''Описание:''' Атрибут позволяет ввести идентификатор шаблона, который будет открываться(сохраняться) при нажатии на кнопку
'''Допустимые значения:''' статичная строка
|}
=== Свойства для Создания документа ===
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
| colspan="1" |Тип документа
| colspan="1" |Обязательно
| colspan="1" |'''Описание:''' Атрибут позволяет выбрать тип документа
'''Допустимые значения:''' статичная строка
|-
| colspan="1" |Апп-функция получения экземпляра документа
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' Атрибут позволяет выбрать апп-функция, в которой будет передаваться экземпляр для документа данного типа
'''Допустимые значения:''' статичная строка
|-
| colspan="1" |Дополнительно/Скрыть
| colspan="1" |Не обязательно
| colspan="1" |'''Описание:''' Атрибут позволяет указать название режима
'''Допустимые значения:''' статичная строка
|}
=== Свойства для Открытия документа ===
{| class="wikitable"
!Свойство
! colspan="1" |Наличие значения
!Назначение
|-
|Идентификатор документа
| colspan="1" |Обязательно
|'''Описание:''' атрибут предназначен для указания выражения, которое будет содержать идентификатор открываемого документа
'''Допустимые значения''': статичная строка
''По умолчанию тип не выбран''
|-
| colspan="1" |Название режима
| colspan="1" |Не обязательно
| colspan="1" |Атрибут позволяет указать название режима
|}
=== Свойства для Открытия режима ===
{| class="wikitable"
{| class="wikitable"
!Свойство
!Свойство

Версия 13:45, 15 июля 2022

Визуальные компоненты

Контейнер объектов (container)

Предназначен для задания единого способа отображения визуальных компонентов и позволяющий инкапсулировать в себе объекты других типов.

Контейнер объектов.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
direction перечислимый нет vertical нет да Определяет способ расположения дочерний элементов
  • vertical - элементы располагаются по вертикали
  • horizontal - элементы располагаются по горизонтали
cssstylecontent строка нет нет да CSS Стиль блока с содержимым для контейнера
ratio число нет 1 нет нет Определяет пропорции ширины или высоты для контейнера
readonly строка нет 0|false да да Значение данного свойства обратно значению свойства enabled. Присвоение значения свойству readonly не имеет действия. Возможные значения "1"|"true" или "0"|"false" (независимы от регистра).

Примечание: если при обращении к этому атрибуту его значение в строковом виде равно "1" или "true", то оно принимается за true, в случае любых других значений включая пустую строку или NULL оно принимается за false.

Вкладки (tabsheet)

Вкладка — это визуальный элемент, который позволяет создавать множество вкладок, для размещения на них визуальных элементов.

Вкладка.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
activeTabCaption строка только для чтения нет да Название активной вкладки. Если ни одна из вкладок не активна, то значение атрибута равно пустой строке.
activeTabPosition число только для чтения нет да Позиция активной вкладки. Нумерация вкладок начинается с единицы. Если ни одна из вкладок не активна, то значение атрибута равно нулю.
activeTab строка да да Название активной вкладки. Если название задано, при загрузке режима вкладка с этим названием становится активной
direction строка horizontal нет да Направление отображения вкладок (vertical - вкладки слева, контент - справа | horizontal - вкладки сверху, контент снизу)
cssstylecaption строка нет да Имя CSS стиля вкладки
cssstyleactive строка нет да Имя CSS стиля активной вкладки
enableCollapse булеан false нет да Возможность сворачивания (только для вкладок с направлением отображения "vertical")
collapsed число 0 нет да Положение по умолчанию (свернуты - 1, развернуты - 0)

Панель кнопок (toolbar)

Панель кнопок - визуальный элемент, который позволяет разместить в себе группу кнопок.

Панель кнопок.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
readonly строка 0|false да да Значение данного свойства обратно значению свойства enabled. Присвоение значения свойству readonly не имеет действия. Возможные значения "1"|"true" или "0"|"false" (независимы от регистра).

Кнопка (button)

Позволяет добавить на панель кнопку, которую в последствие можно привязать к какомулибо действию, созданному в правилах заполнения (к примеру Апп-функция).

Кнопка.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступен из скрипта Описание
onclick действие нет нет да Название действия (action/actiongroup), выполняемое при нажатии на кнопку
iconname строка нет да да Наименование иконки из репозитория для отображения на кнопке
hint строка нет да да Текст всплывающей подсказки при наведении на кнопку

Текст/подпись (label)

Текст-Подпись .png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступен из скрипта Описание
onclick действие нет нет нет Название действия (action/actiongroup), выполняемое при клике на тексте

Таблица (grid)

Компонент для отображения табличных данных.

Таблица.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
groupby строка нет да нет Перечисление колонок курсора для их группировки через запятую (Только для Delphi)
groupbox булеан нет true нет нет При истинном значении отображается поле для ручной группировки данных пользователем (Только для Delphi)
selectedRow строка курсора только чтение нет да Позволяет получить данные из выделенной в гриде строке, дополнительно указав название колонки в курсоре. Например выражение:
${window.grid.selectedRow.rw_name}

возвращает из выделенной строки грида grid значение ячейки в колонке с именем rw_name

selectedRows строка курсора только чтение нет да Позволяет получить данные из выделенных в гриде строк, дополнительно указав название колонки в курсоре. Например выражение:
${window.grid.selectedRows.rw_name}

возвращает через запятую из выделенных строк грида значение ячеек в колонке с именем rw_name. В случае, когда выделена только одна строка в гриде, атрибут работает как selectedRow

selectedCell любой тип только чтение нет да Позволяет получить данные из выделенной ячейки грида. Например выражение:
${window.grid.selectedCell}

возвращает значение выделенной ячейки грида

selectedSourceField строка только чтение нет да Название колонки в курсоре данных, соответствующей выделенной колонки грида
${window.grid.selectedSourceField}
selectedGroup строка только чтение нет да Информация о группировке. Формат:
<group>

   

   <col_name>group_value</col_name>

</group>

Например, если данные в гриде сгруппированы по колонка A и B. Осуществляется попытка провалиться в итоги, где A="Значение A", B="Значение B", то результирующая строка будет

<group>

   <A>Значение A</A>

   <B>Значение B</B>

</group>

Не поддерживается в XM

selectioncolumn строка только чтение нет нет Имя колонки (поля), в котором пользователь сможет осуществлять выделение галочкой.

!!! поле с таким именем должно присутствовать в датасете, а колонка с этим полем - в списке колонок грида!!!

livecomplexheaders булеан нет false нет нет Признак того, что в случае сложных заголовков сохраняется возможность сортировать и фильтровать по столбцам грида.

Если этот атрибут равен "true", то значение атрибута numerate игнорируется и считается равным "false".

columnfiltereditemslist булеан нет false нет нет При фильтрации в фильтрах колонок грида присутствуют только значения видимые в результате применения фильтров по другим колонкам(иначе фильтры колонок содержат все значения).
groupHeaderLineCount число нет 1 нет нет Количество строк в заголовке группы.
cansort булеан нет true нет нет Дать возможность пользователю сортировать данные.
expandGroups булеан нет false нет нет Развернуть группировки.
checkedRows строка курсора только чтение нет да Позволяет получить данные из строк в гриде, отмеченными галочками, дополнительно указав колонку название колонки в курсоре. Значения будут перечислены через запятую.

Например выражение:

${window.grid.checkedRows.rw_id}

для отмеченных строк грида rw_id = 10 и rw_id=20 вернет "10,20"

Отмеченной строкой грида является та строка, у которой значение колонки из selectioncolumn равно истине

rowstyle строка нет нет да "Стиль строки" - Название колонки, содержащей информацию о раскраске строки таблицы. Формат раскраски описан в статье (Выделение цветом строк в окне фильтра) - TTTTTT$BBBBBB$SSSS
selectedRowStyle строка нет нет да "Стиль выделенной строки" - Название колонки, содержащей информацию о раскраске выделенной строки таблицы. Формат раскраски описан в статье (Выделение цветом строк в окне фильтра) - TTTTTT$BBBBBB$SSSS
minRows число нет нет нет Минимальное число строк на странице
maxRows число нет нет нет Максимальное число строк на странице
selectedColumnName строка только чтение нет да Название активной колонки (которое отображается в шапке грида)
selectedColumnNameWithBands строка только чтение нет да Для сложных шапок - последовательность названий колонок, в которые входит активная, начиная сверху, через запятую.

Пример: Верхний бенд, средний бенд, название колонки.

selectedColumnBand(xx) строка только чтение нет да Возвращает функцию для расчета сложных шапок - названий бендов. Для получения последовательности бендов заданного уровня, необходима запись типа ${eval(windowName.gridName.selectedColumnBand,xx)}, где windowName - имя формы, gridName - имя грида, xx - номер уровня (считается от колонки вверх).
exportCaption строка нет да нет Текст в шапке листа Excel при экспорте.

Обработчики событий

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
ondrilldown действие (action/actiongroup) нет да нет Название действия, выполняемое при двойном щелчке на строк. Если столбцу грида, в ячейке которого был выполнен двойной щелчток мышью также содержит атрибут ondrilldown, то выполняется действие, назначенное столбцу.
onrowselect действие (action/actiongroup) нет да нет Название действия, выполняемое при смене активной строки грида.

Действие также выполняется при инициализации грида, так как в этот момент его первая строка становится активной.

onrowclick действие (action/actiongroup) нет да нет Название действия, выполняемое при нажатии на строку грида.

Группа колонок грида (colgroup)

Объединяет несколько пордяд идущих колонок в одну визуальную группу

Группа колонок.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
caption строка да да нет Название группы колонок

Колонка (column)

Описывает визуальное представление колонки грида и связывает колонку с курсором данных.

Колонка.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
caption строка да да нет Название колонки
sourcefield строка да нет нет Название отображаемой колонки курсора
displayformat перечислимый нет нет Формат отображения данных:
  • currency - отображение денег
  • number - отображение произвольного числа
  • date - дата
  • datetime -дата со временем
  • check - булеан в виде checkbox
  • string - строка (в разработке)
  • icon - иконка по идентификатору
  • checkicon - кликабельная иконка - при клике на нее значение поля меняется на +1 и иконка меняется на следующую из списка icons (если список исчерпан, то с начала списка и значение поля равно 0)
summary строка нет нет Формула для расчета итогов и подытогов колонки. Формулы 1-го рода - агрегирующие функции:
  • sum() - просуммировать значения текущей колонки. Применяется для типов данных: число (деньги)
  • min() - минимальное значение текущей колонки. Применяется для типов данных: число (деньги), дата
  • max() - максимальное значение текущей колонки. Применяется для типов данных: число (деньги), дата
  • avg() - среднее значение значений текущей колонки. Применяется для типов данных: число (деньги)
  • count() - количество строк в текущей колонке. Применяется для всех типов данных
  • countdistinct() - количество строк с уникальными значениями в текущей колонке. Применяется для всех типов данных
  • countnotempty() - количество строк с не пустыми значениями в текущей колонке. Применяется для всех типов данных

Формулы 2-го рода - агрегирующие функции по произвольным колонкам курсора:

  • sum(название колонки курсора) - просуммировать значения заданной колонки (суммирует значения только из заданных в гриде колонок)
  • min(название колонки курсора) - минимальное значение заданной колонки
  • max(название колонки курсора) - максимальное значение заданной колонки
  • avg(название колонки курсора) - среднее значение значений заданной колонки
  • count(название колонки курсора) - количество строк в заданной колонке
  • countdistinct(название колонки курсора) - количество строк с уникальными значениями в заданной колонке
  • countnotempty() - количество строк с не пустыми значениями в текущей колонке. Применяется для всех типов данных
  • group(название колонки курсора) - используется для условия подсчёта подытогов. Подытог рассчитывается только для данных, группируемых по колонке, указанной в group.

Формулы 3-го рода - формулы первого и второго рода и операторы для $-выражений. Например:

sum(название колонки курсора) + min() - сумма значений заданной колонки плюс минимальное значение в текущей колонке.

XM-формула

Есть возможность так же использовать xm-формулы, они обязательно должны быть обернуть в $ выражение - ${Текст формулы}

summaryformat строка нет нет Формат отображения данных итогов и подытогов колонки:
  • currency - отображение денег
  • number - отображение произвольного числа

Примечание: если в summary колонки находится формула 2-го или 3-го рода (см. summary), то необходимо определить формат итога

для значения формулы с помощью summaryformat.

headerstyle стиль да нет Стиль шапки колонки. Фактически используется только для задания ширины колонки.
contentstyle стиль да нет Стиль данных по колонке. Никак не влияет на внешний вид колонки. Добавлен на случай будущего расширения стилей дополнительными атрибутами.
descriptionfunc строка нет нет Наименование апп-функции, для получения описания картинки
visible строка нет 1|true да нет Видимость столбца. Возможные значения "1"|"true" или "0"|"false" (независимы от регистра).

Примечание: если при обращении к этому атрибуту его значение в строковом виде равно "1" или "true", то оно принимается за true, в случае любых других значений включая пустую строку или NULL оно принимается за false.

widthinchars число нет нет нет Начальная ширина колонки в размере равном указанному количеству латинских символов "a"
icons строка нет нет нет Список идентификаторов системных иконок которые последовательно будут отображаться в поле типа checkicon при изменении значения поля. (Первая иконка списка отображается при значении поля 0, вторая 1 итд)
cellstyle строка нет нет нет нет Название колонки, содержащей информацию о раскраске ячейки в колонке таблицы.

Значением в поле колонки стиля должна быть строка, содержащая json с настройками стилизации ячейки в строке.

Поддерживаются следующие параметры стилизации:

bgcolor - цвет заливки ячейки

textcolor - цвет текста ячейки

textalign - кастомное выравнивание содержимого ячейки по горизонтали (  left, center, right )

fractionDigits - количество знаков после запятой для ячеек с типом "number" - (параметр числовой - то есть "fractionDigits": 2 , а не "2")

bold (true/false) - жирный шрифт

italic (true/false) - курсив

underline (true/false) - подчеркивание

strikethrough (true/false) - перечеркивание

Например '{"bgcolor": "#00ff00", "textcolor": "#ffff00", "underline": true, "strikethrough": false}'

Важно, чтобы значением свойств bold, italic, underline и strikethrough было именно булево значение true или false, а не строки "true" или "false"

headerLineBreak булеан false нет нет Признак переноса строки в заголовке колонки.
headerTextAlign строка left нет нет Выравнивание текста в заголовке колонки:
  • left - по левому краю;
  • center - по центру;
  • right - по правому краю;
  • justify - по ширине.
withDischarges булеан нет false нет нет Разделение на разряды. Учитывается для колонок с форматом отображения число или деньги.

Обработчики событий

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
ondrilldown действие (action/actiongroup) да нет Название действия при проваливании в ячейку. Информацию о ячейке можно получить из атрибутов selectedCell, selectedSourceField, selectedRow
ondrillsummary действие (action/actiongroup) да нет Название действия при проваливании в строку итогов. Информацию о группировки можно получить из атрибута selectedGroup
onchangevalue действие (action/actiongroup) да нет Для displayformat "check" и "checkicon" - определяет действие которое будет вызываться при смене значения в ячейке (клике на чекбокс/иконку).

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

Форматирование данных

Тип данных/displayformat Выравнивание Способ форматирования
Число/number справа
  • В целой части используются разделители тысячных в виде пробелов
  • Дробная часть отображается только при ее наличии, т.е. она не равна 0
  • Дробная часть может иметь длину не более 6 знаков
  • Если дробная часть имеет больше 6 знаков, она округляется по правилам математики
  • Дробная часть не должная содержать в качестве последних символов нули
Дата/date по центру Формат отображения: dd.mm.yyyy hh24:mi:ss.

Время отображается только, если оно не равно 00:00:00

/datetime по центру Формат отображения: dd.mm.yyyy hh24:mi:ss
/currency справа
  • В целой части используются разделители тысячных в виде пробелов
  • Дробная часть всегда отображается и имеет два знача после запятой. Например, для целый чисел дробная часть равна "00"
Строка/string (в разработке) слева Данные, отличные от строки, форматируются в строку согласно правилам "Способ форматирования" для каждого типа данных. Исключение для чисел, при форматировании в строку для них не используются разделители тысячных

Числовое поле (edit)

Компонент для ввода числовых данных (numedit).

Числовое поле.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
displayformat перечислимый нет number нет нет Формат отображения данных:
  • currency - отображение денег
  • number - отображение произвольного числа
totalDigits число нет нет нет Допустимая длина числа

Мин. - 1 (oracle), макс. - 38 (oracle)

Если значение не задано, оно считается равным максимальному

fractionDigits число нет нет нет Допустимая длина дробной части

Мин. - 1 (oracle), макс. - 10 (oracle)

Если значение не задано, оно считается равным максимальному

withDischarges булеан нет true нет нет Разделить число на разряды
incDecButtonsNeeded булеан нет false нет нет Управляет отображением кнопок увеличения\уменьшения значения на 1.

Текстовое поле ввода (numedit)

Компонент для ввода текстовых данных (edit).

Текстовое поле.png

Свойства

Название атрибута Тип данных Обязательность Значение по умолчанию Может содержать скрипт Доступ из скрипта Описание
password булеан нет false нет да При истинном значении текст отображается в зашифрованном виде
maxlength число нет 0 нет да Наибольшая возможная длина текста. Если введено число символов больше, чем заданная максимальная длина, то текст обрезается до размера, указанного в maxlength.

В случае отсутствия этого атрибута или его нулевого или отрицательного значения длина текста ничем не ограничена.

immediateChange булеан нет false нет нет Требование XM-документу реагировать на каждое изменение соджержимого строки ввода и немедленно производить соответствующие расчеты.
mask строка нет нет нет Маска ввода. Содержит шаблон, по которому будет форматировано значение поля.

Шаблоны бывают двух видов - маска и обычное регулярное выражение.

1) Шаблон типа "Маска":

0 - любое число

a (латинская) - любая буква

* - любой символ

[] - все, что внутри, к вводу необязательно

{} -все, что внутри, останется в value у поля. Используется для тех символов, которые уже являются частью маски изначально - например, знаки пунктуации. Так, данные, введенные по маске 000-000 не будут в итоге содержать дефиса (он будет добавляться только в саму маску поля, без передачи в БД\хранилище при сохранении), а по 000{-}000 - будут.

Если какой-то из вышеперечисленных символов нужно вставить буквально, его надо экранировать обратным слешем - \ (то есть \0 позволит только ноль вставить).


Также существует возможность вставить в шаблон типа "Маска" регулярное выражение с квантификатором. Само регулярное выражение должно записываться в круглых скобках, например:

([A-Z])

Такая запись будет соответствовать одному символу. Если символов несколько, то добавляется квантификатор в круглых скобках, следующих за скобками с RegExp:

([A-Z])(4) - нужно ввести строго 4 символа.

([A-Z])(1,4) - минимум один, максимум 4.

Квантификатор не может быть открытый, т.к. шаблон типа "Маска" подразумевает точное указание количества символов.

Если необходимо сделать круглую скобку частью маски, то ее нужно экранировать обратным слешем - \. Пример:

\(([A-Z])(1, 4)\) - ввод пользователя будет обрамлен круглыми скобками.

2) Шаблон типа "Регулярное выражение":

RegExp нужно вводить в поле как обычное регулярное выражение, но оно должно быть таким, чтобы поддерживался промежуточный ввод. Например:

^\d{1,2}\/\d{1,2}\/\d{4}$ - не поддерживается, т.к. предполагает одновременное наличие минимум 6 символов.

^\d{0,2}\/?\d{0,2}\/?\d{0,4}$ - поддерживается, т.к. допускает промежуточный ввод.

^\d{1,2}\/?\d{0,2}\/?\d{0,4}$ - тоже поддерживается, т.к. первым символом будет введено число - и строка будет соответствовать RegExp.

Для правильной интерпретации следует добавлять в начало выражения - ^, а в конец - $.


В целом, шаблон типа "Маска" следует использовать для более строгих форматов, а RegExp - для более открытых (только цифры, буквы и т.п.)

maskType строка нет pattern нет нет Тип маски ввода. Содержит строку, по которой определяется тип маски - шаблон библиотеки IMask или RegExp.
Свойство Наличие значения Назначение
Идентификатор Обязательно Описание: атрибут предназначен для указания выражения, которое будет содержать идентификатор режима

Допустимые значения: статичная строка(Значение может задаваться явно, т.е. в числовом виде, либо через переменную документа. например XM_DOCUMENT.num, где XM_DOCUMENT - название документа, num - имя переменной )

По умолчанию тип не выбран

Название режима Не обязательно Атрибут позволяет выбрать название из существующих режимов

Свойства применимости

Свойство Наличие значения Назначение
Скрывать если Не обязательно Описание: атрибут предназначен для визуального скрытия элемента на форме.

Допустимые значения: формула, результат - логический тип. Если значение равно:

  • Истина - элемент скрывается на форме
  • Ложь - элемент отображается и недоступен для редактирования значения.
  • NULL - элемент отображается и недоступен для редактирования значения. Примечание: если выражение не задано, то условие по умолчанию принимает значение Ложь.
Выполнять если Не обязательно Описание: атрибут предназначен для задания условия, значение которого влияет на доступность к данному компоненту.

Допустимые значения: формула, результат - логический тип. Если значение равно:

  • Истина - элемент отображается и недоступен для редактирования
  • Ложь - элемент отображается и недоступен для редактирования
  • NULL - элемент отображается и недоступен для редактирования

Примечание: если выражение не задано, то условие по умолчанию принимает значение Истина.

Источник — http://xmdocs.intellex.ru/index.php?title=Визуальные_компоненты&oldid=2414