TreeCombo

Description

The TreeCombo class implements the TreeCombo development environment component that is used to display branching hierarchical structures as combo boxes.

Properties inherited from ITreeCombo

  Property name Brief description
AnimationType The AnimationType property determines the type of animation that is used when the list of the component is expanded.
AutoUpdateInfo The AutoUpdateInfo property indicates whether the information about selection in the component editor is updated automatically.
CancelOnEscape The CancelOnEscape property determines whether the set selection should be cancelled and the list should be closed on pressing the ESCAPE key.
CloseOnClick The CloseOnClick property determines whether the list should be closed automatically when one of the elements from this list is selected by the mouse button click.
CloseOnEnter The CloseOnEnter property determines whether the list should be closed and the selection should be saved on pressing the ENTER key.
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 determines visibility of the drop-down list.
DroppedListHeight The DroppedListHeight property determines height of the drop-down list of the component.
DroppedListWidth The DroppedListWidth property determines width of the drop-down list of the component.
DroppedPopupMenu The DroppedPopupMenu property determines the context menu that is called in the area of the drop-down list of the component.
FilterStyle The FilterStyle property determines the mode of building of the filtered elements tree.
FindEditVisible The FindEditVisible property indicates whether the search line is displayed when the drop-down list of component is expanded.
ShowEditImage The ShowEditImage property indicates whether icon of the element is displayed in the component editor.
ShowSystemHints The ShowSystemHints property determines whether a system tooltip is displayed for various component elements.

Properties inherited from ITreeControl

  Property name Brief description
The AdjustWidthOnlyVisible property determines the method of auto adjusting the column width.
Outdated. Use ITreeControl.SelectionMode.
The AutoCheckParent property determines whether the indeterminate state should be set automatically for the parent nodes of the component, if not all child elements are selected.
The BorderStyle property determines style of the frame that outlines the component.
The Checkboxes property determines whether component elements have checkboxes.
The ColumnClick property determines whether it is possible to display columns headers as buttons.
The Columns  property returns collection of columns of the component.
The DropTargetNode property determines node of the component over which user is dragging another node at the moment.
The EnableFindDialog property determines whether the pressing CTRL+F or F3 hot keys should call standard dialog of the elements search.
The FindMode property determines the mode of selection of the found elements.
The FocusedNode property determines a node that has focus at the moment.
The GridLines property determines whether the gird should be displayed.
The HeaderMenu property determines context menu that is called on clicking the additional mouse button on the component header.
The HideSelection property indicated whether the selection is displayed in the component when the focus is passed to another component.
The HighlightTrack property determines whether the element is highlighted on mouse over.
The HotTrack property indicates whether the element over which the mouse pointer moves, is underlined.
The HotTrackAutoExpand property indicates whether the state of the child elements tree is changed on clicking on the selected element.
The Images property determines the list of images that are displayed near the elements of the component tree.
The InnerRoot property returns parameters of the inner root node of the tree.
The Locked property determines whether it is possible to change selection and edit elements in the component.
Outdated. Use ITreeControl.SelectionMode.
The Nodes property returns collection of component elements.
The ReadOnly property indicates whether the elements can be edited.
The RowSelect property determines whether it is necessary to highlight the whole string of the selected element.
The Selected property returns the last selected element of the tree.
The Selection property returns selection of the elements tree.
The SelectionMode property determines the mode of selection of the elements in the component.
The ShowButtons property determines whether the buttons of expanding and collapsing of the nodes child tree should be displayed.
The ShowColumnHeaders property determines whether headers of the columns should be displayed.
The ShowHeaderButton property determines whether to show the button that opens column headers menu.
The ShowHints property determines whether the tooltips should be displayed when the mouse is kept over the elements.
The ShowLines property determines whether the line that connects the node with its successors should be displayed.
The SortColumn property determines index of the column by which the sorting should be performed.
The Sorted property determines whether it is possible to sort by the column specified in the SortColumn property.
The SortType property determines type of sorting for the component.
The StateImages property determines the list of images that are used to indicate the state of elements of the component tree.

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 a component can accept a dragged object.
The Anchors property returns settings determining % 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 given component is focused.
The Font property defines the parameters of the font used to display text in a component.
The Heigth 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 you hover over a component.
The HintTimeout property sets for how long the tooltip is shown.
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 tooltip 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 at the form runtime.
The Width property determines the horizontal size of a component (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 child property, the index of which is passed by the input parameter.
Data The Data property is used to store any custom data.
Name The Name property specifies the component name.
Tag The compiler does not use the Tag property. A user can change the value of the Tag property and use it as he wishes.

Methods inherited from ITreeCombo

  Method name Brief description
AdjustDroppedListWidth The AdjustDroppedListWidth method adjusts the width of the drop-down list of the component.
DropDown The DropDown property expands the combo box.
RollUp The RollUp method rolls up the combo box.
UpdateInfo The UpdateInfo method updates information about elements selection that is displayed in the component editor.

Methods inherited from ITreeControl

   Method name Brief description
AdjustWidth The AdjustWidth method adjusts automatically width of the column taking into account its contents.
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.
Sort The Sort method sorts elements of the specified column to specified direction.
SortDefault The SortDefault method performs ascending sorting of component elements.

Methods inherited from IControl

   Method name Brief description
Outdated. The BringToFront method sends 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 allows to start dragging.
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
OnBeginFilter The OnBeginFilter event occurs at the start of filtering of component elements list.
OnDropDown The OnDropDown event occurs on expanding the component list.
OnFilter The OnFilter event occurs after the list of components is filtered.
OnRollUp The OnRollUp event occurs on collapsing the component list.

Events inherited from ITreeControl

   Event name Brief description
OnBeginSearch The OnBeginSearch event occurs when elements are started to be searched in the component.
OnAdded The OnAdded event occurs when the new element is added.
OnChecked The OnChecked event occurs after flag state of the element has been changed.
OnChecking The OnChecking event occurs before flag state of the element is changed.
OnCollapsed The OnCollapsed event occurs after the child hierarchy of the tree node has been collapsed.
OnCollapsing The OnCollapsing event occurs before the child hierarchy of the tree node is collapsed.
OnColumnClick The OnColumnClick event occurs on clicking on the header of column of the component.
OnCompareItems The OnCompareItems event occurs when two elements are compared during the custom sorting of elements.
OnDeleting The OnDeleting event occurs when the element is removed.
OnEdited The OnEdited event occurs on escaping from the edit mode of field contents of the current component record.
OnEditing The OnEditing event occurs on activating the edit mode of the field contents of the current component record.
OnExpanded The OnExpanded event occurs after the child hierarchy of the tree node has been expanded.
OnExpanding The OnExpanding event occurs before the child hierarchy of the tree node is expanded.
OnFocusedChanged The OnFocusedChanged event occurs after the focus has been passed to another node of the component.
OnFocusedChanging The OnFocusedChanging event occurs before the focus is passed to another node of the component.
OnGetHint The OnGetHint event occurs when the tooltip appears near the element over which the mouse cursor has stopped.
OnGetNodeImage The OnGetNodeImage event is used when an image is determined near the tree element.
OnGetNodeStateImage The OnGetNodeStateImage event is used when the state image is determined near the tree element.
OnHover The OnHover event occurs when the mouse cursor hovers over the element and this element of the component is underlined.
OnSearch The OnSearch event occurs after the element search in the component is finished.
OnSelected The OnSelected event occurs after selection of the node has been set.
OnSelecting The OnSelecting event occurs before selection of the node is set.
OnSelectionChanged The OnSelectionChanged event occurs when the selection of the node of the component is changed.
OnUnselected The OnUnselected event occurs after node has been deselected.
OnUnselecting The OnUnselecting event occurs before element is deselected.

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 enters the space 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 get focused.
The OnExit event occurs when a component loses focus.
The OnHScroll event occurs on changing position of horizontal scrollbar slider.
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 when the pointer is in component area and a mouse button 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 mouse cursor moves over a component.
The OnMouseUp event occurs on releasing mouse button when the cursor is in component area.
The OnMouseWheel event occurs if the component has focus when the mouse wheel is rotated.
The OnVScroll event occurs on changing position of vertical scrollbar slider.

See also:

Forms Assembly Classes