Edit Tree Items:Delete Item Method
Short Name: Edit Tree Items.Delete
Installed With: Full Development System
Class: TreeControl Methods
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.
Parameters
Name | Required | Description |
---|---|---|
tag | No | Unique tag of the item you want to delete. The default is an empty string, which represents the root level in the tree control. |
Delete Children | No | If TRUE (default), the method deletes all the child items under the item you want to delete. If FALSE, the method moves all the child items to level in the hierarchy of the item you want to delete before deleting the 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:Delete Item method.