Модуль "Документы"

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

Функции

Объекты и типы

Функции модуля "Документы"

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

Формат вызова:
ВыбратьДокумент(Документ: Документ; [ТипыДокументов]: целое): целое; /*только чтение*/

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

параметры:
Документ - Переменная документа.

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

Формат вызова:
ВыбратьДокументы(ТипДокумента: целое; Список: СписокДокументов; Поля: строка; Значения ...: БезТипа): целое; /*только чтение*/

описание:
Выбирает в список документы с указанными параметрами. Если параметры отбора не заданы, то список заполняется текущими открытыми документами.

ВыбратьКакСправочник

Формат вызова:
ВыбратьКакСправочник(ТипДокумента: целое; Документ: Документ; [Список]: СписокОбъектов; [ПрограммаФильтра]: Программа; [Информация]: объект; [НомерЗакладки]: целое): целое; /*только чтение*/

описание:
Вызывает диалог выбора документов одного типа, в форме справочника.

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

результат:
Если пользователь выбирает кнопку "ОК" то результат "ДА" (1) иначе "НЕТ" (0).

ДокументСуществует

Формат вызова:
ДокументСуществует(Документ: Документ; ПроверитьБазуДанных = нет: целое; [Подключение]: Документ): целое; /*только чтение*/

Документы

Формат вызова:
Документы: ОкноДокументов;

описание:
Текущая активная секция документов.

пример использования:

  

КлассДокумента

Формат вызова:
КлассДокумента(Идентификаторы ...: строка): КлассДокументов; /*только чтение*/

КлассОбрабатываемогоДокумента

Формат вызова:
КлассОбрабатываемогоДокумента: КлассДокументов; /*только чтение*/

МенеджерДокументов

Формат вызова:
МенеджерДокументов: МенеджерДокументов; /*только чтение*/

описание:
Объект предназначен для экспорта / импорта конфигураций документов.

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

Формат вызова:
НайтиДокумент(ТипДокумента: целое; Поля: строка; Значения ...: БезТипа): Документ; /*только чтение*/

описание:
Ищет документ по указанным параметрам.

пример использования:

Документ := НайтиДокумент(Документ_РасчетПоТабелю, "Период", Период.ПолныйМесяц);

наследованный

Формат вызова:
наследованный; /*только чтение*/

ОбновитьФормыДокументов

Формат вызова:
ОбновитьФормыДокументов; /*только чтение*/

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

Формат вызова:
ПерейтиНаДокумент(Документ: Документ; ТипДокумент: целое): целое; /*только чтение*/

описание:
Установить текущий документ на секции документов.

РедактироватьПолеДокумента

Формат вызова:
РедактироватьПолеДокумента(Поле: ПолеДокумента; Ссылка: целое); /*только чтение*/

СоздатьДокумент

Формат вызова:
СоздатьДокумент(ТипДокумента, [БезНомера]: целое; [РодительскийДокумент]: Документ; [БезПроверкиПрав]: целое): Документ; /*только чтение*/

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

пример использования:

 

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

Формат вызова:
СоздатьПараметрыВыборкиДокумента(СписокПараметров: СписокПараметров): ПараметрыВыборкиДокуметов; /*только чтение*/

СоздатьУсловияВыборки

Формат вызова:
СоздатьУсловияВыборки(ТипДокумента: целое; [ИмяПоляВыборки]: строка): УсловияВыборкиДокументов; /*только чтение*/

СписокЗначенийПоляДокумента

Формат вызова:
СписокЗначенийПоляДокумента(Поле: ПолеДокумента; Список: Список): целое; /*только чтение*/

ТипДокумента

Формат вызова:
ТипДокумента(Документ: Документ; [Подключение]: Подключение): целое; /*только чтение*/

описание:
Возвращает индекс типа документа.

ФиктивныйДокумент

Формат вызова:
ФиктивныйДокумент(Дата: Дата; Номер: целое): Документ; /*только чтение*/

описание:
Формирует код фиктивного документа, содержащего только дату и номер. При отсутствии параметров возвращет -1.

Типы модуля "Документы"

ПараметрыВыборкиДокуметов

описание:
У документов на каждом рабочем месте можно сделать дополнительные (помимо начальной и конечной даты) параметры открытия. Данный объект предназначен для доступа к этип параметрам. Каждый пункт параметра может иметь текстовое и целое представление.

функции объекта:

Диалог

Формат вызова:
ПараметрыВыборкиДокуметов.Диалог: СписокПараметров; /*только чтение*/

Значение

Формат вызова:
ПараметрыВыборкиДокуметов.Значение(Признак: БезТипа): целое;

описание:
Целое значение параметра по индексу или краткому названию параметра.

параметры:
Признак - Индекс (от 0 до Количество - 1) или краткое название параметра.

результат:
Если параметр не найден, то возвращает 0.

Идентификатор

Формат вызова:
ПараметрыВыборкиДокуметов.Идентификатор(Индекс: целое): строка; /*только чтение*/

КлассПоля

Формат вызова:
ПараметрыВыборкиДокуметов.КлассПоля(Признак: БезТипа): КлассПоля; /*только чтение*/

Количество

Формат вызова:
ПараметрыВыборкиДокуметов.Количество: целое; /*только чтение*/

описание:
Общее количество параметров в списке.

Текст

Формат вызова:
ПараметрыВыборкиДокуметов.Текст(Признак: БезТипа): строка;

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

параметры:
Признак - Индекс (от 0 до Количество - 1) или краткое название параметра.

результат:
Если параметр не найден, то возвращает пустую строку ("").

Удалить

Формат вызова:
ПараметрыВыборкиДокуметов.Удалить(Признак: БезТипа);

УдалитьОбъект

Формат вызова:
ПараметрыВыборкиДокуметов.УдалитьОбъект; /*только чтение*/

Флаг

Формат вызова:
ПараметрыВыборкиДокуметов.Флаг(Признак: БезТипа): целое;

УсловияВыборкиДокументов

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

функции объекта:

Автогенерация

Формат вызова:
УсловияВыборкиДокументов.Автогенерация(Параметры: ПараметрыВыборкиДокуметов); /*только чтение*/

Добавить

Формат вызова:
УсловияВыборкиДокументов.Добавить(Поле: строка; ТипУсловия: целое; Значения ...: БезТипа): УсловияВыборкиДокументов; /*только чтение*/

описание:
Добавляет новое условие в запрос.

параметры:
Поле - Поле, по которому строится условие выборки.
ТипУсловия - Условие_Меньше
Условие_Больше
Условие_БольшеИлиРавно
Условие_МеньшеИлиРавно
Условие_НеРавно
Условие_Равно
Условие_Между
Условие_Входит
Условие_Текст

Значения ... - Значения условия выборки.

ДобавитьВВыборку

Формат вызова:
УсловияВыборкиДокументов.ДобавитьВВыборку(Ключ: целое); /*только чтение*/

ДобавитьТаблицу

Формат вызова:
УсловияВыборкиДокументов.ДобавитьТаблицу(Таблица: строка); /*только чтение*/

описание:
Добавляет таблицу в секцию "from" SQL запроса.

Документ

Формат вызова:
УсловияВыборкиДокументов.Документ(Индекс: целое): Документ; /*только чтение*/

описание:
Документ из выборки по индексу (от 0 до .Количество - 1)

Запрос

Формат вызова:
УсловияВыборкиДокументов.Запрос(ТолькоУсловие: целое): строка; /*только чтение*/

Количество

Формат вызова:
УсловияВыборкиДокументов.Количество: целое; /*только чтение*/

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

Очистить

Формат вызова:
УсловияВыборкиДокументов.Очистить([АвтогенерацияПараметров]: целое); /*только чтение*/

описание:
Очистка всех установленных ограничений.

ПоляВыборки

Формат вызова:
УсловияВыборкиДокументов.ПоляВыборки: строка;

ПоляИзСвязки

Формат вызова:
УсловияВыборкиДокументов.ПоляИзСвязки: целое;

Применить

Формат вызова:
УсловияВыборкиДокументов.Применить: целое; /*только чтение*/

описание:
Вызывается для применения ограничений.

Присоединить

Формат вызова:
УсловияВыборкиДокументов.Присоединить(ТипУсловия: целое); /*только чтение*/

описание:
Присоеднияет условие по "ИЛИ"

ТипДокумента

Формат вызова:
УсловияВыборкиДокументов.ТипДокумента: КлассДокументов; /*только чтение*/

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

УдалитьОбъект

Формат вызова:
УсловияВыборкиДокументов.УдалитьОбъект; /*только чтение*/

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

КлассКолонки

функции объекта:

Класс

Формат вызова:
КлассКолонки.Класс: КлассДокументов; /*только чтение*/

Вложенность

Формат вызова:
КлассКолонки.Вложенность: целое; /*только чтение*/

Заголовок

Формат вызова:
КлассКолонки.Заголовок: строка; /*только чтение*/

Идентификатор

Формат вызова:
КлассКолонки.Идентификатор: строка; /*только чтение*/

ИмяПоля

Формат вызова:
КлассКолонки.ИмяПоля: строка; /*только чтение*/

КлассПоля

Формат вызова:
КлассКолонки.КлассПоля: КлассПоля; /*только чтение*/

Очередность

Формат вызова:
КлассКолонки.Очередность: целое; /*только чтение*/

Документ

описание:
Основной объект модуля "Документы". От него наследуются все другие виды документов.

функции объекта:

Дата

Формат вызова:
Документ.Дата: Дата;

описание:
Возвращает и устанавливает дату создания документа.

Добавить

Формат вызова:
Документ.Добавить: Документ; /*только чтение*/

описание:
Добавляет новый документ.

ЗаблокироватьСобытия

Формат вызова:
Документ.ЗаблокироватьСобытия(События ...: целое); /*только чтение*/

описание:
Блокирует события по указанному индексу. Функция необходима при заполнении документов, имеющих много сложных формул во избежании постоянного пересчета при изменении значений полей документа. В конце обязательно нужно вызвать функцию РазблокироватьСобытия.

Заголовок

Формат вызова:
Документ.Заголовок: строка;

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

ЗагрузитьИзБуфера

Формат вызова:
Документ.ЗагрузитьИзБуфера(Буфер: Буфер); /*только чтение*/

ЗагрузитьПолеИзБуфера

Формат вызова:
Документ.ЗагрузитьПолеИзБуфера(ИмяПоля: строка; Буфер: Буфер): целое; /*только чтение*/

ИзменитьСтатус

Формат вызова:
Документ.ИзменитьСтатус(Статус: целое); /*только чтение*/

ИмяРаздела

Формат вызова:
Документ.ИмяРаздела([Полное = нет]: целое): строка;

Категория

Формат вызова:
Документ.Категория: строка; /*только чтение*/

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

Ключ

Формат вызова:
Документ.Ключ: целое;

описание:
Внутренний код объекта, необходимый для хранения в базе данных. Имеет тоже значение, что и сам объект.

МонопольныйДоступ

Формат вызова:
Документ.МонопольныйДоступ: целое;

Наименование

Формат вызова:
Документ.Наименование: строка; /*только чтение*/

описание:
Возвращает наименование документа.

НайтиПоле

Формат вызова:
Документ.НайтиПоле(ИмяПоля: строка): ПолеДокумента; /*только чтение*/

описание:
Находит поле документа по заданному имени поля.

параметры:
ИмяПоля - Параметр указывает имя поля документа.

Номер

Формат вызова:
Документ.Номер: целое;

описание:
Возвращает и устанавливает номер документа.

Обновить

Формат вызова:
Документ.Обновить(ПеречитатьИзБазы: целое); /*только чтение*/

описание:
Обновляет документ после редактирования новыми данными и возвращает "Да" (1), если обновление прошло успешно.

ОбновитьРабочееМесто

Формат вызова:
Документ.ОбновитьРабочееМесто; /*только чтение*/

описание:
Устанавливается режим обновления рабочего места.

ОтменитьИзменения

Формат вызова:
Документ.ОтменитьИзменения(ДляОдногоДокумента: целое); /*только чтение*/

описание:
Возвращает "Да" (1), если произведенные изменения необходимо отменить, не сохраняя.

параметры:
ДляОдногоДокумента - Указывается "ДА"(1), если изменения требуется отменить только для данного документа и "Нет" (0) в противном случае.

ПараметрРаздела

Формат вызова:
Документ.ПараметрРаздела(Идентификатор: строка; [Раздел]: целое): РесурсныйПараметр;

Показать

Формат вызова:
Документ.Показать(Параметры, АктивнаяДетализация: целое): целое; /*только чтение*/

описание:
Возвращает "Да"(1), если данный документ нужно показать и "Нет"(0) в противном случае.

Поле

Формат вызова:
Документ.Поле(ИмяПоля: строка): ПолеДокумента; /*только чтение*/

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

параметры:
ИмяПоля - Параметр указывает имя поля документа.

ПолеИзменено

Формат вызова:
Документ.ПолеИзменено(ИмяПоля ...: строка): целое;

описание:
Возвращает "Да" (1), если хотя бы одно из полей документа, переданных в списке входных параметров, с указанным именем было изменено и "Нет" (0) в противном случае.

параметры:
ИмяПоля ... - Параметр указывает имя поля документа.

пример использования:

ИзменениеЗаписи(ПП: ПлатежноеПоручение);
переменные
  Организация: Организация;
начало
  если ПП.ПолеИзменено("Плательщик") тогда
  начало
    Организация := ОрганизацияПоНаименованию(ПП.Плательщик);
    если Организация <> -1 тогда
      ПП.СчетПлательщика := Организация.Счет;
  конец;
  если ПП.ПолеИзменено("Получатель") тогда
  начало
    Организация := ОрганизацияПоНаименованию(ПП.Получатель);
    если Организация <> -1 тогда
      ПП.СчетПолучателя := Организация.Счет;
  конец;
конец

ПоляИзменены

Формат вызова:
Документ.ПоляИзменены(ИмяПоля ...: строка): целое;

описание:
Возвращает "Да" (1), если все поля документа с указанными именами были изменены и "Нет" (0) в противном случае.

параметры:
ИмяПоля ... - Параметр указывает имя поля документа.

ПроверитьУровеньГруппы

Формат вызова:
Документ.ПроверитьУровеньГруппы; /*только чтение*/

РазблокироватьСобытия

Формат вызова:
Документ.РазблокироватьСобытия(События ...: целое); /*только чтение*/

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

РодительскийДокумент

Формат вызова:
Документ.РодительскийДокумент: Документ;

описание:
Возвращает указатель на родительский документ, если такового нет, то возвращает "0".

Сортировка

Формат вызова:
Документ.Сортировка: строка;

СохранитьВБуфер

Формат вызова:
Документ.СохранитьВБуфер(Буфер: Буфер; [ДляКорзины]: целое); /*только чтение*/

СохранитьИзменения

Формат вызова:
Документ.СохранитьИзменения(ДляОдногоДокумента: целое); /*только чтение*/

описание:
Возвращает "Да" (1), если произведенные изменения необходимо сохранить.

параметры:
ДляОдногоДокумента - Указывается "ДА" (1), если изменения требуется сохранить только для данного документа и "Нет" (0) в противном случае.

СохранитьПолеВБуфер

Формат вызова:
Документ.СохранитьПолеВБуфер(ИмяПоля: строка; Буфер: Буфер): целое; /*только чтение*/

СписокДетализации

Формат вызова:
Документ.СписокДетализации(Наименование: строка; Список: СписокДокументов; [ПоТекущемуПредставлению]: целое): целое; /*только чтение*/

СписокИзмененныхПолей

Формат вызова:
Документ.СписокИзмененныхПолей(Список: Список): целое; /*только чтение*/

Статус

Формат вызова:
Документ.Статус([НемедленноеСохранение]: целое): целое;

описание:
Возвращает и устанавливает код статуса документа (согласно константам): "новый", "редактируется", "проведен", "закрыт".

СформироватьОбраз

Формат вызова:
Документ.СформироватьОбраз(Буфер: Буфер; ИспользоватьОбработчик: целое; [ЭП]: ЦифроваяПодпись); /*только чтение*/

ТекстПоСписку

Формат вызова:
Документ.ТекстПоСписку(ИмяПоля: строка): строка;

Текущий

Формат вызова:
Документ.Текущий: Документ;

описание:
Возвращает и устанавливает данный документ как текущий.

Тип

Формат вызова:
Документ.Тип: КлассДокументов;

описание:
Возвращает значение кода документа по типу.

Удалить

Формат вызова:
Документ.Удалить; /*только чтение*/

описание:
Удаляет документ из списка документов и возвращает "Да" (1), если удаление прошло успешно.

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

Формат вызова:
Документ.УстановитьПароль(НовыйПароль, СтарыйПароль: строка); /*только чтение*/

ЭЦП

Формат вызова:
Документ.ЭЦП([Проверить]: целое): ЦифроваяПодпись; /*только чтение*/

ПолеКакДробное

Формат вызова:
Документ.ПолеКакДробное(ИмяПоля: строка; ЗначениеВБазеДанных: целое): дробное;

ПолеКакОбъект

Формат вызова:
Документ.ПолеКакОбъект(ИмяПоля: строка; ЗначениеВБазеДанных: целое): объект;

ПолеКакСтрока

Формат вызова:
Документ.ПолеКакСтрока(ИмяПоля: строка; ЗначениеВБазеДанных: целое): строка;

ПолеКакЦелое

Формат вызова:
Документ.ПолеКакЦелое(ИмяПоля: строка; ЗначениеВБазеДанных: целое): целое;

ПолеПустое

Формат вызова:
Документ.ПолеПустое(ИмяПоля: строка; ЗначениеВБазеДанных: целое): целое;

ЕстьИзменения

Формат вызова:
Документ.ЕстьИзменения(ПроверитьДетализации: целое): целое; /*только чтение*/

CтатусИзменения

Формат вызова:
Документ.CтатусИзменения: целое; /*только чтение*/

описание:
Метод Документ.CтатусИзменения возвращает статус документа в кэше. Добавлены константсы для статуса документа в кэше: СтатусИзменения_НетВКэше СтатусИзменения_НеИзменен СтатусИзменения_Добавлен СтатусИзменения_Модифицирован СтатусИзменения_Удален

АвторДокумента

Формат вызова:
Документ.АвторДокумента([КемСоздан]: целое): строка; /*только чтение*/

ВремяДокумента

Формат вызова:
Документ.ВремяДокумента([КогдаСоздан]: целое): дробное; /*только чтение*/

ЗакрытьОкно

Формат вызова:
Документ.ЗакрытьОкно; /*только чтение*/

ЗаписатьОформление

Формат вызова:
Документ.ЗаписатьОформление(ЦветФона, ЦветШрифта, СтильШрифта: целое): целое; /*только чтение*/

описание:
Устанавливает сразу все параметры оформления всей строки(за исключением ячеек у которых задано свое оформление).

ЗаписатьОформлениеКолонки

Формат вызова:
Документ.ЗаписатьОформлениеКолонки(ИмяПоля: строка; ЦветФона, ЦветШрифта, СтильШрифта: целое): целое; /*только чтение*/

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

ПодготовитьЗапись

Формат вызова:
Документ.ПодготовитьЗапись; /*только чтение*/

ПроверитьРежимРедактирования

Формат вызова:
Документ.ПроверитьРежимРедактирования(Секция: СекцияПроекта): целое; /*только чтение*/

СтильШрифта

Формат вызова:
Документ.СтильШрифта: целое;

описание:
Устанавливает/получает стиль шрифта всей строки(за исключением ячеек у которых задано свое оформление).

СтильШрифтаКолонки

Формат вызова:
Документ.СтильШрифтаКолонки(ИмяПоля: строка): целое;

описание:
Устанавливает/получает стиль шрифта в ячейке.

ЦветФона

Формат вызова:
Документ.ЦветФона: целое;

описание:
Устанавливает/получает цвет фона всей строки(за исключением ячеек у которых задано свое оформление).

ЦветФонаКолонки

Формат вызова:
Документ.ЦветФонаКолонки(ИмяПоля: строка): целое;

описание:
Устанавливает/получает цвет фона ячейки.

ЦветШрифта

Формат вызова:
Документ.ЦветШрифта: целое;

описание:
Устанавливает/получает цвет шрифта всей строки(за исключением ячеек у которых задано свое оформление).

ЦветШрифтаКолонки

Формат вызова:
Документ.ЦветШрифтаКолонки(ИмяПоля: строка): целое;

описание:
Устанавливает/получает цвет шрифта в ячейке.

КЭШЗначенийДокументов

функции объекта:

Закрыть

Формат вызова:
КЭШЗначенийДокументов.Закрыть;

Значение

Формат вызова:
КЭШЗначенийДокументов.Значение(Документ: Документ; Индекс, Отсутствует: целое): целое;

Открыть

Формат вызова:
КЭШЗначенийДокументов.Открыть(Дата: Дата); /*только чтение*/

Текст

Формат вызова:
КЭШЗначенийДокументов.Текст(Документ: Документ; Индекс, Отсутствует: целое): строка;

ПолеДокумента

описание:
Объект предназначен для прямого доступа к полям документа.

функции объекта:

Вычисляемое

Формат вызова:
ПолеДокумента.Вычисляемое: целое; /*только чтение*/

ЗагузитьИзБуфера

Формат вызова:
ПолеДокумента.ЗагузитьИзБуфера(Буфер: Буфер); /*только чтение*/

Изменено

Формат вызова:
ПолеДокумента.Изменено: целое;

описание:
Возвращает "да" (1) если в результате действия пользователя поле было изменено. При присвоении результата вызывается событие на изменение записи документа

Имя

Формат вызова:
ПолеДокумента.Имя(ИмяБД: целое): строка; /*только чтение*/

описание:
Краткое имя поля (русский идентификатор)

КакДробное

Формат вызова:
ПолеДокумента.КакДробное([Непосредственно]: целое): дробное;

описание:
Доступ к полю как дробному.

КакОбъект

Формат вызова:
ПолеДокумента.КакОбъект([Непосредственно]: целое): объект;

описание:
Доступ к полю как объекту (как целое только без преобразования типов).

КакСтрока

Формат вызова:
ПолеДокумента.КакСтрока([Непосредственно]: целое): строка;

описание:
Доступ к полю как строковому.

КакЦелое

Формат вызова:
ПолеДокумента.КакЦелое([Непосредственно]: целое): целое;

описание:
Доступ к полю как целому.

Класс

Формат вызова:
ПолеДокумента.Класс: КлассДокументов; /*только чтение*/

Модуль

Формат вызова:
ПолеДокумента.Модуль: строка; /*только чтение*/

Пустое

Формат вызова:
ПолеДокумента.Пустое([Непосредственно]: целое): целое;

описание:
Возвращаеет "да" (1) если поле не имеет никакого значения.

Сектор

Формат вызова:
ПолеДокумента.Сектор: СекторДокумента; /*только чтение*/

СохранитьВБуфер

Формат вызова:
ПолеДокумента.СохранитьВБуфер(Буфер: Буфер); /*только чтение*/

СсылкаНаСтроку

Формат вызова:
ПолеДокумента.СсылкаНаСтроку(Строка: строка): целое; /*только чтение*/

СтрокаПоСсылке

Формат вызова:
ПолеДокумента.СтрокаПоСсылке(Ссылка: целое): строка; /*только чтение*/

Текст

Формат вызова:
ПолеДокумента.Текст: строка; /*только чтение*/

ТипОбъекта

Формат вызова:
ПолеДокумента.ТипОбъекта: целое; /*только чтение*/

СекторДокумента

функции объекта:

КакДробное

Формат вызова:
СекторДокумента.КакДробное(Запись: объект): дробное;

КакОбъект

Формат вызова:
СекторДокумента.КакОбъект(Запись: объект): объект;

КакСтрока

Формат вызова:
СекторДокумента.КакСтрока(Запись: объект): строка;

КакЦелое

Формат вызова:
СекторДокумента.КакЦелое(Запись: объект): целое;

ОкноДокументов

описание:
Секция документов - основной интерфейс для ввода первичной информации.

функции объекта:

ВидСписка

Формат вызова:
ОкноДокументов.ВидСписка: целое;

Детализация

Формат вызова:
ОкноДокументов.Детализация(Номер: целое): Документ; /*только чтение*/

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

КоличествоДетализаций

Формат вызова:
ОкноДокументов.КоличествоДетализаций: целое; /*только чтение*/

описание:
Количество выделенных пунктов табличной части документов.

КоличествоМастерЗаписей

Формат вызова:
ОкноДокументов.КоличествоМастерЗаписей: целое; /*только чтение*/

описание:
Количество выделенных записей документов на общем списке.

пример использования:

// обработка выделенных документов
начало
  НачатьИзмененияДанных;
  попытка
    если Документы.КоличествоМастерЗаписей <> 0 тогда
    начало
      Индикатор.Старт(Документы.КоличествоМастерЗаписей, НазваниеСтатуса(Статус));
      попытка
        от А := 1 до Документы.КоличествоМастерЗаписей делать
        начало
          ОбработатьПлатежноеПоручение(Документы.Мастер(А));
          Индикатор.Передвинуть;
        конец;
      обязательно
        Индикатор.Стоп;
      конец;
    конец иначе
      ОбработатьПлатежноеПоручение(ПлатежноеПоручение);
  обязательно
    ЗакончитьИзмененияДанных;
  конец;
конец;

Контейнер

Формат вызова:
ОкноДокументов.Контейнер: КонтейнерДокументов; /*только чтение*/

Мастер

Формат вызова:
ОкноДокументов.Мастер(Номер: целое): Документ; /*только чтение*/

описание:
Документ по номеру в списке выделенных документов.

пример использования:

// см. пример для "КоличествоМастерЗаписей"

ОбновитьДокумент

Формат вызова:
ОкноДокументов.ОбновитьДокумент; /*только чтение*/

описание:
Делает обновление активных документов.

СписокПараметров

Формат вызова:
ОкноДокументов.СписокПараметров: СписокПараметров; /*только чтение*/

Текущий

Формат вызова:
ОкноДокументов.Текущий: Документ; /*только чтение*/

описание:
Текущий документ на секции.

ТипТекущегоДокумента

Формат вызова:
ОкноДокументов.ТипТекущегоДокумента: целое; /*только чтение*/

Класс

Формат вызова:
ОкноДокументов.Класс: КлассДокументов;

Секция

Формат вызова:
ОкноДокументов.Секция: СекцияПроекта;

КонтейнерДокументов

функции объекта:

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

Формат вызова:
КонтейнерДокументов.Заблокировать; /*только чтение*/

Параметры

Формат вызова:
КонтейнерДокументов.Параметры: СписокПараметров; /*только чтение*/

Разблокировать

Формат вызова:
КонтейнерДокументов.Разблокировать; /*только чтение*/

РежимКарточки

Формат вызова:
КонтейнерДокументов.РежимКарточки: целое;

ТабличнаяЧасть

Формат вызова:
КонтейнерДокументов.ТабличнаяЧасть: ТаблицаДокумента; /*только чтение*/

Форма

Формат вызова:
КонтейнерДокументов.Форма: объект; /*только чтение*/

ШапкаДокумента

Формат вызова:
КонтейнерДокументов.ШапкаДокумента: ТаблицаДокумента; /*только чтение*/

ФокусНаКлассе

Формат вызова:
КонтейнерДокументов.ФокусНаКлассе: КлассДокументов; /*только чтение*/

СправочникДокумента

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

функции объекта:

Документ

Формат вызова:
СправочникДокумента.Документ: Документ;

описание:
Текущий документ на интерфейсе.

Контейнер

Формат вызова:
СправочникДокумента.Контейнер: КонтейнерДокументов; /*только чтение*/

Раздел

Формат вызова:
СправочникДокумента.Раздел(ВерхнееЗначение: целое): целое;

Тип

Формат вызова:
СправочникДокумента.Тип: целое;

описание:
Вид документа справочника.

ИнспекторДокумента

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

функции объекта:

Закладка

Формат вызова:
ИнспекторДокумента.Закладка(Тип: целое): ЗакладкаДетализацииДокумента; /*только чтение*/

Параметр

Формат вызова:
ИнспекторДокумента.Параметр(Идентификатор: строка): КолонкаДокумента; /*только чтение*/

описание:
Пункт в списке параметров документов.

Таблица

Формат вызова:
ИнспекторДокумента.Таблица([Тип]: целое): ТаблицаДокумента; /*только чтение*/

Класс

Формат вызова:
ИнспекторДокумента.Класс: КлассДокументов; /*только чтение*/

Секция

Формат вызова:
ИнспекторДокумента.Секция: СекцияПроекта; /*только чтение*/

ТаблицаДокумента

функции объекта:

Колонка

Формат вызова:
ТаблицаДокумента.Колонка(Идентификатор: строка; ВызватьОшибку: целое): КолонкаДокумента; /*только чтение*/

СписокВыбранных

Формат вызова:
ТаблицаДокумента.СписокВыбранных(Список: СписокДокументов; [ВидВыбранных]: целое); /*только чтение*/

описание:
В обработчиках на изменение статуса в методе Контейнер.ШапкаДокумента.СписокВыбранных второй параметр теперь можно будет использовать для получения списка выделенных документов при автоматическом изменении статуса: 0 - (ВыбранныеДокументы_Выделенные): как обычно, список выделенных документом при обычном обработчике статуса; 1 - (ВыбранныеДокументы_ВсеНаСекции): список всех документов на секции; 2 - (ВыбранныеДокументы_ДляАвтоСтатуса): список выделенных документов именно для авто-статуса.

Тип

Формат вызова:
ТаблицаДокумента.Тип: целое; /*только чтение*/

ВыбранноеПоле

Формат вызова:
ТаблицаДокумента.ВыбранноеПоле: строка; /*только чтение*/

Класс

Формат вызова:
ТаблицаДокумента.Класс: КлассДокументов; /*только чтение*/

РежимПросмотра

Формат вызова:
ТаблицаДокумента.РежимПросмотра: целое;

Секция

Формат вызова:
ТаблицаДокумента.Секция: СекцияПроекта; /*только чтение*/

ЗакладкаДетализацииДокумента

функции объекта:

Видимость

Формат вызова:
ЗакладкаДетализацииДокумента.Видимость: целое;

Заголовок

Формат вызова:
ЗакладкаДетализацииДокумента.Заголовок: строка;

КолонкаДокумента

функции объекта:

Доступность

Формат вызова:
КолонкаДокумента.Доступность: целое;

Заголовок

Формат вызова:
КолонкаДокумента.Заголовок: строка;

Захлопнут

Формат вызова:
КолонкаДокумента.Захлопнут: целое;

СтильРедактора

Формат вызова:
КолонкаДокумента.СтильРедактора: целое;

Уровень

Формат вызова:
КолонкаДокумента.Уровень: целое;

ЦветЗаголовка

Формат вызова:
КолонкаДокумента.ЦветЗаголовка([ДляФона]: целое): целое;

ЦветЗначения

Формат вызова:
КолонкаДокумента.ЦветЗначения([ДляФона]: целое): целое;

ШрифтЗаголовка

Формат вызова:
КолонкаДокумента.ШрифтЗаголовка: целое;

ШрифтЗначения

Формат вызова:
КолонкаДокумента.ШрифтЗначения: целое;

СписокДокументов

наследуется от типа: СписокОбъектов

описание:
Объект, наследуемый от стандартного списка объектов. Нужен для более удобного доступа к элементам списка, если они являются объектами.

функции объекта:

Документ

Формат вызова:
СписокДокументов.Документ(Индекс: целое): Документ;

МенеджерДокументов

описание:
Объект предназначен для экспорта / импорта конфигураций документов.

функции объекта:

БлокировкаРедактируемыхЗаписей

Формат вызова:
МенеджерДокументов.БлокировкаРедактируемыхЗаписей: целое;

описание:
Для оперативного включения (выключения) блокировки.

ЗагрузитьДокументИзФайла

Формат вызова:
МенеджерДокументов.ЗагрузитьДокументИзФайла(ИмяФайла: строка); /*только чтение*/

описание:
Загружает документ из файла. После выполнения функции новый документ сразу отображается в дереве настройки документов.

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

Формат вызова:
МенеджерДокументов.ЗакрытьДокументы; /*только чтение*/

КЭШЗначений

Формат вызова:
МенеджерДокументов.КЭШЗначений: КЭШЗначенийДокументов; /*только чтение*/

КЭШКлассов

Формат вызова:
МенеджерДокументов.КЭШКлассов: Отношение; /*только чтение*/

ОчиститьБлокировкуЗаписей

Формат вызова:
МенеджерДокументов.ОчиститьБлокировкуЗаписей([УчетнаяЗапись]: Пользователь); /*только чтение*/

описание:
Для снятия блокировки по всем или по указанному пользователю.

ПодкачкаТекстовыхПолей

Формат вызова:
МенеджерДокументов.ПодкачкаТекстовыхПолей: целое;

ПроверитьКлючДокумента

Формат вызова:
МенеджерДокументов.ПроверитьКлючДокумента(Ключ: целое): строка; /*только чтение*/

ПроверкаОбязательныхПолей

Формат вызова:
МенеджерДокументов.ПроверкаОбязательныхПолей: целое;

СинхронизацияДокументов

Формат вызова:
МенеджерДокументов.СинхронизацияДокументов: целое;

СохранитьДокументВФайл

Формат вызова:
МенеджерДокументов.СохранитьДокументВФайл(ИмяФайла, [Идентификатор]: строка); /*только чтение*/

описание:
Сохраняет документ с указанным именем ("Платежное поручение") в файл.

СохранитьИзменения

Формат вызова:
МенеджерДокументов.СохранитьИзменения; /*только чтение*/

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

СохранятьНомерПриКопировании

Формат вызова:
МенеджерДокументов.СохранятьНомерПриКопировании: целое;

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

Формат вызова:
МенеджерДокументов.УдалитьДокументы(Тип: КлассДокументов); /*только чтение*/

ЦветаИнтерфейса

Формат вызова:
МенеджерДокументов.ЦветаИнтерфейса(ИндексЦвета: целое): целое;

КонтрольОдновременногоДоступа

Формат вызова:
МенеджерДокументов.КонтрольОдновременногоДоступа: целое;

ОтладкаЗапросовДокумента

Формат вызова:
МенеджерДокументов.ОтладкаЗапросовДокумента: целое;

СохранитьКэшИзменений

Формат вызова:
МенеджерДокументов.СохранитьКэшИзменений(Буфер: Буфер); /*только чтение*/

СохранитьТаблицуБлокировок

Формат вызова:
МенеджерДокументов.СохранитьТаблицуБлокировок(Буфер: Буфер); /*только чтение*/

АктуализироватьДокумент

Формат вызова:
МенеджерДокументов.АктуализироватьДокумент(Документ: Документ; [ПроверитьКэшКлассов], [ПеречитатьИзБазы]: целое); /*только чтение*/

ДокументЗагруженВКЭШ

Формат вызова:
МенеджерДокументов.ДокументЗагруженВКЭШ(Ключ, [Тип]: целое): целое; /*только чтение*/

ИспользованиеМаскиВКлючах

Формат вызова:
МенеджерДокументов.ИспользованиеМаскиВКлючах: целое; /*только чтение*/

ОбновитьВнешниеИнструменты

Формат вызова:
МенеджерДокументов.ОбновитьВнешниеИнструменты; /*только чтение*/

ПроверкаПравПриСоздании

Формат вызова:
МенеджерДокументов.ПроверкаПравПриСоздании: целое;

СписокНазванийДокументов

Формат вызова:
МенеджерДокументов.СписокНазванийДокументов(Источник: Отношение; Приемник: Список); /*только чтение*/

КлассДокументов

функции объекта:

Адаптер

Формат вызова:
КлассДокументов.Адаптер: АдаптерДанных; /*только чтение*/

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

Формат вызова:
КлассДокументов.ВыбратьДокументы(Условия: УсловияВыборкиДокументов; Список: СписокДокументов; [УдалитьУсловия = нет]: целое): целое; /*только чтение*/

ВыгрузитьПодкаченныеЗаписи

Формат вызова:
КлассДокументов.ВыгрузитьПодкаченныеЗаписи; /*только чтение*/

Детализация

Формат вызова:
КлассДокументов.Детализация(Индекс: целое): КлассДокументов; /*только чтение*/

ДочернийКласс

Формат вызова:
КлассДокументов.ДочернийКласс(Наименование: строка): КлассДокументов; /*только чтение*/

ЗаблокироватьСобытия

Формат вызова:
КлассДокументов.ЗаблокироватьСобытия(События ...: целое); /*только чтение*/

Заголовок

Формат вызова:
КлассДокументов.Заголовок: строка; /*только чтение*/

Запросы

Формат вызова:
КлассДокументов.Запросы(Идентификатор: строка; Индекс: целое): строка; /*только чтение*/

Идентификатор

Формат вызова:
КлассДокументов.Идентификатор: строка; /*только чтение*/

ИзменитьЗапись

Формат вызова:
КлассДокументов.ИзменитьЗапись(Запись: объект; Статус: целое); /*только чтение*/

ИмеетСвязаннуюТаблицу

Формат вызова:
КлассДокументов.ИмеетСвязаннуюТаблицу: целое; /*только чтение*/

ИмяПоля

Формат вызова:
КлассДокументов.ИмяПоля(Идентификатор: строка; [ВключитьИмяТаблицы = нет]: целое): строка; /*только чтение*/

ИмяТаблицы

Формат вызова:
КлассДокументов.ИмяТаблицы([ДляПоля]: строка): строка; /*только чтение*/

ИндексДляБД

Формат вызова:
КлассДокументов.ИндексДляБД: целое; /*только чтение*/

Инициализировать

Формат вызова:
КлассДокументов.Инициализировать: целое; /*только чтение*/

Категория

Формат вызова:
КлассДокументов.Категория: строка;

КлассПоля

Формат вызова:
КлассДокументов.КлассПоля(Идентификатор: строка): КлассПоля; /*только чтение*/

КонечнаяДата

Формат вызова:
КлассДокументов.КонечнаяДата: Дата; /*только чтение*/

Кэширование

Формат вызова:
КлассДокументов.Кэширование: целое;

Наименование

Формат вызова:
КлассДокументов.Наименование: строка; /*только чтение*/

НаследуетсяОт

Формат вызова:
КлассДокументов.НаследуетсяОт(Класс: КлассДокументов; [Непосредственно]: целое): целое; /*только чтение*/

НачальнаяДата

Формат вызова:
КлассДокументов.НачальнаяДата: Дата; /*только чтение*/

Обновить

Формат вызова:
КлассДокументов.Обновить([ОбновитьСекции]: целое); /*только чтение*/

Обработчик

Формат вызова:
КлассДокументов.Обработчик(Событие: целое): Программа; /*только чтение*/

ОтменитьИзменения

Формат вызова:
КлассДокументов.ОтменитьИзменения; /*только чтение*/

Отношение

Формат вызова:
КлассДокументов.Отношение: Отношение; /*только чтение*/

ПараметрРаздела

Формат вызова:
КлассДокументов.ПараметрРаздела(Идентификатор: строка; [Раздел], [ТочноеЗначение]: целое): РесурсныйПараметр;

Параметры

Формат вызова:
КлассДокументов.Параметры: целое; /*только чтение*/

ПараметрыСекции

Формат вызова:
КлассДокументов.ПараметрыСекции(Секция: СекцияПроекта): СписокПараметров; /*только чтение*/

Переоткрыть

Формат вызова:
КлассДокументов.Переоткрыть(НачальнаяДата, КонечнаяДата: Дата; Условия: ПараметрыВыборкиДокуметов); /*только чтение*/

ПодготовитьКэш

Формат вызова:
КлассДокументов.ПодготовитьКэш(Список: объект; Идентификатор: строка); /*только чтение*/

Подключение

Формат вызова:
КлассДокументов.Подключение: Подключение; /*только чтение*/

Поле

Формат вызова:
КлассДокументов.Поле(Имя: строка; [ВызватьОшибку = да]: целое): ПолеДокумента; /*только чтение*/

ПолеИзменено

Формат вызова:
КлассДокументов.ПолеИзменено(ИмяПоля ...: строка): целое;

ПолучитьЗапись

Формат вызова:
КлассДокументов.ПолучитьЗапись(Документ, Родитель: Документ; СНомером: целое): объект; /*только чтение*/

Поля

Формат вызова:
КлассДокументов.Поля(Индекс: целое): ПолеДокумента; /*только чтение*/

ПоляИзменены

Формат вызова:
КлассДокументов.ПоляИзменены(ИмяПоля ...: строка): целое;

Последовательность

Формат вызова:
КлассДокументов.Последовательность: строка; /*только чтение*/

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

Формат вызова:
КлассДокументов.Представление: КлассДокументов; /*только чтение*/

Привязка

Формат вызова:
КлассДокументов.Привязка(Секция: целое): целое; /*только чтение*/

описание:
Информация на связке "Класс документа + рабочее место (секция)" для произвольного использования.

ПрограммаФильтрации

Формат вызова:
КлассДокументов.ПрограммаФильтрации: Программа;

РазблокироватьСобытия

Формат вызова:
КлассДокументов.РазблокироватьСобытия(События ...: целое); /*только чтение*/

РодительскийКласс

Формат вызова:
КлассДокументов.РодительскийКласс(Шапка: целое): КлассДокументов; /*только чтение*/

СквознаяНумерация

Формат вызова:
КлассДокументов.СквознаяНумерация: целое; /*только чтение*/

СледующийНомер

Формат вызова:
КлассДокументов.СледующийНомер([Дата]: Дата; [СквознаяНумерация]: целое; [КСП]: КСП): целое; /*только чтение*/

СоздатьДокумент

Формат вызова:
КлассДокументов.СоздатьДокумент([БезНомера]: целое): Документ; /*только чтение*/

СоздатьИзБуфера

Формат вызова:
КлассДокументов.СоздатьИзБуфера(Буфер: Буфер; [БезНомера], [ВызватьОбработчикНаСоздание]: целое): Документ; /*только чтение*/

Сокращение

Формат вызова:
КлассДокументов.Сокращение: строка; /*только чтение*/

СохранитьИзменения

Формат вызова:
КлассДокументов.СохранитьИзменения; /*только чтение*/

СписокНаследников

Формат вызова:
КлассДокументов.СписокНаследников(Список: СписокОбъектов); /*только чтение*/

СписокПолей

Формат вызова:
КлассДокументов.СписокПолей(Список: СписокОбъектов); /*только чтение*/

Текущий

Формат вызова:
КлассДокументов.Текущий: Документ;

ТекущийРаздел

Формат вызова:
КлассДокументов.ТекущийРаздел: строка;

ЧислоДетализаций

Формат вызова:
КлассДокументов.ЧислоДетализаций: целое; /*только чтение*/

ЧислоПолей

Формат вызова:
КлассДокументов.ЧислоПолей: целое; /*только чтение*/

ЭтоБлокирующийСтатус

Формат вызова:
КлассДокументов.ЭтоБлокирующийСтатус(Статус: целое): целое; /*только чтение*/

ДокументКласса

Формат вызова:
КлассДокументов.ДокументКласса(Документ: Документ): ДокументКласса; /*только чтение*/

ЗарезервироватьКлючи

Формат вызова:
КлассДокументов.ЗарезервироватьКлючи(Количество: целое); /*только чтение*/

МаскаНомера

Формат вызова:
КлассДокументов.МаскаНомера: строка; /*только чтение*/

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

Формат вызова:
КлассДокументов.НаименованиеДокумента(Документ: Документ): строка; /*только чтение*/

ОстатокКлючей

Формат вызова:
КлассДокументов.ОстатокКлючей: целое; /*только чтение*/

ПараметрыНумерации

Формат вызова:
КлассДокументов.ПараметрыНумерации: целое; /*только чтение*/

ПериодНумерации

Формат вызова:
КлассДокументов.ПериодНумерации: целое; /*только чтение*/

СписокИнструментов

Формат вызова:
КлассДокументов.СписокИнструментов(Список: СписокОбъектов; ТипОбъекта: целое); /*только чтение*/

КлассПоля

функции объекта:

Вычисляемый

Формат вызова:
КлассПоля.Вычисляемый: целое; /*только чтение*/

Заголовок

Формат вызова:
КлассПоля.Заголовок: строка; /*только чтение*/

ИмяПоля

Формат вызова:
КлассПоля.ИмяПоля: строка; /*только чтение*/

Модуль

Формат вызова:
КлассПоля.Модуль: строка; /*только чтение*/

Размер

Формат вызова:
КлассПоля.Размер: целое; /*только чтение*/

Сокращение

Формат вызова:
КлассПоля.Сокращение: строка; /*только чтение*/

СписокЗначений

Формат вызова:
КлассПоля.СписокЗначений: строка; /*только чтение*/

СтильРедактора

Формат вызова:
КлассПоля.СтильРедактора: целое; /*только чтение*/

ТипДокумента

Формат вызова:
КлассПоля.ТипДокумента: целое; /*только чтение*/

ТипОбъекта

Формат вызова:
КлассПоля.ТипОбъекта: целое; /*только чтение*/

Справочник

Формат вызова:
КлассПоля.Справочник: строка; /*только чтение*/

ФормаДокумента

функции объекта:

Класс

Формат вызова:
ФормаДокумента.Класс: КлассДокументов; /*только чтение*/

Визуализатор

Формат вызова:
ФормаДокумента.Визуализатор: строка; /*только чтение*/

Вложенность

Формат вызова:
ФормаДокумента.Вложенность: целое; /*только чтение*/

Название

Формат вызова:
ФормаДокумента.Название: строка; /*только чтение*/

НаСкрытие

Формат вызова:
ФормаДокумента.НаСкрытие: Программа; /*только чтение*/

Обработчик

Формат вызова:
ФормаДокумента.Обработчик: Программа; /*только чтение*/

Порядок

Формат вызова:
ФормаДокумента.Порядок: целое; /*только чтение*/

Ресурс

Формат вызова:
ФормаДокумента.Ресурс: строка; /*только чтение*/

КнопкаДокумента

функции объекта:

Класс

Формат вызова:
КнопкаДокумента.Класс: КлассДокументов; /*только чтение*/

ДокументКласса

наследуется от типа: Документ

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