DimensionTree

Assembly: ExtCtrls;

Namespace: Prognoz.Platform.Interop.ExtCtrls;

Description

The DimensionTree class implements the DimensionTree development environment component 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 the style of a component border.
	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 vertex of the dimension, which index is received as an input parameter.
	ColumnClick	The ColumnClick property determines whether it is possible to display the component column headings 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 selection change in dimension.
	DropTargetNode	The DropTargetNode property determines the component node, over which a 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 dictionary dimension element filter view.
	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 mouse over.
	HotTrack	The HotTrack property determines whether the elements are underscored on mouse over.
	HotTrackAutoExpand	The HotTrackAutoExpand property determines whether the state of children tree is changed on clicking a selected element.
	Images	The Images property determines the component, images of which are used in the component.
	LevelsMultiselect	The LevelsMultiselect property determines whether multiple selection of dimension levels is enabled.
	Locked	The Locked property determines whether it is possible to change selection of elements.
	ModeElements	The ModeElements property determines the view of theOnly By Elements selection mode.
	ModeLevels	The ModeLevels property determines the view of theOnly By Levels selection mode.
	MultipleAttributes	The MultipleAttributes property determines whether several dictionary attributes are displayed.
	MultiSelect	Outdated.Use SelectionMode.
	OwnSelection	The OwnSelection property determines whether the own 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 vertices 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 the hint is displayed when hovering the mouse pointer on a component element.
	ShowLines	The ShowLines property determines whether the connecting line between a vertex 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 that determine the percentage of the size change for the current component when the parent component is resized.
	Brush	The Brush property specifies the brush 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 the background color of a component.
	Cursor	The Cursor property determines how the cursor looks like when you hover over a component during form execution.
	Enabled	The Enabled property determines whether a component is available for a user.
	Focused	The Focused property returns True if the focus is set on the component.
	Font	The Font property defines the parameters of the font used to display text in a component.
	Height	The Height property determines the component height (pixels).
	HelpContext	The HelpContext property determines the unique index for a section of a context help for this component.
	Hint	The Hint property determines the tip text displayed if the mouse pointer is hovered over a component.
	HintTimeout	The HintTimeout determines the time for which the tooltip is displayed.
	Left	The Left property determines the coordinate of the component left edge (pixels).
	Parent	The Parent property determines the 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 should use 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 using the right mouse button.
	Scrolls	The Scrolls property returns parameters of component's scroll bars.
	ShowHint	The ShowHint property determines whether a tool tip should be displayed when you hover over a component.
	TabOrder	The TabOrder property determines the position of a component in a tab order.
	TabStop	The TabStop property determines whether the focus is set to a component when the Tab button is pressed.
	Text	The Text property determines the row identifying a component for a user.
	Top	The Top property determines the coordinate of the component upper edge (pixels).
	Visible	The Visible property determines whether a component is displayed when a form is executed.
	Width	Свойство Width определяет ширину компонента в пикселях.

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, the index of which 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 of the DimensionTree component elements.

Methods inherited from IDimensionViewer

	Method name	Brief description
	AdjustWidth	The AdjustWidth method is used to automatically fit a column based on 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 is 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 the coordinates of a point specified relative to the component coordinate system to screen coordinates.
	DoDragDrop	The DoDragDrop method enables to start drag-and-drop operation.
	GetImage	The GetImage method returns a graphic presentation of a component together with all children.
	ScreenToClient	The ScreenToClient method converts screen coordinates of a point to coordinates specified relative to the component 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 the collapsing of the hierarchy of the tree node children.
	OnCollapsing	The OnCollapsing event occurs before the collapsing of 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 during comparing two elements during the 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 the hint 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 a component, when a user starts to drag an object from the component.
	OnClick	The OnClick event occurs if a user clicks a component area using the main mouse button.
	OnControlMove	The OnControlMove event occurs when a component is moved.
	OnControlResize	The OnControlResize event occurs when a component is resized.
	OnDblClick	The OnDblClick event occurs if a user double-clicks a component area using the mouse button.
	OnDragDrop	The OnDragDrop event occurs for a component if a user drops a dragged object over it.
	OnDragEnter	The OnDragEnter event occurs when a dragged object crosses the borders of this component.
	OnDragLeave	The OnDragLeave event occurs when a dragged object leaves the borders of this component.
	OnDragOver	The OnDragOver event occurs for this component when a user drags a dragged object over it.
	OnEnter	The OnEnter event occurs when a component receives focus.
	OnExit	The OnExit event occurs when a component loses focus.
	OnHScroll	The OnHScroll event occurs when the horizontal scrollbar thumb changes its position.
	OnKeyDown	The OnKeyDown event occurs if a component is focused and a keyboard key is pressed.
	OnKeyPress	The OnKeyPress event occurs if a component is focused when a user presses a character key.
	OnKeyPreview	The OnKeyPreview event occurs prior to each event requiring clicking.
	OnKeyUp	The OnKeyUp event occurs if a component is focused and a user releases any button previously pressed.
	OnMouseDown	The OnMouseDown event occurs if the pointer is in component's 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 the 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 on moving the cursor over component.
	OnMouseUp	The OnMouseUp event occurs on releasing mouse button when the pointer is in component area.
	OnMouseWheel	The OnMouseWheel event occurs if the component has focus when the mouse wheel is rotated.
	OnVScroll	The OnVScroll event occurs when the vertical scrollbar thumb changes its position.

See also:

ExtCtrls Assembly Classes