Alpha.Community

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

Пользовательская команда

Компонент позволяет хранить описание команды и сочетание "горячих" клавиш в одном месте. Реализован на базе компонента Команда.

Обработка горячих клавиш настраивается в событии KeyPress формы. Подробнее об этом событии можно прочитать в Справочном руководстве на Alpha.HMI → Экранные формы → События → KeyPress.

Пример использования в проекте

Пусть необходимо разработать приложение, в котором можно сохранить текст в файл несколькими способами: нажав кнопку на панели инструментов, выбрав пункт контекстного меню формы или нажав сочетание "горячих" клавиш. Для этих целей можно использовать экземпляр типа Пользовательская команда. Описание команды и "горячих" клавиш будут храниться в его свойствах, сохранение содержимого экземпляра типа Текст будет выполняться по активации обработчика события экземпляра этого типа. Экземпляр типа Пользовательская команда можно вызвать в обработчиках разных событий.

На главной форме проекта разместите экземпляры типов Кнопка панели инструментов и Текст. В качестве вспомогательных компонентов используйте экземпляры типов Прямоугольник, Изображение, Окружение: файлы и Пользовательская команда.

Тогда в рантайме приложение будет выглядеть так:

Создание пользовательской команды

Перенесите экземпляр типа Пользовательская команда из Библиотеки компонентов на форму. Экземпляр этого типа не отображается на форме и виден только в области Структура объекта. Теперь можно перейти к настройкам этого экземпляра типа.

В экземпляре типа Пользовательская команда:

  • в свойстве Описание укажите заголовок команды, который будет отображаться в контекстном меню;
  • в свойстве Сочетание клавиш укажите сочетание "горячих" клавиш, по нажатию которых можно вызвать команду. Значение этого свойства будет отображаться в контекстном меню справа от описания команды;
  • в обработчике события Invoked настройте сохранение содержимого экземпляра типа Текст в файл. Для этого можно использовать код, написанный на языке Alpha.Om:
    //сохранение в файл
    itemFile: string = FileSystem.CombinePath(FileSystem.ProjectFolder, "text.txt");
    FileSystem.WriteTextFile(itemFile, Text_ValveClosed.Text);

    В результате вызова этого обработчика события в переменную itemFile типа string будет записан путь к файлу text.txt, хранящемуся в папке output проекта. В этом файле сохранится содержимое экземпляра типа Текст.

    Если файла text.txt не существует в папке output, то он будет создан после первого исполнения кода.

Вызов нажатием кнопки на панели инструментов

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

  1. Добавьте на форму экземпляр типа Прямоугольник – он будет выступать в качестве панели инструментов.
  2. В экземпляре типа Прямоугольник разместите экземпляр типа Кнопка панели инструментов.

Чтобы по нажатию кнопки на панели инструментов вызвать команду, перейдите к обработчику события MouseClick экземпляра типа Кнопка панели инструментов. В этом обработчике используйте код, написанный на языке Alpha.Om:

UICommand_SaveFile.Invoke();

В результате будет активирована функция Invoke() экземпляра типа Пользовательская команда. Эта функция активирует обработчик события Invoked экземпляра типа Пользовательская команда, который сохранит содержимое экземпляра типа Текст в файл.

Вызов в контекстном меню

Команду можно вызвать в контекстном меню формы. В этом меню в качестве заголовка пункта меню и сочетания "горячих" клавиш используйте значения свойств экземпляра типа Пользовательская команда, а в качестве ссылки на команду, выполняемую при выборе пункта меню – ссылку на сам экземпляр типа Пользовательская команда.

Элементы меню задаются в виде JSON-массива. О структуре этого массива можно почитать в свойстве Элементы меню. Массив можно описать с помощью функции. Чтобы создать функцию, в контекстном меню формы выберите Создать функцию.

Ознакомьтесь с кодом созданной функции GetMenuItems(), написанным на языке JavaScript:

var items = [
{ 
 'id': "save",
 'title': UICommand_SaveFile.Description.Value,
 'keyGesture': UICommand_SaveFile.KeyGesture.Value
}
];
return JSON.stringify(items);

Чтобы контекстное меню открывалось по нажатию правой кнопки мыши на форме, перейдите к событию MouseRightClick этой формы. В обработчике этого события откройте экземпляр типа Меню в новом окне. Настройте свойства Меню:

  • в качестве начального значения свойства X окна используйте формулу here.ScreenX(here.MouseX,0);
  • в качестве начального значения свойства Y окна используйте формулу here.ScreenY(0,here.MouseY). Использование функций ScreenX и ScreenY позволяет открывать контекстное меню в месте щелчка правой кнопкой мыши на форме. Подробнее о функциях ScreenX и ScreenY можно почитать в документации на Alpha.HMI → Справочное руководство → Экранные формы → Функции;
  • в свойстве Элементы меню в виде формулы укажите ранее созданную функцию GetMenuItems();
  • в свойстве pAction укажите ссылку на экземпляр типа Пользовательская команда. Тогда по нажатию пункта меню будет активирован обработчик события Invoked этого экземпляра.

Вызов "горячими" клавишами

Команду можно вызвать по нажатию "горячих" клавиш. Пусть для сохранения содержимого экземпляра типа Текст в файл используется сочетание клавиш Ctrl+S.

Чтобы вызвать команду по нажатию этих "горячих" клавиш, перейдите к событию KeyPress формы. В обработчике этого события используйте код, написанный на языке Alpha.Om:

if (event.Modifiers == 0x4000000) // Ctrl
{
 if (event.KeyCode == 28) // S
 {
  UICommand_SaveFile.Invoke();
 }			
}

В результате по нажатию сочетания клавиш Ctrl+S будет активирована функция Invoke() экземпляра типа Пользовательская команда. Эта функция активирует обработчик события Invoked экземпляра типа Пользовательская команда, который сохранит содержимое экземпляра типа Текст в файл.