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

Глава 7-3
Системные процедуры и функции


 

Специальные процедуры и функции

СоздатьОбъект

Создает объект агрегатного типа данных и возвращает ссылку на него.

Синтаксис:

СоздатъО6ъект(<ИмяАгрегатногоТипа>)

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

CreateObject

Параметры:

<ИмяАгрегатногоТипа>

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

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

Ссылка на созданный объект агрегатного типа данных.

Описание:

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

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

Пример:

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

Спр.НайтиПоКоду("029");

СтатусВозврата

Установить/определить статуса возврата предопределенной процедуры.

Синтаксис:

СтатусВозврата([<Статус>])

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

ReturnStatus

Параметры:

<Статус>

Необязательный параметр. Числовое выражение. Если задано значение 1, то устанавливается статус возврата — Выполнить Действие. Если задано значение 0, то устанавливается статус возврата — Отменить Действие. Если параметр опущен, то статус возврата предопределенной процедуры не меняется.

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

Число 1 — если статус возврата — Выполнить Действие;

Число 0 — если статус возврата — Отменить Действие.

Описание:

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

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

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

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

Если параметр <Статус> задан явно, то после выполнения данной функции статус возврата установится в заданное значение. Пример:

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

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

   Если Клиент.Выбран() = 0 Тогда

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

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

   КонецЕсли;

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

* Если в предопределенной процедуре ВводНаОсновании установить статус возврата — 0, то ввод нового документа будет отменен и форма нового документа не откроется.

Процедура ВводНаОсновании(ДокОснование)

   Автор = Пользователь;

   ДокВид = ДокОснование.Вид();

   Если (ДокВид = "Счет") ИЛИ (ДокВид = "Счет_фактура")

        ИЛИ (ДокВид = "РасходнаяКредит") ИЛИ (ДокВид = РасходнаяРеализ") Тогда

      Автор = Пользователь;

      ДокВид = ДокОснование.Вид();

      Фирма = ДокОснование.Фирма;

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

      Основание = ДокВид + " № " + ДокОснование.НомерДок;

      Сумма = ДокОснование.Итог("Сумма");

      НДС = ДокОснование.Итог("НДС");

   Иначе

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

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

   КонецЕсли;

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

См. также: «Системные предопределенные процедуры»

ОткрытьФорму

Выполняет открытие формы из'встроенного языка.

Синтаксис:

ОткрытьФорму (<Параметр1>, <КонтекстФормы>, < Параметр 3>...)

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

OpenForm

Параметры:

<Параметр1>

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

Для журналов, отчетов, списков в конце строки описателя формы может быть указан символ "#" с некоторым идентификатором: "#LLLL". Это используется для того, чтобы данная форма открылась в новом окне, а не активизировала существующее окно этой формы, если оно открыто. Где, LLLL — идентификатор, который позволяет открыть новое окно или активизировать уже открытое с этим идентификатором. Если идентификатор не задан, то обязательно открывается новое окно.

<КонтекстФормы>

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

После исполнения данного метода система вернет в данную переменную контекст открытой формы (см. Передача контекста в качестве параметра). С помощью значения этого контекста можно затем произвольно манипулировать открытой формой, пока она открыта. Пока форма открыта, тип значения данного параметра равен 100 (см. ТипЗначения), если закрыта — 0.

<Параметр3>...

В зависимости от типа открываемой формы используется различный состав и значения остальных параметров.

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

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

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

Описание:

Функция ОткрытьФорму позволяет открыть форму документа, справочника, журнала документов, и других форм используемых в системе 1С:Предприятие.

Замечание. Для журналов, отчетов, списков в конце строки описателя формы может быть указан символ "#" с некоторым идентификатором: "#LLLL". Это используется для того, чтобы данная форма открылась в новом окне, а не активизировала существующее окно этой формы, если оно открыто. Где, LLLL — идентификатор, который позволяет открыть новое окно или активизировать уже открытое с этим идентификатором. Если идентификатор не задан, то обязательно открывается новое окно.

Замечание. Метод ОткрытьФорму нельзя вызывать в «теле» глобального модуля (части глобального модуля, расположенной после последней процедуры). Для его вызова при старте программы следует размещать его в процедуре ПриНачалеРаботыСистемы.

Для открытия разных форм следует использовать разный синтаксис вызова данной функции:

Открытие формы существующего документа.

ОткрытьФорму(<Документ>, <КонтекстФормы>, <РежимПросмотра>)

<Документ>

Значение типа «Документ».

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

Необязательный параметр. Числовое выражение: 1 — открыть форму в режиме только просмотра; 0 — открыть форму в режиме редактирования. -1 (минус единица) в этом случае используется вариант предусмотренный текущим значением параметра «Режим открытия объектов» установленного пользователем. По умолчанию — 0.

Открытие формы нового документа

ОткрытьФорму(<ОписательОбъекта>, <КонтекстФормы>, <ДокументОснование>)

<ОписательОбъекта>

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

"Документ.ХХХХХ", где ХХХХХ — идентификатор вида документа;

<ДокументОснование>

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

Открытие формы журнала документов.

ОткрытьФорму(<ОписательОбъекта>, <КонтекстФормы>)

<ОписательОбъекта>

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

"Журнал . ХХХХХ. YYYYY", где ХХХХХ — идентификатор журнала документов; YYYYY — идентификатор формы журнала документов;

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

ОткрытьФорму("Журнал.РасходнаяНакладная")

Открытие формы журнала подчиненных документов.

ОткрытьФорму(<ОписательОбъекта>, <КонтекстФормы>, <Документ>)

<ОписательОбъекта>

Строковое выражение. "Журнал.Подчиненные";

<Документ>

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

Открытие формы существующего элемента справочника.

ОткрытьФорму(<Элемент>, <КонтекстФормы>, <РежимПросмотра>)

<Элемент>

Значение типа «Справочник».

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

Необязательный параметр. Числовое выражение: 1 — открыть форму в режиме только просмотра; 0 — открыть форму в режиме редактирования. -1 (минус единица) в этом случае используется вариант предусмотренный текущим значением параметра «Режим открытия объектов» установленного пользователем. По умолчанию — 0.

Открытие формы нового элемента справочника.

ОткрытьФорму(<ОписательОбъекта>, <КонтекстФормы> , <ГруппаРодитель>,

<ФлагГруппы>, <ЭлементВладелец>)

<ОписательОбъекта>

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

"Элемент. ХХХХХ", где ХХХХХ — вид справочника;

<ГруппаРодитель>

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

<ФлагГруппы>

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

<ЭлементВладелец>

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

Открытие формы списка справочника.

ОткрытьФорму(<ОписательОбъекта>, <КонтекстФормы>)

<ОписательОбъекта>

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

"Справочник.ХХХХХ.YYYYY", где ХХХХХ — вид справочника, YYYYY — имя выбранной формы списка справочника;

Открытие формы отчета.

ОткрытьФорму(<ОписательОбъекта>, <КонтекстФормы>)

<ОписательОбъекта>

Строковое выражение. "Отчет. ХХХХХ" , где ХХХХХ — вид отчета;

Открытие формы обработки.

ОткрытьФорму(<ОписательОбъекта>, <КонтекстФормы>)

<ОписательОбъекта>

Строковое выражение. "Обработка.ХХХХХ", где ХХХХХ — вид обработки;

Открытие формы внешнего отчета.

ОткрытьФорму(<ОписательОбъекта>, <КонтекстФормы>, <ИмяФайла>)

<ОписательОбъекта>

Строковое выражение. "Отчет";

<ИмяФайла>

Строковое выражение — полное имя файла внешнего отчета.

Открытие формы журнала расчетов.

ОткрытьФорму(<ОписательОбъекта>, <КонтекстФормы>)

<ОписательОбъекта>

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

"ЖурналРасчетов. ХХХХХ", где ХХХХХ — вид журнала расчетов;

Открытие формы существующего счета.

ОткрытьФорму(<Счет>, <КонтекстФормы>, <РежимПросмотра>)

<Счет>

Значение типа «Счет».

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

Необязательный параметр. Числовое выражение: 1 — открыть форму в режиме только просмотра; 0 — открыть форму в режиме редактирования. -1 (минус единица) в этом случае используется вариант предусмотренный текущим значением параметра «Режим открытия объектов» установленного пользователем. По умолчанию — 0.

Открытие формы нового счета.

ОткрытьФорму(<ОписательОбъекта>, <КонтекстФормы>)

<ОписательОбъекта>

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

"Счет. ХХХХХ" , где ХХХХХ — идентификатор плана счетов;

Открытие формы списка счетов (плана счетов).

ОткрытьФорму(<ОписательОбъекта>, <КонтекстФормы>)

<ОписательОбъекта>

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

"ПланСчетов.ХХХХ.YYYY", где ХХХХХ — идентификатор плана счетов; YYYYY — идентификатор формы плана счетов.

Открытие формы существующей операции.

ОткрытьФорму(<ОписательОбъекта>, <КонтекстФормы>, <Документ>, <Проводка>,

<Корреспонденция>, <РежимПросмотра>)

<ОписательОбъекта>

Строковое выражение. "Операция".

<Документ>

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

<Проводка>

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

<Корреспонденция>

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

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

Необязательный параметр. Числовое выражение: 1 — открыть форму в режиме только просмотра; 0 — открыть форму в режиме редактирования. -1 (минус единица) в этом случае используется вариант предусмотренный текущим значением параметра «Режим открытия объектов» установленного пользователем. По умолчанию — 0.

Открытие формы ввода новой операции.

ОткрытьФорму(<ОписательОбъекта>, <КонтекстФормы>, <ТиповаяОперация>)

<ОписательОбъекта>

Строковое выражение. "Операция".

<ТиповаяОперация>

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

Открытие формы журнала операций.

ОткрытьФорму(<ОписательОбъекта>, <КонтекстФормы>, <Документ>, <Пров>, <Корр>)

<ОписательОбъекта>

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

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

<Документ>

Значение типа «документ», операция которого будет использована для первоначального позиционирования.

<Пров>

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

<Корр>

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

Открытие формы журнала проводок.

ОткрытьФорму(<ОписательОбъекта>, <КонтекстФормы>, <Документ>, <Проводка>,

<Корреспонденция>)

<ОписательОбъекта>

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

"ЖурналПроводок.YYYYY", где YYYYY — идентификатор формы журнала проводок;

<Документ>

Значение типа «документ», операция которого будет использована для первоначального позиционирования.

<Проводка>

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

<Корреспонденция>

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

Открытие окна истории значений периодических констант, реквизитов справочников и счетов.

ОткрытьФорму("История.Константа.<ИдентКонстанты>", , , <УстНаДату>)

ОткрытьФорму("История.Справочник.<ИдентСправочника>, <ИдентРеквизита>", ,

<ЭлементСправочника>, <УстНаДату>)

ОткрытьФорму("История.Счет", , <Счет>, <УстНаДату>)

<ИдентКонстанты>

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

<ИдентСправочника>

Идентификатор справочника, как он задан в конфигураторе.

<ИдентРеквизита>

Идентификатор периодического реквизита справочника, как он задан в конфигураторе.

<ЭлементСправочника>

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

<Счет>

Счет, для которого открывается окно истории значений.

<УстНаДату>

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

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

Примеры:

Перем Конт;

ОткрытьФорму("История.Справочник.Сотр.Тариф#Ид01", , ТекущийЭлемент());

ОткрытьФорму(Докум, Конт);

ОткрытьФорму("Документ.РасхНакл");

ОткрытьФорму("Журнал.Продажи.КраткаяФорма");

ОткрытьФорму("Отчет", , "С:\lcv7db\extforms\profit.ert");

ОткрытьФормуМодально

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

Синтаксис:

ОткрытьФормуМодально(<Параметр1>, <КонтекстФормы>, <ПараметрЗ>...)

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

OpenFormModal

Параметры: см. параметры метода ОткрытьФорму

Возвращаемое значение: см. метод ОткрытьФорму.

Описание:

Функция ОткрытьФормуМодально позволяет открыть модальную форму документа, справочника, журнала документов, и других форм используемых в системе 1С:Предприятие. Синтаксис и описание см. метод ОткрытьФорму.

См. также: ОткрытьФорму

ТипЗначения

Получить тип значения данных.

Синтаксис:

ТипЗначения(<3начение>)

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

ValueType

Параметры:

<3начение>           Выражение, тип данных значения которого надо определить.

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

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

0 —                 неопределенный тип данных;

1 —                 числовой тип данных;

2 —                 строковый тип данных;

3 —                 тип данных — дата;

10 —   агрегатный тип данных «Перечисление»;

11 —   агрегатный тип данных «Справочник»;

12 —   агрегатный тип данных «Документ»;

13 —   агрегатный тип данных «Календарь»;

14 —   агрегатный тип данных «ВидРасчета»;

15 —   агрегатный тип данных «Счет»;

16 —   агрегатный тип данных «ВидСубконто»;

17 —   агрегатный тип данных «ПланСчетов»;

100 —        так называемый внешний объект. В этот класс попадают все агрегатные объекты, не вошедшие в вышеперечисленный список, такие как «Текст», «Таблица», «Запрос», «ЖурналРасчетов» и т. п.

Описание:

Функция ТипЗначения определяет, к какому типу данных принадлежит переданный параметр <3начение> и возвращает числовой результат:

Пример:

Если ТипЗначения(Код)<>1 Тогда

   Предупреждение("Код имеет не числовой тип !!!");

КонецЕсли;

ТипЗначенияСтр

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

Синтаксис:

ТипЗначенияСтр(<3начение>)

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

ValueTypeStr

Параметры:

<3начение>           Выражение, тип данных значения которого надо определить.

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

Функция возвращает строковое значение в русскоязычном или в англоязычном написании — в зависимости от текущей установки основного языка конфигурации:

Русскоязычное

Англоязычное

Описание

Неизвестный Объект

UnknownObject

неопределенный тип данных;

Число

Number

числовой тип данных;

Строка

String

строковый тип данных;

Дата

Date

тип данных — дата;

Перечисление

Enum

агрегатный тип данных «Перечисление»;

Справочник

Reference

агрегатный тип данных «Справочник»;

Документ

Document

агрегатный тип данных «Документ»;

Регистр

Register

агрегатный тип данных «Регистр»;

Календарь

Calendar

агрегатный тип данных «Календарь»;

ВидРасчета

Calculation

агрегатный тип данных «ВидРасчета»;

ЖурналРасчетов

CalcJournal

агрегатный тип данных «ЖурналРасчетов»;

ПланСчетов

ChartOfAccounts

агрегатный тип данных «ПланСчетов»;

Счет

Account

агрегатный тип данных «Счет»,

Операция

Operation

агрегатный тип данных «Операция»;

КорректныеПроводки

CorrectEntries

агрегатный тип данных «КорректныеПроводки»;

БухгалтерскиеИтоги

BookkeepingTotals

агрегатный тип данных «БухгалтерскиеИтоги»;

Таблица

Table

агрегатный тип данных «Таблица»;

Текст

Text

агрегатный тип данных «Текст»;

Запрос

Query

агрегатный тип данных «Запрос»;

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

ValueList

агрегатный тип данных «СписокЗначений»;

ТаблицаЗначений

ValueTable

агрегатный тип данных «ТаблицаЗначений»;

Периодический

Рег1odic

агрегатный тип данных «Периодический»;

Картинка

Picture

агрегатный тип данных «Картинка»;

ГрупповойКонтекст

GroupContext

локальный контекст программного модуля, передаваемый при помощи ключевого слова Контекст или возвращаемый методом ОткрытьПодбор;

OLE

OLE

OLE-объект;

Описание:

Функция ТипЗначенияСтр определяет, к какому типу данных принадлежит переданный параметр <3начение> и возвращает соответствующе строковое значение. Название агрегатного типа данных передается либо в русском либо в английском написании — в зависимости от текущей установки основного языка конфигурации.

Пример:

Предупреждение("Код имеет тип - " + ТипЗначенияСтр(Код));

См. также: ОсновнойЯзык

ПустоеЗначение

Проверить значение любого типа.

Синтаксис:

ПустоеЗначение(<3начение>)

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

Empty Value

Параметры:

<3начение>           Выражение любого типа данных, значение которого проверяется на «пустое».

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

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

Описание:

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

-            значение неопределенного типа — всегда пустое;

-            значение типа «строка» проверяется как в методе ПустаяСтрока;

-            значение типа «число» проверяется на равенство нулю;

-            значение типа «дата» проверяется на пустое значение;

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

Пример:

Если ПустоеЗначение(Код) = 1 Тогда

   Предупреждение("Задайте непустое значение Кода !!!");

КонецЕсли;

ПолучитьПустоеЗначение

Получить пустое значение заданного типа данных.

Синтаксис:

ПолучитьПустоеЗначение(<Тип>)

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

GetEmptyValue

Параметры:

<Тип>

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

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

Функция ПолучитьПустоеЗначение возвращает пустое значение заданного типа данных.

Описание:

Функция возвращает пустое значение заданного типа данных.

Пример:

Если ВыбФирма = ПолучитьПустоеЗначение("Справочник.Фирмы") = 1 Тогда

   Предупреждение("Задайте непустое значение Фирмы");

КонецЕсли;

НазначитьВид

Для значений типа «Документ неопределенного вида», «Справочник неопределенного вида», «Счет неопределенного вида» назначает конкретный вид.

Синтаксис:

НазначитьВид(<3начение>, <Вид>)

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

SetKind

Параметры:

<3начение>

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

<Вид>

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

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

Описание:

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

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

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

Пример:

* Например, реквизиту документа «Контрагент» типа справочник неопределенного вида, в зависимости от значений других реквизитов можно установить вид «Организации» или «Сотрудники».

Процедура ВводНаОсновании(ДокОсн)

   Если ДокОсн.Вид() = "Счет" Тогда

      НазначитьВид(Контрагент, «Организации»);

   Иначе

      НазначитВид(Контрагент, «Сотрудники»);

   КонецЕсли;

   Форма.Контрагент.НеИзменятьВид(1);

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

ЗаписьЖурналаРегистрации

Выводит строку текста в системный журнал регистрации.

Синтаксис:

ЗаписьЖурналаРегистрации(<Коммент>, <ТипСобытия>, <Событие>, <Объект>,
<Категория>)

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

LogMessageWrite

Параметры:

<Коммент>

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

<ТипСобытия>

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

<Событие>

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

<Объект>

Необязательный параметр. Объект события, по умолчанию отсутствует. Для переданных в функцию объектов типа Документ/ Справочник/ Счет представление объекта будет записано автоматически (это не зависит от типа события и самого события).

<Категория>

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

1 — администрирование;

2 — изменение данных;

3 — информация;

4 — предупреждение;

5 — ошибка.

Значение по умолчанию 3.

Описание:

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

Системой зарезервированы следующие типы событий/события:

Документ / Открыт

Справочник/СнятаПометакаНаУдаление

Документ / Новый

 

Документ / Удален

Константа / ЗначениеЗаписано

Документ / Записан

Константа / ЗначениеУдалено

Документ / НаЗаписан

 

Документ / Проведен

ЖурналРасчетов / ИзмененРасчетныйПериод

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

ЖурналРасчетов / ОткатНазадРасчетногоПериода

Документ / НеПроведен

ЖурналРасчетов / НеудачнаяПопыткаИзмененияПериода

Документ / СделанНеПроведенным

ЖурналРасчетов / ОтменаРучногоРедактированияРезультата

Документ / ЗаписанИПроведенЗаднимЧислом

ЖурналРасчетов / ИзмененРезультат

Документ / ЗаписанИПроведен

 

Документ / ПомеченНаУдаление

Счет / ЗаписанНовый

Документ / СнятаПометакаНаУдаление

Счет / Записан

Документ / ИзмененаОперацияДокумента

Счет / ЗначениеРеквизитаЗаписано

Документ / ПроводкиВключены

Счет / ЗмачениеРеквизитаУдалено

Документ / ПроводкиВыключены

Счет / Удален

Документ / ИзмененоВремя

Счет / ПомеченНаУдаление

Справочник / ЗаписанНовый

Счет / СнятаПометакаНаУдаление

Справочник / Записан

 

Справочник / Удален

КорректнаяПроводка / ЗаписанаНовая

Справочник / ЗначениеРеквизитаЗаписано

КорректнаяПроводка / Записана

Справочник / ЗначениеРеквизитаУдалено

КорректнаяПроводка / Удалена

Справочник / ПеренесенВДругуюГруппу

 

Справочник / ПомеченНаУдаление

ОбщиеСобытия / ИзменениеТА

Незарезервированные имена позволяют пользователю фактически указывать свои собственные типы событий и события. Это значит, что если в параметре <ТипСобытия> записать "Отчет" а в параметре <Событие> "Сформирован", то при просмотре журнала регистрации можно будет фильтровать по событию «Сформирован» типа событий «Отчет».

Пример:

ЗаписьЖурналаРегистрации("Доброе утро!")

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

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

Синтаксис:

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

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

AutoNumPrefix

Параметры:

<ИмяВида>

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

<Префикс>

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

Описание:

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

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

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

Пример:

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

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

ПолучитьЗначенияОтбора

Выбирать все существующие значения отбора.

Синтаксис:

ПолучитьЗначенияОтбора(<ИмяОтбора>, <СписокЗначений> , [<ДатаНач>], [<ДатаКон>])

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

GetSelect ionValues

Параметры:

<ИмяОтбора>

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

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

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

<ДатаНач>

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

<ДатаКон>

Необязательный параметр. Дата конца интервала в котором проводить отбор. Если параметр не задан или равен 0, то отбор будет производиться до ТА.

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

Числовое значение: 1 — операция выполнена успешно; 0 — операция не выполнена.

Описание:

Функция ПолучитьЗначенияОтбора выбирает все возможные существующие значения отбора <ИмяОтбора>, заполняет выбранными значениями объект типа «СписокЗначений», и передает ссылку на этот объект в переменной <СписокЗначений>.

Замечание. Функция ПолучитьЗначенияОтбора может работать и с выбранными в конфигурации отборами операций и проводок ("СуммаОперации", "Содержание", "Сумма", "Валюта", "Количество", "ВалСумма", "Счет", "СчетДт", "СчетКт", "ПланСчетов", реквизитам операции, реквизитам проводки, видам субконто) для которых установлен режим отбора.

Пример:

// Выбрать существующие значения Авторов документов

ПолучитьЗначенияОтбора("Автор", Спис, , );

См. также: «Работа со Списком Значений»

КомандаСистемы

Вызывает на исполнение команду DOS.

Синтаксис:

КомандаСистемы(<СтрокаКоманды>)

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

System

Параметры:

<СтрокаКоманды>

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

Описание:

Процедура КомандаСистемы вызывает на исполнение команду, как если бы она была введена в командной строке DOS. При выполнении команды загружается исполняемый файл как «верхняя», активная программа.

Если загружается Windows-приложение, то управление немедленно возвращается в систему 1С:Предприятие на следующий за оператором КомандаСистемы оператор и система продолжает выполняться как фоновая прикладная программа. Пользователь может возвратиться в запускающую программу или закончив выполнение запущенной, или переключившись обратно посредством списка задач Windows.

Если в параметре <СтрокаКоманды> не содержится путь к загружаемой программе в файловой системе к программе, то поиск происходит в следующей последовательности:

-            текущий системный каталог;

-            каталог Windows;

-            системный каталог Windows;

-            все каталоги, указанные в переменной PATH;

Пример:

* В данном примере запускается редактор текста notepad.exe и в него загружается файл textl. txt.

КомандаСистемы("notepad textl.txt");

ЗапуститьПриложение

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

Синтаксис:

ЗапуститьПриложение(<СтрокаКоманды>)

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

RunApp

Параметры:

<СтрокаКоманды>

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

Описание:

Процедура ЗапуститьПриложение вызывает запуск внешнего приложения. В отличие от функции КомандаСистемы запуск приложения выполняется непосредственно, минуя командный интерпретатор. При выполнении команды исполняемый файл загружается как «верхняя», активная программа.

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

Если загружается Windows-приложение, то управление немедленно возвращается в систему 1С:Предприятие на следующий за оператором ЗапуститьПриложение оператор и система продолжает выполняться как фоновая прикладная программа. Пользователь может возвратиться в запускающую программу или закончив выполнение запущенной, или переключившись обратно посредством списка задач Windows.

Если в параметре <СтрокаКоманды> не содержится путь к загружаемой программе в файловой системе к программе, то поиск происходит в следующей последовательности:

-            текущий системный каталог;

-            каталог Windows;

-            системный каталог Windows;

-            все каталоги, указанные в переменной PATH;

Пример:

* В данном примере запускается редактор текста notepad.exe и в него загружается файл textl. txt.

ЗапуститьПриложение("notepad textl.txt");

ЗавершитьРаботуСистемы

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

Синтаксис:

ЗавершитьРаботуСистемы(<ФлагСохранения>)

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

ExitSystem

Параметры:

<ФлагСохранения>

Необязательный параметр. Флаг запроса сохранения открытых объектов. Если 0, то не запрашивается сохранение не записанных документов, элементов справочников и т. п. Если 1, то сохранение запрашивается. Значение по умолчанию 1.

Описание:

Процедура ЗавершитьРаботуСистемы вызывает завершение работы системы.

Пример:

ЗавершитьРаботуСистемы(0);

НайтиПомеченныеНаУдаление

Находит все помеченные на удаление объекты.

Синтаксис:

НайтиПомеченныеНаУдаление(<Объекты>)

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

FindMarkedForDelete

Параметры:

<Объекты>

Идентификатор объекта типа «СписокЗначений», в который данная процедура помещает найденные объекты.

Описание:

Процедура НайтиПомеченныеНаУдаление находит все помеченные на удаление объекты и помещает их в список значений.

Пример:

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

НайтиПомеченныеНаУдаление(Список);

НайтиСсылки

Находит ссылки на объекты, переданные в списке значений.

Синтаксис:

НайтиСсылки(<Объекты>, <Ссылки>)

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

FindReferences

Параметры:

<Объекты>

Конкретное значение объекта или объект типа «СписокЗначений», в котором данной процедуре передаются объекты, по которым надо найти ссылки.

<Ссылки>

Идентификатор объекта типа «ТаблицаЗначений», в который данная процедура помещает найденные ссылки на объекты. Таблица значений состоит из 3 колонок:

1. Объект — объект, на который ссылаются;

2. Ссылка — объект, который содержит ссылку;

3. Комментарий — комментарий к ссылке.

Описание:

Процедура НайтиСсылки находит ссылки на переданные в списке объекты, и помещает их в таблицу значений.

Пример:

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

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

НайтиПомеченныеНаУдаление(Список);

НайтиСсылки(Список, ТаблицаСсылок);

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

Удалить объекты, переданные в списке значений.

Синтаксис:

УдалитьОбъекты(<Объекты>, <Проверять>, <Ссылки>)

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

DeleteObjects

Параметры:

<Объекты>

Конкретное значение объекта или объект типа «СписокЗначений», в котором данной процедуре передаются объекты, которые надо удалить.

<Проверять>

Необязательный параметр. Число: 1 — перед удалением проверяется — нет ли ссылок на удаляемый объект. Если есть, то объект не удаляется, а ссылки помещаются в таблицу значений <Ссылки>. Любое другое число — проверку не выполнять. Значение по умолчанию: 1.

<Ссылки>

Необязательный параметр. Идентификатор объекта типа «ТаблицаЗначений», в который данная процедура помещает найденные ссылки на объекты. Таблица значений состоит из 3 колонок:

1. Объект — объект, на который ссылаются;

2. Ссылка — объект, который содержит ссылку;

3. Комментарий — комментарий к ссылке.

Описание:

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

Пример:

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

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

НайтиПомеченныеНаУдаление(Список);

УдалитьОбъекты(Список, 1, ТаблицаСсылок);

ОбработкаОжидания

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

Синтаксис:

ОбработкаОжидания([<ИмяПроцедуры>], [<ИнтервалВызова>])

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

IdleProcessing

Параметры:

<ИмяПроцедуры>

Необязательный параметр. Строковое выражение — имя процедуры глобального модуля, которая будет вызываться периодически с интервалом времени <ИнтервалВызова>. Тело процедуры <ИмяПроцедуры> должно быть написано разработчиком конфигурации в глобальном программном модуле.

Если в качестве параметра передается «пустая строка», то ранее запущенный процесс прекращается.

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

<ИнтервалВызова>

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

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

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

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

Имя процедуры глобального модуля, которая назначена для периодического запуска (на момент до исполнения процедуры).

Описание:

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

Пример:

Процедура СформироватьТекущийОтчетПродаж

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

ОбработкаОжидания("СформироватьТекущийОтчетПродаж", 60);



Перейти  к оглавлению: Описание встроенного языка

Hosted by uCoz