1.5.9. Объект СписокЗначений (ValueList)

Объект типа «СписокЗначений» — это средство языка (не сохраняемый в БД объект), которое позволяет строить «динамические массивы» и манипулировать ими (добавлять, редактировать, удалять элементы, сортировать). Список значений может быть наполнен значениями любого типа, т. е. в одном списке типы хранимых значений могут быть разными. 

Во всех программных модулях вызов соответствующих методов может выполняться при помощи переменной со ссылкой на объект типа «СписокЗначений». Такие объекты можно создавать при помощи функции СоздатьОбъект, ссылка на который присваивается переменной. Кроме того, если в форму диалога при помощи визуальных средств конфигуратора вставлены специальные элементы форм диалога «Список» и «Поле со списком», то идентификаторы этих элементов доступны в контексте программного модуля этой формы как уже существующие объекты типа «СписокЗначений».

1.5.9.1. Методы.

ДобавитьЗначение(<Значение>,<Представление>), AddValue

Назначение: добавить значение в список

Параметры: 

<Значение> - выражение со значением, которое добавляется в список.

<Представление> - необязательный параметр. Строковое выражение, содержащее задаваемое символьное представление добавляемого значения. По умолчанию принимает стандартное в системе 1С:Предприятие символьное представление объекта.
Возвращаемое значение: нет.

ВставитьЗначение(<Индекс>,<Значение>,<Представление>,<Кол>), InsertValue

Назначение: вставить значения в список, начиная с позиции Индекс

Параметры: 

<Индекс> - позиция списка, начиная с которой добавляются значения.

<Значение> - выражение со значением, которое добавляется в список.

<Представление> - необязательный параметр. Строковое выражение, содержащее задаваемое символьное представление

 добавляемого значения. 
<Кол> - количество добавляемых элементов (по умолчанию 1).

Возвращаемое значение: нет.

РазмерСписка(), GetListSize

Назначение: получить количество элементов в списке

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

УстановитьЗначение(<Индекс>,<Значение>,<Представление>,<Кол>), SetValue

Назначение: заполнить список, начиная с позиции Индекс указанными значениями

Параметры: 

<Индекс> - позиция списка, начиная с которой устанавливаются значения.

<Значение> - выражение со значением, которое добавляется в список.

<Представление> - необязательный параметр. Строковое выражение, содержащее задаваемое символьное представление добавляемого значения.

<Кол> - количество устанавливаемых элементов (по умолчанию 1).
Возвращаемое значение: нет.

Установить(<Строка>,<Значение>), Set

Назначение: найти элемент по строковому представлению и установить его значение

Параметры: 

<Строка> - строка представления элемента.

<Значение> - выражение со значением, которое устанавливается элементу списка.

Возвращаемое значение: индекс элемента в списке или 0, если элемент с таким представлением не найден. В этом случае значение не устанавливается.

Сортировать(<Направление>), Sort

Назначение: сортирует элементы списка по значениям

Параметры: 

<Направление> - направление сортировки 0 - по возрастанию, 1 - по убыванию. По умолчанию 0

Возвращаемое значение: нет.

Замечание:
Сортировка значений списка производится после неявного преобразования значения в строку

СортироватьПоПредставлению(<Направление>), SortByPresent

Назначение: сортирует элементы списка по строковым представлениям

Параметры: 

<Направление> - направление сортировки 0 - по возрастанию, 1 - по убыванию. По умолчанию 0

Возвращаемое значение: нет.

Принадлежит(<Значение>), Belong

Назначение: Проверяет вхождение в список значений указанного значения, т.е. , является ли значение подмножеством списка значений
Параметры: 

<Значение> - проверяемое значение.

Возвращаемое значение: число: 1 - если проверяемое значение входит в список значений; 0 - если не входит.

НайтиЗначение(<Значение>), FindValue

Назначение: найти индекс элемента с указанным значением

Параметры: 

<Значение> - проверяемое значение.

Возвращаемое значение: число - индекс элемента  - если проверяемое значение входит в список значений; 0 - если не входит.

ПолучитьЗначение(<Индекс><Представление>), GetValue

Назначение: получить значение по указанному индексу

Параметры: 

<Индекс> - позиция списка, из которой надо получить значение .

<Представление> - переменная, в которую передается строковое представление элемента.

<Кол> - количество устанавливаемых элементов (по умолчанию 1).
Возвращаемое значение: нет.

Получить(<Строка>), Get

Назначение: найти элемент по строковому представлению и возвратить его значение

Параметры: 

<Строка> - строка представления элемента.

Возвращаемое значение: значение найденного элемента или пустое значение, если элемент не найден..

ИзСтрокиСРазделителями(<Строка>), FromSeparatedString

Назначение: заполняет список значений значениями из переданной в качестве параметра строки, содержащей разделенные запятыми значения: числа и строки в двойных кавычках.

Параметры: 

<Строка> - строка представления элемента.

Возвращаемое значение: нет.

ВСтрокуСРазделителями(), ToSeparatedString

Назначение: преобразует список значений в строку, содержащую разделенные запятыми значения: числа и строки в двойных кавычках.

Параметры: нет.

Возвращаемое значение: результирующая строка.

ВыбратьЗначение(<Значение>,<Заголовок>,<Позиция>,<Таймаут>,<СпособВыбора>), ChooseValue

Назначение: Открыть окно для интерактивного выбора значения из списка.

Параметры: 

<Значение> - идентификатор переменной, куда помещается результат выбора;
<Заголовок> - строка заголовка диалогового окна.
<Позиция> - идентификатор переменной, куда помещается номер позиции выбранного значения в списке.
<Таймаут> - необязательный параметр. Числовое выражение, значение которого задает время ожидания системы (в секундах) на отклик пользователя (в текущей реализации игнорируется).
<СпособВыбора> - необязательный параметр. Число, значение которого задает способ выбора значения. 0 - в виде диалога; 1 - выбор производится в виде меню, которое подстраивается по месту текущего элемента диалога или ячейки таблицы; 2 - выбор маленьким списком (список похож на выбор значения перечисления), также привязанным к позиции элемента диалога
Значение по умолчанию - 0.

Возвращаемое значение: 1 - если выбор произведен, 0 - иначе.

Замечание:
Метод может использоваться только для переменных, созданных функцией СоздатьОбъект.

ОтметитьЗначения(<Значение>,<Заголовок>,<Позиция>), CheckValue

Назначение: Открыть окно для интерактивной пометки значений списка

Параметры: 

<Значение> - идентификатор переменной, куда помещается результат выбора;
<Заголовок> - строка заголовка диалогового окна.
<Позиция> - необязательный параметр. Идентификатор переменной, куда помещается номер позиции выбранного значения в списке.
Возвращаемое значение: 1 - если выбор произведен, 0 -иначе

Замечание:
Возможность выбора значения - это дополнительная возможность, предоставляемая данным методом. Параметр <Значение> указывает на значение того элемента списка, на котором будет установлен курсор при открытии окна пометки. В этот же параметр возвращается последнее выбранное значение. В параметр <Позиция> возвращается номер позиции последнего выбранного значения в списке. Если выбор отменен, то значения параметров не меняются. Метод может использоваться только для переменных, созданных функцией СоздатьОбъект.

Пометка(<Позиция>,<Пометка>), Check

Назначение: пометить значение списка

Параметры: 

<Позиция> - номер позиции выбранного значения в списке.
<Пометка> - необязательный параметр. Число: 1 - установить отметку; 0 - снять отметку. Если данный параметр опущен, то отметка значения списка не изменяется.

Возвращаемое значение: значение метки до выполнения метода. Число: 1 - отметка установлена; 0 - отметка не установлена.

ТекущаяСтрока(<ИндексСтроки>), CurSel

Назначение: Установить/определить текущий элемент списка в поле диалога.

Параметры: 

<ИндексСтроки> - номер строки поля диалога, на которую требуется установить курсор (необязателен. Если не задан, то положение курсора не меняется).

Возвращаемое значение: номер текущей строки поля диалога (до его изменения).. 

Замечание:
Метод можно использовать только для полей диалога типа ''Список'' или ''Поле со списком''.  

УдалитьВсе(), RemoveAll

Назначение: удалить все элементы списка

Параметры: нет
Возвращаемое значение: нет.

УдалитьЗначение(<Позиция>,<Количество>), RemoveValue

Назначение: удалить несколько значений, начиная с заданной позиции списка

Параметры: 

<Позиция> - номер позиции удаляемого значения в списке.
<Количество> - число удаляемых значений (необязательный параметр). По умолчанию 1.

Возвращаемое значение: нет.

СдвинутьЗначение(<Количество>,<Позиция>), MoveValue

Назначение: Переместить значение списка значений на новую позицию.

Параметры: 

<Количество> - количество позиций, на которое надо переместить значение. Если число положительное, то значение сдвигается вниз, если отрицательное, то вверх.
<Позиция> - позиция, значение которой надо переместить.

Возвращаемое значение: нет.

Выгрузить(<Значение>,<Позиция>,<Количество>), UnLoad

Назначение: Выгрузить список значений в другой список значений.

Параметры: 

<Значение> - значение типа ''Список значений'', в которое нужно выгрузить данные. Если переданное значение пустое, тогда система сама создаст объект типа ''Список значений''.
<Позиция> - необязательный параметр. Номер начальной позиции, с которой надо начинать выгрузку. Значение по умолчанию 1.
<Количество> - необязательный параметр. Количество выгружаемых значений. Если не указан, то все.

Возвращаемое значение: нет.

УстановитьРазмер(<РазмерСписка>), SetSize

Назначение: Явное задание размера списка значений

Параметры: <РазмерСписка> - число >= 0 задающее размер списка

Возвращаемое значение: нет.