TreeControl class

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name	TreeControl class
Class ID	66
Scope	Basic Development Environment
Class Inheritance	Generic GObject Control TreeControl Generic GObject Control TreeControl
Class Children	This class has no children.

The TreeControl class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide TreeControl Properties Table

Legend
R/W	Readable/Writable Permissions
RTE	Available in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated

TreeControl Properties Table

Property ID	Long Name (English)	Description	R/W	RTE
756A3C00	Column Header Strings[]	An array of the strings in the column headers.	Read/Write	Yes
756A3C01	Visible Items:Vertical Scrollbar Visible	If TRUE, displays the vertical scroll bar.	Read/Write	Yes
756A3C02	Visible Items:Horizontal Scrollbar Visible	If TRUE, displays the horizontal scroll bar.	Read/Write	Yes
756A3C03	Number of Rows	Number of visible rows in the tree control, excluding column headers. This property counts partially visible rows.	Read/Write	Yes
756A3C04	Number of Columns	Number of visible columns in the tree control. This property counts partially visible columns.	Read/Write	Yes
756A3C05	Visible Items:Column Headers Visible	If TRUE, displays the column headers.	Read/Write	Yes
756A3C06	Autosizing Row Height	Determines whether the rows autosize their height to display all text when fonts change or when the number of lines in a cell changes.	Read/Write	Yes
756A3C07	Multiple Line Input	If TRUE, you can enter multiple lines of text in the tree control cells by pressing the <Enter> key on the keyboard. If FALSE, pressing the <Enter> key on the keyboard while editing cells causes LabVIEW to commit the edits in the current cell and the text focus moves to the next cell. This property does not affect run-time behavior of the tree control.	Read/Write	Yes
756A3C08	Selection Color	The color used to highlight the selected items.	Read/Write	Yes
756A3C09	Top Left Visible Cell	The unique tag and column of the item string displayed in the top left corner of the tree control. Use this property to read or change the top item, or use it to read or change the leftmost column of information displayed.	Read/Write	Yes
756A3C0A	Visible Items:Symbols Visible	If TRUE, displays the item symbols.	Read/Write	Yes
756A3C0B	Keyboard Mode	Sets how to handle upper and lowercase characters when you type characters in a tree control at run time. Valid values include 0 (System Default), 1 (Case Sensitive), and 2 (Case Insensitive).	Read/Write	Yes
756A3C0C	Selection Mode	Number of items the user can select. Valid values include 0 (zero or one), 1 (one), 2 (zero or more), and 3 (one or more).	Read/Write	Yes
756A3C0D	Active Item:Tag	The tag of the item(s) to which you want to apply subsequent property changes.	Read/Write	Yes
756A3C0E	Active Item:Open?	If TRUE, the active item(s) appears expanded to display items indented under it.	Read/Write	Yes
756A3C0F	Active Item:Disabled?	If TRUE, the active item(s) appears dimmed and you cannot select the item(s).	Read/Write	Yes
756A3C10	Active Item:Child-Only?	If TRUE, you cannot indent other items under the active item(s).	Read/Write	Yes
756A3C11	Active Item:Indent Level	The level at which the active item(s) appears in the hierarchy. Wire a value of 0 to this property to move the item to the highest level in the hierarchy.	Read/Write	Yes
756A3C12	Active Item:Symbol Index	The index of the symbol for the active item(s).	Read/Write	Yes
756A3C13	Active Cell:Active Column Number	Sets the column of the active cell(s).	Read/Write	Yes
756A3C14	Active Cell:Background Color	The background color of the active cell(s).	Read/Write	Yes
756A3C15	Active Cell:Foreground Color		Read/Write	Yes
756A3C16	Active Cell:Cell Size	The size of the active cell(s) in pixels.	Read/Write	Yes
756A3C17	Active Cell:Cell Size:Height	The height of the active cell(s) in pixels.	Read/Write	Yes
756A3C18	Active Cell:Cell Size:Width	The width of the active cell(s) in pixels.	Read/Write	Yes
756A3C19	Active Cell:String	The string in the active cell(s).	Read/Write	Yes
756A3C1A	Twisty Type		Read/Write	Yes
756A3C1C	Displayed Items	Returns the unique tags of all visible items in the tree control in display order. If an item is indented under another item and the parent item is not expanded, this property does not return the tags of any items indented under that parent item.	Read Only	Yes
756A3C1D	Visible Items:Hierarchy Lines Visible Old		Read/Write	Yes
756A3C1E	Allow Selection of Parent Items	If TRUE, users can select items that have other items indented under them and items that are not child-only and do not have other items indented under them. If FALSE, users can select only items with a value of TRUE for the Child-Only? property.	Read/Write	Yes
756A3C1F	Drag/Drop:Allow Dragging of Parent Items	If FALSE, the user cannot drag an item in the tree control unless the item is child-only.	Read/Write	Yes
756A3C20	Drag/Drop:Allow Dropping Between Items	If FALSE, the user cannot drag an item to place it between two other items at the same hierarchical level.	Read/Write	Yes
756A3C21	Visible Items:Vertical Lines Visible	If TRUE, displays vertical lines that separate columns in the tree control.	Read/Write	Yes
756A3C22	Visible Items:Horizontal Lines Visible	If TRUE, displays horizontal lines that separate rows in the tree control.	Read/Write	Yes
756A3C23	Drag/Drop:Allow Dragging (Deprecated)		Read/Write	Yes
756A3C24	Expand/Contract Symbol:Symbol Type	The type of symbol to display next to each item that has other items indented under it. Valid values include 0 (None), 1 (LabVIEW), 2 (Mac OS X), 3 (Windows), and 4 (Default).	Read/Write	Yes
756A3C25	Active Cell:Old Cell Size		Read/Write	Yes
756A3C26	Active Cell:OldHeight		Read/Write	Yes
756A3C27	Active Cell:OldWidth		Read/Write	Yes
756A3C28	Size	The width and height in pixels of the tree control.	Read/Write	Yes
756A3C29	Size:Width	The width of the active cell(s) in pixels.	Read/Write	Yes
756A3C2A	Size:Height	The height of the active cell(s) in pixels.	Read/Write	Yes
756A3C2B	Content Rect Position	The coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the content rectangle of the tree control.	Read Only	Yes
756A3C2C	Content Rect Position:Left	The coordinate in pixels, relative to the origin of the owning pane, of the left edge of the content rectangle of the tree control.	Read Only	Yes
756A3C2D	Content Rect Position:Top	The coordinate in pixels, relative to the origin of the owning pane, of the top edge of the content rectangle of the tree control.	Read Only	Yes
756A3C2E	Content Rect Bounds	The size in pixels of the content rectangle of the tree control.	Read Only	Yes
756A3C2F	Content Rect Bounds:Width	The width in pixels of the content rectangle of the tree control.	Read Only	Yes
756A3C30	Content Rect Bounds:Height	The height in pixels of the content rectangle of the tree control.	Read Only	Yes
756A3C31	Active Cell:Position	The coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the active cell(s).	Read Only	Yes
756A3C32	Active Cell:Position:Left	The coordinate in pixels, relative to the origin of the owning pane, of the left edge of the active cell.	Read Only	Yes
756A3C33	Active Cell:Position:Top	The coordinate in pixels, relative to the origin of the owning pane, of the top edge of the active cell.	Read Only	Yes
756A3C34	Active Cell:Cell Font	The font of the active cell in the tree control.	Read/Write	Yes
756A3C35	Active Cell:Cell Font:Name	The name of the font in the active cell. Predefined font names include App Font, Sys Font, and Dlg Font.	Read/Write	Yes
756A3C36	Active Cell:Cell Font:Size	The size of the font in the active cell.	Read/Write	Yes
756A3C37	Active Cell:Cell Font:Bold	Indicates whether the text in the active cell is bold.	Read/Write	Yes
756A3C38	Active Cell:Cell Font:Italic	Indicates whether the text in the active cell is italic.	Read/Write	Yes
756A3C39	Active Cell:Cell Font:Underline	Indicates whether the text in the active cell is underlined.	Read/Write	Yes
756A3C3A	Active Cell:Cell Font:Strikeout	Indicates whether to strike out the text in the active cell.	Read/Write	Yes
756A3C3B	Active Cell:Cell Font:Color	The text font color in the active cell.	Read/Write	Yes
756A3C3C	Active Cell:Cell Justification	Gets and sets the justification of text.	Read/Write	Yes
756A3C3D	Allow Editing Cells	If TRUE, users can edit non-header cells in this control at run time by clicking the cell text and then clicking it a second time after a short pause. If FALSE, users cannot edit non-header cells.	Read/Write	Yes
756A3C3E	Old Edit Position		Read/Write	Yes
756A3C3F	Visible Items:Row Headers Visible	Shows the row headers.	Read/Write	Yes
756A3C40	Row Header Strings[]	An array of the strings in the row headers.	Read/Write	Yes
756A3C41	Is Array?	Returns TRUE if the tree has an array data type.	Read/Write	Yes
756A3C42	Active Item:Row Number	The row number of the item to which you want to apply subsequent property changes. Wire a value of –1 to this property to select the column headers. Wire a value of –2 to select all rows.	Read/Write	Yes
756A3C43	All Tags	The tags of all items in a tree control. This property returns the tags of both visible and hidden items in order from the top of the tree control to the bottom.	Read Only	Yes
756A3C44	Sibling Multiselect	If TRUE and the Selection Mode is 0 or More Items, users can select multiple items only if those items are siblings.	Read/Write	Yes
756A3C46	Drag/Drop:Allow Dragging	If TRUE, you can drag items from this control.	Read/Write	Yes
756A3C47	Drag/Drop:Allow Dropping	If TRUE, LabVIEW automatically accepts drops containing the LV_TREE_TAG, LV_TEXT, or LV_TREE_ITEMS data types. The LV_TREE_TAG data type is a string that represents the tag from which you drag. The LV_TEXT data type is of type string. The LV_TREE_ITEMS data type is an array of a cluster containing an array of strings, from left to right, in the item you are dragging, an integer representing the glyph index associated with the item from which you are dragging data, and an integer representing the indent level of the item from which you are dragging.	Read/Write	Yes
756A3C48	Expand/Contract Symbol:Show Symbol at Root	Shows or hides the expand/contract symbols for items at indent level 0. The indent level 0 items become flush with the left side of the tree control when you hide the expand/contract symbols.	Read/Write	Yes
756A3C49	Drag/Drop:Drag Mode	Sets the default behavior for a drag and drop operation for the control. The settings apply only when the control configured is the source of the drag and drop operation.	Read/Write	Yes
756A3C4A	Drag/Drop:Allow Drag and Drop Outside Control	If TRUE, this enables the control to drag items to other controls and accept drags from other controls.	Read/Write	Yes
756A3C4B	Select Entire Rows	Highlights the entire row if you select a row in the tree.	Read/Write	Yes
756A3C4C	Edit Position	The row-column pair index of the current text entry. Values of (0,0) indicate the top-left text entry. A value of –1 indicates the row or column header. Values of (–2, –2) indicate that no edits are being made to the text of the control.	Read/Write	Yes
756A3C4D	Visible Items:Hierarchy Lines Visible	If Visible, lines to outline the hierarchy of the items are always visible as vertical and horizontal lines to the left of the items in the tree control. If Invisible, the hierarchy lines are always invisible. If OS Default, LabVIEW displays the hierarchy lines if trees in the operating system show hierarchy lines.	Read/Write	Yes
756A3C4E	Focus Item		Read/Write	Yes

Methods

Show/Hide TreeControl Properties Table

Legend
RTE	Available in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated

TreeControl Methods Table

Method ID	Long Name (English)	Description	RTE
756A3800	Navigate Tree:Get Next Item	Returns the tag of the first item after an item at the same level in the hierarchy. If no items exist after the item at the same level in the hierarchy, the method returns an empty string.	Yes (Read/Write)
756A3801	Navigate Tree:Get Parent Item	Returns the tag of the parent item above an item. If the item is the topmost item in the tree control, the method returns an empty string.	Yes (Read/Write)
756A3802	Navigate Tree:Get Path	Returns an array of unique tags for each item in the path from the root level in the tree control to the item.	Yes (Read/Write)
756A3803	Edit Tree Items:Delete Item	Deletes an item from the tree control. Wire an empty string to tag and a value of TRUE to Delete Children to delete all items in the tree control.	Yes (Read/Write)
756A3804	Edit Tree Items:Add Item	Adds an item to the tree control.	Yes (Read/Write)
756A3805	Edit Tree Items:Add Item to End	Adds an item after all existing items in the tree control.	Yes (Read/Write)
756A3806	Open/Close:Item	Expands or closes a node in the tree control.	Yes (Read/Write)
756A3807	Edit Tree Items:Sort Children	Sorts the child items under an item alphabetically.	Yes (Read/Write)
756A3808	Open/Close:Ensure Visible	Scrolls to an item and if necessary, expands nodes in the tree control to make the item visible.	Yes (Read/Write)
756A3809	Open/Close:All	Expands or closes all nodes in the tree control.	Yes (Read/Write)
756A380A	Double Click	Returns the unique tag of the last item the user double-clicked or returns an empty string if the user did not double-click an item since you last called this method.	Yes (Read/Write)
756A380C	Edit Tree Items:Move Item	Moves an existing item to a new position in the tree control.	Yes (Read/Write)
756A380D	Navigate Tree:Get Child	Returns the tag of the first child item under an item. If the item has no child items, the method returns an empty string.	Yes (Read/Write)
756A380E	Edit Tree Items:Set Tag	Sets the unique tag of a tree control item, which you use to modify the item or to gather information about the item programmatically.	Yes (Read/Write)
756A380F	Custom Item Symbols:Get Symbol	Returns the item symbol as a cluster of image data so you can draw it as a picture using the Draw Flattened Pixmap VI or save the image to a file using the Graphics Formats VIs.	Yes (Read/Write)
756A3810	Custom Item Symbols:Get Symbol Array	Returns the item symbols as an array of clusters of image data so you can draw them as pictures using the Draw Flattened Pixmap VI or save the images to files using the Graphics Formats VIs.	Yes (Read/Write)
756A3811	Custom Item Symbols:Set To Custom Symbol	Sets the image of an item symbol.	Yes (Read/Write)
756A3812	Custom Item Symbols:Set To Custom Symbol Array	Sets the images of all item symbols.	Yes (Read/Write)
756A3813	Custom Item Symbols:Revert To Built In Symbol	Resets an item symbol to the default symbol for its index.	Yes (Read/Write)
756A3814	Custom Item Symbols:Revert All To Built In Symbols	Resets all item symbols to the default symbols.	Yes (Read/Write)
756A3815	Point to Row Column	Converts a pixel coordinate to a tag-column pair in the coordinates of the control. This method also returns whether the point is inside the bounds of the content rectangle and whether the point is within the custom symbol of the cell. The method returns the tag TREE_COLUMN_HEADERS when you wire a point that is within the tree's column headers.	Yes (Read/Write)
756A3816	Navigate Tree:Get Previous Item	Returns the tag of the item immediately before and at the same hierarchical level as the one you provide as an input. If no items exist before the item at the same level in the hierarchy, this method returns an empty string.	Yes (Read/Write)
756A3817	Edit Tree Items:Add Multiple Items to End	Adds items after all existing items in the tree control.	Yes (Read/Write)

Events

Show/Hide TreeControl Events Table

Legend
Basic Development Environment
VI Scripting
Private
Deprecated

TreeControl Events Table

Code	Name	Description	Type
1073741880	Edit Cell	Generated when the user enters new text or changes text in a cell.	Notify
2147483703	Edit Cell?	Generated when the user enters new text or changes text in a cell but before the new or changed text appears.	Filter
1073741846	Double Click	Generated when a user double-clicks an item in the tree control.	Notify
1073741855	Item Close	Generated when the user closes an item in the tree control to hide any child items under the item.	Notify
2147483665	Item Close?	Generated when the user closes an item in the tree control to hide any child items under the item but before the item closes.	Filter
1073741854	Item Open	Generated when the user expands an item in the tree control to display any child items under the item.	Notify
2147483664	Item Open?	Generated when the user expands an item in the tree control to display any child items under the item but before the item opens.	Filter

History

Version	Change(s)
	More info to come.

See Also

• VI Server Class Hierarchy
• VI Server
• VI Scripting