String

The String block provides a control to input a single string to the command.

NX also provides a keystroke callback to process the input typed in the String block for each keystroke — see Keystroke callback for the String block (source: xid1474058).

Inherited general properties

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

Block-specific properties

Property Name	Description	Access	Property Type	List of Values
BalloonTooltipTexts	Specifies balloon tooltip text for each item in the (Combo Box) list. Each item must have a corresponding text value.	CIGS	String	List of any string values. Type NULL for items without a text value; type \n for a line feed.
BalloonTooltipImages	Specifies the file name of the image displayed in the balloon tooltip corresponding to an item in the list. Each item in the Combo Box list must have a corresponding value. All images must have the same size. Type NULL for items without a corresponding image.	CIGS	String	Valid bitmap file name from the NX library (no suffix/extension needed), or complete file path. Supports TIFF, PNG, GIF, JPEG, BMP.
BalloonTooltipLayout	Specifies the location of text with respect to the image in the balloon tooltip. Applicable only when both text and image are specified.	CIGS	Enum	Horizontal — default; text to the right of image. Vertical — text below image; use when image is >300px wide or width:height ratio > 4.
Bitmap	Specifies the name of the Bitmap image used by this block.	CSG	String	Any valid bitmap image name (full path can also be specified).
IsPassword	Specifies whether characters are readable. Relevant only if PresentationStyle is KeyIn or Wide.	CIG	Logical	TRUE — characters not readable, displayed as *. FALSE — characters displayed and readable correctly.
ListItems	Contains the list of items for the list box. Available only if PresentationStyle is List or Combo.	CSG	Strings	Any string value.
Localize	Allows localization of the block Label if it matches an English string in the NX localization database.	CIG	Logical	TRUE — translate. FALSE — do not translate.
MaxTextLength	Specifies the maximum number of characters accepted by the block.	CIG	Integer	Any integer between 1 and 1024. A value less than 1 defaults to 132. A value greater than 1024 is capped to 1024.
PresentationStyle	Specifies the presentation style of the string control.	CIG	Enum	KeyIn — normal text box. Wide — wide text box. List — list box. Combo — combo box.
Hint	Available when PresentationStyle is Wide. Specifies a hint NX displays in the block when focus is not on the field and it is empty.	CIGS	String	Any string value.
ReadOnlyString	Specifies read/write permission for the string block.	CIG	Logical	TRUE — string cannot be modified. FALSE — string can be modified.
RetainValue	Determines if the block's value is saved in dialog memory (upon OK, Apply, or Close).	CGS (inferred, consistent with other blocks)	Logical	TRUE / FALSE.
Value	Specifies the string value in the text box. See Keystroke callback for the String block for more information.	CSG	String	Any string value.
Width	Specifies the width of the text field. Available only when PresentationStyle is KeyIn.	CIG	Enum	NARROW — narrow text field. STANDARD — larger than narrow.
RequiredInput	Specifies that string input to the block is required; NX enables OK/Apply after a non-blank character is entered. Not available if ReadOnlyString is TRUE.	CIG	Enum	Yes — input required. No — input not required.
UncommittedValue	Specifies the string's uncommitted value in the text box (the in-progress text before it's committed/parsed).	CSG	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.

Related Basic blocks

Multi-Line String, Toggle, List Box, Layer, Line Width, Line Style, Line Color/Style/Width, Text Color/Font/Width.