StrategyParameterLabel – описание и примеры использования в OsEngine.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Теперь мы можем увидеть ее в таблице параметров:

Рис. 2. Отображение StrategyParameterLabel в таблице параметров.

Слева в строке выводится значение Label из параметра, справа значение Value.