Multi-Line String

The Multi-line String block provides a control to input an array of strings to the command.

Inherited general properties

• BlockID
• Enable
• Group
• Label
• Show
• Expanded

Block-specific properties

Property Name	Description	Access	Property Type	List of Values
Height	Specifies the number of rows shown on the dialog.	CIG	Integer	Any value >= 0. Zero means use the default height.
Localize	Allows localization of the block Label if it matches an English string in the NX localization database.	CIG	Logical	TRUE — translate to current locale. FALSE — do not translate.
MaximumCharactersAccepted	Specifies the maximum number of characters accepted by the block.	CIG	Integer	Any value >= 0. Zero means the largest integer supported on both UNIX and Windows.
MaximumHeight	Specifies the maximum number of rows shown on the dialog when the dialog is resized. Valid only if ResizeHeightWithDialog is true.	CIG	Integer	Any value >= 0. Zero means no maximum.
MinimumHeight	Specifies the minimum number of rows shown on the dialog when the dialog is resized. Valid only if ResizeHeightWithDialog is true.	CIG	Integer	Any value >= 0. Zero means no minimum.
ResizeHeightWithDialog	Specifies whether the height dynamically changes when the dialog is resized.	CIG	Logical	TRUE — height changes. FALSE — height remains unchanged.
RetainValue	Determines if the block's value is saved in dialog memory (upon OK, Apply, or Close).	—	Logical	TRUE — retains the previous value. FALSE — does not retain the previous value.
Value	Contains the array of strings.	CSG	Strings	Any string values.
Width	Specifies the width of the string field shown on the dialog. Not used if the block is attached on the left and right to the borders of the dialog.	CIG	Integer	Any integer value >= 0. Zero means width is not specified.
ValuesConcatenated	Returns a string with all the values concatenated. Values are separated with new-line characters. To split back into separate strings, use "\\n" (extra backslash for the escape sequence).	SG	String	Any string value.

Access column legend

Character	Stands for	Meaning
C	Creation	Modifiable interactively in Block UI Styler at design time.
I	Initialize	Modifiable at run time via NXOpen API, but only during the Initialize callback.
G	Get	Readable via NXOpen API in any callback.
S	Set	Modifiable at run time via NXOpen API in any callback.