Alpha.Community

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

События

При запуске проекта через Alpha.HMI.WebViewer с помощью браузера Firefox:

  • На Windows 10 и Linux: события, связанные с BackButton/ForwardButton могут работать некорректно из-за ограничений браузера Firefox.

Если несколько объектов наложены друг на друга, обработка событий выполняется по следующему правилу:

  • Если у объекта на переднем плане есть хотя бы один обработчик событий MouseClick, MouseRightClick, MouseDoubleClick, MousePress или MouseRelease, эти события не передаются нижележащим объектам.
  • Если у объекта на переднем плане нет обработчиков этих событий, они передаются нижележащему объекту.

Исключение:

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

AboutToOpened

Событие срабатывает перед отображением экранной формы.

CloseRequested

Запрос на закрытие формы.

Opened

Событие срабатывает сразу после того, как форма стала видимой пользователю.

Closed

Закрытие формы.

WindowActivationChanged

Изменение статуса активности окна. Окно активно, когда на нем фокус.

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

Параметры

active bool Статус активности окна: активное (true) или неактивное (false).

WindowSizeChanged

Изменение размеров окна или фрейма, содержащего форму.

Параметры

width uint4 Новая ширина окна или фрейма.
height uint4 Новая высота окна или фрейма.

WindowPosChanged

Изменение положения окна.

Параметры

x int4 Новое положение по горизонтали верхней левой точки окна.
y int4 Новое положение по вертикали верхней левой точки окна.

KeyPress

Нажатие определённой клавиши или сочетания клавиш на форме.

Параметры

event Экземпляр типа KeyEvent. См. описание типа KeyEvent.

Примеры

Вывести код нажатой клавиши в текстовое поле

TextEdit_1.Text = Str.ToString(event.KeyCode);

Вывести код нажатой клавиши-модификатора в текстовое поле

TextEdit_1.Text = Str.ToString(event.Modifiers);

При удержании клавиши F5 записать текст из поля ввода в текстовое поле

if (event.KeyCode == 55 && event.Repeated == true)
{Text_1.Text = TextEdit_1.Text;}

Вывести текст нажатой клавиши в текстовое поле

TextEdit_1.Text = event.Text;

KeyRelease

Отпускание определённой клавиши или сочетания клавиш на форме.

Параметры

event Экземпляр типа KeyEvent. См. описание типа KeyEvent.

Примеры

Увеличить размер прямоугольника при отпускании пробела

if (event.KeyCode == 84)
{Rectangle_1.Width = 500;Rectangle_1.Height = 500;}

Уведомить о сохранении данных

if (event.Modifiers == 67108864 && event.KeyCode == 28)
{Text_1.Text = "Сохранено";}

При удержании и отпускании клавиши F5 записать текст из поля ввода в текстовое поле

if (event.KeyCode == 55 && event.Repeated == true)
{Text_1.Text = TextEdit_1.Text;}

Вывести текст нажатой клавиши в текстовое поле

Text_1.Text = event.Text;

MouseMove

Перемещение курсора мыши.

Параметры

event Экземпляр типа MouseEvent. См. описание типа MouseEvent.

Примеры

Выводить в текстовое поле координаты курсора при его перемещении по объекту:

Text_1.Text = "X=" + String.ToString(event.X) + ", Y=" + String.ToString(event.Y);

MouseClick

Одиночный клик левой кнопкой мыши по объекту.

Параметры

event Экземпляр типа MouseEvent. См. описание типа MouseEvent.

Примеры

Переместить объект в точку, где произошёл клик:

Object_1.X = event.X;
Object_1.Y = event.Y;

MouseRightClick

Клик правой кнопкой мыши по объекту.

Параметры

event Экземпляр типа MouseEvent. См. описание типа MouseEvent.

Примеры

Записать координаты точки клика правой кнопкой мыши в поле ввода:

TextEdit_1.Text = "Координаты: X = " + String.ToString(event.X) + ", Y = " + String.ToString(event.Y);

MouseDoubleClick

Двойной клик мыши по объекту.

Параметры

event Экземпляр типа MouseEvent. См. описание типа MouseEvent.

Примеры

Увеличить/уменьшить масштаб объекта в зависимости от того, где произошел двойной клик - если двойной клик произошел в правой половине объекта, увеличить масштаб в 1.5 раза, если в левой половине - уменьшить в 0.7 раза:

if (event.X > Object_1.Width / 2) {
  // Клик в правой половине-увеличить
  Object_1.Scale *= 1.5;
} else {
  // Клик в левой половине-уменьшить
  Object_1.Scale *= 0.7;
}

MousePress

Нажатие кнопки мыши в области объекта.

Параметры

event Экземпляр типа MouseEvent. См. описание типа MouseEvent.

Примеры

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

TextEdit_1.Text = String.ToString(event.KeyboardModifiers);

MouseRelease

Отпускание кнопки мыши после нажатия на объект, независимо от положения курсора в момент отпускания.

Параметры

event Экземпляр типа MouseEvent. См. описание типа MouseEvent.

Примеры

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

TextEdit_2.Text = String.ToString(event.Buttons);

MouseEnter

Вход курсора в область объекта.

Параметры

event Экземпляр типа MouseEvent. См. описание типа MouseEvent.

Примеры

Изменить цвет подсветки объекта в зависимости от зажатых клавиш-модификаторов при входе курсора - зелёный для Ctrl, красный для Shift, голубой без модификаторов:

if ((event.KeyboardModifiers & 0x04000000) != 0) { // Ctrl зажат
  Object_1.BrushColor = 0xFF99FF99; // зелёный
} else if ((event.KeyboardModifiers & 0x02000000) != 0) { // Shift зажат
  Object_1.BrushColor = 0xFFFF9999; // красный
} else {
  Object_1.BrushColor = 0xFFD8E6F2; // голубой
}

MouseLeave

Выход курсора за пределы области объекта.

Параметры

event Экземпляр типа MouseEvent. См. описание типа MouseEvent.

Примеры

При выходе курсора записать в текстовое поле координаты выхода и маску кодов клавиш-модификаторов, которые были зажаты в момент события.

Text_1.Text = "Выход в точке X=" + String.ToString(event.X) + ", Y=" + String.ToString(event.Y) + ", модификаторы=" + String.ToString(event.KeyboardModifiers);

TouchMove

Нажатие на объект и дальнейшее ведение пальцем (пером) по экрану.

Параметры

event Экземпляр типа TouchEvent. См. описание типа TouchEvent.

Примеры

При перемещении пальцем (пером) по форме выводить текущие координаты нажатия в текстовые поля.

Text_1.Text = String.ToString(event.PointX(0));
Text_2.Text = String.ToString(event.PointY(0));

TouchPress

Нажатие пальцем (пером) на объект.

Параметры

event Экземпляр типа TouchEvent. См. описание типа TouchEvent.

Примеры

При нажатии на объект SW и зажатии клавиши Ctrl увеличивать масштаб объекта.

if (event.KeyboardModifiers == 0x04000000)
{
SW_1.Scale = 5;
}

TouchRelease

Событие срабатывает, если после нажатия на объект отпустить палец (перо) в любом месте экрана.

Параметры

event Экземпляр типа TouchEvent. См. описание типа TouchEvent.

Примеры

При отпускании пальца (пера) на форме выводить сообщение в текстовое поле с координатами точки поднятия.

Text_1.Text = "Координаты: X = " + String.ToString(event.PointX(0)) + ", Y = " + String.ToString(event.PointY(0));

FocusChanged

Событие устарело.

Изменение фокуса у объекта.

Параметры

hasFocus bool Флаг наличия фокуса на объекте.

Wheel

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

Параметры

event Экземпляр типа WheelEvent. См. описание типа WheelEvent.

Примеры

Изменить масштаб объекта при прокрутке:

if (event.Delta > 0) 
{
ㅤ Object_1.Scale *= 1.1; // Увеличить масштаб
}
else
{
ㅤ Object_1.Scale *= 0.9; // Уменьшить масштаб
}

Описание типа MouseEvent

Параметр event для событий мыши является экземпляром типа MouseEvent. Описание типа MouseEvent и его особенности приведены в таблице ниже.

X float Локальная координата объекта по оси Х, в которой возникло событие.
Y float

Локальная координата объекта по оси Y, в которой возникло событие.

ScreenX float Глобальная координата по оси X относительно пространства мониторов.
ScreenY float Глобальная координата по оси Y относительно пространства мониторов.
EventType int4

Тип события:

  • MouseMove: 0;
  • MouseClick: 1;
  • MouseRightClick: 2;
  • MouseDoubleClick: 3;
  • MousePress: 4;
  • MouseRelease: 5;
  • MouseEnter: 6;
  • MouseLeave: 7.
Button int4
  • Для MouseMove, MouseEnter, MouseLeave всегда 0.
  • Для MouseClick, MouseRightClick, MouseDoubleClick, MousePress, MouseRelease: код кнопки мыши, которая инициировала событие.
Buttons int4
  • Для MouseMove: маска зажатых кнопок только при условии, что до перемещения было произведено нажатие на элемент, и у элемента есть обработчик событий MousePress, MouseRelease, MouseClick или MouseDoubleClick. Без предварительного нажатия маска остаётся пустой.
  • Для MouseClick, MouseRightClick, MouseRelease: маска кодов кнопок мыши, которые были зажаты до события, не включая кнопку, которая инициировала событие.
  • Для MouseDoubleClick, MousePress: маска кодов кнопок мыши, которые были зажаты до события, включая кнопку, которая инициировала событие.
  • Для MouseEnter, MouseLeave: маска кодов кнопок мыши, которые были зажаты до возникновения события.
KeyboardModifiers int4

Маска кодов клавиш-модификаторов (например, Ctrl, Shift, Alt), которые были зажаты в момент события.
Полный список базовых кодов модификаторов приведён в разделе Комбинации модификаторов.

Описание типа TouchEvent

Параметр event для событий касания является экземпляром типа TouchEvent. Описание типа TouchEvent и его особенности приведены в таблице ниже.

PointsCount uint4
  • Для TouchMove, TouchPress: количество нажатий.
  • Для TouchRelease: количество поднятий пальца (пера).
KeyboardModifiers int4 Маска кодов клавиш-модификаторов (например, Ctrl, Shift, Alt), которые были зажаты в момент события.
Полный список базовых кодов модификаторов приведён в разделе Комбинации модификаторов.
PointX float

Функция возвращает координату точки по оси X:

float PointX(uint4 idx)

Параметр idx указывает порядковый номер точки.

  • Для TouchMove, TouchPress: возвращает координату X точки нажатия.
  • Для TouchRelease: возвращает координату X точки поднятия пальца/пера.
PointY float

Функция возвращает координату точки по оси Y:

float PointY(uint4 idx)

Параметр idx указывает порядковый номер точки.

  • Для TouchMove, TouchPress: возвращает координату X точки нажатия.
  • Для TouchRelease: возвращает координату X точки поднятия пальца/пера.

Описание типа WheelEvent

Параметр event для события прокрутки является экземпляром типа WheelEvent. Описание типа WheelEvent и его особенности приведены в таблице ниже.

X float Локальная координата объекта по оси Х, в которой возникло событие.
Y float

Локальная координата объекта по оси Y, в которой возникло событие.

ScreenX float Глобальная координата по оси X относительно пространства мониторов.
ScreenY float Глобальная координата по оси Y относительно пространства мониторов.
Buttons int4 Маска кодов кнопок мыши, которые были зажаты в момент события прокрутки.
KeyboardModifiers int4

Маска кодов клавиш-модификаторов (например, Ctrl, Shift, Alt), которые были зажаты в момент события.
Полный список базовых кодов модификаторов приведён в разделе Комбинации модификаторов.

Delta int4

Расстояние прокрутки.

Положительное значение — прокрутка вверх, отрицательное — вниз. На стандартных мышах один шаг поворота колёсика равен 15 градусам, что соответствует Delta равным 120.

Описание типа KeyEvent

Параметр event для событий нажатия является экземпляром типа KeyEvent. Описание типа KeyEvent и его особенности приведены в таблице ниже.

KeyCode uint4

Код клавиши, которая была нажата в момент события. Полный список кодов клавиш приведён в разделе Коды клавиш.

При нажатии клавиши Enter записать текст из редактора текста в текстовое поле.

if (event.KeyCode == 82)
{Text_1.Text = TextEdit_1.Text;}
Modifiers int4

Маска кодов клавиш-модификаторов (например, Ctrl, Shift, Alt), которые были зажаты в момент события.
Полный список базовых кодов модификаторов приведён в разделе Комбинации модификаторов.

Repeated bool

Флаг удержания клавиши или сочетания любых клавиш. Не становится true при удержании клавиш-модификаторов: Ctrl, Alt, Shift

При удержании клавиши F5 записать текст из редактора текста в текстовое поле.

if (event.KeyCode == 55 && event.Repeated == true)
{Text_1.Text = TextEdit_1.Text;}
Text string Текст нажатой клавиши.