StringBlock Class

class NXOpen.BlockStyler.StringBlock

Bases: NXOpen.BlockStyler.UIBlock

Represents a String block

New in version NX8.5.0.

Properties

Property	Description
AllowInternationalTextInput	Returns or sets the AllowInternationalTextInput
BalloonTooltipLayoutAsString	Returns or sets the BalloonTooltipLayout as string
Bitmap	Returns or sets the Bitmap
Enable	Returns or sets the Enable.
Expanded	Returns or sets the Expanded
Group	Returns or sets the Group
IsPassword	Returns or sets the IsPassword.
Label	Returns or sets the Label
Localize	Returns or sets the Localize
MaxTextLength	Returns or sets the MaxTextLength
Name	Returns the name of the block or BlockID
PresentationStyleAsString	Returns or sets the PresentationStyle as string
ReadOnlyString	Returns or sets the ReadOnlyString
RetainValue	Returns or sets the RetainValue
Show	Returns or sets the Visibility of block.
Tag	Returns the Tag for this object.
Tooltip	Returns or sets the Tooltip
Type	Returns the type of block
Value	Returns or sets the Value
WideValue	Returns or sets the WideValue.
WidthAsString	Returns or sets the Width as string

Methods

Method	Description
Focus	Focuses on the block.
GetBalloonTooltipImages	Gets the BalloonTooltipImages
GetBalloonTooltipLayoutMembers	Gets the BalloonTooltipLayout members
GetBalloonTooltipTexts	Gets the BalloonTooltipTexts
GetListItems	Gets the ListItems
GetPresentationStyleMembers	Gets the PresentationStyle members
GetProperties	Returns the properties of the block
GetWidthMembers	Gets the Width members
SetBalloonTooltipImages	Sets the BalloonTooltipImages
SetBalloonTooltipTexts	Sets the BalloonTooltipTexts
SetListItems	Sets the ListItems

Property Detail

AllowInternationalTextInput

StringBlock.AllowInternationalTextInput

Returns or sets the AllowInternationalTextInput

-------------------------------------

Getter Method

Signature AllowInternationalTextInput

Returns: Return type:bool

New in version NX8.5.0.

Deprecated since version NX12.0.0: Not required from NX10 onwards. Internationalization is available by default.

License requirements: None.

-------------------------------------

Setter Method

Signature AllowInternationalTextInput

Parameters:allow (bool) –

New in version NX8.5.0.

Deprecated since version NX12.0.0: Not required from NX10 onwards. Internationalization is available by default.

License requirements: None.

BalloonTooltipLayoutAsString

StringBlock.BalloonTooltipLayoutAsString

Returns or sets the BalloonTooltipLayout as string

-------------------------------------

Getter Method

Signature BalloonTooltipLayoutAsString

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature BalloonTooltipLayoutAsString

Parameters:enumString (str) –

New in version NX8.5.0.

License requirements: None.

Bitmap

StringBlock.Bitmap

Returns or sets the Bitmap

-------------------------------------

Getter Method

Signature Bitmap

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Bitmap

Parameters:bitmapString (str) –

New in version NX8.5.0.

License requirements: None.

IsPassword

StringBlock.IsPassword

Returns or sets the IsPassword.

If true, characters will not be readable. They will be displayed as *.

-------------------------------------

Getter Method

Signature IsPassword

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IsPassword

Parameters:passwrod (bool) –

New in version NX8.5.0.

License requirements: None.

Localize

StringBlock.Localize

Returns or sets the Localize

-------------------------------------

Getter Method

Signature Localize

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Localize

Parameters:localize (bool) –

New in version NX8.5.0.

License requirements: None.

MaxTextLength

StringBlock.MaxTextLength

Returns or sets the MaxTextLength

-------------------------------------

Getter Method

Signature MaxTextLength

Returns: Return type:int

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MaxTextLength

Parameters:textLength (int) –

New in version NX8.5.0.

License requirements: None.

PresentationStyleAsString

StringBlock.PresentationStyleAsString

Returns or sets the PresentationStyle as string

-------------------------------------

Getter Method

Signature PresentationStyleAsString

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PresentationStyleAsString

Parameters:enumString (str) –

New in version NX8.5.0.

License requirements: None.

ReadOnlyString

StringBlock.ReadOnlyString

Returns or sets the ReadOnlyString

-------------------------------------

Getter Method

Signature ReadOnlyString

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ReadOnlyString

Parameters:readonly (bool) –

New in version NX8.5.0.

License requirements: None.

RetainValue

StringBlock.RetainValue

Returns or sets the RetainValue

-------------------------------------

Getter Method

Signature RetainValue

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RetainValue

Parameters:retain (bool) –

New in version NX8.5.0.

License requirements: None.

Tooltip

StringBlock.Tooltip

Returns or sets the Tooltip

-------------------------------------

Getter Method

Signature Tooltip

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Tooltip

Parameters:tooltipString (str) –

New in version NX8.5.0.

License requirements: None.

Value

StringBlock.Value

Returns or sets the Value

-------------------------------------

Getter Method

Signature Value

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Value

Parameters:valueString (str) –

New in version NX8.5.0.

License requirements: None.

WideValue

StringBlock.WideValue

Returns or sets the WideValue.

Specifies the International text. This property accepts international characters supported by NX.

-------------------------------------

Getter Method

Signature WideValue

Returns: Return type:str

New in version NX8.5.0.

Deprecated since version NX12.0.0: Use ‘Value’ instead which supports Internationalization.

License requirements: None.

-------------------------------------

Setter Method

Signature WideValue

Parameters:wideValueString (str) –

New in version NX8.5.0.

Deprecated since version NX12.0.0: Use ‘Value’ instead which supports Internationalization.

License requirements: None.

WidthAsString

StringBlock.WidthAsString

Returns or sets the Width as string

-------------------------------------

Getter Method

Signature WidthAsString

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature WidthAsString

Parameters:enumString (str) –

New in version NX8.5.0.

License requirements: None.

Method Detail

GetBalloonTooltipImages

StringBlock.GetBalloonTooltipImages

Gets the BalloonTooltipImages

Signature GetBalloonTooltipImages()

Returns: Return type:list of str

New in version NX8.5.0.

License requirements: None.

GetBalloonTooltipLayoutMembers

StringBlock.GetBalloonTooltipLayoutMembers

Gets the BalloonTooltipLayout members

Signature GetBalloonTooltipLayoutMembers()

Returns:Values to get from the property Return type:list of str

New in version NX8.5.0.

License requirements: None.

GetBalloonTooltipTexts

StringBlock.GetBalloonTooltipTexts

Gets the BalloonTooltipTexts

Signature GetBalloonTooltipTexts()

Returns:Values to get from the property. Return type:list of str

New in version NX8.5.0.

License requirements: None.

GetListItems

StringBlock.GetListItems

Gets the ListItems

Signature GetListItems()

Returns:Values to get from the property Return type:list of str

New in version NX8.5.0.

License requirements: None.

GetPresentationStyleMembers

StringBlock.GetPresentationStyleMembers

Gets the PresentationStyle members

Signature GetPresentationStyleMembers()

Returns:Values to get from the property. Return type:list of str

New in version NX8.5.0.

License requirements: None.

GetWidthMembers

StringBlock.GetWidthMembers

Gets the Width members

Signature GetWidthMembers()

Returns:Values to get from the property. Return type:list of str

New in version NX8.5.0.

License requirements: None.

SetBalloonTooltipImages

StringBlock.SetBalloonTooltipImages

Sets the BalloonTooltipImages

Signature SetBalloonTooltipImages(imageStrings)

Parameters:imageStrings (list of str) –

New in version NX8.5.0.

License requirements: None.

SetBalloonTooltipTexts

StringBlock.SetBalloonTooltipTexts

Sets the BalloonTooltipTexts

Signature SetBalloonTooltipTexts(tooltipTextArray)

Parameters:tooltipTextArray (list of str) – Value to set for the property.

New in version NX8.5.0.

License requirements: None.

SetListItems

StringBlock.SetListItems

Sets the ListItems

Signature SetListItems(itemStrings)

Parameters:itemStrings (list of str) – Value to set to the property

New in version NX8.5.0.

License requirements: None.