Класс 'List' • Графовые модели

Свойства #

Count #

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

Count : Integer

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

VBScript

ag.MsgBox lst1.Count

almaGRID API

First #

Overview
Возвращает первый элемент списка.

First : Variant

Значение свойства (ReadOnly)
Тип: Variant
Элемент списка.

VBScript

ag.MsgBox lst1.First

almaGRID API

Item #

Overview
Возвращает или устанавливает элемент по указанному индексу. Индекс первого элемента - 0.

Item  ( Index  Integer  ) : Variant

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

Параметры

Index 

Integer

Отсчитываемый от нуля индекс списка.

VBScript

lst1(0) = 12
lst1.Item(0) = 12
ag.MsgBox lst1(lst1.Count-1)

almaGRID API

Last #

Overview
Возвращает последний элемент списка.

Last : Variant

Значение свойства (ReadOnly)
Тип: Variant
Элемент списка.

VBScript

ag.MsgBox lst1.Last

almaGRID API

Методы #

Add #

Overview
Добавляет объект в список.

Add  ( Value  Variant  )

Параметры

Value 

Variant

Значение элемента.

VBScript

lst1.Add "dog"

almaGRID API

AddRange #

Overview
Добавляет элементы одного списка в другой.

AddRange  ( Lst  List  ) : List

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

Параметры

Lst

List

Добавляемый список.

VBScript

list1.AddRange list2

set lst1 = ag.app.NewObject("List", Array(2,3,4))
set lst2 = ag.app.NewObject("List", Array(4,5,6)).AddRange(lst1)
ag.MsgBox ag.app.Stringify(lst2)

almaGRID API

Clear #

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

Clear

VBScript

lst1.Clear

almaGRID API

Contains #

Overview
Определяет, находится ли элемент в списке.

Contains  ( Value  Variant  ) : Boolean

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

Параметры

Value 

Variant

Значение элемента.

VBScript

ag.MsgBox lst1.Contains("tiger")

almaGRID API

Except #

Overview
Исключает из списка элементы заданного списка.

Except  ( Lst  List  ) : List

Возвращаемое значение
Тип: List
Список, результат исключения элементов заданного списка.

Параметры

Lst

List

Список, элементы которого будут исключены.

VBScript

set lst3 = lst1.Except(lst2)

almaGRID API

GetRange #

Overview
Создает копию диапазона элементов списка.

GetRange  ( Index  Integer , Count  Integer  ) : List

Возвращаемое значение
Тип: List
Коллекция List элементов диапазона списка.

Параметры

Index	Integer	Отсчитываемый от нуля индекс списка, с которого начинается диапазон.
Count	Integer	Количество элементов в диапазоне.

VBScript

set lst2 = lst1.GetRange(2, 3)

almaGRID API

IndexOf #

Overview
Возвращает отсчитываемый от нуля индекс первого вхождения значения в список.

IndexOf  ( Value  Variant  ) : Integer

Возвращаемое значение
Тип: Integer
Отсчитываемый от нуля индекс первого вхождения значения в список.

Параметры

Value 

Variant

Значение элемента.

VBScript

ag.MsgBox lst2.IndexOf("bird")

almaGRID API

Insert #

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

Overview
Добавляет элемент с указанным значением в указанную позицию списка.

Insert  ( Index  Integer , Value  Variant  ) : List

Возвращаемое значение
Тип: List
Этот список после добавления элемента.

Параметры

Index	Integer	Позиция в списке, в которую будет добавлен элемент.
Value	Variant	Значение элемента.

VBScript

lst1.Insert 0, "dog"
set lst2 = lst1.Insert(0, "dog").Intersect(lst3)

almaGRID API

InsertRange #

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

Overview
Добавляет список элементов в указанную позицию.

InsertRange  ( Index  Integer , Lst  List  ) : List

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

Параметры

Index	Integer	Позиция, в которую будет добавлен список.
Lst	List	Добавляемый список.

VBScript

lst1.Insert 0, lst0
set lst2 = lst1.Insert(0, lst0).Intersect(lst3)

almaGRID API

Intersect #

Overview
Пересечение списка с заданным списком.

Intersect  ( Lst  List  ) : List

Возвращаемое значение
Тип: List
Список, результат пересечения с заданным списком.

Параметры

Lst

List

Список, с которым будет выполнено пересечение.

VBScript

set lst3 = lst1.Intersect(lst2)

almaGRID API

Remove #

Overview
Удаляет первое вхождение определенного элемента из списка.

Remove  ( Value  Variant  ) : Boolean

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

Параметры

Value 

Variant

Значение элемента.

VBScript

ag.MsgBox lst1.Remove("crocodile")

almaGRID API

RemoveAt #

Overview
Удаляет элемент по указанному индексу в списке. Индекс начинается с нуля.

RemoveAt  ( Index  Integer  ) : List

Возвращаемое значение
Тип: List
Этот список после удаления элемента.

Параметры

Index 

Integer

Отсчитываемый от нуля индекс удаляемого элемента.

VBScript

lst1.RemoveAt(2)

almaGRID API

RemoveRange #

Overview
Удаляет диапазон элементов из списка.

RemoveRange  ( LstOrIndex  Variant , [Count  Integer  = 0 ] ) : List

Возвращаемое значение
Тип: List
Этот список после удаления элементов.

Параметры

LstOrIndex 

Variant

Список удаляемых элементов List или отсчитываемый от нуля индекс списка, с которого начинается удаляемый диапазон.

Count 

Integer

Необязательный параметр. Значение по умолчанию 0 .

Количество элементов в удаляемом диапазоне. Не указывается, если в параметре LstOrIndex передан List.

VBScript

lst2.RemoveRange 0, 2
lst2.RemoveRange lst1

almaGRID API

SelectByField #

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

Overview
Возвращает элементы, представленные именованными списками Dictionary по значению указанного поля.

SelectByField  ( FieldName  String , ExactValueOrMinValue  Variant , [MaxValue  Variant  = null ], [ExcludeMaxValue  Boolean  = False ] ) : List

Возвращаемое значение
Тип: List
Cписок выбранных элементов.

Параметры

FieldName	String	Поле именованного списка, по значению которого выполняется отбор.
ExactValueOrMinValue	Variant	Значение поля FieldName выбираемых элементов или нижняя граница (включительно) диапазона значений поля FieldName выбираемых элементов.
MaxValue	Variant	Необязательный параметр. Значение по умолчанию null . Верхняя граница диапазона значений поля FieldName выбираемых элементов.
ExcludeMaxValue	Boolean	Необязательный параметр. Значение по умолчанию False . Если False, то верхняя граница диапазона значений поля FieldName включена в условия отбора.

VBScript

set Order01 = ag.app.NewObject("Dictionary", Array("RequestedStartTime", CDate("2023-01-01 12:00:00"), "Priority", 5))
set Order02 = ag.app.NewObject("Dictionary", Array("RequestedStartTime", CDate("2023-01-01 13:00:00"), "Priority", 5))
set Order03 = ag.app.NewObject("Dictionary", Array("RequestedStartTime", CDate("2023-01-01 13:00:04"), "Priority", 5))
set Order04 = ag.app.NewObject("Dictionary", Array("RequestedStartTime", CDate("2023-01-01 13:00:02"), "Priority", 9))
set Order05 = ag.app.NewObject("Dictionary", Array("RequestedStartTime", CDate("2023-01-01 13:00:01"), "Priority", 5))

set OrderList = ag.app.NewObject("List", Array(Order01, Order02, Order03, Order04, Order05))

Time1 = CDate("2023-01-01 13:00")
set lst = OrderList.SelectByField("RequestedStartTime", Time1, DateAdd("s", 10, Time1))
lst.SortByField "Priority", True

lst.Remove Order02

ag.MsgBox ag.app.Stringify(lst)

almaGRID API

Sort #

Overview
Сортирует элементы списка.

Sort  ( [Reverse  Boolean  = False ] ) : List

Возвращаемое значение
Тип: List
Этот список после сортировки.

Параметры

Reverse 

Boolean

Необязательный параметр. Значение по умолчанию False .

Порядок сортировки. Если True то сортировка от большего меньшему.

VBScript

lst2.Sort

almaGRID API

SortByField #

Overview
Сортирует элементы списка.

SortByField  ( FieldName  String , [Reverse  Boolean  = False ] ) : List

Возвращаемое значение
Тип: List
Этот список после сортировки.

Параметры

FieldName 

String

Поле именованного списка, по значению которого выполняется сортировка.

Reverse 

Boolean

Необязательный параметр. Значение по умолчанию False .

Порядок сортировки. Если True то сортировка от большего меньшему.

VBScript

Res.SortByField "Delta", False

almaGRID API

ToArray #

Overview
Создает свою копию в виде массива.

ToArray : Array

Возвращаемое значение
Тип: Array
Массив значений элементов списка.

VBScript

arr = Res.ToArray

almaGRID API

ToArrayList #

Overview
Создает свою копию в виде коллекции System.Collections.ArrayList.

ToArrayList : System.Collections.ArrayList

Возвращаемое значение
Тип: System.Collections.ArrayList
Коллекция.

VBScript

Set AL = Res.ToArrayList

almaGRID API

ToTagSet #

Overview
Создает свою копию в виде коллекции TagSet. Все значения элементов преобразуются к типу String.

ToTagSet : TagSet

Возвращаемое значение
Тип: TagSet
Коллекция.

VBScript

Set ts = Res.ToTagSet

almaGRID API

Union #

Overview
Объединяет список с заданным списком.

Union  ( Lst  List  ) : List

Возвращаемое значение
Тип: List
Список, результат объединения с заданным списком.

Параметры

Lst

List

Список, с которым будет выполнено объединение.

VBScript

set lst3 = lst1.Union(lst2)

almaGRID API

Пример #

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

VBScript

'создаем пустой список
Set lst1 = ag.app.NewObject("List")

'добавляем к списку строковые элементы
'список может содержать элементы любых типов 
lst1.Add "dog"
lst1.Add "cat"
lst1.Add "horse"
lst1.Add "elephant"
lst1.Add "crocodile"

'выводим первый и последний элемент списка
ag.MsgBox lst1(0) & " " & lst1(lst1.Count-1)
'-> dog crocodile

'проверяем, содержит ли список элемент "tiger"
ag.MsgBox lst1.Contains("tiger")
'-> False

'сортируем список
lst1.Sort

'выполняем итерацию по элементам списка
s = ""
for each item in lst1
	s = s & item & " "
next
ag.MsgBox s
'-> cat crocodile dog elephant horse

'получаем диапазон элементов списка
set lst2 = lst1.GetRange(2, 3)
s = ""
for each item in lst2
	s = s & item & " "
next
ag.MsgBox s
'-> dog elephant horse

'удаляем диапазон элементов списка: начиная с первого два элемента
lst2.RemoveRange 0, 2
lst2(0) = "tiger"
lst2.Add "bird"

'ищем индекс элемента по его значению
res = lst2.IndexOf("bird")
ag.MsgBox res
'-> 1

'добавляем один список к другому
lst1.AddRange(lst2)

'удаляем элемент по его значению
res = lst1.Remove("crocodile")
ag.MsgBox res
'-> True

'удаляем элемент по его индексу в списке
lst1.RemoveAt(2)
ag.MsgBox lst1.Count
'-> 5

almaGRID API

Если вы нашли ошибку, пожалуйста, выделите фрагмент текста и нажмите Ctrl+Enter.

Установка almaGRID

Начало работы

Работа с моделями

Справочник по API

Лицензирование

Archive

Класс ‘List’

Свойства #

Count #

First #

Item #

Last #

Методы #

Add #

AddRange #

Clear #

Contains #

Except #

GetRange #

IndexOf #

Insert #

InsertRange #

Intersect #

Remove #

RemoveAt #

RemoveRange #

SelectByField #

Sort #

SortByField #

ToArray #

ToArrayList #

ToTagSet #

Union #

Пример #

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

Сообщить об опечатке

Текст, который будет отправлен нашим редакторам:

Ваш комментарий (необязательно):

Свойства #

Count #

First #

Item #

Last #

Методы #

Add #

AddRange #

Clear #

Contains #

Except #

GetRange #

IndexOf #

Insert #

InsertRange #

Intersect #

Remove #

RemoveAt #

RemoveRange #

SelectByField #

Sort #

SortByField #

ToArray #

ToArrayList #

ToTagSet #

Union #

Пример #

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

Как мы можем помочь?

Сообщить об опечатке

Текст, который будет отправлен нашим редакторам:

Ваш комментарий (необязательно):