DimensionTree

Assembly: ExtCtrls;

Namespace: Prognoz.Platform.Interop.ExtCtrls;

Description

The DimensionTree class implements the DimensionTree development environment component that is used to display dictionary data as a tree.

Comments

To work with the DimensionCombo component, use the DimensionCombo class.

Fore.NET Syntax

Class to get analog of the DimensionTree class:

None;

Class to get analog of the DimensionTree class object:

DimensionTreeClass;

Properties inherited from IDimensionViewer

	Property name	Brief description
	AdjustWidthOnlyVisible	The AdjustWidthOnlyVisible property determines the mode of auto adjusting column width.
	AttributeSeparator	The AttributeSeparator property determines a separator between attribute names.
	AutoCheckParent	The AutoCheckParent property determines whether the parent nodes of the component automatically receive an indefinite state, if not all of the child elements are selected.
	AutoExpandDepth	The AutoExpandDepth property determines the number of the dimension level, which are automatically expanded, when the form is launched.
	BorderStyle	The BorderStyle property determines a component border style.
	Checkboxes	The Checkboxes property determines whether the component elements have checkboxes.
	Checked	The Checked property determines whether the dimension element, the index of which is received as an input parameter, is selected.
	CheckState	The CheckState property determines the status of the dimension node.
	ColumnClick	The ColumnClick property determines whether component column headers can be displayed as buttons.
	Columns	The Columns property returns the component columns collection.
	Dimension	The Dimension property determines a data source of the component.
	DimGroup	The DimGroup property determines the dictionary elements group, based on which an element tree in the component is built.
	DimUpdateTimer	The DimUpdateTimer property determines delay between element selection and changing selection in dimension.
	DropTargetNode	The DropTargetNode property determines the component node, over which the user is currently dragging another node.
	ElementsActive	The ElementsActive property switches between the Be Elements and Be Levels selection modes.
	EnableFilter	The EnableFilter property determines whether the field for dimension element filtering is displayed.
	EnableFindDialog	The EnableFindDialog property determines whether the standard element search dialog is called when the CTRL+F key combination or F3 key is pressed.
	EndDate	The EndDate property determines the period end of data range.
	FindMode	The FindMode property determines selection mode of found elements.
	FocusedElement	The FocusedElement property determines the index of the focused dimension element.
	GridLines	The GridLines property determines whether grid is displayed.
	HideSelection	The HideSelection property determines whether the selection is displayed in the component, when the focus goes to another component.
	HighlightTrack	The HighlightTrack property determines whether the element is highlighted on mouseover.
	HotTrack	The HotTrack property determines whether the elements are underlined on mouseover.
	HotTrackAutoExpand	The HotTrackAutoExpand property determines whether the state of child elements tree is changed on clicking the selected element.
	Images	The Images property determines the component, which images are used in the component.
	LevelsMultiselect	The LevelsMultiselect property determines whether multiple selection of dimension levels is enabled.
	Locked	The Locked property determines whether selection of elements can be changed.
	ModeElements	The ModeElements property determines the view of the By Elements Only selection mode.
	ModeLevels	The ModeLevels property determines the view of the By Levels Only selection mode.
	MultipleAttributes	The MultipleAttributes property determines whether several dictionary attributes are displayed.
	MultiSelect	Outdated.Use SelectionMode.
	OwnSelection	The OwnSelection property determines whether the proper selection of component elements is used.
	RowSelect	The RowSelect property determines whether the whole row is highlighted when an element is selected.
	Selection	The Selection property determines elements selection.
	SelectionMode	The SelectionMode property determines the mode of selecting component elements.
	ShowButtons	The ShowButtons property determines whether the nodes children tree expanding and collapsing buttons are displayed.
	ShowColumnHeaders	The ShowColumnHeaders property determines whether column headers are displayed.
	ShowHeaderButton	The ShowHeaderButton property determines the button that opens column headers menu is displayed.
	ShowHints	The ShowHints property determines whether a hint is displayed when hovering the mouse cursor over one of the component elements.
	ShowLines	The ShowLines property determines whether the connecting line between a node and its children is displayed.
	ShowRoot	The ShowRoot property determines whether the tree root elements expanding and collapsing buttons are displayed.
	SortColumn	The SortColumn property determines the index of the column, by which sorting is executed.
	Sorted	The Sorted property determines whether the values can be sorted by column specified in the SortColumn property.
	SortType	The SortType property determines the component sorting type.
	StartDate	The StartDate property determines start of the data range period.
	UseSystemImages	The UseSystemImages property determines whether system icons are used.

Properties inherited from IControl

	Property name	Brief description
	Align	The Align property determines component alignment within its parent component.
	AllowDrag	The AllowDrag property determines whether an object can be dragged from a component.
	AllowDrop	The AllowDrop property determines whether the component can accept a dragged object.
	Anchors	The Anchors property returns settings determining % of the resize for the current component when the parent component is resized.
	Brush	The Brush property determines the brush that is used to fill the component area.
	ClientHeight	The ClientHeight property determines the height of the client component area.
	ClientWidth	The ClientWidth property determines the width of the client component area.
	Color	The Color property determines color of the component background.
	Cursor	The Cursor property determines how the cursor looks like when is it hovered over a component during form execution.
	Enabled	The Enabled property determines whether a component is available for the user.
	Focused	The Focused property returns True if the focus is set to the component.
	Font	The Font property determines parameters of the font that is used to display text in the component.
	Height	The Height property determines component height in pixels.
	HelpContext	The HelpContext property determines a unique index for a section of a context help for this component.
	Hint	The Hint property determines a tooltip text displayed on hovering over the component.
	HintTimeout	The HintTimeout property determines for how long a tooltip is displayed.
	Left	The Left property determines a coordinate of the component left edge in pixels.
	Parent	The Parent property determines a parent component.
	ParentColor	The ParentColor property determines whether a component inherits the color of the parent component.
	ParentFont	The ParentFont property determines whether a component uses the font of the parent component.
	ParentShowHint	The ParentShowHint property determines when a tooltip is displayed.
	PopupMenu	The PopupMenu property determines the context menu displayed when a component is clicked with the right mouse button.
	Scrolls	The Scrolls property returns parameters of component's scrollbars.
	ShowHint	The ShowHint property determines whether a tooltip is displayed when the component is hovered.
	TabOrder	The TabOrder property determines a component position in a tab order.
	TabStop	The TabStop property determines whether the component must be focused when the Tab button is pressed.
	Text	The Text property determines a row identifying a component for the user.
	Top	The Top property determines a coordinate of the component top edge in pixels.
	Visible	The Visible property determines whether the component is displayed when a form is executed.
	Width	The Width property sets component width in pixels.

Properties inherited from IComponent

	Property name	Brief description
	ComponentCount	The ComponentCount property returns the number of child components located on the parent component.
	Components	The Components property returns a child component, which index is passed via the input parameter.
	Data	The Data property is used to store any custom data.
	Name	The Name property determines the component name.
	Tag	The Tag property is not used by the compiler. The user can change the value of this property and use it at his discretion.

Methods inherited from IDimensionTree

	Method name	Brief description
	ShowFindDialog	The ShowFindDialog method opens the dialog box for searching DimensionTree component elements.

Methods inherited from IDimensionViewer

	Method name	Brief description
	AdjustWidth	The AdjustWidth method adjusts automatically width of the column taking into account its contents.
	Collapse	The Collapse method collapses the tree children hierarchy.
	Expand	The Expand method expands the tree children hierarchy.
	GetCheckedNodes	The GetCheckedNodes method returns the collection of the elements, for which the flag is set.
	GetItemAt	The GetItemAt method checks if there is an element in the specified point of client component area.
	HitTest	The HitTest method checks if there is an element in the specified point of client component area and returns check result.
	MakeVisible	The MakeVisible method scrolls the elements tree in such a way, that the specified element fits into the visible area of a component.
	Sort	The Sort method sorts by the values of the specified column.
	SortDefault	The SortDefault method sorts by the values of the column, index of which is specified in the SortColumn property.

Methods inherited from IControl

	Method name	Brief description
	BringToFront	Outdated. The BringToFront method brings a component to the foreground.
	ClientToScreen	The ClientToScreen method converts point coordinates specified relative to the component's coordinate system into screen coordinates.
	DoDragDrop	The DoDragDrop method enables the user to start dragging operation.
	GetImage	The GetImage method returns a graphic presentation of a component together with all child components.
	ScreenToClient	The ScreenToClient method converts point's screen coordinates into coordinates specified relative to the component's coordinate system.
	SendToBack	Outdated. The SendToBack method is used to send a component to the background.
	SetFocus	The SetFocus method sets focus to this component.

Events inherited from IDimensionViewer

	Event name	Brief description
	OnChecked	The OnChecked event occurs after changing the Checked status.
	OnChecking	The OnChecking event occurs before changing the Checked status.
	OnCollapsed	The OnCollapsed event occurs after collapsing the hierarchy of the tree node children.
	OnCollapsing	The OnCollapsing event occurs before collapsing the hierarchy of the tree node children.
	OnColumnClick	The OnColumnClick event occurs on clicking on one of the component columns.
	OnCompareItems	The OnCompareItems event occurs on comparing two elements during user element sorting.
	OnExpanded	The OnExpanded event occurs after expanding the hierarchy of tree node children.
	OnExpanding	The OnExpanding event occurs directly before expanding the tree node children hierarchy.
	OnFocusedChanged	The OnFocusedChanged event occurs on moving the focus to another component element.
	OnGetHint	The OnGetHint event occurs on appearing a tooltip over the element, over which the mouse cursor is hovered.
	OnGetNodeImage	The OnGetNodeImage event is used on determining an image near the tree node.
	OnHover	The OnHover event occurs when a mouse cursor hovers over the element and the element is underlined.
	OnSelectionChanged	The OnSelectionChanged event occurs on changing the selection of the component element.

Events inherited from IControl

	Event name	Brief description
	OnBeginDrag	The OnBeginDrag event occurs for the component when the user starts to drag an object from the component.
	OnClick	The OnClick event occurs if the user clicks the component area with the main mouse button.
	OnControlMove	The OnControlMove event occurs when the component is moved.
	OnControlResize	The OnControlResize event occurs when the component is resized.
	OnDblClick	The OnDblClick event occurs if the user double-clicks the component area with the mouse button.
	OnDragDrop	The OnDragDrop event occurs for the component if the user drops a dragged object over it.
	OnDragEnter	The OnDragEnter event occurs when a dragged object enters the component area.
	OnDragLeave	The OnDragLeave event occurs when a dragged object leaves component borders.
	OnDragOver	The OnDragOver event occurs for the component when the user drags an object over it.
	OnEnter	The OnEnter event occurs when the component receives focus.
	OnExit	The OnExit event occurs when the component loses focus.
	OnHScroll	The OnHScroll event occurs when horizontal scrollbar slider changes its position.
	OnKeyDown	The OnKeyDown event occurs if the component is focused and a keyboard key is pressed.
	OnKeyPress	The OnKeyPress event occurs if the component is focused when the user presses a character key.
	OnKeyPreview	The OnKeyPreview event occurs prior to each event related to key pressing.
	OnKeyUp	The OnKeyUp event occurs if the component is focused and the user releases any button previously pressed.
	OnMouseDown	The OnMouseDown event occurs if the pointer is in the component area and a mouse key is pressed.
	OnMouseEnter	The OnMouseEnter event occurs when mouse cursor enters the component area.
	OnMouseHover	The OnMouseHover event occurs when mouse cursor is held in the component area.
	OnMouseLeave	The OnMouseLeave event occurs when mouse cursor leaves the component area.
	OnMouseMove	The OnMouseMove event occurs when the cursor is moved over the component.
	OnMouseUp	The OnMouseUp event occurs when the mouse button is released and the cursor is in the component area.
	OnMouseWheel	The OnMouseWheel event occurs if the component is focused when the user rotates a mouse wheel.
	OnVScroll	The OnVScroll event occurs when vertical scrollbar slider changes its position.

See also:

ExtCtrls Assembly Classes