DimensionCombo

Description

The DimensionCombo class implements the DimensionCombo development environment component used to display dictionary elements viewed as a dropdown list.

Properties inherited from IDimensionCombo

   Property name Brief description
AnimationType The AnimationType property determines type of animation to be used when component's list is being unfolded.
AutoUpdateInfo The AutoUpdateInfo property determines whether information on selection in the component editor is updated automatically.
CancelOnEscape The CancelOnEscape property determines whether the selection should be cancelled, and the list - closed, when the Escape key is pressed.
CloseOnClick The CloseOnClick property determines whether the list should be automatically closed, when one of the elements is selected.
CloseOnEnter The CloseOnEnter property determines whether the list should be closed, and the selection is saved when the ENTER key is pressed.
CustomMultiselectText The CustomMultiselectText property determines whether a custom template is used to form component text on multiple selection.
CustomMultiselectTextTemplate The CustomMultiselectTextTemplate property determine the template, according to which component text willbe formed on multiple selection.
Dropped The Dropped property returns the status of the drop-down menu.
DroppedListHeight The DroppedListHeight property determines height of the component's drop-down menu.
DroppedListWidth The DroppedListWidth property determines width of the component's drop-down menu.
DroppedPopupMenu The DroppedPopupMenu property determines context menu which can be opened in the area of the components's drop-down menu.
FilterStyle The FilterStyle property determines mode of creating a tree of filtered elements.
FindEditVisible The FindEditVisible property determines whether a search string is displayed when the component dropdown list is expanded.
ShowSystemHints The ShowSystemHints property determines whether a system tooltip is displayed for various component elements.

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 the style of a component border.
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 vertex of the dimension, which index is received as an input parameter.
The ColumnClick property determines whether it is possible to display the component column headings 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 selection change in dimension.
The DropTargetNode property determines the component node, over which a user is currently dragging another node.
The ElementsActive property switches between the Be Elements and Be Levels selection modes.
The EnableFilter property determines dictionary dimension element filter view.
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 mouse over.
The HotTrack property determines whether the elements are underscored on mouse over.
The HotTrackAutoExpand property determines whether the state of children tree is changed on clicking a selected element.
The Images property determines the component, images of which are used in the component.

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

The Locked property determines whether it is possible to change selection of elements.
The ModeElements property determines the view of theOnly By Elements selection mode.
The ModeLevels property determines the view of theOnly By Levels selection mode.
The MultipleAttributes property determines whether several dictionary attributes are displayed.
Outdated.Use SelectionMode.
The OwnSelection property determines whether the own 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 vertices 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 the hint is displayed when hovering the mouse pointer on a component element.
The ShowLines property determines whether the connecting line between a vertex 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
The Align property determines component alignment within its parent component.
The AllowDrag property determines whether an object can be dragged from a component.
The AllowDrop property determines whether the component can accept a dragged object.
The Anchors property returns settings that determine the percentage of the size change for the current component when the parent component is resized.
The Brush property specifies the brush used to fill the component area.
The ClientHeight property determines the height of the client component area.
The ClientWidth property determines the width of the client component area.
The Color property determines the background color of a component.
The Cursor property determines how the cursor looks like when you hover over a component during form execution.
The Enabled property determines whether a component is available for a user.
The Focused property returns True if the focus is set on the component.
The Font property defines the parameters of the font used to display text in a component.
The Height property determines the component height (pixels).
The HelpContext property determines the unique index for a section of a context help for this component.
The Hint property determines the tip text displayed if the mouse pointer is hovered over a component.
The HintTimeout determines the time for which the tooltip is displayed.
The Left property determines the coordinate of the component left edge (pixels).
The Parent property determines the parent component.
The ParentColor property determines whether a component inherits the color of the parent component.
The ParentFont property determines whether a component should use the font of the parent component.
The ParentShowHint property determines when a tooltip is displayed.
The PopupMenu property determines the context menu displayed when a component is clicked using the right mouse button.
The Scrolls property returns parameters of component's scroll bars.
The ShowHint property determines whether a tool tip should be displayed when you hover over a component.
The TabOrder property determines the position of a component in a tab order.
The TabStop property determines whether the focus is set to a component when the Tab button is pressed.
The Text property determines the row identifying a component for a user.
The Top property determines the coordinate of the component upper edge (pixels).
The Visible property determines whether a component is displayed when a form is executed.
Свойство Width определяет ширину компонента в пикселях.

Properties inherited from IComponent

  Property name Brief description
The ComponentCount property returns the number of child components, located on the parent component.
The Components property returns a child component, the index of which is passed via the input parameter.
The Data property is used to store any custom data.
The Name property determines the component name.
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 IDimensionCombo

   Method name Brief description
AdjustDroppedListWidth The AdjustDroppedListWidth property adjusts width of the component's drop-down menu.
DropDown The DropDown method collapses the drop-down list.
RollUp The RollUp method collapses the list of component elements.
UpdateInfo The UpdateInfo method updates information about element selection.

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
Outdated. The BringToFront method brings a component to the foreground.
The ClientToScreen method converts the coordinates of a point specified relative to the component coordinate system to screen coordinates.
The DoDragDrop method enables to start drag-and-drop operation.
The GetImage method returns a graphic presentation of a component together with all children.
The ScreenToClient method converts screen coordinates of a point to coordinates specified relative to the component coordinate system.
Outdated. The SendToBack method is used to send a component to the background.
The SetFocus method sets focus to this component.

Events

  Event name Brief description
OnDropDown The OnDropDown event occurs on expanding of the DimensionCombo component list.
OnRollUp The OnRollUp event occurs on collapsing of the DimensionCombo component list.

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
The OnBeginDrag event occurs for a component, when a user starts to drag an object from the component.
The OnClick event occurs if a user clicks a component area using the main mouse button.
The OnControlMove event occurs when a component is moved.
The OnControlResize event occurs when a component is resized.
The OnDblClick event occurs if a user double-clicks a component area using the mouse button.
The OnDragDrop event occurs for a component if a user drops a dragged object over it.
The OnDragEnter event occurs when a dragged object crosses the borders of this component.
The OnDragLeave event occurs when a dragged object leaves the borders of this component.
The OnDragOver event occurs for this component when a user drags a dragged object over it.
The OnEnter event occurs when a component receives focus.
The OnExit event occurs when a component loses focus.
The OnHScroll event occurs when the horizontal scrollbar thumb changes its position.
The OnKeyDown event occurs if a component is focused and a keyboard key is pressed.
The OnKeyPress event occurs if a component is focused when a user presses a character key.
The OnKeyPreview event occurs prior to each event requiring clicking.
The OnKeyUp event occurs if a component is focused and a user releases any button previously pressed.
The OnMouseDown event occurs if the pointer is in component's area and a mouse key is pressed.
The OnMouseEnter event occurs when mouse cursor enters the component area.
The OnMouseHover event occurs when the mouse cursor is held in the component area.
The OnMouseLeave event occurs when mouse cursor leaves the component area.
The OnMouseMove event occurs on moving the cursor over component.
The OnMouseUp event occurs on releasing mouse button when the pointer is in component area.
The OnMouseWheel event occurs if the component has focus when the mouse wheel is rotated.
The OnVScroll event occurs when the vertical scrollbar thumb changes its position.

See also:

ExtCtrls Assembly Classes