04bc80b4

Методы


Выбрать ( Select )

Синтаксис:

Выбрать (<Дата начала> , <Дата окончания>, <Отбор>, <Порядок>)

Параметры:

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

Тип: Дата. Дата и время начала периода выборки документов.

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

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

Тип: Дата. Дата окончания периода выбираемых документов

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

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

Тип: Структура. Задает поле и значение отбора открываемой выборки. Ключ структуры описывает имя поля, а значение струк­туры - значение отбора по этому полю. В качестве полей для от­бора могут задаваться только поле Дата и реквизиты документа, для которых в конфигураторе признак индексирования установлен в значение "Индексировать" или в значение "Индексировать с доп. упорядочиванием".

Важно! Структура может содержать только один элемент.

Значение по умолчанию: Неопределено. 



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

Тип: Строка. Задает реквизит документа, по которому упорядо­чивается выборка документов. Может быть указано поле Дата или имя реквизита документа, для которого признак индексиро­вания в конфигураторе установлен в значения "Индексировать" или "Индексировать с доп. упорядочиванием". После указания имени через пробел может быть указано направление сортировки.

Направление определяется: 

  • "Убыв" ("Desc") - упорядочивать по убыванию, и 
  • "Возр" (" Asc") - упорядочивать по возрастанию. 
  • По умолчанию выборка упорядочивается по возрастанию.

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

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

    Тип: ДокументВыборка.<Имя документа>. Сформирован­ная выборка.

    Описание:

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


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

    Синтаксис:

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

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

    Тип: Объект описания метаданного.

    Описание:

    Позволяет получить объект описания метаданных документа. Другой путь получения того же значения - через свойство гло­бального  контекста  Метаданные.   Например:  Метадан-ные.Документы.РасходнаяНакладная.

    Пример:

    Если ВыбДокумент.Метаданные().Реквизиты.Контрагент.Выбран() Тогда Контрагент = ВыбДокумент.Контрагент;

    КонецЕсли;

    МоментВремени ( PointOfTime )

    Синтаксис:

    МоментВремени()

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

    Тип: МоментВремени.

    Описание:

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

    ПолучитьОбъект ( GetObject )

    Синтаксис:

    ПолучитьОбъект()

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

    Тип: ДокументОбъект. <Имя документа>.

    Описание:

    Позволяет получить по ссылке объект для модификации и записи документа (ДокументОбъект.<Имя документа>).

    Пример:

    Объект = ВыбДокумент.ПолучитьОбъект();

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

    Синтаксис:

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

    Параметры:

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

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

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

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

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

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

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

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

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

    Тип: Форма.

    Описание:

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

    Пример:

    ВыбДокумент.ПолучитьФорму(). Открыть();




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

    Синтаксис:

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

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

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

    Описание:

    Метод позволяет определить, заблокирован ли документ данным

    объектом.

    Примечание:

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

    Пример:

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

    КонецЕсли;

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

    Синтаксис:

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

    Описание:

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

    Пример:

    Попытка

        НовДокумент.Заблокировать();

    Исключение

        Предупреждение("Невозможно заблокировать документ.");

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

    Записать ( Write )

    Синтаксис:

    Записать (<Режим записи> , <Режим проведения> )

    Параметры:

    < Режим записи> Необязательный

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

    Значение по умолчанию: Запись

    При определении значения параметра используется системное перечисление РежимЗаписиДокумента ( DocumentWritingMode).

    <Режим проведения> Необязательный

    Тип: РежимПроведения. Позволяет выбрать один из возмож­ных режимов проведения.

    Значение по умолчанию: Неоперативный

    При определении значения параметра используется системное перечисление РежимПроведения (PostingMode).

    Описание:

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

    Примечание:

    Для документов с поддержкой уникальности номеров, в процессе записи, если нужно, проверяется уникальность номера.

    Пример:

    Попытка

        НовДокумент. Записать (РежимЗаписиДокумента. Проведение);

    Исключение

        Предупреждение("Невозможно провести документ.");

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

    См. также:

    ДокументОбъект.<Имя документа>, событие ПередЗаписью.



    Содержание раздела