Click or drag to resize

TreeView Class (Typed)

X#
Create a tree view control.
Inheritance Hierarchy
Object
  VObject
    Control
      TextControl
        TreeView

Namespace:  XSharp.VO.SDK
Assembly:  XSharp.VOGUIClasses (in XSharp.VOGUIClasses.dll) Version: 2.19
Syntax
 CLASS TreeView INHERIT TextControl
Request Example View Source

The TreeView type exposes the following members.

Constructors
  NameDescription
Public methodTreeView
Construct a tree view.
Top
Properties
  NameDescription
Public propertyBackground
The brush used for painting the background of the control. For example, in a single line edit control, the background is the color behind the text in the edit control.
(Inherited from Control.)
Public propertyCaption
The string representing the caption of the text control.
(Inherited from TextControl.)
Public propertyContextMenu
A menu object representing the local pop-up menu for a control.
(Inherited from Control.)
Public propertyControlFont
The font used to draw the text in the control.
(Inherited from TextControl.)
Public propertyControlID
A number between 1 and 8000 representing the unique ID of a control
(Inherited from Control.)
Public propertyControlType (Overrides ControlType.)
Public propertyCurrentText
A string representing the text currently displayed in a text control. For edit controls, including the edit box associated with simple and drop-down combo boxes, it contains the text currently appearing in the edit box. For fixed icon and group box controls, TextControl:CurrentText contains NULL_STRING.
(Inherited from TextControl.)
Public propertyDragDropEnabled
A logical value that is TRUE if drag-and-drop is enabled for the tree view. If drag-and-drop is enabled, items can be dragged within, as well as outside, the control.
Public propertyDragImageList
An image list containing a single image displayed during a drag-and-drop operation for the tree view.
Public propertyEventReturnValue (Inherited from Control.)
Public propertyFieldSpec (Inherited from Control.)
Public propertyHasFocus (Inherited from Control.)
Public propertyHyperLabel
The hyperlabel connected to the control.
(Inherited from Control.)
Public propertyImageList
An image list containing images to display for each item in the tree view.
Public propertyIndent
A numeric value representing the number of pixels that child items are indented from parent items.
Public propertyIsHidden (Inherited from Control.)
Public propertyItemCount
A numeric value representing the number of items in the tree view.
Public propertyLength
A numeric value representing the number of characters in the control.
(Inherited from TextControl.)
Public propertyModified
A logical value that is set to TRUE when a standard edit control or editable combo box is in the process of being modified.
(Inherited from Control.)
Public propertyName
A string representing the name of the control.
(Inherited from Control.)
Public propertyNameSym
A symbol representing the name of the control.
(Inherited from Control.)
Public propertyOrigin
A point representing the location of a control on its owner window, in canvas coordinates.
(Inherited from Control.)
Public propertyOwner
The owner window of a control.
(Inherited from Control.)
Public propertyOwnerAlignment
Constant representing how the window will be aligned within its owner window.
(Inherited from Control.)
Public propertyParent (Inherited from Control.)
Public propertyReadOnly
Is the control readonly ?
(Inherited from Control.)
Public propertySearchString
The incremental search string associated with the tree view.
Public propertyServer
The server object that currently connected to this control. If no server is connected, the value is NIL.
(Inherited from Control.)
Public propertySize
A dimension representing the size of a control.
(Inherited from Control.)
Public propertyStateImageList
An image list containing state images to display for each item in the tree view.
Public propertyStatus
A hyperlabel indicating the status of the control after a validation attempt or other action.
(Inherited from Control.)
Public propertySWFControl (Inherited from Control.)
Public propertyTextColor
The color used to draw the text in the control. (Refer to the Color:Init() method for details on specifying a color object.)
(Inherited from TextControl.)
Public propertyTextValue
A string representing the value held in the control.
(Inherited from TextControl.)
Public propertyToolTipText
String value representing the tooltip text used when the user moves the mouse pointer over the control.
(Inherited from Control.)
Public propertyUseHLForToolTip
Logical value determining whether the descriptive text of a control's Hyperlabel should be used as the tooltip text.
(Inherited from Control.)
Public propertyCode exampleValue
The value held in the control, in whatever data type the control holds.
(Inherited from Control.)
Public propertyValueChanged (Inherited from Control.)
Public propertyVisibleCount
A numeric value representing the number of tree view items that are fully visible in the tree view.
Top
Functions
  NameDescription
Public methodActivate
Provide a method that is invoked when the control has focus and a window is activated.

(Inherited from Control.)
Public methodAddChild (Inherited from Control.)
Public methodAddItem
Add a new tree view item as the last child item of a specified parent.
Public methodAsString (Inherited from Control.)
Public methodBringToFront (Inherited from Control.)
Public methodCollapse(Symbol)
Collapse a tree view item, hiding its child items.
Public methodCollapse(TreeViewItem)
Collapse a tree view item, hiding its child items.
Public methodCollapse(Symbol, Logic)
Collapse a tree view item, hiding its child items.
Public methodCollapse(TreeViewItem, Logic)
Collapse a tree view item, hiding its child items.
Public methodCollapse(Symbol, Logic, Logic)
Collapse a tree view item, hiding its child items.
Public methodCollapse(TreeViewItem, Logic, Logic)
Collapse a tree view item, hiding its child items.
Public methodCollapse(Symbol, Logic, Logic, Logic)
Collapse a tree view item, hiding its child items.
Public methodCollapse(TreeViewItem, Logic, Logic, Logic)
Collapse a tree view item, hiding its child items.
Public methodCreate
Creates the underlying Win32 control
(Inherited from TextControl.)
Public methodCreateWindowEx (Inherited from Control.)
Public methodDeactivate
Provide a method that is invoked when the control has focus and a window is deactivated.

(Inherited from Control.)
Public methodDefault
Call the default windows procedure for a control and set the EventReturnValue.
(Inherited from Control.)
Public methodDeleteAll
Delete all items of the tree view.
Public methodDeleteItem(Symbol)
Delete a tree view item.
Public methodDeleteItem(Usual)
Delete a tree view item.
Public methodDeleteItem(TreeViewItem)
Delete a tree view item.
Public methodDeleteItem(Symbol, Logic)
Delete a tree view item.
Public methodDeleteItem(Usual, Logic)
Delete a tree view item.
Public methodDeleteItem(TreeViewItem, Logic)
Delete a tree view item.
Public methodDisable
Disable a control (until a subsequent call to Control:Enable()).
(Inherited from Control.)
Public methodDisableTheme
Disable the WinXP theme for a control.
(Inherited from Control.)
Public methodDispatch
Provide the prototype dispatcher for events within the system when the control has focus; routing various events to their appropriate event handlers.

(Inherited from Control.)
Public methodDrop (Inherited from Control.)
Public methodEditItemLabel
Begins in-place label editing of an item in the tree view.
Public methodEnable
Enable a control that was previously disabled.
(Inherited from Control.)
Public methodEnableDragDrop
Enable or disable drag-and-drop of items for the tree view.
Public methodEnableSort
Register a user-defined method to use for sorting items in the tree view.
Public methodEnsureVisible
Ensure that an item is visible in the tree view, expanding its parent item or scrolling the tree view if necessary.
Public methodExpand(Symbol)
Expand a tree view item, showing its child items.
Public methodExpand(Symbol, Logic)
Expand a tree view item, showing its child items.
Public methodExpand(Symbol, Logic, Logic)
Expand a tree view item, showing its child items.
Public methodExpand(TreeViewItem, Logic, Logic)
Expand a tree view item, showing its child items.
Public methodExpose
Provide a method that is invoked when the control has focus and whenever part of the window needs repainting.

(Inherited from Control.)
Public methodFocusChange
Provide a method that is invoked when the control has focus and the input focus changes from the current control to another (or vice versa).

(Inherited from Control.)
Public methodFont
Change the current font of the text control.
(Inherited from TextControl.)
Public methodGetCurrentItem
Public methodGetDropHighlight
Return the first tree view item that is the target of a drag-and-drop operation.
Public methodGetFirstChildItem(Symbol)
Return the first child tree view item.
Public methodGetFirstChildItem(Usual)
Return the first child tree view item.
Public methodGetFirstChildItem(TreeViewItem)
Return the first child tree view item.
Public methodGetFirstVisibleItem
Return the first visible tree view item.
Public methodGetItemAtPosition
Return the tree view item at a particular position, if one exists.
Public methodGetItemAttributes(Symbol)
Return a tree view item given its symbolic name.
Public methodGetItemAttributes(TreeViewItem)
Public methodGetItemBoundingBox
Return the bounding box of a tree view item.
Public methodGetNextSiblingItem(Symbol)
Return a tree view item's next sibling item.
Public methodGetNextSiblingItem(Usual)
Return a tree view item's next sibling item.
Public methodGetNextSiblingItem(TreeViewItem)
Return a tree view item's next sibling item.
Public methodGetNextVisibleItem(Symbol)
Return a tree view item's next visible item.
Public methodGetNextVisibleItem(Usual)
Return a tree view item's next visible item.
Public methodGetNextVisibleItem(TreeViewItem)
Return a tree view item's next visible item.
Public methodGetParentItem(Symbol)
Public methodGetParentItem(Usual)
Return a tree view item's parent item.
Public methodGetParentItem(TreeViewItem)
Return a tree view item's parent item.
Public methodGetPreviousSiblingItem(Symbol)
Return a tree view item's previous sibling item.
Public methodGetPreviousSiblingItem(Usual)
Return a tree view item's previous sibling item.
Public methodGetPreviousSiblingItem(TreeViewItem)
Return a tree view item's previous sibling item.
Public methodGetPreviousVisibleItem(Symbol)
Return a tree view item's previous visible item.
Public methodGetPreviousVisibleItem(Usual)
Return a tree view item's previous visible item.
Public methodGetPreviousVisibleItem(TreeViewItem)
Return a tree view item's previous visible item.
Public methodGetRootItem
Return the root tree view item.
Public methodGetSelectedItem
Return the currently selected tree view item.
Public methodHandle
Return the handle for a control.
(Inherited from Control.)
Public methodHasBorder
Check if a border has been set for the control
(Inherited from Control.)
Public methodHasStyle
Check if a style value has been set for the control
(Inherited from Control.)
Public methodHide
Hide a control so it is not visible (until a subsequent call to Control:Show()).
(Inherited from Control.)
Public methodHorizontalScroll
Provide a method that is invoked when the control has focus and a horizontal scroll bar is scrolled.

(Inherited from Control.)
Public methodIme
Return and optionally set whether Input Method Editor is enabled for this text control.
(Inherited from TextControl.)
Public methodInsertItem
Insert a new tree view item as a child of a specified item and after a specified item in the tree view.
Public methodIsEnabled
Report if this control is currently enabled.
(Inherited from Control.)
Public methodIsReadOnly
Report if this control is currently readonly.
(Inherited from Control.)
Public methodIsVisible
Report if this control is visible (completely or partially) or hidden.
(Inherited from Control.)
Public methodKeyDown
Provide a method that is invoked when the control has focus and a key on the keyboard is pressed.

(Inherited from Control.)
Public methodKeyUp
Provide a method that is invoked when the control has focus and a key on the keyboard is released.

(Inherited from Control.)
Public methodLinkDF
Connect a control to a data field in a data server.
(Inherited from Control.)
Public methodMenuInit
Provide a method that is invoked when a pop-up menu owned by the control is about to pop up.
(Inherited from Control.)
Public methodMenuSelect
Provide a method that is invoked when an item on a menu owned by the control is highlighted.
(Inherited from Control.)
Public methodMouseButtonDoubleClick
Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is double-clicked.

(Inherited from Control.)
Public methodMouseButtonDown
Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is clicked.

(Inherited from Control.)
Public methodMouseButtonUp
Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is released.
(Inherited from Control.)
Public methodMouseDrag
Provide a method that is invoked when the control has focus and a mouse with one or more buttons clicked is moved in the window.
(Inherited from Control.)
Public methodMouseMove
Provide a method that is invoked when the control has focus and the mouse is moved in the control.
(Inherited from Control.)
Public methodMove
Provide a method that is invoked when the control has focus and the control is moved (either by the user or by the application).
(Inherited from Control.)
Public methodOnControlCreated (Inherited from Control.)
Public methodOnHandleCreated (Inherited from TextControl.)
Public methodOnHandleDestroyed (Inherited from TextControl.)
Public methodOverRide
This is a compatibility method that is no longer used or needed.
(Inherited from Control.)
Public methodPaintBackGround (Inherited from Control.)
Public methodPerformValidations
Perform all the validations defined to this control's field specification (for example, required, maximum and minimum digits, maximum and minimum value, validation rule) and return the result of the test.
(Inherited from Control.)
Public methodRegisterTimer
Register a timer method to be invoked for the control.
(Inherited from Control.)
Public methodRemoveEditBalloonTip
Removes the current BallonTip from the Edit control that has inherited from this class.
(Inherited from TextControl.)
Public methodRePaint
Send an ExposeEvent to repaint the control
(Inherited from Control.)
Public methodResize
Provide a method that is invoked when the control has focus and the control changes size.
(Inherited from Control.)
Public methodRestoreUpdate (Overrides RestoreUpdate.)
Public methodSelectItem
Cause a tree view to select a tree view item, scroll the item into view, or redraw it as the target of a drag-and-drop operation.
Public methodSendToBack (Inherited from Control.)
Public methodSetCueBanner(String)
Add a cue banner to the Edit control that has inherited from this class.
(Inherited from TextControl.)
Public methodSetCueBanner(String, IntPtr) (Inherited from TextControl.)
Public methodSetExStyle
Set the exstyle for the control.
(Inherited from Control.)
Public methodSetFocus
Pass input focus to a control, thereby directing all mouse and keyboard input to the control.
(Inherited from Control.)
Public methodSetItemAttributes
Update a tree view item within the tree view.
Public methodSetStyle
Set the style for the control.
(Inherited from Control.)
Public methodShow
Display a control so it is visible.
(Inherited from Control.)
Public methodShowEditBalloonTip
Add a BallonTip to the Edit control that has inherited from this class.
(Inherited from TextControl.)
Public methodShowToolTip (Inherited from Control.)
Public methodSortChildren
Sort the child tree view items of an item using the user-defined sort method specified by EnableSort().
Public methodSuspendUpdate (Overrides SuspendUpdate.)
Public methodTimer
Provide a method to be invoked at specific intervals defined when the timer is registered though the RegisterTimer() method.
(Inherited from Control.)
Public methodToggle
Toggle the expanded or collapsed state of a tree view item, showing or hiding its child items appropriately.
Public methodValidateControl
This method validates if the control has been created and when not then it triggers the control creation
(Inherited from Control.)
Public methodVerticalScroll
Provide a method that is invoked when the control has focus and a vertical scroll bar is scrolled.
(Inherited from Control.)
Top
Globals and Defines
  NameDescription
Public fieldoCargo
Cargo slot.
(Inherited from VObject.)
Top
Remarks
A tree view control is a control that displays a hierarchical list of tree view items, such as files and directories on a disk. Each item consists of a label and an optional icon, and each item can have a list of subitems associated with it. By clicking an item, the user can expand and collapse the associated list of subitems.
See Also