# PictureBox ## Шаблон PictureBox Перечень всех возможных тэгов объекта: ```xml ``` ## Описание PictureBox ```xml ``` ### Получение значения Значением PictureBox считается источник текущего отображаемого изображения. ```xml ``` ### Задание значения Значение объекта: любое значение будет интерпретировано как источник. ```xml ``` ## Тэги, специфичные для PictureBox ### SizeMode Название типа размера изображения. Необязательный тэг. Ожидается название одного из типов размеров изображения:
AutoSizeИзображение располагается в левом верхнем углу
CenterImageЕсли поле больше изображения, то изображение отображается в центре; если изображение больше поля, то рисунок размещается в центре, а его внешние края обрезаются
NormalИзображение размещается в верхнем левом углу; изображение располагается в центре, если размер поля больше, чем размер изображения
StretchImageИзображение вытягивается или сужается, чтобы в точности соответствовать размеру
ZoomРазмер изображения увеличивается или уменьшается, сохраняя пропорции размеров
По умолчанию используется значение Zoom. ```xml Zoom ``` ### InitialImage Источник изображения, которое будет использоваться в качестве изображения поля, пока в асинхронном режиме загружается требуемое. Начальная загрузка изображения из источника для `` всегда происходит синхронно, вне зависимости от значения свойства [``](#wait_on_load). Необязательный тэг. Ожидается источник изображения. Если тэг `` отсутствует, то в момент загрузки требуемого изображения никаких изменений в поле не будет происходить. ```xml Images\InitialImage.gif ``` ### ErrorImage Источник изображения, которое будет использоваться в качестве изображения поля, если требуемое не было загружено. Начальная загрузка изображения из источника для `` всегда происходит синхронно, вне зависимости от значения свойства [``](#wait_on_load). Необязательный тэг. Ожидается источник изображения. Если тэг `` отсутствует, то в случае ошибки загрузки требуемого изображения никаких изменений в поле не будет ничего происходить. ```xml D:\ErrorImage.png ``` ### WaitOnLoad Признак, определяющий, будет ли загрузка изображений происходить в синхронном режиме. Необязательный тэг. Ожидается логическое значение. По умолчанию используется значение False. ```xml False ``` ### NullImage Источник изображения, которое будет использоваться в качестве изображения поля, если значение поля установлено в NULL. Необязательный тэг. Ожидается источник изображения. Если тэг `` отсутствует, то в случае установки NULL-значения в поле не будет ничего происходить. ```xml D:\NullImage.jpg ``` ### Image Источник изображения, которое будет использоваться в качестве начального отображаемого изображения при загрузке формы. Необязательный тэг. Ожидается источник изображения. Если тэг `` отсутствует, то в качестве начального изображения будет использовано первое изображения из списка, указанного в тэге [``](#images_list). ```xml http://wfsys.ru/image.bmp ``` #### Источники изображений 1. Сокращенный путь до файла - например, "Images\Sample.png" (в качестве исходной папки будет взята папка с расположением формы, на которой описано данное поле). 2. Полный путь до файла в формате UNC - например, "D:\sample.jpg" или "\SERVER\Images\sample.bmp". 3. Ссылка на интернет-ресурс по протоколам http\://, https\:// или ftp\:// - например, "". 4. Ссылка на GUID файла, расположенного на сервере, - например, "guid://cbed3d33-7591-49ff-8119-8ad7e3c81599". ### ImagesLoad Тип загрузки изображений из списка, указанного в тэге [``](#images_list). Необязательный тэг. Значение тэга ``: не ожидается. Если тэг [``](#images_list) отсутствует, то для атрибута `Value` используется значение ByRequest. ```xml ``` #### Атрибуты тэга ``
Value

Значение.

Обязательный атрибут. Ожидается название одного из типов загрузки изображений.

#### Типы загрузки изображений
ByRequestИзображения будут загружаться только в том случае, если их требуется отобразить
AllВсе изображения будут загружены при загрузке формы
### ImagesList Список источников изображений, которые будут использоваться в качестве изображений для установки в поле. Необязательный тэг. Ожидается массив источников изображений. Если тэг `` отсутствует, то в качестве начального изображения будет использовано изображение из источника, указанного в тэге [``](#null_image). ```xml ``` ## Get-проперти для получения свойств ### SizeMode Возвращает название типа размера изображения. ```xml ``` ### InitialImage Возвращает [источник изображения](#image_sources), которое будет использоваться в качестве изображения поля, пока в асинхронном режиме загружается требуемое. ```xml ``` ### ErrorImage Возвращает [источник изображения](#image_sources), которое будет использоваться в качестве изображения поля, если требуемое изображение не было загружено. ```xml ``` ### WaitOnLoad Возвращает признак, определяющий, будет ли загрузка изображений происходить в синхронном режиме. ```xml ``` ### NullImage Возвращает [источник изображения](#image_sources), которое будет использоваться в качестве изображения поля, если значение поля установлено в NULL. ```xml ``` ### Image Возвращает [источник изображения](#image_sources), которое будет использоваться в качестве начального отображаемого изображения при загрузке формы. ```xml ``` ### ImagesLoad Возвращает тип загрузки изображений из списка, указанного в тэге [``](#images_list). ```xml ``` ### ImagesList Возвращает массив источников изображений, которые будут использоваться в качестве изображений для установки в поле. ```xml ``` ### Count Возвращает общее количество изображений в списке [``](#images_list). ```xml ``` ### CurrentImageIndex Возвращает индекс отображаемого изображения (-1 - если установлено изображение из настройки [``](#image), 0 - если установлено изображение из настройки [``](#null_image), от 1 до N - если установлено изображение из списка [``](#images_list), где N - общее количество изображений в этом списке). ```xml ``` ### CurrentImageSource Возвращает источник отображаемого изображения. ```xml ``` ### CurrentRealImageSource Возвращает источник изображения даже если это изображение не отображается, а отображается [``](#error_image). ```xml ``` ### IsCurrentImageSourceError Возвращает True или False в зависимости от того, была ли ошибка в загрузке текущего изображения. ```xml ``` ## Set-проперти для динамического задания свойств ### SizeMode Задает название типа размера изображения. Ожидается название одного из типов размеров изображения. ```xml StretchImage ``` ### InitialImage Задает [источник изображения](#image_sources), которое будет использоваться в качестве изображения поля, пока в асинхронном режиме загружается требуемое. Ожидается источник изображения. ```xml ftp://wfsys.ru/Image.png ``` ### ErrorImage Задает [источник изображения](#image_sources), которое будет использоваться в качестве изображения поля, если требуемое не было загружено. Ожидается источник изображения. ```xml D:\ErrorImage.bmp ``` ### WaitOnLoad Задает признак, определяющий, будет ли загрузка изображений происходить в синхронном режим. Ожидается логическое значение. ```xml True ``` ### NullImage Задает [источник изображения](#image_sources), которое будет использоваться в качестве изображения поля, если значение поля установлено в NULL. Ожидается источник изображения. ```xml \\SHARE\Images\NullImage.png ``` ### Image Задает [источник изображения](#image_sources), которое будет использоваться в качестве начального отображаемого изображения при загрузке формы. Ожидается источник изображения. ```xml guid://26c7d4b6-2b4a-48f3-bde1-def012932219 ``` ### ImagesList Задает список [источников изображений](#image_sources), которые будут использоваться в качестве изображений для установки в поле. При наличии в новом списке ранее загруженных изображений (по совпадению источника) их перезагрузка не происходит. Ожидается массив источников изображений. ```xml ``` ### Open Открывает файл изображения с индексом ImageIndex, предварительно при необходимости перезагрузив его в соответствии с признаком ForceRefresh. ```xml 1 False ``` ### Next Устанавливает в качестве текущего следующее по списку [``](#images_list) изображение, предварительно при необходимости перезагрузив его в соответствии с признаком ForceRefresh. ```xml False ``` ### Prev Устанавливает в качестве текущего предыдущее по списку [``](#images_list) изображение, предварительно при необходимости перезагрузив его в соответствии с признаком ForceRefresh. ```xml False ``` ### Show Устанавливает в качестве текущего изображение с индексом ImageIndex, предварительно при необходимости перезагрузив его в соответствии с признаком ForceRefresh. ```xml 1 False ``` ### Refresh Перезагружает изображение с индексом ImageIndex. ```xml 1 ``` --- # 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/picturebox.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.