Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

Свойства

Отображаемое имя

Описание объекта (поля объекта). Позволяет указать произвольное (например, русскоязычное) имя для узнаваемости объекта (поля объекта) в проекте. Не мешает использованию базового англоязычного имени объекта (поля объекта) для обращения в коде.

Горизонтальная полоса прокрутки и Вертикальная полоса прокрутки

HorizontalScrollBar
VerticalScrollBar

Ссылка на компонент Полоса прокрутки. Используется для настройки прокрутки содержимого экранной формы. Полосы прокрутки появляются автоматически, если содержимое формы превышает её размеры.

Курсор

Cursor

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

Координата курсора X и Координата курсора Y

float MouseX
float MouseY

Позиция курсора мыши в локальных координатах объекта. Измеряется в пикселях, как сдвиг относительно левого верхнего угла объекта.

Доступно только для чтения в режиме рантайма.

Примеры

Вывести в текстовую область координаты курсора мыши внутри объекта.

TextEdit.Text = Str.ToString(Object.MouseX);
TextEdit.Text = Str.ToString(Object.MouseY);

X и Y

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

float X
float Y

Позиция объекта по горизонтали и по вертикали. Измеряется в пикселях, как сдвиг относительно левого верхнего угла родительского объекта (объекта-контейнера).

Примеры

Установить позицию элемента (100; 100).

Object.X = 100;
Object.Y = 100;

Сдвинуть объект на 50 пикселей правее и ниже его текущей позиции.

Object.X += 50;
Object.Y += 50;

Z-значение

float ZValue

Порядок отображения объекта на экране среди объектов, находящихся на одном уровне вложенности (соседних, с общим родителем). Чем выше значение свойства Z-значение, тем выше объект отображается, перекрывая объекты с меньшими значениями этого свойства на том же уровне вложенности.

Диапазон допустимых значений: 0 и выше.

При использовании Alpha.HMI.WebViewer рекомендуется задавать целочисленные значения для свойства Z-значение, так как в Alpha.HMI.WebViewer значение Z-значение автоматически округляется до целого числа.

Угол поворота

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

float Rotation

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

Примеры

Задать угол поворота объекта - 45 градусов.

Object.Rotation = 45;

Увеличить угол поворот объекта на 1 градус относительно текущего значения.

Object.Rotation += 1;

Масштаб

float Scale

Коэффициент масштабирования контейнера экранной формы:

  • 1.0 — содержимое отображается в исходном размере.
  • Меньше 1.0 — содержимое уменьшается.
  • Больше 1.0 — содержимое увеличивается.

Отражение

uint1 Flip

Отражение объекта относительно горизонтальной и вертикальной осей.

Значение

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

Видимость

bool Visible

Видимость элементов экранной формы.

Примеры

Включить отображение.

if(signal1.value > signal2.value)
{
 here.Visible = true;
}

Отключить отображение.

if(signal1.value < signal2.value)
{
  here.Visible = false;
}

Непрозрачность

double Opacity

Степень прозрачности экранной формы. Измеряется в диапазоне от 0.0 до 1.0 , где

  • 0.0 - форма полностью прозрачная;
  • 1.0 - форма полностью непрозрачная.

Включено

bool Enabled

Активность объекта.

Значение

true Объект активен.
false Объект заблокирован.

Примеры

Активировать объект в зависимости от выполнения условия.

if (Signal1.value == Signal2.value)
{
 Object.Enabled = true;
}
else
{
 Object.Enabled = false;
}

Всплывающая подсказка

string Tooltip

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

Примеры

Задать всплывающую подсказку для контейнера экранной формы.

here.Tooltip = "Подача команды MNA_start = true";

Ширина и высота

float Width
float Height

Ширина и высота контейнера экранной формы в пикселях.

Примеры

Задать ширину контейнера экранной формы.

here.Width = 50;

Уменьшить текущую ширину контейнера экранной формы на 50 пикселей.

here.Width -= 50;

Задать высоту контейнера экранной формы.

here.Height = 500;

Увеличить текущую высоту контейнера экранной формы вдвое.

here.Height *= 2;

Фокус ввода

bool Focus

Свойство устарело.

Переводит фокус на объект/снимает фокус с объекта.

Значение

true Фокус на объекте.
false Фокус вне объекта.

Цвет пера

uint4 PenColor

Цвет внешней границы контейнера экранной формы. Указывается через системное окно Выбор цвета. После выбора автоматически переводится в шестнадцатеричную систему счисления .

Примеры

Задать черный цвет пера.

here.PenColor = 0xff000000;  //в шестнадцатеричной системе счисления
here.PenColor = 4278190080; //в десятичной системе счисления

Стиль пера

uint2 PenStyle

Стиль внешней границы контейнера экранной формы.

Значение

Значение Граница Внешний вид
0 Без границы  
1 Сплошная линия
2 Длинный пунктир
3 Короткий пунктир
4 Смешанный пунктир
5 Смешанный пунктир

Примеры

Применить стиль границы (короткий пунктир) для объекта.

here.PenStyle = 3;

Толщина пера

float PenWidth

Толщина внешней границы контейнера экранной формы. Измеряется в пикселях.

Примеры

Задать толщину пера 5 пикселей.

here.PenWidth = 5;

Цвет заливки

uint4 BrushColor

Цвет заливки окна экранной формы. Указывается через системное окно Выбор цвета. После выбора автоматически переводится в шестнадцатеричную систему счисления .

Примеры

Залить объект красным цветом.

here.BrushColor = 0xffff0000;  //в шестнадцатеричной системе счисления
here.BrushColor = 4294901760; //в десятичной системе счисления

Стиль заливки

uint2 BrushStyle

Заливает объект одним из стилей заливки.

Значение

Значение Стиль Внешний вид
0 Нет заливки
1 Сплошная заливка
2 Точечная 1
3 Точечная 2
4 Точечная 2
5 Точечная 4
6 Точечная 5
7 Точечная 6
8 Точечная 7
9 Горизонтальные линии
10 Вертикальные линии
11 Клетка
12 Обратные диагональные линии
13 Прямые диагональные линии
14 Диагональная клетка

Примеры

Залить объект узором в клетку.

Object.BrushStyle = 11;

X окна и Y окна

int4 WindowX
int4 WindowY

Позиция окна экранной формы по горизонтали и вертикали. Измеряется в пикселях. Действует аналогично свойству X для объектов. За начало отчета (точка 0;0) берется левый верхний угол монитора.

Примеры

Установить позицию окна экранной формы (10; 50).

here.WindowX = 10;
here.WindowY = 50;

Ширина окна и Высота окна

int4 WindowWidth
int4 WindowHeight

Ширина и высота окна экранной формы в пикселях. Может отличаться от свойств Ширина или Высота, которые относятся к контейнеру экранной формы. Если размеры окна больше размеров контейнера экранной формы, то во время исполнения будут видны свободные области. Если размеры окна меньше размеров контейнера экранной формы, то снизу и справа появятся полосы прокрутки.

Примеры

Установить ширину и высоту окна (800х600 px).

here.WindowWidth = 800;
here.WindowHeight = 600;

Заголовок окна

string WindowCaption

Надпись в строке заголовка.

Примеры

Установить заголовок окна.

here.WindowCaption = "Заголовок окна";

Активность окна

bool WindowActive

Текущее состояние активности окна экранной формы.

Доступно только для чтения в режиме рантайма.

Значение

true Окно активно.
false Окно неактивно.

Примеры

Вывести состояние активности окна в поле ввода.

TextEdit.Text = Str.ToString(here.WindowActive);

Показывать заголовок

bool ShowWindowCaption

Включает/отключает заголовок окна вместе со всеми кнопками.

Значение

true Заголовок отображается.
false Заголовок скрыт.

Примеры

Убрать заголовок окна.

here.ShowWindowCaption = false;

Показывать кнопку "свернуть"

bool ShowWindowMinimize

Включает/отключает кнопку в заголовке окна.

Значение

true Кнопка "свернуть" отображается.
false Кнопка "свернуть" скрыта.

Примеры

Убрать кнопку "свернуть".

here.ShowWindowMinimize = false;

Показывать кнопку "развернуть"

bool ShowWindowMaximize

Включает/отключает кнопку в заголовке окна.

Значение

true Кнопка "развернуть" отображается.
false Кнопка "развернуть" скрыта.

Примеры

Убрать кнопку "развернуть".

here.ShowWindowMaximize = false;

Показывать кнопку "закрыть"

bool ShowWindowClose

Включает/отключает кнопку в заголовке окна.

Значение

true Кнопка "закрыть" отображается.
false Кнопка "закрыть" скрыта.

Примеры

Убрать кнопку "закрыть".

here.ShowWindowClose = false;

Поверх всех окон

bool AlwaysOnTop

Определяет режим отображения экранной формы поверх остальных окон мнемосхемы.

Значение

true Окно всегда отображается поверх других окон мнемосхемы.
false Обычное отображение.

Примеры

Установить отображение экранной формы поверх остальных окон.

here.AlwaysOnTop = true;

Размеры окна

uint4 WindowSizeMode

Определяет режим вычисления размеров окна.

Значение

0 Вручную.
1 Автоподбор при открытии.
2 Автоподбор.

Примеры

Отобразить режим вычисления размеров окна в текстовом поле

TextEdit.Text = here.WindowSizeMode;

Стиль рамки окна

uint4 WindowBorderStyle

Стиль рамки окна экранной формы.

Значение

0 Без рамки.
1 Изменяемый размер.
2 Фиксированный размер.

Примеры

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

TextEdit.Text = here.WindowBorderStyle;

Состояние окна

uint4 WindowState

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

Значение

0 По умолчанию.
1 Развернуто.
2 На весь экран.
3 Свернуто.

Примеры

Показать код текущего режима в текстовом поле.

TextEdit.Text = here.WindowState;

Режим масштабирования

uint4 WindowScalingMode

Автоматически подгоняет размеры контейнера экранной формы до размеров окна.

Значение

0 Не масштабировать.
1 Всегда масштабировать: автоматическая подгонка размеров будет работать в любых ситуациях.
2 Только уменьшать: контейнер экранной формы, размеры которого выходят за границы окна, будет автоматически уменьшен до размеров окна.

Примеры

Выключить режим масштабирования.

here.WindowScalingMode = 0;

Включить режим "Всегда масштабировать".

here.WindowScalingMode = 1;

Включить режим "Только уменьшать".

here.WindowScalingMode = 2;

Монитор

int4 MonitorNumber

Определяет номер монитора для открытия окна экранной формы в многомониторной системе отображения. Свойство учитывается только при значениях свойства Положение окна Вручную относительно монитора или По центру монитора. В остальных случаях свойство Монитор игнорируется.

Мониторы нумеруются начиная с 0. Порядок нумерации: сверху вниз, затем слева направо. То есть сначала перебираются мониторы по вертикали (сверху вниз), затем по горизонтали (слева направо).

Если вместо многомониторной системы отображения используется единственный монитор, то во всех случаях значение свойства Монитор нужно оставлять равным 0.

Примеры

Открыть экранную форму на втором мониторе.

here.MonitorNumber = 1;

Отобразить номер монитора в текстовом поле.

TextEdit.Text = Str.ToString(here.MonitorNumber);

Положение окна

uint4 WindowPosition

Определяет позицию для открытия окна экранной формы.

Значение

0 Вручную.
1 По центру монитора.
2 По центру родительского окна.
3 По центру родительской формы.
4 Вручную относительно монитора.

Примеры

Отобразить код позиции в текстовом поле.

TextEdit.Text = here.WindowPosition;

Режим обработки закрытия окна

uint2 WindowCloseMode

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

Значение

1

Закрыть — Окно закрывается сразу при нажатии на крестик.

2

Отправить запрос — При нажатии на крестик вызывается событие CloseRequested, окно остаётся открытым до выполнения дополнительной логики.

Свойство игнорируется для окон, открытых с помощью элемента Фрейм.

Путь к файлу иконки

string WindowIconPath

Путь к файлу изображения, которое используется как иконка в заголовке окна. Поддерживаются распространенные форматы изображений, такие как *.png, *.jpg и другие.

Идентификатор базового типа

string BaseTypeUuid

Идентификатор (UUID) базового типа объекта.