WideString Class

class NXOpen.UIStyler.WideString

Bases: NXOpen.UIStyler.StylerItem

Represents a WideString for UI Styler

New in version NX5.0.0.

Properties

Property	Description
ItemValue	Returns or sets the string value for this dialog item.
Sensitivity	Returns or sets the sensitivity of the wide string
Visibility	Returns or sets the visibility of the wide string

Methods

Method	Description
AddActivateHandler	Registers activate callback.
Dispose	Free resources associated with the instance.
GetItemType	Gets the dialog item type.
InitializeAttachment	Returns initialized dialog item attachment information
IsEqualTo	Equates two styler items
SetAttachment	Specifies the updated dialog item attachment information
SetFocus	Indicates that this dialog item is receiving keyboard focus.
SetLabel	Specifies descriptive text to display for the dialog item.

Property Detail

ItemValue

WideString.ItemValue

Returns or sets the string value for this dialog item.

It can be the initial value that is programmatically defined, or interactively entered by the user.

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

Getter Method

Signature ItemValue

Returns: Return type:str

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature ItemValue

Parameters:itemValue (str) –

New in version NX5.0.0.

License requirements: None.

Sensitivity

WideString.Sensitivity

Returns or sets the sensitivity of the wide string

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

Getter Method

Signature Sensitivity

Returns: Return type:bool

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature Sensitivity

Parameters:type (bool) –

New in version NX5.0.0.

License requirements: None.

Visibility

WideString.Visibility

Returns or sets the visibility of the wide string

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

Getter Method

Signature Visibility

Returns: Return type:bool

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature Visibility

Parameters:type (bool) –

New in version NX5.0.0.

License requirements: None.

Method Detail

AddActivateHandler

WideString.AddActivateHandler

Registers activate callback.

This method should be called before calling UIStyler.Dialog.Show() or UIStyler.Dialog.RegisterWithUiMenu()

Signature AddActivateHandler(activateevent, isDialogLaunchingEvent)

Parameters:

• activateevent (CallableObject) –
• isDialogLaunchingEvent (bool) –

New in version NX5.0.0.

License requirements: None.

SetFocus

WideString.SetFocus

Indicates that this dialog item is receiving keyboard focus.

Signature SetFocus()

New in version NX5.0.0.

License requirements: None.

SetLabel

WideString.SetLabel

Specifies descriptive text to display for the dialog item.

It should describe the dialog item’s intended use

Signature SetLabel(strLabel)

Parameters:strLabel (str) – Label string

New in version NX5.0.0.

License requirements: None.