Методы
Синтаксис:
Заблокирован()
Возвращаемое значение:
Тип: Булево. Истина - элемент заблокирован. Ложь - элемент не заблокирован.
Описание:
Позволяет определить, заблокирован ли элемент данным объектом.
Примечание:
Следует учитывать, что этот метод используется для проверки блокировки объекта информационной базы конкретным объектом встроенного языка. Он не может быть использован для проверки, заблокирован ли вообще объект информационной базы, например, другими пользователями.
Пример:
Если НоменклатураОбъект.Заблокирован() Тогда НоменклатураОбъект.Разблокировать();
КонецЕсли;
Синтаксис:
Заблокировать()
Описание:
Позволяет выполнить блокировку объекта от изменения другими режимами или пользователями.
Пример:
Попытка
Объект.Заблокировать();
Исключение
Предупреждение("Не удалось заблокировать объект " + Объект +ОписаниеОшибки(), 60);
КонецПопытки;
Синтаксис:
Записать()
Описание:
Выполняет запись элемента справочника в информационную базу.
В процессе записи проверяется уникальность кода, если данные режим установлен в конфигурации.
Пример:
Попытка
Объект.Записать();
Исключение
Предупреждение ("Не удалось записать объект " + Объект + "|" + ОписаниеОшибки(), 60);
КонецПопытки;
Синтаксис;
Заполнить(< Основание>)
Параметры:
<0снование> Обязательный
Тип: Произвольный. Значение, на основании которого выполняется заполнение элемента справочника.
Описание:
Позволяет заполнить данные элемента данными из другого объекта. Инициирует событие ОбработкаЗаполнения и вызов его процедуры-обработчика в модуле справочника. В ней может размещаться алгоритм, заполняющий данные элемента из переданного значения.
Примечание:
Для заполнения может использоваться значение любого типа.
Пример:
Объект.Заполнить(ОбьектОснование);
Метаданные ( Metadata )
Синтаксис:
Метаданные()
Возвращаемое значение:
Тип: Объект описания негаданного. Объект описания метаданных справочника.
Описание:
Предоставляет доступ к объекту описания метаданных справочника.
Пример:
МетаданныеСправочника = Объект.Метаданные();
Сообщить("Представление справочника " + МетаданныеСправочника.Представление());
Модифицированность ( Modified )
Синтаксис:
Модифицированность()
Возвращаемое значение:
Тип: Булево. Истина - если объект изменен. Ложь - если объект не изменен.
Описание:
Позволяет определить, был ли изменен объект.
Примечание:
Метод не позволяет определить, был ли изменен объект другими пользователями.
Пример:
Если Объект.Модифицированность() Тогда Объект.Записать();
КонецЕсли;
ПолноеНаименование ( FullDescr )
Синтаксис:
ПолноеНаименование()
Возвращаемое значение:
Тип: Строка. Строка, включающая наименование элемента и наименования всех вышестоящих элементов.
Наименования выводятся слева направо, начиная с самого верхнего уровня, разделяются символом "/".
Описание:
Позволяет получить наименование элемента справочника с учетом наименований всех вышестоящих элементов.
Пример:
Сообщить("Полное наименование данного элемента: " + Объект.ПолноеНаименование()) ;
ПолныйКод ( FullCode )
Синтаксис:
ПолныйКод()
Возвращаемое значение:
Тип: Строка. Строка, включающая код элемента и коды всех вышестоящих элементов.
Коды выводятся слева направо, начиная с самого верхнего уровня, разделяются символом "/".
Описание:
Позволяет получить код элемента справочника с учетом кодов всех вышестоящих элементов.
Пример:
Сообщить ("Полный код данного элемента: " + Объект.ПолныйКод());
ПолучитьМакет ( GetTemplate )
Синтаксис:
ПолучитьМакет (< Макет>)
Параметры:
<Макет> Обязательный
Тип: Строка, Объект описания метаданного. Имя макета, как оно задано в конфигураторе или объект описания метаданного требуемого макета.
Возвращаемое значение:
Тип: ТабличныйДокумент. Созданный макет.
Описание:
Позволяет получить макет справочника.
Пример:
Объект.ПолучитьМакет();
ПолучитьФорму ( GetForm )
Синтаксис:
ПолучитьФорму (<Форма> , <Владелец> , <Ключ уникальности>)
Параметры:
<Форма> Необязательный
Тип: Строка, Объект описания метаданного. Имя формы, как оно задано в конфигураторе или объект описания метаданного требуемой формы.
Значение по умолчанию: Если параметр не указан, то используется основная форма, заданная в конфигураторе.
<Владелец> Необязательный
Тип: Форма. Форма, которая будет являться владельцем открываемой формы.
<Ключ уникальности> Необязательный
Тип: Произвольный. В данном параметре может быть задан некоторый ключ, значение которого будет использоваться для поиска уже открытых форм. Если будет найдена форма с таким же ключом уникальности, вместо открытия новой формы будет активизирована она.
Значение по умолчанию: Если параметр не указан, сначала всегда будет искаться уже открытая форма.
Возвращаемое значение:
Тип:Форма.
Описание:
Позволяет получить форму элемента справочника, которая содержит данный объект встроенного языка.
Пример:
Клиенты = Справочники.Контрагенты;
НовыйКлиент= Клиенты.СоздатьЭлемент();
НовыйКлиент.ПолучитьФорму() .Открыть();
ПринадлежитГруппе ( BelongsToFolder )
Синтаксис:
ПринадлежитГруппе (< Элемент>)
Параметры:
<Элемент> Обязательный
Тип: СправочникСсылка. <Имя справочника;». Ссылка на группу, для которой определяется принадлежность элемента.
Возвращаемое значение:
Тип: Булево. Истина - элемент подчинен группе.
Ложь - элемент не подчинен группе.
Описание:
Позволяет определить подчиненность элемента справочника группе с учетом всех уровней иерархии.
Примечание:
Определяет подчиненность группе непосредственно на момент вызова метода путем последовательного считывания всех вышестоящих элементов.
Пример:
Если Объект. ПринадлежитГруппе(ГруппаСсылка) Тогда Сообщить("Принадлежит") ;
КонецЕсли ;
Прочитать ( Read )
Синтаксис:
Прочитать()
Описание:
Позволяет прочесть заново данные элемента справочника.
Пример:
Объект.Прочитать();
Разблокировать ( Unlock )
Синтаксис:
Разблокировать()
Описание:
Позволяет снять блокировку элемента, если он заблокирован данным объектом.
Пример:
Объект.Разблокировать();
Скопировать ( Copy )
Синтаксис:
Скопировать()
Возвращаемое значение:
Тип: СправочникОбъект. <Имя справочника>. Созданный объект для записи элемента справочника.
Описание:
Позволяет создать новый элемент справочника копированием существующего.
Удалить ( Delete )
Синтаксис:
Удалить()
Описание:
Удаляет элемент справочника.
Важно! В отличие от метода УстановитьПометкуУдаления данный производит непосредственное удаление элемента справочника без возможности восстановления и без проверки ссылочной целостности. Использовать данный метод нужно крайне осмотрительно.
Пример:
Объект.Удалить();
Уровень ( Level )
Синтаксис:
Уровень()
Возвращаемое значение:
Тип: Число. Уровень элемента справочника.
Описание:
Позволяет определить уровень элемента справочника.
Примечание:
Имеет смысл только для многоуровневых справочников. Следует учитывать, что уровень элемента может меняться, например, при переносе в другую группу (смене родителя).
Для элемента, не имеющего родителей уровень будет равняться 0.
Пример:
Сообщить("Данный элемент принадлежит уровню " + Объект.Уровень());
УстановитьНовыйКод ( SetNewCode )
Синтаксис;
УстановитьНовыйКод(< Префикс кода>)
Параметры:
<Префикс кода> Необязательный
Тип: Строка. Строковое значение префикса. Если префикс указан, то новый код будет формироваться в пределах диапазона кодов ограниченных указанным префиксом.
Описание:
Устанавливает новый код. Если в коде присутствует числовая часть, то новый код автоматически устанавливается следующим за имеющимся максимальным. При этом определяется текущий максимальный код среди элементов данного справочника. Если передан префикс, то новый код устанавливается в пределах указанного префикса.
Примечание:
Префикс имеет смысл, если для справочника в конфигураторе выбран тип кода "Текстовый".
Пример:
Объект. УстановитьНовыйКод("Пр-");
УстановитьПометкуУдаления ( SetDeleteMark )
Синтаксис:
УстановитьПометкуУдаления(< Пометка удаления> , <Включая подчиненные> )
Параметры:
<Пометка удаления> Обязательный
Тип: Булево. Пометка.
Истина - пометка будет установлена.
Ложь - пометка будет снята.
<Включая подчиненные> Необязательный
Тип: Булево. Если параметр установлен в Истина, то будут помечены на удаление, кроме данного элемента, все его подчиненные элементы в данном справочнике и во всех подчиненных справочниках.
Если параметр установлен в Ложь, то будет помечен на удаление только данный элемент.
Значение по умолчанию: Истина.
Описание:
Позволяет установить/снять пометку на удаление. Объект при этом не удаляется из информационной базы. Окончательное удаление помеченных элементов справочника происходит при удалении помеченных объектов с проверкой ссылочной целостности данных.
Пример:
Объект. УстановитьПометкуУдаления(Истина, Истина);
ЭтоНовый ( IsNew )
Синтаксис:
ЭтоНовый()
Возвращаемое значение:
Тип Булево. Истина, если изменяется еще ни разу не записанный элемент.
Ложь, если элемент уже записан в информационную базу.
Описание:
Позволяет определить, был ли элемент уже записан в информационную базу.
Пример:
Если Объект.ЭтоНовый() Тогда
Объект.Наименование = "Новый элемент";
КонецЕсли;