Text class
| VI Server Class Information | |
|---|---|
| Return to VI Server Class Hierarchy | |
| Class Name | Text class |
| Class ID | 5 |
| Scope | Basic Development Environment |
| Class Inheritance |
|
| Class Children |
|
 |
This article is a stub. You can help LabVIEW Wiki by expanding it. Please improve this article if you can. |
The Text class is a class in the VI Server Class Hierarchy, (see also VI Server).
Contents |
Properties
Show/Hide Text Properties Table
| Legend | |
|---|---|
| R/W | Readable/Writable Permissions |
| RTE | Available in the Run-Time Engine |
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated | |
| Property ID | Long Name (English) | Description | R/W | RTE |
|---|---|---|---|---|
| 632D800 | Text | 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. | Read/Write | Yes |
| 632D801 | Font | Cluster of font name, size, bold, italic, underline, strikeout. | Read/Write | Yes |
| 632D802 | Selection | Text selection specified in terms of character positions for the beginning of selection (inclusive) and end of selection (not inclusive). If you set the start and end to be the same, LabVIEW inserts a caret into the text. | Read/Write | Yes |
| 632D803 | Selection:Start | Character position for the beginning of selection (inclusive). | Read/Write | Yes |
| 632D804 | Selection:End | Allows you to select the end point of text in a text string. | Read/Write | Yes |
| 632D805 | Scroll Position | Position of the scroll box in the scroll bar. | Read/Write | Yes |
| 632D806 | Size to Text? | Sets whether the size of the text object changes according to the text included. You can write this property only for free labels, control labels, and captions. | Read/Write | Yes |
| 632D807 | Font:Name | Font name. Predefined font names include App Font, Sys Font, and Dlg Font. If you provide an empty string, this property returns an error. | Read/Write | Yes |
| 632D808 | Font:Size | Font size. | Read/Write | Yes |
| 632D809 | Font:Bold | Indicates whether the text is bold. | Read/Write | Yes |
| 632D80A | Font:Italic | Indicates whether the text is italic. | Read/Write | Yes |
| 632D80B | Font:Underline | Indicates whether the text is underlined. | Read/Write | Yes |
| 632D80C | Font:Strikeout | Indicates whether the text is in the strikeout font. | Read/Write | Yes |
| 632D80D | Font:Color | Sets the color of the currently selected text. You can use the Selection property to select a subset of a string. | Read/Write | Yes |
| 632D80E | Text Colors | Changes the foreground and background color of a text string. | Read/Write | Yes |
| 632D80F | Text Colors:Text Color | Text color for all fonts in the text. | Read/Write | Yes |
| 632D810 | Text Colors:BG Color | Background color of text object. | Read/Write | Yes |
| 632D811 | Interpret As Unicode | Read/Write | Yes | |
| 632D812 | Document Bounds | Returns the size required to display the entire text. | Read Only | Yes |
| 632D813 | Document Bounds:Width | Returns the width required to display the entire text. | Read Only | Yes |
| 632D814 | Document Bounds:Height | Returns the height required to display the entire text. | Read Only | Yes |
| 632D815 | Justification | Gets and sets the justification of text. | Read/Write | Yes |
| 632D816 | Vertical Arrangement | Gets and sets the vertical arrangement for the text. You can set the vertical arrangement for labels, captions, and free labels. | Read/Write | Yes |
| 632D817 | Lock | Locks the label or caption to the owning control, indicator, or terminal. You cannot set this property on text fields that are not labels or captions, such as Boolean text, numeric text, free labels, and so on. | Read/Write | Yes |
| 632D818 | FontType | Write Only | Yes | |
| 632D819 | Attached Object | Gets or sets the reference to a block diagram object to which a text label is attached. This property only works with free labels on the block diagram. | Read/Write | Yes |
| 632D81A | Enable Hyperlinks | Read/Write | Yes | |
| 632D81B | Text Overflow | Read/Write | Yes |
Methods
Show/Hide Text Properties Table
| Legend | |
|---|---|
| RTE | Available in the Run-Time Engine |
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated | |
| Method ID | Long Name (English) | Description | RTE |
|---|---|---|---|
| 632D400 | Move to Default Location | Move a label to its default location relative to its owner. | Yes (Read/Write) |
Events
This class has no events or it inherits events from its parent: Decoration Class.
History
 |
History information is needed. What changes have occurred over previous versions? |
| Version | Change(s) |
|---|---|
|
More info to come. |