Методы
Синтаксис:
Выбрать (<Дата начала> , <Дата окончания>, <Отбор>, <Порядок>)
Параметры:
<Дата начала> Необязательный
Тип: Дата. Дата и время начала периода выборки документов.
Значение по умолчанию: Пустая дата, то есть выбираются все документы, начиная с самого первого документа в системе.
<Дата окончания> Необязательный
Тип: Дата. Дата окончания периода выбираемых документов
Значение по умолчанию: Пустая дата, то есть выбираются все документы, заканчивая самым последним документом в системе.
<0тбор> Необязательный
Тип: Структура. Задает поле и значение отбора открываемой выборки. Ключ структуры описывает имя поля, а значение структуры - значение отбора по этому полю. В качестве полей для отбора могут задаваться только поле Дата и реквизиты документа, для которых в конфигураторе признак индексирования установлен в значение "Индексировать" или в значение "Индексировать с доп. упорядочиванием".
Важно! Структура может содержать только один элемент.
Значение по умолчанию: Неопределено.
<Порядок> Необязательный
Тип: Строка. Задает реквизит документа, по которому упорядочивается выборка документов. Может быть указано поле Дата или имя реквизита документа, для которого признак индексирования в конфигураторе установлен в значения "Индексировать" или "Индексировать с доп. упорядочиванием". После указания имени через пробел может быть указано направление сортировки.
Направление определяется:
По умолчанию выборка упорядочивается по возрастанию.
Значение по умолчанию: Если порядок не задан, выборка упорядочивается по хронологии документов.
Возвращаемое значение:
Тип: ДокументВыборка.<Имя документа>. Сформированная выборка.
Описание:
Метод предназначен для получения выборки документов за определенный период. Получаемая выборка может быть упорядочена по реквизитам документа.
Пример:
Выборка = Документы.РасходнаяНакладяая.Выбрать(ДатаНач, ДатаКон);
НайтиПоНомеру ( FindByNumber )
Вариант синтаксиса: Для документов с непериодической нумерацией
Синтаксис:
НайтиПоНомеру(<Номер документа>)
Параметры:
<Номер документа> Обязательный
Тип: Число, Строка. Номер искомого документа. Тип переда ваемого значения зависит от установки в конфигураторе представления номера документа.
Вариант синтаксиса: Для документов с нумерацией в пределах периода
Синтаксис:
НайтиПоНомеру (< Номер документа> , <Дата
интервала>)
Параметры:
<Номер документа> Обязательный
Тип: Число, Строка. Номер искомого документа. Тип передаваемого значения зависит от установки в конфигураторе представления номера документа.
<Дата интервала> Обязательный
Тип: Дата. Дата из интервала, в котором проводится поиск по номеру. Сам интервал определяется как период уникальности номеров документа, в который входит указанная дата. Например, если номера документов уникальны в пределах месяца и задана дата 10 декабря 2001 года, то поиск будет проводиться в интервале с 01 по 31 декабря 2001 года.
Возвращаемое значение:
Тип: ДокументСсылка.<Имя документа>. Если документ не найден, возвращается пустая ссылка на документ.
Описание:
Находит документ по номеру. Для документов с нумерацией в пределах периода поиск осуществляется в указанном периоде.
ПолучитьМакет ( GetTemplate )
Синтаксис:
ПолучитьМакет(< Макет>)
Параметры:
<Макет> Обязательный
Тип: Строка, Объект описания метаданного. Имя макета, как оно задано в конфигураторе или объект описания метаданного требуемого макета.
Возвращаемое значение:
Тип: ТабличныйДокумент.
Описание:
Метод позволяет получить один из макетов, определенных для документа в конфигурации.
ПолучитьФорму ( GetForm )
Синтаксис:
ПолучитьФорму(< Форма>, <Владелец>, <Ключ уникальности>)
Параметры:
<Форма> Обязательный
Тип: Строка. Имя формы, как оно задано в конфигураторе.
<Владелец> Необязательный
Тип: Форма. Форма, которая будет являться владельцем открываемой формы.
<Ключ уникальности> Необязательный
Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она.
Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.
Возвращаемое значение:
Тип: Форма.
Описание:
Позволяет получить форму документа. Если получаемая форма -форма для редактирования документа, то будет получена форма нового документа.
ПолучитьФормуВыбора ( GetFormChoice )
Синтаксис:
ПолучитьФормуВыбора (< Форма>, <Владелец>, <Ключ уникальности>)
Параметры:
<Форма> Необязательный
Тип: Строка, Объект описания метаданного. Имя формы, как оно задано в конфигураторе или объект описания метаданного требуемой формы.
Значение по умолчанию: Если параметр не указан, то используется основная форма, заданная в конфигураторе.
<Владелец> Необязательный
Тип: Форма. Форма, которая будет являться владельцем открываемой формы.
<Ключ уникальности> Необязательный
Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она.
Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.
Возвращаемое значение:
Тип: Форма.
Описание:
Позволяет получить форму списка для выбора документов.
ПолучитьФормуНовогоДокумента ( GetFormNewDcou merit )
Синтаксис:
ПолучитьФормуНовогоДокумента (< Форма> , <Владелец> , <Ключ уникальности>)
Параметры:
<Форма> Необязательный
Тип: Строка, Объект описания метаданного. Имя формы, как оно задано в конфигураторе или объект описания метаданного требуемой формы.
Значение по умолчанию: Если параметр не указан, то используется основная форма, заданная в конфигураторе.
<Владелец> Необязательный
Тип: Форма. Форма, которая будет являться владельцем открываемой формы.
<Ключ уникальности> Необязательный
Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет
активизирована она.
Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.
Возвращаемое значение:
Тип: Форма.
Описание:
Позволяет получить форму нового документа.
ПолучитьФормуСписка ( GetFormList )
Синтаксис:
ПолучитьФормуСписка (< Форма>, <Владелец>, <Ключ уникальности>)
Параметры:
<Форма> Необязательный
Тип: Строка, Объект описания метаданного. Имя формы, как оно задано в конфигураторе или объект описания метаданного требуемой формы.
Значение по умолчанию: Если параметр не указан, то используется основная форма, заданная в конфигураторе.
<Владелец> Необязательный
Тип: Форма. Форма, которая будет являться владельцем открываемой формы.
<Ключ уникальности> Необязательный
Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она.
Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.
Возвращаемое значение:
Тип: Форма.
Описание:
Позволяет получить форму списка документов.
ПустаяСсылка ( EmptyRef )
Синтаксис:
ПустаяСсылка()
Возвращаемое значение:
Тип: ДокументСсылка.<Имя документа>.
Описание:
Метод предназначен для получения пустой ссылки на документ. Например, может использоваться, когда нужно передать пустую ссылку в параметр метода или процедуры.
СоздатьДокумент ( CreateDocument )
Синтаксис:
СоздатьДокумент()
Возвращаемое значение:
Тип: ДокументОбъект.<Имя документа>.
Описание:
Создает новый документ.
Пример:
// создание нового документа
РасходнаяНакладная НовДок = Документы.РасходнаяНакладная.СоздатьДокумент();
НовДок.Записать();