TextBoxStyleSetting Class

class NXOpen.CAE.Xyplot.TextBoxStyleSetting

Bases: NXOpen.CAE.Xyplot.BaseDisplayStyleSetting

Represents the text box display style.

Call CAE.Xyplot.BaseDisplayStyleSetting.CommitChange() to apply style changes to corresponding plot after it’s modified. Not support KF.

New in version NX9.0.0.

Properties

Property Description
Color Returns or sets the text box outline color
FillingColor Returns or sets the text box filling color
IsFilled Returns or sets a value indicating whether to fill the text box
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
Owner Returns the owner style
Tag Returns the Tag for this object.
Visibility Returns or sets a value indicating whether to display the text box

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.
GetLineStyle Gets the text box line style
GetMargin Gets the margin value of text box
SetMargin Sets the margin value of text box

Property Detail

Color

TextBoxStyleSetting.Color

Returns or sets the text box outline color

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

Getter Method

Signature Color

Returns:
Return type:Id

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature Color

Parameters:color (Id) –

New in version NX9.0.0.

License requirements: None.

FillingColor

TextBoxStyleSetting.FillingColor

Returns or sets the text box filling color

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

Getter Method

Signature FillingColor

Returns:
Return type:Id

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature FillingColor

Parameters:fillingColor (Id) –

New in version NX9.0.0.

License requirements: None.

IsFilled

TextBoxStyleSetting.IsFilled

Returns or sets a value indicating whether to fill the text box

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

Getter Method

Signature IsFilled

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature IsFilled

Parameters:isFilled (bool) –

New in version NX9.0.0.

License requirements: None.

Owner

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

Visibility

TextBoxStyleSetting.Visibility

Returns or sets a value indicating whether to display the text box

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

Getter Method

Signature Visibility

Returns:
Return type:bool

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature Visibility

Parameters:visibility (bool) –

New in version NX9.0.0.

License requirements: None.

Method Detail

CommitChange

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

GetLineStyle

TextBoxStyleSetting.GetLineStyle

Gets the text box line style

Signature GetLineStyle()

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

New in version NX12.0.0.

License requirements: None.

GetMargin

TextBoxStyleSetting.GetMargin

Gets the margin value of text box

Signature GetMargin(marginOption)

Parameters:marginOption (NXOpen.CAE.Xyplot.TextBoxMarginOption) – margin option
Returns:
Return type:float

New in version NX12.0.0.

License requirements: None.

SetMargin

TextBoxStyleSetting.SetMargin

Sets the margin value of text box

Signature SetMargin(marginOption, marginValue)

Parameters:

New in version NX12.0.0.

License requirements: None.