String class
| VI Server Class Information | |
|---|---|
| Return to VI Server Class Hierarchy | |
| Class Name | String class |
| Class ID | 27 |
| 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 String class is a class in the VI Server Class Hierarchy, (see also VI Server).
Contents |
Properties
Show/Hide String 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 |
|---|---|---|---|---|
| 6345800 | Value | Value of string control. | Read/Write | Yes |
| 6345801 | Text Size | Read/Write | Yes | |
| 6345802 | Text Size:Width | Width of the frame around the text area of the string control in pixels. | Read/Write | Yes |
| 6345803 | Text Size:Height | Height of the frame around the text area of the string control in pixels. | Read/Write | Yes |
| 6345804 | Text | Reference to the text inside the string control. | Read Only | Yes |
| 6345805 | Display Style | Sets the display style of a string object. Valid values include 0 (normal), 1 (backslash '\' codes), 2 (password), and 3 (hex). You cannot write to this property when the referenced string control has key focus. | Read/Write | Yes |
| 6345806 | Scrollbar Visible | Read/Write | Yes | |
| 6345807 | Limit To Single Line? | If TRUE, the user cannot enter a carriage return in the control or indicator. However, the user can copy the first line of a string and paste it in the string control or indicator. | Read/Write | Yes |
| 6345808 | Update While Typing? | Updates the value of a string as the user enters characters instead of waiting until the user presses the <Enter> key or otherwise ends text entry. | Read/Write | Yes |
| 6345809 | Default Value | Gets or sets the default value of the string control. | Read/Write | Yes (Read Only) |
| 634580A | Force Unicode Text | Read/Write | Yes | |
| 634580B | Prealloc Length | Read/Write | Yes | |
| 634580C | Value (Signaling) | Sets the value of the control and generates a Value Change event. | Write Only | Yes |
| 634580D | Size | Width and height in pixels of the frame around the text area of the string control. | Read/Write | Yes |
| 634580E | Size:Width | Width of the frame around the text area of the string control in pixels. | Read/Write | Yes |
| 634580F | Size:Height | Height of the frame around the text area of the string control in pixels. | Read/Write | Yes |
| 6345810 | Vertical Scrollbar Visible | If TRUE, displays a vertical scroll bar. | Read/Write | Yes |
| 6345811 | Horizontal Scrollbar Visible | If TRUE, displays a horizontal scroll bar. | Read/Write | Yes |
| 6345812 | Enable Wrapping | If FALSE, disables word wrapping, wrapping only at line breaks instead. | Read/Write | Yes |
| 6345813 | Allow Dragging | If TRUE, LabVIEW starts a drag and drop operation when you use the Operating tool to drag text from this control. | Read/Write | Yes |
| 6345814 | Allow Dropping | If TRUE, the control automatically accepts text dragged to it, including the LV_TEXT data type from drag and drop events. The LV_TEXT data type is of type string. If FALSE, LabVIEW does not automatically accept any drops, including from the operating system, at run time. LabVIEW returns error 1157 if you set this property on an indicator. | Read/Write | Yes |
| 6345815 | Display Format Visible? | Gets or sets the visibility of the display format for the string control. | Read/Write | Yes (Read Only) |
Methods
Show/Hide String Properties Table
| Legend | |
|---|---|
| RTE | Available in the Run-Time Engine |
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated | |
| Method ID | Long Name (English) | Description | RTE |
|---|---|---|---|
| 6345400 | Size to Text | Resizes the string control vertically to show all text. This method does not resize the string control horizontally. | Yes (Read/Write) |
| 6345401 | Get Nth Line | Gets the characters that make up the Nth line in a string control and returns the offsets in the original string in bytes. | Yes (Read/Write) |
| 6345402 | Byte Offset from Point | Returns the byte offset of the string from the given point. | Yes (Read/Write) |
| 6345403 | Append String | Appends a string to the existing value of the referenced string control. | Yes (Read/Write) |
Events
This class has no events or it inherits events from its parent: Control Class.
History
 |
History information is needed. What changes have occurred over previous versions? |
| Version | Change(s) |
|---|---|
|
More info to come. |