DimensionTree

Assembly: 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.

Properties inherited from IDimensionTree

  Property name Brief description
Expanded The Expanded property determines whether a tree node hierarchy is expanded or collapsed.

Properties inherited from IDimensionViewer

  Property name Brief description
The AdjustWidthOnlyVisible property determines the mode of auto adjusting column width.
The AttributeSeparator property determines a separator between attribute names.
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.
The AutoExpandDepth property determines the number of the dimension level, which are automatically expanded, when the form is launched.
The BorderStyle property determines a component border style.
The Checkboxes property determines whether the component elements have checkboxes.
The Checked property determines whether the dimension element, the index of which is received as an input parameter, is selected.
The CheckState property determines the status of the dimension node.
The ColumnClick property determines whether component column headers can be displayed as buttons.
The Columns property returns the component columns collection.
The Dimension property determines a data source of the component.
The DimGroup property determines the dictionary elements group, based on which an element tree in the component is built.
The DimUpdateTimer property determines delay between element selection and changing selection in dimension.
The DropTargetNode property determines the component node, over which the user is currently dragging another node.
The ElementsActive property switches between the Be Elements and Be Levels selection modes.
The EnableFilter property determines whether the field for dimension element filtering is displayed.
The EnableFindDialog property determines whether the standard element search dialog is called when the CTRL+F key combination or F3 key is pressed.
The EndDate property determines the period end of data range.
The FindMode property determines selection mode of found elements.
The FocusedElement property determines the index of the focused dimension element.
The GridLines property determines whether grid is displayed.
The HideSelection property determines whether the selection is displayed in the component, when the focus goes to another component.
The HighlightTrack property determines whether the element is highlighted on mouseover.
The HotTrack property determines whether the elements are underlined on mouseover.
The HotTrackAutoExpand property determines whether the state of child elements tree is changed on clicking the selected element.
The Images property determines the component, which images are used in the component.

The LevelsMultiselect property determines whether multiple selection of dimension levels is enabled.

The Locked property determines whether selection of elements can be changed.
The ModeElements property determines the view of the By Elements Only selection mode.
The ModeLevels property determines the view of the By Levels Only selection mode.
The MultipleAttributes property determines whether several dictionary attributes are displayed.
The OwnSelection property determines whether the proper selection of component elements is used.
The RowSelect property determines whether the whole row is highlighted when an element is selected.
The Selection property determines elements selection.
The SelectionMode property determines the mode of selecting component elements.
The ShowButtons property determines whether the nodes children tree expanding and collapsing buttons are displayed.
The ShowColumnHeaders property determines whether column headers are displayed.
The ShowHeaderButton property determines the button that opens column headers menu is displayed.
The ShowHints property determines whether a hint is displayed when hovering the mouse cursor over one of the component elements.
The ShowLines property determines whether the connecting line between a node and its children is displayed.
The ShowRoot property determines whether the tree root elements expanding and collapsing buttons are displayed.
The SortColumn property determines the index of the column, by which sorting is executed.
The Sorted property determines whether the values can be sorted by column specified in the SortColumn property.
The SortType property determines the component sorting type.
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 the 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
The ClientToScreen method converts point coordinates specified relative to the component's coordinate system into screen coordinates.
The DoDragDrop method enables the user to start dragging operation.
The GetImage method returns a graphic presentation of a component together with all child components.
The ScreenToClient method converts point's screen coordinates into coordinates specified relative to the component's coordinate system.
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
The OnBeginDrag event occurs for the component when the user starts to drag an object from the component.
The OnClick event occurs if the user clicks the component area.
The OnControlMove event occurs when the component is moved.
The OnControlResize event occurs when the component is resized.
The OnDblClick event occurs if the user double-clicks the component area.
The OnDragDrop event occurs for the component if the user drops a dragged object over it.
The OnDragEnter event occurs when a dragged object enters the component area.
The OnDragLeave event occurs when a dragged object leaves component borders.
The OnDragOver event occurs for the component when the user drags an object over it.
The OnEnter event occurs when the component receives focus.
The OnExit event occurs when the component loses focus.
The OnHScroll event occurs when horizontal scrollbar slider changes its position.
The OnKeyDown event occurs if the component is focused and a keyboard key is pressed.
The OnKeyPress event occurs if the component is focused when the user presses a character key.
The OnKeyPreview event occurs prior to each event related to key pressing.
The OnKeyUp event occurs if the component is focused and the user releases any button previously pressed.
The OnMouseDown event occurs if the pointer is in the component area and a mouse key is pressed.
The OnMouseEnter event occurs when mouse cursor enters the component area.
The OnMouseHover event occurs when mouse cursor is held in the component area.
The OnMouseLeave event occurs when mouse cursor leaves the component area.
The OnMouseMove event occurs when the cursor is moved over the component.
The OnMouseUp event occurs when the mouse button is released and the cursor is in the component area.
The OnMouseWheel event occurs if the component is focused when the user rotates a mouse wheel.
The OnVScroll event occurs when vertical scrollbar slider changes its position.

See also:

ExtCtrls Assembly Classes