Edit Tree Items:Add Item Method
Short Name: Edit Tree Items.Add Item
Installed With: Full Development System
Class: TreeControl Methods
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.
Parameters
Name | Required | Description |
---|---|---|
Parent Tag | No | Unique tag of the item under which you want to add the new item. The default is an empty string, which adds the item to the highest level in the hierarchy. |
Child Position | No | Sets where to place the new item in relation to the item whose tag you wire to Parent Tag. Wire a value of 0 (default) to place the new item directly under the parent item. Wire a value of 1 to place the new item under the first child item, a value of 2 to place the new item under the second child item, and so on. Wire a value of –1 to place the new item under the last child item. If the value you wire to this input is greater than the number of child items under the parent item, the method places the new item under the last child item. |
Left Cell String | No | Text to display in the leftmost cell for the new item. The default is an empty string. |
Child Text | No | Array of strings to display in the remaining cells for the new item. The default is an array of empty strings. |
Child Tag | No | Unique tag for the new item. The default is the string you wire to Left Cell. If an existing tag already uses that string, LabVIEW appends a number to the string to create a unique tag for the new item. 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 new item. If the tag you wire to the method begins or ends with white space, LabVIEW removes the white space. |
Child Only? | No | If TRUE, you cannot indent other items under the new item. The default is FALSE. This property is similar to the Child-Only Item item on the shortcut menu of a tree control. |
output | No | Tag for the new item. |
Remarks
The following table lists the characteristics of this method.
Available in Run-Time Engine and Real-Time Operating System | Yes (Read/Write) |
Settable when the VI is running | Yes |
Loads the front panel into memory | No |
Need to authenticate before use | No |
Loads the block diagram into memory | No |
Remote access disallowed | No |
Must wait until user interface is idle | No |
Available with control VIs | No |
Available with global VIs | No |
Available with strict type definitions | No |
Available with polymorphic VIs | No |
Example
Refer to the Directory Hierarchy in Tree Control VI in the labview\examples\general\controls\Tree Control Directory.llb for an example of using the Edit Tree Items:Add Item method.