Alpha.Community

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

Функции

AddAcceptedFormat

Добавить тип данных в список разрешенных для приема.

Синтаксис

void AddAcceptedFormat(string userType)

Параметры

userType string

Cтроковый идентификатор типа данных, который разрешается принимать

Примеры

Разрешить прием данных типа tag и value.

DragDrop_1.AddAcceptedFormat("tag");
DragDrop_1.AddAcceptedFormat("value");

ResetAcceptedFormats

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

Синтаксис

void ResetAcceptedFormats()

SetText

Задать текстовое содержимое, которое будет передано при перетаскивании. Используется для передачи данных единым блоком. На стороне получателя данные извлекаются с помощью функции GetText().

Синтаксис

void SetText(string value)

Параметры

value string

Текстовое значение для передачи.

Примеры

Передать имя тега Tank_Level.PV.

DragDrop_1.SetText("Tank_Level.PV");
DragDrop_1.DoDragDrop();

SetHtml

Задать HTML-содержимое, которое будет передано при перетаскивании. Используется для передачи форматированного текста или HTML-разметки. На стороне получателя данные извлекаются с помощью функции GetHtml().

Синтаксис

void SetHtml(string value)

Параметры

value string

HTML-содержимое для передачи.

Примеры

Передать HTML-содержимое.

DragDrop_1.SetHtml("<b>Важное значение:</b> Tank_Level.PV");
DragDrop_1.DoDragDrop();

SetData

Задать данные с указанием их типа. Позволяет передавать несколько различных типов данных в рамках одного перетаскивания. Объект-получатель может выборочно принимать только нужные ему типы. На стороне получателя данные извлекаются с помощью функции GetData().

Синтаксис

void SetData(string type, string value)

Параметры

value string

Строковое значение данных.

type string Строковый идентификатор типа данных.

Примеры

Передать несколько типов данных.

DragDrop_1.SetData("tag", "Tank_Level.PV");
DragDrop_1.SetData("description", "Уровень в резервуаре");
DragDrop_1.SetData("units", "%");
DragDrop_1.DoDragDrop();

SetDataSize

Инициализирует массив бинарных данных указанного размера. Функция должна вызываться перед заполнением массива с помощью SetDataAt() или Append(). На стороне получателя размер массива можно получить с помощью функции GetDataSize().

Синтаксис

void SetDataSize(string type, uint4 size)

Параметры

type string

Строковый идентификатор типа данных.

size uint4 Размер массива (количество элементов).

Примеры

Создать массив из 10 байт.

DragDrop_1.SetDataSize("binaryData", 10);

SetDataAt

Записать байтовое значение в указанную позицию массива. Массив должен быть предварительно инициализирован с помощью SetDataSize(). На стороне получателя значения извлекаются с помощью функции GetDataAt().

Синтаксис

void SetDataAt(string type, uint4 idx, uint1 value)

Параметры

type string

Строковый идентификатор типа данных.

idx uint4 Индекс элемента в массиве (начиная с 0).
value uint1 Байтовое значение (0-255).

Примеры

Заполнить массив значениями.

DragDrop_1.SetDataSize("measurements", 3);
DragDrop_1.SetDataAt("measurements", 0, 100);
DragDrop_1.SetDataAt("measurements", 1, 150);
DragDrop_1.SetDataAt("measurements", 2, 200);
DragDrop_1.DoDragDrop();

Append

Добавляет новый элемент в конец массива бинарных данных. Если массив не существует, он создается автоматически.

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

Синтаксис

void Append(string type, uint1 value)

Параметры

type string

Строковый идентификатор типа данных.

value uint1 Байтовое значение (0-255).

Примеры

Последовательно добавить значения в массив

DragDrop_1.Append("sensorData", 85);
DragDrop_1.Append("sensorData", 92);
DragDrop_1.Append("sensorData", 78);
DragDrop_1.DoDragDrop();

Clear

Очистить все содержимое элемента Перемещение.

Синтаксис

void Clear()

Примеры

Очистить все данные перед установкой новых

DragDrop_1.Clear();
DragDrop_1.SetText("Новые данные");
DragDrop_1.DoDragDrop();

DoDragDrop

Инициирует операцию перетаскивания с данными, которые были предварительно установлены с помощью функций SetText(), SetHtml(), SetData(), SetDataAt() или Append(). Функция должна вызываться в обработчике события MousePress объекта-отправителя (или ItemPressed для элемента Дерево) сразу после установки передаваемых данных.

Синтаксис

void DoDragDrop()

Примеры

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

// В обработчике события MousePress
DragDrop_1.SetText("Передаваемые данные");
DragDrop_1.DoDragDrop(); // Запустить перетаскивание