Методы

Добавить (Add)

Синтаксис:

Добавить(<Имя>, <Тип>, <Длина>, <Точность>)

Параметры:

<Имя>        Обязательный

Тип: Строка. Имя добавляемого поля. Поддерживаются только латинские имена полей длиной до 10 символов.

<Тип>     Обязательный

Тип: Строка. Тип создаваемого поля: "N" - число, "S" - строка, "D" - дата, "L" - логическое, "F" - аналогично "N" - число, "М" -мемополе (не поддерживается).

<Длина>     Обязательный

Тип: Число. Общая длина создаваемого поля.

<Точность>     Необязательный

Тип: Число. Длина дробной части (только для числовых полей). Значение по умолчанию: 0.

Описание:

Добавляет новое поле в описание структуры таблицы базы дан­ных.

Пример:

хВ.Поля.Добавить( "CODE", "S", 5);

хВ.Поля.Добавить( "NAME", "S", 40);

хВ.Поля.Добавить ("COST", "N", 14, 2);

хВ.СоздатьФайл("с:\ТЕСТ.DBF");

См. также:

XBase, метод СоздатьФайл. Коллекция индексов XBase, метод Добавить.

Количество (Count) 

Синтаксис:

Количество()

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

Тип:Число.

Описание:

Позволяет получить количество полей в таблице базы данных.

Пример:

Сообщить(" Всего полей в таблице: " + хВ.Поля.Количество());

Методы

Добавить (Add)

Синтаксис:

Добавить(<Имя>, <Выражение>, <Уникальность>, <У6ывание>, <Фильтр>)

Параметры:

<Имя>    Обязательный

Тип: Строка. Имя создаваемого индекса. Поддерживаются толь­ко латинские имена индексов длиной до 10 символов.

<Выражение>        Обязательный

Тип: Строка. Выражение индекса. 

<Уникальность>    Необязательный

Тип: Булево. Признак уникальности создаваемого индекса. Истина - уникальный. Ложь - неуникальный.

Значение по умолчанию: Ложь.

<Убывание>    Необязательный

Тип: Булево. Признак того, что создаваемый индекс будет убы­вающим. Истина - убывает. Ложь - возрастает.

Значение по умолчанию: Ложь.

<Фильтр> Необязательный

Тип: Строка. Выражение фильтра индекса. Значение по умолчанию: ".Т.".

Описание:

Добавляет новый индекс в коллекцию индексов таблицы базы данных.

Пример:

хВ = новый xBase;

хВ.поля.добавить ("CODE", "S", 5);

ХВ.Поля.Добавить("NАМЕ","S" , 40);

// Дбавим индекс по полю CODE:

хВ.Индексы.Добавить(" IDXCODE" , "CODE" , Истина) ;

хВ.СоздатьФайл("с:\test.dbf", "c:\test.cdx") ;

Количество (Count)

Синтаксис:

Количество()

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

Тип: Число. Количество индексов таблицы.

Описание:

Позволяет получить количество индексов таблицы базы данных.

Примечание:

Количество индексов отлично от нуля, если открыт либо создан индексный файл.

Пример:

хВ = Новый xBase;

xB.OткрытьФайл("c:\test.dbf"',"c:\test.cdx");

// Получим количество индексов

КоличествоИндексов = хВ.Индексы.Количество();

««««««««««

1С:Предприятие 8.0

»»»»»»»»»»

Методы

Вставить (Insert)

Синтаксис:

Вставить (< Ключ>, <3начение>)

Параметры:

<Ключ>    Обязательный

Тип: Строка. Ключ устанавливаемого элемента.

<3начение>     Необязательный

Значение устанавливаемого элемента.

Описание:

Устанавливает значение элемента структуры по ключу. Если эле­мент с переданным значением ключа существует, то его значение заменяется, в противном случае добавляется новый элемент.

Пример:

СтруктураОтбор = Новый Структура("Дата, Клиент");

СтруктураОтбор.Вставить("Клиент", ТекКлиент);

СтруктураОтбор.Вставить("Дата", РабочаяДата);

Количество (Count)

Синтаксис:

Количество()

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

Тип: Число. Количество элементов структуры.

Описание:

Позволяет получить количество элементов структуры.

Пример:

СтруктураОтбор.Количество() ;

Очистить (Clear)

Синтаксис:

Очистить()

Описание:

Удаляет все элементы структуры.

Пример:

СтруктураОтбор.Очистить() ;

Свойство (Property)

Синтаксис:

Свойство(<Ключ>, <Найденное значение> )

Параметры:

<Ключ>    Обязательный

Тип: Строка. Ключ для поиска свойства.

<Найденное значение>    Необязательный

Тип: Произвольный. В данный параметр возвращается найден­ное значение. Если ключа нет в структуре, то возвращается Неопределено.

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

Тип: Булево. Истина, если ключ найден, Ложь, если ключ не найден.

Описание:

Позволяет получить значение элемента по указанному имени, а также проверить имеется ли указанное свойство.

Пример:

СтруктураОтбор.Свойство("Дата");

Удалить (Remove)

Синтаксис:

Удалить (<Ключ>)

Параметры:

<Ключ>     Обязательный

Тип: Строка. Ключ удаляемого элемента.

Описание:

Удаляет элемент структуры с заданным ключом.

Пример:

СтруктураОтбор.Удалить("Дата");

Методы

Вставить (Insert)

Синтаксис:

Вставить(<Ключ>, <3начение>)

Параметры:

<Ключ>    Обязательный

Ключ устанавливаемого элемента.

<3начение>    Обязательный

Значение устанавливаемого элемента.

Описание:

Устанавливает значение элемента соответствия по ключу. Если элемент с переданным значением ключа существует, то его значе­ние заменяется, в противном случае добавляется новый элемент.

Пример:

ПараметрыОбработки = Новый Соответствие();

ПараметрыОбработки.Вставить ("Дата начала", ДатаНач);

ПараметрыОбработкм.Вставить("Дата конца", ДатаКон);

Количество (Count)

Синтаксис:

Количество()

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

Тип: Число. Количество элементов соответствия.

Описание:

Позволяет получить количество элементов соответствия.

Пример:

ПараметрыОбработки.Количество();

Очистить (Clear)

Синтаксис:

Очистить()

Описание:

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

Пример:

ПараметрыОбработки.Очистить();

Удалить (Remove)

Синтаксис:

Удалить(<Ключ>)

Параметры:

<Ключ>    Обязательный

Ключ удаляемого элемента.

Описание:

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

Пример:

ПараметрыОбработки.Удалить( "Дата конца");

Методы

Вставить (Insert)

Синтаксис:

Вставить(<Индекс>)

Параметры:

<Индекс>     Обязательный

Тип: Число. Индекс вставляемой строки.

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

Тип: СтрокаТаблицыЗначений. Вставленная строка.

Описание:

Вставляет строку на позицию в таблице значений, соответствую­щую указанному индексу.

Пример:

НоваяСтрока = ТаблицаЦен.Вставить(2);

НоваяСтрока.Товар = ТекТовар;

НоваяСтрока.Цена = ПолученнаяЦена;

ВыбратьСтроку (SelectRow)

Синтаксис:

ВыбратьСтроку(< Заголовок>, <Начальная строка> )

Параметры:

<3аголовок>     Необязательный

Тип: Строка. Заголовок диалогового окна выбора строки. Может использоваться для подсказки пользователю.

<Начальная строка>         Необязательный

Тип: СтрокаТаблицыЗначений. Указывает строку таблицы значений, на которой будет установлен курсор при открытии окна выбора.

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

Тип: СтрокаТаблицыЗначений. Выбранная строка таблицы значений. Если пользователь отказался от выбора возвращает Неопределено.

Описание:

Вызывает модальное диалоговое окно для интерактивного выбора строки из таблицы значений.

ВыгрузитьКолонку (UnloadColumn)

Синтаксис:

ВыгрузитьКолонку (< Колонка>)

Параметры:

<Колонка>     Обязательный

Тип: Число, Строка, КолонкаТаблицыЗначений. Ко­лонка, значения которой необходимо выгрузить. В качестве зна­чения параметра может выступать индекс колонки, имя колонки, сама колонка.

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

Тип: Массив. Массив значений, содержащихся в колонке.

Описание:

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

Добавить (Add)

Синтаксис:

Добавить()

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

Тип: СтрокаТаблицыЗначений. Добавленная строка.

Описание:

Добавляет строку в конец таблицы значений.

Пример:

НоваяСтрока = ТаблицаЦен.Добавить();

НоваяСтрока.Товар = ТекТовар;

НоваяСтрока.Цена = ПолученнаяЦена;

ЗагрузитьКолонку (LoadColumn)

Синтаксис:

ЗагрузитьКолонку(< Массив>, <Колонка>)

Параметры:

<Массив>    Обязательный

Тип: Массив. Массив значений, который выступает в качестве источника данных для колонки.

<Колонка>     Обязательный

Тип: Число, Строка, КолонкаТаблицыЗначений. Ко­лонка, в которую будут загружены значения из массива. В каче­стве значения параметра может выступать индекс колонки, имя колонки, сама колонка.

Описание:

Загружает колонку таблицы значений из массива значений.

ЗаполнитьЗначения (FillValues)

Синтаксис:

3аполнитьЗначения (<Значение>, <Колонки>)

Параметры:

<3начение>     Обязательный

Тип: Произвольный. Значение, которым необходимо заполнить строки таблицы.

<Колонки>     Необязательный

Тип: Строка. Список имен колонок, разделенных запятыми, по которым производится заполнение строк таблицы значений.

Значение по умолчанию: Если параметр не указан, или передана пустая строка, будет заполнена вся таблица.

Описание:

Заполняет все строки таблицы значений указанным значением.

Пример:

ТаблицаЦен.Заполнить(Рубли, "Валюта');

Индекс (IndexOf)

Синтаксис:

Индекс(<Строка>)

Параметры:

<Строка>     Обязательный

Тип: СтрокаТаблицыЗначений. Строка таблицы значений, для которой нужно определить индекс.

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

Тип: Число. Индекс строки таблицы значений. Если строка не принадлежит данной таблице, возвращается -1.

Описание:

Позволяет определить индекс строки таблицы значений.

Итог (Total)

Синтаксис:

Итог(<Колонка>)

Параметры:

<Колонка>     Обязательный

Тип: Строка. Имя колонки, по которой необходимо посчитать итог.

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

Тип: Число. Сумма значений по всем строкам указанной колон­ки.

Описание:

Позволяет просуммировать значения всех строк в указанной ко­лонке.

Количество (Count)

Синтаксис:

Количество()

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

Тип: Число. Количество строк таблицы значений.

Описание:



Позволяет получить количество строк таблицы значений.

Пример:

КолСтрок = ТаблицаЦен.Количество();

Найти (Find)

Синтаксис:

Найти(<Значение>, <Колонки>)

Параметры:

<Значение >    Обязательный

Тип: Произвольный. Искомое значение.

<Колонки>      Необязательный

Тип: Строка. Список имен колонок, разделенных запятыми, по которым производится поиск.

Значение по умолчанию: Если параметр не указан, или передана пустая строка, поиск осуществляется по всей таблице.

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

Тип: СтрокаТаблицыЗначений. Строка, в которой содержит­ся искомое значение. Если значение не найдено возвращается Неопределено.

Описание:

Позволяет найти значение в указанных колонках таблицы значе­ний.

Примечание:

Метод эффективно использовать для поиска уникальных значе­ний.

Пример:

НайденнаяСтрока = ТаблицаЦен.Найти(ВыбТовар, "Товар");

Если НайденнаяСтрока = Неопределено Тогда 

    Предупреждение("Товар не найден!');

Иначе

    ЦенаТовара = НайденнаяСтрока.Цена;

КонецЕсли;

НайтиСтроки (FindRows)

Синтаксис:

НайтиСтроки (< Параметры отбора> )

Параметры:

<Параметры отбора>    Обязательный

Тип: Структура. Задает условия поиска; ключ структуры опре­деляет имя колонки, по которой будет осуществляться поиск, а значение структуры - искомое значение.

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

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

Замечание!

Массив хранит ссылки на строки таблицы значе­ний, то есть при изменении строки в таблице, значение в массиве тоже будет измененным.

Описание:

Позволяет найти строки таблицы значений, отвечающие задан­ным условиям поиска.

Примечание:

Метод эффективно использовать для выборки неуникальных зна­чений.

Очистить (Clear)

Синтаксис:

Очистить()

Описание:

Позволяет удалить все строки таблицы значений. Структура ко­лонок остается неизменной.

Пример:



ТаблицаЦен.Очистить();

Свернуть (GroupBy)

Синтаксис:

Свернуть(< Колонки группировок , <Колонки суммирования>)

Параметры:

<Колонки группировок>     Обязательный

Тип: Строка. Имена колонок, разделенные запятыми, по кото­рым необходимо группировать строки таблицы значений.

<Колонки суммирования>    Необязательный

Тип: Строка. Имена колонок, разделенные запятыми, по кото­рым необходимо суммировать значения в строках таблицы значе­ний.

Описание:

Осуществляет свертку таблицы значений по указанным колонкам группировки. Строки, у которых совпадают значения в колонках, указанных в первом параметре, сворачиваются в одну строку. Значения этих строк, хранящиеся в колонках, указанных во вто­ром параметре, накапливаются.

Важно!

Списки колонок не должны пересекаться. Колонки, не вошедшие ни в один из списков колонок, после выполнения ме­тода удаляются из таблицы значений.

Пример:

ТаблицаЦен.Сверауть("Товар, Налита", "Цена");

Сдвинуть (Move)

Синтаксис:

Сдвинуть(< Строка>, <Смещение> )

Параметры:

<Строка>    Обязательный

Тип: Число, СтрокаТаблицыЗначений. Индекс строки, ко­торую нужно переместить, или сама строка.

<Смещение>    Обязательный

Тип: Число. Количество строк, на которое необходимо перемес­тить строку. Положительное значение означает, что строка будет передвинута ближе к концу таблицы значений (вниз), отрица­тельное - ближе к началу (вверх).

Описание:

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

Пример:

// перемещение первой строки вперед на одну позицию

ТаблицаЦен.Сдвинуть(0, 1) ;

// перемещение второй строки назад на одну позицию

ТаблицаЦен.Сдвинуть(1, -1);

Скопировать (Copy)

Синтаксис:

Скопировать()

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

Тип: ТаблицаЗначений.

Описание:

Позволяет сделать полную копию исходной таблицы значений.

Пример:

НовТаблицаЦен = ТаблицаЦен.Скопировать();



Сортировать (Sort)

Синтаксис:

Сортировать(< Колонки>)

Параметры:

<Колонки>     Обязательный

Тип: Строка. Список имен колонок, разделенных запятыми, по которым производится сортировка таблицы. После каждого име­ни колонки через пробел может быть указано направление сорти­ровки. Направление определяется: "Убыв" ("Desc") - упорядочи­вать по убыванию; "Возр" ("Asc") - упорядочивать по возраста­нию. По умолчанию сортировка производится по возрастанию. Порядок указания имен колонок таблицы определяет порядок сортировки. Это означает, что сначала таблица сортируется по колонке, указанной первой. Затем группы строк с одинаковым значением в этой колонке сортируются по колонке, которая ука­зана второй, и так далее.

Описание:

Позволяет отсортировать таблицу значений в соответствии с ука­занными правилами сортировки.

Пример:

ТаблицаЦен.Сортировать("Цена Убыв, Товар Возр");

Удалить (Remove)

Синтаксис:

Удалить(< Индекс>)

Параметры:

<Индекс>     Обязательный

Тип: Число. Индекс строки, которую надо удалить.

Описание:

Удаляет из таблицы значений строку по указанному индексу.

Пример:

ТаблицаЦен.Удалить(ИндексУдаляемойСтроки);

Методы

Вставить (Insert)

Синтаксис:

Вставить(<Индекс>, <Имя>, <Тип>, <3аголовок>, <Ширина>)

Параметры:

<Индекс> Обязательный

Тип: Число. Индекс вставляемой колонки.

<Имя>    Необязательный

Тип: Строка. Имя колонки.

Значение по умолчанию: Пустая строка.

<Тип>    Необязательный

Тип: ОписаниеТипов. Объект, описывающий допустимые типы значений для колонки.

Значение по умолчанию: Если параметр не указан, в колонке можно будет хранить значение любого типа.

<3аголовок>       Необязательный

Тип: Строка. Заголовок колонки таблицы значений. Использу­ется при визуальном отображении таблицы значений.

Значение по умолчанию: Пустая строка.

<Ширина >      Необязательный

Тип: Число. Ширина колонки в символах. Используется при ви­зуальном отображении таблицы значений.

Значение по умолчанию: 0.

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

Тип: КолонкаТаблицыЗначений. Вставленная колонка

Описание:

Вставляет колонку на указанную позицию в таблицу значений.

Добавить (Add)

Синтаксис:

Добавить(<Имя>, <Тип>, <3аголовок>, <Ширина>)

Параметры:

<Имя>     Необязательный

Тип: Строка. Имя колонки. Значение по умолчанию: Пустая строка.

<Тип>    Необязательный

Тип: ОписаниеТипов. Объект, описывающий допустимые типы значений для колонки.

Значение по умолчанию: Если параметр не указан, в колонке можно будет хранить значение любого типа.

<3аголовок>    Необязательный

Тип: Строка. Заголовок колонки таблицы значений. Использу­ется при визуальном отображении таблицы значений.

Значение по умолчанию: Пустая строка.

<Ширина>     Необязательный

Тип: Число. Ширина колонки в символах. Используется при ви­зуальном отображении таблицы значений.

Значение по умолчанию: 0.

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

Тип: КолонкаТаблицыЗначений. Добавленная колонка.

Описание:

Добавляет колонку в конец коллекции колонок таблицы.

Индекс (IndexOf)

Синтаксис:

Индекс(<Колонка>)

Параметры:

<Колонка>     Обязательный

Тип: КолонкаТаблицыЗначений. Колонка таблицы значений, для которой нужно определить индекс.

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

Тип: Число. Индекс колонки таблицы значений. Если колонка не принадлежит данной таблице, возвращается -1.

Описание:

Позволяет определить индекс колонки таблицы значений. .

Количество (Count)

Синтаксис:

Количество()

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

Тип: Число. Количество колонок таблицы значений.

Описание:

Позволяет получить количество колонок таблицы значений.

Очистить (Clear)

Синтаксис:

Очистить()

Описание:

Позволяет удалить все колонки таблицы значений.

Примечание:

Фактически после исполнения метода будут удалены все колонки и строки таблицы значений.

Сдвинуть (Move)

Синтаксис:

Сдвинуть(< Колонка>, <Смещение>)

Параметры:

<Колонка>    Обязательный

Тип: Число, Колонка ТаблицыЗначений. Индекс сдвигае­мой колонки или сама колонка.

<Смещение>    Обязательный

Тип: Число. Количество колонок, на которое необходимо переместить колонку. Положительное значение означает, что колонка будет передвинута ближе к концу таблицы значений будет передвинута ближе к концу таблицы значений (вправо), отрицательное - ближе к началу (влево).

Описание:

Позволяет переместить колонку на указанное количество пози­ций.

Удалить (Remove)

Синтаксис:

Удалить(<Индекс>)

Параметры:

<Индекс>    Обязательный

Тип: Число, КолонкаТаблицыЗначений. Индекс удаляемой колонки или сама колонка.

Описание:

Метод удаляет заданную колонку из таблицы значений.

Методы

Скопировать (Copy)

Синтаксис:

Скопировать()

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

Тип: ДеревоЗначений.

Описание:

Метод позволяет сделать полную копию исходного дерева значе­ний.

Пример:

НовоеДеревоСостава = ДеревоСостава.Скопировать();

Методы

Вставить (Insert)

Синтаксис:

Вставить(<Индекс>)

Параметры:

<Индекс>     Обязательный

Тип: Число. Индекс позиции в коллекции строк данного уровня, в которую необходимо вставить строку.

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

Тип: СтрокаДереваЗначений. Вставленная строка.

Описание:

Вставляет строку с указанным индексом в коллекцию строк дан­ного уровня дерева значений.

Пример:

НовыйЭлемент = СтрокиСостава.Вставить(5);

НовыйЭлемент.Затрата = Затрата;

НовыйЭлемент.Норма = Количество;

ВыгрузитьКолонку (UnloadColumn)

Синтаксис:

ВыгрузитьКолонку(< Колонка>)

Параметры:

<Колонка>     Обязательный

Тип: Число, Строка, либо КолонкаДереваЗначений. Колонка, из которой нужно выгрузить значения. В качестве зна­чения параметра может быть передан индекс колонки, имя ко­лонки, либо колонка дерева значений.

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

Тип: Массив. Массив, содержащий значения колонки.

Описание:

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

Примечание:

Значения из колонки выгружаются в порядке индексов строк в коллекции.

Пример:

МассивЗатрат = СтрокиСостава.ВыгрузитьКолонку("Затрата");

Добавить (Add)

Синтаксис:

Добавить()

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

Тип: СтрокаДереваЗначений. Добавленная строка.

Описание:

Добавляет строку в конец коллекции строк данного уровня дерева значений.

Пример:

НовыйЭлемент = СтрокиСостава.Добавить();

НовыйЭлемент.Затрата = Затрата;

НовыйЭлемент.Норма = Количество;

ЗагрузитьКолонку (LoadColumn)

Синтаксис:

ЗагрузитьКолонку (< Массив> , <Колонка>)

Параметры:

<Массив>     Обязательный

Тип: Массив. Массив значений для загрузки в колонку.

<Колонка>     Обязательный

Тип: Число, Строка, либо КолонкаДереваЗначений. Колонка коллекции, в которую будут загружены значения из мас­сива. В качестве значения параметра может быть передан индекс ко­лонки, имя колонки, либо колонка дерева значений.

Описание:

Загружает значения из массива в заданную колонку коллекции строк дерева значений.

Примечание:

Значения из массива загружаются в колонку в порядке индексов.

Пример:

СтрокиСостава.ЗагрузитьКолонку(МассивЗатрат, "Затрата");

Индекс (IndexOf)

Синтаксис:

Индекс(<Строка>)

Параметры:

<Строка>    Обязательный

Тип: СтрокаДереваЗначений. Строка, для которой необхо­димо получить индекс

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

Тип: Число. Индекс элемента в коллекции.

Описание:

Получает индекс элемента в коллекции.

Пример:

ИндексТекСтроки = СтрокиСостава.Индекс(ТекущаяСтрока);

Итог (Total)

Синтаксис:

Итог(<Колонка>, <Включать подчиненные>)

Параметры:

<Колонка>    Обязательный

Тип: Число, Строка, Колонка дерева значений. Ко­лонка, по которой подсчитывается итог. В качестве значения параметра может быть передан индекс ко­лонки, имя колонки, либо колонка дерева значений.

<Включать подчиненные>    Необязательный

Тип: Булево. Если значение параметра Истина, в сумму будут также включены итоги по подчиненным строкам (если таковые имеются).

Значение по умолчанию: Ложь.

Описание:

Суммирует значения всех строк в указанной колонке.

Примечание:

Имеет смысл для числовых значений.

Пример:

СтоимостьПродукции = СтрокиСостава.Итог("Сумма");

Количество (Count)

Синтаксис:

Количество()

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

Тип: Число. Количество строк в коллекции данного уровня дере­ва значений.

Описание:

Позволяет определить количество строк данного уровня дерева значений.

Пример:

КоличествоСтрок = СтрокиСостава.Количество();

Найти (Find)

Синтаксис:

Найти(<3начение>, <Колонки>, <Включать подчиненные>)

Параметры:

<3начение>    Обязательный

Искомое значение.

<Колонки>    Необязательный

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

Значение по умолчанию: Если параметр не указан, или передана пустая строка, поиск осуществляется по всем колонкам дерева.



<Включать подчиненные>    Необязательный

Тип: Булево. Если значение параметра Истина, в поиске будут участвовать строки подчиненных коллекций (если таковые име­ются).

Значение по умолчанию: Ложь.

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

Тип: СтрокаДереваЗначений. Строка, которая содержит ис­комое значение. Если значение не найдено, возвращает значение Неопределено.

Описание:

Позволяет найти значение в дереве в указанных колонках кол­лекции строк дерева значений. Если список колонок пуст, поиск осуществляется по всем колонкам дерева.

Примечание:

Метод эффективно использовать для поиска уникальных значе­ний.

Пример:

НайдСтрока = СтрокиСостава.Найти(ТекЗатрата, "Затрата");

Если НайдСтрока = Неопределено Тогда

    Предупреждение("Затрата не найдена!");

Иначе

    Количество = НайдСтрока.Норма ;

КонецЕсли;

НайтиСтроки (FindRows)

Синтаксис:

НайтиСтроки(<Параметры отбора> , <Включать подчиненные>)

Параметры:

<Параметры отбора>     Обязательный

Тип: Структура. Задает условия поиска: ключ структуры опре­деляет имя колонки, по которой будет осуществляться поиск, а значение структуры - искомое значение.

<Включать подчиненные>    Необязательный

Тип: Булево. Если значение параметра Истина, поиск будет производится также в подчиненных коллекциях строк (если тако­вые имеются).

Значение по умолчанию: Ложь.

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

Массив из строк дерева значений, соответствующих заданному условию поиска.

Замечание! Массив хранит ссылки на строки дерева значений, то есть при изменении строки в дереве, значение в массиве тоже будет изменено.

Описание:

Позволяет найти строки из коллекции строк дерева значений, соответствующие заданному условию поиска.

Примечание:

Метод эффективно использовать для выборки неуникальных зна­чений.

Пример:

ПараметрыОтбора = Новый Структура;

ПараметрыОтбора.Вставить("Затрата", ТекЗатрата) ;



НайдСтроки = СтрокиСостава.НайтиСтроки(ПараметрыОтбора);

Очистить (Clear)

Синтаксис:

Очистить()

Описание:

Удаляет все коллекции строки данного уровня дерева значений. Если у строк данного уровня были подчиненные строки, то они также будут удалены. Структура колонок остается неизменной.

Пример:

СтрокиСостава.Очистить();

Сдвинуть (Move)

Синтаксис:

Сдвинуть(< Строка>, <Смещение>)

Параметры:

<Строка>     Обязательный

Тип: Число, СтрокаДереваЗначений. Индекс строки, ко­торую надо сдвинуть, либо сама сдвигаемая строка.

<Смещение>    Обязательный

Тип: Число. Количество строк, на которые необходимо сдвинуть строку. Положительное смещение обозначает сдвиг в конец, от­рицательное - в начало коллекции.

Описание:

Позволяет переместить строку на указанное количество позиций в коллекции строк данного уровня дерева значений.

Пример:

// сдвинем первую строку на следующую позицию 

СтрокиСостава.Сдвинуть(0, 1) ;

// сдвинем вторую строку на предыдущую позицию

СтрокиСостава.Сдвинуть(1, -1);

Сортировать (Sort)

Синтаксис:

Сортировать(<Строка сортировки> , <Включать подчиненные>)

Параметры:

<Строка сортировки>    Обязательный

Тип: Строка. Список имен колонок, разделенных запятыми, по которым производится сортировка таблицы. После каждого име­ни колонки через пробел может быть указано направление упоря­дочивания. Направление определяется: "Убыв" ("Desc") - упоря­дочивать по убыванию; "Возр" ("Asc") - упорядочивать по воз­растанию. По умолчанию сортировка таблиці производится по возрастанию. Порядок указания имен колонок таблицы определя­ет порядок сортировки. Это означает, что сначала таблица сорти­руется по колонке, указанной первой. Затем группы строк с оди­наковым значением в этой колонке сортируются по колонке, ко­торая указана второй, и так далее.

<Включать подчиненные>    Необязательный.

Тип: Булево. Если значение параметра - Истина, то будут отсортированы коллекции подчиненных строк (если таковые име­ются).

Значение по умолчанию: Ложь.

Описание:

Позволяет отсортировать строки коллекции в соответствии с указанными правилами сортировки.

Пример:

СтрокиСостава.Сортировать("Норма Убыв", Истина) ;

Удалить (Remove)

Синтаксис:

Удалить(<Индекс>)

Параметры:

<Индекс>     Обязательный

Тип: Число, СтрокаДереваЗначений. Индекс удаляемой строки в коллекции, либо сама удаляемая строка.

Описание:

Удаляет строку с заданным индексом из коллекции строк данного уровня дерева значений. Если у строки имеются подчиненные строки, они также будут удалены.

Методы

Вставить (Insert)

Синтаксис:

Вставить(<Индекс>, <Имя>, <Тип>, <3аголовок>, <Ширина>)

Параметры:

<Индекс>     Обязательный

Тип: Число. Индекс в коллекции колонок, с которым необходи­мо вставить колонку.

<Имя>    Необязательный

Тип: Строка. Имя колонки.

Значение по умолчанию: Пустая строка.

<Тип>    Необязательный

Тип: ОписаниеТипов. Объект, описывающий допустимые типы значений для колонки.

Значение по умолчанию: Если параметр не указан, в колонке можно будет хранить значение любого типа.

<3аголовок>    Необязательный

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

Значение по умолчанию: Пустая строка. 

<Ширина>    Необязательный

Тип: Число. Ширина колонки в символах. Используется при ви­зуальном отображении дерева значений.

Значение по умолчанию: 0.

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

Тип: КолонкаДереваЗначений. Вставленная колонка.

Описание:

Вставляет колонку в заданную позицию коллекции колонок дере­ва значений.

Пример:

МассивТипов = Новый Массив;

МассивТипов.Добавить(Тип("Число"));

КЧ = Новый КвалификаторыЧисла(10,3);

ОписаниеЧисло = Новый ОписаниеТипов (МассивТипов, КЧ);

КолонкиСостава = ДС.Колонки;

КолонкиСостава.Вставить(2, "Количество", ОписаниеЧисло, "Кол-во",14);

Добавить (Add)

Синтаксис:

Добавить(<Имя>, <Тип>, <3аголовок>, <Ширина>)

Параметры:

<Имя>    Необязательный

Тип: Строка. Имя колонки. Значение по умолчанию: Пустая строка.

<Тип>     Необязательный

Тип: ОписаниеТипов. Объект, описывающий допустимые типы значений для колонки.

Значение по умолчанию: Если параметр не указан, в колонке можно будет хранить значение любого типа.

<3аголовок>     Необязательный

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

Значение по умолчанию: Пустая строка.

<Ширина>     Необязательный

Тип: Число. Ширина колонки в символах. Используется при ви­зуальном отображении дерева значений.

Значение по умолчанию: 0.

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

Тип: КолонкаДереваЗначений. Добавленная колонка.

Описание:

Добавляет колонку в конец коллекции колонок дерева значений.

Пример:

МассивТипов = Новый Массив;

МассивТипов.Добавить(Тип("Число")) ;

КЧ = Новый КвалификаторыЧисла(10,3);

ОписаниеЧисло = Новый ОписаниеТипов (МассивТипов, КЧ);

КолонкиСостава = ДС.Колонки;

КолонкиСостава.Добавить("Количество", ОписаниеЧисло, "Кол-во",14);

Индекс (IndexOf)

Синтаксис:

Индекс(<Колонка>)

Параметры:

<Колонка>     Обязательный

Тип: КолонкаДереваЗначений. Колонка, для которой необ­ходимо получить индекс.

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

Тип: Число. Индекс колонки в коллекции.

Описание:

Получает индекс указанной колонки в коллекции колонок

Пример:

ИндексТекКолонки = КолонкиСостава.Индекс(ТекущаяКолонка);

Количество (Count)

Синтаксис:

Количество()

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

Тип: Число. Количество колонок дерева значений.

Описание:

Позволяет получить количество колонок дерева значений.

Пример:

КолонкиСостава = ДеревоСостава.Колонки;

КоличествоКолонок = КолонкиСостава.Количество();

Очистить (Clear) 

Синтаксис:

Очистить()

Описание:

Метод удаляет все колонки дерева значений. При этом также удаляются все его строки.

Пример:

КолонкиСостава.Очистить();

Сдвинуть (Move)

Синтаксис:

Сдвинуть(<Колонка>, <Смещение>)

Параметры:

<Колонка>     Обязательный

Тип: Числов или Колонка. Индекс сдвигаемой колонки в коллекции или сама колонка.

<Смещение>     Обязательный

Тип: Число. Количество колонок, на которое необходимо сдви­нуть колонку. Положительное смещение обозначает сдвиг в ко­нец, отрицательное - в начало коллекции.

Описание:

Сдвигает колонку с заданным индексом на указанное смещение.

Пример:

// сдвинем колонку на следующую позицию 

КолонкиСостава.Сдвинуть(ИндексТекущейКолонки, 1);

// сдвинем колонку на предыдущую позицию 

КолонкиСостава.Сдвинуть(ИндексТекушейКолонки, -1);

Удалить (Remove)

Синтаксис:

Удалить(< Индекс>)

Параметры:

<Индекс>     Обязательный

Тип: Число. Индекс удаляемой колонки в коллекции.

Описание:

Метод удаляет колонку в заданной позиции коллекции колонок дерева значений.

Пример:

КолонкиСостава.Удалить(1) ;

Методы

Добавить (Add)

Синтаксис:

Добавить(<Тип>, <Имя>, <Видимость>, <Панель>)

Параметры:

<Тип>     Обязательный

Тип: Тип. Тип добавляемого элемента управления.

<Имя>     Обязательный

Тип: Строка. Имя создаваемого элемента управления.

<Видимость>     Необязательный

Тип: Булево. Определяет, создавать новый элемент управления формы видимым или нет

Значение по умолчанию: Истина, т.е. по умолчанию элемент создается видимым.

<Панель>    Необязательный

Тип: Панель. Определяет, какой именно панели формы принад­лежит создаваемый элемент. Если не указан, создаваемый эле­мент будет принадлежать непосредственно форме.

Значение по умолчанию: Если параметр не указан, новый элемент управления будет принадлежать главной панели формы.

Описание:

Добавляет элемент управления на форму.

Пример:

ЭлементыФормы.Добавить(Тип("ПолеВвода"), "НовоеПолеВвода");

Индекс (IndexOf)

Синтаксис:

Индекс (<ЭлементФормы>)

Параметры:

<ЭлвментФормы>     Обязательный

Тип:Элемент формы.

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

Тип: Число. Индекс переданного элемента. Если элемент не принадлежит форме, возвращает -1

Описание:

Получает индекс переданного элемента формы в коллекции эле­ментов формы.

Количество (Count)

Синтаксис:

Количество()

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

Тип: Число.

Описание:

Позволяет получить количество размещенных на форме элемен­тов управления.

Пример:

КолВоЭлементов = ЭлементыФормы.Количество();

Очистить (Clear)

Синтаксис:

Очистить()

Описание:

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

Удалить (Remove)

Синтаксис:

Удалить(<Номер элемента>)

Параметры:

<Номер элемента>    Обязательный

Тип: Число. Порядковый номер элемента в коллекции элементов управления формы.

Описание:

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

Методы

Обновление (RedrawFlag)

Синтаксис:

Обновление(< Флаг>)

Параметры:

<Флаг>       Обязательный

Тип: Булево. Истина - Разрешить обновление. Ложь - за­претить обновление.

Описание:

Устанавливает признак обновления (пересчета и отрисовки) диа­граммы. Запрет обновления диаграммы рекомендуется на время наполнения данными в целях ускорения работы системы. Если обновление разрешено, пересчет и отрисовка производятся авто­матически.

Пример:

Диаграмма.Обновление(Ложь);

Очистить (Clear)

Синтаксис:

Очистить()

Описание:

Очищает диаграмму: удаляет все значения, обнуляет количество точек и серий, удаляет все имена меток.

Пример:

Диаграмма.Очистить();

ПолучитьЗначение (GetValue)

Синтаксис:

ПолучитьЗначение(< Точка>, <Серия>)

Параметры:

<Точка> Обязательный

Тип: Число, ТочкаДиаграммы. Индекс точки либо значение сама точка диаграммы.

<Серия>    Обязательный

Тип: Число, СерияДиаграммы. Индекс серии либо сама се­рия диаграммы.

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

Тип: ЗначениеДиаграммы. Значение диаграммы в заданной точке и серии.

Описание:

Получает значение из заданной точки и серии диаграммы.

Пример:

ОбъемПродаж = Диаграмма.ПолучитьЗначение(Точка, Серия).Значение;

См. также:

Диаграмма, метод УстановитьЗначение.

УстановитьЗначение (SetValue)

Синтаксис:

УстановитьЗначение(< Точка> , <Серия>. <3начение>, <Расшифровка>)

Параметры:

<Точка>    Обязательный

Тип: Число, ТочкаДиаграммы. Индекс точки либо сама точ­ка диаграммы.

<Серия>    Обязательный

Тип: Число, СерияДиаграммы. Индекс серии либо сама се­рия диаграммы.

<3начение>    Обязательный

Тип: Произвольный. Устанавливаемое значение. При построе­нии диаграммы значения с типами, отличными от Число, будут интерпретироваться как числа.

<Расшифровка>    Необязательный

Тип: Произвольный. Значение, используемое при расшифровке диаграммы.

Описание:

Устанавливает значение в заданной точке и серии диаграммы. Дополнительно может быть установлена расшифровка значения.

Пример:

Диаграмма.УстановитьЗначение(Точка, Серия, ОбъемПродаж);

См. также:

Диаграмма, метод ПолучитьЗначение.

Методы

ПолучитьДействие (GetAction)

Синтаксис:

ПолучитьДействие (<Событие>)

Параметры:

<Событие>    Обязательный

Тип: Строка. Имя события.

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

Тип: Действие.

Описание:

Позволяет определить действие, которое будет исполняться при возникновении указанного события.

УстановитьДействие (SetAction)

Синтаксис:

УстановитьДействие (<Событие>, <Действие>)

Параметры:

<Событие>     Обязательный

Тип: Строка. Имя события.

<Действие>     Обязательный

Тип: Действие. Устанавливаемое действие.

Описание:

Метод позволяет назначить действие, которое будет исполняться при возникновении указанного события.

Методы

Вставить (Insert)

Синтаксис:

Вставить(<Индекс>, <Тип>, <Текст>, <Действие>)

Параметры:

<Индекс> Обязательный

Тип: Число. Позиция в коллекции кнопок, в которую необходи­мо вставить кнопку.

<Тип>    Необязательный

Тип: системное перечисление ТипКнопкиКоманднойПанели. Тип кнопки командной панели (разделитель, действие, подменю).

<Текст>    Необязательный

Тип: Строка. Текст, который будет выводиться на кнопке.

<Действие>    Необязательный

Тип: Действие. Действие, которое необходимо выполнить при нажатии на данную кнопку. Для типов кнопок Разделитель и Подменю, действие указывать не нужно.

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

Тип: КнопкаКоманднойПанели.

Описание:

Вставляет кнопку в указанную позицию.

Пример:

КП = ЭлементыФормы.КоманднаяПанель;

НовоеДействие = Новый Действие("МояПроцедураВМодулеФормы");

ТипКнопки = ТипКнопкиИнтерфейса.Действие;

НоваяКнопка = КП.Кнопки.Вставить(0, ТипКнопки,, НовоеДействие);

Добавить(Add)

Синтаксис:

Добавить(<Тип кнопки>, <Текст>, <Действие>)

Параметры:

<Тип кнопки>    Необязательный

Тип: системное перечисление ТипКнопкиКоманднойПанели. Тип кнопки интерфейса (разделитель, подменю, действие).

<Текст>     Необязательный

Тип: Строка. Текст, который будет выводиться на кнопке.

<Действие>     Необязательный

Тип: Действие. Действие, которое необходимо выполнить при нажатии на данную кнопку. Для типов кнопок Разделитель и Подменю, действие указывать не нужно.

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

Тип: системное перечисление КнопкаКоманднойПанели. Добавленная кнопка.

Описание:

Добавляет кнопку в командную панель.

Пример:

КП = ЭлементыФормы.КоманднаяПаяель;

НовоеДействие = Новый Действие("МояПроцедураВМодулеФормы");

ТипКнопки = ТипКнопкиИнтерфейса.Действие;

НоваяКнопка = КП.Кнопки.Добавить(ТипКнопки,, НовоеДействие);

Количество (Count)

Синтаксис:

Количество()

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

Тип: Число. Количество кнопок в командной панели.

Описание:

Позволяет получить количество кнопок в командной панели.

Пример:

КП = ЭлементыФормы.КоманднаяПанель;

Сообщить("Итого кнопок " + КП.Кнопки.Количество() );

Очистить (Clear)

Синтаксис:

Очистить()

Описание:

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

Пример:

КП = ЭлементыФормы.КоманднаяПанель;

КП. Кнопки - Очистить () ;

Сдвинуть (Move)

Синтаксис:

Сдвинуть(< Кнопка>, <Смещение>)

Параметры:

<Кнопка>     Обязательный

Тип: Число, КнопкаКоманднойПанели. Индекс кнопки, которую необходимо передвинуть, или сама кнопка.

<Смещение>    Обязательный

Тип: Число. Количество кнопок, на которое необходимо сдви­нуть данную. Положительное значение соответствует смещению кнопки в сторону конца командной панели (увеличение индекса), отрицательное - к началу.

Описание:

Позволяет сдвинуть кнопку на указанное количество позиций.

Пример:

// Сдвигаем первую кнопку "вправо"

КП = ЭлементыФормы.КоманднаяПанель;

КП.Кнопки.Сдвинуть(0,1);

Удалить (Remove)

Синтаксис:

Удалить(<Индекс>)

Параметры:

<Индекс>    Обязательный

Тип: Число. Позиция кнопки в командной панели.

Описание:

Позволяет удалить кнопку из командной панели.

Пример:

КП = ЭлементыФормы.КоманднаяПанель;

КП.Кнопки.Удалить(0) ;

Методы

ПолучитьВыделенныйТекст

Синтаксис:

ПолучитьВыделенныйТекст()

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

Тип: Строка. Выделенный текст в виде строки.

Описание:

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

Пример:

ВыделенныйТекст = ЭлементыФормы.ПолеТекста.ПолучитьВыделенныйТекст();

««««««««««

1С:Предприятие 8.0

»»»»»»»»»»

Методы

Индекс (IndexOf)

Синтаксис:

Индекс(<Ссылка на стиль>)

Параметры:

<Ссылка на стиль>     Обязательный

Тип: Стиль. Ссылка на стиль коллекции, для которой необходи­мо получить индекс.

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

Тип: Число. Индекс указанного стиля в коллекции.

Описание:

Получает индекс указанного стиля в коллекции стилей.

Пример:

ИндексСтиля = БиблиотекаСтилей.Индекс(ТекущийСтиль);

Количество (Count)

Синтаксис:

Количество()

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

Тип Число. Количество стилей в коллекции.

Описание:

Позволяет получить количество стилей в коллекции стилей.

Пример:

ВсегоСтилей = БиблиотекаСтилей.Количество();

Стиль (Style)

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

««««««««««

1С:Предприятие 8.0

»»»»»»»»»»

Методы

Количество (Count)

Синтаксис:

Количество()

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

Тип: Число. Количество интерфейсов в коллекции.

Описание:

Позволяет получить количество интерфейсов.

ПереключитьИнтерфейс (SwitchInterface)

Синтаксис:

ПереключитьИнтерфейс (<Имена интерфейсов> )

Параметры:

<Имена интерфейсов> Необязательный

Тип: Строка. Перечисленные через запятую имена интерфейсов, которые следует сделать видимыми.

Описание:

Способ группового управления видимостью командных интер­фейсов. При вызове данного метода сначала становятся невиди­мыми все интерфейсы, кроме имеющих значение Ложь у свойст­ва Переключаемый, а затем становятся видимыми перечислен­ные в параметре интерфейсы.

Пример:

Интерфейсы.ПереключитьИнтерфейс("Основной,Маркетинг");

Методы

Выполнить (Execute)

Синтаксис:

Выполнить()

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

Тип: РезультатЗапроса.

Описание:

Позволяет выполнить запрос к базе данных.

УстановитьПараметр

Синтаксис:

УстановитьПараметр(< Имя>, <3начение>}

<Имя> Обязательный

Тип: Строка. Имя устанавливаемого параметра. Оно должно соответствовать требованиям, предъявляемым к именованию пе­ременных встроенного языка.

<3начение>     Обязательный

Тип: Произвольный. Значение устанавливаемого параметра.

Описание:

Позволяет установить параметр запроса. Параметры доступны для обращения в тексте запроса. С помощью этого метода можно передавать переменные в запрос, например, для использования в условиях запроса.

Пример:

Запрос.УстановитьПараметр("ДатаКонца", РабочаяДата);

Запрос.УстановитьПараметр("Товар", ВыбТовар);

Методы

Выбрать (Choose)

Синтаксис:

Выбрать(< Тип обхода>)

Параметры:

<Тип обхода> Необязательный

Тип: системное перечисление ОбходРезультатаЗапроса. Задает тип обхода записей в получаемой выборке.

Значение по умолчанию: Прямой.

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

Тип: ВыборкаИзРезультатаЗапроса.

Описание:

Предназначен для получения выборки записей из результата за­проса.

Пример:

Выборка = РезультатЗапроса.Выбрать() ;

Выгрузить (Unload)

Синтаксис:

Выгрузить(<Тип обхода>)

Параметры:

<Тип обхода>     Необязательный

Тип: системное перечисление ОбходРезультатаЗапроса. Задает тип обхода записей в получаемой выборке.

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

Тип: ТаблицаЗначений, ДеревоЗначений. Если тип обхода задан Прямой, результат выгружается в таблицу значений, в про­тивном случае в дерево значений.

Описание:

Позволяет выгрузить записи результата запроса в таблицу значе­ний или дерево значений.

Пример:

ТаблицаРезультатов = РезультатЗапроса.Выгрузить();

Пустой (IsEmpty)

Синтаксис:

Пустой()

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

Тип: Булево. Истина, если есть детальные записи; Ложь - в противном случае.

Описание:

Проверяет, есть ли в результате детальные записи.

Методы

Индекс (IndexOf)

Синтаксис:

Индекс(<Колонка>)

Параметры:

<Колонка> Обязательный

Тип: КолонкаРезультатаЗапроса. Колонка результата запроса, для которой нужно определить индекс.

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

Тип: Число. Индекс колонки результата запроса. Если колонка не принадлежит данной коллекции, возвращается -1.

Описание:

Позволяет определить индекс колонки результата запроса.

Пример:

РезультатЗапроса.Колонки.Индекс(Колонка);

Количество (Count)

Синтаксис:

Количество()

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

Тип Число. Количество колонок результата запроса.

Описание:

Позволяет получить количество колонок результата запроса.

Пример:

РезультатЗапроса.Колонки.Количество();

Методы

Расположить (Place)

Синтаксис:

Расположить(<Область ячеек>)

Параметры:

<0бласть ячеек> Обязательный

Тип: ОбластьЯчеекТабличногоДокумента. Область, в ко­торой нужно расположить элемент управления.

Описание:

Позволяет расположить элемент управления в заданной области ячеек табличного документа.

Методы

Выбрать (Choose)

Синтаксис:

Выбрать(<Тип обхода>, <Группировки>, <ГруппировкиДляЗначенийГруппировок>)

Параметры:

<Тип обхода> Необязательный

Тип: системное перечисление ОбходРезультатаЗапроса. Задает тип обхода записей в получаемой выборке.

Значение по умолчанию: ОбходРезультатаЗапроса.Прямой

<Группировки>     Необязательный

Тип: Строка. Список группировок, разделенных запятыми, по которым будет производиться обход.

Для детальных записей указывается пустая строка. В случае, если группировки не указаны - будет использоваться следующая группировка, указанная в предложении запроса "ИТОГИ".

<ГруппировкиДляЗначенийГруппировок>     Необязательный

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

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

Тип: ВыборкаИзРезультатаЗапроса.

Описание:

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

Группировка (Group)

Синтаксис:

Группировка()

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

Тип: Строка. Возвращает имя группировки текущей записи. Если группировки нет, возвращается пустая строка.

Описание:

Позволяет получить имя группировки текущей записи выборки.

Пример:

ТекГрупиировка = Выборка.Группировка();

Количество

Синтаксис:

Количество()

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

Тип: Число.

Описание:

Количество записей в выборке.

НайтиСледующий (FindNext)

Синтаксис:

НайтиСледующий (< Структура поиска> )

Параметры:

<Структура поиска>     Обязательный

Тип: Структура. Структура, которая определяет условия поис­ка. В ключе структуры находятся имена полей, в значениях - ис­комые значения.

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

Тип: Булево. Истина, если запись найдена, Ложь - в против­ном случае.

Описание:

Позволяет найти запись по указанным условиям и установить указатель выборки на нее.

Примечание:

Текущая запись не рассматривается.

Пример:

СтуктураПоиска = Новый Структура("Товар, Контрагент");

СтуктураПоиска.Товар = НужныйТовар;

СтуктураПоиска.Контрагент = НужнайКонтрагент;

Пока Выборка.НайтиСледующий(СтуктураПоиска) Цикл

КонецЦидла;

Сбросить

Синтаксис:

Сбросить()

Описание:

Сбросить выборку. После вызова метода Следующий выборка спозиционируется на первую запись в ней.

Следующий (Next)

Синтаксис:

Следующий()

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

Тип: Булево. Истина - если следующая запись выбрана. Ложь - если достигнут конец выборки.

Описание:

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

Пример:

Пока Выборка.Следующий() Цикл

КонецЦикла;

СледующийПоЗначениюПоля (NextByFieldValue)

Синтаксис:

СледующийПоЗначениюПоля(< Имя поля>)

Параметры:

<Имя поля>    Обязательный

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

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

Тип: Булево. Истина - если следующая запись выбрана. Ложь - в противном случае.

Описание:

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

Пример:

Пока Выборка.СледующийПоЗначениюПоля("Товар") Цикл

КонецНикла;

ТипЗаписи (RecordType)

Синтаксис:

ТипЗаписи()

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

Тип: системное перечисление ТипЗаписиЗапроса.

Описание:

Позволяет определить тип текущей записи выборки.

Пример:

ТекТип = Выборка.ТипЗаписи();

Уровень (Level)

Синтаксис:

Уровень()

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

Тип: Число. Уровень текущей записи.

Описание:

Позволяет получить уровень текущей записи в иерархии и груп­пировках. Уровень считается от начальной выборки из результата запроса.

Пример:

ТекУровень = Выборка.Уровень();

Методы

Записать ( Write )

Синтаксис;

Записать()

Описание:

Позволяет записать значения всех входящих в набор констант в информационную базу.

Пример:

НаборКонстант.Записать();

ПолучитьФорму ( GetForm )

Синтаксис:

ПолучитьФорму(<Форма>, <Владелец> , <Ключ уникальности>)

Параметры:

< Форма >_ Необязательный

Тип: Строка, Объект описания метаданного. Имя формы, как оно задано в конфигураторе или объект описания ме­таданного требуемой формы.

Значение по умолчанию: Если параметр не указан, то использует­ся основная форма, заданная в конфигураторе.

<Владелец> Необязательный

Тип: Форма. Форма, которая будет являться владельцем откры­ваемой формы.

<Ключ уникальности> Необязательный

Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она.

Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.

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

Тип:Форма.

Описание:

Позволяет получить форму набора констант.

Пример:

НаборКонстант. ПолучитьФорму ().Открыть();

Прочитать ( Read )

Синтаксис:

Прочитать()

Описание:

Позволяет считать текущие значения входящих в набор констант из информационной базы.

Пример:

НаборКонстант.Прочитать();

Методы

Заблокирован ( IsLocked )

Синтаксис:

Заблокирован()

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

Тип: Булево. Истина - элемент заблокирован. Ложь - элемент не заблокирован.

Описание:

Позволяет определить, заблокирован ли элемент данным объек­том.

Примечание:

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

Пример:

Если НоменклатураОбъект.Заблокирован() Тогда НоменклатураОбъект.Разблокировать();

КонецЕсли;

Заблокировать ( Lock )

Синтаксис:

Заблокировать()

Описание:

Позволяет выполнить блокировку объекта от изменения другими режимами или пользователями.

Пример:

Попытка

    Объект.Заблокировать();

Исключение

    Предупреждение("Не удалось заблокировать объект " + Объект +ОписаниеОшибки(), 60);

КонецПопытки;

Записать ( Write )

Синтаксис:

Записать()

Описание:

Выполняет запись элемента справочника в информационную ба­зу.

В процессе записи проверяется уникальность кода, если данные режим установлен в конфигурации.

Пример:

Попытка

    Объект.Записать();

Исключение

    Предупреждение ("Не удалось записать объект " + Объект + "|" + ОписаниеОшибки(), 60);

КонецПопытки;

Заполнить (Fill)

Синтаксис;

Заполнить(< Основание>)

Параметры:

<0снование> Обязательный

Тип: Произвольный. Значение, на основании которого выпол­няется заполнение элемента справочника.

Описание:

Позволяет заполнить данные элемента данными из другого объ­екта. Инициирует событие ОбработкаЗаполнения и вызов его процедуры-обработчика в модуле справочника. В ней может размещаться алгоритм, заполняющий данные элемента из пере­данного значения.

Примечание:

Для заполнения может использоваться значение любого типа.

Пример:

Объект.Заполнить(ОбьектОснование);

Метаданные ( Metadata )

Синтаксис:

Метаданные()

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

Тип: Объект описания негаданного. Объект описания метаданных справочника.

Описание:

Предоставляет доступ к объекту описания метаданных справоч­ника.

Пример:

МетаданныеСправочника = Объект.Метаданные();

Сообщить("Представление справочника " + МетаданныеСправочника.Представление());

Модифицированность ( Modified )

Синтаксис:

Модифицированность()

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

Тип: Булево. Истина - если объект изменен. Ложь - если объект не изменен.

Описание:

Позволяет определить, был ли изменен объект.

Примечание:

Метод не позволяет определить, был ли изменен объект другими пользователями.

Пример:

Если Объект.Модифицированность() Тогда Объект.Записать();

КонецЕсли;

ПолноеНаименование ( FullDescr )

Синтаксис:

ПолноеНаименование()

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

Тип: Строка. Строка, включающая наименование элемента и наименования всех вышестоящих элементов.

Наименования выводятся слева направо, начиная с самого верх­него уровня, разделяются символом "/".

Описание:

Позволяет получить наименование элемента справочника с уче­том наименований всех вышестоящих элементов.

Пример:

Сообщить("Полное наименование данного элемента: "  +  Объект.ПолноеНаименование()) ;

ПолныйКод ( FullCode )

Синтаксис:

ПолныйКод()

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

Тип: Строка. Строка, включающая код элемента и коды всех вышестоящих элементов.

Коды выводятся слева направо, начиная с самого верхнего уров­ня, разделяются символом "/".

Описание:

Позволяет получить код элемента справочника с учетом кодов всех вышестоящих элементов.

Пример:

Сообщить ("Полный код данного элемента: " + Объект.ПолныйКод());

ПолучитьМакет ( GetTemplate )

Синтаксис:

ПолучитьМакет (< Макет>)

Параметры:

<Макет> Обязательный

Тип: Строка, Объект описания метаданного. Имя ма­кета, как оно задано в конфигураторе или объект описания мета­данного требуемого макета.



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

Тип: ТабличныйДокумент. Созданный макет.

Описание:

Позволяет получить макет справочника.

Пример:

Объект.ПолучитьМакет();

ПолучитьФорму ( GetForm )

Синтаксис:

ПолучитьФорму (<Форма> , <Владелец> , <Ключ уникальности>)

Параметры:

<Форма>  Необязательный

Тип: Строка, Объект описания метаданного. Имя формы, как оно задано в конфигураторе или объект описания ме­таданного требуемой формы.

Значение по умолчанию: Если параметр не указан, то использует­ся основная форма, заданная в конфигураторе.

<Владелец>  Необязательный

Тип: Форма. Форма, которая будет являться владельцем откры­ваемой формы. 

<Ключ уникальности>  Необязательный

Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она.

Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.

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

Тип:Форма.

Описание:

Позволяет получить форму элемента справочника, которая со­держит данный объект встроенного языка.

Пример:

Клиенты = Справочники.Контрагенты;

НовыйКлиент= Клиенты.СоздатьЭлемент();

НовыйКлиент.ПолучитьФорму() .Открыть();

ПринадлежитГруппе ( BelongsToFolder )

Синтаксис:

ПринадлежитГруппе (< Элемент>)

Параметры:

<Элемент> Обязательный

Тип: СправочникСсылка. <Имя справочника;». Ссылка на группу, для которой определяется принадлежность элемента.

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

Тип: Булево. Истина - элемент подчинен группе.

Ложь - элемент не подчинен группе.

Описание:

Позволяет определить подчиненность элемента справочника группе с учетом всех уровней иерархии.

Примечание:

Определяет подчиненность группе непосредственно на момент вызова метода путем последовательного считывания всех выше­стоящих элементов.

Пример:



Если Объект. ПринадлежитГруппе(ГруппаСсылка) Тогда Сообщить("Принадлежит") ;

КонецЕсли ;

Прочитать ( Read )

Синтаксис:

Прочитать()

Описание:

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

Пример:

Объект.Прочитать();

Разблокировать ( Unlock )

Синтаксис:

Разблокировать()

Описание:

Позволяет снять блокировку элемента, если он заблокирован данным объектом.

Пример:

Объект.Разблокировать();

Скопировать ( Copy )

Синтаксис:

Скопировать()

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

Тип: СправочникОбъект. <Имя справочника>. Созданный объект для записи элемента справочника.

Описание:

Позволяет создать новый элемент справочника копированием су­ществующего.

Удалить ( Delete )

Синтаксис:

Удалить()

Описание:

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

Важно!         В        отличие        от         метода УстановитьПометкуУдаления данный производит непо­средственное удаление элемента справочника без возможности восстановления и без проверки ссылочной целостности. Исполь­зовать данный метод нужно крайне осмотрительно.

Пример:

Объект.Удалить();

Уровень ( Level )

Синтаксис:

Уровень()

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

Тип: Число. Уровень элемента справочника.

Описание:

Позволяет определить уровень элемента справочника.

Примечание:

Имеет смысл только для многоуровневых справочников. Следует учитывать, что уровень элемента может меняться, например, при переносе в другую группу (смене родителя).

Для элемента, не имеющего родителей уровень будет равняться 0. 

Пример:

Сообщить("Данный элемент принадлежит уровню " + Объект.Уровень());

УстановитьНовыйКод ( SetNewCode )

Синтаксис;

УстановитьНовыйКод(< Префикс кода>)

Параметры:

<Префикс кода> Необязательный

Тип: Строка. Строковое значение префикса. Если префикс ука­зан, то новый код будет формироваться в пределах диапазона ко­дов ограниченных указанным префиксом.



Описание:

Устанавливает новый код. Если в коде присутствует числовая часть, то новый код автоматически устанавливается следующим за имеющимся максимальным. При этом определяется текущий максимальный код среди элементов данного справочника. Если передан префикс, то новый код устанавливается в пределах ука­занного префикса.

Примечание:

Префикс имеет смысл, если для справочника в конфигураторе выбран тип кода "Текстовый".

Пример:

Объект. УстановитьНовыйКод("Пр-");

УстановитьПометкуУдаления ( SetDeleteMark )

Синтаксис:

УстановитьПометкуУдаления(< Пометка удаления> , <Включая подчиненные> )

Параметры:

<Пометка удаления> Обязательный

Тип: Булево. Пометка.

Истина - пометка будет установлена.

Ложь - пометка будет снята.

<Включая подчиненные> Необязательный

Тип: Булево. Если параметр установлен в Истина, то будут помечены на удаление, кроме данного элемента, все его подчи­ненные элементы в данном справочнике и во всех подчиненных справочниках.

Если параметр установлен в Ложь, то будет помечен на удаление только данный элемент.

Значение по умолчанию: Истина.

Описание:

Позволяет установить/снять пометку на удаление. Объект при этом не удаляется из информационной базы. Окончательное уда­ление помеченных элементов справочника происходит при удале­нии помеченных объектов с проверкой ссылочной целостности данных.

Пример:

Объект. УстановитьПометкуУдаления(Истина, Истина);

ЭтоНовый ( IsNew )

Синтаксис:

ЭтоНовый()

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

Тип Булево. Истина, если изменяется еще ни разу не записан­ный элемент.

Ложь, если элемент уже записан в информационную базу.

Описание:

Позволяет определить, был ли элемент уже записан в информа­ционную базу.

Пример:

Если Объект.ЭтоНовый() Тогда

    Объект.Наименование = "Новый элемент";

КонецЕсли;

Методы

Метаданные ( Metadata )

Синтаксис:

Метаданные()

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

Тип: Объект описания негаданного. Объект описания метаданных справочника.

Описание:

Предоставляет доступ к объекту описания метаданных справоч­ника.

Пример:

МетаданныеСправочника = Выборка.Метаданные();

Сообщить("Представление справочника - " + МетаданныеСправочника.Представление());

ПолучитьОбъект ( GetObject )

Синтаксис:

ПолучитьОбъект()

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

Тип: СправочникОбъект. <Имя справочника>. Объект, предназначенный для модификации элемента.

Описание:

Позволяет получить объект для модификации и записи элемента, на котором в данный момент спозиционирована выборка.

Пример:

Объект = ВыборкаСправочника.ПолучитьОбъект();

Следующий ( Next )

Синтаксис:

Следующий()

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

Тип: Булево. Истина - если следующий элемент выбран. Ложь - если достигнут конец выборки.

Описание:

Выполняет получение следующего элемента выборки. Для обхода справочника нужно после получения выборки вызвать данный метод для позиционирования на первый элемент и далее вызы­вать до тех пор пока не будет возвращено значение Ложь.

Пример:

ВыборкаСправочника = Справочники.Валюты.Выбрать();

Пока ВыборкаСправочника.Следующй() Цикл

Сообщить("Записана валюта " + ВыборкаСправочника.Наименование);

КонецЦикла;

УровеньВВыборке ( LevellnSelection )

Синтаксис:

УровеньВВыборке()

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

Тип: Число. Уровень в выборке.

Описание:

Позволяет определить уровень элемента справочника в выборке, полученной с помощью метода ВыбратьИерархически. Уро­вень выдается начиная с 0. То есть при обходе верхнего уровня выборки уровень будет равняться 0. Выдаваемые значения зави­сят от того, с каким отбором по родителю выполнялась выборка. Если отбор по родителю не производился, то уровень в выборке будет совпадать с уровнем элемента в справочнике.

Примечание:

Для неиерархической выборки смысла не имеет.

Пример:

МПЗ = Справочники.Номенклатура;

ВыборкаМПЗ = МПЗ.ВыбратьИерархически(ВыбГруппа,);

Пока ВыборкаМПЗ.Следующий() Цикл

    Сообщить("в выборке " + ВыборкаМПЗ. Ссылка + "Уровень "+ ВыборкаНПЗ.УровеньВВыборке()) ;

    Сообщить("в справочнике " + ВыборкаМПЗ.Ссылка + "Уровень "+ ВыборкаМПЗ.Ссылка.Уровень());

КонецЦикла ;

    Исключение

        Предупреждение("Не удалось записать объект " + Объект  + ОписаниеОшибки(),60) ;

    КонецПопытки;

КонецЕсли;

ПолучитьФорму ( GetForm )

Синтаксис:

ПолучитьФорму (< Форма>, <Владелец> , <Ключ уникальности>)

Параметры:

<Форма>  Необязательный

Тип: Строка, Объект описания метаданного. Имя формы, как оно задано в конфигураторе или объект описания ме­таданного требуемой формы.

Значение по умолчанию: Если параметр не указан, то использует­ся основная форма, заданная в конфигураторе.

<Владелец>  Необязательный

Тип: Форма. Форма, которая будет являться владельцем откры­ваемой формы.

<Ключ уникальности>  Необязательный

Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она.

Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.

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

Тип: Форма.

Описание:

Позволяет получить форму элемента справочника, на который указывает ссылка.

Пример:

Если Не ТоварСсылка.Пустая() Тогда

    ТоварСсылка.ПолучитьФорму().Открыть();

    Возврат ;

КонецЕсли;

ПринадлежитГруппе(BelongToGroup)

Синтаксис:

ПринадлежитГруппе (< Элемент>)

Параметры:

<Элемент> Обязательный

Тип: СправочникСсылка. <Имя справочника;». Группа, для которой определяется принадлежность элемента.

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

Тип: Булево. Истина - элемент подчинен группе. Ложь - элемент не подчинен группе.

Описание:

Позволяет определить подчиненность элемента справочника группе с учетом всех уровней иерархии.

Примечание:

Метод определяет подчиненность группе непосредственно на мо­мент вызова метода путем последовательного считывания всех вышестоящих элементов.



Пример:

Если ТоварСсылка. ПринадлежитГруппе(ГруппаСсылка) Тогда Сообщить("Принадлежит");

КонецЕсли;

Пустая ( IsEmpty )

Синтаксис:

Пустая ()

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

Тип: Булево. Истина, если ссылка не указывает ни на какой

элемент

Ложь, если ссылка указывает на какой-либо элемент.

Описание:

Позволяет определить, является ли ссылка пустой или нет.

Пример:

Если ТоварСсылка.Пустая() Тогда

    Предупреждение("Не выбран товар!",60);

    Возврат;

КонецЕсли;

Скопировать ( Copy )

Синтаксис:

Скопировать()

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

Тип СправочникОбъект.<Имя справочника>.  Созданный объект для записи элемента справочника.

Описание:

Позволяет создать новый элемент справочника копированием су­ществующего.

Пример:

Если Не ТоварСсылка.Пустая() Тогда

    Копия = ТоварСсылка.Скопировать();

    Копия.Записать();

КонецЕсли;

Уровень ( Level )

Синтаксис:

Уровень()

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

Тип. Число. Уровень элемента справочника.

Описание:

Позволяет определить уровень элемента справочника.

Примечание:

Имеет смысл только для многоуровневых справочников. Следует учитывать, что уровень элемента может меняться, например, при переносе в другую группу (смене родителя). Для элемента, не имеющего родителей уровень будет равняться 0.

Пример:

Сообщить("Данный элемент принадлежит уровню " + СсылкаНаЭлемент.Уровень()) ;

Методы

Пустая ( IsEmpty )

Синтаксис:

Пустая()

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

Тип: Булево. Истина, если ссылка не указывает ни на какое значение, Ложь, если ссылка указывает на какое-либо значение перечисления.

Описание:

Позволяет определить, является ли ссылка пустой.

Пример:

ВидКонтаргента = Контрагент.Вид;

Если ВидКонтаргента.Пустая() Тогда

Сообщить(" +Контрагент + ". Неизвестный вид контрагента!");

КонецЕсли;

Методы

ПолучитьМакет ( GetTemplate )

Синтаксис:

ПолучитьМакет(<Макет>)

Параметры:

<Макет> Обязательный

Тип: Строка, Объект описания метаданного. Имя ма­кета, как оно задано в конфигураторе или объект описания мета­данного требуемого макета.

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

Тип: ТабличныйДокумент. Макет отчета.

Описание:

Позволяет получить макет отчета.

Пример:

МакетОтчета = Отчеты.ОстаткиНоменклатуры.ПолучитьМакет("Основной");

ПолучитьФорму ( GetForm )

Синтаксис:

ПолучитьФорму (< Форма>, <Владелец> , <Ключ уникальности>)

Параметры:

<Форма> Необязательный

Тип: Строка, Объект описания метаданного. Имя формы, как оно задано в конфигураторе или объект описания ме­таданного требуемой формы.

Значение по умолчанию: Если параметр не указан, то использует­ся основная форма, заданная в конфигураторе.

<Владелец>     Необязательный

Тип: Форма. Форма, которая будет являться владельцем откры­ваемой формы.

<Ключ уникальности> Необязательный

Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она.

Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.

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

Тип:Форма.

Описание:

Позволяет получить форму отчета.

Пример:

ФормаОтчета = Отчеты.Продажи.ПолучитьФорму();

Создать ( Create )

Синтаксис:

Создать()

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

Тип: ОтчетОбъект.<Имя отчета>. Объект отчета.

Описание:

Позволяет создать новый экземпляр отчета.

Пример:

ОтчетОстаткиНоменклатуры = Отчеты.ОстаткиНоменклатуры.Создать();

Методы

ПолучитьМакет ( GetTemplate )

Синтаксис:

ПолучитьМакет (< Макет>)

Параметры:

<Макет> Обязательный

Тип: Строка, Объект описания метаданного. Имя ма­кета, как оно задано в конфигураторе или объект описания мета­данного требуемого макета.

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

Тип: ТабличныйДокумент. Макет отчета.

Описание:

Позволяет получить макет отчета.

Пример:

ОтчетОПродажах = Отчеты.Продажи.Создать();

МакетОтчета = ОтчетОПродажах.ПолучитьМакет ("Продажи") ;

ПолучитьФорму ( GetForm )

Синтаксис:

ПолучитьФорму(< Форма>, <Владелец>, <Ключ уникальности>)

Параметры:

<Форма> Необязательный

Тип: Строка, Объект описания метаданного. Имя формы, как оно задано в конфигураторе или объект описания ме­таданного требуемой формы.

Значение по умолчанию: Если параметр не указан, то использует­ся основная форма, заданная в конфигураторе.

<Владелец> Необязательный

Тип: Форма. Форма, которая будет являться владельцем откры­ваемой формы.

<Ключ уникальности> Необязательный

Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она.

Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.

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

Тип: Форма.

Описание:

Позволяет получить форму отчета.

Пример:

ОтчетОПродажах = Отчеты.Продажи.Создать();

ФормаОтчета = ОтчетОПродажах.ПолучитьФорму();

Методы

ПолучитьМакет ( GetTemplate )

Синтаксис:

ПолучитьМакет(<Макет>)

Параметры:

<Макет> Обязательный

Тип: Строка, Объект описания метаданного. Имя ма­кета, как оно задано в конфигураторе или объект описания мета­данного требуемого макета.

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

Тип: ТабличныйДокумент. Макет обработки.

Описание:

Позволяет получить макет обработки.

Пример:

ИдМакета = "ОбработкаДокументов";

МакетОбр = Обработки.ОбработкаДокументов.ПолучитьМакет(ИдМакета);

ПолучитьФорму ( GetForm )

Синтаксис:

ПолучитьФорму(< Форма>, <Владелец>, <Ключ уникальности>)

Параметры:

<Форма> Необязательный

Тип: Строка, Объект описания метаданного. Имя формы, как оно задано в конфигураторе или объект описания ме­таданного требуемой формы.

Значение по умолчанию: Если параметр не указан, то использует­ся основная форма, заданная в конфигураторе.

<Владелец> Необязательный

Тип: Форма. Форма, которая будет являться владельцем откры­ваемой формы.

<Ключ уникальности> Необязательный

Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она.

Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.

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

Тип: Форма.

Описание:

Позволяет получить форму обработки.

Пример:

ИдФормы = "ОсновнаяФорма";

ФормаОбр = Обработки. ОбработкаДокументов. ПолучитьФорму( ИдФормы);

Создать ( Create )

Синтаксис:

Создать()

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

Тип: ОбработкаОбъект. <Имя обработки>. Объект обра­ботки.

Описание:

Позволяет создать новый экземпляр обработки.

Пример:

ОбработкаДокументов = Обработки.ОбработкаДокументов.Создать();

Методы

ПолучитьМакет ( GetTemplate )

Синтаксис:

ПолучитьМакет(<Макет>)

Параметры:

<Макет> Обязательный

Тип: Строка, Объект описания негаданного. Имя ма­кета, как оно задано в конфигураторе или объект описания мета-данного требуемого макета.

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

Тип: ТабличныйДокумент. Макет обработки.

Описание:

Позволяет получить макет обработки.

ПолучитьФорму ( GetForm )

Синтаксис:

ПолучитьФорму (< Форма-», <Владелец>, <Ключ уникальности>)

Параметры:

<Форма> Необязательный

Тип: Строка, Объект описания метаданного. Имя формы, как оно задано в конфигураторе или объект описания ме­таданного требуемой формы.

Значение по умолчанию: Если параметр не указан, то использует­ся основная форма, заданная в конфигураторе.

<Владелец> Необязательный

Тип: Форма. Форма, которая будет являться владельцем откры­ваемой формы.

<Ключ уникальности> Необязательный

Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она.

Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.

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

Тип: Форма.

Описание:

Позволяет получить форму обработки.

Методы

ПолучитьФорму ( GetForm )

Синтаксис:

ПолучитьФорму (< Полное имя файла> , <Имя формы>, <Владелец>, <Ключ уникальности>)

Параметры:

<Полное имя файла> Обязательный

Тип: Строка. Путь к файлу внешней обработки.

<Имя формы> Необязательный

Тип: Строка, Объект описания метаданных. Имя фор­мы, как оно задано в конфигураторе.

Значение по умолчанию: Если параметр не указан, то использует­ся форма, заданная в качестве основной.

<Владелец> Необязательный

Тип: Форма. Форма, которая будет являться владельцем откры­ваемой формы.

Значение по умолчанию: Неопределено.

<Ключ уникальности> Необязательный

Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована найденная форма.

Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.

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

Тип: Форма.

Описание:

Позволяет получить форму внешней обработки.

Создать ( Create )

Синтаксис:

Создать(<Полное имя файла>)

Параметры:

<Полное имя файла>  Обязательный

Полное имя файла внешней обработки.

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

Тип: ВнешняяОбработка. Объект внешней обработки.

Описание:

Позволяет получить объект внешней обработки по указанному файлу внешней обработки.

Методы

ПолучитьМакет ( GetTempIate )

Синтаксис:

ПолучитьМакет (< Макет>)

Параметры:

<Макет> Обязательный

Тип: Строка, Объект описания метаданного. Имя ма­кета, как оно задано в конфигураторе или объект описания мета­данного требуемого макета.

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

Тип: ТабличныйДокумент. Макет внешней обработки.

Описание:

Позволяет получить макет внешней обработки.

Пример:

МакетОбработки = ВнешОбработка. ПолучитьМакет("Шаблон");

ПолучитьФорму ( GetForm )

Синтаксис:

ПолучитьФорму (< Форма>, <Владелец>, <Ключ уникальности> )

Параметры:

<Форма> Необязательный

Тип: Строка, Объект описания метаданного. Имя формы, как оно задано в конфигураторе или объект описания ме­таданного требуемой формы.

Значение по умолчанию: Если параметр ие указан, то использует­ся основная форма, заданная в конфигураторе.

<Владелец> Необязательный

Тип: Форма. Форма, которая будет являться владельцем откры­ваемой формы.

<Ключ уникальности> Необязательный

Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она.

Значение по умолчанию: Если параметр не указан, сначала всегда

будет искаться уже открытая форма.

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

Тип: Форма.

Описание:

Позволяет получить форму внешней обработки.

Пример:

ФормаОбработки = ВнешОбработка.ПолучитьФорму("ТлавнаяФорма");

««««««««««

1С:Предприятие 8.0

»»»»»»»»»»

Методы

Выбрать ( Select )

Вариант синтаксиса: Для периодического регистра

Синтаксис;

Выбрать{<Начало интервала> , <Конец интервала> , <Отбор>)

Параметры:

<Начало интервала» Необязательный

Тип: Дата, МоментВремени или Граница. Начало интер­вала, за который будут выдаваться записи периодического реги­стра сведений. Если не указан, то будут выдаваться записи с са­мого ранней включительно.

Значение по умолчанию: Неопределено.

<Конец интервала> Необязательный

Тип: Дата, МоментВремени или Граница. Конец интер­вала, за который будут выдаваться записи периодического реги­стра сведений. Если не указан, то будут выдаваться записи до са­мой поздней включительно.

Значение по умолчанию: Неопределено. Описание

<Отбор> Необязательный

Тип: Структура. Задает поле и значение отбора открываемой выборки. Ключ структуры описывает имя поля, а значение струк­туры - значение отбора по этому полю. В качестве полей для от­бора могут задаваться измерения, для которых в конфигураторе признак индексирования установлен в значение "Индексировать" или установлен признак "Ведущее".

Важно! Структура может содержать только один элемент.

Значение по умолчанию: Неопределено.

Вариант синтаксиса: Для непериодического регистра Синтаксис:

Выбрать(< Отбор>)

Параметры:

<0тбор> Необязательный

Тип: Структура. Задает поле и значение отбора открываемой выборки. Ключ структуры описывает имя поля, а значение струк­туры - значение отбора по этому полю. В качестве полей для от­бора могут задаваться измерения, для которых в конфигураторе признак индексирования установлен в значение "Индексировать" или установлен признак "Ведущее".

Важно! Структура может содержать только один элемент. Значение по умолчанию: Неопределено.

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

Тип: РегистрCведенийВыборка.<Имя    регистра сведений>. Сформированная выборка записей регистра сведе­ний.

Описание:

Позволяет сформировать выборку записей регистра сведений.

Пример:

Курсы = РегистрыСведений.КурсыВалют;

ОтборВалют = Новый Структура("Валюта");

ОтборВалют.Валюта = ВыбВалюта;

ВыборкаКурсовВалют = Курсы.Выбрать(,,ОтборВалот);

Пока ВыборкаКурсовВалот.Следующий() Цикл

    Сообщить("Дата " + ВыборкаКурсовВалот.Период *

    " Валюта "+СокрЛП(ВыборкаКурсовВалст.Валюта) +

    ", Курс "+ ВыборкаКурсовВалют.Курс );

КонецЦикла;

ВыбратьПоРегистратору ( SelectByRecorder )

Синтаксис:

ВыбратьПоРегистратору (< Регистратор>)

Параметры:

<Регистратор> Обязательный

Тип: ДокументСсылка. <Имя документа>. Ссылка на до­кумент, являющийся регистратором для записей регистра.

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

Тип:     РегистрСведенийВыборка.<Имя регистра сведений>. Сформированная выборка записей регистра сведе­ний.

Описание:

Позволяет получить выборку по регистратору записей регистра сведений. Применяется для регистров сведений, для которых в конфигураторе установлен режим записи "Подчинение регистра­тору".

Пример:

ВыборкаЦен = РегистрыСведений.МаркетингЦен.ВыбратьПоРегистратору(ВыбРегистратор);

Пока ВыборкаПев.Следующий() Цикл

    Сообщить("Дата " + ВыборкаЦен. Регистратор. ДатаДокумента *

    " Номенклатура "+СокрЛП(ВыборкаЦен.Номенклатура) +

    ", Конкурент "+ ВыборкаЦен.Конкурент );

КонецЦикла ;

Получить ( Get )



Вариант синтаксиса: Для периодического регистра

Синтаксис:

Получить(<Период>, <Измерение 1>, ..., <ИзмерениеN >)

Параметры:

<Период> Обязательный

Тип: Дата, МоментВремени. Определяет момент времени, на который необходимо получить значения ресурсов. Если указан­ный момент времени не совпадает с периодом ни одной записи регистра, то будет возвращена структура, содержащая пустые зна­чения.



<Измерение 1>, ..., <Измерение N > Необязательный

Тип: Произвольный. Набор параметров, который определяет перечень значений измерений, по которым должен выполняться поиск. Порядок параметров должен соответствовать порядку из­мерений регистра как он задан в конфигураторе. Измерения мо­гут задаваться с пропусками. Не указанное значение просто запя­тая. Фиксируются только указанные измерения.

Вариант синтаксиса: Для непериодического регистра Синтаксис:

Получить(< Измерение 1>, ..., <Измерение N >)

Параметры:

<Измерение 1>, . . ., <Измерение N > Необязательный

Тип: Произвольный. Набор параметров, который определяет перечень значений измерений, по которым должен выполняться поиск. Порядок параметров должен соответствовать порядку из­мерений регистра как он задан в конфигураторе. Измерения могут задаваться с пропусками. Не указанное значение просто запя­тая. Фиксируются только указанные измерения.

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

Тип: Структура. Структура, содержащая значения ресурсов.

Описание:

Позволяет получить значения ресурсов записи регистра, соответствующей указанным значениям измерений регистра и периоду (для периодических регистров).

ПолучитьМакет ( GetTemplate )



Синтаксис;

ПолучитьМакет(< Макет>)

Параметры:

<Макет> Обязательный

Тип:Строка, Объект описания метаданного. Имя ма­кета, как оно задано в конфигураторе или объект описания мета­данного требуемого макета.

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

Тип: ТабличныйДокумент. Созданный макет.

Описание:

Позволяет получить макет регистра сведений.

Пример:

Таб = СоздатьОбъект("ТабличныйДокумент");

Макет = РегистрыСведений.КурсыВалют.ПолучитьМакет("ТаблицаКурсов");

Таб.Вывести(Макет.ПолучитьОбласть("Шапка"));

Таб.Показать();

ПолучитьПервое ( GetFirst )



Синтаксис:

ПолучитьПервое (< Начало периодам, <Измерение 1> , ..., <Измерение N > )

Параметры:

<Начало периода > Необязательный



Тип: Дата, МоментВремени или Граница. Определяет момент времени, начиная с которого необходимо получить значе­ния ресурсов. Если параметр не указан, то будут возвращены зна­чения ресурсов самой первой записи регистра.

Значение по умолчанию: Неопредепено.

<Измерение 1>, . . - , <Измерение N > Необязательный

Тип: Произвольный. Набор параметров, который определяет перечень значений измерений, по которым должен выполняться поиск. Порядок параметров должен соответствовать порядку из­мерений регистра как он задан в конфигураторе. Измерения мо­гут задаваться с пропусками. Не указанное значение просто запя­тая. Фиксируются только указанные измерения.

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

Тип: Структура. Возвращает структуру, содержащую значения ресурсов.

Описание:

Позволяет получить значения ресурсов наиболее ранней записи регистра, соответствующей указанным периоду и значениям из­мерений регистра. Метод применим только для периодических регистров сведений. Поиск по периоду осуществляется "включи­тельно", т.е. если существует запись с таким же значением одно­именного свойства, то она и будет найдена.

Пример:

МаркетингЦен = РегистрыСведений.МаркетингЦен;

Цена = МаркетингЦен.ПолучитьПервое(ВыбДата, ВыбКлиент, ВыбТовар).Цена;

ПолучитьПоследнее ( GetLast )

Синтаксис:

ПолучитьПоследнее (< Конец периода> , <Измерение 1>, ..., <Измерение N > )

Параметры;

<Конец периода > Необязательный

Тип: Дата, МоментВремени или Граница. Определяет момент времени, по который необходимо получить значения ре­сурсов. Если параметр не указан, то будут возвращены значения ресурсов самой последней записи регистра.

Значение по умолчанию: Неопределено.

<Измерение 1>, . . . , <Измере ние N >     Необязательный

Тип: Произвольный. Набор параметров, который определяет перечень значений измерений, по которым должен выполняться поиск. Порядок параметров должен соответствовать порядку из­мерений регистра как он задан в конфигураторе. Измерения мо­гут задаваться с пропусками. Не указанное значение просто запя­тая. Фиксируются только указанные измерения.



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

Тип: Структура. Возвращает структуру, содержащую значения ресурсов.

Описание:

Позволяет получить значения ресурсов наиболее поздней записи регистра, соответствующей указанным периоду и значениям из­мерений регистра. Метод применим только для периодических регистров сведений.

Пример:

Доллары = Справочники.Валюты.НайтиПоНаименованио("USD");

Курсы     = РегистрыСведений.КурсыВалют;

ТекКурс = Курсы.ПолучитьПоследнее(ТекущаяДата(), Доллары);

Сообщить("Текущий курс доллара: " + ТекКурс.Курс + " руб.");

ПолучитьФорму ( GetForm )



Синтаксис:

ПолучитьФорму (< Форма>, <Владелец>, <Ключ уникальности> )

Параметры:

<Форма> Обязательный

Тип: Строка. Имя формы, как оно задано в конфигураторе.

<Владелец> Необязательный

Тип: Форма. Форма, которая будет являться владельцем откры­ваемой формы.

<Ключ уникальности> Необязательный

Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она.

Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.

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

Тип: Форма.

Описание:

Позволяет получить форму регистра сведений.

Пример:

КурсыВалют = РегистрыСведений.КурсыВалют;

ФормаВалют = КурсыВалют.ПоялчитьФорму("ФормаСписка");

ФормаВалют.Открыть();

ПолучитьФормуРедактированияЗаписи ( GetRecordEditingForm )



Синтаксис:

ПолучитьФормуРедактированияЗаписи(< Форма>, <Владелец>, <Ключ уникальности>)

Параметры:

<Форма> Необязательный

Тип. Строка, Объект описания метаданного Имя формы, как оно задано в конфигураторе или объект описания ме-тадаиного требуемой формы.

Значение по умолчанию: Если параметр не указан, то использует­ся основная форма, заданная в конфигураторе.



<Владелец> Необязательный

Тип Форма Форма, которая будет являться владельцем откры­ваемой формы.

<Ключ уникальности> Необязательный

Тип' Произвольный В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она.

Значение по умолчанию. Если параметр не указан, сначала всегда будет искаться уже открытая форма.

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

Тип Форма.

Описание:

Позволяет получить форму редактирования записи регистра све­дений

Пример:

РегистрыСведений.КурсыВалют.ПолучитьФормуСписка().Открыть();

ПолучитьФормуСписка ( GetFormList )



Синтаксис:

ПолучитьФормуСписка (< Форма> , <Владелец> , <Ключ уникальности>)

Параметры:

<Форма> Необязательный

Тип Строка, Объект описания метаданного Имя форты, как оно задано в конфигураторе или объект описания ме­таданного требуемой формы.

Значение по умолчанию- Если параметр не указан, то использует­ся основная форма, заданная в конфигураторе

<Владелец> Необязательный

Тип Форма. Форма, которая будет являться владельцем откры­ваемой формы

<Ключ уникальности> Необязательный

Тип Произвольный В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она

Значение по умолчанию Если параметр не указан, сначала всегда будет искаться уже открытая форма.

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

Тип Форма.

Описание:

Позволяет получить форму списка регистра сведений.

Пример:

РегмстрыСвеяений.КурсыВалют.ПолучитьФормуСписка().Открыть();

СоздатьКлючЗаписи ( CreateRecordKey )



Синтаксис:

СоздатьКлючЗаписи (< Значения ключа> )

Параметры:

<3начения клоча> Обязательный

Тип: Структура. Структура, содержащая значения для заполне­ния свойств ключа записи.



Имена элементов структуры должны соответствовать именам ключевых полей.

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

Тип:   РегистрСведенийКлючЗаписи.<Имя   регистра сведений>. Созданный ключ записи.

Описание:

Позволяет создать ключ записи по переданной структуре.

СоздатьМенеджерЗаписи ( CreateRecordManager )

Синтаксис:

СоздатьМенеджерЗаписи()

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

Тип: РегистрСведенийМенеджерЗаписи.<Имя регистра сведений>. Созданный менеджер записи регистра сведений.

Описание:

Создает объект для управления записью регистра сведений.

Пример:

РегистрыСведений.КурсыВалют.СоздатьМенеджерЗаписи();

СоздатьНаборЗаписей ( CreateRecordSet )



Синтаксис:

СоздатьНаборЗаписей()

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

Тип: РегистрСведенийНаборЗаписей.<Имя регистра сведений>. Созданный набор записей.

Описание:

Позволяет создать набор записей регистра сведений. Набор запи­сей создается пустым.

Пример:

КурсыВалют = РегистрыСведений.КурсыВалют;

НаборКурсов = КурсыВалют.СоздатьНаборЗаписей();

СрезПервых ( SliceFirst )



Синтаксис:

СрезПервых(<Начало периода>, <Отбор>)

Параметры:

<Начало периода> Необязательный

Тип: Дата, МоментВремени или Граница. Определяет момент времени, начиная с которого необходимо выбрать записи.

Значение по умолчанию: Неопределено.

<Отбор>Необязательный

Тип: Структура. Структура, содержащая отбор по измерениям регистра.

В переданной структуре должны содержаться те измерения, по которым должны быть отфильтрованы записи. В элементе струк­туры задается имя и значение отбора.

Значение по умолчанию: Неопределено.

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

Тип: ТаблицаЗначений. Таблица значений, заполненная дан­ными найденных записей регистра сведений.

Описание:

Позволяет получить наиболее ранние записи регистра, соответст­вующие установленным в параметрах метода значениям ключе­вых полей. Записи подбираются для каждого сочетания из всех имеющихся значений измерений регистра. Метод применим толь­ко для периодических регистров сведений.



Пример:

МаркетингЦен = РегистрыСведений.МаркетингЦен;

ОбновленныеСегодняЦены = МаркетингЦен.СрезПервых(ТекущаяДата());

СрезПоследних ( SliceLast )



Синтаксис:

СрезПоследних{<Конец периода> , <Отбор>)

Параметры:

< Конец периода > Необязательный

Тип. Дата, МоментВремени или Граница. Определяет момент времени, заканчивая которым необходимо выбрать запи­си.

Значение по умолчанию: Неопределено.

<Отбор> Необязательный

Тип: Структура. Структура, содержащая отбор по измерениям регистра.

В переданной структуре должны содержаться те измерения, по которым должны быть отфильтрованы записи. В элементе струк­туры задается имя и значение отбора.

Значение по умолчанию: Неопределено. Описание

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

Тип: ТаблицаЗначений. Таблица значений, заполненная дан­ными найденных записей регистра сведений.

Описание:

Позволяет получить наиболее поздние записи регистра, соответ­ствующие установленным в параметрах метода значениям ключе­вых полей. Записи подбираются для каждого сочетания из всех имеющихся значений измерений регистра. Метод применим толь­ко для периодических регистров сведений.

Пример:

МаркетингЦен = РегистрыСведений МаркетингЦен ;

ТекущиеЦеныКонкурентов = МаркетингЦен.СрезПоследних(ТекущаяДата());

Методы

ПолучитьМенеджерЗаписи(GetRecorderManager)

Синтаксис:

ПолучитьМенеджерЗаписи()

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

Тип: РегистрСведенийМенеджерЗаписи.<Имя регистра сведений>. Менеджер записи регистра сведений.

Описание:

Позволяет получить объект для модификации, записи и удаления записи регистра сведений, на которой в данный момент спозиционирована выборка.

Следующий ( Next )

Синтаксис:

Следующий()

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

Тип: Булево. Истина - запись выбрана.

достигнут конец выборки.

Описание:

Выполняет получение очередной записи выборки. Для обхода записей регистра нужно после получения выборки вызвать дан­ный метод для позиционирования на первую запись и далее вы­зывать до тех пор, пока не будет возвращено значение Ложь.

Пример:

// найдем максимальную цену у конкурентов на товар ВыбТовар

МаркетингЦен = РегистрыСведений.МаркетингЦен;

ОтборПоТовару = Новый Структура("Номенклатура");

ОтборПоТовару.Номенклатура = ВыбТовар;

ЦеныТовара = МаркетингЦен.Выбрать(,,ОтборПоТовару);

МаксЦена = 3;

Конкурент = "Не найден";

Пока ЦеныТовара.Следующий() Цикл

    Если ЦеныТовара.Цена > МаксЦена Тогда МаксЦена = ЦеныТовара.Цена;

        Конкурент = ЦеныТовара.Конкурент;

     КонецЕсли;

КонецЦикла;

Предупреждение("Максимальня цена " + СокрЛП(ВыбТовар) + " = " + МаксЦена + " руб. у  " + СокрЛП (Конкурент) + ".");

Методы

МоментВремени ( PointOfTime )

Синтаксис:

МоментВремени()

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

Тип: МоментВремени.

Описание:

Позволяет определить момент времени, соответствующий за­писи регистра. Применяется для регистров сведений, для которых в конфигураторе установлен режим записи "Подчинение регист­ратору".

Методы

ЗаписатьВФорме ( WritelnForm )

Синтаксис:

ЗаплсатьВФорме()

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

Тип: Булево. Истина - объект записан.

Ложь - нет.

Описание:

Позволяет записать объект, открытый в форме.

Пример:

Если ЗаписатьВФорме() Тогда

Сообщить("Запись занесена в ИБ.");

КонецЕсли;

Методы

ЗаписатьВФорме ( WritelnForm )

Синтаксис:

ЗаписатьВФорме()

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

Истина - объект записан. Ложь - нет.

Описание:

Позволяет записать объект, открытый в форме.

Пример:

Если ЗаписатьВФорме() Тогда

Сообщить("Объект записан.') ;

КонецЕсли;

Методы

Выбрать ( Select )

Синтаксис:

Выбрать(<Начало интервала> , <Конец интервала> , <Отбор>)

Параметры:

<Начало интервала> Необязательный.

Тип: Дата, МоментВремени или Граница.. Начало ин­тервала, за который будут выбираться записи регистра накопле­ния.

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

Значение по умолчанию: Неопределено.

<Конец интервала> Необязательный

Тип: Дата, МоментВремени или Граница.. Конец интер­вала, за который будут выбираться записи регистра накопления.

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

Значение по умолчанию: Неопределено.

<Отбор> Необязательный

Тип: Структура. Задает поле и значение отбора открываемой выборки. Ключ структуры описывает имя поля, а значение струк­туры - значение отбора по этому полю. В качестве полей для от­бора могут задаваться измерения, для которых в конфигураторе признак индексирования установлен в значение "Индексировать".

Важно! Структура может содержать только один элемент.

Значение по умолчанию: Неопределено.

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

Тип: РегистрНакопленияВыборка.<Имя    регистра накопления>. Сформированная выборка записей регистра на­копления.

Описание:

Позволяет получить выборку записей регистра накопления.

Пример:

// Посчитаем, сколько отгружено с начала года

МПЗ = РегистрыНакопления.УчетНоменклатуры;

ОтборПоТовару = Новый Структура("Номенклатура");

ОтборПоТовару.Номенклатура = ВыбТовар;

НачДата = НачалоГода(ТекущаяДата()) ;

КонДата = ТекущаяДата() ;

ВыборкаМПЗ = МПЗ.Выбрать(НачДата,КонДата,ОтборПоТовару);

Расход =0;

Пока ВыборкаМПЗ.Следующий() Цикл

    Если ВыборкаМПЗ.Расход Тогда

        Расход = Расход + ВыборкаМПЗ.Количество;

    КонецЕсли;

КонецЦикла ;

Предупреждение("Отгружено с начала года " + СокрЛП(ВыбТовар) + " = "+ Расход + " шт.");

ВыбратьПоРегистратору

Синтаксис:

ВыбратьПоРегистратору (< Регистратор>)

Параметры:

<Регистратор> Обязательный

Тип: Документ-Ссылка. <Имя документа>. Ссылка на до­кумент, являющийся регистратором для записей регистра.

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

Тип:   РегистрНакопленияВыборка.<Имя   регистра накопления>. Сформированная выборка записей регистра на­копления.

Описание:

Позволяет получить выборку по регистратору записей регистра накопления.

Обороты ( Turnovers )

Синтаксис:

Обороты(<Начало периода> , <Конец периода> , <Отбор>, <Измерения>, <Ресурсы>)

Параметры:

<Начало периода> Необязательный

Тип: Дата, Момент Времени, Граница. Момент времени, начиная с которого необходимо получить обороты. Если параметр не указан или установлен в Неопределено, то обороты будут получены начиная с момента ведения информационной базы. Ес­ли в качестве параметра передана Дата или МоментВремени, то обороты за указанную дату (момент времени) будут включены в результирующую таблицу значений.

Значение по умолчанию: Неопределено.

<Конец периода > Необязательный

Тип: Дата, МоментВремени, Граница. Момент времени, определяющий конец периода за который необходимо получить обороты. Если параметр не указан или установлен в Неопределено, то обороты будут получены до самого позднего движения регистра. Если в качестве параметра передана Дата

или Момент Времени, то обороты за указанную дату (момент времени) будут включены в результирующую таблицу значений.

Значение по умолчанию: Неопределено.

<От6ор> Необязательный

Тип: Структура. Структура, содержащая набор значений изме­рений регистра, по которым надо отбирать обороты. Имя ключа структуры должно совпадать с именем измерения регистра, за­данного в конфигураторе.

Значение по умолчанию: Неопределено.

<Измерения> Необязательный

Тип: Строка. Список измерений, для которых надо разворачи­вать обороты. Строка, содержащая имена измерений, разделенные запятыми. Если параметр не указан или указана пустая строка, то обороты будут сформированы по всем измерениям.



Значение по умолчанию: Пустая строка.

<Ресурсы> Необязательный

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

Если параметр не указан или указана пустая строка, то обороты будут сформированы по всем ресурсам.

Значение по умолчанию: Пустая строка.

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

Тип: ТаблицаЗначений. Сформированная таблица значений.

Описание:

Позволяет получить обороты регистра накопления за заданный момент времени. Есть возможность фильтрации по значениям измерений. Возвращает таблицу значений, содержащую колонки с измерениями, указанными в параметре Измерения, и по две ко­лонки на каждый ресурс, указанный в параметре Ресурсы. На звания колонок для ресурсов формируются следующим образом "<Имя ресурса>Приход" и "<Имя ресурса>Расход".

Пример:

ОстаткиМПЗ = РегистрыНакопления.ОстаткиМПЗ;

ФильтрМПЗ   =  Новый Структура("Номенклатура","Склад");

ФильтрМПЗ.Номенклатура = ВыбМПЗ;

ФильтрМПЗ.Склад        = ВыбСклад;

ТабОборотов = ОстаткиМПЗ.Обороты(ДатаНач, ДатаКон, ФильтрМПЗ, "Номенклатура,Склад", "Количество") ;

Остатки ( Balance )

Синтаксис:

Остатки(< Момент времени> , <Отбор>, <Измерения>, <Ресурсы>)

Параметры:

<Момент времени> Необязательный

Тип: Дата, МоментВремени, Граница. Момент времени, на который необходимо получить остатки. Если параметр не ука­зан или установлен в Неопределено, то будут получены теку­щие остатки (на максимальную дату движений регистра). Если в качестве параметра передана Дата, то остатки будут получены на начало дня, если МоментВремени - то в остатках не будут учтены движения регистра, произошедшие в тот же момент вре­мени.

Значение по умолчанию: Неопределено.

<Отбор> Необязательный

Тип: Структура. Структура, содержащая набор значений изме­рений регистра, по которым надо отбирать итоги. Имя Ключа структуры должен совпадать с именем измерения регистра, за­данного в конфигураторе.



Значение по умолчанию: Неопределено. Описание

<Измерения> Необязательный

Тип: Строка. Список измерений, для которых надо получить остатки. Строка, содержащая имена измерений, разделенные за­пятыми.

Если параметр не указан или указана пустая строка, то остатки будут сформированы по всем измерениям.

Значение по умолчанию: Неопределено.

<Ресурсы> Необязательный

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

Если параметр не указан или указана пустая строка, то остатки будут сформированы по всем ресурсам.

Значение по умолчанию: Пустая строка.

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

Тип: ТаблицаЗначений. Сформированная таблица значений.

Описание:

Позволяет получить остатки регистра накопления на заданный момент времени. Есть возможность фильтрации по значениям измерений, а также получения остатков в разрезе других измере­ний. Возвращает таблицу значений, содержащую колонки с изме­рениями, указанными в параметре Измерения, и колонки с ре­сурсами, указанными в параметре Ресурсы.

Замечание! Использование данного метода имеет смысл толь­ко для регистров, у которых в конфигураторе указан вид регистра "Остатки".

Пример:

ОстаткиМПЗ = РегистрыНакопления.ОстаткиМПЗ;

ФигьтрМПЗ    = Новый Структура() ;

ФильтрМПЗ.Вставить("Номенклатура",ВыбМПЗ);

ФильтрМПЗ.Вставить("Склад", ВыбСклад) ;

ТабОстатков = ОстаткиМПЗ. Остатки (ВыбДата, ФильтрМПЗ, "Номенклатура,Склад", "Количество") ;

ПересчитатьИтоги ( RecalcTotals )

Синтаксис:

ПересчитатьИтоги()

Описание:

Позволяет осуществить полный пересчет итогов регистра накоп­ления.

Пример:

Регистры.ОстаткиМПЗ.ПересчитатьИтоги();

ПолучитьМакет ( GetTemplate )

Синтаксис:

ПолучитьМакет(< Макет>)

Параметры:

<Макет> Обязательный

Тип: Строка, Объект описания метаданного. Имя ма­кета, как оно задано в конфигураторе или объект описания мета­данного требуемого макета.



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

Тип: ТабличныйДокумент. Созданный макет.

Описание:

Позволяет получить макет регистра накопления.

ПолучитьПериодРасчитанныхИтогов

Синтаксис:

ПолучитьПериодРасчитанныхИтогов()

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

Тип: Дата. Период рассчитанных итогов.

Описание:

Позволяет получить период рассчитанных итогов. Имеет смысл только для регистров остатков.

Пример:

ВыбДата = Регистры.ОстаткиМПЗ.ПолучитьПериодРасчитанныхИтогов();

См. также:

РегистрНакопленияМенеджер.<Имя регистра накопления>. Метод УстановитьПериодРассчитанныхИтогов.

ПолучитьФорму ( GetForm )



Синтаксис:

ПолучитьФорму(<Форма>, <Владелец>, <Ключ уникальности>)

Параметры:

<Форма> Обязательный

Тип: Строка. Имя формы, как оно задано в конфигураторе.

<Владелец> Необязательный

Тип: Форма. Форма, которая будет являться владельцем откры­ваемой формы.

<Ключ уникальности> Необязательный

Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она.

Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.

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

Тип: Форма.

Описание:

Позволяет получить форму регистра накопления.

ПолучитьФормуСписка ( GetFormList )



Синтаксис:

ПолучитьФормуСписка (< Форма>, <Владелец> , <Ключ уникальности>}

Параметры:

<Форма> Необязательный

Тип: Строка, Объект описания метаданного. Имя формы, как оно задано в конфигураторе или объект описания ме­таданного требуемой формы.

Значение по умолчанию: Если параметр не указан, то использует­ся основная форма, заданная в конфигураторе.

<Владелец> Необязательный

Тип: Форма. Форма, которая будет являться владельцем откры­ваемой формы.

<Ключ уникальности> Необязательный

Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она.



Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.

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

Тип: Форма.

Описание:

Позволяет получить форму списка регистра накопления.

Пример:

РегистрыНакопления.УчетНоменклатуры.ПолучитьФормуСписка().Открыть();

СоздатьКлючЗаписи ( CreateRecordKey )



Синтаксис:

СоздатьКлючЗаписи(< Значения ключа>)

Параметры:

< Значения ключа> Обязательный

Тип: Структура.

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

Тип: РегистрНакопленияКлючЗаписи.<Имя регистра накопления>. Созданный ключ записи.

Описание:

Создает ключ записи по переданной структуре.

СоздатьНаборЗаписей ( CreateRecordSet )



Синтаксис:

СоздатьНаборЗаписей()

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

Тип: РегистрНакопленияНаборЗаписей.<Имя регистра накопления>. Созданный набор записей.

Описание:

Позволяет создать набор записей регистра накопления. Набор записей создается пустым.

Пример:

ОстаткиТоваров = РегистрыНакопления.УчетНоменклатуры;

НаборЗаписейМПЗ = ОстаткиТоваров.СоздатьНаборЗаписей();

УстановитьПериодРассчитанныхИтогов ( SetTotalsMaxPeriod )

Синтаксис:

УстановитьПериодРассчитанныхИтогов(< Период>)

Параметры:

<Период> Обязательный

Тип: Дата. Период, на который необходимо рассчитать итоги.

Описание:

Позволяет установить период, на который рассчитаны итоги. Пе­риодичность расчета - месяц. Период устанавливается на начало месяца. Имеет смысл только для регистров остатков.

Примечание:

Период, на который рассчитаны итоги, влияет только на произво­дительность получения остатков по данному регистру. Для полу­чения итогов регистра после установленного периода расчета бу­дут использоваться полученные в результате использования ме­тода результаты.

Пример:

Регистры.ОстаткиМПЗ.УстановитьПериодРасчитанныхИтогов(ВыбДата) ;

Методы

Следующий ( Next )

Синтаксис:

Следующий()

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

Тип: Булево. Истина - запись выбрана.

Ложь- запись не выбрана - достигнут конец выборки.

Описание:

Выполняет получение следующей записи выборки. Для обхода записей регистра нужно после получения выборки вызвать дан­ный метод для позиционирования на первую запись и далее вы­зывать до тех пор, пока не будет возвращено значение Ложь.

Методы

Обновить ( Refresh )

Синтаксис:

Обновить()

Описание:

Вызывает перечитывание данных списка.

Методы

Вставить ( Insert )

Синтаксис:

Вставить(<Индекс>)

Параметры:

<Индекс> Обязательный

Тип: Число. Индекс позиции, на которую надо вставить новую запись.

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

Тип: РегистрНакопленияЗапись.<Имя    регистра накопления>. Созданная запись регистра.

Описание:

Позволяет вставить новую запись в набор на указанную позицию.

Выбран ( Selected )

Синтаксис:

Выбран()

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

Тип: Булево. Истина, если считан.

Ложь, если иначе. В частности, если набор не считывался и не записывался, а также если записывался с добавлением записей.

Описание:

Позволяет определить, считан ли набор записей.

Примечание:

При изменении отбора считается, что набор перестает быть счи­танным.

Выгрузить ( Unload )

Синтаксис:

Выгрузить()

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

Тип: ТаблицаЗначений. Сформированная таблица значений.

Описание:

Создает таблицу значений и копирует в нее все записи набора. Структура полученной таблицы совпадает со структурой набора записей.

ВыгрузитьКолонку ( UnloadColumn )

Синтаксис:

ВыгрузитьКолонку(< Имя поля>)

Параметры:

<Имя поля> Обязательный

Тип: Строка. Имя поля записей набора, значения из которого будут выгружены в массив.

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

Тип: Массив. Сформированный массив значений.

Описание:

Позволяет выгрузить значения заданного поля у записей набора в массив значений. Значения записей выгружаются в элементы массива, имеющие тот же индекс.

Добавить( Add )

Синтаксис:

Добавить()

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

Тип:    РегистрНакопленияЗапись.<Имя    регистра накопления>. Запись регистра сведений, помещенная в набор.

Описание:

Позволяет создать новую запись в наборе.

Загрузить ( Load )

Синтаксис:

Загрузить(< Таблица значений>)

Параметры:

<Таблица значений> Обязательный

Тип: ТаблицаЗначений. Таблица значений, содержащая данные для заполнения набора записей.

Описание:

Очищает набор записей и заполняет его значениями из указанной таблицы значений. Заполняются значения доступных для записи свойств записей регистра накопления, имена которых совпали с именами колонок таблицы значений.

ЗагрузитьКолонку ( LoadColumn )



Синтаксис:

ЗагрузитьКолонку( <Массив> , <Имя поля>)

Параметры:

<Массив> Обязательный

Тип: Массив. Массив, содержащий значения для заполнения ко­лонки набора.

<Имя поля> Обязательный

Тип: Строка. Имя поля записей набора, в которое будут загру­жаться значения из массива.

Описание:

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

Записать ( Write )



Синтаксис:

Записать(< Замещать> )

Параметры:

<3амещать> Необязательный

Тип: Булево. Замещать записи по установленному отбору.

Если значение параметра Истина, то перед записью существую­щие записи будут удалены.

Значение по умолчанию: Истина.

Описание:

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

Индекс ( IndexOf )



Синтаксис:

Индекс(< Запись>)

Параметры:

<3апись> Обязательный

Тип:    РегистрНакопленияЗапись.<Имя     регистра накопления>. Запись набора, для которой необходимо полу­чить индекс.

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

Тип: Число. Индекс записи в наборе.

Описание:

Позволяет определить индекс записи в наборе.

Итог ( Total )



Синтаксис:

Итог(<Имя поля>)

Параметры:

<Имя поля> Обязательный

Тип: Строка. Имя поля записей набора, по которому необходи­мо подсчитать итог.

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

Тип: Число. Числовое значения результата вычисления.

Описание:

Позволяет вычислить итог по одному из полей набора.

Количество ( Count )

Синтаксис:

Количество()

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

Тип: Число. Количество записей в наборе.

Описание:

Позволяет получить количество записей в наборе.



Пример:

Сообщить(" Записей в наборе - " + НаборЗаписейМПЗ. Количество());

Модифицированность ( Modified )



Синтаксис:

Модифицированность()

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

Тип: Булево. Истина - если записи изменены.

Ложь - если записи не изменены.

Описание:

Позволяет определить, были ли изменены записи в наборе.

Пример:

Если НаборЗаписейМПЗ.Модифицированность() Тогда НаборЗаписейМПЗ.Записать();

КонецЕсли;

Очистить ( Clear )



Синтаксис:

Очистить()

Описание:

Позволяет очистить набор, удаляя из него все записи.

ПолучитьФорму ( GetForm )



Синтаксис:

ПолучитьФорму(<Форма> , <Владелец> , <Ключ уникальности>)

Параметры:

<Форма> Необязательный

Тип. Строка, Объект описания метаданного. Имя формы, как оно задано в конфигураторе или объект описания ме-таданного требуемой формы.

Значение по умолчанию: Если параметр не указан, то использует­ся основная форма, заданная в конфигураторе.

<Владелец> Необязательный

Тип Форма. Форма, которая будет являться владельцем откры­ваемой формы.

<Ключ уникальности> Необязательный

Тип Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она.

Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.

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

Тип Форма.

Описание:

Позволяет получить форму набора записей регистра накопления.

Прочитать ( Read )

Синтаксис:

Прочитать()

Описание:

Позволяет выполнить чтение записей из информационной базы по установленному отбору.

Пример:

ОстаткиМПЗ = РегистрыНакопления.УчетНоменклатуры;

НаборЗаписейМПЗ ОстаткиМПЗ.СоздатьНаборЗаписей();

Док = НаборЗаписейМПЗ.Отбор.Регистратор;

Док.Установить(ВыбДок);

НаборЗаписейМПЗ.Прочитать();

Сдвинуть ( Move )



Синтаксис:

Сдвинуть(< Запись>, <Смещение>)



Параметры:

<3апись> Обязательный

Тип:     Число,     РегистрНакопленияЗапись.<Имя регистра накопления>. Индекс сдвигаемой записи либо сама запись.

<Смещение> Обязательный

Тип" Число. Количество позиций, на которое следует сдвинуть запись. Положительное значение соответствует смещению записи в сторону конца списка записей набора (увеличение индекса), отрицательное - к началу.

Описание:

Позволяет сдвинуть запись в наборе на указанное число позиций.

Удалить ( Remove )

Синтаксис:

Удалить (< Запись> )

Параметры:

<3апись> Обязательный

Тип.     Число,     РегистрНакопленияЗапись.<Имя регистра накопления>. Индекс удаляемой записи либо сама запись.

Описание:

Позволяет удалить запись из набора по указанному индексу запи­си или объекту записи регистра накопления.

УстановитьАктивность ( SetActive )

Синтаксис:

УстановитьАктивность(< Активность> )

Параметры:

<Активность> Обязательный

Тип: Булево. Истина - записи учитываются в итогах регист­ра.

Ложь - записи не учитываются в итогах регистра.

Описание:

Позволяет изменить значение свойства Активность у всех записей, входящих в набор.

Пример:

НаборЗаписейМПЗ.УстановитьАктивность(Истина);

Методы

МоментВремени ( PointOfTime )

Синтаксис:

МоментВремени()

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

Тип: МоментВремени.

Описание:

Позволяет определить момент времени, соответствующий за­писи регистра.

Методы

ЗаписатьВФорме ( WritelnForm )

Синтаксис:

ЗаписатьВФорме()

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

Тип: Булево. Истина - объект записан.

Ложь - нет.

Описание:

Позволяет записать объект, открытый в форме.

Пример:

Если ЗаписатьВФорме() Тогда

Сообщить("Объект записан.");

КонецЕсли;

Методы

Найти ( Find )

Синтаксис:

Найти(<Значение поиска> )

Параметры:

<3начение поиска> Обязательный

Значение, по которому будет выполняться поиск. Тип значения должен соответствовать типу критерия отбора.

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

Тип: Массив. Массив ссылок на объекты, в которых использует­ся указанное значение отбора.

Описание:

Позволяет найти объекты информационной базы, входящие в со­став отбора, в которых использовано указанное значение отбора.

Примечание:

Состав объектов метаданных, входящих в состав отбора, задается при конфигурировании.

Пример:

МассивСсылок = КритерииОтбора.Контрагенты.Найти(ВыбКонтрагент);

Для Каждого Ссылка Из МассивСсылок Цикл Сообщить(Ссылка);

КонецЦикла;

ПолучитьФорму ( GetForm )

Синтаксис:

ПолучитьФорму (< Форма> . <Владелец> , <Ключ уникальности>}

Параметры:

<Форма> Необязательный

Тип: Строка, Объект описания метаданного. Имя формы, как оно задано в конфигураторе или объект описания ме­таданного требуемой формы.

Значение по умолчанию: Если параметр не указан, то использует­ся основная форма, заданная в конфигураторе.

<Владелец> Необязательный

Тип: Форма. Форма, которая будет являться владельцем откры­ваемой формы.

<Ключ уникальности> Необязательный

Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она.

Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.

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

Тип: Форма.

Описание:

Позволяет получить форму журнала документов.

Методы

Вставить ( Insert )

Синтаксис:

Вставить{<Индекс>)

Параметры:

<Индекс> Обязательный

Тип: Число. Индекс позиции, на которую надо вставить новую запись.

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

Тип:РегистрСведенийЗапись.<Имя регистра сведений>. Созданная запись регистра.

Описание:

Позволяет вставить новую запись в набор на указанную позицию.

Важно! Метод доступен только для набора записей регистра сведений, в котором записи подчинены регистратору.

Пример:

НоваяЦена = НаборЦенКонкурентов.Вставить(0);

Выбран ( Selected )

Синтаксис:

Выбран()

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

Тип: Булево. Истина, если не изменялся.

Ложь, если изменялся. В частности, если набор не считывался и не записывался, а также если записывался с добавлением записей.

Описание:

Позволяет определить считан ли набор записей.

Примечание:

При изменении отбора считается, что набор перестает быть счи­танным.

Пример:

Если Не НаборКурсов.Выбран() Тогда НаборКурсов.Прочитать() ;

КонеиЕсли;

Выгрузить ( Unload )

Синтаксис:

Выгрузить()

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

Тип: ТаблицаЗначений. Созданная таблица значений.

Описание:

Позволяет скопировать в таблицу значений все записи набора. Структура полученной таблицы совпадает со структурой набора записей.

Пример:

ТаблицаКурсов = НаборКурсов.Выгрузить();

ВыгрузитьКолонку( UnloadColumn )

Синтаксис:

ВыгрузитьКолонку(<Имя поля>)

Параметры:

<Имя поля> Обязательный

Тип: Строка. Имя поля записей набора, значения из которого будут выгружены в массив.

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

Тип: Массив. Сформированный массив значений.

Описание:

Позволяет выгрузить значения заданного поля у записей набора в массив значений. Значения записей выгружаются в элементы массива, имеющие тот же индекс.

Пример:

МассивКурсов = НаборКурсов.ВыгрузитьКолонку("Курс");

Добавить ( Add )

Синтаксис:

Добавить()

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

Тип: РегистрСведенийЗапись.<Имя регистра сведений>. Запись регистра сведений, помещенная в набор.

Описание:

Позволяет создать новую запись в наборе.

Пример:

НовыйКурс = НаборКурсов.Добавить();

Загрузить( Load )



Синтаксис:

Загрузить(<Таблица значений>)

Параметры:

<Таблица значений> Обязательный

Тип: ТаблицаЗначений. Таблица значений, по которой произ­водится заполнение набора записей.

Описание:

Очищает набор записей и заполняет его значениями из передан­ной таблицы значений. Заполняются значения у колонок, имена которых совпали.

Пример:

НаборКурсов.Загрузить(ТаблКурсов) ;

ЗагрузитьКолонку ( LoadColumn )



Синтаксис:

ЗагрузитьКолонку (<Массив>, <Имя поля>)

Параметры:

<Массив> Обязательный

Тип: Массив. Массив, содержащий значения для заполнения ко­лонки набора.

<Имя поля> Обязательный

Тип: Строка. Имя поля записей набора, в которое будут загру­жаться значения из массива.

Описание:

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

Пример:

НаборКурсов.ЗагрузитьКолонку(МассивКурсов, "Курс");

Записать ( Write )



Синтаксис:

Записать (< 3амещать> )

Параметры:

<3амещать> Необязательный

Тип: Булево. Замещать записи по установленному отбору. Если значение параметра Истина, то перед записью существующие записи будут удалены.

Значение по умолчанию: Истина.

Описание:

Позволяет записать набор записей в информационную базу. В зависимости от переданного параметра, может быть выполнено добавление записей или их замещение. Если указано замещение, то перед выполнением записи будет выполнено удаление сущест­вующих записей в соответствии с текущими установками отбора, если данный параметр установлен в Ложь, то запись будет вы­полнена только в случае отсутствия в информационной базе дру­гих записей с такими же значениями измерений и периодом (для периодических регистров). Если для регистра сведений, подчи­ненного регистратору, выполняется добавление записей, то после выполнения записи набор очищается.



Пример:

НаборКурсов.Записать();

Индекс ( IndexOf )



Синтаксис:

Индекс(< Запись>)

Параметры:

<3апись> Обязательный

Тип: РегистрСведенийЗапись.<Имя регистра сведений>. Запись набора, для которой необходимо получить индекс.

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

Тип: Число. Индекс записи в наборе.

Описание:

Позволяет определить индекс записи в наборе.

Пример:

Если НовыйКурс. Индекс() =0 Тогда

    Сообщить("Это первая запись о курсе в наборе.");

КонецЕсли ;

Итог ( Total )



Синтаксис:

Итог(<Имя поля>)

Параметры:

<Имя поля> Обязательный

Тип: Строка. Имя поля записей набора, по которому необходи­мо подсчитать итог.

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

Тип: Число. Числовое значения результата вычисления.

Описание:

Позволяет вычислить итог по одному из полей набора.

Пример:

СреднийКурс = НаборКурсов.Итог("Курс") / НаборКурсов.Количество();

Сообщить("Средний курс " + СреднийКурс);

Количество ( Count )



Синтаксис:

Количество()

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

Тип- Число. Количество записей в наборе.

Описание:

Позволяет получить количество записей в наборе.

Пример:

Для Сч = 0 По НаборКурсов. Количество () -1 Цикл

    ДатаКурса = НаборКурсов(Сч].Период;

    ТекКурс    = НаборКурсов[Сч]-Курс;

    Сообщить ("Курс на " + ДатаКурса + " - "+ ТекКурс + " руб.");

КонецЦикла;

Модифицированность ( Modified )

Синтаксис:

Модифицированность()

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

Тип: Булево. Истина - записи изменены.

Ложь - записи не изменены.

Описание:

Позволяет определить, были ли изменены элементы данной кол­лекции после считывания или записи набора.

Примечание:

Метод не позволяет определить, были ли изменены соответст­вующие записи в регистре другими пользователями.

Пример:

Если НаборКурсов.Модифицированность () Тогда НаборКурсов.Записать();

КонецЕсли;

Очистить ( Clear )



Синтаксис:

Очистить()

Описание;

Позволяет удалить все записи из набора.

Пример:

НаборКурсов.Очистить();

ПолучитьФорму ( GetForm )



Синтаксис:

ПолучитьФорму (< Форма>, <Владелец> , <Ключ уникальности>)

Параметры:

<Форма> Необязательный

Тип: Строка, Объект описания метаданного. Имя формы, как оно задано в конфигураторе или объект описания ме­таданного требуемой формы.

Значение по умолчанию: Если параметр не указан, то использует­ся основная форма, заданная в конфигураторе.

<Владелец> Необязательный

Тип: Форма. Форма, которая будет являться владельцем откры­ваемой формы.

<Ключ уникальности> Необязательный

Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет акта визирована она.

Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.

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

Тип: Форма.

Описание:

Позволяет получить форму набора записей регистра сведений.

Пример:

НаборКурсов.ПолучитьФорму("ФормаНабораЗаписей").Открыть();

Прочитать ( Read )

Синтаксис:

Прочитать()

Описание:

Позволяет выполнить чтение записей из информационной базы по установленному отбору.

Пример:

КурсыВалют = РегистрыСведений.КурсыВалют;

НаборКурсов = КурсыВалют .СоздатьНаборЗаписей();

НаборКурсов.Прочитать();

Сдвинуть ( Move )



Синтаксис:

Сдвинуть(< Запись>, <Смещение>)

Параметры:

<3апись> Обязательный

Тип: Число, РегистрСведенийЗапись.<Имя регистра сведений>. Индекс сдвигаемой записи либо сама запись.

<Смещение> Обязательный

Тип: Число. Количество позиций, на которое следует сдвинуть запись. Положительное значение соответствует смещению записи в сторону конца списка записей набора (увеличение индекса), отрицательное - к началу.

Описание:

Позволяет сдвинуть запись в наборе на указанное число позиций.



Важно! Метод доступен только для набора записей регистра сведений, в котором записи подчинены регистратору.

Удалить ( Remove )



Синтаксис:

Удалить(< Запись>)

Параметры:

<3апись> Обязательный

Тип: Число, РегистрСведенийЗапись.<Имя регистра сведений>. Индекс удаляемой записи либо сама запись.

Описание:

Позволяет удалить запись из набора.

Пример:

НаборКурсов.Удалить(0);

УстановитьАктивность ( SetActive )

Синтаксис:

УстановитьАктивность (<Активность>)

Параметры:

<Активность> Обязательный

Тип: Булево. Признак активности. Истина - записи активны. Ложь - записи не активны.

Описание:

Позволяет установить значение свойства Активность для всех записей набора.

Пример:

НаборКурсов.УстановитьАктивность(Истина);

Методы

Обновить ( Refresh )

Синтаксис:

Обновить()

Описание:

Вызывает перечитывание данных списка.

Методы

Сбросить ( Reset )

Синтаксис:

Сбросить()

Описание:

Отключает признак использования отбора у всех элементов отбо­ра.

Пример:

СправочникСписок.Отбор.Сбросить();

См. также:

Элемент отбора, свойство Использование.

Методы

Установить ( Set )

Синтаксис:

Установить (< Значение> , <Использование> )

Параметры:

<3начение> Необязательный

Тип Произвольный. Значение сравнения.

<Использование> Необязательный

Тип Булево. Признак использования отбора по значению. Значение по умолчанию: Истина.

Описание:

Устанавливает значение отбора и флаг использования. При вы­полнении данного метода вид сравнения устанавливается в зна­чение Равно.

Примечание:

Метод имеет смысл применять, если необходимо установить и значение и использование отбора.

Методы

ПолучитьДатуНачала ( GetDateFrom )

Синтаксис:

ПолучитьДатуНачала()

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

Тип: Дата.

Описание:

Возвращает дату начала периода.

Примечание:

Если граница интервала задана как БезОграничения, то будет возвращена пустая дата.

Пример:

ДатаНач = НП.ПолучитьДатуНачала();

ПолучитьДатуОкончания ( GetDateTo )

Синтаксис:

ПолучитьДатуОкончания()

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

Тип: Дата.

Описание:

Возвращает дату конца периода.

Примечание:

Если граница интервала задана как БезОграничения, то будет возвращена пустая дата.

Пример:

ДатаКон = НП.ПолучитьДатуОкончания();

Представление ( Presentation )

Синтаксис:

Представление()

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

Тип: Строка.

Описание:

Позволяет получить строковое представление настроенного пе­риода.

Редактировать ( Edit )

Синтаксис:

Редактировать()

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

Тип: Булево. Истина, если нажата кнопка "ОК".

Описание:

Открывает диалог ввода периода в модальном режиме. В зависи­мости от значения свойств РедактироватьКакИнтервал и РедактироватьКакПериод    диалог визуальной настройки имеет обе закладки или одну из них. Если использовано обе за­кладки активность той или иной из них задается свойством ВариантНастройки.

Пример:

НП.Редактировать();

УстановитьПериод ( SetPeriod )

Синтаксис:

УстановитьПериод(< Дата начала> , <Дата окончания>)

Параметры:

<Дата начала>  Необязательный

Тип Дата Дата начала периода.

<Дата окончания> Необязательный

Тип Дата Дата окончания периода.

Описание:

Устанавливает период редактирования. Если это возможно, объ­екту автоматически подбирается вариант периода и значение пе­риода

Пример:

НП.УстановитьПериод('2002040Г,'20020531');

Методы

Вставить ( Insert )

Синтаксис:

Вставить(<Индекс>)

Параметры:

<Индекс> Обязательный

Тип: Число. Индекс позиции в табличной части, в которую не­обходимо вставить строку.

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

Тип: Строка табличной части. Вставленная строка.

Описание:

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

Пример:

Ответы.Вставить(1);

Выгрузить ( Unload )

Синтаксис:

Выгрузить()

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

Тип; ТаблицаЗначений. Таблица значений, содержащая стро­ки табличной части. Имена колонок таблицы значений совпадают с именами колонок табличного поля. Колонка, содержащая номер строки, выгружается в колонку с именем НомерСтроки.

Описание;

Выгружает табличную часть в таблицу значений.

Пример:

ТаблицаСостава = Состав.Выгрузить();

ВыгрузитьКолонку ( UnloadColumn )

Синтаксис:

ВыгрузитьКолонку(< Колонка>)

Параметры:

<Колонка> Обязательный

Тип- Число, Строка. Колонка, из которой нужно выгрузить значения. В качестве значения параметра может быть передан индекс колонки, имя колонки.

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

Тип: Массив. Массив, содержащий значения колонки.

Описание:

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

Примечание:

Значения из колонки выгружаются в порядке индексов строк в табличной части.

Пример:

Товары = Состав.ВыгрузитьКолонку("Номенклатура");

Добавить ( Add )

Синтаксис:

Добавить()

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

Тип: Строка табличной части. Добавленная строка.

Описание:

Добавляет строку в конец табличной части.

Пример:

Состав.Добавить();

Загрузить ( Load )

Синтаксис:

Загрузить (< Таблица> )

Параметры:

<Таблица> Обязательный

Тип: ТаблицаЗначений. Таблица значений, откуда загружается табличная часть. Колонки таблиц совмещаются по именам.

Описание:

Загружает табличную часть из таблицы значений. При этом все прежние строки табличной части удаляются. При загрузке значе­ния в колонках табличной части заполняются значениями из ко­лонок таблицы значений с совпадающими именами.

Пример:

Состав.Загрузить(ТаблицаСостава);

ЗагрузитьКолонку ( LoadColumn )

Синтаксис:

ЗагрузитьКолонку (< Массив>, <Колонка>)

Параметры:

<Массив> Обузательный

Тип: Массив. Массив значений для загрузки в колонку.

<Колонка> Обязательный

Тип: Число, Строка. Колонка, в которую будут загружены значения из массива.

В качестве значения параметра может быть передан индекс ко­лонки, либо имя колонки.

Описание:

Загружает значения из массива в заданную колонку табличной части.

Примечание:

Значения из массива загружаются в колонку в порядке индексов.

Пример:

Состав.ЗагрузитьКолонку(Товары, "Номенклатура") ;

Индекс ( IndexOf )

Синтаксис:

Индекс(< Строка>)

Параметры:

<Строка> Обязательный

Тип: Строка табличной части- Строка табличной части, для которой необходимо получить индекс.

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

Тип: Число. Индекс строки.

Описание:

Получает индекс стоки в табличной части.

Пример:

ИндексТекСтроки = Состав.Индекс(ЭлементыФормы.Состав.ТекущаяСтрока);

Итог (Total)

Синтаксис:

Итог (<Колонка> )

Параметры:

<Колонка> Необязательный

Тип; Число, Строка. Индекс либо имя колонки, по которой подсчитывается итог.

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

Тип: Число.

Описание:

Суммирует значения всех строк в указанной колонке.

Примечание:

Имеет смысл для числовых значений.

Пример:

ВсегоПоДокументу = Сумма.Итог("Всего");

Количество ( Count )

Синтаксис:

Количество()

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

Тип: Число. Количество строк табличной части.

Описание:

Позволяет получить количество строк табличной части.

Пример:

ВсегоСтрок = Состав.Количество();

Найти ( Find )



Синтаксис:

Найти(< Значение>, <Колонки>)

Параметры:

<3начение> Обязательный

Тип: Произвольный. Искомое значение.

<Колонки> Необязательный

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

Значение по умолчанию: Если параметр не указан или передана пустая строка, поиск осуществляется по всей таблице.



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

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

Описание:

Позволяет найти значение в указанных колонках табличной час­ти. Если список колонок пуст, поиск осуществляется по всей таб­личной части.

Примечание:

Метод эффективно использовать для поиска уникальных значе­ний.

Пример:

НайдСтрока = Состав.Найти(ТекТовар, "Номенклатура');

Если НайдСтрока = Неопределено Тогда

Предупреждение("Товар не найден !");

Иначе

    Количество = НайдСтрока.Количество;

КонецЕсли;

НайтиСтроки ( FindRows )



Синтаксис:

НайтиСтроки (< Параметры отбора>)

Параметры:

<Параметры отбора> Обязательный

Тип: Структура. Задает условия поиска: ключ структуры опре­деляет имя колонки, по которой будет осуществляться поиск, а значение структуры - искомое значение.

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

Тип: Массив. Массив из строк табличной части, соответствую­щих заданному условию поиска.

Замечание! Массив хранит ссылки на строки табличной части, то есть при изменении строки в табличной части, значение в мас­сиве тоже будет изменено.

Описание:

Позволяет найти строки табличной части, соответствующие за­данному условию поиска.

Примечание:

Метод эффективно использовать для выборки неуникальных зна­чений.

Пример:

ПараметрыОтбора = Новый Структура;

ПараметрыОтбора.Вставить("Номенклатура", ТекТовар);

НайдСтроки = Состав.НайтиСтроки(ПараметрыОтбора);

Очистить ( Clear )



Синтаксис:

Очистить ()

Описание:

Удаляет все строки табличной части.

Пример:

Состав.Очистить();

Свернуть ( GroupBy )



Синтаксис:

Свернуть(<Колонки группировок, <Колонки суммирования>)

Параметры:

<Колонки группировок>  Обязательный

Тип: Строка. Имена колонок, разделенные запятыми, по кото­рым необходимо группировать строки табличного поля.

<Колонки суммирования> Необязательный

Тип: Строка. Имена колонок, разделенные запятыми, по кото­рым необходимо суммировать значения в строках табличного по­ля.



Описание:

Осуществляет свертку табличной части по указанным колонкам группировки. Строки, у которых совпадают значения в колонках, указанных в первом параметре, сворачиваются в одну строку. Значения этих строк, хранящиеся в колонках, указанных во вто­ром параметре, накапливаются.

Важно! Оба списка колонок должны покрывать всю табличную часть. Списки колонок не должны пересекаться.

Пример:

Состав.Свернуть("Номенклатура", "Количество, Сумма, Всего"');

Сдвинуть ( Move )



Синтаксис:

Сдвинуть(< Строка>, <Смещение>)

Параметры:

< Строка> Обязательный

Тип: Число, Строка табличной части. Индекс строки, которую нужно сдвинуть, либо сама сдвигаемая строка.

<Смещение> Обязательный

Тип: Число. Количество строк, на которое необходимо перемес­тить строку. Положительное значение означает, что строка будет передвинута ближе к концу табличной части (вниз), отрицатель­ное - ближе к началу (вверх).

Описание:

Позволяет переместить строку табличной части на указанное ко­личество позиций.

Пример:

// сдвиг 2-й строки на предыдущую позицию

Состав.Сдвинуть(1, -1);

// сдвиг 2-й строки на следующую позицию

Состав.Сдвинуть(1, 1);

Удалить ( Remove )



Синтаксис:

Удалить(< Индекс>)

Параметры:

<Индекс> Обязательный

Тип: Число, Строка табличной части. Индекс удаляемой строки в табличной части, либо сама удаляемая строка.

Описание:

Удаляет строку с указанным индексом из табличной части.

Пример:

Состав.Удалить(3);

Методы

Индекс (IndexOf)

Синтаксис:

Индекс(<ЭлементПорядка>)

Параметры:

<ЭлементПорядка> Обязательный

Тип: ЭлементПорядка. Элемент порядка, индекс которого требуется определить.

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

Тип: Число. Индекс в коллекции указанного элемента порядка. Если такого нет, возвращает -1.

Количество (Count)

Синтаксис:

Количество()

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

Тип: Число. Количество входящих в коллекцию элементов порядка.

Очистить (Clear)

Синтаксис:

Очистить()

Описание:

Очищает все признаки упорядочивания

Установить (Set)

Синтаксис:

Установить(<Строка порядка>)

Параметры:

<Строка порядка> Необязательный

Тип: Строка. Список имен полей, разделенных запятыми, по которым производится упорядочивание. После каждого имени поля через пробел может быть указано направление сортировки. Направление определяется: "Убыв" ("Desc") - упорядочивать по убыванию; "Возр" ("Asc") - упорядочивать по возрастанию. По умолчанию упорядочивание производится по возрастанию. Порядок указания имен полей определяет порядок выполнения упорядочивания. Это означает, что будет выполняться упорядочивание по полю, указанному первым. Затем группы строк с одинаковым значением в этом поле упорядочиваются по полю, которое указано вторым, и так далее.

Описание:

Устанавливает упорядочивание по заданным полям в выбранном направлении.

Пример:

СписокСправочника.Порядок.Установить("Код Убыв, Наименование Возр");

---

---