1С Предприятие 8.0. Описание встроенного языка

Методы


Заблокирован ( IsLocked )

Синтаксис:

Заблокирован()

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

Тип: Булево. Истина, если документ заблокирован, Ложь в противном случае.

Описание:

Метод позволяет определить, заблокирован ли документ данным

объектом.

Примечание:

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

Пример:

Если РасходнаяНакладнаяОбъект.Заблокирован() Тогда РасходнаяНакладнаяОбъект.Разблокировать();



КонецЕсли;

Заблокировать( Lock )

Синтаксис:

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

Описание:

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

Пример:

Попытка

    НовДокумент.Заблокировать();

Исключение

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

КонецПопытки ;

Записать ( Write )

Синтаксис:

Записать (<Режим записи> , <Режим проведения> )

Параметры:

< Режим записи> Необязательный

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

Значение по умолчанию: Запись

При определении значения параметра используется системное перечисление РежимЗаписиДокумента ( DocumentWritingMode).

<Режим проведения> Необязательный

Тип: РежимПроведения. Позволяет выбрать один из возмож­ных режимов проведения.

Значение по умолчанию: Неоперативный

При определении значения параметра используется системное перечисление РежимПроведения (PostingMode).

Описание:

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

Примечание:

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

Пример:

Попытка

    НовДокумент. Записать (РежимЗаписиДокумента. Проведение);

Исключение

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

КонецПопытки ;

См. также:

ДокументОбъект.<Имя документа>, событие ПередЗаписью.




ДокументОбъект.<Имя документа>, событие ПриЗаписи.

Заполнить ( Fill )

Синтаксис:

Заполнить(< Основание>)

Параметры:

<0снование>  Обязательный

Тип: Произвольный. Значение, на основании которого выпол­няется заполнение документа.

Описание:

Позволяет заполнить данные документа данными из другого объ­екта. Инициирует событие ОбработкаЗаполнения и вызов его процедуры-обработчика в модуле документа. В ней может размещаться алгоритм, заполняющий данные документа из пере­данного значения.

Примечание:

Для заполнения может использоваться значение любого типа.

Пример:

РасходнаяНакладнаяОбъект.Заполнить(ВыбКонтрагент);

См. также:

ДокументОбъект.<Имя документа> .  событие ОбработкаЗаполнения.

Метаданные ( Metadata )



Синтаксис:

Метаданные()

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

Тип:Объект описания метаданного.

Описание:

Позволяет получить объект описания метаданных документа. Другой путь получения того же значения - через свойство гло­бального  контекста  Метаданные.   Например:  Метадан-ные.Документы.РасходнаяНакладная.

Пример:

Если ВыбДокумент. Метаданные().Реквизиты .Контрагент. Выбран()  Тогда Контрагент = ВыбДокумент.Контрагент;

КонедЕсли;

Модифицированность ( Modified )



Синтаксис:

Модифицированность()

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

Тип: Булево. Истина, если документ модифицирован и Ложь - если нет.

Описание:

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

Пример:

Если РасходнаяНакладнаяОбьект. Модифицированность() Тогда Предупреждение("Документ был изменен.");

КонецЕсли;

МоментВремени ( PointOfTime )



Синтаксис:

МоментВремени()

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

Тип: МоментВремени.

Описание:

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

ПолучитьГраницуАктуальности ( GetActualBound )



Синтаксис:

ПолучитьГраницуАктуальности()

Описание

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

Тип: МоментВремени. Граница актуальности для документа.

Описание:

Позволяет определить границу актуальности для документа. Гра­ница актуальности определяется как момент времени наиболее позднего движения по тем оперативным регистрам, по которым данный документ может записывать движения. Состав этих реги­стров задается при настройке метаданных документа.



ПолучитьМакет ( GetTemplate )



Синтаксис:

ПолучитьМакет (<Макет>)

Параметры:

<Макет> Обязательный

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

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

Тип: ТабличныйДокумент.

Описание:

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

ПолучитьФорму ( GetForm )



Синтаксис:

ПолучитьФорму (< Форма>, <Владелец> , <Ключ уникальности>)

Параметры:

<Форма>  Необязательный

Тип: Строка, Объект описания негаданного. Имя формы, как оно задано в конфигураторе или объект описания ме-таданного требуемой формы.

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

<Владелец> Необязательный

Тип: Форма. Форма, которая будет являться владельцем откры­ваемой формы.

<Ключ уникальности> Необязательный

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

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

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

Тип:Форма.

Описание:

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

Пример:

ВыбДокумент.ПолучитьФорму().Открыть();

Прочитать ( Read )



Синтаксис:

Прочитать()

Описание:

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

Пример:

РасходнаяНакладнаяОбъект. Прочитать();

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



Синтаксис:

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

Описание:

Метод выполняет разблокировку документа, если он заблокиро­ван этим объектом.

Пример:

РасходнаяНакладнаяОбъект.Разблокировать();

Скопировать ( Copy )



Синтаксис:

Скопировать()

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

Тип: ДокументОбъект.<Имя документа>



Описание:

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

Пример:

Объект = ВыбДокумент.Скопировать();

Си. также:

ДокументОбъект.<Имя документа>, событие ПриКопировании.

Удалить ( Delete )



Синтаксис:

Удалить()

Описание:

Метод удаляет документ из базы данных.

Важно!         В        отличие        от         метода УстановитьПометкуУдаления, данный производит непо­средственное удаление документа без возможности восстановле­ния и без проверки ссылочной целостности. Использовать дан­ный метод нужно крайне осмотрительно.

Пример:

ТекстВопроса = "Удалить документ без возможности восстановления";

Ответ = Вопрос(ТекстВопроса, РежимДиалогаВопрос.ДаНет);

Если Ответ = КодВозвратаДиалога.Да Тогда РасходнаяНакладнаяОбьект.Удалить();

КонецЕсли;

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

Синтаксис:

УстановитьВремя (< Режим определения времени> , <Использовать журналы>)

Параметры:

<Режим определения времени>  Необязательный

Тип: Автовремя. Устанавливает режим автоматического опре­деления времени при записи нового документа.

Значение по умолчанию: ТекущееИлиПоследним.

При определении значения параметра используется системное перечисление Автовремя ( AutoTime).

<Использовать журналы> Необязательный

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

Значение по умолчанию: Ложь.

Описание:

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

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

Синтаксис:

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

Параметры:

<Префикс номера> Необязательный

Тип: Строка. Префикс устанавливаемого номера. Значение по умолчанию: Пустая строка

Описание:

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

Примечание:



Для документов с нумерацией в пределах периода, номер уста­навливается в соответствии с установленной датой документа.

Пример:

РасходнаяНакладнаяОбъект.УстановитьНовыйНомер(ПрефиксИБ);

См. также:

Документ-Объект.<Имя документа>,  событие ПриУстановкеНовогоНомера.

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



Синтаксис:

УстановитьПометкуУдаления (< Пометка удаления>)

Параметры:

<Пометка удаления>  Обязательный

Тип: Булево. Признак пометки удаления документа. Если зна­чение Истина - пометка на удаление будет установлена, если Ложь - снята.

Описание:

Позволяет установить/снять пометку на удаление документа. До­кумент при этом не удаляется из информационной базы. Оконча­тельное удаление помеченных документов происходит при удале­нии помеченных объектов с проверкой ссылочной целостности данных.

Пример:

РасходнаяНакладнаяОбъект.УстановитьПометкуУдаления(Истина);

ЭтоНовый ( IsNew )



Синтаксис:

ЭтоНовый()

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

Тип: Булево. Для новых документов, которые еще не были за­писаны, метод возвращает значение Истина. Если документ уже записан, то Ложь.

Описание:

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

Пример:

Если РасходнаяНакладнаяОбъект.ЭтоНовый() Тогда РасходнаяНакладнаяОбъехт.Записать();

КонецЕсли;


Содержание раздела