NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::CAE::Xyplot::TextBoxStyleSetting Class Reference

Represents the text box display style. More...

Inheritance diagram for NXOpen::CAE::Xyplot::TextBoxStyleSetting:
NXOpen::CAE::Xyplot::BaseDisplayStyleSetting NXOpen::TaggedObject NXOpen::CAE::Xyplot::IDisplayStyle

Public Member Functions

NXOpen::NXColorColor ()
 Returns the text box outline color
Created in NX9.0.0. More...
 
NXOpen::NXColorFillingColor ()
 Returns the text box filling color
Created in NX9.0.0. More...
 
NXOpen::CAE::Xyplot::CurveDisplaySettingsGetLineStyle ()
 Gets the text box line style. More...
 
double GetMargin (NXOpen::CAE::Xyplot::TextBoxMarginOption marginOption)
 Gets the margin value of text box. More...
 
bool IsFilled ()
 Returns a value indicating whether to fill the text box
Created in NX9.0.0. More...
 
void SetColor (NXOpen::NXColor *color)
 Sets the text box outline color
Created in NX9.0.0. More...
 
void SetFilled (bool isFilled)
 Sets a value indicating whether to fill the text box
Created in NX9.0.0. More...
 
void SetFillingColor (NXOpen::NXColor *fillingColor)
 Sets the text box filling color
Created in NX9.0.0. More...
 
void SetMargin (NXOpen::CAE::Xyplot::TextBoxMarginOption marginOption, double marginValue)
 Sets the margin value of text box
Created in NX12.0.0. More...
 
void SetVisibility (bool visibility)
 Sets a value indicating whether to display the text box
Created in NX9.0.0. More...
 
bool Visibility ()
 Returns a value indicating whether to display the text box
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAE::Xyplot::BaseDisplayStyleSetting
virtual void CommitChange ()
 Commits any edits that have been applied to the display style. More...
 
NXOpen::TaggedObjectFind (const NXString &journalIdentifier)
 Finds the NXOpen::TaggedObject with the given identifier as recorded in a journal. More...
 
NXOpen::TaggedObjectFind (const char *journalIdentifier)
 Finds the NXOpen::TaggedObject with the given identifier as recorded in a journal. More...
 
NXString JournalIdentifier ()
 Returns the identifier that would be recorded in a journal for this object. More...
 
virtual
NXOpen::CAE::Xyplot::IDisplayStyle
Owner ()
 Returns the owner style
Created in NX10.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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.

Created in NX9.0.0.

Member Function Documentation

NXOpen::NXColor* NXOpen::CAE::Xyplot::TextBoxStyleSetting::Color ( )

Returns the text box outline color
Created in NX9.0.0.



License requirements : None

NXOpen::NXColor* NXOpen::CAE::Xyplot::TextBoxStyleSetting::FillingColor ( )

Returns the text box filling color
Created in NX9.0.0.



License requirements : None

NXOpen::CAE::Xyplot::CurveDisplaySettings* NXOpen::CAE::Xyplot::TextBoxStyleSetting::GetLineStyle ( )

Gets the text box line style.

Returns

Created in NX12.0.0.

License requirements : None
double NXOpen::CAE::Xyplot::TextBoxStyleSetting::GetMargin ( NXOpen::CAE::Xyplot::TextBoxMarginOption  marginOption)

Gets the margin value of text box.

Returns

Created in NX12.0.0.

License requirements : None
Parameters
marginOptionmargin option
bool NXOpen::CAE::Xyplot::TextBoxStyleSetting::IsFilled ( )

Returns a value indicating whether to fill the text box
Created in NX9.0.0.



License requirements : None

void NXOpen::CAE::Xyplot::TextBoxStyleSetting::SetColor ( NXOpen::NXColor color)

Sets the text box outline color
Created in NX9.0.0.



License requirements : None

Parameters
colorcolor
void NXOpen::CAE::Xyplot::TextBoxStyleSetting::SetFilled ( bool  isFilled)

Sets a value indicating whether to fill the text box
Created in NX9.0.0.



License requirements : None

Parameters
isFilledisfilled
void NXOpen::CAE::Xyplot::TextBoxStyleSetting::SetFillingColor ( NXOpen::NXColor fillingColor)

Sets the text box filling color
Created in NX9.0.0.



License requirements : None

Parameters
fillingColorfillingcolor
void NXOpen::CAE::Xyplot::TextBoxStyleSetting::SetMargin ( NXOpen::CAE::Xyplot::TextBoxMarginOption  marginOption,
double  marginValue 
)

Sets the margin value of text box
Created in NX12.0.0.



License requirements : None

Parameters
marginOptionmargin option
marginValuemarginvalue
void NXOpen::CAE::Xyplot::TextBoxStyleSetting::SetVisibility ( bool  visibility)

Sets a value indicating whether to display the text box
Created in NX9.0.0.



License requirements : None

Parameters
visibilityvisibility
bool NXOpen::CAE::Xyplot::TextBoxStyleSetting::Visibility ( )

Returns a value indicating whether to display the text box
Created in NX9.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.