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
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	Short Name (English)	Description	R/W	RTE
756A3C13	ActiveColNum	Sets the column of the active cell(s). The following table lists example values for this property. Value Result -2 Selects all columns. -1 Selects all column headers. 0 Selects the first column. Wire the index of a specific column to select a specific column.	R/W	X
756A3C14	CellBG	The background color of the active cell(s). You can set the color of the front panel object by wiring a hexadecimal number with the form RRGGBB or by wiring the color box constant to the property.	R/W	X
756A3C34	CellFont	The font of the active cell in the tree control. Use this property to change the size, style, or color of the cell font. You cannot use this property with a strict type definition.	R/W	X
756A3C37	CellFontBold	Indicates whether the text in the active cell is bold. This property is an element of the Active Cell:Cell Font property.	R/W	X
756A3C3B	CellFontColor	The text font color in the active cell. This property is an element of the Active Cell:Cell Font property.	R/W	X
756A3C38	CellFontItalic	Indicates whether the text in the active cell is italic. This property is an element of the Active Cell:Cell Font property.	R/W	X
756A3C35	CellFontName	The name of the font in the active cell. Predefined font names include App Font, Sys Font, and Dlg Font. This property is an element of the Active Cell:Cell Font property. If you select an invalid font, this property returns an error.	R/W	X
756A3C36	CellFontSize	The size of the font in the active cell. This property is an element of the Active Cell:Cell Font property.	R/W	X
756A3C3A	CellFontStrike	Indicates whether to strike out the text in the active cell. This property is an element of the Active Cell:Cell Font property.	R/W	X
756A3C39	CellFontUnder	Indicates whether the text in the active cell is underlined. This property is an element of the Active Cell:Cell Font property.	R/W	X
756A3C3C	CellJustify	Gets and sets the justification of text.	R/W	X
756A3C16	CellSize	The size of the active cell(s) in pixels. Changing the cell size does not change the size of the tree control.	R/W	X
756A3C17	Height	The height of the active cell(s) in pixels. This property is an element of the Active Cell:Cell Size property.	R/W	X
756A3C18	Width	The width of the active cell(s) in pixels. This property is an element of the Active Cell:Cell Size property.	R/W	X
756A3C31	ActiveCellPos	The coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the active cell(s).	R	X
756A3C32	ActiveCellPosLeft	The coordinate in pixels, relative to the origin of the owning pane, of the left edge of the active cell. This property is an element of the Active Cell:Position property.	R	X
756A3C33	ActiveCellPosTop	The coordinate in pixels, relative to the origin of the owning pane, of the top edge of the active cell. This property is an element of the Active Cell:Position property.	R	X
756A3C19	Cell String	The string in the active cell(s). If the active cell is all columns or all rows, this property returns an error.	R/W	X
756A3C10	Child-Only?	If TRUE, you cannot indent other items under the active item(s). If the active item is the column headers or if the active item has other items indented under it, this property returns an error. If the active item is all rows, the property returns an error. This property is similar to the Child-Only Item item on the shortcut menu of a tree control.	R/W	X
756A3C0F	Disabled?	If TRUE, the active item(s) appears dimmed and you cannot select the item(s). If the active item is the column headers or all rows, this property returns an error. This property is similar to the Disable Item item on the shortcut menu of a tree control.	R/W	X
756A3C11	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. If the active item is the column headers, this property returns an error. If the active item is all rows, this property returns an error. If you wire a value to this property that is more than one level greater than the indent level of the item above the item you want to indent, this property returns an error. This property is similar to the Indent Item and Outdent Item items on the shortcut menu of a tree control.	R/W	X
756A3C0E	Open?	If TRUE, the active item(s) appears expanded to display items indented under it. If the active item is the column headers or all rows, this property returns an error.	R/W	X
756A3C42	ActiveItemRowNumber	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. When you read this property, this property returns the row number of the active item. When you write to this property, this property sets the active item to the row number you specify. This property returns an error if you specify an invalid row number. An invalid row is an empty row below the tree.	R/W	X
756A3C12	Symbol	The index of the symbol for the active item(s). You can use a listbox symbol ring constant to view the default item symbols. You can use the Custom Item Symbols methods to customize item symbols. If the active item is the column headers, this property returns an error. If the active item is all rows and you read this property, the property returns an error.	R/W	X
756A3C0D	ActiveItemTag	The tag of the item(s) to which you want to apply subsequent property changes. The following table lists example values for this property. Value Result TREE_COLUMN_HEADERS Selects all column headers. TREE_ALL_ROWS Selects all rows. Wire the tag of a specific item to select a specific item.	R/W	X
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.	R	X
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. This property is similar to the Editable Cells item on the shortcut menu of a tree control.	R/W	X
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. This property is similar to the Allow Selection of Parent Items item on the shortcut menu of a tree control.	R/W	X
756A3C06	AutoRowHt	Determines whether the rows autosize their height to display all text when fonts change or when the number of lines in a cell changes. If FALSE, you can have clipped text in cells, and the user will be unable to manually resize the row height at run time to see all of the text. This property affects only user input. If you use the Value property to set the item strings, the rows do not automatically resize. To resize the rows, set this property to FALSE and then set it back to TRUE. This property is similar to the Autosize Row Height item on the shortcut menu of a tree control.	R/W	X
756A3C00	ColHdrs()	An array of the strings in the column headers.	R/W	X
756A3C2E	ContentRectBounds	The size in pixels of the content rectangle of the tree control.	R	X
756A3C30	ContentRectBoundsHeight	The height in pixels of the content rectangle of the tree control. This property is an element of the Content Rect Bounds property.	R	X
756A3C2F	ContentRectBoundsWidth	The width in pixels of the content rectangle of the tree control. This property is an element of the Content Rect Bounds property.	R	X
756A3C2B	ContentRectPos	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.	R	X
756A3C2C	ContentRectPosLeft	The coordinate in pixels, relative to the origin of the owning pane, of the left edge of the content rectangle of the tree control. This property is an element of the Content Rect Position property.	R	X
756A3C2D	ContentRectPosTop	The coordinate in pixels, relative to the origin of the owning pane, of the top edge of the content rectangle of the tree control. This property is an element of the Content Rect Position property.	R	X
756A3C1C	DispItems	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.	R	X
756A3C4A	AllowDragOutsideControl	If TRUE, this enables the control to drag items to other controls and accept drags from other controls. Use the Control events for more control over how users drag items within controls. You can use this property with the Drag/Drop:Allow Dragging and the Drag/Drop:Allow Dropping properties to allow data dragging to other controls and to accept data drops from other controls. This property is similar to the Allow Drag Drop Outside Control item on the shortcut menu of a tree control.	R/W	X
756A3C46	Allow Item Drag	If TRUE, you can drag items from this control. Use the Control events for more control over how users drag and drop items within controls. This property is similar to the Allow Dragging item on the shortcut menu of a tree control.	R/W	X
756A3C1F	Allow Dragging of Parent Items	If FALSE, the user cannot drag an item in the tree control unless the item is child-only. Use the Control events for more control over how users drag items within the tree control. This property is similar to the Allow Dragging of Parent Items item on the shortcut menu of a tree control.	R/W	X
756A3C47	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. Use the Control events for more control over how users drag items within controls. This property is similar to the Allow Dropping item on the shortcut menu of a tree control.	R/W	X
756A3C20	Allow Dropping Between Items	If FALSE, the user cannot drag an item to place it between two other items at the same hierarchical level. Use the Control events for more control over how users drag items within the tree control. This property is similar to the Allow Dropping Between Items item on the shortcut menu of a tree control.	R/W	X
756A3C49	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. Use the Control events for more control over how users drag and drop items within controls. This property is similar to the Drag Mode item on the shortcut menu of a tree control.	R/W	X
756A3C4C	EditPos	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. Before you use this property to set text focus on a control, set key focus of the control. Elements: Name Description Row The row of the current text entry. Possible values are 0…n, where n is the total number of rows - 1. Enter –1 to select a column header. Column The column of the current text entry. Possible values are 0…m, where m is the total number of columns - 1. Enter –1 to select a row header.	R/W	X
756A3C48	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. If you hide the expand/contract symbols, you can still expand or collapse an item at indent level 0 by double-clicking the item. To disable the double-clicking functionality, wire a True constant to the Discard? parameter of the Item Close? event.	R/W	X
756A3C24	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). This property is similar to the Expand/Contract Symbol Type item on the shortcut menu of a tree control.	R/W	X
756A3C4E	FocusItem		R/W	X
756A3C41	Is Array?	Returns TRUE if the tree has an array data type.	R/W	X
756A3C0B	KBrdMode	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). This property is similar to the Keyboard Mode item on the shortcut menu of a tree control.	R/W	X
756A3C07	MultilineInput	If TRUE, you can enter multiple lines of text in the tree control cells by pressing the key on the keyboard. If FALSE, pressing the 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. This property is similar to the Multi-line Input item on the shortcut menu of a tree control.	R/W	X
756A3C04	NumCols	Number of visible columns in the tree control. This property counts partially visible columns. If you wire a value of 0 to this property, LabVIEW displays the leftmost column. The tree control resizes according to the number of columns you set.	R/W	X
756A3C03	NumRows	Number of visible rows in the tree control, excluding column headers. This property counts partially visible rows. If you wire a value of 0 to this property, LabVIEW displays the topmost row. The tree control resizes according to the number of rows you set.	R/W	X
756A3C40	RowHdrs()	An array of the strings in the row headers.	R/W	X
756A3C4B	SelectEntireRows	Highlights the entire row if you select a row in the tree.	R/W	X
756A3C08	SelColor	The color used to highlight the selected items. You can set the color of the front panel object by wiring a hexadecimal number with the form RRGGBB or by wiring the color box constant to the property.	R/W	X
756A3C0C	SelMode	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). A single-selection tree control has a scalar data type, and a multiple-selection tree control has an array data type. If you set this property for a single-selection tree control to a value of 2 or 3, LabVIEW returns an error because LabVIEW cannot change the data type from scalar to array at run time. This property is similar to the Selection Mode item on the shortcut menu of a tree control.	R/W	X
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. If you enable Sibling Multiselect, but there are multiple non-sibling items already selected, subsequent selection behavior might not be intuitive. If you reset the selection to something valid, the selection behavior returns to normal. This property is similar to the Selection Mode»Limit Multiselect to Siblings item on the shortcut menu of a tree control.	R/W	X
756A3C28	Size	The width and height in pixels of the tree control. This property sizes the tree control similar to the Size property in the Listbox and Table control classes. This property is also similar to the Size Height and Size Width options on the Appearance page of the Properties dialog box.	R/W	X
756A3C2A	Height	The height of the active cell(s) in pixels. This property is an element of the Active Cell:Cell Size property.	R/W	X
756A3C29	Width	The width of the active cell(s) in pixels. This property is an element of the Active Cell:Cell Size property.	R/W	X
756A3C09	TopLeft	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. If you wire a tag of TREE_COLUMN_HEADERS or TREE_ALL_ROWS or a column of –2 to this property, the property returns an error. If the tree control contains no items, this property returns an error. This property returns the tag and column of the item string at the top left corner of the visible tree window, which is not necessarily the top left element of the tree. To access the top left element, wire a value of 0 to the Active Cell:Active Column Number property and to the Active Item:Row Number property. Elements: Name Description Node The value that appears in the top left corner of the tree control. Column The index of the leftmost column of information displayed in the tree control.	R/W	X
756A3C05	ColHdrVis	If TRUE, displays the column headers. This property is similar to the Visible Items»Column Headers item on the shortcut menu of a tree control and the Show column headers option on the Appearance page of the Tree Properties dialog box.	R/W	X
756A3C4D	HierarchyLinesVis	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. This property is similar to the Visible Items»Hierarchy Lines item on the shortcut menu of a tree control.	R/W	X
756A3C22	Horizontal Lines Visible	If TRUE, displays horizontal lines that separate rows in the tree control. This property is similar to the Visible Items»Horizontal Lines item on the shortcut menu of a tree control and the Show horizontal lines option on the Appearance page of the Properties dialog box.	R/W	X
756A3C02	HScrollVis	If TRUE, displays the horizontal scroll bar. This property is similar to the Visible Items»Horizontal Scrollbar item on the shortcut menu of a tree control.	R/W	X
756A3C3F	RowHdrVis	Shows the row headers. This property is similar to the Visible Items»Row Headers item on the shortcut menu of a tree control and to the Show row headers option on the Appearance page of the Tree Properties dialog box.	R/W	X
756A3C0A	SymsVis	If TRUE, displays the item symbols. This property is similar to the Visible Items»Symbols item on the shortcut menu of a tree control and the Show symbols option on the Appearance page of the Properties dialog box.	R/W	X
756A3C21	Vertical Lines Visible	If TRUE, displays vertical lines that separate columns in the tree control. This property is similar to the Visible Items»Vertical Lines item on the shortcut menu of a tree control and the Show vertical lines option on the Appearance page of the Properties dialog box.	R/W	X
756A3C01	VScrollVis	If TRUE, displays the vertical scroll bar. This property is similar to the Visible Items»Vertical Scrollbar item on the shortcut menu of a tree control.	R/W	X

Methods

Show/Hide TreeControl Methods Table

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

TreeControl Methods Table

Method ID	Short Name (English)	Description	RTE
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. The cluster returned by this method is similar to the image data output of the Read JPEG File, Read PNG File, and Read BMP File VIs.	X
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. The clusters returned by this method are similar to the image data output of the Read JPEG File, Read PNG File, and Read BMP File VIs.	X
756A3814	Custom Item Symbols.Revert Symbols	Resets all item symbols to the default symbols. You can use a listbox symbol ring constant to view the default item symbols.	X
756A3813	Custom Item Symbols.Revert Symbol	Resets an item symbol to the default symbol for its index.	X
756A3811	Custom Item Symbols.Set Symbol	Sets the image of an item symbol. If you want to use a picture to set the symbol, use the Picture to Pixmap VI to convert the data to an image data cluster before using this method. The image cluster you wire to this method is similar to the image data input of the Write JPEG File, Write PNG File, and Write BMP File VIs.	X
756A3812	Custom Item Symbols.Set Symbol Array	Sets the images of all item symbols. If you want to use a picture to set the symbols, use the Picture to Pixmap VI to convert the data to an image data cluster before using this method. The image clusters you wire to this method are similar to the image data input of the Write JPEG File, Write PNG File, and Write BMP File VIs.	X
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. You also can use the Double Click event to obtain information about items that the user double-clicks in the tree control.	X
756A3804	Edit Tree Items.Add Item	Adds an item to the tree control. This method is similar to the Insert Item Before item on the shortcut menu of a tree control.	X
756A3805	Edit Tree Items.Add Item to End	Adds an item after all existing items in the tree control.	X
756A3817	Edit Tree Items.Add Multiple Items to End	Adds items after all existing items in the tree control. This method returns an error if you set an item to an indent level that has no parent item.	X
756A3803	Edit Tree Items.Delete	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. If you do not update the value of a tree control after deleting a row, the control may return old data. Deleting a selected item does not change the value of a tree control. After you delete an item, the tree value may be a tag for an item that no longer exists. You can select one of the remaining tree items to update the value of the tree control. This method is similar to the Delete Item item on the shortcut menu of a tree control.	X
756A380C	Edit Tree Items.Move Item	Moves an existing item to a new position in the tree control.	X
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. You cannot create a tag that begins with TREE_. All tags that begin with TREE_ are reserved for use by LabVIEW. If the tag you wire to the method begins with TREE_, LabVIEW prepends an underscore (_) to create a valid tag for the item. If the tag you wire to the method begins or ends with white space, LabVIEW removes the white space. This method is similar to the Tag text box in the Edit Tree Items dialog box.	X
756A3807	Edit Tree Items.Sort Children	Sorts the child items under an item alphabetically.	X
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.	X
756A3800	Navigate Tree.Get Next	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.	X
756A3801	Navigate Tree.Get Parent	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.	X
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.	X
756A3816	Navigate Tree.Get Previous	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.	X
756A3809	Open/Close.Open/Close All		X
756A3808	Open/Close.Ensure Visible		X
756A3806	Open/Close.Item		X
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. Note The Point to Row Column method does not return an error for points that lie within a control but outside of the actual cell area for that control, such as the scroll bar. Use the InBounds parameter to verify that a point lies within the cell area of a control.	X

Events

Show/Hide TreeControl Events Table

Legend
Basic Development Environment
VI Scripting
Private
Deprecated

TreeControl Events Table

Code	Name	Type
1073741846	Double Click	Notify
1073741880	Edit Cell	Notify
2147483703	Edit Cell?	Filter
1073741855	Item Close	Notify
2147483665	Item Close?	Filter
1073741854	Item Open	Notify
2147483664	Item Open?	Filter

History

Version	Change(s)
	More info to come.

See Also

• VI Server Class Hierarchy
• VI Server
• VI Scripting