Represents the text display style. More...

Inheritance diagram for NXOpen::CAE::Xyplot::TextStyleSetting:

Public Member Functions
NXOpen::CAE::Xyplot::TextAlignment	Alignment ()
	Returns the text alignment.

NXOpen::NXColor *	Color ()
	Returns the text color Created in NX9.0.0.

virtual void	CommitChange ()
	Commits any edits that have been applied to the display style.

NXString	Font ()
	Returns the text font Created in NX9.0.0.

NXOpen::Preferences::VisualizationFonts::StyleType	FontStyle ()
	Returns the text font style.

NXOpen::CAE::Xyplot::Fonttype	FontType ()
	Returns the text font type Created in NX9.0.0.

double	GlobalSizeScale ()
	Returns the scale of global text size.

bool	IsGlobalSizeAutoScaled ()
	Returns a value indicating whether to automatically adjust the scale of global text size to fit the screen.

NXOpen::CAE::Xyplot::TextOrientation	Orientation ()
	Returns the text orientation.

void	SetAlignment (NXOpen::CAE::Xyplot::TextAlignment alignment)
	Sets the text alignment.

void	SetColor (NXOpen::NXColor *color)
	Sets the text color Created in NX9.0.0.

void	SetFont (const NXString &font)
	Sets the text font Created in NX9.0.0.

void	SetFont (const char *font)
	Sets the text font Created in NX9.0.0.

void	SetFontStyle (NXOpen::Preferences::VisualizationFonts::StyleType fontStyle)
	Sets the text font style.

void	SetFontType (NXOpen::CAE::Xyplot::Fonttype fontType)
	Sets the text font type Created in NX9.0.0.

void	SetGlobalSizeAutoScaled (bool isGlobalSizeAutoScaled)
	Sets a value indicating whether to automatically adjust the scale of global text size to fit the screen.

void	SetGlobalSizeScale (double sizeScale)
	Sets the scale of global text size.

void	SetOrientation (NXOpen::CAE::Xyplot::TextOrientation orientation)
	Sets the text orientation.

void	SetSize (int size)
	Sets the text size.

void	SetUseGlobalFontSetting (bool useGlobalFontSetting)
	Sets a value indicating whether to use the global setting of text font, font style and font size.

void	SetWeight (NXOpen::Display::TransientText::TextSize weight)
	Sets the text weight.

int	Size ()
	Returns the text size.

NXOpen::CAE::Xyplot::TextBoxStyleSetting *	TextBoxStyle ()
	Returns the style of text box Created in NX9.0.0.

bool	UseGlobalFontSetting ()
	Returns a value indicating whether to use the global setting of text font, font style and font size.

NXOpen::Display::TransientText::TextSize	Weight ()
	Returns the text weight.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents the text display style.

Call CAE::Xyplot::IDisplayStyle::CommitChange to apply style changes to corresponding plot after it's modified.
Not support KF.

Created in NX9.0.0.

Member Function Documentation

NXOpen::CAE::Xyplot::TextAlignment NXOpen::CAE::Xyplot::TextStyleSetting::Alignment ( )

Returns the text alignment.

Only valid for title options, legend options and axis label options.
Created in NX9.0.0.

License requirements : None

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

Returns the text color
Created in NX9.0.0.

License requirements : None

virtual void NXOpen::CAE::Xyplot::TextStyleSetting::CommitChange ( )

virtual

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

           Triggers the corresponding plot to update graph.

Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Implements NXOpen::CAE::Xyplot::IDisplayStyle.

NXString NXOpen::CAE::Xyplot::TextStyleSetting::Font ( )

Returns the text font
Created in NX9.0.0.

License requirements : None

NXOpen::Preferences::VisualizationFonts::StyleType NXOpen::CAE::Xyplot::TextStyleSetting::FontStyle ( )

Returns the text font style.

Available when the text font is standard font.
Created in NX9.0.0.

License requirements : None

NXOpen::CAE::Xyplot::Fonttype NXOpen::CAE::Xyplot::TextStyleSetting::FontType ( )

Returns the text font type
Created in NX9.0.0.

License requirements : None

double NXOpen::CAE::Xyplot::TextStyleSetting::GlobalSizeScale ( )

Returns the scale of global text size.

           It will be taken only when @link CAE::Xyplot::TextStyleSetting::UseGlobalFontSetting CAE::Xyplot::TextStyleSetting::UseGlobalFontSetting @endlink and @link CAE::Xyplot::TextStyleSetting::SetUseGlobalFontSetting CAE::Xyplot::TextStyleSetting::SetUseGlobalFontSetting @endlink  is true,
           and @link CAE::Xyplot::TextStyleSetting::IsGlobalSizeAutoScaled CAE::Xyplot::TextStyleSetting::IsGlobalSizeAutoScaled @endlink and @link CAE::Xyplot::TextStyleSetting::SetGlobalSizeAutoScaled CAE::Xyplot::TextStyleSetting::SetGlobalSizeAutoScaled @endlink  is false.

Created in NX9.0.0.

License requirements : None

bool NXOpen::CAE::Xyplot::TextStyleSetting::IsGlobalSizeAutoScaled ( )

Returns a value indicating whether to automatically adjust the scale of global text size to fit the screen.

           It will be taken only when @link CAE::Xyplot::TextStyleSetting::UseGlobalFontSetting CAE::Xyplot::TextStyleSetting::UseGlobalFontSetting @endlink and @link CAE::Xyplot::TextStyleSetting::SetUseGlobalFontSetting CAE::Xyplot::TextStyleSetting::SetUseGlobalFontSetting @endlink  is true.

Created in NX9.0.0.

License requirements : None

NXOpen::CAE::Xyplot::TextOrientation NXOpen::CAE::Xyplot::TextStyleSetting::Orientation ( )

Returns the text orientation.

Only invalid for legend options.
Created in NX9.0.0.

License requirements : None

void NXOpen::CAE::Xyplot::TextStyleSetting::SetAlignment ( NXOpen::CAE::Xyplot::TextAlignment alignment )

Sets the text alignment.

Only valid for title options, legend options and axis label options.
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

alignment alignment

void NXOpen::CAE::Xyplot::TextStyleSetting::SetColor ( NXOpen::NXColor * color )

Sets the text color
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

color color

void NXOpen::CAE::Xyplot::TextStyleSetting::SetFont ( const NXString & font )

Sets the text font
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

font font

void NXOpen::CAE::Xyplot::TextStyleSetting::SetFont ( const char * font )

Sets the text font
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

font font

void NXOpen::CAE::Xyplot::TextStyleSetting::SetFontStyle ( NXOpen::Preferences::VisualizationFonts::StyleType fontStyle )

Sets the text font style.

Available when the text font is standard font.
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

fontStyle fontstyle

void NXOpen::CAE::Xyplot::TextStyleSetting::SetFontType ( NXOpen::CAE::Xyplot::Fonttype fontType )

Sets the text font type
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

fontType fonttype

void NXOpen::CAE::Xyplot::TextStyleSetting::SetGlobalSizeAutoScaled ( bool isGlobalSizeAutoScaled )

Sets a value indicating whether to automatically adjust the scale of global text size to fit the screen.

           It will be taken only when @link CAE::Xyplot::TextStyleSetting::UseGlobalFontSetting CAE::Xyplot::TextStyleSetting::UseGlobalFontSetting @endlink and @link CAE::Xyplot::TextStyleSetting::SetUseGlobalFontSetting CAE::Xyplot::TextStyleSetting::SetUseGlobalFontSetting @endlink  is true.

Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

isGlobalSizeAutoScaled isglobalsizeautoscaled

void NXOpen::CAE::Xyplot::TextStyleSetting::SetGlobalSizeScale ( double sizeScale )

Sets the scale of global text size.

           It will be taken only when @link CAE::Xyplot::TextStyleSetting::UseGlobalFontSetting CAE::Xyplot::TextStyleSetting::UseGlobalFontSetting @endlink and @link CAE::Xyplot::TextStyleSetting::SetUseGlobalFontSetting CAE::Xyplot::TextStyleSetting::SetUseGlobalFontSetting @endlink  is true,
           and @link CAE::Xyplot::TextStyleSetting::IsGlobalSizeAutoScaled CAE::Xyplot::TextStyleSetting::IsGlobalSizeAutoScaled @endlink and @link CAE::Xyplot::TextStyleSetting::SetGlobalSizeAutoScaled CAE::Xyplot::TextStyleSetting::SetGlobalSizeAutoScaled @endlink  is false.

Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

sizeScale sizescale

void NXOpen::CAE::Xyplot::TextStyleSetting::SetOrientation ( NXOpen::CAE::Xyplot::TextOrientation orientation )

Sets the text orientation.

Only invalid for legend options.
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

orientation orientation

void NXOpen::CAE::Xyplot::TextStyleSetting::SetSize ( int size )

Sets the text size.

The acceptable range is 1-10.
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

size size

void NXOpen::CAE::Xyplot::TextStyleSetting::SetUseGlobalFontSetting ( bool useGlobalFontSetting )

Sets a value indicating whether to use the global setting of text font, font style and font size.

           If True, you need to set text size scale by setting @link CAE::Xyplot::TextStyleSetting::IsGlobalSizeAutoScaled CAE::Xyplot::TextStyleSetting::IsGlobalSizeAutoScaled @endlink and @link CAE::Xyplot::TextStyleSetting::SetGlobalSizeAutoScaled CAE::Xyplot::TextStyleSetting::SetGlobalSizeAutoScaled @endlink  or
           @link CAE::Xyplot::TextStyleSetting::GlobalSizeScale CAE::Xyplot::TextStyleSetting::GlobalSizeScale @endlink and @link CAE::Xyplot::TextStyleSetting::SetGlobalSizeScale CAE::Xyplot::TextStyleSetting::SetGlobalSizeScale @endlink

Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

useGlobalFontSetting useglobalfontsetting

void NXOpen::CAE::Xyplot::TextStyleSetting::SetWeight ( NXOpen::Display::TransientText::TextSize weight )

Sets the text weight.

Available when the text font is NX font.
Created in NX9.0.0.

License requirements : nx_ftk ("NX Advanced Graphing")

Parameters

weight weight

int NXOpen::CAE::Xyplot::TextStyleSetting::Size ( )

Returns the text size.

The acceptable range is 1-10.
Created in NX9.0.0.

License requirements : None

NXOpen::CAE::Xyplot::TextBoxStyleSetting* NXOpen::CAE::Xyplot::TextStyleSetting::TextBoxStyle ( )

Returns the style of text box
Created in NX9.0.0.

License requirements : None

bool NXOpen::CAE::Xyplot::TextStyleSetting::UseGlobalFontSetting ( )

Returns a value indicating whether to use the global setting of text font, font style and font size.

           If True, you need to set text size scale by setting @link CAE::Xyplot::TextStyleSetting::IsGlobalSizeAutoScaled CAE::Xyplot::TextStyleSetting::IsGlobalSizeAutoScaled @endlink and @link CAE::Xyplot::TextStyleSetting::SetGlobalSizeAutoScaled CAE::Xyplot::TextStyleSetting::SetGlobalSizeAutoScaled @endlink  or
           @link CAE::Xyplot::TextStyleSetting::GlobalSizeScale CAE::Xyplot::TextStyleSetting::GlobalSizeScale @endlink and @link CAE::Xyplot::TextStyleSetting::SetGlobalSizeScale CAE::Xyplot::TextStyleSetting::SetGlobalSizeScale @endlink

Created in NX9.0.0.

License requirements : None

NXOpen::Display::TransientText::TextSize NXOpen::CAE::Xyplot::TextStyleSetting::Weight ( )

Returns the text weight.

Available when the text font is NX font.
Created in NX9.0.0.

License requirements : None

The documentation for this class was generated from the following file:

CAE_Xyplot_TextStyleSetting.hxx

Public Member Functions

Detailed Description

Member Function Documentation