Журнал документов — средство для работы со списком документов. В терминах языка журнал не является специальным типом данных (он не имеет значения, его нельзя создать при помощи функции СоздатьОбъект).
С журналом в системе связана форма отображения списка документов и программный модуль формы журнала документов (см. «Виды программных модулей»). В локальном контексте этого программного модуля непосредственно доступны реквизиты формы журнала. Кроме того, здесь непосредственно доступен атрибут «только для чтения» — ТекущийДокумент, содержащий значение выбранного в журнале документа.
Атрибуты контекста Модуля формы журнала документовОписанный в данном разделе атрибут можно вызывать только в Модуле формы журнала (см. «Виды программных модулей»).
ТекущийДокументСинтаксис:ТекущийДокумент
Англоязычный синоним:CurrentDocument
Описание:
Атрибут (только для чтения) ТекущийДокумент содержит значение выбранного в журнале документа. Этот атрибут позволяет использовать в программе полученное значение документа. Поскольку данный атрибут фактически является ссылкой на позиционируемый объект типа «документ», то поэтому для передачи или запоминания самого значения текущего документа журнала рекомендуется использовать конструкциюЦитата
ТекущийДокумент.ТекущийДокумент()
Данный атрибут может использоваться только в локальном контексте программного модуля формы журнала документов.
Пример:
// только в модуле Формы журнала документа
// ———————————————————————————————————————
функция Операция()
Если Число(ТекущийДокумент.Выбран()) > 0 Тогда
Возврат "" + ТекущийДокумент.ДатаДок + " " + ТекущийДокумент.Вид;
Иначе
Возврат "Пусто";
КонецЕсли;
КонецФункции
//————————————————————————————————————————
Функция ЖурналСумма()
Если Число(ТекущийДокумент.Выбран()) > 0 тогда
Возврат Константа.МинЗарплата.Получить(ДатаДок);
Иначе
Возврат 0;
КонецЕсли;
КонецФункции
Методы контекста Модуля формы журнала документовОписанные в данном разделе методы доступны только в контексте Модуля формы журнала документов (см. «Виды программных модулей»).
Отбор по значениям может производиться только в «Общем» журнале, т. е. в котором установлен признак «Все документы». Таким образом, отбор по значениям может выступать в качестве альтернативного способа выбора документов в журнале, относительно выбору документов по видам. С другой стороны, сам набор ссылок на реквизиты документов определенных видов в настройке графы отбора определяет состав видов документов включаемых в данный отбор. Для того, чтобы при открытии журнала не показывался список всех документов, следует в предопределенной процедуре ПриОткрытии установить отбор по несуществующему значению отбора, например, по пустому значению.
ВидыОтбораУстановить доступные виды отборов журнала для вызова их в интерактивном режиме.
Синтаксис:ВидыОтбора(<СписокИменОтборов>)
Англоязычный синоним:KindsOfSelection
Возвращаемое значение:Строковое значение, содержащее текущий список имен отборов для журнала, разделенных запятыми (на момент до исполнения метода).
Описание:Метод ВидыОтбора устанавливает доступные виды отборов журнала для вызова их в интерактивном режиме.
Данный метод доступен только в контексте Модуля формы журнала документов (см. «Виды программных модулей»).
Пример:
ВидыОтбора("Склад, Клиент, Автор");
ЗакладкиОтбораУстановить в форме журнала закладки для интерактивного осуществления отбора.
Синтаксис:ЗакладкиОтбора(<ИмяОтбора>, <ФлагОтбораЗначенийВИнтервалеЖурнала>,
<ФлагУстановкиЗначенияОтбора>, <3начение0тбора>)
Англоязычный синоним:TabCtrlSelection
Описание:Метод ЗакладкиОтбора устанавливает в форме журнала закладки для интерактивного осуществления отбора.
Данный метод доступен только в контексте Модуля формы журнала документов (см. «Виды программных модулей»).
Пример:
ЗакладкиОтбора("Склады", 1, 1, Константа.ОснСклад);
УстановитьОтборУстановить отбор журнала.
Синтаксис:УстановитьОтбор(<ИмяОтбора>, <3начение0тбора>)
Англоязычный синоним:SetSelection
Описание:Метод УстановитьОтбор принудительно устанавливает отбор для журнала.
Данный метод доступен только в контексте Модуля формы журнала документов (см. «Виды программных модулей»).
Замечание. Во всех журналах, кроме журнала подчиненных документов, работает отбор по виду документа. В этом случае синтаксис вызова метода следующий:
УстановитьОтбор(<ВедДокумента>)
Пример:
Изм = УстановитьОтбор("Склады", Склад1);
ПолучитьОтборВозвратить текущее значение отбора журнала.
Синтаксис:ПолучитьОтбор(<ИмяОтбора>, <3начение0тбора>)
Англоязычный синоним:GetSelection
Возвращаемое значение:Числовое значение: 1 — есть отбор; 0 — если нет отбора.
Описание:Метод ПолучитьОтбор возвращает текущее значение отбора журнала. Данный метод доступен только в контексте Модуля формы журнала документов (см. «Виды программных модулей»).
Пример:
Изм = ПолучитьОтбор();
УстановитьИнтервалУстановить интервал журнала.
Синтаксис:УстановитьИнтервал(<ДатаНач>, <ДатаКон>, <ФлагИзменения>)
Англоязычный синоним:SetRange
Описание:Метод УстановитьМнтервал позволяет установить интервал журнала. Данный метод доступен только в контексте Модуля формы журнала документов (см. «Виды программных модулей»).
Пример:
УстановитьИнтервал(НИ, КИ);
НачалоИнтервалаВозвратить дату начала интервала журнала.
Синтаксис:НачалоИнтервала()
Англоязычный синоним:BegOfRange
Возвращаемое значение:Значение даты начала интервала журнала.
Описание:Метод НачалоИнтервала позволяет получить дату начала интервала журнала.
Данный метод доступен только в контексте Модуля формы журнала документов (см. «Виды программных модулей»).
Пример:
НИ = НачалоИнтервала();
КонецИнтервалаВозвратить дату конца интервала журнала.
Синтаксис:КонецИнтервала()
Англоязычный синоним:EndOfRange
Возвращаемое значение:Значение даты конца интервала журнала.
Описание:Метод КонецИнтервала позволяет получить дату конца интервала журнала.
Данный метод доступен только в контексте Модуля формы журнала документов (см. «Виды программных модулей»).
Пример:
КИ = КонецИнтервала();
ПодчинениеДокументуУстановить документ-владелец для журнала подчиненных документов.
Синтаксис:ПодчинениеДокументу([<Докум>], [<ФлагАвтоСменыПодчинен>])
Англоязычный синоним:ParentDoc
Возвращаемое значение:Текущее значение документа, которому подчинен журнал.
Описание:Метод ПодчинениеДокументу позволяет установить документ-владелец для журнала подчиненных документов.
Данный метод доступен только в контексте Модуля формы журнала подчиненных документов (см. «Виды программных модулей»).
Пример:
ПодчинениеДокументу(Док, 1);