1.5.2. Объект ДеревоЗначений (ValueTreeCtrl)

1.5.2.1. Создание объекта ДеревоЗначений.

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

Рис.1

При присвоении имени идентификатора диалогового элемента типа ДеревоЗначений в окне свойств диалогового элемента в модуле формы для переменной с этим именем становятся доступны методы элемента ДеревоЗначений (см. рис.2).

Рис.2.

1.5.2.2. Методы.

ВставитьЭлемент(<Имя>,<НомерКартинки>,<Родитель>), InsertItem

Назначение: Добавить новый элемент в дерево

Параметры: 

<Имя> - строковое значение элемента
<НомерКартинки> - номер картинки (0-элемент,1-группа,2-открытая группа,3-группа с плюсиком)
<Родитель> - родитель элемента (цифровой параметр, для вставки в корень дерево должно быть = 0)"},
Возвращаемое значение: числовое значение - ссылка на вставленный элемент.

ВыбратьПодчиненные(<Родитель>), SelectChildItem

Назначение: выбрать подчинённые элементы указанного родителя

Параметры: <Родитель> - числовой идентификатор элемента родителя

Возвращаемое значение: возвращает 1 если в выборке есть хотя бы один элемент, в противном случае 0.

ВыделенныйЭлемент(), SelItem

Назначение: Возвращает текущий выделенный на экране элемент.

Параметры: нет

Возвращаемое значение: числовое значение - ссылка на выделенный элемент.

Жирность(<Элемент>,<Флаг>), Bold 

Назначение: получить/установить жирность шрифта указанного элемента

Параметры: 

<Элемент> - элемент дерева
<Флаг> - 1 - жирный, 0 - нет (если параметр не задан, то метод возвращает текущее значение)

Возвращаемое значение: возвращает значение флага до исполнения метода.

ИспользоватьФлаги(<Режим>), EnableCeckBox

Назначение: Включает возможность использования флагов (или по другому пометок) в дереве при добавлении новых элементов

Параметры: <Режим> - 1-включить,0-отключить

Возвращаемое значение: значение режима до исполнения метода

КорневойЭлемент(), GetRootItem

Назначение: Получить корневой элемент дерева

Параметры: нет

Возвращаемое значение: числовое значение - ссылка на корневой элемент дерева

МетаАтрибут(<Элемент>), MetаAttribute

Назначение: Установить тип текущего элемента дерева метаданных как атрибут (т.е. свойство агрегатного типа)

Параметры: <Элемент> - числовое значение элемента дерева

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

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

МетаГруппа(<Элемент>,<Флаг>), MetаGroup

Назначение: Разрешить/запретить интерактивны ввод подчиненных элементов в дереве метаданных

Параметры: 

<Элемент> - числовое значение элемента дерева
<Флаг> - 1-разрешить ввод новых-подчиненных элементов, 0 - запретить

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

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

МетаКартинкаЭлемента(<Элемент>,<Номер>), MetаItemPicture

Назначение: Задать номер картинки для подчиненных элементов группы. Имеет смысл если элемент задан как группа.

Параметры:

<Элемент> - числовое значение элемента дерева
<Номер> - номер картинки из стандартной библиотеки картинок
Возвращаемое значение: нет

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

МетаМакет(<Элемент>), MetаMaket

Назначение: Установить тип текущего элемента дерева метаданных как макет печатной формы (при интерактивном выборе данного элемента в будет открываться макет для редактирования)

Параметры: <Элемент> - числовое значение элемента дерева

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

Замечание:
Применяется только в предопределенных процедурах режима конфигурирования для работы с деревом метаданных
Также см. методы: МетаТекст, МетаМодуль, МетаФорма, МетаАтрибут, МетаФормула

МетаМодуль(<Элемент>), MetаModule

Назначение: Установить тип текущего элемента дерева метаданных как модуль (при интерактивном выборе данного элемента в будет открываться модуль для редактирования)

Параметры: <Элемент> - числовое значение элемента дерева

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

Замечание:
Применяется только в предопределенных процедурах режима конфигурирования для работы с деревом метаданных
Также см. методы: МетаТекст, МетаМакет, МетаФорма, МетаАтрибут, МетаФормула

МетаПараметр(<Элемент>,<Параметр>), MetаParameter

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

Параметры: 

<Элемент> - числовое значение элемента дерева

<Параметр> - значение произвольного типа

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

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

МетаРедактирование(<Элемент>,<Флаг>), MetаEdit

Назначение: Разрешить/запретить редактирование элемента дерева метаданных

Параметры: 

<Элемент> - числовое значение элемента дерева

<Флаг> - 1- разрешить редактирование, 0 - запретить

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

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

МетаТекст(<Элемент>), MetаText

Назначение: Установить тип текущего элемента дерева метаданных как текстовое поле

Параметры: <Элемент> - числовое значение элемента дерева

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

Замечание:
Применяется только в предопределенных процедурах режима конфигурирования для работы с деревом метаданных
Также см. методы: МетаАтрибут,МетаМодуль,МетаФорма,МетаМакет,МетаФормула

МетаФорма(<Элемент>), MetаForm

Назначение: Установить тип текущего элемента дерева метаданных как форма (при интерактивном выборе данного элемента в будет открываться форма для редактирования)

Параметры: <Элемент> - числовое значение элемента дерева

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

Замечание:
Применяется только в предопределенных процедурах режима конфигурирования для работы с деревом метаданных
Также см. методы: МетаАтрибут,МетаМодуль,МетаТекст,МетаМакет,МетаФормула

МетаФормула(<Элемент>,<ИмяПроцедуры>), MetаFormule

Назначение: Установить тип текущего элемента дерева метаданных как исполняемую формулу (при интерактивном выборе данного элемента будет выполняться заданная процедура)

Параметры: 

<Элемент> - числовое значение элемента дерева

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

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

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

Пример:
Процедура ПриЗагрузкеКонфигурации(Дерево,ПапкаМетаданных)
    Родитель=Дерево.ВставитьЭлемент(''Меню программы'',361,ПапкаМетаданных);
    Дерево.МетаРедактирование(Родитель,0);
    Дерево.МетаГруппа(Родитель,1);
    Дерево.МетаКартинкаЭлемента(Родитель,365);
    Дерево.МетаФормула(Родитель,''НовыйЭлемент'');

    МетаМеню=СоздатьОбъект(''Метаданные'').Массив[''Метаданные''][''Меню программы''];
    Для А=1 По РазмСтр(МетаМеню) Цикл
        Имя=МетаМеню.ПолучитьПоНомеру(А);
        ТекЭлемент=Дерево.ВставитьЭлемент(Имя,365,Родитель);
        Дерево.МетаРедактирование(ТекЭлемент,1);
        Дерево.МетаГруппа(ТекЭлемент,0);
        Дерево.МетаТекст(ТекЭлемент);
        Дерево.МетаФормула(ТекЭлемент,''НовыйЭлемент'');
        Дерево.МетаПараметр(ТекЭлемент,Имя);
    КонецЦикла
КонецПроцедуры

//_________________________________________________
Процедура НовыйЭлемент(Имя)
    ОткрытьФорму(''Новое меню'',Имя);
КонецПроцедуры

Обновить(), Refresh

Назначение: Обновить изображение дерева на экране.

Параметры: нет

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

Замечание:
Эту операцию следует выполнять каждый раз после программного изменения данных дерева

ПодключитьДерево(<Дерево>), AttachTree

Назначение: Подключить дерево из другого объекта для новой циклической обработки

Параметры: <Дерево> - подключаемое дерево

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

ПолучитьДанные(), GetItemData

Назначение: Получить данные из текущего элемента дерева

Параметры: нет

Возвращаемое значение: числовое значение элемента

ПолучитьКартинку(), GetItemImage

Назначение: Получить номер картинки из текущего элемента дерева

Параметры: нет

Возвращаемое значение: числовое значение - номер картинки из библиотеки пиктограмм

ПолучитьПодчиненный(<Элемент>), GetChildItem

Назначение: Получить подчиненный элемент

Параметры: <Элемент> - числовое значение элемента дерева

Возвращаемое значение: числовое значение элемента

ПолучитьРодителя(<Элемент>), GetParentItem

Назначение: Получить родительский элемент

Параметры: <Элемент> - числовое значение дочернего элемента дерева

Возвращаемое значение: числовое значение родительского элемента

ПолучитьСледующий(<Элемент>), GetNextItem

Назначение: Получить следующий элемент

Параметры: <Элемент> - числовое значение элемента дерева

Возвращаемое значение: числовое значение следующего элемента

ПолучитьТекст(), GetItemText

Назначение: Получить текст из текущего элемента

Параметры: нет

Возвращаемое значение: строковое значение текста элемента

ПолучитьФлаг(), GetCheck

Назначение: Получить флаг (пометку) элемента

Параметры: нет

Возвращаемое значение: числовое значение флага элемента

ПолучитьЭлемент(), GetItem

Назначение: Получить элемент из выборки

Параметры: нет

Возвращаемое значение: 1 - в выборке есть элементы, 0 - нет

Разворот(<Элемент>,<Режим>), Expand

Назначение: Развернуть дерево на заданном элементе

Параметры: 

<Элемент> - числовое значение элемента дерева

<Режим> - 1 - развернуть, 0 - свернуть

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

РедактироватьТекст(), EditText

Назначение: Начать интерактивное редактирование текста текущего (выделенного) элемента дерева

Параметры: нет

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

ТекущийЭлемент(), CurrentItem

Назначение: Возвращает текущий элемент выборке, открытой методом выбора подчинённых элементов

Параметры: нет

Возвращаемое значение: числовое значение текущего элемента выборки

УдалитьВсе(), RemoveAll

Назначение: Удаляет все элементы дерева

Параметры: нет

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

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

Назначение: Удаляет заданный элемент дерева

Параметры: <Элемент> - числовое значение элемента дерева

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

УстановитьДанные(<Элемент>, <Число>), SetItemData

Назначение: Установить числовое значение заданного элемента дерева

Параметры: 

<Элемент> - числовое значение элемента дерева

<Число> - устанавливаемое значение

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

УстановитьКартинку(<Элемент>, <НомерКартинки>), SetItemImage

Назначение: Установить картинку, отображаемую при показе заданного элемента дерева

Параметры: 

<Элемент> - числовое значение элемента дерева

<НомерКартинки> - номер картинки из библиотеки пиктограмм

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

УстановитьТекст(<Элемент>, <Строка>), SetItemText

Назначение: Установить строковое значение заданного элемента дерева

Параметры: 

<Элемент> - числовое значение элемента дерева

<Строка> - строка текста, показываемая на экране для заданного элемента

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

УстановитьТипОбъекта(<Элемент>,<Ред>,<ЭтоГруппа>,<Команда>,<Картинка>,<Параметр>), SetItemImage

Назначение: Установить тип объекта в дереве метаданных - применяется только в конфигураторе в предопределенных процедурах

Параметры: 

<Элемент> - числовое значение элемента дерева

<Ред> - признак редактируемого элемента
<ЭтоГруппа> - число 0 - элемент, число1 - группа, т.е. признак ввода в составе папки подчиненных элементов с указанным ниже типом
<Команда> - числовое выражение типа объекта (от 0 до 4) или Команда - строка с именем вызываемой функции текущего модуля
Типы объектов:
0 - текст
1-атрибут (с типами)
2-модуль
3-форма
4-таблица (макет)
<Картинка> - картинка подчиненных элементов (для автоматического ввода новых элементов), если это группа
<Параметр> - произвольное значение, которое передается вызываемой функции в качестве параметра

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

Примечание:
Если определена исполняемая команда, то она вызывается каждый раз при вводе нового элемента или при нажатии кнопки Enter или выполнения двойного щелчка мышкой
Также см. методы:
МетаГруппа, МетаТекст, МетаАтрибут, МетаМодуль, МетаФорма, МетаМакет, МетаФормула, МетаКартинкаЭлемента, МетаПараметр

УстановитьФлаг(<Элемент>, <Флаг>), SetCheck

Назначение: Установить числовое значение флажка (пометки) заданного элемента дерева

Параметры: 

<Элемент> - числовое значение элемента дерева

<Флаг> - 0, пометка снята, 1- пометка установлена

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

ЭтоГруппа(), IsItAGroup

Назначение: Определяет, имеет ли текущий элемент дерева дочерние элементы 

Параметры: нет

Возвращаемое значение: 1 - имеет, 0 - нет