TreeView Class (Typed) |  |
Create a tree view control.
Inheritance HierarchyNamespace: XSharp.VO.SDK
Assembly: XSharp.VOGUIClasses (in XSharp.VOGUIClasses.dll) Version: 2.21
SyntaxThe TreeView type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | Background |
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.) |
| Caption |
The string representing the caption of the text control.
(Inherited from TextControl.) |
| ContextMenu |
A menu object representing the local pop-up menu for a control.
(Inherited from Control.) |
| ControlFont |
The font used to draw the text in the control.
(Inherited from TextControl.) |
| ControlID |
A number between 1 and 8000 representing the unique ID of a control
(Inherited from Control.) |
| ControlType | (Overrides ControlType.) |
| CurrentText |
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.) |
| DragDropEnabled |
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.
|
| DragImageList |
An image list containing a single image displayed during a drag-and-drop operation for the tree view.
|
| EventReturnValue | (Inherited from Control.) |
| FieldSpec | (Inherited from Control.) |
| HasFocus | (Inherited from Control.) |
| HyperLabel |
The hyperlabel connected to the control.
(Inherited from Control.) |
| ImageList |
An image list containing images to display for each item in the tree view.
|
| Indent |
A numeric value representing the number of pixels that child items are indented from parent items.
|
| IsHidden | (Inherited from Control.) |
| ItemCount |
A numeric value representing the number of items in the tree view.
|
| Length |
A numeric value representing the number of characters in the control.
(Inherited from TextControl.) |
| Modified |
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.) |
| Name |
A string representing the name of the control.
(Inherited from Control.) |
| NameSym |
A symbol representing the name of the control.
(Inherited from Control.) |
| Origin |
A point representing the location of a control on its owner window, in canvas coordinates.
(Inherited from Control.) |
| Owner |
The owner window of a control.
(Inherited from Control.) |
| OwnerAlignment |
Constant representing how the window will be aligned within its owner window.
(Inherited from Control.) |
| Parent | (Inherited from Control.) |
| ReadOnly |
Is the control readonly ?
(Inherited from Control.) |
| SearchString |
The incremental search string associated with the tree view.
|
| Server |
The server object that currently connected to this control. If no server is connected, the value is NIL.
(Inherited from Control.) |
| Size |
A dimension representing the size of a control.
(Inherited from Control.) |
| StateImageList |
An image list containing state images to display for each item in the tree view.
|
| Status |
A hyperlabel indicating the status of the control after a validation attempt or other action.
(Inherited from Control.) |
| SWFControl | (Inherited from Control.) |
| TextColor |
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.) |
| TextValue |
A string representing the value held in the control.
(Inherited from TextControl.) |
| ToolTipText |
String value representing the tooltip text used when the user moves the mouse pointer over the control.
(Inherited from Control.) |
| UseHLForToolTip |
Logical value determining whether the descriptive text of a control's Hyperlabel should be used as the tooltip text.
(Inherited from Control.) |
 | Value |
The value held in the control, in whatever data type the control holds.
(Inherited from Control.) |
| ValueChanged | (Inherited from Control.) |
| VisibleCount |
A numeric value representing the number of tree view items that are fully visible in the tree view.
|
Functions| Name | Description | |
|---|---|---|
 | Activate |
Provide a method that is invoked when the control has focus and a window is activated. (Inherited from Control.) |
| AddChild | (Inherited from Control.) |
| AddItem |
Add a new tree view item as the last child item of a specified parent.
|
| AsString | (Inherited from Control.) |
| BringToFront | (Inherited from Control.) |
| Collapse(Symbol) |
Collapse a tree view item, hiding its child items.
|
| Collapse(TreeViewItem) |
Collapse a tree view item, hiding its child items.
|
| Collapse(Symbol, Logic) |
Collapse a tree view item, hiding its child items.
|
| Collapse(TreeViewItem, Logic) |
Collapse a tree view item, hiding its child items.
|
| Collapse(Symbol, Logic, Logic) |
Collapse a tree view item, hiding its child items.
|
| Collapse(TreeViewItem, Logic, Logic) |
Collapse a tree view item, hiding its child items.
|
| Collapse(Symbol, Logic, Logic, Logic) |
Collapse a tree view item, hiding its child items.
|
| Collapse(TreeViewItem, Logic, Logic, Logic) |
Collapse a tree view item, hiding its child items.
|
| Create |
Creates the underlying Win32 control
(Inherited from TextControl.) |
| CreateWindowEx | (Inherited from Control.) |
| Deactivate |
Provide a method that is invoked when the control has focus and a window is deactivated. (Inherited from Control.) |
| Default | Call the default windows procedure for a control and set the EventReturnValue. (Inherited from Control.) |
| DeleteAll |
Delete all items of the tree view.
|
| DeleteItem(Symbol) |
Delete a tree view item.
|
| DeleteItem(Usual) |
Delete a tree view item.
|
| DeleteItem(TreeViewItem) |
Delete a tree view item.
|
| DeleteItem(Symbol, Logic) |
Delete a tree view item.
|
| DeleteItem(Usual, Logic) |
Delete a tree view item.
|
| DeleteItem(TreeViewItem, Logic) |
Delete a tree view item.
|
| Disable |
Disable a control (until a subsequent call to Control:Enable()).
(Inherited from Control.) |
| DisableTheme |
Disable the WinXP theme for a control.
(Inherited from Control.) |
| Dispatch |
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.) |
| Drop | (Inherited from Control.) |
| EditItemLabel |
Begins in-place label editing of an item in the tree view.
|
| Enable |
Enable a control that was previously disabled.
(Inherited from Control.) |
| EnableDragDrop |
Enable or disable drag-and-drop of items for the tree view.
|
| EnableSort |
Register a user-defined method to use for sorting items in the tree view.
|
| EnsureVisible |
Ensure that an item is visible in the tree view, expanding its parent item or scrolling the tree view if necessary.
|
| Expand(Symbol) |
Expand a tree view item, showing its child items.
|
| Expand(Symbol, Logic) |
Expand a tree view item, showing its child items.
|
| Expand(Symbol, Logic, Logic) |
Expand a tree view item, showing its child items.
|
| Expand(TreeViewItem, Logic, Logic) |
Expand a tree view item, showing its child items.
|
| Expose |
Provide a method that is invoked when the control has focus and whenever part of the window needs repainting. (Inherited from Control.) |
| FocusChange |
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.) |
| Font |
Change the current font of the text control.
(Inherited from TextControl.) |
| GetCurrentItem | |
| GetDropHighlight |
Return the first tree view item that is the target of a drag-and-drop operation.
|
| GetFirstChildItem(Symbol) |
Return the first child tree view item.
|
| GetFirstChildItem(Usual) |
Return the first child tree view item.
|
| GetFirstChildItem(TreeViewItem) |
Return the first child tree view item.
|
| GetFirstVisibleItem |
Return the first visible tree view item.
|
| GetItemAtPosition |
Return the tree view item at a particular position, if one exists.
|
| GetItemAttributes(Symbol) |
Return a tree view item given its symbolic name.
|
| GetItemAttributes(TreeViewItem) | |
| GetItemBoundingBox |
Return the bounding box of a tree view item.
|
| GetNextSiblingItem(Symbol) |
Return a tree view item's next sibling item.
|
| GetNextSiblingItem(Usual) |
Return a tree view item's next sibling item.
|
| GetNextSiblingItem(TreeViewItem) |
Return a tree view item's next sibling item.
|
| GetNextVisibleItem(Symbol) |
Return a tree view item's next visible item.
|
| GetNextVisibleItem(Usual) |
Return a tree view item's next visible item.
|
| GetNextVisibleItem(TreeViewItem) |
Return a tree view item's next visible item.
|
| GetParentItem(Symbol) | |
| GetParentItem(Usual) |
Return a tree view item's parent item.
|
| GetParentItem(TreeViewItem) |
Return a tree view item's parent item.
|
| GetPreviousSiblingItem(Symbol) |
Return a tree view item's previous sibling item.
|
| GetPreviousSiblingItem(Usual) |
Return a tree view item's previous sibling item.
|
| GetPreviousSiblingItem(TreeViewItem) |
Return a tree view item's previous sibling item.
|
| GetPreviousVisibleItem(Symbol) |
Return a tree view item's previous visible item.
|
| GetPreviousVisibleItem(Usual) |
Return a tree view item's previous visible item.
|
| GetPreviousVisibleItem(TreeViewItem) |
Return a tree view item's previous visible item.
|
| GetRootItem |
Return the root tree view item.
|
| GetSelectedItem |
Return the currently selected tree view item.
|
| Handle |
Return the handle for a control.
(Inherited from Control.) |
| HasBorder | Check if a border has been set for the control (Inherited from Control.) |
| HasStyle | Check if a style value has been set for the control (Inherited from Control.) |
| Hide |
Hide a control so it is not visible (until a subsequent call to Control:Show()).
(Inherited from Control.) |
| HorizontalScroll |
Provide a method that is invoked when the control has focus and a horizontal scroll bar is scrolled. (Inherited from Control.) |
| Ime |
Return and optionally set whether Input Method Editor is enabled for this text control.
(Inherited from TextControl.) |
| InsertItem |
Insert a new tree view item as a child of a specified item and after a specified item in the tree view.
|
| IsEnabled |
Report if this control is currently enabled.
(Inherited from Control.) |
| IsReadOnly |
Report if this control is currently readonly.
(Inherited from Control.) |
| IsVisible |
Report if this control is visible (completely or partially) or hidden.
(Inherited from Control.) |
| KeyDown |
Provide a method that is invoked when the control has focus and a key on the keyboard is pressed. (Inherited from Control.) |
| KeyUp |
Provide a method that is invoked when the control has focus and a key on the keyboard is released. (Inherited from Control.) |
| LinkDF |
Connect a control to a data field in a data server.
(Inherited from Control.) |
| MenuInit |
Provide a method that is invoked when a pop-up menu owned by the control is about to pop up.
(Inherited from Control.) |
| MenuSelect |
Provide a method that is invoked when an item on a menu owned by the control is highlighted.
(Inherited from Control.) |
| MouseButtonDoubleClick |
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.) |
| MouseButtonDown |
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.) |
| MouseButtonUp |
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.) |
| MouseDrag |
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.) |
| MouseMove |
Provide a method that is invoked when the control has focus and the mouse is moved in the control.
(Inherited from Control.) |
| Move |
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.) |
| OnControlCreated | (Inherited from Control.) |
| OnHandleCreated | (Inherited from TextControl.) |
| OnHandleDestroyed | (Inherited from TextControl.) |
| OverRide | This is a compatibility method that is no longer used or needed. (Inherited from Control.) |
| PaintBackGround | (Inherited from Control.) |
| PerformValidations |
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.) |
| RegisterTimer |
Register a timer method to be invoked for the control.
(Inherited from Control.) |
| RemoveEditBalloonTip |
Removes the current BallonTip from the Edit control that has inherited from this class.
(Inherited from TextControl.) |
| RePaint |
Send an ExposeEvent to repaint the control
(Inherited from Control.) |
| Resize |
Provide a method that is invoked when the control has focus and the control changes size.
(Inherited from Control.) |
| RestoreUpdate | (Overrides RestoreUpdate.) |
| SelectItem |
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.
|
| SendToBack | (Inherited from Control.) |
| SetCueBanner(String) |
Add a cue banner to the Edit control that has inherited from this class.
(Inherited from TextControl.) |
| SetCueBanner(String, IntPtr) | (Inherited from TextControl.) |
| SetExStyle |
Set the exstyle for the control.
(Inherited from Control.) |
| SetFocus |
Pass input focus to a control, thereby directing all mouse and keyboard input to the control.
(Inherited from Control.) |
| SetItemAttributes |
Update a tree view item within the tree view.
|
| SetStyle |
Set the style for the control.
(Inherited from Control.) |
| Show |
Display a control so it is visible.
(Inherited from Control.) |
| ShowEditBalloonTip |
Add a BallonTip to the Edit control that has inherited from this class.
(Inherited from TextControl.) |
| ShowToolTip | (Inherited from Control.) |
| SortChildren |
Sort the child tree view items of an item using the user-defined sort method specified by EnableSort().
|
| SuspendUpdate | (Overrides SuspendUpdate.) |
| Timer |
Provide a method to be invoked at specific intervals defined when the timer is registered though the RegisterTimer() method.
(Inherited from Control.) |
| Toggle |
Toggle the expanded or collapsed state of a tree view item, showing or hiding its child items appropriately.
|
| ValidateControl | This method validates if the control has been created and when not then it triggers the control creation (Inherited from Control.) |
| VerticalScroll |
Provide a method that is invoked when the control has focus and a vertical scroll bar is scrolled.
(Inherited from Control.) |
Globals and Defines
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