Методы

Установить (Set)

Синтаксис:

Установить(<Значение>, <Использование>)

Параметры:

<Значение> Обязательный

Тип: Произвольный. Значение сравнения.

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

Тип: Булево. Признак использования отбора по значению.

Значение по умолчанию: Истина.

Описание:

Устанавливает значение отбора и флаг использования. При выполнении данного метода вид сравнения устанавливается в значение Равно.

Примечание:

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

Методы

СодержитТип (ContainsType)

Синтаксис:

СодержитТип (< Тип>)

Параметры:

<Тип>     Обязательный

Тип: Тип. Тип, вхождение которого проверяется.

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

Тип: Булево. Истина - указанный тип входит в используемые типы, Ложь - указанный тип не входит в используемые типы.

Описание:

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

Пример:

ПроверяемыйТип = Тип( "Строка");

Если ДопустимыеТипы.СодержитТип(ПроверяемыйТип) Тогда

    Сообщить("Описание типов содержит тип " + ПроверяемыйТип);

Иначе

    Сообщить("Описание типов не содержит тип " + ПроверяемыйТип);

КонецЕсли;

Типы (Types)

Синтаксис:

Типы()

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

Тип: Массив. Массив значений типа Тип, состоящий из исполь­зуемых типов.

Описание:

Позволяет получить типы, используемые в объекте.

Пример:

ИспользуемыеТипы = ДопустимыеТипы.Типы();

Для каждого ИспользуемыйТип Из ИспользуемыеТипы Цикл 

    Сообщить(ИспользуемыйТип);

КонепЦикла;

Методы

ВГраница (UBound)

Синтаксис:

ВГраница()

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

Тип: Число. Наибольший индекс в массиве. Если количество элементов массива равно 0, возвращает -1.

Описание:

Получает наибольший индекс элемента массива.

Примечание:

Наибольший индекс соответствует количеству элементов массива минус 1.

Пример:

Для Сч = 0 по М.ВГраница() Цикл

    М[Сч] = М[Сч] * 1;

КонецЦикла;

Вставить (Insert)

Синтаксис:

Вставить(<Индекс>, <3начение>)

Параметры:

<Индекс>    Обязательный

Тип: Число. Индекс вставляемого значения.

<3начение>    Обязательный

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

Описание:

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

Пример:

М.Вставить(0, "Первый");

Добавить(Add)

Синтаксис:

Добавить(<Значение>)

Параметры:

<3начение>    Обязательный

Добавляемое значение.

Описание:

Добавляет элемент в конец массива.

Примечание:

При добавлении количество элементов массива увеличивается на 1.

Пример:

М.Добавить("Первый");

М.Добавить("Второй");

Количество (Count)

Синтаксис:

Количество()

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

Тип: Число. Количество элементов массива.

Описание:

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

Пример:

КоличествоЭлементов = К.Количество();

Очистить (Clear)

Синтаксис:

Очистить()

Описание:

Удаляет все значения из массива.

Пример:

М.Очистить() ;

Удалить (Remove)

Синтаксис:

Удалить(<Индекс>)

Параметры:

<Индекс>    Необязательный.

Тип: Число. Индекс удаляемого элемента.

Описание:

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

Пример:

М.Удалить(4);,

Методы

Вставить (Insert)

Синтаксис:

Вставить(<Индекс>, <3начение>, <Представление> , <Пометка>, <Картинка>)

Параметры:

<Индекс>     Обязательный

Тип: Число. Индекс позиции, на которую надо вставить элемент. 

<3начение>    Необязательный

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

Значение по умолчанию: Неопределено.

<Представление>    Необязательный

Тип: Строка. Строковое выражение, содержащее представление добавляемого значения.

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

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

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

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

<Картинка>     Необязательный

Тип: Картинка. Визуальное представление значения. Значение по умолчанию: Пустая картинка.

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

Тип: ЭлементСпискаЗначений. Новый элемент списка зна­чений.

Описание:

Позволяет вставить новый элемент в список значений на пози­цию с указанным индексом.

Пример:

СписокТиповЦен.Добавить("Все наценки", Истина);

ВыборкаТиповЦен = Справочники.ТипыЦен.Выбрать();

Пока ВыборкаТиповЦен.Следующий() Цикл

    СписокТиповЦен.Вставить(0, ВыборкаТиповЦен.Ссылка, ВыборкаТиповЦен.Наценка, Ложь);

КонецЦикла ;

ВыбратьЭлемент (Chooseltem)

Синтаксис:

ВыбратьЭлемент(< Заголовок>, <Элемент>)

Параметры:

<3аголовок>     Необязательный

Тип: Строка. Заголовок окна выбора.

Значение по умолчанию: Неопределено. Стандартный заголо­вок системы.

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

Тип: ЭлементСпискаЗначений. Элемент, на который следует изначально спозиционировать список значений при интерактив­ном выборе. Если значением параметра не является элемент спи­ска значений, входящий в данный список, позиционирования не произойдет.

Значение по умолчанию: Неопределено.

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

Тип: ЭлементСпискаЗначений. Выбранный элемент списка значений. При отказе от выбора возвращается Неопределено.

Описание:

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

Пример:

ВыбЭлемент = СписокТиповЦен.НайтиПоЗначению(ВыбЗначение);

ВыбЭлемент = СписокТиповЦен.ВыбратьЭлемент("Выберите тип цен:", ВыбЭлемент);

Если ВыбЭлемент = Неопределено Тогда 

    Сообщить("Не выбран тип цен.");

Иначе

    ВывЗначение = ВыбЭлемент.Значение;

КонецЕсли ;

ВыгрузитьЗначения (UnloadValues)

Синтаксис:

ВыгрузитьЗначения()

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

Тип: Массив. Сформированный массив.

Описание:

Позволяет выгрузить хранимые элементами значения в массив значений.

Пример:

МассивЭлементов = СписокТиповЦен.Выгрузить();

Добавить (Add)

Синтаксис:

Добавить(< Значение>, <Представление> , <Пометка>, <Картинка>)

Параметры:

<3начение>     Необязательный

Тип: Произвольный. Значение, которое необходимо добавить. 

Значение по умолчанию: Неопределено.

<Представление>    Необязательный

Тип: Строка. Строковое выражение, содержащее представление добавляемого значения.

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

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

Тип: Булево. Определяет, создавать новое значение с установ­ленной пометкой или без пометки.

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

<Картинка>    Необязательный

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

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

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

Тип: ЭлементСпискаЗначений. Добавленный элемент списка значений.

Описание:

Позволяет добавить новый элемент в конец списка значений.

Пример:

Выборка = Справочники.ТипыЦен.Выбрать();

Пока Выборка.Следующий() Цикл

    СписокТиповЦен.Добавить(Выборка.Ссылка, Выборка.Наценка, Истина);

КонецЦикла;

ЗагрузитьЗначения (LoadValues)

Синтаксис:



ЗагрузитьЗначения (< Массив значений>)

Параметры:

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

Тип: Массив. Массив, содержащий значения для заполнения списка значений.

Описание:

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

Пример:

СписокТиповЦен.Загрузить(МассивЭлементов) ;

Индекс (IndexOf)

Синтаксис:

Индекс(<Элемент>)

Параметры:

<Элемент>    Обязательный

Тип: ЭлементСпискаЗначений. Элемент списка значений, для которого надо определить индекс.

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

Тип: Число. Индекс переданного элемента в списке значений. Если элемент не принадлежит данному списку, возвращается -1.

Описание:

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

Пример:

НомерСтроки = Список.Индекс(ТекущийЭлементСписка);

Количество (Count)

Синтаксис:

Количество()

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

Тип: Число. Количество элементов в списке.

Описание:

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

Пример:

Сообщить ("Итого типов цен: " + СписокТиповЦен.Количество());

НайтиПоЗначению (FindByValue)

Синтаксис:

НайтиПоЗначению(<Искомое значение>)

Параметры:

<Искомое значение>     Обязательный

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

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

Тип: ЭлементСпискаЗначений. Найденный элемент списка значений. Если ни один элемент не хранит значения, равного ис­комому, возвращается Неопределено.

Описание:

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

Пример:

Если ПолеСписка1.НайтиПоЗначению(Вы6Значение) = Неопределено Тогда 

    Сообщить("Значение не найдено!");

КонецЕсли;

ОтметитьЭлементы (Checkltems)

Синтаксис:

ОтметитьЭлементы (<Заголовок>)

Параметры:

< Заголовок>    Необязательный

Тип: Строка. Заголовок окна диалога.

Значение по умолчанию: Неопределено. Стандартный заголо­вок системы.



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

Тип: Булево. Истина, если в диалоге пометки нажата кнопка ОК, иначе - Ложь.

Описание:

Позволяет интерактивно установить или снять пометки у элемен­тов списка значений.

Пример:

Если СписокТиповЦен.ОтметитьЭлементы("Отметьте удаляемые типы цен.") Тогда

    Для каждого Элемент из СписокТиповЦен Цикл 

        Если Элемент.Пометка = Истина Тогда 

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

        КонецЕсли;

    КонецЦикла;

Иначе

    Сообщить("Отказ от пометки на удаление типов цен.");

КонецЕсли;

Очистить (Clear)

Синтаксис:

Очистить()

Описание:

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

Пример:

СписокТиповЦен.Очистить() ;

Сдвинуть (Move)

Синтаксис:

Сдвинуть (< Элемент>, <Смещение>)

Параметры:

<Элемент>    Обязательный

Тип: Число, ЭлементСписка Значений. Индекс сдвигаемо­го элемента списка либо сам элемент.

<Смещение>    Обязательный

Тип: Число. Количество позиций, на которое следует сдвинуть элемент. Положительное значение соответствует смещению эле­мента в сторону конца списка (увеличение индекса), отрицатель­ное - к началу.

Описание:

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

Пример:

// Сдвигаем первый элемент "вниз"

Список.Сдвинуть(0,1);

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

Синтаксис:

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

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

Тип: СписокЗначений. Созданный список значений.

Описание:

Позволяет создать копию списка значений.

Пример:

КопияСписка = СписокТиповЦен.Скопировать();

СортироватьПоЗначению (SortByValue)

Синтаксис:

СортироватьПоЗначению(< Направление> )

Параметры:

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

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



Значение по умолчанию: Возр.

Описание:

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

Пример:

СписокТиповЦен.СортироватьПоЗначению(ТипыСортировки.Возр);

СортироватьПоПредставлению (SortByPresent) 

Синтаксис:

СортироватьПоПредставлению(< Направление>)

Параметры:

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

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

Значение по умолчанию: Возр.

Описание:

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

Пример:

СписокТиповЦен.СортироватьПоПредставлению(ТипыСортировки.Убыв);

Удалить (Remove)

Синтаксис:

Удалить(<Элемент>)

Параметры:

<Элемент>    Обязательный

Тип: Число, ЭлементСпискаЗначений. Индекс удаляемого элемента либо сам элемент.

Описание:

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

Пример:

// удаление по индексу в списке

СписокТиповЦен.Удалить(0);

// удаление по элементу

НайденныйЭлемент = СписокТиповЦен.НайтиПоЗначению(ВыбЗначение);

Если НайденныйЭлемент <> Неопределено Тогда

    СписокТиповЦен.Удалить(НайденныйЭлемент);

Иначе

    Сообщить("Значение не найдено!");

КонецЕсли,

Методы

Активизировать (Activate)

Синтаксис:

Активизировать()

Описание:

Активизирует уже открытую форму.

Пример:

Если Форма.Открыта() Тогда 

    Форма.Активизировать() ;

КонецЕсли ;

ВводДоступен (IslnputAvailable)

Синтаксис:

ВводДоступен()

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

Тип: Булево. Истина - ввод данных в форму возможен (фор­ма активна). Ложь - форма не активна.

Описание:

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

Пример:

Если ВводДоступен() Тогда

    Сообщить("Введите текст");

КонецЕсли;

ВыбратьИзМеню (ChooseFromMenu)

Синтаксис:

ВыбратьИзМеню(< Список значений> , <Элемент формы>)

Параметры:

<Список значений>     Обязательный

Тип СписокЗначений. Список значений, содержащий значе­ния, из которых будет осуществляться выбор.

<Элемент формы>     Обязательный

Тип Элемент управления. Элемент формы, около которого будет открыто меню выбора. Для некоторых элементов (таблич­ный документ, табличное поле) меню будет показано около ак­тивной области

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

Тип ЭлементСпискаЗначений. Выбранный меню или Неопределено, если пользователь отказался от выбора.

Описание:

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

Пример:

Список = Новый СписокЗначений;

Список.Добавить(Перечисления.ВидыДопРасходов.Доставка) ;

Список.Добавить(Перечисления.ВидыДопРасходов.Разгрузка) ;

// Перечисление "ВидыДопРасходов" содержит значения "Транспорт", 

// "Доставка", "Разгрузка". По смыслу элемент "Транспорт" исключен 

ВидДР = ВыбратьИзМеню(Список.ЭлементыФормы("КнопкаДР"));

ВыбратьИзСписка (ChooseFromList)

Синтаксис:

ВыбратьИзСписка(< Список значений> , <Элемент формы> , <Начальное значение> )

Параметры:

<Список значений>     Обязательный

Тип СписокЗначений. Список значений, содержащий значе­ния, из которых будет осуществляться выбор

<Элемент формы>     Обязательный

Тип Элемент управления. Элемент формы, около которого будет открыт выпадающий список. Для некоторых элементов (табличный документ, табличное поле) выпадающий список будет показан около активной области.

<Начальное значение>       Необязательный

Тип Число, ЭлементСпискаЗначений. Задает начальный элемент, который будет активным при открытии списка

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

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

Тип: ЭлементСпискаЗначений. Выбранный элемент списка или Неопределено, если пользователь отказался от выбора.

Описание:

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

Пример:

Список = Новый СписокЗначений;

Список Добавить(Перечисления ВидыДопРасходов.Доставка);

Список Добавить(Перечисления ВидыДопРасходов.Разгрузка);

// Перечисление "ВидыДопРасходов" содержит значения "Транспорт", 

// "Доставка", "Разгрузка" По смыслу элемент "Транспорт" исключен 

ВидДР = ВыбратьИзСписка(Список, ЭлементыФормы("ПолеВвода"), 1);

Закрыть (Close)

Синтаксис:

Закрыть(<Параметр закрытия>)

Параметры:

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

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

Значение по умолчанию: Неопределено.

Описание:

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

Пример:

Закрыть("ОК");



Обновить (Refresh)

Синтаксис:

Обновить()

Описание:

Обновляет данные, представленные в форме.

Пример:

Обновить();

ОповеститьОбАктивизацииОбъекта (NotifyActivateObject)

Синтаксис:

ОповеститьОбАктивизацииОбъекта(< Активный объект> )

Параметры:

<Активный объект>     Обязательный

Тип. Ссылка на объект, либо текущая строка табличного поля. Активизированный объект.

Описание:

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

Пример:

ОповеститьОбАктивизацииОбьекта(ТекущаяСтрока) ;

См. также:

Форма, событие ОбработкаАктивизацииОбъекта.

ОповеститьОВыборе (NotifyChoice)

Синтаксис:

ОповеститьОВыборе (< Значение выбора> )

Параметры:

<3начение выбора>     Обязательный

Результат выбора.

Описание:

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

Пример:

ОповеститьОВыборе(ТекущаяСтрока);

См. также:

Форма, событие ОбработкаВыбора.

ОповеститьОЗаписиНовогоОбъекта (NotifyWriteNewObject)

Синтаксис:

ОповеститьОЗаписиНовогоОбъекта (< Объект>)

Параметры:

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

Тип: Любая ссылка на объект ИБ. Добавленный объект.

Описание:

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



Пример:

ОповеститьОЗаписиНовогоОбъекта (ДобавленнаяСтрока) ;

См. также:

Форма, событие ОбработкаЗаписиНовогоОбъекта.

ОтключитьОбработчикИзмененияДанных (DetachChangeDataHandler)

Синтаксис:

ОтключитьОбработчикИзмененияДанных(< Имя данных> )

Параметры:

<Имя данных>    Обязательный

Тип: Строка. Имя данных (путь к данным), изменения которых отслеживаются обработчиком. Могут быть указаны данные, свя­занные с реквизитами формы, табличными частями, а также под­чиненные данные - реквизиты этих объектов. Например, "Реквизит1.Наименование".

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

Описание:

Отключает процедуру-обработчик, ранее подключенную для вы­зова при изменении указанных данных в форме или подчиненных формах.

Пример:

ОтключитьОбработчикИзмененияДанных("ПолеВвода!");

См. также:

Форма, метод ПодключитьОбработчикИзмененияДанных.

ОтключитьОбработчикОжидания (DetachldleHandler)

Синтаксис:

ОтключитьОбработчикОжидания(< Имя процедуры>)

Параметры:

<Имя процедуры>     Обязательный

Тип: Строка. Имя процедуры, которую необходимо исключить из обработки ожидания.

Описание:

Отключает ранее подключенную процедуру - обработчик ожида­ния.

Пример:

ОтключитьОбработчикОжидания("ПриОжидании") ;

См. также:

Форма, метод ПодключитьОбработчикОжидания.

Открыта (IsOpen)

Синтаксис:

Открыта()

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

Тип: Булево.

Описание:

Определяет, открыта ли данная форма.

Пример:

Если Не Форма.Открыта() Тогда 

    Форма.Открыть();

КонецЕсли;

Открыть (Open)

Синтаксис:

Открыть()

Описание:

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

Пример:

Форма = Справочники.Номенклатура.ПолучитьФормуСписка() ;

Форма.Открыть();

См. также:

Форма, метод ОткрытьМодально.

Форма, метод Закрыть.

ОткрытьМодально (DoModal)

Синтаксис:

ОткрытьМодально (< Таймаут>)

Параметры:

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



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

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

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

Тип: Произвольный. Команда закрытия формы.

Описание:

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

Пример:

ФормаСписка = Справочники.Объекты.ПолучитьФормуСписка();

ФормаСписка.ОткрытьМодально() ;

См. также:

Форма, метод Открыть. Форма, метод Закрыть.

ПодключитьОбработчикИзмененияДанных (AttachChangeDataHandler)

Синтаксис:

ПодключитьОбработчикИзмененияДанных(< Имя данных> , <Имя процедуры> , <Отслеживать подчиненные данные>)

Параметры:

<Имя данных>    Обязательный

Тип: Строка. Имя данных (путь к данным), изменения которых необходимо отслеживать. Могут быть указаны данные, связанные с реквизитами формы, табличными частями, а также подчинен­ные данные - реквизиты этих объектов. Например, "Реквизит1.Наименование".

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

<Имя процедуры>     Обязательный

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

<Отслеживать подчиненные данные>     Необязательный

Тип: Булево. Признак того, что процедуру-обработчик нужно вызывать и при изменении данных, подчиненных заданным в па­раметре Имя данных, Например, при изменении их реквизитов.

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

Описание:

Подключает процедуру-обработчик, вызываемую при изменении указанных данных в форме или подчиненных формах.

Пример:

ПодключитьОбработчикИзмененияДанных("ПолеВвода1", "ПриИзменении");

См. также:

Форма, метод ОтключитьОбработчикИзмененияДанных.



ПодключитьОбработчикОжидания (AttachldleHandler)

Синтаксис:

ПодключитьОбработчикОжидания(< Имя процедуры> , <Интервал>)

Параметры:

<Имя процедуры>     Обязательный

Тип: Строка. Имя процедуры, подключаемой в качестве обра­ботчика ожидания.

<Интервал>    Обязательный

Тип: Число. Интервал времени в секундах, по истечению которо­го должна вызываться процедура - обработчик ожидания.

Описание:

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

Пример:

ПодключитьОбработчикОжидания("ПриОжидании", 1) ;

См. также:

Форма, метод ОтключитьОбработчикОжидания.

Глобальный             контекст,             метод ПодключитьОбработчикОжидания.

ПолучитьДействие (GetAction)

Синтаксис:

ПолучитьДействие(<Событие>)

Параметры:

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

Тип: Строка. Имя события, для которого необходимо получить действие.

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

Тип: Действие.

Описание:

Получает процедуру-обработчик (действие) указанного события формы.

Пример:

ТекущееДействиеПриЗакрытии = ПолучитьДействие("ПриЗакрытии");

См. также:

Действие.

УстановитьДействие (SetAction)

Синтаксис:

УстановитьДействие (<Событие> , <Действие>)

Параметры:

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

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

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

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

Описание:

Назначает новую процедуру-обработчик (действие) для указанно­го события формы.

Пример:

ДействиеПриЗакрытииФормы = Новый Действие("ПриЗакрытииФормы");

УстановитьДействие("ПриЗакрытии", ДействиеПриЗакрытииФормы);

См.также:

Форма, метод ПолучитьДействие, Действие.

««««««««««

1С:Предприятие 8.0

»»»»»»»»»»

Методы

Добавить (Add)

Синтаксис:

Добавить(<Текст>)

Параметры:

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

Тип: Строка. Название серии.

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

Тип: СерияДиаграммы. Добавленная серия.

Описание:

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

Пример:

Диаграмма.Очистить();

Для Сч = 1 По 4 Цикл

    НоваяСерия = Диаграмма.Серии.Добавить("Серия К" + Сч);

КонецЦикла;

Индекс (IndexOf)

Синтаксис:

Индекс(<Серия>)

Параметры:

<Серия>    Обязательный

Тип: СерияДиаграммы. Серия диаграммы.

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

Тип: Число. Индекс переданного элемента в коллекции. Если элемент не принадлежит данной коллекции, возвращает -1.

Описание:

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

Пример:

ИндексСерии = Диаграмма.Серии.Индекс(ВыбраннаяСерия);

Количество (Count)

Синтаксис:

Количество()

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

Тип: Число.

Описание:

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

Примечание:

Количество серий диаграммы.

Пример:

СерииДиаграммы = ДиаграммаСерии;

КоличествоСерий = СерииДиаграммы.Количество();

Сообщить("Диаграмма содержит " + КоличествоСерий + " серий");

Методы

Добавить (Add)

Синтаксис:

Добавить(< Текст>)

Параметры:

<Текст> Необязательный

Тип: Строка. Название точки.

Описание:

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

Пример:

Диаграмма.Точки.Добавить("Март");

Индекс (IndexOf)

Синтаксис:

Индекс(< Точка>)

Параметры:

<Точка>     Обязательный

Тип: ТочкаДиаграммы. Точка диаграммы.

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

Тип: Число. Индекс переданного элемента в коллекции. Если элемент не принадлежит данной коллекции, возвращает -1.

Описание:

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

Пример:

ИндексТочки = Диаграмма.Точки.Индекс(ВыбраннаяТочка);

Количество (Count)

Синтаксис:

Количество()

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

Тип: Число. Количество точек диаграммы.

Описание:

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

Пример:

ВсегоТочек = Диаграмма.Точки.Количество();

Методы

Вставить (Insert)

Синтаксис:

Вставить(<Номер элемента> , <Имя>, <3аголовок>, <3начение>, <Картинка заголовка>)

Параметры:

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

Тип: Число. Позиция, в которую должен быть помещена страни­ца.

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

Тип: Строка. Имя добавляемой страницы.

<3аголовок>     Необязательный

Тип: Строка. Текст заголовка добавляемой страницы. Если страницы панели показываются в виде закладок, то определяет текст на закладке.

<3начение>    Необязательный

Тип: Произвольный. Значение, связанное со страницей.

<Картинка заголовка>    Необязательный

Тип. Картинка. Картинка, отображаемая на заголовке закладки.

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

Тип: Страница панели.

Описание:

Вставляет страницу в нужную позицию коллекции страниц пане­ли.

Добавить (Add)

Синтаксис:

Добавить(<Имя>, <3аголовок>, <3начение>, <Картинка заголовка>)

Параметры:

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

Тип: Строка. Имя добавляемой страницы.

<3аголовок>    Необязательный

Тип: Строка. Текст заголовка добавляемой страницы. Если страницы панели показываются в виде закладок, то определяет текст на закладке.

<3начение>     Необязательный

Тип: Произвольный. Значение, связанное со страницей.

<Картинка заголовка>    Необязательный

Тип: Картинка. Картинка, отображаемая на заголовке закладки.

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

Тип: Страница панели. Созданная страница

Описание:

Добавляет страницу в коллекцию страниц панели.

Индекс (IndexOf)

Синтаксис:

Индекс(<Страница>)

Параметры:

<Страница>    Обязательный

Тип: Страница панели. Страница панели.

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

Тип: Число. Индекс панели в коллекции.

Описание:

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

Пример:

ИндексТекСтраницы = Панель.Страницы.Индекс(Панель.ТекущаяСтраница);

Количество (Count)

Синтаксис:

Количество()

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

Тип: Число. Количество страниц

Описание:

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

Очистить (Clear)

Синтаксис:

Очистить()

Описание:

Удаляет все страницы из коллекции страниц панели. После вы­полнения этого метода панель имеет одну страницу и одну за­кладку. Нумерация страниц коллекции начинается с 1.

Сдвинуть (Move)

Синтаксис:

Сдвинуть(< Страница>, <Смещение>)

Параметры:

<Страница>     Обязательный

Тип: Число или страница. Индекс перемещаемой страницы в коллекции страниц панели, или сама страница.

<Смещение >     Обязательный

Тип: Число. Количество позиций, не которое необходимо пере­местить страницу в коллекции. Положительное значение соответ­ствует смещению к концу коллекции, отрицательное - к началу.

Описание:

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

Пример:

Панель.Страницы.Сдвинуть(1, -1);

Удалить (Remove)

Синтаксис:

Удалить(<Номер>)

Параметры:

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

Тип: Число. Номер удаляемой страницы в коллекции.

Описание:

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

Методы

ДобавитьСтроку (AddLine)

Синтаксис:

ДобавитьСтроку()

Описание:

Добавляет строку в табличное поле, аналогично выполнению ко­манды "Добавить".

Если табличное поле связано с таблицей или деревом значений, метод добавляет строку в таблицу или дерево значений (анало­гично соответствующим методам этих объектов).

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

Если табличное поле связано с набором записей или табличной частью, то метод начинает редактирование новой записи. (На­пример, список записей в форме списка регистра сведений; таб­личная часть документа или справочника).

Примечание:

Если табличное поле связано с набором записей регистра сведе­ний, то новые записи можно вводить "вручную" только если для регистра установлен режим записи "Независимый" (задается при конфигурировании). Если набор записей принадлежит регистру накопления либо для регистра сведений установлен режим записи "Подчинение регистратору", то добавление новых "ручных" запи­сей не допускается.

Пример:

ЭлементыФормы.ТП.ДобавитьСтроку() ;

ИзменитьСтроку (ChangeLine)

Синтаксис:

ИзменитьСтроку()

Описание:

Начинает интерактивное изменение данных текущей строки, ана­логично выполнению команды "Изменить".

Примечание:

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

Пример:

ЭлементыФормы.ТП.ИзменитьСтроку();

Развернут (Expanded)

Синтаксис:

Развернут(<Строка>)

Параметры:

<Строка> Обязательный

Строка табличного поля. Тип значения строки табличного поля приведен в описаниях расширений табличного поля у соответст­вующий объектов.

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

Тип: Булево.

Описание:

Проверяет, развернут ли узел дерева в указанной строке.

Примечание:

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

Пример:

УзелРазвернут = ЭлементыФормы.ТП1.Развернут(Строка);

Развернуть (Expand)

Синтаксис:

Развернуть(<Строка> , <С подчиненными>)

Параметры:

<Строка>    Обязательный

Строка табличного поля. Тип значения строки табличного поля приведен в описаниях расширений табличного поля у соответст­вующий объектов.

<С подчиненными>    Необязательный

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

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

Описание:

Разворачивает узел в указанной строке дерева.

Примечание:

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

Пример:

// Разворот текущей строки в дереве:

ЭлементыФормы.ТП.Развернуть(ЭлементыФормы.ТП.ТекущаяСтрока, Истина);

Свернуть (Collapse)

Синтаксис:

Свернуть(< Строка>)

Параметры:

<Строка>    Обязательный

Строка табличного поля. Тип значения строки табличного поля приведен в описаниях расширений табличного поля у соответст­вующий объектов.

Описание:

Сворачивает узел в указанной строке дерева.

Примечание:

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

Пример:

УзелРазвернут =

ЭлементыФормы.ТП1.Развернут(Строка);

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

Синтаксис:

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

Описание:

Копирует текущую строку табличного поля, аналогично выполне­нию команды "Добавить копированием".

Если табличное поле связано с таблицей или деревом значений, метод добавляет копию текущей строки в таблицу или дерево значений (аналогично соответствующим методам этих объектов).

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

Если табличное поле связано с набором записей или табличной частью, то метод начинает редактирование новой записи - копии текущего (Например, список записей в форме списка регистра сведений, табличная часть документа или справочника).

Примечание:

Если табличное поле связано с набором записей регистра сведе­ний, то новые записи можно вводить "вручную" только если для регистра установлен режим записи "Независимый" (задается при конфигурировании). Если набор записей принадлежит регистру накопления либо для регистра сведений установлен режим записи "Подчинение регистратору", то добавление новых "ручных" запи­сей не допускается.

Пример:

ЭлементыФормы.ТП.СкопироватьСтроку();

Методы

Вставить (Insert)

Синтаксис:

Вставить(<Индекс>, <Текст шапки>)

Параметры:

<Индекс> Обязательный

Тип: Число. Индекс вставляемой колонки. Если индекс равен количеству колонок, то происходит добавление колонки в конец коллекции.

<Текст шапки>    Необязательный

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

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

Тип: Колонка табличного поля. Вставленная колонка таб­личного поля.

Описание:

Вставляет колонку в заданную позицию коллекции колонок таб­личного поля.

Пример:

ЭлементыФормы.ТП.Колонки.Вставить(0, "Наименование");

Добавить (Add)

Синтаксис:

Добавить(< Текст шапки>)

Параметры:

<Текст шапки>    Необязательный

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

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

Тип: Колонка табличного поля. Добавленная колонка таб­личного поля.

Описание:

Добавляет колонку в конец коллекции колонок табличного поля.

Пример:

ЭлементыФормы.ТП.Колонки.Добавить("Код");

Индекс (IndexOf)

Синтаксис:

Индекс(< Элемент>)

Параметры:

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

Тип: Колонка табличного поля. Колонка табличного поля.

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

Тип: Число. Индекс колонки в коллекции колонок.

Описание:

Получает индекс колонки в коллекции колонок.

Количество (Count)

Синтаксис:

Количество()

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

Тип: Число. Количество колонок

Описание:

Позволяет получить количество колонок табличного поля.

Пример:

ВсегоКолонок = ЭлементыФормы.ТП.Колонки.Количество();

Очистить (Clear)

Синтаксис:

Очистить()

Описание:

Удаляет все колонки табличного поля.

Пример:

ЭлементыФормы.ТП.Колонки.Очистить();

Сдвинуть (Move)

Синтаксис:

Сдвинуть(<Колонка>, <Смещение>)

Параметры:

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

Тип: Число, Колонка табличного поля. Индекс колонки, которую нужно сдвинуть, либо сама колонка.

<Смещение>    Обязательный

Тип: Число. Количество колонок, на которое нужно переместить колонку. Положительное значение означает, что колонка будет передвинута ближе к концу коллекции (вправо), отрицательное - ближе к началу (влево).

Описание:

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

Удалить (Remove)

Синтаксис:

Удалить(<Индекс>)

Параметры:

<Индекс>     Обязательный

Тип: Число, Колонка табличного поля. Индекс удаляе­мой колонки, либо сама колонка.

Описание:

Удаляет заданную колонку из табличного поля.

Пример:

// Удаление первой колонки:

ЭлементыФормы.ТП.Колонки.Удалить(0);

Методы

УстановитьЭлементУправления (SetControl)

Синтаксис:

УстановитьЭлементУправления(< Тип элемента управления>)

Параметры:

<Тип элемента управления>     Обязательный

Тип: Тип. Тип элемента управления, устанавливаемого в качестве редактора.

Описание:

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

Пример:

ТекКолонка = ЭлементыФормы.ТП1.Колонки[2];

ТекКолонка.УстановитьЭлементУправления(Тип("Флажок"));

««««««««««

1С:Предприятие 8.0

»»»»»»»»»»

Методы

Добавить (Add)

Синтаксис:

Добавить(<Строка>)

Параметры:

<Строка> Обязательный

Строка табличного поля. Тип значения строки табличного поля приведен в описаниях расширений табличного поля у соответст­вующий объектов.

Описание:

Устанавливает выделение на указанную строку.

Пример:

ЭлементыФормы.ТП.ВыделенныеСтроки.Добавить(ТекСтрока);

Количество (Count)

Синтаксис:

Количество()

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

Тип: Число. Количество выделенных строк.

Описание:

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

Пример:

КолВо = ЭлементыФормы.ТабличноеПоле1.ВыделенныеСтроки.Количество();

Очистить (Clear)

Синтаксис:

Очистить()

Описание:

Снимает выделение со всех строк.

Удалить (Remove)

Синтаксис:

Удалить(<Строка>)

Параметры:

<Строка>     Обязательный

Строка табличного поля. Тип значения строки табличного поля приведен в описаниях расширений табличного поля у соответст­вующий объектов.

Описание:

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

Методы

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

Синтаксис:

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

Параметры:

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

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

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

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

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

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

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

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

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

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

Тип: Форма

Описание:

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

Пример:

Константы.ПолучитьФорму().ОткрытьМодально() ;

СоздатьНабор ( CreateSet )_

Вариант синтаксиса:

По строке

Синтаксис:

СоздатьНабор(< Набор констант>)

Параметры:

<Набор констант>Обязательный

Тип: Строка.  Строка, содержащая перечисленные через запятую имена констант, для управления которыми создается объект.

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

Вариант синтаксиса:

По массиву Синтаксис:

СоздатьНабор(<Набор констант>)

Параметры:

<Набор констант>_ Необязательный

Ключ

Тип: Массив. Массив значений, содержащий строки-имена кон­стант и (или) соответствующие константам значен? я типа Объект описания метаданного. Этот список определяет набор констант, для управления которыми создается объест.

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

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

Пустой массив

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

Тип: КонстантыНабор. Созданный набор констант.

Описание:

Используется для создания объекта управления константами.

// Создание набора по строке НаборКонстант = Константы.СоздатьНабор('Директор,Бухгалтер");

// Создание набора по массиву МассивКонстант = Новый Массив;

МассивКонстант.Добавить(Метаданные.Константы.Директор);

МассивКонстант.Добавить("Бухгалтер") ;

НаборКонстант = Константы.СоздатьНабор(МассивКонстант);

Методы

Получить ( Get )

Синтаксис:

Получить()

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

Тип: Произвольный.

Текущее значение константы.

Описание:

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

Примечание:

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

Пример:

Сообщить("Директор у нас: " + Константы. Директор. Получить());

Установить ( Set )

Синтаксис:

Установить(< Значение>)

Параметры:

<3начение> Обязательный

Тип: Произвольный.

Описание:

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

Пример:

Константы.Бухгалтер.Установить("Сидоров Петр Иванович");

Методы

ЗаписатьВФорме ( WritelnForm )

Синтаксис:

ЗаписатьВФорме()

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

Тип: Булево. Истина - набор записан. Ложь - нет.

Описание:

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

Пример:

Если ЗаписатьВФорме() Тогда

Сообщить("Запись занесена в ИБ.");

КонецЕсли ;

Методы

Выбрать ( Select )

Синтаксис:

Выбрать(<Родитель>, <Владелец>, <Отбор>, <Порядок>)

Параметры:

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

Тип: СправочникСсылка. <Имя справочникам Отбор по родителю. Имеет смысл только для многоуровневых справочни­ков. Если параметр не задан или установлен в Неопределено, то отбор по родителю не производится. Чтобы отобрать элементы верхнего уровня, нужно в качестве данного параметра указать пустую ссылку на элемент справочника.

Значение по умолчанию: Неопределено.

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

Тип: СправочникСсылка. <Имя справочника>. Отбор по владельцу. Имеет смысл только для подчиненных справочников. Если параметр не задан или установлен в Неопределено, то отбор по владельцу не производится.

Значение по умолчанию: Неопределено.

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

Тип: Структура. Задает поле и значение отбора открываемой выборки. Ключ структуры описывает имя поля, а значение струк­туры - значение отбора по этому полю. В качестве полей для от­бора могут задаваться только поле Код, Наименование и рек­визиты справочника для которых в конфигураторе признак ин­дексирования установлен в значение "Индексировать" или в зна­чение "Индексировать с доп. упорядоч.".

Важно! Структура может содержать только один элемент.

Значение по умолчанию: Неопределено.

<Порядок> Необязательный

Тип: Строка. Строка с именем реквизита справочника, опреде­ляющая упорядочивание элементов в выборке. Может быть ука­зано "Код", "Наименование" или имя одного из реквизитов при­митивного типа (число, строка, дата, булево), для которого уста­новлен признак "Индексирование" в значение "Индексировать" или в "Индексировать с доп. упорядоч." в конфигураторе. После имени реквизита через пробел может быть указано направление сортировки. Направление определяется: "Убыв" (" Desc") - упо­рядочивать по убыванию; "Возр" (" Asc") - упорядочивать по воз­растанию. По умолчанию сортировка производится по возраста­нию. Если параметр не указан, то порядок определяется основ­ным представлением справочника.

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

Пустая строка.

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

Тип: СправочникВыборка. <Имя справочника>. Получен­ная выборка.

Описание:

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

Пример:

МПЗ = Справочники.Номенклатура;

ОтборМПЗ = Новый Структура("ТипНоменклатуры");

Пусто = Перечисления.ТипыНоменклатуры.ПустаяСсылка();

ОтборМПЗ.ТипНоменклатуры = Пусто;

ВыборкаМПЗ = МПЗ.Выбрать(,,ОтборМПЗ, "Наименование Убыв");

Пока ВыборкаМПЗ.Следующий() Цикл

    Объект = ВыборкаМПЗ.ПолучитьОбъект();

    Объект.ТипНоменклатуры = Перечисления.ТипыНоненклатуры.Товар;

    Попытка

        Объект.Записать();

     Исключение

        Предупреждение("Не удалось записать объект " + Объект + "|" + ОписаниеОиибки(),60);

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

КонецЦикла ;

ВыбратьИерархически ( SelectHierarchicaly )

Синтаксис;

ВыбратьИерархически (< Родитель> , <Владелец>, <Отбор>, <Порядок>)

Параметры:

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

Тип: СправочникСсылка. <Имя справочника>. Отбор по родителю. Имеет смысл только для многоуровневых справочни­ков. Если параметр не задан или установлен в Неопределено, то отбор по родителю не производится.

Значение по умолчанию: Неопределено.

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

Тип: СправочникСсылка. <Имя справочника>. Отбор по владельцу. Имеет смысл только для подчиненных справочников. Если параметр не задан или установлен в Неопределено, то отбор по владельцу не производится.

Значение по умолчанию: Неопределено.

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

Тип: Структура. Структура, в которой указывается поле отбора и   значение    отбора.   Могут   задаваться    только   Код, Наименование и реквизиты справочника, для которых в конфигураторе признак индексирования установлен в значение "Ин­дексировать" или в значение "Индексировать с доп. упорядоч.".



Важно! Структура может содержать только один элемент

Значение по умолчанию: Неопределено.

<Порядок> Необязательный

Тип: Строка. Строка с именем реквизита справочника, опреде­ляющая упорядочивание элементов в выборке.

Может быть указан "Код", "Наименование" или имя одного из реквизитов примитивного типа (число, строка, дата, булево), для которого установлен признак Индексирование в значение Индексировать или Индексировать с доп. упорядоч. в метаданных. После имени реквизита через пробел может быть указано направление сортировки. Направление определяется:

"Убыв" ("Desc") - упорядочивать по убыванию; 

"Возр" (" Asc") -упорядочивать по возрастанию. 

По умолчанию сортировка произ­водится по возрастанию. Если параметр не указан, то порядок определяется основным представлением справочника.

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

Пустая строка.

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

Тип: СправочникВыборка. <Имя справочника>. Получен­ная выборка.

Описание:

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

Пример:

Товары = Справочники.Номенклатура;

ВыборкаСправочника = Товары.ВыбратьИерархически();

НайтиПоКоду ( FindByCode )

Синтаксис:

НайтиПоКоду(<Код>, <Поиск по полному коду> , <Родитель>, <Владелец>}

Параметры:

<Код> Обязательный

Тип: Число, Строка. Искомый код.

Строка или число в зависимости от настроек справочника в кон­фигураторе.

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

Тип: Булево. Режим поиска по полному коду.

Если параметр устанавливается в Истина, то искомый код сле­дует задавать в виде строки, состоящей из последовательности кодов по уровням справочника, разделенных символом "/".

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

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



Тип: СправочникСсылка. <Имя справочника>. Родитель, в пределах которого нужно выполнять поиск. Если не указан или установлен в Неопределено, то поиск будет проводиться во всем справочнике.

Значение по умолчанию: Неопределено.

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

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

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

Неопределенно.

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

Тип: СправочникСсылка.<Имя справочника>. Ссылка на найденный элемент справочника. Если не существует ни одного элемента с требуемым кодом, то будет возвращена пустая ссылка.

Описание:

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

Пример:

СтрокаКода = "840";

Волюты = Справочники.Валюты;

НайденнаяСсылка = Валюты.НайтиПоКоду(СтрокаКода);

Если НайденнаяСсылка = Валюты.ПустаяСсылка() Тогда

    Сообщить( "Валюты " + СтрокаКода + " еще нет");

КонеиЕсли;

НайтиПоНаименованию ( FindByDescr )

Синтаксис:

НайтиПоНаименованию (< Наименование> , <Точное соответствие> , <Родитель>, <Владелец>)

Параметры:

<Наименование>_Обязательный

Тип: Строка. Строка, содержащая искомое наименование.

<Точное соответствие> Необязательный

Тип: Булево. Режим поиска по полному соответствию.

Поиск будет успешным, если строка поиска: в случае значения параметра Ложь - будет соответствовать левой части наимено­вания; в случае значения параметра Истина - будет полно­стью совпадать с наименованием (за исключением "хвостовых" пробелов в наименовании).

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

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

Тип: СправочникСсылка. <Имя справочника>. Родитель, в пределах которого нужно выполнять поиск. Если не указан или установлен в Неопределено, то поиск будет проводиться во всем справочнике.

Значение по умолчанию: Неопределено.

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



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

Значение по умолчанию: Неопределено.

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

Тип: СправочникСсылка. <Имя справочника>. Ссылка на найденный элемент справочника. Если не существует ни одного элемента с требуемым наименованием, то будет возвращена пус­тая ссылка.

Описание:

Позволяет получить ссылку на элемент по его наименованию.

Примечание:

Если существует несколько элементов с указанным наименовани­ем, то будет найден только один из них.

Пример:

СтрокаНаименоваиия = "USD";

Валюты = Справочники.Валюты;

НайденнаяСсылка = Валюты.НаЙтиПоНаименованию(СтрокаНаименования);

Если НайденнаяСсылка = Валюты.ПустаяСсылка() Тогда

    Сообщить("Валюты " + СтрокаНаименования + " еще нет");

КонецЕсли;

НайтиПоРеквизиту ( FindByAttribute )

Синтаксис:

НайтиПоРеквизиту (<Имя реквизита> , <3начение реквизита>, <Родитель>, <Владелец>)

Параметры:

<Имя реквизита>   Обязательный

Тип: Строка. Имя реквизита, как он задан в конфигураторе.

<3начение реквизита> Обязательный

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

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

Тип: СправочникСсылка. <Имя справочника>. Родитель, в пределах которого нужно выполнять поиск. Если не указан или установлен в Неопределено, то поиск будет проводиться во всем справочнике.

Значение по умолчанию: Неопределено.

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

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

Значение по умолчанию: Неопределено.

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

Тип: СправочникСсылка.<Имя справочника>. Ссылка на найденный элемент справочника. Если не существует ни одного элемента с требуемым значением реквизита, то будет возвращена пустая ссылка.



Описание:

Позволяет получить ссылку на элемент по значению реквизита.

Примечание:

Если существует несколько элементов с указанным значением реквизита, то будет найдет только один из них.

Для реквизитов типа Строка поиск осуществляется по точному соответствию.

Пример:

СтрокаНаименования = "Доллары США" ;

Валеты = Справочники.Валюты;

НайденнаяСсылка = Валюты.НайтиПоРеквизиту ("ПолноеНаименоваяяе", СтрокаНаименования);

Если НайденнаяСсылка = Валюты.ПустаяСсылка() Тогда

    Сообщить("Валюты " + СтрокаНаименования + "еде нет.");

Иначе

    Сообщить('Нашли такую.") ;

КонецЕсли;

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

Синтаксис:

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

Параметры:

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

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

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

Тип- ТабличныйДокумент. Созданный макет.

Описание:

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

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

Синтаксис:

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

Параметры:

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

Тип: Строка. Имя формы, как оно задано в конфигураторе.

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

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

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

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

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

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

Тип: Форма.

Описание:

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



Пример:

Товары = Справочники.Номенклатура;

ФормаСписка= Товары.ПолучитьФорму("ФормаСписка") ;

Если Не ФормаСписка. Открыта () Тогда ФормаСписка.Открыть();

КонецЕсли;

ПолучитьФормуВыбора( GetFormChose )

Синтаксис:

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

Параметры:

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

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

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

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

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

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

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

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

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

Тип: Форма.

Описание:

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

Пример:

Товары = Справочники.Номенклатура;

ФормаСлиска= Товары.ПолучитьФормуВыбора();

Если Не ФормаСписка.Открыта() Тогда ФормаСписка.Открыть();

КонецЕсли;

ПолучитьФормуВыбораГруппы

Синтаксис:

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

Параметры:

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

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

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

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

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

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

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



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

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

Тип: Форма.

Описание:

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

ПолучитьФормуНовогоЭлемента ( GetFormNewltem)

Синтаксис:

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

Параметры:

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

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

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

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

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

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

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

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

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

Тип: Форма.

Описание:

Позволяет получить форму нового элемента.

Пример:

Товары = Справочники.Номенклатура;

ФормаНового= Товары.ПолучитьФормуНовогоЭлемента();

ФормаНового.Открыть();

ПолучитьФормуНовойГруппы

Синтаксис:

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

Параметры:

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

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

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

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

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

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

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



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

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

Тип: Форма.

Описание:

Позволяет получить форму новой группы.

Пример:

Товары = Справочники. Номенклатура;

ФормаНового= Товары.ПолучитьФормуНовойГруппы();

ФормаНового.Открыть();

ПолучитьФормуСписка ( GetFormList )

Синтаксис:

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

Параметры:

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

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

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

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

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

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

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

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

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

Тип:Форма.

Описание:

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

Пример:

Товары = Справочники.Номенклатура;

ФормаСписка= Товары.ПолучитьФормуСписка();

Если не ФормаСписка.Открыта() Тогда ФормаСписка.Открыть() ;

КонецЕсли;

ПустаяСсылка ( EmptyRef )

Синтаксис:

ПустаяСсылка()

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

Тип: СправочникСсылка.<Имя справочника>.

Описание:

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

Примечание:

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

Пример:

Если найденнаяСсылка = Справочники.Валюты.ПустаяСсылка() Тогда Сообщить("Такой валюты еде нет");

КонецЕсли;

СоздатьГруппу ( CreateFolder )



Синтаксис:

СоздатьГруппу()



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

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

Описание:

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

Пример:

НовыйОбьект = Справочники ["Контрагенты"] .СоздатьГруппу() ;

НовыйОбъект.Наименование = "Покупатели";

НовыйОбъект.Записать() ;

СоздатьЭлемент ( Createltem )

Синтаксис:

СоздатьЭлемент()

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

Тип: СправочникОбъект.<Имя справочника>.  Созданный объект для записи элемента справочника.

Описание:

Позволяет создать новый элемент справочника.

Пример:

НовыйОбъект = Справочники.Валеты.СоздатьЭлемент();

НовыйОбъект.Код = "840";

НовыйОбъект.Наименование = "USD";

НовыйОбъект.ПолноеНаименование = "Доллары США";

НовыйОбъект.Записать() ;

Методы

Обновить ( Refresh )

Синтаксис:

Обновить()

Описание:

Позволяет обновить список элементов.

Методы

ЗаписатьВФорме ( WritelnForm )

Синтаксис:

ЗаписатьВФорме()

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

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

Описание:

Позволяет записать объект, открытый в форме.

Пример:

Если ЗаписатьВФорме() Тогда

    Сообщить('Объект записан.");

КонецЕсли;

Методы

Выбрать ( Select )

Синтаксис:

Выбрать (<Дата начала> , <Дата окончания>, <Отбор>, <Порядок>)

Параметры:

<Дата начала> Необязательный

Тип: Дата. Дата и время начала периода выборки документов.

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

<Дата окончания> Необязательный

Тип: Дата. Дата окончания периода выбираемых документов

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

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

Тип: Структура. Задает поле и значение отбора открываемой выборки. Ключ структуры описывает имя поля, а значение струк­туры - значение отбора по этому полю. В качестве полей для от­бора могут задаваться только поле Дата и реквизиты документа, для которых в конфигураторе признак индексирования установлен в значение "Индексировать" или в значение "Индексировать с доп. упорядочиванием".

Важно! Структура может содержать только один элемент.

Значение по умолчанию: Неопределено. 

<Порядок> Необязательный

Тип: Строка. Задает реквизит документа, по которому упорядо­чивается выборка документов. Может быть указано поле Дата или имя реквизита документа, для которого признак индексиро­вания в конфигураторе установлен в значения "Индексировать" или "Индексировать с доп. упорядочиванием". После указания имени через пробел может быть указано направление сортировки.

Направление определяется: 

"Убыв" ("Desc") - упорядочивать по убыванию, и 

"Возр" (" Asc") - упорядочивать по возрастанию. 

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

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

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

Тип: ДокументВыборка.<Имя документа>. Сформирован­ная выборка.

Описание:

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

Пример:

Выборка = Документы.РасходнаяНакладяая.Выбрать(ДатаНач, ДатаКон);  

НайтиПоНомеру ( FindByNumber )

Вариант синтаксиса: Для документов с непериодической нумерацией

Синтаксис:

НайтиПоНомеру(<Номер документа>)

Параметры:

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

Тип: Число, Строка. Номер искомого документа. Тип переда­ ваемого значения зависит от установки в конфигураторе пред­ставления номера документа.

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

Синтаксис:

НайтиПоНомеру (< Номер документа> , <Дата

интервала>)

Параметры:

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

Тип: Число, Строка. Номер искомого документа. Тип переда­ваемого значения зависит от установки в конфигураторе пред­ставления номера документа.

<Дата интервала> Обязательный

Тип: Дата. Дата из интервала, в котором проводится поиск по номеру. Сам интервал определяется как период уникальности номеров документа, в который входит указанная дата. Например, если номера документов уникальны в пределах месяца и задана дата 10 декабря 2001 года, то поиск будет проводиться в интерва­ле с 01 по 31 декабря 2001 года.

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

Тип: ДокументСсылка.<Имя документа>. Если документ не найден, возвращается пустая ссылка на документ.

Описание:

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

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

Синтаксис:

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

Параметры:

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

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

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

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

Описание:

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

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

Синтаксис:

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

Параметры:

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



Тип: Строка. Имя формы, как оно задано в конфигураторе.

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

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

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

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

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

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

Тип: Форма.

Описание:

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

ПолучитьФормуВыбора ( GetFormChoice )

Синтаксис:

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

Параметры:

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

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

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

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

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

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

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

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

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

Тип: Форма.

Описание:

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

ПолучитьФормуНовогоДокумента ( GetFormNewDcou merit )

Синтаксис:

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

Параметры:

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

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



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

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

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

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

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

активизирована она.

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

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

Тип: Форма.

Описание:

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

ПолучитьФормуСписка ( GetFormList )

Синтаксис:

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

Параметры:

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

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

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

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

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

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

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

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

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

Тип: Форма.

Описание:

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

ПустаяСсылка ( EmptyRef )

Синтаксис:

ПустаяСсылка()

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

Тип: ДокументСсылка.<Имя документа>.

Описание:

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

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

Синтаксис:

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

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

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

Описание:

Создает новый документ.

Пример:

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

РасходнаяНакладная НовДок = Документы.РасходнаяНакладная.СоздатьДокумент();

НовДок.Записать();

Методы

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

Синтаксис:

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

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

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

Описание:

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

Пример:

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

КонецЕсли;

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

Синтаксис:

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

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

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

Описание:

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

ПолучитьОбъект ( GetObject )

Синтаксис:

ПолучитьОбъект()

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

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

Описание:

Позволяет получить по ссылке объект для модификации и записи документа (ДокументОбъект.<Имя документа>).

Пример:

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

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

Синтаксис:

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

Параметры:

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

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

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

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

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

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

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

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

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

Тип: Форма.

Описание:

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

Пример:

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

Пустая ( IsEmpty )

Синтаксис:

Пустая()

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

Тип: Булево.

Описание:

Позволяет получить признак пустой ссылки на документ. Это означает, что ссылка не ссылается ни на один объект базы дан­ных. Если ссылка пустая, метод возвращает значение Истина. Может использоваться, например, для проверки выбранности до­кумента в элементе управления.

Пример:

Если ВыбДокумент. Пустая() Тогда

    Предупреждение ("Выберите документ !");

КонецЕсли;

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

Синтаксис:

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

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

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

Описание:

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

Пример:

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

См. также:

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

««««««««««

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 )



Синтаксис:

ЭтоНовый()

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

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

Описание:

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

Пример:

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

КонецЕсли;

Методы

ПолучитьОбъекг ( GetObject )

Синтаксис:

ПолучитьОбъект()

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

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

Описание:

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

Следующий ( Next )

Синтаксис:

Следующий()

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

Тип: Булево. Возвращает значение Истина, если получен сле­дующий документ из выборки, и Ложь - если не получен (вы­борка документов завершена).

Описание:

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

Методы

Обновить ( Refresh )

Синтаксис:

Обновить()

Описание:

Вызывает перечитывание данных списка из базы данных.

Методы

ЗаписатьВФорме ( WritelnForm )

Синтаксис:

ЗаписатьВФорме()

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

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

противном случае.

Описание:

Записывает документ, открытый в данный момент в форме.

См. также:

Расширение формы     документа,      свойство ИспользоватьРежимПроведения.

Методы

Выбрать ( Select )

Синтаксис:

Выбрать(<Дата начала>, <Дата окончания>}

Параметры:

<Дата начала> Необязательный

Тип: Дата. Дата и время начала периода выборки документов.

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

<Дата окончания>  Необязательный

Тип: Дата. Дата окончания периода выбираемых документов.

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

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

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

Описание:

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

Пример:

ВыборкаИзЖурнала = ЖурналыДокументов.Торговля.Выбрать(, РабочаяДата);

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

Синтаксис:

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

Параметры:

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

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

Описание:

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

Пример:

МакетРеестра = ЖурналыДокументов.Общий.ПолучитьМакет("Реестр");

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

Синтаксис:

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

Параметры:

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

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

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

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

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

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

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

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

будет искаться уже открытая форма.

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

Тип: Форма.

Описание;

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

Пример:

ФормаЖурнала = ЖурналыДокументов .Общий.ПолучитьФорму();

Методы

ПолучитьОбъект ( GetObject )

Синтаксис:

ПолучитьОбъект()

Описание:

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

Следующий ( Next )

Синтаксис:

Следующий()

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

Возвращает значение Истина, если получен следующий доку­мент из выборки, и Ложь - если не получен (выборка докумен­тов завершена).

Описание:

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

Методы

Обновить ( Refresh )

Синтаксис:

Обновить()

Описание:

Вызывает перечитывание данных списка.

Методы

Обновить ( Refresh )

Синтаксис:

Обновить()

Описание:

Вызывает перечитывание данных списка.

Методы

Выбран ( Selected )

Синтаксис:

Выбран()

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

Истина - если запись считана, Ложь - запись не считана.

Описание:

Позьоляет определить, считана запись или нет.

Пример:

Если Не Курс.Выбран() Тогда

    Предупреждение("Курс не считан");

КонецЕсли;

Записать ( Write )

Синтаксис:

Записать (<3амещать>)

Параметры:

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

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

Значение по умолчанию: Истина.

Описание:

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

Пример:

Курс. Записать(1) ;

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

Синтаксис:

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

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

Тип: Булево. Истина - изменен. Ложь - не изменен.

Описание:

Позволяет определить, изменен ли объект по отношению к счи­танным значениям.

Примечание:

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

Пример:

Если Курс.Модифицированность() Тогда

    Курс.Записать();

КонецЕсли;

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

Синтаксис:

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

Параметры:

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

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

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

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

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

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

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

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

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

Тип: Форма.

Описание:

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

Пример:

Курс.ПолучитьФорму().Открыть() ;

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



Синтаксис:

Прочитать()

Описание:

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

Пример:

Курс.Прочитать()

Удалить ( Delete )



Синтаксис:

Удалить()

Описание:

Позволяет удалить запись с установленными значениями ключе­вых полей.

Пример:

Курс.Удалить();

««««««««««

1С:Предприятие 8.0

»»»»»»»»»»

Методы

Восстановить ( Restore )

Синтаксис:

Восстановить (< Момент времени>, <Последовательности>)

Параметры:

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

Тип: Дата, Момент Времени. Момент времени, на который восстанавливаются последовательности.

Значение по умолчанию: Неопределено.

<Последовательности> Необязательный

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

Значение по умолчанию: Неопределено.

Описание:

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

Пример:

ТабПоследовательностей = Новый ТаблицаЗначений;

ТабПоследовательностей.Колонки.Добавить("ИмяПоследовательности");

ТабПоследовательностей.Колонки.Добавить("НаборКомбинаций") ;

ПустаяТаблица = Новый ТаблицаЗначений;

Стр = ТабПоследовательностей.Добавить();

Стр.ИмяПоследовательности = "УчетТоваров" ;

Стр.НаборКомбинаций = ПустаяТаблица;

Последовательности.Восстановить(РабочаяДата, ТабПоследовательностей);

Методы

Восстановить ( Restore )

Синтаксис:

Восстановить (<Момент времени> , <Отбор>)

Параметры:

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

Тип: Дата, Момент Времени. Момент времени, по который восстанавливается последовательность.

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

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

Тип: ТаблицаЗначений. Набор комбинаций значений измере­ний, которые надо восстанавливать в данной последовательности. Задается как таблица значений, в колонках которой содержатся соответствующие значения измерений. Имена колонок должны соответствовать именам измерений последовательности. Если на­бор комбинаций не указан, то будет восстановлена вся последова­тельность.

Значение по умолчанию: Если не указан, то по всем измерениям. Описание:

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

Пример:

Момент = Новый МоментВремеяи(Док.Дата, Док.Ссылка);

Отбор = Новый ТаблицаЗначений;

Отбор.Колонки.Добавить("Товар");

Отбор.Добавить().Товар = Товар;

Последовательности.УчетТоваров.Восстановить(Момент, Отбор);

ПолучитьГраницу ( GetBoundary )

Синтаксис:

ПолучитьГраницу (< Отбор> )

Параметры:

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

Тип: Структура. Структура, задающая отбор по измерениям последовательности. Ключ структуры определяет измерение по­следовательности, по которому будет осуществляться отбор, а значение структуры - значение измерения.

Если измерение отсутствует в структуре, то по нему отбор осуще­ствляться не будет.

Значение по умолчанию: Если параметр не указан, то по всем значениям измерений.

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

Тип: МоментВремени. Момент времени, соответствующий ми­нимальной границе последовательности.

Описание:

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

Пример:

Отбор = Новый Структура ("Товар");

Отбор.Вставить("Товар", ТекТовар) ;

ГП = Последовательности.УчетТоваров.ПолучитьГраницу(Отбор);

ПолучитьГраницы ( GetBoundaries )



Синтаксис:

ПолучитьГраницы (< Разрез> , <Отбор> )

Параметры:

<Разрез> Обязательный

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

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

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

Значение по умолчанию: Если параметр не указан, то по всем значениям измерений.

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

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

Описание:

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

Пример:

Отбор = Новый ТаблицаЗначений;

Отбор.Колонки.Добавить("Товар");

Разрез = "Товар";

Последов = Последовательности.УчетТоваров;

ТабГраницы = Последов.ПолучитьГраницы(Разрез, Отбор);

Принадлежит (Belong)



Синтаксис:

Принадлежит(< Документ>, <Отбор>)

Описание

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

Тип: ДокументСсылка. <Имя документа>. Проверяемый документ.

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

Тип: Структура. Структура, задающая отбор по измерениям последовательности. Ключ структуры определяет измерение по­следовательности, по которому будет осуществляться отбор, а значение структуры - значение измерения. Если измерение от­сутствует в структуре, то по нему отбор осуществляться не будет.



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

Тип: Булево.

Описание:

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

Пример:

Отбор = Новый Структура;

Отбор.Вставить("Товар", ТекТовар);

Принадлежит = Последовательности.УчетТоваров.Принадлежит(Док, Отбор);

Проверить ( Validate )



Синтаксис:

Проверить(<Момент времени>, <Отбор>)

Параметры:

<Момент времени> Обязательный

Тип: Дата, Момент Времени. Момент времени, по который проверяется последовательность.

<Отбор> Обязательный

Тип: Структура. Структура, задающая отбор по измерениям последовательности. Ключ структуры определяет измерение последовательности, по которому будет осуществляться отбор, а значение структуры - значение измерения.

Если измерение отсутствует в структуре, то по нему отбор осуще­ствляться не будет.

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

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

Описание:

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

Пример:

Момент = Новый МоментВремени(Док.Дата, Док.Ссылка);

Отбор = Новый Структура;

Отбор.Вставить("Товар", Товар) ;

Непрерывна = Последовательности.УчетТоваров.Проверить(Момент, Отбор) ;

УстановитьГраницу ( SetBoundary )



Синтаксис:

УстановитьГраницу (< Момент времени> , <Отбор>)

Параметры:

<Момент времени> Обязательный

Тип: МоментВремени, Дата. Момент времени, на который устанавливается граница последовательности.

<Отбор> Обязательный

Тип: Структура. Структура, задающая отбор по измерениям последовательности. Ключ структуры определяет измерение по­следовательности, по которому будет осуществляться отбор, а значение структуры - значение измерения.

Описание:

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

Пример:

Отбор = Новый Структура ("Товар");

Отбор.Вставить("Товар", ТекТовар) ;

Последовательности.УчетТоваров.УстановитьГраницу(ТекМомент, Отбор) ;

Методы

Добавить ( Add )

Синтаксис:

Добавить()

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

Тип: ПоследовательностьЗапись.<Имя последовательности>. Запись регистрации документа в по­следовательности.

Описание:

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

Записать ( Write )

Синтаксис:

Записать()

Описание:

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

Индекс ( IndexOf )

Синтаксис:

Индекс(< Запись>)

Параметры:

<3апись> Обязательный

Тип: ПоследовательностьЗапись.<Имя последовательности>. Запись, индекс которой необходимо получить.

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

Тип: Число. Индекс указанной записи в наборе.

Описание:

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

Количество ( Count )

Синтаксис:

Количество()

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

Тип: Число. Количество записей регистрации в наборе.

Описание:

Получает количество записей регистрации в наборе.

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

Синтаксис:

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

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

Тип: Булево.

Описание:

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

Очистить ( Clear )

Синтаксис:

Очистить()

Описание:

Удаляет все записи регистрации из набора.

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

Синтаксис:

Прочитать()

Описание:

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

Удалить ( Remove )

Синтаксис:

Удалить(< Запись>)

Параметры:

<Запись> Обязательный

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

Описание:

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

««««««««««

1С:Предприятие 8.0

»»»»»»»»»»

Методы

Сравнить (Compare)

Синтаксис:

Сравнить(<Момент времени>)

Параметры:

<Момент времени> Обязательный

Тип: МоментВремени. Момент времени, с которым производит­ся сравнение.

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

Тип: Число. -1 - если момент времени меньше момента времени, с которым выполняется сравнение, 0 - если момент времени ра­вен моменту времени, с которым выполняется сравнение, 1 - если момент времени больше момента времени, с которым выполняет­ся сравнение.

Описание:

Позволяет сравнить момент времени с другим моментом времени.

Пример:

Момент1 = Новый МоментВремени(Док1.Дата, Док1);

Момент2 = Новый МоментВремени(Док2.Дата, Док2);

Если Момент1.Сравнить(Момент2) = -1 Тогда Момент1 = Момент2;

КонецЕсли;

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

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

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

Надпись (Label)

Надпись предназначена для размещения в форме подписей к дру­гим элементам управления, небольших поясняющих текстов, а также ссылок. Механизм ссылки позволяет связать с надписью некоторые действия, выполняемые при нажатии на неё.

НастройкаПериода ( PeriodSetting)

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

Назначение и краткая характеристика встроенного языка

Встроенный язык системы 1С:Предприятие предназначен для описания (на стадии разработки конфигурации) алгоритме! функционирования прикладной задачи.

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

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

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

Объединение запросов

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

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

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

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

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

<Объединение запросов>

ОБЪЕДИНИТЬ [ВСЕ] <Описание запроса>

[<Объединение запросов>]

Объединение запросов начинается с обязательного ключевого слова ОБЪЕДИНИТЬ, после которого следует описание присоеди­няемого запроса. Далее может присоединяться еще один запрос и т.д.

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

Пример:

Выбрать

    Накладная.Контрагент,

    Накладная.Номенклатура,

    Сумма(Накладная.Количество) Как Приход,

    Сумма(0) Как Расход

Из

    Документ.ПриходнаяНакладная.Состав Накладная

Сгруппировать По

    Контрагент,

    Номенклатура

Объединить Все

Выбрать

    Накладная.Контрагент,

    Накладная.Номенклатура,

    Сумма (0) ,

    Сумма (Накладная.Количество)

Из

    Документ.РасходнаяНакладная.Состав Накладная

Сгруппировать По

    Контрагент,

    Номенклатура

Упорядочить По

    Контрагент,

    Номенклатура

Итоги По

    Контрагент

Итоги Общие

Результат запроса:

Контрагент	Номенклатура	Приход	Расход
		1 943	151
Трикотажная фабрика «Заря»		443	4
Трикотажная фабрика «Заря»	Брюки детские		3
Трикотажная фабрика «Заря»	Брюки детские	100
Трикотажная фабрика «Заря»	Рубашка «Ковбойка»	200
Трикотажная фабрика «Заря»	Джинсы женские		1
Трикотажная фабрика «Заря»	Джинсы женские	80
Трикотажная фабрика «Заря»	Свитер детский	60
Трикотажная фабрика «Заря»	Кухонный комбайн Крупc	3
Ярмарка одежды			42
Ярмарка одежды			20
Ярмарка одежды			20
Ярмарка одежды			2
Торговый дом «Буденовский»			53
Торговый дом «Буденовский»	Брюки детские		10
Торговый дом «Буденовский»	Рубашка «Ковбойка»		5
Торговый дом «Буденовский»	Джинсы женские		12
Торговый дом «Буденовский»	Свитер детский		1
Торговый дом «Буденовский»	Раковина «Лилия»		8
Торговый дом «Буденовский»	Мойдодыр «Аквариум»		5
Торговый дом «Буденовский»	Смеситель «Ультра»		10
Торговый дом «Буденовский»	Кухонный комбайн Крупc		2
Павильон 45 на оптовом рынке			44
Павильон 45 на оптовом рынке	Рубашка «Ковбойка»		5
Павильон 45 на оптовом рынке	Джинсы женские		9
Павильон 45 на оптовом рынке	Раковина «Лилия»		10
Павильон 45 на оптовом рынке	Мойдодыр «Аквариум»		20
Бавария-фарфор		1 500	8
Бавария-фарфор	Брюки детские		7
Бавария-фарфор	Джинсы женские		1
Бавария-фарфор	Раковина «Лилия»	270
Бавария-фарфор	Мойдодыр «Аквариум»	230
Бавария-фарфор	Смеситель «Ультра»	1 000

Объект описания конфигурации

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

Таким образом, общую схему объектов метаданных конфигурации можно представить так:

<Объект описания конфигурации>     -> 

<Коллекция объектов описания метаданных>     -> 

<Объект описа­ния метаданных>     -> 

<Коллекция объектов описания метадан­ных>     -> 

<Объект описания метаданных>... и т.д.

Важно! Данному объекту доступны все свойства и методы объ­екта Объект описания метаданного.

См.также:

Глобальный контекст, свойство Метаданные.

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

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

Объявления локальных переменных

««««««««««

1С:Предприятие 8.0

»»»»»»»»»»

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

Синтаксис:

Процедура <Имя_процедуры>([[Знач] <Парам 1> [=<ДефЗнач>], ... , [Знач] <Парам N> [=<ДефЗнач>]])[Экспорт] [Далее]

// Объявления локальных переменных;

// Операторы ;

[Возврат;]

 // Операторы ;

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

Параметры:

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

Назначает имя процедуры.

Знач

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

<Парам 1>, . . . , <Парам N>

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

=<ДефЗнач>

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

Экспорт

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

модулей.

Далее

Ключевое слово обозначающее, что это предварительное описание процедуры. Если в конце описания процедуры строит это ключевое слово, тело процедуры не пишется (подробнее см. раздел «Предварительное описание процедур и функций»).

// Объявления локальных переменных

Объявляются локальные переменные, на которые можно ссылаться только в рамках этой процедуры (см. оператор Перем).

// Операторы

Исполняемые операторы процедуры.

Возврат

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

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

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

Описание:

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

При выполнении оператора Возврат процедура заканчивается и возвращает управление в точку вызова. Если в тексте процедуры не встретился оператор Возврат, то после выполнения последнего исполняемого оператора происходит выполнение неявного оператора Возврат. Конец программной секции процедуры определяется по оператору КонецПроцедуры.

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

Замечание!

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

Пример :

Перем Глоб;

// Описание процедуры

Процедура мояПроцедура(Пар1, Пар2, ПарЗ) Экспорт

    Глоб = Глоб + Пар1 + Пар2 + ПарЗ;

    Возврат;

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

Глоб = 123;

МояПроцедура(5, 6, 7); // Вызов процедуры



Функция (Function)

Синтаксис:

Функция <Имя_функции>([ [Знач] <Парам1>[=<ДефЗнач>], ... , [Знач] <ПарамN[=<ДефЗнач>]])(Экспорт] [Далее]

//Объявления локальных переменных;

// Операторы ;

Возврат <Возвращаемое значение >;

//  Операторы ;

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

Параметры :

<имя_функции>

Назначает имя функции.

Знач

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

<Парам 1>, ..., <Парам N>

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

=<ДефЗнач>

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

Экспорт

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

Далее

Ключевое слово обозначающее, что это предварительное описание функции. Если в конце описания функции строит это ключевое слово, тело функции не пишется (подробнее см. раздел «Предварительное описание процедур и функций»).

// Объявления локальных переменных

Объявляются локальные переменные, на которые можно ссылаться только в рамках этой функции (см. оператор Перем).

// Операторы

Исполняемые операторы функции.



Возврат <Возвращаемое значение>

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

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

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

Обязательное ключевое слово, обозначающее конец исходного текста функции.

Описание:

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

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

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

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

Замечание!

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

Пример:

Перем Глоб;

// Описание функции

Функция МояФункция(Пар1, Пар2, ПарЗ) Экспорт

    Глоб = Глоб + napl + Пар2 + ПарЗ;

    Возврат Глоб;

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

Глоб =123;

Рез = МояФункция(5, 6, 7); // Вызов функции

««««««««««

1С:Предприятие 8.0

»»»»»»»»»»

ОбластьЯчеекТабличногоДокумента (TableDocumentRange)

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

ОбластьЛегенды (LegendArea)

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

См. также:

Диаграмма, свойство ОбластьЛегенды.

ОбластьПостроения (PlotArea)

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

См. также:

Диаграмма, свойство ОбластьПостроения.

ОбластьЗаголовка (TitleArea)

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

См. также:

Диаграмма, свойство ОбластьЗаголовка.

ОбработкаМенеджер. <Имя обработки>

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

Полное имя типа объекта определяется с учетом имени обработки в конфигурации. Например, для обработки ОбработкаДокументов имя типа            будет выглядеть ОбработкиМенеджер.ОбработкаДокументов.

ОбработкаОбъект. < Имя обработки >

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

Обработки

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

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

ОбработкиМенеджер ( ProcessingsManager )

Объект предназначен для управления обработками и предостав­ляет доступ к значениям типа ОбработкаМенеджер. Доступ к объекту осуществляется через свойство глобального контекста Обработки.

Данный объект является коллекцией значений. В качестве эле­мента  коллекции     выступает     значение      типа ОбработкаМенеджер. <Имя обработки;». Для объекта дос­тупен обход коллекции посредством оператора Для каждого ... из ... Цикл. При обходе выбираются элементы коллекции.

См. также:

Глобальный контекст, свойство Обработки.

Обращение к свойствам объектов

Помимо  основного  обращения  через  точку,  в  языке 1С:Предприятия предусмотрен механизм обращения к свойствам объектов по строке с именем свойства с помощью оператора [] (квадратные скобки).

Синтаксис:

<Объект> [.<Имя свойства;]

Параметры:

<Объект>

Объект, к свойству которого идет обращение.

[.<Имя свойства;]

Имя свойства, к которому необходимо обратиться.

Описание:

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

Пример:

Спр = Справочники.Номенклатура.НайтиПоКоду(ИскомыйКод);

// Обращение к наименование справочника по строке с именем свойства

А = Спр["Наименование"];

// Обращение к наименованию справочника по имени свойства

А = Спр.Наименование;

// Оба эти обращения к свойству абсолютно равнозначны

---

---