2 378 документов
← К списку

ПараметрыОжидания

страница

Возвращает пустую структуру для параметра ПараметрыОжидания процедуры ДлительныеОперацииКлиент.ОжидатьЗавершение.

Синтаксис

Функция ПараметрыОжидания(ФормаВладелец) Экспорт

Параметры

  • ФормаВладелец — ФормаКлиентскогоПриложения
    • Неопределено - форма, из которой вызывается длительная операция.

Возвращаемое значение

Структура - параметры выполнения задания:

  • ФормаВладелец - ФормаКлиентскогоПриложения
    • Неопределено - форма, из которой вызывается длительная операция.
  • Заголовок - Строка - заголовок окна, выводимый на форме ожидания. Если не задан, то не выводится.
  • ТекстСообщения - Строка - текст сообщения, выводимый на форме ожидания. Если не задан, то выводится "Пожалуйста, подождите...".
  • ВыводитьОкноОжидания - Булево - если Истина, то открыть окно ожидания с визуальной индикацией длительной операции. Если используется собственный механизм индикации, то следует указать Ложь.
  • ВыводитьПрогрессВыполнения - Булево - выводить прогресс выполнения в процентах на форме ожидания. Процедура-обработчик длительной операции может сообщить о ходе своего выполнения с помощью вызова процедуры ДлительныеОперации.СообщитьПрогресс.
  • ВыводитьСообщения - Булево - из формы ожидания выводить в ФормаВладелец сообщения, сформированные в процедуре-обработчике длительной операции.
  • ЗаголовокКнопкиОтмена - Строка - заголовок кнопки Отмена, если не указано, по умолчанию используется "Отмена"
  • ОповещениеОПрогрессеВыполнения - ОписаниеОповещения - оповещение, которое периодически вызывается при проверке готовности фонового задания, если ВыводитьОкноОжидания = Ложь. Параметры процедуры-обработчика оповещения: ** Результат - см. НовоеСостояниеДлительнойОперации ** ДополнительныеПараметры - Произвольный - произвольные данные, переданные в описании оповещения.
  • Интервал - Число - интервал в секундах между проверками готовности длительной операции. По умолчанию 0 - после каждой проверки интервал увеличивается с 1 до 15 секунд с коэффициентом 1.4.
  • ОповещениеПользователя - Структура: ** Показать - Булево - если Истина, то по завершении длительной операции вывести оповещение пользователя. ** Текст - Строка - текст оповещения пользователя. ** НавигационнаяСсылка - Строка - навигационная ссылка оповещения пользователя. ** Пояснение - Строка - пояснение оповещения пользователя. ** Картинка - Картинка - картинка, которая будет показана в окне оповещения. Если Неопределено, то картинка не выводится. ** Важное - Булево - если Истина, то оповещение после автоматического закрытия будет добавлено в центр оповещений.
  • ОтменятьПриЗакрытииФормыВладельца - Булево - по умолчанию ФормаВладелец.Открыта(), Ложь если форма не указана. Если Ложь, тогда длительная операция не будет отменена при закрытии формы владельца и при закрытии окна ожидания.
  • ПолучатьРезультат - Булево - служебный параметр. Не предназначен для использования.

Пример вызова

Результат = ДлительныеОперацииКлиент.ПараметрыОжидания(ФормаВладелец)

Доступность

Тонкий клиент, Толстый клиент