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.24 GA
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 propertyControlType (Overrides ControlType.)
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 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 propertyItemCount
A numeric value representing the number of items in the tree view.
Public propertySearchString
The incremental search string associated with the tree view.
Public propertyStateImageList
An image list containing state images to display for each item in the tree view.
Public propertyVisibleCount
A numeric value representing the number of tree view items that are fully visible in the tree view.
Top
Functions
  NameDescription
Public methodAddItem
Add a new tree view item as the last child item of a specified parent.
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 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 methodEditItemLabel
Begins in-place label editing of an item in the tree view.
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 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 methodInsertItem
Insert a new tree view item as a child of a specified item and after a specified item in the tree view.
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 methodSetItemAttributes
Update a tree view item within the tree view.
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 methodToggle
Toggle the expanded or collapsed state of a tree view item, showing or hiding its child items appropriately.
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