Студия/OnSaveSettings

From SunFlurry wiki
Jump to: navigation, search
  OnSaveSettings (Визуальные события)
Применимость:Форма
Тип события:Прерывающее
Статус разработки: Реализована

Событие, возникающее до автоматического (либо по требованию пользователя) сохранения установок формы в файл установок на сервере. В понятие установок входят значения полей редактирования, флажков, тегов, позиций таблиц и пр. Автоматическое сохранение установок производится только для форм с флажком IsAutoSaveLoadSettings. Элементы, входящие в файл установок, должны иметь непустое поле Name (позиции таблиц и теги также записываются для любых элементов, связанных с базой данных). Событие вызывается до вывода диалога выбора файла установок для сохранения.

Аргументы

  • <SetName (STRING)> - Переменная задает наименование файла установок (к примеру, Default.set). Если при вызове события наименование файла заполнено, происходит автоматическое сохранение установок без участия пользователя (к примеру, при закрытии формы), если аргумент содержит пустую строку, ожидается вывод диалога, чтобы пользователь смог выбрать файл установок самостоятельно.
  • <FolderName (STRING)> - Переменная задает наименование папки (формируется из идентификатора объекта или имени папки метаданных) в которую будет происходить сохранение (к примеру, UserSettings\<Имя пользователя>\Справочник.Номенклатура\Form).
  • <Result> - (возможен аргумент-переменная (ByRef)) Переменная результата может принимать значения:
    • 0 (по умолчанию) -- Разрешить сохранение установок
    • 1 -- Запретить сохранение установок

Примеры

//Пример события OnSaveSettings, установки записываются нестандартным образом
Result:=1;
if isEmpty(SetName) Then
  If not SelectFormSettingsFile(1,FolderName,SetName) Then
    Exit;
  EndIf;
EndIf;
//Сохраним установки нестандартным образом
спОтбор.SetByName("ДокументПозиционирования",Form.MainTab.SelectedElement);
ObjectToFile(спОтбор,AddBackSlash(FolderName)+SetName);