DimensionTree

Иерархия наследования

Описание

Компонент DimensionTree предназначен для отображения данных справочника в виде дерева.

Работа с компонентом

Отметка элементов компонента осуществляется при щелчке, как по пиктограмме элемента, так и по самому элементу, либо нажатием клавиши ПРОБЕЛ. Источником данных для компонента DimensionTree является компонент UiDimension.

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

Поиск элементов

В компоненте предусмотрены следующие виды поиска:

При наборе первых символов в наименовании элементов курсор будет переходить к первому найденному элементу. Данный поиск осуществляется циклически и только по элементам, присутствующим в развернутой части иерархии дерева элементов.
При помощи диалога поиска, который вызывается при нажатии сочетания клавиш CTRL+F. После ввода текста и нажатия клавиши ENTER либо кнопки «Найти далее» будет произведен поиск. Поиск осуществляется циклически по всей иерархии элементов. В зависимости от значения свойства FindMode найденный элемент будет сфокусирован либо отмечен. Добавление элементов в отметку производится при нажатии клавиши ПРОБЕЛ либо с помощью мыши при зажатой клавише CTRL (Способ отметки зависит от режима множественной отметки). Кнопка «Дополнительно» позволяет определить расширенные настройки поиска. Кнопка «Найти все» производит поиск всех элементов, удовлетворяющих условиям поиска. Список найденных элементов будет отображен в нижней части диалога. Отметка элементов в списке приведет к отметке элементов в компоненте. Если найденные элементы уже включены в отметку компонента, то они также будут отмечены и в списке. Режим отметки в списке соответствует режиму отметки в компоненте.

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

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

Сортировка данных

Необходимым условием для сортировки данных является установка свойствам ShowColumnHeaders, Sorted и ColumnClick значения True, и свойству SortType значения, отличного от None.

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

Также осуществить настройку сортировки можно в специализированном окне «Сортировка»:

Данное окно появляется при выборе соответствующего пункта контекстного меню, вызываемого в области заголовков колонок.

Примечание. Пункт контекстного меню будет доступен, если свойствам ShowColumnHeaders и Sorted установлено значения True, а свойству SortType значение, отличное от None.

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

В языке Fore для применения сортировки необходимо установить свойству Sorted значение True и свойству SortType значение, отличное от None. Колонка, по данным которой осуществляется сортировка, указывается в свойстве SortColumn. Направление сортировки определяется в свойстве SortAscending соответствующего столбца.

Также для управления сортировкой могут применяться методы Sort и SortDefault.

Отображение нескольких атрибутов справочника

По умолчанию в компоненте отображаются значения атрибута с назначением - «Наименование». Для отображения других атрибутов необходимо свойству ShowColumnHeaders установить значение True и настроить коллекцию столбцов компонента. Для настройки коллекции нажмите кнопку в области свойства Columns или выполните пункт контекстного меню «Колонки». По умолчанию список столбцов соответствует списку атрибутов в структуре справочника. Для столбцов, которые должны отображаться, установите в свойстве Visible значение True. По умолчанию значение этого свойства выставляется в соответствии со значением свойства Visible (Hidden для справочников НСИ) атрибута, с которым связан столбец.

Пример

Свойства компонента DimensionTree

	Имя свойства	Краткое описание
	Align	Свойство Align определяет, как поведет себя компонент при изменении размеров содержащего его родительского компонента.
	AllowDrag	Свойство AllowDrag определяет возможность взять у компонента перетаскиваемый объект.
	AllowDrop	Свойство AllowDrop определяет, будет ли возможность у компонента принять перетаскиваемый объект.
	Anchors	Свойство Anchors возвращает настройки, определяющие в процентном соотношении изменение размеров текущего компонента при изменении размеров родительского компонента.
	AutoCheckParent	Свойство AutoCheckParent определяет, будет ли у родительских вершин компонента автоматически устанавливаться неопределенное состояние, если отмечены не все дочерние элементы.
	AutoExpandDepth	Свойство AutoExpandDepth определяет номер уровня измерения, который будет автоматически разворачиваться при запуске формы на выполнение.
	BorderStyle	Свойство BorderStyle определяет стиль границы компонента.
	Brush	Свойство Brush определяет кисть, используемую для заливки области компонента.
	Checkboxes	Свойство Checkboxes определяет видимость флагов у элементов компонента.
	Checked	Свойство Checked определяет признак установки флага у элемента измерения.
	CheckState	Свойство CheckState определяет состояние вершины измерения.
	ClientHeight	Свойство ClientHeight используется для получения или задания высоты клиентской области компонента.
	ClientWidth	Свойство ClientWidth используется для получения или задания ширины клиентской области компонента.
	Color	Свойство Color определяет цвет фона компонента.
	ColumnClick	Свойство ColumnClick определяет возможность отображения заголовков столбцов в виде кнопок.
	Columns	Свойство Соlumns возвращает коллекцию столбцов компонента.
	ComponentCount	Свойство ComponentCount возвращает количество дочерних компонентов.
	Components	Свойство Components возвращает дочерний компонент.
	Cursor	Свойство Cursor определяет вид курсора над компонентом.
	Data	Свойство Data предназначено для хранения любых пользовательских данных.
	Dimension	Свойство Dimension определяет наименование компонента UiDimension , который будет являтся источником данных для компонента.
	DimGroup	Свойство DimGroup определяет группу элементов справочника, на базе которой будет строиться дерево элементов в компоненте.
	DimUpdateTimer	Свойство DimUpdateTimer определяет задержку между выделением элементов и сменой отметки в измерении.
	DropTargetNode	Свойство DropTargetNode определяет индекс элемента измерения, который подсвечен.
	Enabled	Свойство Enabled определяет доступность компонента для пользователя.
	EnableFindDialog	Свойство EnableFindDialog определяет, будет ли вызываться стандартный диалог поиска элементов при нажатии сочетания клавиш CTRL+F или F3.
	FindMode	Свойство FindMode определяет режим отметки найденных элементов.
	Focused	Свойство Focused возвращает True, если фокус установлен на данном компоненте.
	FocusedElement	Свойство FocusedElement определяет индекс элемента измерения, на котором установлен фокус.
	Font	Свойство Font определяет множество характеристик, описывающих шрифт, используемый при отображении текста.
	GridLines	Свойство GridLines определяет, будет ли отображаться сетка.
	Height	Свойство Height определяет высоту компонента.
	HelpContext	Свойство HelpContext определяет уникальный индекс раздела контекстно-зависимой справки для данного компонента.
	HideSelection	Свойство HideSelection определяет признак отображения отметки в компоненте при передаче фокуса другому компоненту.
	Hint	Свойство Hint определяет текст подсказки для компонента.
	HotTrack	Свойство HotTrack определяет признак выделения подчеркиванием элемента, над которым проходит указатель мыши.
	HotTrackAutoExpand	Свойство HotTrackAutoExpand определяет признак изменения состояния дерева дочерних элементов при щелчке по выделенному элементу.
	Images	Свойство Images определяет имя компонента ImageList , изображения которого будут использоваться в компоненте.
	Left	Свойство Left определяет координату левого края компонента.
	Locked	Свойство Locked определяет возможность изменения отметки элементов в компоненте.
	Name	Свойство Name определяет наименование компонента.
	OwnSelection	Свойство OwnSelection определяет необходимость создания копии массива выделения.
	Parent	Свойство Parent определяет родительский компонент.
	ParentColor	Свойство ParentColor определяет, будет ли для компонента заимствован цвет родительского компонента.
	ParentFont	Свойство ParentFont определяет, будет ли для компонента использоваться шрифт родительского компонента.
	ParentShowHint	Свойство ParentShowHint определяет условие отображения всплывающей подсказки.
	PopupMenu	Свойство PopupMenu определяет контекстное меню, которое будет появляться по щелчку дополнительной кнопки мыши на компоненте.
	RowSelect	Свойство RowSelect определяет необходимость выделения выбранного элемента подсветкой всей строки.
	Scrolls	Свойство Scrolls возвращает параметры полос прокрутки компонента.
	Selection	Свойство Selection определяет отметку элементов в измерении.
	SelectionMode	Свойство SelectionMode определяет режим отметки элементов в компоненте.
	ShowButtons	Свойство ShowButtons разрешает или запрещает показ кнопок разворачивания и сворачивания дерева потомков вершин.
	ShowColumnHeaders	Свойство ShowColumnHeaders определяет, будут ли отображаться заголовки столбцов.
	ShowHint	Свойство ShowHint включает и выключает показ всплывающего окна подсказки для компонента.
	ShowHints	Свойство ShowHints определяет, будет ли появляться подсказка при задержке мыши над одним из элементов компонента.
	ShowLines	Свойство ShowLines определяет, будет ли отображаться линия, соединяющая вершину с ее потомками.
	ShowRoot	Свойство ShowRoot определяет, будут ли отображаться кнопки сворачивания и разворачивания корней деревьев.
	SortColumn	Свойство SortColumn определяет индекс столбца, по которому будет осуществляться сортировка.
	Sorted	Свойство Sorted определяет возможность сортировки по столбцу, указанному в свойстве SortColumn .
	SortType	Свойство SortType определяет тип сортировки для компонента.
	TabOrder	Свойство TabOrder определяет позицию компонента в последовательности табуляции.
	TabStop	Свойство TabStop определяет признак необходимости компоненту получать фокус при нажатии кнопки «TAB».
	Tag	Свойство Tag не используется компилятором. Пользователь может изменить значение свойства Tag и использовать его по своему усмотрению.
	Text	Свойство Text определяет строку, идентифицирующую компонент для пользователя.
	Top	Свойство Top определяет координату верхнего края компонента.
	Visible	Свойство Visible определяет видимость компонента во время выполнения.
	Width	Свойство Width определяет ширину компонента.

Методы компонента DimensionTree

	Имя метода	Краткое описание
	AdjustWidth	Метод AdjustWidth осуществляет автоматический подгон ширины колонки с учетом её содержимого.
	BringToFront	Метод BringToFront располагает компонент на передний план.
	ClientToScreen	Метод ClientToScreen преобразовывает координаты точки, указанные относительно системы координат компонента, в экранные координаты.
	Collapse	Метод Collapse осуществляет сворачивание иерархии потомков дерева.
	DoDragDrop	Метод DoDragDrop позволяет начать операцию перетаскивания.
	Expand	Метод Expand осуществляет разворачивание иерархии потомков дерева.
	GetCheckedNodes	Метод GetCheckedNodes возвращает коллекцию элементов, отмеченных флагом.
	GetImage	Метод GetImage возвращает изображение компонента со всеми дочерними компонентами.
	GetItemAt	Метод GetItemAt осуществляет проверку наличия элемента в заданной точке клиентской области компонента.
	HitTest	Метод HitTest осуществляет проверку наличия элемента в заданной точке клиентской области компонента и возвращает результат проверки.
	MakeVisible	Метод MakeVisible позволяет сделать видимым конкретный элемент.
	ScreenToClient	Метод ScreenToClient преобразовывает экранные координаты точки в координаты, указываемые относительно системы координат компонента.
	SendToBack	Метод SendToBack располагает компонент на задний план.
	SetFocus	Метод SetFocus устанавливает фокус на данный компонент.
	ShowFindDialog	Метод ShowFindDialog инициализирует диалог поиска элементов компонента.
	Sort	Метод Sort выполняет сортировку по значениям указанного столбца.
	SortDefault	Метод SortDefault выполняет сортировку по значениям столбца, индекс которого указан в свойстве SortColumn .

События компонента DimensionTree

	Имя события	Краткое описание
	OnBeginDrag	Событие OnBeginDrag для компонента наступает, когда пользователь начинает перетаскивать объект от компонента.
	OnChecked	Событие OnChecked наступает после изменения состояния отметки флага элемента.
	OnChecking	Событие OnChecking наступает перед изменением состояния отметки флага элемента.
	OnClick	Событие OnClick наступает, если пользователь щёлкнул в области компонента.
	OnCollapsed	Событие OnCollapsed наступает после свертывания иерархии потомков вершины дерева.
	OnCollapsing	Событие OnCollapsing наступает начале свертывания иерархии потомков вершины дерева.
	onColumnClick	Событие OnColumnClick наступает при щелчке кнопкой мыши по одному из столбцов компонента.
	OnCompareItems	Событие OnCompareItems наступает при сравнении двух элементов во время пользовательской сортировки элементов.
	OnDblClick	Событие OnDblClick наступает, если пользователь дважды щёлкнул в области компонента.
	OnDragDrop	Событие OnDragDrop для компонента наступает, когда пользователь отпускает над ним перетаскиваемый объект.
	OnDragEnter	Событие OnDragEnter наступает, когда перетаскиваемый объект входит в область данного компонента.
	OnDragLeave	Событие OnDragLeave наступает, когда перетаскиваемый объект выходит за границы данного компонента.
	OnDragOver	Событие OnDragOver для компонента наступает, когда пользователь протаскивает над ним перетаскиваемый объект.
	OnEnter	Событие OnEnter наступает в момент получения фокуса компонентом.
	OnExit	Событие OnExit наступает в момент потери фокуса компонентом.
	OnExpanded	Событие OnExpanded наступает после развертывания иерархии потомков вершины дерева.
	OnExpanding	Событие OnExpanding наступает непосредственно перед развертыванием иерархии потомков вершины дерева.
	OnFocusedChanged	Событие OnFocusedChanged наступает при передаче фокуса другому элементу компонента.
	OnGetHint	Событие OnGetHint наступает при появлении подсказки над элементом, где остановился курсор мыши.
	OnGetNodeImage	Событие OnGetNodeImage используется при определении изображения возле элемента дерева.
	OnHover	Событие OnHover наступает в момент прохождения курсора мыши над элементом и отметки подчеркиванием элемента компонента.
	OnHScroll	Событие OnHScroll наступает при изменении положения ползунка горизонтальной полосы прокрутки.
	OnKeyDown	Событие OnKeyDown наступает, если компонент находится в фокусе и производится нажатие на клавиатуру.
	OnKeyPress	Событие OnKeyPress наступает, если компонент находится в фокусе, при нажатии пользователем символьной клавиши.
	OnKeyPreview	Событие OnKeyPreview наступает перед каждым событием, связанным с нажатием клавиш.
	OnKeyUp	Событие OnKeyUp наступает, если компонент находится в фокусе, при отпускании пользователем любой, ранее нажатой клавиши.
	OnMouseDown	Событие OnMouseDown наступает, если указатель находится в области компонента и была нажата любая кнопка мыши.
	OnMouseEnter	Событие OnMouseEnter наступает в момент входа курсора мыши в область компонента.
	OnMouseHover	Событие OnMouseHover наступает при задержке курсора мыши в области компонента.
	OnMouseLeave	Событие OnMouseLeave наступает в момент выхода курсора мыши за пределы области компонента.
	OnMouseMove	Событие OnMouseMove наступает при перемещении курсора мыши над компонентом.
	OnMouseUp	Событие OnMouseUp наступает при отпускании кнопки мыши, когда указатель находится в области компонента.
	OnMouseWheel	Событие OnMouseWheel наступает, если компонент находится в фокусе при вращении колеса мыши.
	OnSelectionChanged	Событие OnSelectionChanged наступает при изменении отметки элементов компонента.
	OnVScroll	Событие OnVScroll наступает при изменении положения ползунка вертикальной полосы прокрутки.

См. также:

Компоненты доступа к данным