ITreeControl

Description

The ITreeControl interface contains basic properties and methods of components displaying branching hierarchical structures.

Comments

The interface is basic for the following components of the development environment:

These components implement the series of events, the list of which is represented in this section.

Properties

  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

   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.

See also:

Forms Assembly Interfaces