Toggle Class

class NXOpen.BlockStyler.Toggle

Bases: NXOpen.BlockStyler.UIBlock

Represents a Toggle block

New in version NX8.5.0.

Properties

Property	Description
BalloonTooltipLayoutAsString	Returns or sets the BalloonTooltipLayout as string
BalloonTooltipOffImage	Returns or sets the BalloonTooltipOffImage
BalloonTooltipOffText	Returns or sets the BalloonTooltipOffText
BalloonTooltipOnImage	Returns or sets the BalloonTooltipOnImage
BalloonTooltipOnText	Returns or sets the BalloonTooltipOnText
Bitmap	Returns or sets the Bitmap
BitmapOnly	Returns or sets the BitmapOnly
Enable	Returns or sets the Enable.
Expanded	Returns or sets the Expanded
Group	Returns or sets the Group
Label	Returns or sets the Label
Localize	Returns or sets the Localize
Name	Returns the name of the block or BlockID
RetainValue	Returns or sets the RetainValue
Show	Returns or sets the Visibility of block.
Tag	Returns the Tag for this object.
Type	Returns the type of block
Value	Returns or sets the Value

Methods

Method	Description
Focus	Focuses on the block.
GetBalloonTooltipLayoutMembers	Gets the BalloonTooltipLayout member
GetProperties	Returns the properties of the block

Property Detail

BalloonTooltipLayoutAsString

Toggle.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.

BalloonTooltipOffImage

Toggle.BalloonTooltipOffImage

Returns or sets the BalloonTooltipOffImage

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

Getter Method

Signature BalloonTooltipOffImage

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature BalloonTooltipOffImage

Parameters:imageString (str) –

New in version NX8.5.0.

License requirements: None.

BalloonTooltipOffText

Toggle.BalloonTooltipOffText

Returns or sets the BalloonTooltipOffText

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

Getter Method

Signature BalloonTooltipOffText

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature BalloonTooltipOffText

Parameters:tooltipString (str) –

New in version NX8.5.0.

License requirements: None.

BalloonTooltipOnImage

Toggle.BalloonTooltipOnImage

Returns or sets the BalloonTooltipOnImage

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

Getter Method

Signature BalloonTooltipOnImage

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature BalloonTooltipOnImage

Parameters:imageString (str) –

New in version NX8.5.0.

License requirements: None.

BalloonTooltipOnText

Toggle.BalloonTooltipOnText

Returns or sets the BalloonTooltipOnText

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

Getter Method

Signature BalloonTooltipOnText

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature BalloonTooltipOnText

Parameters:tooltipString (str) –

New in version NX8.5.0.

License requirements: None.

Bitmap

Toggle.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.

BitmapOnly

Toggle.BitmapOnly

Returns or sets the BitmapOnly

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

Getter Method

Signature BitmapOnly

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature BitmapOnly

Parameters:bitmapOnly (bool) –

New in version NX8.5.0.

License requirements: None.

Localize

Toggle.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.

RetainValue

Toggle.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.

Value

Toggle.Value

Returns or sets the Value

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

Getter Method

Signature Value

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature Value

Parameters:valueProperty (bool) –

New in version NX8.5.0.

License requirements: None.

Method Detail

GetBalloonTooltipLayoutMembers

Toggle.GetBalloonTooltipLayoutMembers

Gets the BalloonTooltipLayout member

Signature GetBalloonTooltipLayoutMembers()

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

New in version NX8.5.0.

License requirements: None.