Alpha.Community

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

Функции

AddTab

Создает новую вкладку с указанным текстом и добавляет её в конец панели вкладок (после всех существующих вкладок).

Синтаксис

int4 AddTab(string text)

Параметры

text string Текст, который будет отображаться на заголовке вкладки.

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

int4 Числовой индекс (позиция) добавленной вкладки в панели. Нумерация начинается с 0.

Примеры

Создать новую вкладку с текстом Мои документы и сохранить её индекс в переменную.

docTabIndex: int4  = TabBar_1.AddTab("Мои документы");

InsertTab

Создает новую вкладку с указанным текстом и вставляет её в конкретную позицию среди существующих вкладок. Все вкладки, находящиеся на указанной позиции и после неё, сдвигаются вправо.

Синтаксис

int4 InsertTab(int4 index, string text)

Параметры

index int4 Позиция, куда необходимо вставить новую вкладку (нумерация с 0).
text string Текст, который будет отображаться на заголовке вкладки.

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

int4 Числовой индекс вставленной вкладки (равен переданному параметру index).

Примеры

Вставить вкладку Alarms на вторую позицию (индекс 1).

urgentIndex: int4  = TabBar_1.InsertTab(1, "Alarms");

RemoveTab

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

Синтаксис

void RemoveTab(int4 index)

Параметры

index int4 Индекс удаляемой вкладки (нумерация с 0).

Примеры

Удалить третью вкладку (с индексом 2).

TabBar_1.RemoveTab(2);

GetTabText

Возвращает текст, отображаемый на заголовке вкладки с указанным индексом.

Синтаксис

string GetTabText(int4 index)

Параметры

index int4 Индекс вкладки, текст которой нужно получить.

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

string Текст заголовка вкладки, или пустая строка "", если индекс некорректен.

Примеры

Получить текст первой вкладки и вывести его в журнал.

firstTabText: string = TabBar_1.GetTabText(0);
DebugTool_1.Log("Текст первой вкладки: " + firstTabText);

SetTabText

Изменяет текст заголовка существующей вкладки на новый.

Синтаксис

void SetTabText(int4 index, string text)

Параметры

index int4 Индекс вкладки, текст которой нужно изменить.
text string Новый текст для отображения на заголовке вкладки.

Примеры

Заменить текст первой вкладки на Главная

TabBar_1.SetTabText(0, "Главная");

GetTabIconPath

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

Синтаксис

string GetTabIconPath(int4 index)

Параметры

index int4 Индекс вкладки, путь к иконке которой нужно получить

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

string Полный путь к файлу иконки, или пустая строка "", если иконка не установлена или индекс некорректен.

Примеры

Проверить, есть ли иконка у первой вкладки, и вывести результат.

iconPath: string = TabBar_1.GetTabIconPath(0);
if (iconPath != "") {
ㅤㅤText_1.Text = "Иконка установлена: " + iconPath;
} else {
ㅤㅤText_1.Text = "Иконка не установлена";
}

SetTabIconPath

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

Синтаксис

void SetTabIconPath(int4 index, string iconPath)

Параметры

index int4 Индекс вкладки, для которой устанавливается иконка.
iconPath string Путь к файлу изображения иконки.

Примеры

Установить иконку home.png для первой вкладки и удалить иконку у третьей.

TabBar_1.SetTabIconPath(0, "home.png");
TabBar_1.SetTabIconPath(2, "");

GetTabToolTip

Возвращает текст всплывающей подсказки, которая появляется при наведении курсора мыши на вкладку с указанным индексом.

Синтаксис

string GetTabToolTip(int4 index)

Параметры

index int4 Индекс вкладки, подсказку которой нужно получить

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

string Текст всплывающей подсказки, или пустая строка "" если подсказка не установлена или индекс некорректен.

Примеры

Получить подсказку второй вкладки и отобразить в текстовом поле.

tooltip: string  = TabBar_1.GetTabToolTip(1);
Text_1.Text = "Подсказка: " + tooltip;

SetTabToolTip

Устанавливает текст всплывающей подсказки, которая будет отображаться при наведении курсора мыши на заголовок вкладки.

Синтаксис

void SetTabToolTip(int4 index, string toolTip)

Параметры

index int4 Индекс вкладки, для которой устанавливается подсказка.
toolTip string Текст всплывающей подсказки.

Примеры

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

TabBar_1.SetTabToolTip(1, "Текущие технологические параметры\nОбновление данных каждые 2 секунды");

GetTabVisible

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

Синтаксис

bool GetTabVisible(int4 index)

Параметры

index int4 Индекс вкладки, видимость которой нужно проверить.

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

bool true если вкладка видна пользователю, false если скрыта или индекс некорректен.

Примеры

Проверить, видима ли третья вкладка, и вывести результат в текстовое поле.

isVisible: bool = TabBar_1.GetTabVisible(2);
if (isVisible) {
ㅤㅤText_1.Text = "Третья вкладка отображается";
} else {
ㅤㅤText_1.Text = "Третья вкладка скрыта";
}

SetTabVisible

Управляет отображением вкладки с указанным индексом - показывает или скрывает её от пользователя.

Синтаксис

void SetTabVisible(int4 index, bool visible)

Параметры

index int4 Индекс вкладки, видимость которой нужно изменить.
visible bool true для отображения вкладки, false для скрытия.

Примеры

Скрыть третью вкладку.

TabBar_1.SetTabVisible(2, false);