Надпись в окне параметров. StrategyParameterLabel. Параметры робота #8

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

Расположение в репозитории ГитХаб: https://github.com/AlexWan/OsEngine/blob/master/project/OsEngine/Entity/StrategyParameter.cs

Расположение в проекте, если отрыть его на ПК:

Сам класс выглядит следующим образом:

Состоит из следующих членов:

StrategyParameterLabel – общедоступный конструктор с параметрами инициализирует начальное состояние объекта. Принимает следующие данные:

name – название для экземпляра, используемое в коде программы;
label – отображаемое название для ярлыка;
value – отображаемое значение ярлыка;
rowHeight – высота строки с данным параметром;
textHeight – высота текста в строке с параметром;
color – цвет отображаемого текста;
tabName – имя вкладки, на которой должен отображаться параметр;

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

Label – публичное поле типа string. Содержит значение, отображаемое в левой части строки с параметром.

Value – публичное поле типа string. Содержит основное значение параметра, отображаемое в правой части строки.

RowHeight – публичное поле типа int. Хранит значение для высоты строки, в которой отображается параметр.

TextHeight – публичное поле типа int. Хранит значение для высоты шрифта, которым отображаются данные из параметра.

Color – публичное поле типа Color. Задает цвет отображаемого текста.

Type – публичное свойство типа StrategyParameterType. Возвращает значение StrategyParameterType.Label.

TabName – публичное свойство типа string. Предоставляет доступ к имени вкладки, на которой будет отображаться параметр в окне параметров.

ValueChange – общедоступное событие. Не несет функциональной нагрузки, требуется для соответствия интерфейсу.

GetStringToSave – общедоступный метод. Возвращает строку с настройками объекта параметра для сохранения.

LoadParamFromString – общедоступный метод. Принимает массив строк с настройками для параметра и инициализирует состояние объекта.

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

Как правило, StrategyParameterLabel применяется для вывода дополнительной информации в окне параметров, например, пояснений, либо визуального разграничения между другими параметрами в таблице. Метка не несет никакой функциональности, которая может понадобиться алгоритму робота, поэтому мы можем создать ее при помощи метода CreateParameterLabel без сохранения возвращаемого значения в переменной.