String class

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name	class
Class ID	{{{1}}}
Scope
Class Inheritance	This class is a top-level class.
Class Children	This class has no children.

The String class is a class in the VI Server Class Hierarchy, (see also VI Server).

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

String Properties Table

Property ID	Short Name (English)	Description	R/W	RTE
6345813	Allow Dragging	If TRUE, LabVIEW starts a drag and drop operation when you use the Operating tool to drag text from this control. Use the Control events for more control over how users drag items within controls.	R/W	X
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. Use the Control events for more control over how users drag items within controls.	R/W	X
6345809	DefVal	Gets or sets the default value of the string control.	R/W	X
6345815	DisplayFormatVisibility	Gets or sets the visibility of the display format for the string control. This property is similar to the Visible Items»Display Style item on the shortcut menu of a string object and the Display Style Visible checkbox on the Appearance page of the String Properties dialog box.	R/W	X
6345805	DispStyle	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. This property is similar to the Display items on the shortcut menu of a string object.	R/W	X
6345812	EnableWrap	If FALSE, disables word wrapping, wrapping only at line breaks instead. To use this property, you must set the display style to 0 (normal). This property is similar to the Enable Wrapping item on the shortcut menu of a string control and the Wrap at word breaks option on the Appearance page of the String Properties dialog box.	R/W	X
634580A	Force Unicode Text		R/W	X
6345811	HScrollVis	If TRUE, displays a horizontal scroll bar. Before you display a horizontal scroll bar, you must set Enable Wrapping to FALSE and set the display style to 0 (normal). This property is similar to the Visible Items»Horizontal Scrollbar item on the shortcut menu of a string control and the Show horizontal scroll bar option on the Appearance page of the String Properties dialog box.	R/W	X
6345807	LimitSglLine	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. This property is similar to the Limit to Single Line item on the shortcut menu of a string object.	R/W	X
634580B	PreallocLen		R/W	X
634580D	Size	Width and height in pixels of the frame around the text area of the string control. This property is similar to the Size Height and Size Width options on the Appearance page of the Properties dialog box.	R/W	X
634580F	Height	Height of the frame around the text area of the string control in pixels. This property is an element of the Size property. This property is similar to the Size Height option on the Appearance page of the Properties dialog box.	R/W	X
634580E	Width	Width of the frame around the text area of the string control in pixels. This property is an element of the Size property. This property is similar to the Size Width option on the Appearance page of the Properties dialog box.	R/W	X
6345804	Text	Reference to the text inside the string control.	R	X
6345808	UpdtWhileTyping	Updates the value of a string as the user enters characters instead of waiting until the user presses the key or otherwise ends text entry. This property is similar to the Update Value while Typing item on the shortcut menu of a string object.	R/W	X
6345800	Value	Value of string control.	R/W	X
634580C	Val(Sgnl)	Sets the value of the control and generates a Value Change event. This property updates the value of an object similar to the Value property. However, Value (Signaling) also causes LabVIEW to generate an event as if the user had interactively changed the value of the object. National Instruments recommends you use this property only when you rely on LabVIEW generating an event in response to the programmatic value change.	W	X
6345810	VScrollVis	If TRUE, displays a vertical scroll bar. This property is similar to the Visible Items»Vertical Scrollbar item on the shortcut menu of a string control and the Show vertical scroll bar option on the Appearance page of the String Properties dialog box.	R/W	X

Methods

Show/Hide String Methods Table

Legend
RTE	Available in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated

String Methods Table

Method ID	Short Name (English)	Description	RTE
6345403	Append String	Appends a string to the existing value of the referenced string control.	X
6345402	ByteOffFromPt	Returns the byte offset of the string from the given point.	X
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. You can use this method to determine how the text in a string control is word-wrapped. The position indexes are byte indexes. These are usually equivalent to character indexes, except when using text that has characters that use multiple bytes, such as Asian character sets. Example	X
6345400	Size to Text	Resizes the string control vertically to show all text. This method does not resize the string control horizontally. This method is similar to the Size to text option on the Appearance page of the Properties dialog box.	X

Events

No Events for this class.

History

Version	Change(s)
	More info to come.

See Also

• VI Server Class Hierarchy
• VI Server
• VI Scripting