Text Property

Short Name: Text

Requires: Base Development System

Text as displayed in the front panel object. For example, if you set a string control to use Password Display, this property returns the password string, such as ****, not the Normal Display of the string.

If the text string is a free label or a caption, you can write this property when the VI is running, and it is available in the Run-Time Engine. If the text string is an owned label, you cannot write this property when the VI is running, and it is available in the Run-Time Engine only for reading.

If the text string is a unit label, you can write this property when the VI is running, and it is available in the Run-Time Engine. However, the unit you write must be compatible with the existing unit. If the units are not compatible, LabVIEW returns an error and sets the unit label to the base unit.

If you read or write this property for a nonexistent caption in a VI that is not running, LabVIEW creates the caption. If the VI is running, LabVIEW returns an error.

If you want to determine whether a front panel object has a caption, use the Has Caption property instead of comparing the value of the Text property to an empty string. When you read the Text property of a nonexistent caption, LabVIEW creates a caption and copies the label into the caption. Therefore, the Text property does not accurately reflect whether the caption contained text before the Text property was called.

Example

Remarks

The following table lists the characteristics of this property.

Data type
Permissions	Read/Write
Available in Run-Time Engine	Yes
Available in Real-Time Operating System	Yes
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 allowed	Yes

Example

Refer to the Numeric with Units VI in the labview\examples\Controls and Indicators\Numeric directory for an example of using the Text property.

Open example Find related examples