Custom Item Symbols:Set To Custom Symbol Method

LabView Local Project Settings

Custom Item Symbols:Set To Custom Symbol Method

Short Name: Custom Item Symbols.Set Symbol

Installed With: Full Development System

Class: TreeControl Methods

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.

Example

Parameters

NameRequiredDescription
IndexNoThe index of the symbol you want to set. The default is 0. You also can wire a listbox symbol ring constant to this parameter to select the custom item symbol you want to replace with a default item symbol.
ImageNoDescribes the image you want to use for the item symbol. Images that are less than or equal to 16 × 16 pixels appear as their actual size. If you use an image that is larger than 16 × 16 pixels, LabVIEW shrinks the image to 16 × 16 pixels before displaying it as a tree control item symbol.

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 Setting Custom Item Symbols VI in the labview\examples\general\controls\treecontrol directory for an example of using the Custom Item Symbols:Set To Custom Symbol method.

 Open example  Browse related examples