# ProgressBar ## Шаблон ProgressBar Перечень всех возможных тэгов объекта: ```xml ``` ## Описание ProgressBar ```xml ``` Значением ProgressBar считается текст, указанный в поле. ### Получение значения Для получения указанного в поле текста используется get-проперти [Value](#get_value): ```xml ``` Рекомендуется использовать сокращенный вариант записи: ```xml ``` ### Задание значения Для задания значения текстовому полю используется set-проперти [Value](#set_value): ```xml 10 ``` Рекомендуется использовать сокращенный вариант записи: ```xml 10 ``` ## Тэги, специфичные для ProgressBar ### Custom Признак, включающий возможность настраивать стиль прогресс бара. Если признак имеет значение False, то для внешнего вида прогресс бара используются настройки операционной системы. Необязательный тэг. Значение тэга не ожидается. Необязательный атрибут `Value` ожидает логическое значение. По умолчанию используется значение False. ```xml ``` ### Value Задает текущее значение прогресс бара. Необязательный тэг. Ожидается положительное целочисленное значение. По умолчанию используется значение 0. ```xml 0 ``` ### Maximum Задает максимальное значение прогресс бара. Необязательный тэг. Ожидается положительное целочисленное значение. По умолчанию используется значение 100. ```xml 200 ``` ### Minimum Задает минимальное значение прогресс бара. Необязательный тэг. Ожидается положительное целочисленное значение. По умолчанию используется значение 0. ```xml 0 ``` ### BorderColor Задает цвет границы прогресс бара.\ Используется, только если тэг [``](#custom) имеет значение True. Необязательный тег. Ожидается имя одного из цветов, описанных на форме или описание цвета в формате HTML (#rrggbb). По умолчанию используется черный цвет. ```xml #FF9800 ``` ### BorderWidth Задает толщину границы прогресс бара.\ Используется, только если тэг [``](#custom) имеет значение True. Необязательный тэг. Ожидается положительное целочисленное значение. По умолчанию используется значение 0. ```xml 2 ``` ### ChannelHeight Задает высоту канала.\ Используется, только если тэг [``](#custom) имеет значение True. Необязательный тэг. Ожидается положительное целочисленное значение. По умолчанию используется значение 35 ```xml 40 ``` ### ChannelGradient Признак, включающий градиентную заливку фона канала.\ Используется, только если тэг [``](#custom) имеет значение True. Необязательный тэг. Ожидается логическое значение:
TrueГрадиентная заливка фона канала.
Цвета задаются в тэгах <ChannelFirstColor> и <ChannelSecondColor>.
FalseОднотонная заливка фона канала.
Цвет задается в тэге <ChannelFirstColor>.
По умолчанию используется значение False. ```xml True ``` ### ChannelFirstColor Задает основной цвет канала.\ Используется, только если тэг [``](#custom) имеет значение True. Необязательный тег. Ожидается имя одного из цветов, описанных на форме или описание цвета в формате HTML (#rrggbb). По умолчанию используется Transparent ```xml #757575 ``` ### ChannelSecondColor Задает второй цвет канала.\ Используется, только если тэг [``](#custom) имеет значение True, и свойству [ChannelGradient](#channel_gradient) задано значение True. Необязательный тег. Ожидается имя одного из цветов, описанных на форме или описание цвета в формате HTML (#rrggbb). По умолчанию используется Gray ```xml #9E9E9E ``` ### SliderHeight Задает высоту слайдера.\ Используется, только если тэг [``](#custom) имеет значение True. Необязательный тэг. Ожидается положительное целочисленное значение. По умолчанию используется значение 35 ```xml 40 ``` ### SliderGradient Признак, включающий градиентную заливку слайдера.\ Используется, только если тэг [``](#custom) имеет значение True. Необязательный тэг. Ожидается логическое значение:
TrueГрадиентная заливка слайдера.
Цвета задаются в тэгах <SliderFirstColor> и <SliderSecondColor>.
FalseОднотонная заливка слайдера.
Цвет задается в тэге <SliderFirstColor>.
По умолчанию используется значение False. ```xml True ``` ### SliderFirstColor Задает основной цвет слайдера.\ Используется, только если тэг [``](#custom) имеет значение True. Необязательный тег. Ожидается имя одного из цветов, описанных на форме или описание цвета в формате HTML (#rrggbb). По умолчанию используется LightGreen ```xml #689F38 ``` ### SliderSecondColor Задает второй цвет слайдера.\ Используется, только если тэг [``](#custom) имеет значение True, и свойству [SliderGradient](#slider_gradient) задано значение True. Необязательный тег. Ожидается имя одного из цветов, описанных на форме или описание цвета в формате HTML (#rrggbb). По умолчанию используется YellowGreen ```xml #CDDC39 ``` ### TextAlign Используется, чтобы указать способ выравнивания текста по горизонтали.\ Используется, только если тэг [``](#custom) имеет значение True. Необязательный тэг. Ожидается название одного из способов выравнивания текста по горизонтали.:
TopLeftСлева сверху
TopCenterПо центру сверху
TopRightСправа сверху
MiddleLeftСлева посередине
MiddleCenterПо центру посередине
MiddleRightСправа посередине
SlideПлывущий по верху текст
NoneТекст отсутствует
По умолчанию используется значение None. ```xml MiddleCenter ``` ### TextFormat Задает название формата отображения текста.\ Используется, только если тэг [``](#custom) имеет значение True, а свойство [TextAlign](#text_align) имеет значение отличное от None. Необязательный тэг. Ожидается название одного из типов положения текста:
PercentageОтображается текущее значение в виде процентов, рассчитанных по формуле: Value/Maximum * 100
ValueОтображается текущее значение прогресс бара.
ValueOverMaximumОтображается строка вида: Value/Maximum
TextФормат строки задается в тэге <StringFormat>
По умолчанию принимает значение Value. ```xml ValueOverMaximum ``` ### StringFormat Задает шаблон строки для отображаемого текста.\ Используется, только если тэг [``](#custom) имеет значение True, а тэг [``](#text_format) - значение Text. Необязательный тэг. Любое значение будет переведено в текстовое. Поддерживает две переменные для получения собственных свойств: {0} - Value, {1} - Maximum. ```xml {0} из {1} ``` ### Animation Признак, включающий анимацию при заполнении прогресс бара.\ Используется только если тэг [``](#custom) имеет значение True. Необязательный тэг. Значение тэга не ожидается. Необязательный атрибут `Value` ожидает логическое значение. По умолчанию используется значение False. ```xml ``` ### AnimationColor Задает цвет анимации.\ Используется, только если тэг [``](#custom) имеет значение True и анимация прогресс бара включена. Необязательный тег. Ожидается имя одного из цветов, описанных на форме или описание цвета в формате HTML (#rrggbb). По умолчанию используется YellowGreen. ```xml #CDDC39 ``` ### Speed Задает скорость анимации.\ Используется только если тэг [``](#custom) имеет значение True и анимация прогресс бара включена. Необязательный тэг. Ожидается положительное целочисленное значение. По умолчанию используется значение 2. ```xml 2 ``` ## Get-проперти для получения свойств ### Value Возвращает текущее значение прогресс бара. ```xml ``` ### Maximum Возвращает максимальное значение прогресс бара. ```xml ``` ### Minimum Возвращает минимальное значение прогресс бара ```xml ``` ### BorderColor Возвращает цвет границы прогресс бара. ```xml ``` ### BorderWidth Возвращает толщину границы прогресс бара. ```xml ``` ### ChannelHeight Возвращает высоту канала. ```xml ``` ### ChannelGradient Возвращает тип заливки фона канала. ```xml ``` ### ChannelFirstColor Возвращает основной цвет канала. ```xml ``` ### ChannelSecondColor Возвращает второй цвет канала. ```xml ``` ### SliderHeight Возвращает высоту слайдера. ```xml ``` ### SliderGradient Возвращает типа заливки слайдера. ```xml ``` ### SliderFirstColor Возвращает основной цвет слайдера. ```xml ``` ### SliderSecondColor Возвращает второй цвет слайдера. ```xml ``` ### TextAlign Возвращает название способа выравнивания текста по горизонтали. ```xml ``` ### TextFormat Возвращает название типа формата отображаемого текста. ```xml ``` ### StringFormat Возвращает шаблон строки отображаемого текста. ```xml ``` ## Set-проперти для динамического задания свойств ### Value Задает текущее значение прогресс бара. Ожидается положительное целочисленное значение. ```xml 10 ``` ### Maximum Задает максимальное значение прогресс бара. Ожидается положительное целочисленное значение. ```xml 200 ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://wfsys.gitbook.io/workflow-forms-syntax/workflow_forms/objects/progress_bar.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.