CreateProgress – создать индикатор процесса

Contents

Синтаксис:

function CreateProgress(

[optional] Caption: WideString;

[optional] Max: Integer;

[optional] IsBreakable: WordBool = False;

[optional] BreakProcessText: WideString;

[optional] TextLineCount: Integer): IProgress;

Параметры:

•	Caption – заголовок окна индикатора;

•	Max – максимальная позиция полосы прогресса, расположенной в окне индикатора. Если значение не задано, то форма индикатора не будет отображать полосу прогресса;

•	IsBreakable – возможность прерывания процесса, ход выполнения которого отображает индикатор: True, если процесс можно будет прервать, нажав на кнопку Прервать, False, если процесс невозможно прервать. Если процесс невозможно прервать, то на форме индикатора не будет кнопки Прервать;

•	BreakProcessText – имя кнопки для прерывания процесса;

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

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

Объект работы с индикатором.

Описание:

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

Русскоязычный аналог имени функции:

СоздатьИндикатор

Пример:

// Перенести все документы, найденные поиском, в хранилище.

// Contents - список документов, найденных поиском.

// FileStorage - хранилище документов.

if Contents.Count > 0

Progress = CreateProgress('Перенос документов в хранилище';

Contents.Count; False)

Progress.Show

foreach EDocumentInfo in Contents

EDocument = EDocumentInfo.Document

EDocument.MoveToStorage(FileStorage)

Progress.Next

endforeach

Progress.Hide

endif