Alpha.Community

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

Функции

Shot

Сделать снимок всего рабочего пространства (всех подключенных мониторов) во внутренний буфер Alpha.HMI. Для сохранения снимка из буфера используйте функцию Save().

Синтаксис

bool Shot();

Возвращаемое значение

true Снимок успешно сделан во внутренний буфер Alpha.HMI.
false Возникла ошибка при создании снимка экрана.

Примеры

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

if (Screenshot_1.Shot()) 
{
Text_1.Text = "Снимок экрана выполнен успешно.";
}
else
{
Text_1.Text = "Ошибка при выполнении снимка экрана.";
}

ShotRegion

Сделать снимок заданной прямоугольной области рабочего пространства (может пересекать несколько мониторов) во внутренний буфер Alpha.HMI. Для сохранения снимка из буфера используйте функцию Save().

Синтаксис

bool ShotRegion(int4 x, int4 y, int4 width, int4 height);

Параметры

x int4

Горизонтальная координата верхнего левого угла области (в пикселях).

  • Положительное значение — правее левого края основного монитора;
  • Отрицательное значение — левее левого края основного монитора.
y int4

Вертикальная координата верхнего левого угла области (в пикселях).

  • Положительное значение — ниже верхнего края основного монитора;
  • Отрицательное значение — выше верхнего края основного монитора.
width int4 Ширина области (в пикселях).
height int4 Высота области (в пикселях).

Возвращаемое значение

true Снимок успешно сделан во внутренний буфер Alpha.HMI.
false Возникла ошибка при создании снимка экрана.

Примеры

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

if (Screenshot_1.ShotRegion(100, 100, 400, 300))
{
Text_1.Text = "Снимок области рабочего пространства выполнен успешно.";
}
else
{
Text_1.Text = "Ошибка при выполнении снимка области.";
}

Сделать снимок области рабочего пространства, захватывающей часть левого монитора и основного монитора, и вывести результат выполнения в текстовое поле:

// Захватить область размером 800x600 пикселей:
// - Начало: на 500 пикселей ЛЕВЕЕ основного монитора (x = -500),
// на 100 пикселей НИЖЕ верхнего края основного монитора (y = 100).
// Это полезно, если слева от основного монитора подключен второй монитор.
if (Screenshot_1.ShotRegion(-500, 100, 800, 600))
{
Text_1.Text = "Область захвачена успешно!";
// Теперь можно сохранить снимок:
Screenshot_1.Save("C:\\Users\\username\\Desktop\\screenshot.png");
}
else
{
Text_1.Text = "Ошибка: область вне рабочего пространства.";
}

ShotMonitor

Сделать снимок всего экрана определённого монитора во внутренний буфер Alpha.HMI. Для сохранения снимка из буфера используйте функцию Save().

Синтаксис

bool ShotMonitor(int4 number);

Параметры

number int4 Индекс монитора.

Нумерация мониторов начинается с 0 (где 0 — это крайний левый верхний монитор) и не зависит от нумерации мониторов в операционной системе. Направление нумерации происходит «слева-направо» и «сверху-вниз».

Возвращаемое значение

true Снимок успешно сделан во внутренний буфер Alpha.HMI.
false Возникла ошибка при создании снимка экрана.

Примеры

Сделать снимок экрана второго монитора во внутренний буфер и вывести результат в текстовое поле:

if (Screenshot_1.ShotMonitor(1))
{
Text_1.Text = "Снимок второго монитора выполнен успешно.";
}
else
{
Text_1.Text = "Ошибка при выполнении снимка монитора.");
}

ShotMonitorRegion

Сделать снимок заданной области на определённом мониторе во внутренний буфер Alpha.HMI. Для сохранения снимка из буфера используйте функцию Save().

Синтаксис

bool ShotMonitorRegion( int4 number, int4 x, int4 y, int4 width, int4 height );

Параметры

number int4 Индекс монитора.

Нумерация мониторов начинается с 0 (где 0 — это крайний левый верхний монитор) и не зависит от нумерации мониторов в операционной системе. Направление нумерации происходит «слева-направо» и «сверху-вниз».

x int4 Координата верхнего левого угла области на выбранном мониторе по оси X (в пикселях).
y int4 Координата верхнего левого угла области на выбранном мониторе по оси Y (в пикселях).
width int4 Ширина области (в пикселях).
height int4 Высота области (в пикселях).

Возвращаемое значение

true Снимок успешно сделан во внутренний буфер Alpha.HMI.
false Возникла ошибка при создании снимка экрана.

Примеры

Сделать снимок области экрана второго монитора во внутренний буфер и вывести результат в текстовое поле:

if (Screenshot_1.ShotMonitorRegion(1, 100, 100, 400, 300))
{
Text_1.Text = "Снимок области экрана выполнен успешно.";
}
else
{
Text_1.Text = "Ошибка при выполнении снимка области.";
}

Save

Сохраняет текущий снимок из внутреннего буфера Alpha.HMI в указанный файл.

Синтаксис

bool Save( string path )

Параметры

path string Полный путь к файлу, включая его имя и расширение (например, *.bmp, *.jpg, *.png). Если файл с таким именем уже существует, он будет перезаписан.

Возвращаемое значение

true Снимок успешно сохранён в указанный файл.
false Возникла ошибка при сохранении снимка в файл.

Примеры

Сохранить снимок экрана из внутреннего буфера в указанный файл и вывести результат в текстовое поле:

Screenshot_1.Shot();
if (Screenshot_1.Save("C:\\Users\\username\\Desktop\\screenshot.png"))
{
Text_1.Text = "Снимок успешно сохранён в файл.";
}
else
{
Text_1.Text = "Ошибка при сохранении снимка.";
}

Clear

Очистить внутренний буфер Alpha.HMI.

Синтаксис

void Clear();

Примеры

Очистить внутренний буфер и вывести сообщение в текстовое поле:

Screenshot_1.Clear();
Text_1.Text = "Внутренний буфер очищен.";