almaGRID APIНабор тегов.
Методы #
Add #
Overview
Добавляет тег или правило выбора его дочерних тегов к набору.
Add ( TagPathOrId String , [TagLabel String = '' ], [ChildLevel Integer = 0 ], [Selector String = '' ] ) : Boolean
Возвращаемое значение
Тип: Boolean
True, если тег к набору добавлен успешно и False в противном случае.
Параметры
| TagPathOrId | String | Путь тега TagPath, идентификатор TagId или ''(пустая строка).
|
| TagLabel | String | Необязательный параметр. Значение по умолчанию '' . Название тега на текущем языке, например, 'Тег1'. Если задан TagPathOrId, то TagLabel игнорируется. |
| ChildLevel | Integer | Необязательный параметр. Значение по умолчанию 0 . Количество дочерних уровней по дереву тегов. Для первого дочернего уровня относительно TagPath значение ChildLevel=1.
|
| Selector | String | Необязательный параметр. Значение по умолчанию '' . Селектор отбора тегов с дочерних уровней: 'LastOne' - теги на ChildLevel дочернем уровне. 'LastTwo' - теги, представленные путями от ChildLevel-1 до ChildLevel дочернего уровня. 'LastThree' - теги, представленные путями от ChildLevel-2 до ChildLevel дочернего уровня. 'LastFour' - теги, представленные путями от ChildLevel-3 до ChildLevel дочернего уровня. 'LastFive' - теги, представленные путями от ChildLevel-4 до ChildLevel дочернего уровня. 'EndOne' - теги, завершающие ветви дерева тегов и являющиеся потомками узла TagPath не более, чем на ChildLevel уровне. 'EndOrLastOne' - теги на ChildLevel дочернем уровне, или теги, завершающие ветви дерева тегов и являющиеся потомками узла TagPath не более, чем на ChildLevel уровне. 'AnyOne' - любой потомок узла TagPath до уровня ChildLevel. 'ArrowLastOne' - теги на ChildLevel дочернем уровне, к пути которых добавлен префикс '=>' (признак конца дуги). 'ArrowEndOrLastOne' - теги, отвечающие условиям селектора EndOrLastOne, к путям которых добавлен префикс '=>' (признак конца дуги). 'ArrowAnyOne' - любой потомок узла TagPath до уровня ChildLevel, к пути которого добавлен префикс '=>' (признак конца дуги).
|
Комментарии
Оба параметра ChildLevel и Selector должны быть или заданы или отсутствовать.
Если заданы параметры ChildLevel и Selector, то TagPath должен быть уникальным в дереве тегов.
Set ts1 = ag.app.NewObject("TagSet")
ts1.Add BaseTagPath, "", 10, "AnyOne"
ts1.Add BaseTagPath, "", 10, "ArrowAnyOne"
ts1.Add "a123"AddRange #
Поддержка в версии: старше или равно 34.24.03.32.
Overview
Добавляет к коллекции теги по их идентификаторам.
AddRange ( TagPathOrIds Array ) : TagSet
Возвращаемое значение
Тип: TagSet
Этот набор тегов после выполнения операции или null.
Параметры
| TagPathOrIds | Array | Массив String путей тега TagPath или идентификаторов TagId.
|
ts1.AddRange Array("a123", "b456")Ids #
Overview
Возвращает список строк TagId тегов, находящихся в коллекции.
Ids ( [Index Integer = -1 ] ) : List
Возвращаемое значение
Тип: List
Список строк TagId.
Параметры
| Index | Integer | Необязательный параметр. Значение по умолчанию -1 . Индекс TagId в TagPath. Первый TagId имеет индекс 0. Если Index отрицательный, то отсчет ведется от конца TagPath. Последний TagId имеет индекс -1.
|
'создает список TagId, находящихся в последней позиции TagPath коллекции ts1 Set Ids = ts1.Ids 'создает список TagId, находящихся в предпоследней позиции TagPath коллекции ts1 Set Ids = ts1.Ids(-2)
Insert #
Поддержка в версии: старше или равно 34.24.03.29.
Overview
Добавляет тег в указанную позицию набора.
Insert ( Index Integer , TagPath String , [TagLabel String = '' ] ) : TagSet
Возвращаемое значение
Тип: TagSet
Этот набор тегов после выполнения операции или null.
Параметры
| Index | Integer | Позиция, в которую будет добавлен список.
|
| TagPath | String | Путь к тегу в дереве тегов. Состоит из одного или последовательности нескольих TagId, разделенных символом 's'. Начинается и завершается символом 's'. Например, 'sb123sb456s'.
|
| TagLabel | String | Необязательный параметр. Значение по умолчанию '' . Название тега на текущем языке, например, 'Тег1'. Если задан TagPath, то TagLabel игнорируется. |
ts1.Insert 0, ""
Labels #
Поддержка в версии: старше или равно 34.24.03.29.
Overview
Возвращает список строк TagLabel тегов, находящихся в коллекции.
Labels : List
Возвращаемое значение
Тип: List
Список строк TagLabel.
Set Labels = ts1.Labels
Paths #
Overview
Возвращает список строк TagPath тегов, находящихся в коллекции.
Paths : List
Возвращаемое значение
Тип: List
Список строк TagPath.
Set Paths = ts1.Paths
RemoveRange #
Поддержка в версии: старше или равно 34.24.03.32.
Overview
Удаляет из коллекции теги по их идентификаторам.
RemoveRange ( TagPathOrIds Array ) : TagSet
Возвращаемое значение
Тип: TagSet
Этот набор тегов после выполнения операции или null.
Параметры
| TagPathOrIds | Array | Массив String путей тега TagPath или идентификаторов TagId. Если в коллекции отсутствует заданный тег, то удаление такого тега игнорируется.
|
ts1.RemoveRange Array("a123", "b456")Sort #
Overview
Сортирует теги по названию.
Sort ( [Reverse Boolean = False ] ) : TagSet
Возвращаемое значение
Тип: TagSet
Этот набор тегов после сортировки.
Параметры
| Reverse | Boolean | Необязательный параметр. Значение по умолчанию False . Порядок сортировки. Если True то сортировка от большего меньшему.
|
ts1.Sort set ts2 = ts1.Sort
