Платформа WT
Синтаксис
База знаний

PictureBox

Графический объект; поле с изображением.

Шаблон PictureBox

Перечень всех возможных тэгов объекта:

<MyObject Name="" Type="PictureBox" Assembly="BaseControls" ChangeForm="">
  <!--Тэги, общие для всех графических объектов-->
  <Top></Top>
  <Bottom></Bottom>
  <Left></Left>
  <Right></Right>
  <Height></Height>
  <Width></Width>
  <FontStyle></FontStyle>
  <ForeColor></ForeColor>
  <BackColor></BackColor>
  <Enabled></Enabled>
  <Visible></Visible>
  <Opacity></Opacity>
  <Hint></Hint>
  <ContextMenu Name="" />
  <Change User="" Source="" ValueSet="" />
  <!--Тэги, специфичные для PictureBox-->
  <SizeMode></SizeMode>
  <InitialImage></InitialImage>
  <ErrorImage></ErrorImage>
  <WaitOnLoad></WaitOnLoad>
  <NullImage></NullImage>
  <Image></Image>
  <ImagesLoad Value="" />
  <ImagesList></ImagesList>
</MyObject>

Описание PictureBox

<MyObject Name="PictureBoxName" Type="PictureBox" Assembly="BaseControls">
  <!--Тэги, общие для всех графических объектов-->
  <!--Тэги, специфичные для PictureBox-->
</MyObject>

Получение значения PictureBox

Значением PictureBox считается источник текущего отображаемого изображения.

<Object Name="PictureBoxName" />

Задание значения PictureBox

Значение объекта: любое значение будет интерпретировано как источник.

<Object Name="PictureBoxName"></Object>

Тэги, специфичные для PictureBox

SizeMode

Название типа размера изображения.

Необязательный тэг. Ожидается название одного из типов размеров изображения:

CenterImage

Если поле больше изображения, то изображение отображается в центре; если изображение больше поля, то рисунок размещается в центре, а его внешние края обрезаются

StretchImage

Изображение вытягивается или сужается, чтобы в точности соответствовать размеру

Zoom

Размер изображения увеличивается или уменьшается, сохраняя пропорции размеров

По умолчанию используется значение Zoom.

<SizeMode>Zoom</SizeMode>

InitialImage

Источник изображения, которое будет использоваться в качестве изображения поля, пока в асинхронном режиме загружается требуемое. Начальная загрузка изображения из источника для <InitialImage> всегда происходит синхронно, вне зависимости от значения свойства <WaitOnLoad>.

Необязательный тэг. Ожидается источник изображения.

Если тэг <InitialImage> отсутствует, то в момент загрузки требуемого изображения никаких изменений в поле не будет происходить.

<InitialImage>Images\InitialImage.gif</InitialImage>

ErrorImage

Источник изображения, которое будет использоваться в качестве изображения поля, если требуемое не было загружено. Начальная загрузка изображения из источника для <ErrorImage> всегда происходит синхронно, вне зависимости от значения свойства <WaitOnLoad>.

Необязательный тэг. Ожидается источник изображения.

Если тэг <ErrorImage> отсутствует, то в случае ошибки загрузки требуемого изображения никаких изменений в поле не будет ничего происходить.

<ErrorImage>D:\ErrorImage.png</ErrorImage>

WaitOnLoad

Признак, определяющий, будет ли загрузка изображений происходить в синхронном режиме.

Необязательный тэг. Ожидается логическое значение.

По умолчанию используется значение False.

<WaitOnLoad>False</WaitOnLoad>

NullImage

Источник изображения, которое будет использоваться в качестве изображения поля, если значение поля установлено в NULL.

Необязательный тэг. Ожидается источник изображения.

Если тэг <NullImage> отсутствует, то в случае установки NULL-значения в поле не будет ничего происходить.

<NullImage>D:\NullImage.jpg</NullImage>

Image

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

Необязательный тэг. Ожидается источник изображения.

Если тэг <Image> отсутствует, то в качестве начального изображения будет использовано первое изображения из списка, указанного в тэге <ImagesList>.

<Image>http://wfsys.ru/image.bmp</Image>

Источники изображений

  1. Сокращенный путь до файла - например, "Images\Sample.png" (в качестве исходной папки будет взята папка с расположением формы, на которой описано данное поле).

  2. Полный путь до файла в формате UNC - например, "D:\sample.jpg" или "\SERVER\Images\sample.bmp".

  3. Ссылка на интернет-ресурс по протоколам http://, https:// или ftp:// - например, "http://wfsys.ru/sample.png".

  4. Ссылка на GUID файла, расположенного на сервере, - например, "guid://cbed3d33-7591-49ff-8119-8ad7e3c81599".

ImagesLoad

Тип загрузки изображений из списка, указанного в тэге <ImagesList>.

Необязательный тэг. Значение тэга <ImagesLoad>: не ожидается.

Если тэг <ImagesList> отсутствует, то для атрибута Value используется значение ByRequest.

<ImagesLoad Value="ByRequest" />

Атрибуты тэга <ImagesLoad>

Value

Значение.

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

Типы загрузки изображений

ByRequest

Изображения будут загружаться только в том случае, если их требуется отобразить

All

Все изображения будут загружены при загрузке формы

ImagesList

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

Необязательный тэг. Ожидается массив источников изображений.

Если тэг <ImagesList> отсутствует, то в качестве начального изображения будет использовано изображение из источника, указанного в тэге <NullImage>.

<ImagesList>
  <DataConnection SourceDataConnection="SourceDataConnectionName">
    <Fields>
      <Field Name="ImageSource" />
    </Fields>
  </DataConnection>
</ImagesList>

Get-проперти для получения свойств

SizeMode

Возвращает название типа размера изображения.

<Object Name="PictureBoxName">
  <Property Name="SizeMode" />
</Object>

InitialImage

Возвращает источник изображения, которое будет использоваться в качестве изображения поля, пока в асинхронном режиме загружается требуемое.

<Object Name="PictureBoxName">
  <Property Name="InitialImage" />
</Object>

ErrorImage

Возвращает источник изображения, которое будет использоваться в качестве изображения поля, если требуемое изображение не было загружено.

<Object Name="PictureBoxName">
  <Property Name="ErrorImage" />
</Object>

WaitOnLoad

Возвращает признак, определяющий, будет ли загрузка изображений происходить в синхронном режиме.

<Object Name="PictureBoxName">
  <Property Name="WaitOnLoad" />
</Object>

NullImage

Возвращает источник изображения, которое будет использоваться в качестве изображения поля, если значение поля установлено в NULL. 

<Object Name="PictureBoxName">
  <Property Name="NullImage" />
</Object>

Image

Возвращает источник изображения, которое будет использоваться в качестве начального отображаемого изображения при загрузке формы. 

<Object Name="PictureBoxName">
  <Property Name="Image" />
</Object>

ImagesLoad

Возвращает тип загрузки изображений из списка, указанного в тэге <ImagesList>. 

<Object Name="PictureBoxName">
  <Property Name="ImagesLoad" />
</Object>

ImagesList

Возвращает массив источников изображений, которые будут использоваться в качестве изображений для установки в поле. 

<Object Name="PictureBoxName">
  <Property Name="ImagesList" />
</Object>

Count

Возвращает общее количество изображений в списке <ImagesList>. 

<Object Name="PictureBoxName">
  <Property Name="Count" />
</Object>

CurrentImageIndex

Возвращает индекс отображаемого изображения (-1 - если установлено изображение из настройки <Image>, 0 - если установлено изображение из настройки <NullImage>, от 1 до N - если установлено изображение из списка <ImagesList>, где N - общее количество изображений в этом списке). 

<Object Name="PictureBoxName">
  <Property Name="CurrentImageIndex" />
</Object>

CurrentImageSource

Возвращает источник отображаемого изображения. 

<Object Name="PictureBoxName">
  <Property Name="CurrentImageSource" />
</Object>

CurrentRealImageSource

Возвращает источник изображения даже если это изображение не отображается, а отображается <ErrorImage>. 

<Object Name="PictureBoxName">
  <Property Name="CurrentRealImageSource" />
</Object>

IsCurrentImageSourceError

Возвращает True или False в зависимости от того, была ли ошибка в загрузке текущего изображения.

<Object Name="PictureBoxName">
  <Property Name="IsCurrentImageSourceError" />
</Object>

Set-проперти для динамического задания свойств

SizeMode

Задает название типа размера изображения.

Ожидается название одного из типов размеров изображения.

<Object Name="PictureBoxName">
  <Property Name="SizeMode">StretchImage</Property>
</Object>

InitialImage

Задает источник изображения, которое будет использоваться в качестве изображения поля, пока в асинхронном режиме загружается требуемое.

Ожидается источник изображения.

<Object Name="PictureBoxName">
  <Property Name="InitialImage">ftp://wfsys.ru/Image.png</Property>
</Object>

ErrorImage

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

Ожидается источник изображения.

<Object Name="PictureBoxName">
  <Property Name="ErrorImage">D:\ErrorImage.bmp</Property>
</Object>

WaitOnLoad

Задает признак, определяющий, будет ли загрузка изображений происходить в синхронном режим.

Ожидается логическое значение.

<Object Name="PictureBoxName">
  <Property Name="WaitOnLoad">True</Property>
</Object>

NullImage

Задает источник изображения, которое будет использоваться в качестве изображения поля, если значение поля установлено в NULL.

Ожидается источник изображения.

<Object Name="PictureBoxName">
  <Property Name="NullImage">\\SHARE\Images\NullImage.png</Property>
</Object>

Image

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

Ожидается источник изображения.

<Object Name="PictureBoxName">
  <Property Name="Image">guid://26c7d4b6-2b4a-48f3-bde1-def012932219</Property>
</Object>

ImagesList

Задает список источников изображений, которые будут использоваться в качестве изображений для установки в поле. При наличии в новом списке ранее загруженных изображений (по совпадению источника) их перезагрузка не происходит.

Ожидается массив источников изображений.

<Object Name="PictureBoxName">
  <Property Name="ImagesList">
    <DataConnection SourceDataConnection="SourceDataConnectionName">
      <Fields>
        <Field Name="ImageSource" />
      </Fields>
    </DataConnection>
  </Property>
</Object>

Open

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

<Object Name="PictureBoxName">
  <!--Значение тэга Property: тэг Parameters со вложенными тэгами Parameter-->
  <Property Name="Open">
    <Parameters>
      <!--Значение тэга Parameter с атрибутом Name, равным ImageIndex: ожидается целочисленное значение-->
      <!--Необязательный параметр. При отсутствии или значении NULL открывает текущее отображаемое изображение-->
      <Parameter Name="ImageIndex">1</Parameter>
      <!--Значение тэга Parameter с атрибутом Name, равным ForceRefresh: ожидается логическое значение-->
      <!--Необязательный параметр. При отсутствии используется значение False-->
      <Parameter Name="ForceRefresh">False</Parameter>
    </Parameters>
  </Property>
</Object>

Next

Устанавливает в качестве текущего следующее по списку <ImagesList> изображение, предварительно при необходимости перезагрузив его в соответствии с признаком ForceRefresh.

<Object Name="PictureBoxName">
  <!--Значение тэга Property: тэг Parameters со вложенными тэгами Parameter-->
  <Property Name="Next">
    <Parameters>
      <!--Значение тэга Parameter с атрибутом Name, равным ForceRefresh: ожидается логическое значение-->
      <!--Необязательный параметр. При отсутствии используется значение False-->
      <Parameter Name="ForceRefresh">False</Parameter>
    </Parameters>
  </Property>
</Object>

Prev

Устанавливает в качестве текущего предыдущее по списку <ImagesList> изображение, предварительно при необходимости перезагрузив его в соответствии с признаком ForceRefresh.

<Object Name="PictureBoxName">
  <!--Значение тэга Property: тэг Parameters со вложенными тэгами Parameter-->
  <Property Name="Prev">
    <Parameters>
      <!--Значение тэга Parameter с атрибутом Name, равным ForceRefresh: ожидается логическое значение-->
      <!--Необязательный параметр. При отсутствии используется значение False-->
      <Parameter Name="ForceRefresh">False</Parameter>
    </Parameters>
  </Property>
</Object>

Show

Устанавливает в качестве текущего изображение с индексом ImageIndex, предварительно при необходимости перезагрузив его в соответствии с признаком ForceRefresh.

<Object Name="PictureBoxName">
  <!--Значение тэга Property: тэг Parameters со вложенными тэгами Parameter-->
  <Property Name="Show">
    <Parameters>
      <!--Значение тэга Parameter с атрибутом Name, равным ImageIndex: ожидается целочисленное значение-->
      <Parameter Name="ImageIndex">1</Parameter>
      <!--Значение тэга Parameter с атрибутом Name, равным ForceRefresh: ожидается логическое значение-->
      <!--Необязательный параметр. При отсутствии используется значение False-->
      <Parameter Name="ForceRefresh">False</Parameter>
    </Parameters>
  </Property>
</Object>

Refresh

Перезагружает изображение с индексом ImageIndex.

<Object Name="PictureBoxName">
  <!--Значение тэга Property: тэг Parameters со вложенными тэгами Parameter-->
  <Property Name="Refresh">
    <Parameters>
      <!--Значение тэга Parameter с атрибутом Name, равным ImageIndex: ожидается целочисленное значение-->
      <!--Необязательный параметр. При отсутствии или значении NULL перезагружает все изображения из списка ImagesList-->
      <Parameter Name="ImageIndex">1</Parameter>
    </Parameters>
  </Property>
</Object>

Last updated