Класс ‘Dictionary’

almaGRID API

Именованный список. Универсальная коллекция пар «ключ» — «значение».

Свойства #

Count #

Описание
Количество элементов, содержащихся в словаре.

Count   : Integer 

Значение свойства (ReadOnly)
Тип: Integer
Количество элементов.

dict.Count

almaGRID API

Item #

Описание
Значение по указанному ключу.

Item  ( Key  String  ) : Variant 

Значение свойства
Тип: Variant
Значение.

Параметры

d1 = dict.Item("Key1")
d1 = dict("Key1")

almaGRID API

Keys #

Описание
Создает копию списка ключей элементов словаря.

Keys   : List 

Значение свойства (ReadOnly)
Тип: List
Список ключей.

'выводим все ключи и значения элементов словаря
sk = ""
sv = ""
for each key in dict.Keys
	sk = sk & key & " "
	sv = sv & dict(key) & " "
next
ag.app.MsgBox sk & Chr(13) & sv

almaGRID API

Values #

Описание
Создает копию списка значений элементов словаря.

Values   : List 

Значение свойства (ReadOnly)
Тип: List
Список значений.

'выводим все значения элементов словаря
sv = ""
for each value in dict.Values
	sv = sv & value & " "
next
ag.app.MsgBox sv

almaGRID API

Методы #

Add #

Описание
Добавляет элемент с заданным ключом и значением в словарь. Если ключ присутствует в словаре, то обновляет соответствующее значение.

Add  ( Key  String , Value  Variant  )

Параметры

dict.Add "dog", 5

almaGRID API

AddRange #

Поддержка в версии: старше или равно 34.24.2.0.

Описание
Добавляет к данному словарю элементы из другого словаря, если они там отсутствуют.

AddRange  ( Dict  Dictionary  ) : Dictionary 

Возвращаемое значение
Тип: Dictionary
Данный словарь после добавления к нему новых элементов.

Параметры

dict1.AddRange dict2

set StyleTableHeader = ag.app.NewObject("Dictionary").AddRange(StyleTableBody)
StyleTableHeader.Add "Body", "AliceBlue"

almaGRID API

Clear #

Описание
Удаляет все элементы словаря.

Clear  

dict.Clear

almaGRID API

ContainsKey #

Описание
Определяет, находится ли ключ в словаре.

ContainsKey  ( Key  String  ) : Boolean 

Возвращаемое значение
Тип: Boolean
True, если ключ найден в словаре; в противном случае False.

Параметры

ag.app.MsgBox dict.ContainsKey("cat")

almaGRID API

ContainsValue #

Описание
Определяет, находится ли значение в словаре.

ContainsValue  ( Value  Variant  ) : Boolean 

Возвращаемое значение
Тип: Boolean
True, если значение найдено в словаре; в противном случае False.

Параметры

ag.app.MsgBox dict.ContainsValue(23.4)

almaGRID API

Remove #

Описание
Удаляет из словаря элемент с заданным ключом.

Remove  ( Key  String  ) : Boolean 

Возвращаемое значение
Тип: Boolean
True, если элемент успешно удален; в противном случае False. Этот метод также возвращает False, если элемент не найден в словаре.

Параметры

ag.app.MsgBox dict.Remove("cat")

almaGRID API

ToStr #

Описание
Строковое представление словаря.

ToStr   : String 

Возвращаемое значение
Тип: String
Строка - результат склейки пар 'Ключ' - 'Значение'.

ag.app.MsgBox dict.ToStr

almaGRID API

Пример #

Пример использования ‘Dictionary’ #

VBScript

'создаем пустой словарь
Set dict = ag.app.NewObject("Dictionary")

'добавляем к словарю элементы
'список может содержать элементы любых типов 
dict.Add "dog", 5
dict.Add "cat", 2.5
dict.Add "horse", 220
dict.Add "elephant", 550
dict.Add "crocodile", 345

'также можно записать
'Set dict = ag.app.NewObject("Dictionary", Array("dog", 5, "cat", 2.5, "horse", 220, "elephant", 550, "crocodile", 345))

'выводим первый и последний элемент словаря (пару ключ-значение)
ag.app.MsgBox dict.Keys.Item(0) & " - " & dict.Values.Item(0) & Chr(13) & _
       dict.Keys.Item(dict.Count-1) & " - " & dict.Values.Item(dict.Count-1)
'-> dog - 5 
'   crocodile - 345

'изменяем значение элемента с ключом "elephant"
dict("elephant") = 620

'выводим все ключи и значения элементов словаря
sk = ""
sv = ""
for each key in dict.Keys
	sk = sk & key & " "
	sv = sv & dict(key) & " "
next
ag.app.MsgBox sk & Chr(13) & sv
'-> dog cat horse elephant crocodile 
'   5 2.5 220 620 345

'удаляем элемент
dict.Remove("cat")

'проверяем, присутствует ли в словаре элемент с ключом "cat"
ag.app.MsgBox dict.ContainsKey("cat")
'-> False

'проверяем, присутствует ли в словаре элемент со значением 2.5
ag.app.MsgBox dict.ContainsValue(2.5)
'-> False

'очищаем словарь
dict.Clear
ag.app.MsgBox dict.Count
'-> 0