Предопределенные процедуры Модуля документа

Описанные в данном разделе системные предопределенные процедуры должны располагаться только в Модулях документов (см. «Виды программных модулей»).

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

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

Предопределенные процедуры Модуля формы справочника

Описанные в данном разделе системные предопределенные процедуры должны располагаться только в Модулях форм справочника (см. «Виды программных модулей»). К ним относятся программные модули: Модуль формы элемента справочника, Модуль формы группы справочника.

В основном данные процедуры предназначены для расширения возможности программного управления правами доступа к системе.

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

Предопределенные процедуры Модуля формы

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

Предопределенные процедуры Модуля формы документа

Описанные в данном разделе системные предопределенные процедуры должны располагаться только в Модулях формы документов (см. «Виды программных модулей»).

Предопределенные процедуры модуля формы операции

Описанные в данном разделе системные предопределенные процедуры должны располагаться только в модуле формы операции (см. «Виды программных модулей»).

Предопределенные процедуры модуля формы отчета (обработки)

Предопределенные процедуры модуля формы счета

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

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

Предопределенные процедуры Модуля формы списка справочника

Описанные в данном разделе системные предопределенные процедуры должны располагаться только в Модулях формы списка справочника (см. «Виды программных модулей»).

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

Описанные в данном разделе системные предопределенные процедуры должны располагаться только в Модулях форм списка счетов (см. «Виды программных модулей»).

Предопределенные процедуры Модуля формы журнала документов

Описанные в данном разделе системные предопределенные процедуры должны располагаться только в Модулях формы журналов документов (см. «Виды программных модулей»).

Предопределенные процедуры модуля формы журнала операций

Описанные в данном разделе системные предопределенные процедуры должны располагаться только в модулях форм журнала операций (см. «Виды программных модулей»).

Предопределенные процедуры модуля формы журнала проводок

Описанные в данном разделе системные предопределенные процедуры должны располагаться только в модулях форм журнала проводок (см. «Виды программных модулей»).

Предопределенные процедуры Модуля формы журнала расчетов

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

Данные процедуры предназначены для расширения возможности программного управления правами пользователей на выполнение тех или иных действий.

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

Возвращает представление объекта.

Синтаксис:

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

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

Present

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

Строковое значение представления объекта.

Описание:

Метод Представление возвращает синоним объекта, а если он не задан, то идентификатор.

Пример:

Получение списка видов документов:

Спис = СоздатьОбъект("СписокЗначений");

Для Инд = 1 По Метаданные.Документ() Цикл

Идент = Метаданные.Документ(Инд).Идентификатор;

Предст = Метаданные.Документ(Инд).Представление();

Спис.ДобавитьЗначение(Идент, Предст);

КонецЦикла;

ПредставлениеКорСубконто

Представление корреспондирующего субконто, соответствующего текущему итогу.

Синтаксис:

ПредставлениеКорСубконто(<Номер>|<ВидСубконто>, <Краткое>)

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

CorSubcontoPresentation

Параметры:

<Номер>

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

<ВидСубконто>

Значение типа «Вид субконто».

<Краткое>

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

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

Строковое представление для корреспондирующего субконто, соответствующего текущему итогу.

Описание:

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

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

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

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

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

Пример:

БухИтоги.ИспользоватьСубконто(ВидыСубконто.Товары, , 1);

БухИтоги.ИспользоватьКорСубконто(ВидыСубконто.Клиенты, , 1);

БухИтоги.ВыполнитьЗапрос(ДатаНач, ДатаКон);

БухИтоги.ВыбратьСубконто();

Пока БухИтоги.ПолучитьСубконто() = 1 цикл

БухИтоги.ВыбратьКорСубконто();

Пока БухИтоги.ПолучитьКорСубконто() = 1 цикл

Сообщить(БухИтоги.ПредставлениеСубконто() + "-" +

БухИтоги.ПредставлениеКорСубконто());

КонецЦикла;

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

Получить представление для текущей проводки.

Синтаксис:

ПредставлениеПроводки(<ПоСубконто>)

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

Entry Presentation

Параметры:

<ПоСубконто> Необязательный параметр. Флаг включения в представление проводки представления субконто проводки. Число:

0 — не включать представление субконто;

1 — включать представление субконто;

2 — включать развернутое представление субконто. Значение по умолчанию: 0.

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

Строка — представление для текущей проводки.

Описание:

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

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

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

Пример:

Опер = СоздатьОбъект("Операция");

Опер.НайтиОперацию(ВыбрДокумент);

Опер.ВыбратьПроводки();

Пока Опер.ПолучитьПроводку() = 1 Цикл

Сообщить("Проводка " + Опер.ПредставлениеПроводки(1));

КонецЦикла;

ПредставлениеСубконто

Представление субконто дебета/кредита проводки (корреспонденции) операции.

Синтаксис:

ПредставлениеСубконто(<ПорядковыйНомерСубконто> | <ВидСубконто>, <Режим>)

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

SubcontoPresentation

Параметры:

<ПорядковыйНомерСубконто>

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

<ВидСу6конто>

Идентификатор вида субконто.

<Режим>

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

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

Символьная строка — представление субконто.

Описание:

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

Представление может быть настроено в конфигурации для видов субконто типа «Справочник» или «Документ». Формат представления определяется в конфигураторе при редактировании свойств вида субконто.

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

Пример:

Опер = СоздатьОбъект("Операция");

Опер.НайтиОперацию(ВыбрДокумент);

Опер.ВыбратьПроводки();

Пока Опер.ПолучитьПроводку() = 1 Цикл

Для Инд = 1 По Опер.Дебет.Счет.КоличествоСубконто() Цикл

Сообщить("Субконто " + Опер.Дебет.ПредставлениеСубконто(Инд));

КонецЦикла;

ПредставлениеСубконто

Получить представление для субконто текущей проводки.

Синтаксис:

ПредставлениеСубконто()

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

SubcontoPresentation

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

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

Описание:

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

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

Пример:

Опер = СоздатьОбъект("Операция");

Опер.НайтиОперацию(ВыбрДокумент);

Опер.ВыбратьПроводки();

Пока Опер.ПолучитьПроводку() = 1 Цикл

Сообщить("Субконто " + Опер.ПредставлениеСубконто());

КонецЦикла;

ПредставлениеСубконто

Представление субконто, соответствующего текущему итогу.

Синтаксис:

ПредставлениеСубконто(<Номер>|<ВидСубконто>, <Краткое>]

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

SubcontoPresentation

Параметры:

<Номер>

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

<ВидСубконто>

Значение типа «Вид субконто».

<Краткое>

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

Строковое представление для субконто, соответствующего текущему итогу.

Описание:

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

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

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

Пример:

БухИтоги.ИспользоватьСубконто(ВидыСубконто.Товары, , 1);

БухИтоги.ВыполнитьЗапрос(ДатаНач, ДатаКон);

БухИтоги.ВыбратьСубконто();

Пока БухИтоги.ПолучитьСубконто() = 1 цикл

Сообщить(БухИтоги.ПредставлениеСубконто());

КонецЦикла;

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

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

Синтаксис:

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

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

KindPresent

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

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

Описание:

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

Пример:

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

Спр1 = СоздатьОбъект("Справочник.Товары");

Состояние(Cnpl.ПредставлениеВида());

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

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

Синтаксис:

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

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

KindPresent

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

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

Описание:

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

Пример:

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

Состояние(ИзмерениеТовара.ПредставлениеВида());

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

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

Синтаксис:

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

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

KindPresent

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

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

Описание:

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

Пример:

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

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

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

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

Синтаксис:

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

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

KindPresent

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

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

Описание:

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

Пример:

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

(Рег1.ПредставлениеВида());

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

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

Синтаксис:

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

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

KindPresent

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

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

Описание:

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

Пример:

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

Сч = СоздатьОбъект("Счет.Основной");

Состояние(Сч.ПредставлениеВида());

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

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

Синтаксис:

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

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

KindPresent

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

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

Описание:

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

Пример:

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

Состояние(ЖР.ПредставлениеВида());

в течение которого система будет

Вывести окно предупреждения.
Синтаксис:
Предупреждение(<Текст_сообщения>, <Таймаут>)
Англоязычный синоним:
DoMessageBox
Параметры:

<Текст_сообщения>

Строковое выражение.

<Таймаут>

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

Описание:
Процедура Предупреждение выводит на экран окно предупреждения (MessageBox). Текст определяется параметром <Текст_сообщения>. По поведению данная процедура эквивалентна функции:
Вопрос(<Текст_сообщения>, 0, <Таймаут>), но не возвращает значения.
Если закончилось время ожидания ответа, то окно предупреждения автоматически удаляется с экрана.
Пример:
// Выводим сообщение 5 секунд
Предупреждение("Доброе утро!", 5);

Предварительное описание процедур и функций

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

Пример:

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

Процедура А(Парам1, Парам2) Далее

Процедура Б()

Перем АА, ББ;

...

А(АА, ББ);

...

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

Процедура А(Парам1, Парам2)

...

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

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

Процедура А(Парам1, Парам2) Далее

На то, что это предварительное описание указывает наличие ключевого слова Далее (англоязычный синоним — Forward), которое замещает в случае предварительного описания тело процедуры и ключевое слово КонецПроцедуры. Предварительное описание процедуры/функции может содержаться в любом месте текста модуля, где допускается фактическое определение процедуры или функции, а сам заголовок процедуры/функции должен в точности соответствовать заголовку в фактическом определении, включая наличие, если необходимо, ключевого слова Экспорт и имен формальных параметров.

Перейти на предыдущую запись.

Синтаксис:

Предыдущая()

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

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

Число: 1 — получена предыдущая запись; 0 — предыдущая запись не найдена.

Описание:

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

Пример:

См. пример метода Последняя

ПрефиксАвтоНумерации

Установить префикс для автоматического создания новых номеров.

Синтаксис:

ПрефиксАвтоНумерации(<ИмяВида>, <Префикс>)

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

AutoNumPrefix

Параметры:

<ИмяВида>

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

<Префикс>

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

Описание:

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

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

ПрефиксАвтоНумерации("Документ.*", "ПР-")

Пример:

ПрефиксАвтоНумерации("Документ.РасходнаяНакл", "Рн-");

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

ПрефиксКода

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

Синтаксис:

ПрефиксКода(<Префикс>)

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

CodePrefix

Параметры:

<Префикс>

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

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

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

Описание:

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

Пример:

ПрефиксКода("01-");

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

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

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

Синтаксис:

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

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

NumPrefix

Параметры:

<Префикс>

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

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

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

Описание:

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

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

Пример:

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

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

Прервать

Прерывает выполнение цикла.

Синтаксис:

Прервать

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

Break

Описание:

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

Пример:

// Выведем строки текста с 1 по 10

Выв = СоздатьОбъект("Текст");

Выв.Открыть("ТТТ");

Для i = l По Выв.КоличествоСтрок() Цикл

Сообщить(Выв.ПолучитьСтроку(i));

Если i=10 Тогда

Прервать;

КонецЕсли;

КонецЦикла;

ПрибавитьПериод

Возвращает очередной период журнала на базе текущего периода.

Синтаксис:

ПрибавитьПериод(<Количество>)

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

AddPeriod

Параметры:

<Количество>

Число периодов, на которое отстоит текущий период от искомого. По умолчанию — 1 (т. е. метод возвращает следующий период).

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

Период журнала, отстоящий от заданного на определяемое параметром <Количество> число периодов.

Описание:

Метод предназначен для получения периода отстоящего от текущего на заданное число периодов. Если <Количество> положительное число, возвращаемое значение — будущий период, в противном случае — прошлый период.

Пример:

ЖР = СоздатьОбъект{"ЖурналРасчетов.Зарплата");

ЖР.ВыбратьПериод(РабочаяДата());

//на три расчетных периода (месяца) назад

Пер = ЖР.ПериодДействия.ПрибавитьПериод(-3);

// теперь отбираем записи по нужному нам периоду

ЖР.ВыбратьПериод(Пер.ДатаНачала);

Всего = 0;

Пока ПолучитьЗапись() = 1 Цикл

Если ЖР.ВидРасч = ВидРасчета.Доплата Тогда

Всего = Всего + ЖР.Результат;

КонецЕсли;

КонецЦикла;

Приход

Флаг движения регистра «приход».

Синтаксис:

Приход

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

Income

Описание:

Атрибут Приход содержит значение флага записи движения регистра и используется только при обращении к существующим записям движений регистров. Данный атрибут только для чтения. Атрибут Приход может принимать числовое значение 1 — если текущее движение регистра приход, 0 — если нет.

Данный атрибут не имеет смысла для оборотных регистров.

Пример:

Рег1 = СоздатьОбъект("Регистр.Взаиморасчеты");

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

Рег1.УстановитьФильтр(Клиент);

Рег1.ВыбратьДвижения(ДатаНачало, );

Пока Рег1.ПолучитьДвижение()>0 Цикл

Если Число(Рег1.Клиент.Код) <> Число(Запрос.Клиент.Код) Тогда

Продолжить;

КонецЕсли;

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

Дв_Баз_Сум = Рег1.СуммаБазовая;

Дв_Вал_Сум = Рег1.СуммаВалютная;

Если Рег1.Приход = 1 Тогда

Таб.ВывестиСекцию("Приход");

Иначе

Таб.ВывестиСекцию("Расход");

КонецЕсли;

КонецЦикла;

КонецЕсли;

ПриИсправленииРезультата

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

Синтаксис:

ПриИсправленииРезультата(<3апись>}

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

OnResuitUpdate

Параметры:

<3апись>

Ссылка на запись журнала расчетов, результат расчета которой исправляется.

Описание:

Вызов предопределенной процедуры ПриИсправленииРезультата производится системой 1С:Предприятие неявно при попытке «ручного» исправления результата расчета записи журнала расчетов. Если в данной предопределенной процедуре установить статус возврата — 0, то результат не будет отредактирован.

Данная предопределенная процедура может располагаться только в модуле формы журнала расчетов.

Пример:

Процедура ПриИсправленииРезультата(Запись)

// группа нередактируемых расчетов

НГ = ГруппаРасчетов.Нередактируемые;

Если Запись.ВидРасч.ВходитВГруппу(НГ) = 1 Тогда

Предупреждение("Операция не выполняется");

СтатусВозврата(0);

КонецЕсли;

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

См. также: СтатусВозврата, ПриОтменеИсправления

ПриИзмененииПорядкаСтрок

Предопределенная процедура при изменении порядка строк многострочной части документа.

Синтаксис:

ПриИзмененииПорядкаСтрок(<Действие>)

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

OnChangeLinesOrder

Параметры:

<Действие>

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

Описание:

Вызов предопределенной процедуры ПриИзмененииПорядкаСтрок произ-^дится в системе 1С:Предприятие при интерактивном изменении порядка строк многострочной части документа (перемещения строк вверх-вниз, перенумерация, сортировка). Если в данной предопределенной процедуре установить статус возврата — 0 (например, если данному пользователю нельзя изменять документ), изменении порядка строк документа не будет выполнено.

Данная предопределенная процедура может располагаться только в Модулях формы документов (см. «Виды программных модулей»).

Пример:

Процедура ПриИзмененииПорядкаСтрок()

Если НазваниеНабораПрав() = "Продавец" Тогда

Предупреждение("У вас нет права изменять документ!", 2);

СтатусВозврата(0);

КонецЕсли;

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

См. также: СтатусВозврата

ПриИзмененииПорядкаСтрок

Предопределенная процедура при изменении порядка строк операции.

Синтаксис:

ПриМзмененииПорядкаСтрок(<Действие>)

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

OnChangeLinesOrder

Параметры:

<Действие>

Число: 1 — перемещение строки вниз; -1 (минус единица) — перемещение строки вверх.

Описание:

Вызов предопределенной процедуры ПриИзмененииПорядкаСтрок производится системой 1С:Предприятие неявно при интерактивной попытке перемещения строк вверх-вниз и перенумерации (до выполнения действия).

Если в данной предопределенной процедуре установлен статус возврата 0 (например, если данному пользователю нельзя устанавливать данное значение отбора проводок), установка отбора не будет выполнена.

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

Пример:

Процедура ПриИзмененииПорядкаСтрок(Направление)

СтатусВозврата(0);

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

См. также: СтатусВозврата

ПриИзмененииВремениДокумента

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

Синтаксис:

ПриИзмененииВремениДокумента(<Докум>)

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

OnChangeTimeDoc

Параметры:

<Докум>

Значение обрабатываемого документа.

Описание:

Вызов предопределенной процедуры ПриИзмененииВремениДокумента производится самой системой 1С:Предприятие неявно при интерактивной попытке изменить время документа. Если в данной предопределенной процедуре установить статус возврата — 0 (например, если время данного документа нельзя менять), изменение времени документа не будет выполнено.

Данная предопределенная процедура может располагаться только в глобальном программном модуле.

Пример:

Процедура ПриИзмененииВремениДокумента(Док)

Если НазваниеНабораПрав() = "Продавец" Тогда

Предупреждение("У вас нет права менять время документа!", 2);

СтатусВозврата(0);

КонецЕсли;

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

См. также: СтатусВозврата

Применять

Устанавливает необходимость применять или не применять все правила перерасчетов при вводе новых записей в журнал расчетов.

Синтаксис:

Применять(<ФлагПрименения>)

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

Use

Параметры:

<ФлагПрименения>

Число: 1 — применять; 0 — не применять.

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

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

Описание:

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

Пример:

ПравилоПерерасчета.Применять(1);

Пример исходного текста программного модуля

Перем ФлагПроводки; // Флаг проведения Документа

Перем ФлагИзменения; // Флаг изменения Документа

//————————————————————————————————————————————————

Функция КонтрольОстатка()

// Функция возвращает текущее значение остатка товара на складе

Ост = Регистр.ОстаткиТоваров.Остаток(Склад, Товар, "ОстатокТовара");

Возврат Ост;

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

//————————————————————————————————————————————————

Процедура УстФлагИзм()

ФлагИзменения = 1;

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

//————————————————————————————————————————————————

Процедура ВводНового()

// предопределенная процедура, вызываемая при вводе нового документа

// установим дату Документа

ДатаДок = РабочаяДата();

// установим реквизиты Документа (по умолчанию)

ТипНакладной = Перечисление.ТипыНакладных.Перемещение;

Фирма = Константа.ДефФирма;

Склад = Константа.ДефСклад;

СкладПолучатель = Константа.ДефСклад;

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

//————————————————————————————————————————————————

Процедура ВыходноеСообщение()

// процедура, которую мы будем вызывать при нажатии кнопки "ОК"

Если (ФлагПроводки = 1) И (ФлагИзменения = 1) Тогда

Предупреждение("Проведенный Документ был изменен! При

| сохранении обязательно проведите Документ снова!");

КонецЕсли;

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

//————————————————————————————————————————————————

// При входе в Форму запомним промежуточные переменные

ФлагПроводки = Проведен();

ФлагИзменения = 0;

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

Предположим, что проектируется отчет о продаже товара. Внешний вид отчета визуально настроен. Мы предполагаем, что будет построена объемная гистограмма с одной точкой («Продано на сумму») и количеством серий равным количеству товаров.

Фрагментом модуля отчета, является процедура ПостроитьДиаграмму. Вызов этой процедуры находится в закладке «Текст» свойств внедренного в табличный документ, объекта «Диаграмма», он выглядит так:

ПостроитьДиаграмму(Таб.ТекущийОбъект, Запрос)

Параметрами процедуры являются:

Объект «Диаграмма», переданный как текущий объект табличного документа (подробнее см. в главе Работа с таблицами);

запрос к базе данных, сформированный и выполненный ранее.

Пример:

Процедура ПостроитьДиаграмму(Диаграмма, Запрос)

//На время наполнения данными, запретим перерисовку

Диаграмма.Обновление(0);

// задаем текст заголовка

Диаграмма.Заголовок = "Пример использования диаграммы";

// задаем текст метки точки

Диаграмма.УстановитьИмяТочки(1, "Продано на сумму");

СчетчикСерий = 1;

Пока Запрос.Группировка("Товар") = 1 Цикл

ПродСумма = Запрос.СуммаПродано;

// задаем очередное значение

Диаграмма.Значение(1, СчетчикСерий, ПродСумма);

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

Диаграмма.УстановитьИмяСерии(СчетчикСерий, Запрос.Товар.Наименование)

СчетчикСерий = СчетчикСерий + 1;

КонецЦикла;

// После заполнения данных, включим перерисовку

Диаграмма.Обновление(1);

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

Пример использования объекта Таблица Значений

Пример:

Функция ВыбратьОплаты(ВыбДок)

ТЗ = СоздатьОбъект("ТаблицаЗначений");

ТЗ.НоваяКолонка("ДатаДок", "Дата", , , "Дата", 15);

ТЗ.НоваяКолонка("Номер", "Строка", 20, , "Номер", 15);

ТЗ.НоваяКолонка("Сумма", "Число", 18, 2, "Сумма", 20);

ТЗ.НоваяКолонка("РасчетныйСчет", "Справочник.БанковскиеСчета", , ,

"Расч.счет", 30);

ТЗ.НоваяКолонка("ПодчДок", "Документ", , , );

ТЗ.ВидимостьКолонки("ПодчДок", 0);

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

Док.ВыбратьПодчиненныеДокументы(, , ВыбДок);

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

Если Док.Вид() = "ОплатаПоставщикам" Тогда

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

ТЗ.ДатаДок = Док.ДатаДок;

ТЗ.Номер = Док.НомерДок;

ТЗ.Сумма = Док.Итог("Сумма");

ТЗ.РасчетныйСчет = Док.РасчетныйСчет;

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

КонецЕсли;

КонецЦикла;

ВыбСтрока = 0;

Если ТЗ.ВыбратьСтроку(ВыбСтрока, "Выберите оплату") = 1 Тогда

Возврат ТЗ.ПолучитьЗначение(ВыбСтрока, "ПодчДок");

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

ПриНачалеРаботыСистемы

Предопределенная процедура при начале работы задачи.

Синтаксис:

ПриНачалеРаботыСистемы()

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

OnStartSystem

Описание:

Вызов предопределенной процедуры ПриНачалеРаботыСистемы производится системой 1С:Предприятие неявно при начале работы с программой. Если в данной предопределенной процедуре установить статус возврата — 0 (например, если время доступа данного пользователя к системе истекло), то пользователь не сможет войти в программу.

Данная предопределенная процедура может располагаться только в глобальном программном модуле.

Пример:

Процедура ПриНачалеРаботыСистемы()

Курс = Константа.ОсновнаяВалюта.Текущ_Курс.Получить(ТекущаяДата();

Предупреждение("Добро пожаловать! Сегодня " + " " + ТекущаяДата() +

РазделительСтрок + "Сейчас установлен курс доллара=" + Курс), 7);

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

См. также: СтатусВозврата

ПриНачалеРедактированияСтроки

Предопределенная процедура при начале редактирования существующей строки списка справочника.

Синтаксис:

ПриНачалеРедактированияСтроки()

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

OnStartEditLine

Описание:

Вызов предопределенной процедуры ПриНачалеРедактированияСтроки производится в системе 1С:Пред приятие в момент начала интерактивного редактирования существующей строки списка справочника (кроме новой). Если в данной предопределенной процедуре установить статус возврата — 0 (например, если данному пользователю нельзя изменять значения реквизитов справочника), запись не будет изменена.

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

Пример:

Процедура ПриНачалеРедактированияСтроки()

Если НазваниеНабораПрав() = "Продавец" Тогда

Предупреждение("У вас нет права менять реквизиты!", 2);

СтатусВозврата(0);

КонецЕсли;

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

См. также: СтатусВозврата

ПриНачалеРедактированияСтроки

Предопределенная процедура при редактировании существующей строки документа.

Синтаксис:

ПриНачалеРедактированияСтроки()

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

OnStartEditLine

Описание:

Вызов предопределенной процедуры ПриНачалеРедактированияСтроки производится в системе 1С:Предприятие в момент начала интерактивного редактирования существующей строки многострочной части документа. Если в данной предопределенной процедуре установить статус возврата — 0 (например, если данному пользователю нельзя изменять документ), то запись не будет изменена.

Данная предопределенная процедура может располагаться в Модулях формы документов (см. «Виды программных модулей»).

Пример:

Процедура ПриНачалеРедактированияСтроки()

Если НазваниеНабораПрав() = "Продавец" Тогда

Предупреждение("У вас нет права изменит, документ 1", 2);

СтатусВозврата(0);

КонецЕсли;

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

См. также: СтатусВозврата

ПриНачалеРедактированияСтроки

Предопределенная процедура при начале редактирования существующей строки списка счетов.

Синтаксис:

ПриНачалеРедактированияСтроки()

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

OnStartEditLine

Описание:

Вызов предопределенной процедуры ПриНачалеРедактированияСтроки производится в системе 1С:Предприятие в момент начала интерактивного редактирования существующей строки списка счетов (кроме новой). Если в данной предопределенной процедуре установить статус возврата 0 (например, если данному пользователю нельзя изменять характеристики бухгалтерских счетов), строка не будет изменена.

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

Пример:

Процедура ПриНачалеРедактированияСтроки()

Если НазваниеНабораПрав() = "Оператор" Тогда

Предупреждение("У вас нет права менять счета!", 2);

СтатусВозврата(0);

КонецЕсли;

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

См. также: СтатусВозврата

ПриНачалеРедактированияСтроки

Предопределенная процедура вызывается при редактировании существующей проводки или корреспонденции операции.

Синтаксис:

ПриНачалеРедактированияСтроки()

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

OnStartEditLine

Описание:

Вызов предопределенной процедуры ПриНачалеРедактированияСтроки производится в системе 1С:Предприятие в момент начала интерактивного редактирования существующей проводки или корреспонденции операции.

Если в данной предопределенной процедуре установить статус возврата 0 (например, если данному пользователю нельзя редактировать проводки операции), то проводка не будет изменена.

Данная предопределенная процедура может располагаться в модуле формы операции (см. «Виды программных модулей»).

Пример:

Процедура ПриНачалеРедактированияСтроки()

Если НазваниеНабораПрав() = "Оператор" Тогда

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

СтатусВозврата(0);

КонецЕсли;

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

См. также: СтатусВозврата

ПриНачалеВыбораЗначения

Предопределенная процедура при начале выбора значения.

Синтаксис:

ПриНачалеВыбораЗначения(<ИдентЭлемДиалога>, <ФлагСтанд06р>)

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

OnStartValueChoice

Параметры:

<ИдентЭлемДиалога>

Строковое значение — идентификатор элемента диалога формы.

<ФлагСтандОбр>

Изначально, при вызове процедуры равен 1, если в теле процедуры значение этого параметра поменять на 0, то стандартный процесс выбора значения не будет происходить.

Описание:

Вызов предопределенной процедуры ПриНачалеВыбораЗначения производится в системе 1С:Предприятие неявно в момент, когда в форме пользователь интерактивно инициировал выбор значения (выбор может быть интерактивно инициирован в немодальном режиме при помощи элемента диалога с кнопкой выбора или клавишей «F4»). При вызове процедуры, система подставляет фактические значения параметров, характеризующие элемент диалога и флаг стандартной обработки.

Замечание. В теле этой процедуры методы ОткрытьФорму и ОткрытьПодбор работают для выбора.

Данная предопределенная процедура может располагаться только в программном модуле формы.

Пример:

Процедура ПриНачалеВыбораЗначения(Элемент, Флаг)

Перем КонтПодб;

Если Элемент = "ИдВыбКлиент" Тогда

Флаг = 0;

ОткрытьПодбор("Справочник.Клиенты", "ДляПодбора", КонтПодб);

КонецЕсли;

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

Принадлежит

Проверяет вхождение в список значений указанного значения.

Синтаксис:

Принадлежит(<Значение>)

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

Belong

Параметры:

<Значение>

Значение, проверяемое на вхождение в список значений.

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

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

Описание:

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

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

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

Пример:

Процедура ПроверитьКлиентов(СписокГруппКлиентов)

// в качестве параметра Процедуры передается СписокЗначений

// в котором записаны как элементы справочника Клиенты, так и

// группы этого справочника

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

Док.ВыбратьДокументы();

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

Если СписокГруппКлиентов.Принадлежит(Док.Клиент) = 1 Тогда

Сообщить(Док.Клиент.Наименование + " " + Док);

КонецЕсли;

КонецЦикла;

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

ПринадлежитГруппе

Проверить принадлежность к группе.

Синтаксис:

ПринадлежитГруппе(<Группа>)

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

BelongsToGroup

Параметры:

<Группа>

Выражение со значением группы справочника.

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

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

Описание:

Метод ПринадлежитГруппе проверяет, принадлежит ли указанной группе текущий элемент справочника (не важно, на каком нижестоящем уровне он находится). Возвращаемое числовое значение: 1 — если да; 0 — если нет.

Пример:

// выведем в отчет только те подразделения, которые

// принадлежат группе ВыбГруппа

Процедура ВывестиНаПечать()

// . . .

Возврат;

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

...

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

// Задаем выборку в порядке кодов Спр.ПорядокКодов();

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

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

Если Спр.ПринадлежитГруппе(ВыбГруппа) = -1 Тогда

ВывестиНаПечать();

КонецЕсли;

КонецЦикла;

См. также: ЭтоГруппа