Основная страница

Глава 12-2
Работа с Документами


 

Методы документов

Вид

Название вида документа.

Синтаксис:

Вид()

Англоязычный синоним:

Kind

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

Строковое значение, содержащее название вида документа, как он задан в конфи гураторе.

Описание:

Метод Вид возвращает название вида документа, как он задан в конфигураторе.

Пример:

Если (Док.Вид() = "ДоплатаПроцентом") ИЛИ (Док.Вид() = "ДоплатаСуммой") Тогда

   Сотр = Док.Сотрудник;

Иначе

   Предупреждение("Это не доплата!");

КонецЕсли;

ПредставлениеВида

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

Синтаксис:

ПредставлениеВида()

Англоязычный синоним:

KindPresent

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

Строковое значение, содержащее пользовательское представление вида документа (синоним документа или, если он пустой, то идентификатор).

Описание:

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

Пример:

// отобразим пользовательское представление в строке состояния

Состояние(ВыбДокум.ПредставлениеВида());

УстановитьАтрибут

Установить значение реквизита по имени идентификатора.

Синтаксис:

УстановитьАтрибут(<ИмяРеквизита>, <3начение>)

Англоязычный синоним:

SetAttrib

Параметры:

<ИмяРеквизита>

Строковое выражение, содержащее имя реквизита, как оно задано в конфигураторе.

<3начение>

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

Описание:

Метод УстановитьАтрибут позволяет установить значение реквизита по имени идентификатора, как оно задано в конфигураторе.

Пример:

Док.УстановитьАтрибут("ЦенаРозн", ЦенаТов);

ПолучитьАтрибут

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

Синтаксис:

ПолучитьАтрибут(<ИмяРеквизита>)

Англоязычный синоним:

GetAttrib

Параметры:

<ИмяРеквизита>

Строковое выражение, содержащее имя реквизита, как оно задано в конфигураторе.

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

Значение реквизита <ИмяРеквизита>.

Описание:

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

Пример:

ЦенаДок = Док.ПолучитьАтрибут("Цена");

Выбран

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

Синтаксис:

Выбран()

Англоязычный синоним:

Selected

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

Числовое значение: 1 — если документ выбран, 0 — если документ не выбран.

Описание:

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

Пример:

Док = СоздатьОбъект("Документ.ПрихНакл");

// позиционируем документ по номеру

Док.НайтиПоНомеру("1", 0);

Если Док.Выбран() = 1 Тогда

    // если документ найден

    // открываем выборку строк спецификации документа

    Док.ВыбратьСтроки();

    // цикл выбора строк спецификации документа

    Если Док.КоличествоСтрок() > 0 Тогда

       Пока Док.ПолучитьСтроку() = 1 Цикл

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

       КонецЦикла;

    КонецЕсли;

КонецЕсли;

Проведен

Возвратить флаг проводки документа.

Синтаксис:

Проведен()

Англоязычный синоним:

IsTransacted

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

Числовое значение: 1 — если документ проведен, 0 — если документ не проведен.

Описание:

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

Пример:

Процедура ПолучитьПроведенные()

   Док = СоздатьОбъект("Документ");

   // Откроем выборку документов

   Док.ВыбратьДокументы(ДатаНачала, ДатаКонца);

   // Цикл выбора документов

   Пока Док.ПолучитьДокумент() > 0 Цикл

      Если Док.Проведен() > 0 Тогда

         // для проведенных документов выведем сообщение

         Сообщить(Строка(Док.Вид())+" № "+Док.НомерДок+" от "+Док.ДатаДок);

      КонецЕсли;

   КонецЦикла;

КонецПроцедуры

ТекущийДокумент

Определить значение текущего документа.

Синтаксис:

ТекущийДокумент()

Англоязычный синоним:

CurrentDocument

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

Значение текущего документа.

Описание:

Метод ТекущийДокумент возвращает значение позиционированного текущего документа (в целом, как объекта). Данный метод применяется, например, если нужно документ передать как параметр в вызове какого-либо метода или присвоить какому-либо реквизиту.

Пример:

Если Режим = "Подробный" Тогда

   // используем объект типа «документ» неопределенного вида

   Док = СоздатьОбъект("Документ");

   // Откроем выборку документов

   Док.ВыбратьДокументы(ДатаНачала, ДатаОкончания);

   // Цикл выбора документов

   Пока Док.ПолучитьДокумент() > 0 Цикл

      // присвоим переменной ТекДок значение найденного документа

      ТекДок = Док.ТекущийДокумент();

      // ...

   КонецЦикла;

КонецЕсли;

Выбрать

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

Синтаксис:

Выбрать(<Подсказка>, <ФормаЖурнала>, <КомуПодч>)

Англоязычный синоним:

Choose

Параметры:

<Подсказка>

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

<ФормаЖурнала>

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

·                 "Журнал.ХХХХХ", где ХХХХХ — имя вида соответствующего объекта, как он задан в конфигураторе, например: "Справочник.Товары";

·                 "Журнал.Подчиненные";

·                 "ЖурналОпераций";

·                 "ЖурналОпераций.YYYYY", где YYYYY — имя формы журнала операций, как оно задано в конфигураторе;

<КомуПодч>

Необязательный параметр. Используется при открытии выбора по журналу подчиненных документов, т.е когда второй параметр <ФормаЖурнала> имеет значение "Журнал.Подчиненные". В данном случае в этом параметре передается документ-владелец, по которому следует построить журнал подчиненных документов.

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

Числовое значение: 1 — если документ выбран; 0 — если не выбран.

Описание:

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

Пример:

Док = СоздатьОбъект("Документ.НаклПрих");

// вызываем диалог выбора документа

Если Док.Выбрать("Найди документ") > 0 Тогда

   // удаляем выбранный документ

   Док.Удалить();

КонецЕсли;

См. также: ВидыДляВыбора

ВидыДляВыбора

Установка выбираемых видов для объекта типа «документ» неопределенного вида.

Синтаксис:

ВидыДляВыбора(<СписокВидов>)

Англоязычный синоним:

KindsForChoice

Параметры:

<СписокВидов>

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

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

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

Описание:

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

Данный метод может использоваться только для объектов типа «документ» неопределенного вида — либо созданных функцией СоздатьОбъект, либо определенных в конфигураторе как реквизиты диалога или другого объекта. Если метод ВидыДляВыбора применен к реквизиту диалога типа «документ» неопределенного вида, то интерактивный выбор будет производиться только среди установленных видов документов.

Пример:

// данная процедура присваивает некоторому реквизиту "НаОсновании"

// значение конкретного документа

Процедура УстДокОснования()

   // Создадим объект типа «документ» неопределенного вида

   Дкм = СоздатьОбъект("Документ");

   Дкм.ВидыДляВыбора("РасходнаяНакл, Счет");

   // Вызываем диалог выбора документа

   Если Дкм.Выбрать("Выберите документ основания", "") > 0 Тогда

      НаОсновании = Дкм.ТекущийЭлемент();

   КонецЕсли;

КонецПроцедуры

См. также: Выбрать

Итог

Итоговое значение реквизита документа.

Синтаксис:

Итог(<ИмяРеквизита>)

Англоязычный синоним:

Total

Параметры:

<ИмяРеквизита>

Строковое выражение, содержащее имя реквизита табличной части документа, для которого в конфигураторе установлено свойство «Итог по колонке».

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

Числовое значение — сумма по всем строкам табличной части документа для реквизита <ИмяРеквизита>.

Описание:

Метод Итог позволяет определить сумму значений по всем строкам табличной части документа для реквизита <ИмяРеквизита>.

Данный метод может быть использован только для реквизитов табличной части документов, для которых установлено свойство «Итог по колонке» (закладка «Дополнительные» свойств реквизита документа в конфигураторе).

Пример:

Процедура ВычСреднего()

   // вычислим среднюю сумму по наряду

   Сумма = Итог("Сумма");

   Штук = Итог("Штук");

   Если Штук <> 0 Тогда

      Средн = Сумма / Штук;

   Иначе;

      Средн = 0;

   КонецЕсли;

КонецПроцедуры

КоличествоСтрок

Определить количество строк в документе.

Синтаксис:

КоличествоСтрок()

Англоязычный синоним:

LinesCnt

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

Числовое значение — количество строк в документе.

Описание:

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

Пример:

Сообщить("Документ: " + Вид() + " № " + НомерДок + " от " + ДатаДок +

                    " в документе " + КоличествоСтрок() + " строк");

НайтиДокумент

Найти документ по значению.

Синтаксис:

НайтиДокумент(<Документ>)

Англоязычный синоним:

FindDocument

Параметры:

<Документ>

Выражение, содержащее значение типа «Документ».

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

Число 1 — если действие выполнено (документ найден);

Число 0 — если действие не выполнено.

Описание:

Метод НайтиДокумент выполняет поиск документа по значению, заданному параметром <Документ>. Данный метод используется для позиционирования объекта на конкретный документ.

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

Пример:

Процедура УдалДок(Докум)

   Док = СоздатьОбъект("Документ.НаклПрих");

   // позиционируем созданный объект на заданном документе

   Док.НайтиДокумент(Докум);

   Если Док.Выбран() > 0 Тогда

      // если документ найден, то удалим его

      Док.Удалить();

   Иначе

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

   КонецЕсли;

КонецПроцедуры

НайтиПоНомеру

Найти документ по номеру.

Синтаксис:

НайтиПоНомеру(<Номер>, <Дата>, <ИдентВида>)

Англоязычный синоним:

FindByNum

Параметры:

<Номер>

Строковое выражение, содержащее значение номера искомого документа.

<Дата>

Выражение типа «дата».

<ИдентВида>

Необязательный параметр. Строковое выражение, содержащее идентификатор вида документа или идентификатор Нумератора.

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

Число 1 — если действие выполнено (документ найден);

Число 0 — если действие не выполнено.

Описание:

Метод НайтиПоНомеру позиционирует документ по номеру. В качестве второго параметра задается любая дата из диапазона, в котором нужно искать документ с данным номером. Поиск зависит от выбранного в конфигураторе способа уникальности номеров (по месяцу, году и др.).

Метод может быть использован для объекта Документ общего вида, тогда для поиска нужно указать в параметре <ИдентВида> идентификатор вида документа или идентификатор Нумератора.

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

Пример:

Если ВвестиЧисло(Ном, "Введите номер приказа", 5, 0) = 1 Тогда

   Док=СоздатьОбъект("Документ.ПриказыУвольнения");

   // позиционируем документ по заданному номеру

   Док.НайтиПоНомеру(Строка(Ном), Дата(0));

   Если Док.Выбран() = 1 Тогда

      Документ=Док.ТекущийДокумент();

      // ...

   КонецЕсли;

КонецЕсли;

Получить Строку ПоНомеру

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

Синтаксис:

ПолучитьСтрокуПоНомеру(<Номер>)

Англоязычный синоним:

GetLineByNum

Параметры:

<Номер>

Выражение, содержащее номер искомой строки.

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

Число 1 — если действие выполнено;

Число 0 — если действие не выполнено.

Описание:

Метод ПолучитьСтрокуПоНомеру устанавливает в качестве текущей строки спецификации документа строку с заданным номером (не порядковым, а тем, который записан в строке, т. к. могут быть пропуски).

Пример:

Процедура УдалЗаданнойСтроки(Док, Стр)

   Если Док.Выбран() = 1 Тогда

      // если переданный параметр содержит значение документа, то

      // найдем в нем строку

      Док.ПолучитьСтрокуПоНомеру(Стр);

      // удалим найденную строку спецификации документа

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

   Иначе

      Предупреждение("Документ не выбран!");

   КонецЕсли;

КонецЕсли;

ВыбратьДокументы

Открыть выборку документов.

Синтаксис:

ВыбратьДокументы(<НачалоВыборки>, <КонецВыборки>)

Англоязычный синоним:

SelectDocuments

Параметры:

<НачалоВыборки>

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

<КонецВыборки>

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

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

Число 1 — если действие выполнено и в выборке есть хотя бы один документ;

Число 0 — если действие не выполнено или в выборке нет ни одного документа.

Описание:

Метод ВыбратьДокументы открывает выборку документов в интервале с <НачалоВыборки> по <КонецВыборки>.

Непосредственно сама выборка осуществляется при помощи метода ПолучитьДокумент в порядке возрастания даты и времени записи документов (если не задан обратный порядок методом ОбратныйПорядок).

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

Пример:

Если Режим = "Подробный" Тогда

   Док = СоздатьОбъект("Документ");

   // открываем выборку документов

   Док.ВыбратьДокументы(ДатаНачало, ДатаКонец);

   // цикл получения документов

   Пока Док.ПолучитьДокумент() > 0 Цикл

      ТекДок = Док.ТекущийДокумент();

   КонецЦикла;

КонецЕсли;

См. также: ПолучитьДокумент, ОбратныйПорядок

ВыбратьПодчиненныеДокументы

Открыть выборку подчиненных документов.

Синтаксис:

ВыбратьПодчиненныеДокументы(<НачалоВыборки>, <КонецВыборки>, <Докум>)

Англоязычный синоним:

SelectChildDocs

Параметры:

<НачалоВыборки>

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

<КонецВыборки>

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

<Докум>

Выражение типа «документ», содержащее значение документа-владельца, подчиненные которому будут включаться в выборку.

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

Число: 1 — если действие выполнено и в выборке есть хотя бы один документ; 0 — если действие не выполнено или в выборке нет ни одного документа.

Описание:

Метод ВыбратьПодчиненныеДокументы открывает выборку всех документов, подчиненных заданному документу <Докум> в интервале с <НачалоВыборки> по <КонецВыборки>. Непосредственно сама выборка осуществляется при помощи метода ПолучитьДокумент в порядке возрастания даты и времени записи документов (если не задан обратный порядок методом ОбратныйПорядок).

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

Пример:

//Проверка того, что по Счету были документы отгрузки

ДокТест = СоздатьОбъект("Документ");

// открываем выборку документов

ДокТест.ВыбратьПодчиненныеДокументы('01.01.80', '31.12.99', ПоСчету);

// получение документа

Если ДокТест.ПолучитьДокумент() = 1 Тогда

   Предупреждение("По данному Счету были отгрузки!");

КонецЕсли;

См. также: ПолучитьДокумент, ОбратныйПорядок

ВыбратьПоЗначению

Открыть выборку документов по значению.

Синтаксис:

ВыбратьПоЗначению(<НачалоВыборки>, <КонецВыборки>, <ИмяОтбора>, <3нач>)

Англоязычный синоним:

SelectByValue

Параметры:

<НачалоВыборки>

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

<КонецВыборки>

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

<ИмяОтбора>

Строковое выражение, которое содержит либо название «общего реквизита» документов, либо название «графы отбора» журналов, как они заданы в конфигураторе.

<3нач>

Значение отбора, по которому строится выборка документов.

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

Число 1 — если действие выполнено и в выборке есть хотя бы один документ; 0 — если действие не выполнено или в выборке нет ни одного документа.

Описание:

Метод ВыбратьПоЗначению открывает выборку документов в интервале с <НачалоВыборки> по <КонецВыборки>, для которых реквизит отбора <ИмяОтбора> имеет конкретное заданное значение <3нач>.

Непосредственно сама выборка осуществляется при помощи метода ПолучитьДокумент в порядке возрастания даты и времени записи документов (если не задан обратный порядок методом ОбратныйПорядок).

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

Пример:

Если Режим = "Подробный" Тогда

   Док = СоздатьОбъект("Документ");

   // открываем выборку документов

   Док.ВыбратьПоЗначению(ДатаНачало, ДатаКонец, "Автор", "Сидоров");

   // цикл получения документов

   Пока Док.ПолучитьДокумент() > 0 Цикл

      ТекДок = Док.ТекущийДокумент();

   КонецЦикла;

КонецЕсли;

См. также: ПолучитьДокумент, ОбратныйПорядок

ВыбратьПоНомеру

Открыть выборку документов по номеру.

Синтаксис:

ВыбратьПоНомеру(<Номер>, <Дата>, <ИдентВида>)

Англоязычный синоним:

SelectByNum

Параметры:

<Номер>

Строковое выражение, содержащее значение номера искомых документов.

<Дата>

Выражение типа «дата».

<ИдентВида>

Необязательный параметр. Строковое выражение, содержащее идентификатор вида документа или идентификатор Нумератора.

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

Число 1 — если действие выполнено и в выборке есть хотя бы один документ; 0 — если действие не выполнено или в выборке нет ни одного документа.

Описание:

Метод ВыбратьПоНомеру открывает выборку всех документов с данным номером одного вида или одного нумератора (например, для поиска всех документов с совпадающими номерами).

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

Метод может быть использован для объекта Документ общего вида, тогда для поиска нужно указать в параметре <ИдентВида> идентификатор вида документа или идентификатор Нумератора.

Непосредственно сама выборка осуществляется при помощи метода ПолучитьДокумент в порядке возрастания даты и времени записи документов (если не задан обратный порядок методом ОбратныйПорядок).

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

Пример:

Если Режим = "Подробный" Тогда

   Док = СоздатьОбъект("Документ");

   // открываем выборку документов

   Док.ВыбратьПоНомеру("Ав-0005", '01.01.98', "АктПереоценки");

   // цикл получения документов

   Пока Док.ПолучитьДокумент() > 0 Цикл

      ТекДок = Док.ТекущийДокумент();

   КонецЦикла;

КонецЕсли;

См. также: ПолучитьДокумент, ОбратныйПорядок

ВыбратьПоПоследователыюсти

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

Синтаксис:

ВыбратьПоПоследовательности(<НачПериода>, <КонПериода> , <Последоват>)

Англоязычный синоним:

SelectBySequence

Параметры:

<НачПериода>

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

<КонПериода >

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

<Последоват>

Строковое выражение, содержащее идентификатор используемой Последовательности.

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

Число 1 — если действие выполнено и в выборке есть хотя бы один документ; 0 — если действие не выполнено или в выборке нет ни одного документа.

Описание:

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

Непосредственно сама выборка осуществляется при помощи метода ПолучитьДокумент в порядке возрастания даты и времени записи документов (если не задан обратный порядок методом ОбратныйПорядок).

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

Пример:

Если Режим = "Подробный" Тогда

   Док = СоздатьОбъект ("Документ");

   // открываем выборку документов

   Док.ВыбратьПоПоследовательности(НачД, ПолучитьДокументТА(), "Упр");

   // цикл получения документов

   Пока Док.ПолучитьДокумент() > 0 Цикл

      ТекДок = Док.ТекущийДокумент();

   КонецЦикла;

КонецЕсли;

См. также: ПолучитьДокумент, ОбратныйПорядок

ОбратныйПорядок

Установить порядок выборки документов.

Синтаксис:

ОбратныйПорядок(<Режим>)

Англоязычный синоним:

BackwardOrder

Параметры:

<Режим>

Необязательный параметр. Числовое выражение: 1 — выбирать документы в обратном порядке даты и времени; 0 — выбирать документы в порядке возрастания даты и времени. Значение по умолчанию — 1.

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

Текущее значение порядка выборки документов (на момент до исполнения метода): 1 — обратный порядок выборки документов; 0 — выборка документов в порядке возрастания даты и времени.

Описание:

Метод ОбратныйПорядок устанавливает порядок выборки документов. Данный метод обычно используется до вызова одного из методов: ВыбратьДокументы, ВыбратьПодчиненныеДокументы, ВыбратьПоЗначению, который фактически открывает выборку. Дальнейшая выборка при помощи ПолучитьДокумент будет происходить в заданном порядке выборки.

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

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

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

Пример:

Если Режим = "Подробный" Тогда

   Док = СоздатьОбъект("Документ");

   // устанавливаем обратный порядок выборки документов

   Док = ОбратныйПорядок(1);

   // открываем выборку документов

   Док.ВыбратьДокументы(ДатаНачало, ДатаКонец);

   // цикл получения документов

   Пока Док.ПолучитьДокумент() > 0 Цикл

      ТекДок = Док.ТекущийДокумент();

   КонецЦикла;

КонецЕсли;

УстановитьФильтр

Назначить фильтр выборки документов.

Синтаксис:

УстановитьФильтр(<Проведенные>, <НеПроведенные>, <НеИмеющиеПризнаковУчета>,

<Оперативные>, <Расчетные>, <Бухг>)

Англоязычный синоним:

SetFilter

Параметры:

<Проведенные>

Числовое выражение: 0 — не включать в выборку проведенные документы; 1 — включать.

<НеПроведенные>

Числовое выражение: 0 — не включать в выборку непроведенные документы; 1 — включать.

<НеИмеющиеПризнаковУчета>

Числовое выражение: 0 — не включать в выборку документы не имеющие признаков учета; 1 — включать.

<0перативные>

Числовое выражение: 0 — не включать в выборку оперативные документы; 1 — данный флаг не влияет на выборку; 2 — если оперативный документ, то включается в выборку.

<Расчетные>

Числовое выражение: 0 — не включать в выборку расчетные документы; 1 — данный флаг не влияет на выборку; 2 — если расчетный документ, то включается в выборку.

<Бухг>

Числовое выражение: 0 — не включать в выборку бухгалтерские документы; 1 — данный флаг не влияет на выборку; 2 — если бухгалтерский документ, то включается в выборку.

Описание:

Метод УстановитьФильтр назначает фильтр выборки документов.

Примеры:

·                  Док.УстановитьФильтр(1, 1, 1, 1, 1, 1) — в выборку включаются все документы;

·                  Док.УстановитьФильтр(1, 0, 1, 1, 1, 1) — в выборку включаются все проведенные документы;

·                  Док.УстановитьФильтр(1, 1, 0, 1, 0, 1) — в выборку включаются все документы, имеющие признак оперативный или бухгалтерский или оба, но не имеют признака расчетный;

·                  Док.УстановитьФильтр(1, 1, 1, 2, 1, 2) — в выборку включаются все документы, имеющие признаки и оперативный и бухгалтерский и те, которые не имеют признаков учета;

·                  Док.УстановитьФильтр(1, 1, 1, 2, 0, 2) — в выборку включаются все документы, имеющие признаки и оперативный и бухгалтерский, но не имеют признака расчета, и те, которые не имеют признаков учета;

·                  Док.УстановитьФильтр(1, 0, 0, 0, 1, 0) — в выборку не включаются проведенные документы, если они неоперативные и небухгалтерские и имеют признаки учета, т. е. фактически только проведенные расчетные. Данный метод может использоваться только для документов, созданных функцией СоздатьОбъект.

Пример:

Док = СоздатьОбъект("Документ");

// устанавливаем фильтр выборки документов

Док.УстановитьФильтр(1, 0, 0, 1, 0, 0);

// открываем выборку документов

Док.ВыбратьДокументы(ДатаНачало, ДатаКонец);

// цикл получения документов

Пока Док.ПолучитьДокумент() > 0 Цикл

   ТекДок = Док.ТекущийДокумент();

КонецЦикла;

ПолучитьДокумент

Получить из выборки следующий документ.

Синтаксис:

ПолучитьДокумент()

Англоязычный синоним:

GetDocument

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

Числовое значение: 1 — если следующий документ выбран успешно; 0 — если документ не найден (отсутствует).

Описание:

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

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

Пример:

Если Режим = "Подробный" Тогда

   Док = СоздатьОбъект("Документ");

   // Откроем выборку документов

   Док.ВыбратьДокументы(ДатаНачало, ДатаКонец);

   // Цикл выбора документов

   Пока Док.ПолучитьДокумент() > 0 Цикл

   // присвоим переменной ТекДок значение найденного документа

      ТекДок = Док.ТекущийДокумент();

      // ...

   КонецЦикла;

КонецЕсли;

См. также: ВыбратьДокументы

ВыбратьСтроки

Открыть выборку строк многострочной части документа.

Синтаксис:

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

Англоязычный синоним:

SelectLines

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

Число: 1 — если действие выполнено и в выборке есть хотя бы одна строка; 0 — если действие не выполнено или в выборке нет ни одной строки.

Описание:

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

Пример:

Процедура ОбработкаПроведения()

   Регистр.ТовЗап.Склад = Склад;

   // откроем выборку строк спецификации документа

   ВыбратьСтроки();

   // цикл получения строк спецификации документа

   Пока ПолучитьСтроку() > 0 Цикл

      Регистр.ПривязыватьСтроку(НомерСтроки);

      Регистр.ТовЗап.Товар = Товар;

      Регистр.ТовЗап.Количество = Количество;

      Регистр.ТовЗап.Стоимость = Стоимость;

      Регистр.ТовЗап.ДвижениеРасходВыполнить();

   КонецЦикла;

КонецПроцедуры

ПолучитьСтроку

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

Синтаксис:

ПолучитьСтроку()

Англоязычный синоним:

GetLine

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

Число: 1 — если следующая строка табличной части документа выбрана успешно; 0 — если следующая строка документа не найдена (отсутствует).

Описание:

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

Пример:

Процедура ОбработкаПроведения()

   Регистр.ТовЗап.Склад = Склад;

   // открываем выборку строк спецификации документа

   ВыбратьСтроки();

   // цикл выбора строк спецификации документа

   Пока ПолучитьСтроку() > 0 Цикл

      Регистр.ПривязыватьСтроку(НомерСтроки);

      Регистр.ТовЗап.Товар=Товар;

      Регистр.ТовЗап.Количество=Количество;

      Регистр.ТовЗап.Стоимость=Стоимость;

      Регистр.ТовЗап.ДвижениеРасходВыполнить();

   КонецЦикла;

КонецПроцедуры

Новый

Начать ввод нового документа.

Синтаксис:

Новый()

Англоязычный синоним:

New

Описание:

Метод Новый инициализирует создание нового документа. Собственно запись нового документа в информационную базу происходит при вызове метода Записать. После инициализации создания нового документа, как правило производится заполнение его реквизитов с последующим вызовом метода Записать.

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

Пример:

// данная процедура создает документ с № 1, в котором записывает

// все имеющиеся в справочнике должности

Процедура Оприходовать()

   Спр = СоздатьОбъект("Справочник.Должности");

   Док = СоздатьОбъект("Документ.Приказы");

   // найдем документ с № 1

   Док.НайтиПоНомеру("1", 0);

   Если Док.Выбран() = 0 Тогда

      // если документа с № 1 не существует, то создадим его

      Док.Новый();

      Док.НомерДок = "1";

      Док.ДатаДок='01.01.80';

      // запишем все должности в документ

      Спр.ВыбратьЭлементы();

      Пока Спр.ПолучитьЭлемент() > 0 Цикл

         Если (Док.Выбран() = 1) Тогда

            Док.НоваяСтрока();

            Док.Должность = Спр.ТекущийЭлемент();

         КонецЕсли;

      КонецЦикла;

      // запишем новый документ на диск

      Док.Записать();

   КонецЕсли;

КонецПроцедуры

ПрефиксНомера

Установить текущий префикс номера для документа.

Синтаксис:

ПрефиксНомера(<Префикс>)

Англоязычный синоним:

NumPrefix

Параметры:

<Префикс>

Необязательный параметр. Строковое выражение — новый префикс номера для документа.

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

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

Описание:

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

Данный метод может использоваться только для объектов, созданных Функцией СоздатьОбъект и в основном предназначен для использования при создании новых документов из языка с помощью метода Новый.

Пример:

ПрефиксНомера("Сч-");

См. также: ПрефиксАвтоНумерации, УстановитьНовыйНомер

УстановитьНовыйНомер

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

Синтаксис:

УстановитьНовыйНомер(<Префикс>)

Англоязычный синоним:

SetNewNum

Параметры:

<Префикс>

Строковое выражение — префикс номера документа.

Описание:

Метод УстановитьНовыйНомер устанавливает новый номер документа с заданным префиксом <Префикс>. Данный метод производит корректное переприсвоение номера документа (с автоинкрементацией и резервированием номера на время ввода).

Пример:

УстановитьНовыйНомер("01-");

См. также: ПрефиксАвтоНумерации, ПрефиксНомера

НазначитьТип

Назначить тип для реквизита неопределенного вида.

Синтаксис:

НазначитьТип(<ИмяРеквизита>, <ИмяТипа>, <Длина>, <Точность>)

Англоязычный синоним:

SetType

Параметры:

<ИмяРеквизита>

Строковое выражение — название реквизита документа неопределенного типа, как он назван в конфигураторе.

<ИмяТипа>

Строковое выражение — название типа данных (или Вид субконто), который назначается реквизиту документа. Например:

"Строка", "Число", "Справочник.Товары", "Документ.РасходнаяНакладная" и т. п.

<Длина>

Необязательный параметр. Числовое выражение — длина поля представления данных. Имеет смысл только при задании числового или строкового типа.

<Точность>

Необязательный параметр. Числовое выражение — число знаков числа после десятичной точки. Имеет смысл только при задании числового типа.

Описание:

Метод НазначитьТип позволяет назначить тип для реквизита, которому в конфигураторе назначен тип «Неопределенный».

Пример:

Накладная.НазначитьТип("ТМЦ", "Справочник.Товары");

Записать

Записать документ.

Синтаксис:

Записать()

Англоязычный синоним:

Write

Описание:

Метод Записать выполняет запись в базу данных текущего нового или измененного документа.

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

Пример:

Док.СоздатьОбъект("Документ.Заказ");

Док.АвтоВремяТекущее();

Док.Новый();

Док.УстановитьНовыйНомер("Прг-");

Док.Клиент = Константа.ОсновнойКлиент;

Док.Количество = 5;

Док.Записать();

Док.Провести(1, "Программно");

Удалить

Удалить документ.

Синтаксис:

удалить(<Режим>)

Англоязычный синоним:

Delete

Параметры:

<Режим>

Необязательный параметр. Числовое выражение: 1 — непосредственное удаление; 0 — пометка на удаление. Значение по умолчанию — 1.

Описание:

Метод Удалить удаляет (или делает пометку на удаление) текущий документ. Данный метод разрешено применять только для тех документов, которые либо не проведены, либо они лежат за точкой ТА, т. е. предполагается, что предварительно интерактивно сдвинули ТА назад.

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

Замечание: Непосредственное удаление объекта следует применять очень аккуратно, так как это действие может нарушить ссылочную целостность информации. Данный режим не рекомендуется использовать, если на данный объект могут быть ссылки в других объектах, например в реквизитах существующих документов.

Пример:

Док = СоздатьОбъект("Документ.Приказы");

Если Док.Выбрать("Найди документ") > 0 Тогда

   Док.Удалить(1);

КонецЕсли;

См. также: ПометкаУдаления, СнятьПометкуУдаления

ПометкаУдаления

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

Синтаксис:

ПометкаУдаления()

Англоязычный синоним:

DeleteMark

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

Число: 1 — если на документе стоит пометка удаления; 0 — если нет пометки удаления.

Описание:

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

Пример:

Процедура УсловноеУдаление(Докум)

   Док = СоздатьОбъект("Документ");

   Если Докум.Выбран() > 0 Тогда

      // позиционируем документ на переданном значении

      Док.НайтиДокумент(Докум);

      Если Док.Выбран() > 0 Тогда

         Если Вопрос("Удалять??? ", 1) = 1 Тогда

            Если Док.ПометкаУдаления() = 1 Тогда

               Предупреждение("Уже помечен на удаление!");

            Иначе

               // удаляем документ

               Док.Удалить(0);

            КонецЕсли;

         КонецЕсли;

      Иначе

         Предупреждение("Нечего удалять! ");

      КонецЕсли;

   КонецЕсли;

КонецПроцедуры

См. также: Удалить, СнятьПометкуУдаления

СнятьПометкуУдаления

Снять пометку удаления документа.

Синтаксис:

СнятьПометкуУдаления()

Англоязычный синоним:

ClearDeleteMark

Описание:

Метод СнятьПометкуУдаления снимает пометку удаления текущего документа.

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

Пример:

Процедура Восстановление(Докум)

   Док = СоздатьОбъект("Документ");

   Если Докум.Выбран() > 0 Тогда

      // позиционируем документ на переданном значении

      Док.НайтиДокумент(Докум);

      Если Док.Выбран() > 0 Тогда

         Если Док.ПометкаУдаления() = 1 Тогда

            // восстанавливаем

            Спр.СнятьПометкуУдаления();

         КонецЕсли;

      КонецЕсли;

   КонецЕсли;

КонецПроцедуры _________ _______

См. также: Удалить, ПометкаУдаления

НоваяСтрока

Добавить новую строку в документ.

Синтаксис:

НоваяСтрока()

Англоязычный синоним:

NewLine

Описание:

Метод НоваяСтрока добавляет новую строку с очередным порядковым номером в многострочную часть документа.

Пример:

Процедура ОбработкаПодбора(Выб, КонФормы)

   Кол=0;

   Если ВвестиЧисло(Кол, "Введите количество", 10, 0) = 1 Тогда

      // добавим новую строку в спецификацию

      НоваяСтрока();

      Работа = Выб;

      Количество = Кол;

      АктивизироватьСтроку();

   КонецЕсли;

КонецПроцедуры

УдалитьСтроку

Удалить строку документа.

Синтаксис:

УдалитьСтроку()

Англоязычный синоним:

DeleteLine

Описание:

Метод УдалитьСтроку удаляет текущую строку из многострочной части Документа.

Пример:

Процедура УдалЗаданнойСтроки(Док, Стр)

   Если Док.Выбран() = 1 Тогда

      // если переданный параметр содержит значение документа, то

      // найдем в нем строку

      Док.ПолучитьСтрокуПоНомеру(Стр);

      // удалим найденную строку спецификации документа

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

      Предупреждение("Документ не выбран!");

   КонецЕсли;

КонецЕсли;

УдалитьСтроки

Удалить все строки документа.

Синтаксис:

УдалитьСтроки()

Англоязычный синоним:

DeleteLines

Описание:

Метод УдалитьСтроки удаляет сразу все строки из многострочной части документа.

Пример:

УдалитьСтроки();

СортироватьСтроки

Сортировать многострочную часть документа по реквизитам.

Синтаксис:

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

Англоязычный синоним:

SortLines

Параметры:

<Колонки>                       

Перечисленные через запятую реквизиты многострочной части документа, по которым следует сортировать. Знаки "+", "-", предшествующие названию реквизита указывают направление сортировки по реквизиту. Знак "*" — сортировать по внутреннему значению реквизита.

Описание:

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

Пример:

Док = СоздатьОбъект("Документ.Приказы");

Если Док.Выбрать("Найди документ") > 0 Тогда

   Док.СортироватьСтроки("+Сумма, -НДС");

   Док.Записать ();

КонецЕсли;

ПолучитьПозицию

Получить позицию документа.

Синтаксис:

ПолучитьПозицию()

Англоязычный синоним:

GetPosition

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

32-х символьное строковое значение позиции документа.

Описание:

Метод ПолучитьПозицию возвращает позицию документа.

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

Пример:

ПозицияДокумента = ВыбДокумент.ПолучитьПозицию();

ПринадлежитПоследовательности

Определить, принадлежит ли последовательности данный документ.

Синтаксис:

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

Англоязычный синоним:

BelongToSequence

Параметры:

<Последов>

Строковое выражение, определяющая Последовательность.

<НовоеЗначение>

Необязательный параметр. Число:

1 — документ принудительно устанавливается как принадлежащий последовательности; 0 — документ принудительно устанавливается как не принадлежащий последовательности.

Использование этого параметра разрешено только при проведении документа (в Модуле документа).

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

Число: 1 — если документ принадлежит последовательности; 0 — если не принадлежит.

Описание:

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

Пример:

Если Док.ПринадлежитПоследовательности(«УпрУчет») = 1 Тогда

   Если Последовательность.УпрУчет.Сравнить(Док) = 1 Тогда

      Последовательность.УпрУчет.Установить(Док);

   КонецЕсли;

КонецЕсли;

ИспользоватьЖурнал

Использовать журнал для отбора документов и доступа к графам.

Синтаксис:

ИспользоватьЖурнал(<Журнал>, <ФлагОгрПросм>)

Англоязычный синоним:

UseJournal

Параметры:

<Журнал>

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

<ФлагОгрПросм>

Необязательный параметр. Число: 1 — если выборка ограничивается документами, входящими в указанный журнал; 0 — если метод используется только для использования граф методом Графа. Значение по умолчанию 1.

Описание:

Метод ИспользоватьЖурнал позволяет при переборе документов командой Выбрать использовать журнал для отбора документов и доступа к графам журнала.

Пример:

Док = СоздатьОбъект("Документ.НаклПрих");

Док.ИспользоватьЖурнал("Приходные");

См. также: Графа

Графа

Выдает значение графы журнала для текущего документа.

Синтаксис:

Графа(<Графа>)

Англоязычный синоним:

Column

Параметры:

<Графа>

Идентификатор графы журнала, который задан методом ИспользоватьЖурнал.

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

Значение заданной графы журнала для текущего документа.

Описание:

Метод Графа позволяет получить значение заданной графы журнала для текущего документа. Данный метод работает только в том случае, если ранее Применен метод ИспользоватьЖурнал.

Пример:

Док = СоздатьОбъект("Документ.НаклПрих");

Док.ИспользоватьЖурнал("Приходные", 0);

док.НайтиДокумент(ВыбДок);

Цена = Док.Графа("Цена");

См. также: ИспользоватьЖурнал

Блокировка

Установить/прочитать режим блокировки.

Синтаксис:

Блокировка(<ВклВыкл>)

Англоязычный синоним:

Locking

Параметры:

<ВклВыкл>

Необязательный параметр. Число: 1 — включить; 0 — выключить.

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

Если при вызове метода параметр <ВклВыкл> не задан, то возвращается режим блокировки до выполнения метода. Число: 1 — заблокирован; 0 — свободен.

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

Описание:

Метод Блокировка позволяет установить/прочитать режим блокировки.

Пример:

Блокировка(0);

ПолучитьВремя

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

Синтаксис:

ПолучитьВремя(<Часы>, <Минуты>, <Секунды>)

Англоязычный синоним:

GetTime

Параметры:

<Часы>

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

<Секунды>

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

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

Строковое значение времени записи документа в виде "ЧЧ.ММ.СС".

Описание:

Метод ПолучитьВремя возвращает время документа в переданные для этого переменные <Часы>, <Минуты>, <Секунды>.

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

Пример:

Функция ВремяДокумента(Док)

   Перем Ч;

   Перем М;

   Перем С;

   Если Док.Выбран() > 0 Тогда

      Док.ПолучитьВремя(Ч, М, С);

      Возврат "Документ записан в " + Ч + " час " + М + " мин. " + С + " с";

   Иначе

      Возврат "Документ не выбран!";

   КонецЕсли;

Конецфункции

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

Установить время документа.

Синтаксис:

УстановитьВремя(<Часы>, <Минуты>, <Секунды>)

Англоязычный синоним:

SetTime

Параметры:

<Часы>

Числовое выражение.

<Минуты>

Числовое выражение.

<Секунды>

Числовое выражение.

Описание:

Метод УстановитьВремя устанавливает время документа в соответствии с заданными параметрами <Часы>, <Минуты>, <Секунды>.

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

Пример:

Док = СоздатьОбъект("Документ.НаклПрих");

Если Док.Выбрать("Найди документ") > 0 Тогда

   Док.УстановитьВремя(13, 0, 0);

КонецЕсли;

См. также: ПриИзмененииВремениДокумента

АвтоВремяНачалоДня

Установить новому документу время на начало дня.

Синтаксис:

АвтоВремяНачалоДня()

Англоязычный синоним:

AutoTimeBegOfDay

Описание:

Метод АвтоВремяНачалоДня устанавливает режим, при котором новому документу записывается время на начало дня.

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

Пример:

Процедура УстВремяДок(Док, Режим)

   Если Режим = "Начало" Тогда

      Док.АвтоВремяНачалоДня();

   ИначеЕсли Режим = "Конец" Тогда

      Док.АвтоВремяКонецДня();

   ИначеЕсли Режим = "Текущее" Тогда

      Док.АвтоВремяТекущее();

   Иначе

      Док.АвтоВремяОтключить();

   КонецЕсли;

КонецПроцедуры

АвтоВремяКонецДня

Установить новому документу время на конец дня.

Синтаксис:

АвтоВремяКонецДня()

Англоязычный синоним:

AutoTimeEndOfDay

Описание:

Метод АвтоВремяКонецДня устанавливает режим, при котором новому документу записывается время на конец дня.

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

Пример:

См. предыдущий пример

АвтоВремяТекущее

Установить новому документу текущее время.

Синтаксис:

АвтоВремяТекущее()

Англоязычный синоним:

AutoTimeCurrent

Описание:

Метод АвтоВремяТекущее устанавливает режим, при котором новому документу записывается текущее время.

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

Пример:

Процедура УстВремяДок(Док, Режим)

   Если Режим = "Начало" Тогда

      Док.АвтоВремяНачалоДня();

   ИначеЕсли Режим = "Конец" Тогда

      Док.АвтоВремяКонецДня();

   ИначеЕсли Режим = "Текущее" Тогда

      Док.АвтоВремяТекущее();

   Иначе

      Док.АвтоВремяОтключить();

   КонецЕсли;

КонецПроцедуры

АвтоВремяПослеТА

Установить новому документу время после ТА.

Синтаксис:

АвтоВремяПослеТА()

Англоязычный синоним:

AutoTimeAfterAP

Описание:

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

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

Пример:

Процедура УстВремяДок(Док, Режим)

   Если Режим = "Начало" Тогда

      Док.АвтоВремяНачалоДня();

   ИначеЕсли Режим = "Конец" Тогда

      Док.АвтоВремяКонецДня();

   ИначеЕсли Режим = "Текущее" Тогда

      Док.АвтоВремяТекущее();

   ИначеЕсли Режим = "ПослеТА" Тогда

      Док.АвтоВремяПослеТА();

   Иначе

      Док.АвтоВремяОтключить();

   КокецЕсли;

КонецПроцедуры

АвтоВремяОтключить

Отключает режим автоматической установки времени документа.

Синтаксис:

АвтоВремяОтключить()

Англоязычный синоним:

AutoTimeOff

Описание:

Метод АвтоВремяОтключить отключает режим автоматической установки времени нового документа, при этом новые документы заносятся с временем устанавливаемым при помощи метода УстановитьВремя.

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

Пример:

См. предыдущий пример

См. также: УстановитьВремя

Провести

Выполнить проведение документа.

Синтаксис:

Провести(<Режим>, <3нач>)

Англоязычный синоним:

MakeActions

Параметры:

<Режим>

Необязательный параметр. Числовое выражение: 0 — проводить документ без сдвига ТА; 1 — проводить непроведенный документ реальным временем (со сдвигом ТА); 2 — перепроводить проведенный документ реальным временем (со сдвигом ТА); 3 —проводить любой (непроведенный, проведенный) документ реальным временем (со сдвигом ТА). Значение по умолчанию — 0.

Данный параметр устанавливает режим проведения документа после ТА. Этот метод относится к случаю проведения документа в пределах даты, в которой находится ТА. Дело в том, что при записи документа, документ кроме даты получает еще и время документа. В многопользовательском режиме часто возникает ситуация, когда в момент проведения документа, он уже оказывается не последним в потоке проводимых документов (провели документ с другого рабочего места), в этом случае система 1С:Предприятие дает на выбор два варианта проведения:

·                 провести документ тем временем, каким он был записан, т. е. фактически задним временем (до ТА);

·                 изменить время документа в рамках текущей даты, чтобы документ стал самым последним и проводился в потоке, т. е. в ТА.

<3нач>

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

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

Число: 1 — проведение документа завершено успешно; 0 — проведение документа не выполнено.

Описание:

Метод Провести запускает процедуру проведения документа. Возвращаемое значение можно использовать, например, в качестве условия принятия решения при завершении обработки транзакции.

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

Замечание. Если этот метод применяется в Модуле формы документа непосредственно к документу локального контекста, то данный метод отрабатывает те же действия, как интерактивное нажатие пользователем кнопки с формулой "#Провести". В этом случае, если параметр <Режим> опущен, то документ проводится в режиме, соответствующем установкам системы меню «Сервис» - «Параметры».

Пример:

Док.СоздатьОбъект("Документ.Заказ");

Док.АвтоВремяТекущее();

Док.Новый();

Док.УстановитьНовыйНомер("Прг-");

Док.Клиент = Константа.ОсновнойКлиент;

Док.Количество = 5;

Док.Записать();

Док.Провести(1, "Программно");

См. также: ОбработкаПроведения, ГруппроваяОбработка

СделатьНеПроведенным

Отменить проведение документа.

Синтаксис:

СделатьНеПроведенным()

Англоязычный синоним:

UnPost

Описание:

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

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

Пример:

Док.СоздатьОбъект("Документ.Заказ");

Док.НайтиДокумент(Докум);

Док.СделатьНеПроведенным();

См. также: Провести, ПриОтменеПроведенияДокумента

СравнитьТА

Сравнить дату и время документа с Точкой актуальности итогов.

Синтаксис:

СравнитьТА()

Англоязычный синоним:

CompareWithAP

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

Числовое значение:

·                    1(плюс единица) — если дата и время документа больше даты и времени Точки актуальности итогов.

·                    0 — если дата и время документа равно дате и времени Точки актуальности итогов.

·                    -1 (минус единица) — если дата и время документа меньше даты и времени Точки актуальности итогов.

·                    -2 (минус два) в случае, если новый документ, который сравнивается с ТА, еще не записан, то есть он еще не имеет никакой позиции на оси времени.

Описание:

Метод СравнитьТА сверяет дату и время документа с датой и временем Точки актуальности итогов, позволяя определить положение на оси времени момента записи документа по отношению к текущиму положению ТА.

Пример:

Процедура ОбработкаПроведения()

   Если СравнитьТА() > 0 Тогда

      // если документ после ТА, вызываем процедуру

      ПроводкаДокументаБудущимЧислом();

   ИначеЕсли СравнитьТА() < 0 Тогда

      // если документ до ТА, вызываем процедуру

      ПроводкаДокументаЗаднимЧислом();

   Иначе

      // если документ в ТА, вызываем процедуру

      ПроводкаДокумента();

   КонецЕсли;

КонецПроцедуры

СуществуетОперация

Устанавливает (возвращает) признак существования операции у документа.

Синтаксис:

СуществуетОперация(<Признак>)

Англоязычный синоним:

OperExist

Параметры:

<Признак>

Числовое выражение: 1 — существует операция, 0 — не существует операции.

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

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

Описание:

В метаданных для конкретного вида документа (имеющего признак «Бухгалтерский учет») устанавливается режим записи операции. Операция может записываться для документов данного вида в режимах: «Всегда», «Выборочно» и «Только при проведении».

Метод СуществуетОперация применяется в случае использования режима «Выборочно». Он устанавливает признак наличия операции у конкретного документа. Данная возможность позволяет записывать операцию для документов конкретного вида в зависимости от некоторых условий. Для режимов записи операции «Всегда» и «Только при проведении» данный метод смысла не имеет.

Пример:

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

Процедура ПриЗаписи()

   Если Склад = ОснСклад Тогда

      СуществуетОперация(1);

   Иначе

      СуществуетОперация(0);

   КонецЕсли;

КонецПроцедуры

ВыгрузитьТабличнуюЧасть

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

Синтаксис:

ВыгрузитьТабличнуюЧасть(<3нач>, <Реквизиты>)

Англоязычный синоним:

UnloadTable

Параметры:

<3нач>

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

<Реквизиты>

Необязательный параметр. Список реквизитов многострочной части документа через запятую. Данный параметр указывает, какие реквизиты выгружать, если не указано то все. Для номера строки документа в таблице значений создается отдельная колонка с идентификатором "НомерСтрокиДокумента". При задании какие колонки выгружать, для выгрузки номера строки надо указать колонку "НомерСтроки".

Описание:

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

Пример:

ВыбДокум.ВыгрузитьТабличнуюЧасть(ТаблЗнач, "Товар, Сумма, НДС, Цена");

ЗагрузитьТабличнуюЧасть

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

Синтаксис:

ЗагрузитьТабличнуюЧасть(<ТаблЗнач>)

Англоязычный синоним:

LoadTable

Параметры:

<ТаблЗнач>

Таблица значений, откуда загружается многострочная часть документа. Колонки совмещаются по идентификаторам.

Описание:

Метод ЗагрузитьТабличнуюЧасть загружает многострочную часть документа из таблицы значений.

Пример:

ВыбДокум.ЗагрузитьТабличнуюЧасть(ТаблЗнач);

 



Перейти  к оглавлению: Описание встроенного языка

Hosted by uCoz