Edit Tree Items:Delete Item Method

LabView Local Project Settings

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.

Example

Parameters

NameRequiredDescription
tagNoUnique tag of the item you want to delete. The default is an empty string, which represents the root level in the tree control.
Delete ChildrenNoIf 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 SystemYes (Read/Write)
Settable when the VI is runningYes
Loads the front panel into memoryNo
Need to authenticate before useNo
Loads the block diagram into memoryNo
Remote access disallowedNo
Must wait until user interface is idleNo
Available with control VIsNo
Available with global VIsNo
Available with strict type definitionsNo
Available with polymorphic VIsNo

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.

 Open example  Browse related examples