Перейти к основному содержимому

Форма

Стд::Интерфейс::Формы::Форма<ТипРезультата> Доступность: Клиент

ТипРезультата: Тип возвращаемого значения при открытии формы в модальном или всплывающем окне. По умолчанию Неопределено. Если пользователь закрыл форму крестиком, кликом мимо при открытии во всплывающем окне или был вызван метод Закрыть без передачи аргумента - в качестве результата открытия возвращается Неопределено.

Базовый компонент для форм приложения.

Форма - это компонент, для которого определены операции открытия и закрытия. Форма образует связь с оконной системой приложения. Для примера, если пользователь нажмет клавишу Esc, когда фокус в компоненте внутри формы, то форма закроется. В качестве содержимого форме задается компонент шаблона формы, который определяет содержимое формы и управляет его трансформацией в различные форм-факторы.

Порождает тип одиночку команды открытия формы - <ИмяФормы>.ОткрытьФорму/<ИмяФормы>.OpenForm, наследника НавигационнаяКоманда.

Сравнение ссылочное

Иерархия типа

Базовые типы: Объект, Стд::Интерфейс::Компонент

Дочерние типы: ФормаЗаписи, ФормаОбъекта, ФормаОтчета, ФормаСписка


Конструкторы

Форма

Доступность: Клиент

@ИменованныеПараметры
Форма(
Видимость: Авто|Булево,
Доступность: Авто|Булево,
ТолькоЧтение: Авто|Булево,
ВыравниваниеВГруппеПоВертикали: Авто|ВыравниваниеПоВертикали,
ВыравниваниеВГруппеПоГоризонтали: Авто|ВыравниваниеПоГоризонтали,
ВесПриРастягивании: Авто|Число,
Высота: Авто|Число,
Ширина: Авто|Число,
ШиринаВКолонках: Авто|ШиринаВКолонках,
МаксимальнаяВысота: Авто|Число,
МаксимальнаяШирина: Авто|Число,
МинимальнаяВысота: Авто|Число,
МинимальнаяШирина: Авто|Число,
РастягиватьПоВертикали: Авто|Булево,
РастягиватьПоГоризонтали: Авто|Булево,
ПриПеретаскивании: (Компонент, СобытиеПриПеретаскивании)->ничто,
ПриНаведении: (Компонент, СобытиеКомпонента)->ничто,
ПриПотереНаведения: (Компонент, СобытиеКомпонента)->ничто,
Заголовок: Авто|Строка,
СпособОткрытия: Авто|СпособОткрытияФормы,
ОтступПоВертикали: Авто|РазмерОтступа,
ОтступПоГоризонтали: Авто|РазмерОтступа,
Содержимое: ШаблонФормы?,
Закрыть: Команда,
Обновить: Команда,
ОсновнаяКоманда: Команда?,
КомандыСоздания: Команда|ГруппаКомандногоИнтерфейса|?,
ОбычныеКоманды: ФрагментКомандногоИнтерфейса?,
ДополнительныеКоманды: ФрагментКомандногоИнтерфейса?,
ПодсказкиПриПервомОткрытии: ПоследовательностьОбучающихПодсказок?,
ПовторноеИспользованиеФормы: Авто|Булево)
Создает компонент со значениями свойств, соответствующими параметрам конструктора.


Свойства

ДополнительныеКоманды

Доступность: Клиент

ДополнительныеКоманды: ФрагментКомандногоИнтерфейса?

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


Заголовок

Доступность: Клиент

Заголовок: Авто|Строка

Заголовок формы.


Закрыть

Доступность: Клиент ТолькоЧтение

Закрыть: Команда

Команда закрытия формы.


КомандыСоздания

Доступность: Клиент

Задает команду или группу команд, располагаемых в виде кнопки или меню создания. Место и вид отображения кнопки создания различается в зависимости от среды исполнения:

  • на мобильных устройствах это плавающая кнопка, которая отображается в правом нижнем углу экрана,
  • на остальных устройствах кнопка отображается после заголовка формы.

Обновить

Доступность: Клиент ТолькоЧтение

Обновить: Команда

Команда принудительного обновления данных в форме.


ОбычныеКоманды

Доступность: Клиент

Список основных команд формы. Отображаются в нижней панели команд формы после главной команды.


ОсновнаяКоманда

Доступность: Клиент

ОсновнаяКоманда: Команда?

Задает команду, которая определяет главное действие формы. Рекомендуется использовать для команды, после вызова которой форма будет закрыта. Например:

  • Сохранить и закрыть
  • Отправить (письмо)
  • Закрыть Отображается в нижней панели команд формы.

ОтступПоВертикали

Доступность: Клиент

ОтступПоВертикали: Авто|РазмерОтступа

Отступ от границ формы до границ содержимого по вертикали.


ОтступПоГоризонтали

Доступность: Клиент

ОтступПоГоризонтали: Авто|РазмерОтступа

Отступ от границ формы до границ содержимого по горизонтали.


ПовторноеИспользованиеФормы

Доступность: Клиент

ПовторноеИспользованиеФормы: Авто|Булево

Признак повторного использования формы. Если Истина, то форма, открытая в основной области, при закрытии не удаляется, а при повторном открытии активизируется тот же самый экземпляр. Авто - определяется системой автоматически. Например, для форм списков будет Истина.


ПодсказкиПриПервомОткрытии

Доступность: Клиент

ПодсказкиПриПервомОткрытии: ПоследовательностьОбучающихПодсказок?

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


Содержимое

Доступность: Клиент

Содержимое: ШаблонФормы?

Шаблон формы, который определяет содержимое формы и управляет его трансформацией в различные форм-факторы.


СпособОткрытия

Доступность: Клиент

СпособОткрытия: Авто|СпособОткрытияФормы

Способ открытия формы при вызове метода Открыть При Авто открывает формы сущностей в диалоговых окнах, а остальные - в рабочей области.


Методы

Закрыть

Доступность: Клиент

Закрыть(ПараметрЗакрытия: ТипРезультата? = Неопределено): Булево
Закрывает форму. Переданный параметр служит возвращаемым из метода открытия значением, если он был вызван с параметром ОжидатьЗакрытия = Истина.


ЗапуститьОбучающиеПодсказки

Доступность: Клиент

ЗапуститьОбучающиеПодсказки(Последовательность: ПоследовательностьОбучающихПодсказок)
Запускает последовательность обучающих подсказок в текущей форме. При таком запуске, механизм не будет сам запоминать факт просмотренности подсказок пользователем: последовательность будет запускаться всегда. Параметры:

  • Последовательность - последовательность подсказок, которую нужно запустить.

ОстановитьОбучающиеПодсказки

Доступность: Клиент

ОстановитьОбучающиеПодсказки(Последовательность: ПоследовательностьОбучающихПодсказок? = Неопределено)
Останавливает указанную последовательность обучающих подсказок в текущей форме. Параметры:

  • Последовательность - последовательность подсказок, которую нужно остановить. Если равно Неопределено, то останавливает текущую активную последовательность.

Открыть

Доступность: Клиент

Открыть(): ТипРезультата?
Открывает экземпляр формы. Открывает форму по-разному и возвращает разные результаты в зависимости от свойства СпособОткрытия.

  • Если СпособОткрытия = ВМодальномОкне или ВоВсплывающемОкне, то возвращает значение, переданное в метод Закрыть или Неопределено, если форма была закрыта через "крестик". Метод не вернет управление вызывающему коду, пока окно не закроется.
  • Иначе, возвращает Неопределено. Метод вернет управление вызывающему коду, как только окно откроется.

ОткрытьВМодальномОкне

Доступность: Клиент

ОткрытьВМодальномОкне(ОжидатьЗакрытия: Булево = Истина): ТипРезультата?
Открывает форму модально. Нельзя вызывать метод на форме, которая уже открыта. Если параметр ОжидатьЗакрытия не равен Истина, метод возвращает Неопределено. Иначе возвращает значение, переданное в метод Закрыть открытой формы. Если форма была закрыта через "крестик", возвращает Неопределено.


ОткрытьВоВсплывающемОкне

Доступность: Клиент

ОткрытьВоВсплывающемОкне(
РасположениеВсплывающегоОкна: Компонент|РасположениеВсплывающегоОкна = РасположениеВсплывающегоОкна.АктивныйКомпонент,
ОжидатьЗакрытия: Булево = Истина
): ТипРезультата?
Открывает форму во всплывающем окне. Нельзя вызывать метод на форме, которая уже открыта. Параметры:

  • Положение - компонент, у которого произойдет всплытие или значение перечисления РасположениеВсплывающегоОкна
  • ОжидатьЗакрытия - если Истина, то метод не вернет управление, пока модальное окно не закроется. Если параметр ОжидатьЗакрытия не равен Истина, метод возвращает Неопределено. Иначе возвращает значение, переданное в метод Закрыть открытой формы. Если форма была закрыта через "крестик", возвращает Неопределено.

ПоказатьСледующуюОбучающуюПодсказку

Доступность: Клиент

ПоказатьСледующуюОбучающуюПодсказку(Последовательность: ПоследовательностьОбучающихПодсказок? = Неопределено)
Показывает следующую подсказку указанной обучающей последовательности в текущей форме. Параметры:

  • Последовательность - последовательность подсказок, в которой нужно переключить подсказку. Если равно Неопределено, то переходит к следующей подсказке текущей активной последовательности.

Список унаследованных методов

Объект

ВСтроку, ПолучитьТип, Представление