CustomTextStyleSetting Class

class NXOpen.CAE.Xyplot.CustomTextStyleSetting

Bases: NXOpen.CAE.Xyplot.TextStyleSetting

Represents the text content definition in title options

Not support KF.

New in version NX9.0.0.

Properties

Property	Description
Alignment	Returns or sets the text alignment.
Color	Returns or sets the text color
Font	Returns or sets the text font
FontStyle	Returns or sets the text font style.
FontType	Returns or sets the text font type
GlobalSizeScale	Returns or sets the scale of global text size.
IsGlobalSizeAutoScaled	Returns or sets a value indicating whether to automatically adjust the scale of global text size to fit the screen.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
LeaderStyle	Returns the leader style
NumberFormat	Returns the number format options
Orientation	Returns or sets the text orientation.
Owner	Returns the owner style
Size	Returns or sets the text size.
Tag	Returns the Tag for this object.
TextBoxStyle	Returns the style of text box
UseAutomatic	Returns or sets a value indicating whether to define text content automatically .
UseGlobalFontSetting	Returns or sets a value indicating whether to use the global setting of text font, font style and font size.
Visibility	Returns or sets the visibility
Weight	Returns or sets the text weight.

Methods

Method	Description
CommitChange	Commits any edits that have been applied to the display style.
Find	Finds the NXOpen.TaggedObject with the given identifier as recorded in a journal.
GetUserDefinedText	Returns the text content defined by user.
SetUserDefinedText	Sets the text content defined by user.

Property Detail

Owner

CustomTextStyleSetting.Owner

Returns the owner style

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

Getter Method

Signature Owner

Returns: Return type:NXOpen.CAE.Xyplot.IDisplayStyle

New in version NX10.0.0.

License requirements: None.

UseAutomatic

CustomTextStyleSetting.UseAutomatic

Returns or sets a value indicating whether to define text content automatically .

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

Getter Method

Signature UseAutomatic

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature UseAutomatic

Parameters:useAutomatic (bool) –

New in version NX9.0.0.

License requirements: None.

Visibility

CustomTextStyleSetting.Visibility

Returns or sets the visibility

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

Getter Method

Signature Visibility

Returns: Return type:bool

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature Visibility

Parameters:visibility (bool) –

New in version NX12.0.0.

License requirements: None.

Method Detail

CommitChange

CustomTextStyleSetting.CommitChange

Commits any edits that have been applied to the display style.

Triggers the corresponding plot to update graph.

Signature CommitChange()

New in version NX9.0.0.

License requirements: None.

GetUserDefinedText

CustomTextStyleSetting.GetUserDefinedText

Returns the text content defined by user.

Signature GetUserDefinedText()

Returns: Return type:list of str

New in version NX11.0.0.

License requirements: None.

SetUserDefinedText

CustomTextStyleSetting.SetUserDefinedText

Sets the text content defined by user.

Signature SetUserDefinedText(text)

Parameters:text (list of str) –

New in version NX11.0.0.

License requirements: None.