TreeControl class

From LabVIEW Wiki
Jump to: navigation, search
VI Server Class Information
Return to VI Server Class Hierarchy
Class Name TreeControl class
Class ID 66
Scope Basic Development Environment
Class Inheritance
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/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
TreeControl Properties Table
Property ID Long Name (English) Description R/W RTE
756A3C00Column Header Strings[]An array of the strings in the column headers.Read/WriteYes
756A3C01Visible Items:Vertical Scrollbar VisibleIf TRUE, displays the vertical scroll bar.Read/WriteYes
756A3C02Visible Items:Horizontal Scrollbar VisibleIf TRUE, displays the horizontal scroll bar.Read/WriteYes
756A3C03Number of RowsNumber of visible rows in the tree control, excluding column headers. This property counts partially visible rows.Read/WriteYes
756A3C04Number of ColumnsNumber of visible columns in the tree control. This property counts partially visible columns.Read/WriteYes
756A3C05Visible Items:Column Headers VisibleIf TRUE, displays the column headers.Read/WriteYes
756A3C06Autosizing Row HeightDetermines whether the rows autosize their height to display all text when fonts change or when the number of lines in a cell changes.Read/WriteYes
756A3C07Multiple Line InputIf 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/WriteYes
756A3C08Selection ColorThe color used to highlight the selected items.Read/WriteYes
756A3C09Top Left Visible CellThe 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/WriteYes
756A3C0AVisible Items:Symbols VisibleIf TRUE, displays the item symbols.Read/WriteYes
756A3C0BKeyboard ModeSets 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/WriteYes
756A3C0CSelection ModeNumber 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/WriteYes
756A3C0DActive Item:TagThe tag of the item(s) to which you want to apply subsequent property changes.Read/WriteYes
756A3C0EActive Item:Open?If TRUE, the active item(s) appears expanded to display items indented under it.Read/WriteYes
756A3C0FActive Item:Disabled?If TRUE, the active item(s) appears dimmed and you cannot select the item(s).Read/WriteYes
756A3C10Active Item:Child-Only?If TRUE, you cannot indent other items under the active item(s).Read/WriteYes
756A3C11Active Item:Indent LevelThe 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/WriteYes
756A3C12Active Item:Symbol IndexThe index of the symbol for the active item(s).Read/WriteYes
756A3C13Active Cell:Active Column NumberSets the column of the active cell(s).Read/WriteYes
756A3C14Active Cell:Background ColorThe background color of the active cell(s).Read/WriteYes
756A3C15Active Cell:Foreground ColorRead/WriteYes
756A3C16Active Cell:Cell SizeThe size of the active cell(s) in pixels.Read/WriteYes
756A3C17Active Cell:Cell Size:HeightThe height of the active cell(s) in pixels.Read/WriteYes
756A3C18Active Cell:Cell Size:WidthThe width of the active cell(s) in pixels.Read/WriteYes
756A3C19Active Cell:StringThe string in the active cell(s).Read/WriteYes
756A3C1ATwisty TypeRead/WriteYes
756A3C1CDisplayed ItemsReturns 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 OnlyYes
756A3C1DVisible Items:Hierarchy Lines Visible OldRead/WriteYes
756A3C1EAllow Selection of Parent ItemsIf 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/WriteYes
756A3C1FDrag/Drop:Allow Dragging of Parent ItemsIf FALSE, the user cannot drag an item in the tree control unless the item is child-only.Read/WriteYes
756A3C20Drag/Drop:Allow Dropping Between ItemsIf FALSE, the user cannot drag an item to place it between two other items at the same hierarchical level.Read/WriteYes
756A3C21Visible Items:Vertical Lines VisibleIf TRUE, displays vertical lines that separate columns in the tree control.Read/WriteYes
756A3C22Visible Items:Horizontal Lines VisibleIf TRUE, displays horizontal lines that separate rows in the tree control.Read/WriteYes
756A3C23Drag/Drop:Allow Dragging (Deprecated)Read/WriteYes
756A3C24Expand/Contract Symbol:Symbol TypeThe 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/WriteYes
756A3C25Active Cell:Old Cell SizeRead/WriteYes
756A3C26Active Cell:OldHeightRead/WriteYes
756A3C27Active Cell:OldWidthRead/WriteYes
756A3C28SizeThe width and height in pixels of the tree control.Read/WriteYes
756A3C29Size:WidthThe width of the active cell(s) in pixels.Read/WriteYes
756A3C2ASize:HeightThe height of the active cell(s) in pixels.Read/WriteYes
756A3C2BContent Rect PositionThe 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 OnlyYes
756A3C2CContent Rect Position:LeftThe coordinate in pixels, relative to the origin of the owning pane, of the left edge of the content rectangle of the tree control.Read OnlyYes
756A3C2DContent Rect Position:TopThe coordinate in pixels, relative to the origin of the owning pane, of the top edge of the content rectangle of the tree control.Read OnlyYes
756A3C2EContent Rect BoundsThe size in pixels of the content rectangle of the tree control.Read OnlyYes
756A3C2FContent Rect Bounds:WidthThe width in pixels of the content rectangle of the tree control.Read OnlyYes
756A3C30Content Rect Bounds:HeightThe height in pixels of the content rectangle of the tree control.Read OnlyYes
756A3C31Active Cell:PositionThe coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the active cell(s).Read OnlyYes
756A3C32Active Cell:Position:LeftThe coordinate in pixels, relative to the origin of the owning pane, of the left edge of the active cell.Read OnlyYes
756A3C33Active Cell:Position:TopThe coordinate in pixels, relative to the origin of the owning pane, of the top edge of the active cell.Read OnlyYes
756A3C34Active Cell:Cell FontThe font of the active cell in the tree control.Read/WriteYes
756A3C35Active Cell:Cell Font:NameThe name of the font in the active cell. Predefined font names include App Font, Sys Font, and Dlg Font.Read/WriteYes
756A3C36Active Cell:Cell Font:SizeThe size of the font in the active cell.Read/WriteYes
756A3C37Active Cell:Cell Font:BoldIndicates whether the text in the active cell is bold.Read/WriteYes
756A3C38Active Cell:Cell Font:ItalicIndicates whether the text in the active cell is italic.Read/WriteYes
756A3C39Active Cell:Cell Font:UnderlineIndicates whether the text in the active cell is underlined.Read/WriteYes
756A3C3AActive Cell:Cell Font:StrikeoutIndicates whether to strike out the text in the active cell.Read/WriteYes
756A3C3BActive Cell:Cell Font:ColorThe text font color in the active cell.Read/WriteYes
756A3C3CActive Cell:Cell JustificationGets and sets the justification of text.Read/WriteYes
756A3C3DAllow Editing CellsIf 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/WriteYes
756A3C3EOld Edit PositionRead/WriteYes
756A3C3FVisible Items:Row Headers VisibleShows the row headers.Read/WriteYes
756A3C40Row Header Strings[]An array of the strings in the row headers.Read/WriteYes
756A3C41Is Array?Returns TRUE if the tree has an array data type.Read/WriteYes
756A3C42Active Item:Row NumberThe 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/WriteYes
756A3C43All TagsThe 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 OnlyYes
756A3C44Sibling MultiselectIf TRUE and the Selection Mode is 0 or More Items, users can select multiple items only if those items are siblings.Read/WriteYes
756A3C46Drag/Drop:Allow DraggingIf TRUE, you can drag items from this control.Read/WriteYes
756A3C47Drag/Drop:Allow DroppingIf 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/WriteYes
756A3C48Expand/Contract Symbol:Show Symbol at RootShows 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/WriteYes
756A3C49Drag/Drop:Drag ModeSets 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/WriteYes
756A3C4ADrag/Drop:Allow Drag and Drop Outside ControlIf TRUE, this enables the control to drag items to other controls and accept drags from other controls.Read/WriteYes
756A3C4BSelect Entire RowsHighlights the entire row if you select a row in the tree.Read/WriteYes
756A3C4CEdit PositionThe 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/WriteYes
756A3C4DVisible Items:Hierarchy Lines VisibleIf 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/WriteYes
756A3C4EFocus ItemRead/WriteYes

Methods

Show/Hide TreeControl Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
TreeControl Methods Table
Method ID Long Name (English) Description RTE
756A3800Navigate Tree:Get Next ItemReturns 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)
756A3801Navigate Tree:Get Parent ItemReturns 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)
756A3802Navigate Tree:Get PathReturns 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)
756A3803Edit Tree Items:Delete ItemDeletes 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)
756A3804Edit Tree Items:Add ItemAdds an item to the tree control.Yes (Read/Write)
756A3805Edit Tree Items:Add Item to EndAdds an item after all existing items in the tree control.Yes (Read/Write)
756A3806Open/Close:ItemExpands or closes a node in the tree control.Yes (Read/Write)
756A3807Edit Tree Items:Sort ChildrenSorts the child items under an item alphabetically.Yes (Read/Write)
756A3808Open/Close:Ensure VisibleScrolls to an item and if necessary, expands nodes in the tree control to make the item visible.Yes (Read/Write)
756A3809Open/Close:AllExpands or closes all nodes in the tree control.Yes (Read/Write)
756A380ADouble ClickReturns 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)
756A380CEdit Tree Items:Move ItemMoves an existing item to a new position in the tree control.Yes (Read/Write)
756A380DNavigate Tree:Get ChildReturns 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)
756A380EEdit Tree Items:Set TagSets 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)
756A380FCustom Item Symbols:Get SymbolReturns 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)
756A3810Custom Item Symbols:Get Symbol ArrayReturns 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)
756A3811Custom Item Symbols:Set To Custom SymbolSets the image of an item symbol.Yes (Read/Write)
756A3812Custom Item Symbols:Set To Custom Symbol ArraySets the images of all item symbols.Yes (Read/Write)
756A3813Custom Item Symbols:Revert To Built In SymbolResets an item symbol to the default symbol for its index.Yes (Read/Write)
756A3814Custom Item Symbols:Revert All To Built In SymbolsResets all item symbols to the default symbols.Yes (Read/Write)
756A3815Point to Row ColumnConverts 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)
756A3816Navigate Tree:Get Previous ItemReturns 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)
756A3817Edit Tree Items:Add Multiple Items to EndAdds 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
1073741880Edit CellGenerated when the user enters new text or changes text in a cell.Notify
2147483703Edit Cell?Generated when the user enters new text or changes text in a cell but before the new or changed text appears.Filter
1073741846Double ClickGenerated when a user double-clicks an item in the tree control.Notify
1073741855Item CloseGenerated when the user closes an item in the tree control to hide any child items under the item.Notify
2147483665Item 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
1073741854Item OpenGenerated when the user expands an item in the tree control to display any child items under the item.Notify
2147483664Item 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)
LabVIEW 2018 More info to come.

See Also