Text class/Text property
|VI Server Property Information|
|Scope||Basic Development Environment|
|* Displayed here in English. Short and Long names appear in the language of the LabVIEW IDE.|
|Owning Class ID||5|
|Owning Class Name||Text Class|
|Data Type||String data type|
|Available in Real-Time Operating System||Yes|
|Available in Run-Time Engine||Yes|
|Loads the block diagram into memory||No|
|Loads the front panel into memory||No|
|Need to authenticate before use||No|
|Remote access allowed||Yes|
|Settable when the VI is running||Yes|
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.
|Specific use cases for this property.|
|History information is needed. What changes have occurred over previous versions?|
|More info to come.|
|Add links to internal wiki pages that would also help.|
|Add links to external resources that would also help.|