Form.StatusText

From SunFlurry wiki
Revision as of 08:50, 7 February 2021 by Admin (talk | contribs) (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
  StatusText (Оповещение пользователя)
Объект:Форма
Статус разработки: Реализована
Тип:Функция
Обращение к БД:Нет
Исключения:Невозможно превратить в строку
Визуальность:Да

Функция получает или изменяет текст статуса выполнения, выводимый в полосе статуса в самом низу окна клиента. Статус выполнения выводится для каждого потока отдельно и будет показан только пока поток занят исполнением программы. Для консольного клиента информация по статусу обычно выводится в заголовок консоли. Функция может использоваться до инициализации формы и в консольном клиенте. Статус также выводится для окна административной панели при запуске исполняемых выражений. Функцию удобно использовать в цикле длительной обработки для оповещения пользователя о прогрессе выполнения обработки. См. также UpdateProgress.

Синтаксис

Form.StatusText(<Новая строка статуса выполнения (STRING)>):<Текущая строка статуса выполнения (STRING)>

Аргументы

  • <Новая строка статуса выполнения (STRING)> - (необязательный аргумент) Задает новую строку статуса выполнения. При отсутствии аргумента, статус выполнения изменен не будет.

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

Возвращает строковое значение -- текущий статус выполнения.

Примеры

//Пример показывает цикл с длительной обработкой таблицы. Пользователь будет видеть, сколько осталось обработать строк
аСтр:=0;
While аСтр<aTab.Size() Do
  аСтр:=аСтр+1;
  //Выводить статус на каждой 10-той строке
  If аСтр%10=0 Then
    Form.StatusText("Себестоимость: "+аСтр+" из "+aTab.Size());
  EndIf;  
  aTab.CurLine:=аСтр;
  If aTab.ТипЗаписи<>0 Then
    Continue;
  EndIf;

  ...
EndDo;