The CE Treeview Object Model

Team-Fly    

 
eMbedded Visual Basic: Windows CE and Pocket PC Mobile Applications
By Chris Tacke, Timothy Bassett
Table of Contents
appendix A.  Control Reference


The following tables outline the Object Model for the CE TreeView Control. This control is included in MSCETreeview.dll.

Table A.32. TreeViewCtl Methods
Method Return Description
GetVisibleCount Long The number of Node objects that fit vertically in the internal area of the TreeView Control. Note: This may be greater than the actual number of Nodes in the control.
Move Nothing Moves the control to the specified location. Can be used to set the Left, Top, Height, and Width simultaneously .
Refresh Nothing Forces a repaint of the entire control.
SetFocus Nothing Moves the current focus to the control.
StartLabelEdit Nothing Allows the user to edit the Text of a node.
Zorder Nothing Places the control at the front or back of the z-order .
Table A.33. TreeViewCtl Properties
Property Return Description
Container Object Returns a reference to the TreeView control's container object, such as its containing form.
Enabled Boolean Sets or Gets whether the control responds to user-generated events.
Event_Cancel Boolean Determines whether the control processes events.
FontBold Boolean Sets or Gets the Bold font style for the control.
FontItalic Boolean Sets or Gets the Italic font style for the control.
FontName String Sets or Gets the font used to display text in the object.
FontSize Long Sets or Gets the font size for text displayed in the control.
FontStrikethrough Boolean Sets or Gets the Strikethrough font style for the control.
FontUnderline Boolean Sets or Gets the Underline font style for the control.
Height Long Sets or Gets the current height of the control
HideSelection Boolean Determines whether selected text remains highlighted when the control loses focus.
ImageList Long Sets or Gets the handle to the ImageList associated with the control.
Indentation Single Sets or Gets the distance a child Node is indented below its parent.
LabelEdit LabelEditEnum Determines whether Labels within the control are user-editable.
Left Long Sets or Gets the current Left position of the control.
LineStyle LineStyleEnum Sets or Gets the style of lines displayed between Node objects.
Name String Gets the logical name of the TreeView control as set in the Properties window.
Nodes Nodes Collection Gets a reference to the Nodes Collection of the control.
Parent Object Returns a reference to the TreeView control's parent object, such as its containing form.
PathSeparator String Sets or Gets the delimiting character used for the return of the FullPath property.
SelectedItem Node Object Gets a reference to the currently selected Node object.
Sorted Boolean Determines whether Root Nodes within the control are sorted alphabetically by Text.
Style TreeStyleEnum Sets or Gets the types of graphics, such as lines, pluses and minuses, which appear for each Node.
TabIndex Long Sets or Gets order in which the Tab key sends focus to the control relative to all other controls on the form.
TabStop Boolean Determines whether the Tab key can set focus to the control.
Tag String Sets or Gets a string that can be used to hold any additional information the programmer wants to store.
Top Long Sets or Gets the current Top position of the control.
Visible Boolean Determines whether the control is displayed to the user.
Width Long Sets or Gets the current Width of the control.
Table A.34. TreeView Control Events
Event Description
AfterLabelEdit Fires after a user changes the Text of a Node.
BeforeLabelEdit Fires when a user begins editing the Text of a Node.
Collapse Fires when a Node is collapsed by the user.
Expand Fires when a Node is expanded by the user.
GotFocus Fires when current application focus is set to the control.
LostFocus Fires when current application focus leaves the control.
NodeClick Fires whenever the user clicks on a Node.
Table A.35. Node Object Methods
Method Return Description
EnsureVisible Nothing Ensures the specified Node is visible by scrolling and expanding nodes if necessary.
Table A.36. Node Object Properties
Property Return Description
Child Node Object Gets a reference to a Node's first child Node.
Children Long Gets the number of child Nodes a parent Node has.
Expanded Boolean Sets or Gets whether the specified node is expanded.
ExpandedImage Long Sets or Gets the index of the ImageList image displayed when a Node is expanded.
FirstSibling Node Object Gets a reference to a Node's first sibling Node.
FullPath String Returns the full path to the specified Node.
Image Long Sets or Gets the index of the ImageList image displayed normally for a Nodes in the control.
Index Long Gets a number that uniquely identifies the specified Node within the Nodes Collection.
Key String Sets or Gets a string that uniquely identifies the specified Node within the Nodes Collection.
LastSibling Node Object Gets a reference to a Node's first sibling Node.
Next Node Object Gets a reference to a Node's next sibling Node.
Parent Node Object Gets a reference to a Node's Parent Node.
Previous Node Object Gets a reference to a Node's previous sibling Node.
Root Node Object Gets a Reference to the Root Node of the TreeView control.
Selected Boolean Sets or Gets the selection status of a Node.
SelectedImage Long Sets or Gets the index of the ImageList image displayed when a Node is Selected.
Sorted Boolean Determines whether a Node's child Nodes are sorted alphabetically by Text.
Text String Sets or Gets the text displayed for a Node.
Table A.37. Nodes Collection Methods
Method Return Description
Add Node Object Adds a new Node object to the Nodes collection.
Clear Nothing Removes all Nodes from the Nodes collection.
Remove Nothing Removes a specific Node from the Nodes collection.
Table A.38. Nodes Collection Properties
Property Return Description
Count Long Gets the total number of Nodes in the Nodes collection.
Item Node Object Gets a reference to a Node in the Nodes collection based on its Index property.
Table A.39. TreeStyleEnum Constants
Constant Value Description
TvwTextOnly Indicates the control will not display lines, pictures, or plus/minus.
TvwPictureText 1 Indicates the control will display pictures for each Node.
TvwPlusMinusText 2 Indicates the control will display a plus/minus box left of each Node.
TvwPlusPictureText 3 Indicates the control will display both a picture and a plus/minus box for each Node.
TvwTreelinesText 4 Indicates the control will display lines between Nodes.
TvwTreelinesPictureText 5 Indicates the control will display lines between each Node as well as pictures for each Node.
TvwTreelinesPlusMinusText 6 Indicates the control will display lines between each Node as well as a plus/minus box left of each Node.
TvwTreelinesPlusMinusPictureText 7 Indicates the control will display lines between each Node, picture for each Node and a plus/minus box left of each Node.

Team-Fly    
Top
 


eMbedded Visual BasicR. WindowsR CE and Pocket PC Mobile Applications
eMbedded Visual BasicR. WindowsR CE and Pocket PC Mobile Applications
ISBN: N/A
EAN: N/A
Year: 2001
Pages: 108

flylib.com © 2008-2017.
If you may any questions please contact us: flylib@qtcs.net