NXOpen::Annotations::FrameBarElementStyleBuilder Class Reference

Represents a NXOpen::Annotations::FrameBarElementStyleBuilder . More...

Inheritance diagram for NXOpen::Annotations::FrameBarElementStyleBuilder:

Public Types
enum	LabelTextOrientation { LabelTextOrientationAlongTic, LabelTextOrientationPerpendicularToTic }
	the Label text orientation More...

Public Member Functions
int	ExtendedTicBegin ()
	Returns the extended tic from which display to be started Created in NX8.0.0. More...
int	ExtendedTicColor ()
	Returns the extended tic color Created in NX8.0.0. More...
int	ExtendedTicFont ()
	Returns the extended tic font Created in NX8.0.0. More...
int	ExtendedTicFrequency ()
	Returns the extended tic display frequency Created in NX8.0.0. More...
double	ExtendedTicLength ()
	Returns the extended tic length Created in NX8.0.0. More...
int	ExtendedTicWidth ()
	Returns the extended tic width Created in NX8.0.0. More...
int	LabelColor ()
	Returns the label color Created in NX8.0.0. More...
int	LabelFont ()
	Returns the label font Created in NX8.0.0. More...
bool	LabelItalicized ()
	Returns the label font style Created in NX8.5.0. More...
int	LabelName ()
	Returns the label name Created in NX8.0.0. More...
int	LabelWidth ()
	Returns the label width Created in NX8.0.0. More...
void	SetExtendedTicBegin (int displayExtendBegin)
	Sets the extended tic from which display to be started Created in NX8.0.0. More...
void	SetExtendedTicColor (int extendColor)
	Sets the extended tic color Created in NX8.0.0. More...
void	SetExtendedTicFont (int extendFont)
	Sets the extended tic font Created in NX8.0.0. More...
void	SetExtendedTicFrequency (int displayExtendFrequency)
	Sets the extended tic display frequency Created in NX8.0.0. More...
void	SetExtendedTicLength (double extendLength)
	Sets the extended tic length Created in NX8.0.0. More...
void	SetExtendedTicWidth (int extendWidth)
	Sets the extended tic width Created in NX8.0.0. More...
void	SetLabelColor (int labelColor)
	Sets the label color Created in NX8.0.0. More...
void	SetLabelFont (int labelFont)
	Sets the label font Created in NX8.0.0. More...
void	SetLabelItalicized (bool italic)
	Sets the label font style Created in NX8.5.0. More...
void	SetLabelName (int labelName)
	Sets the label name Created in NX8.0.0. More...
void	SetLabelWidth (int labelWidth)
	Sets the label width Created in NX8.0.0. More...
void	SetSkipLabelBegin (int skipLabelBegin)
	Sets the label from which skip to be started Created in NX8.0.0. More...
void	SetSkipLabelFrequency (int skipLabelFrequency)
	Sets the label skip frequency Created in NX8.0.0. More...
void	SetSkipTicBegin (int skipTicBegin)
	Sets the tic from which skip to be started Created in NX8.0.0. More...
void	SetSkipTicFrequency (int skipTicFrequency)
	Sets the tic skip frequency Created in NX8.0.0. More...
void	SetTicColor (int ticColor)
	Sets the tic color Created in NX8.0.0. More...
void	SetTicDisplay (int ticDisplay)
	Sets the transverse frames tic display type Created in NX8.0.0. More...
void	SetTicFont (int ticFont)
	Sets the tic font Created in NX8.0.0. More...
void	SetTicLabelTextOrientation (NXOpen::Annotations::FrameBarElementStyleBuilder::LabelTextOrientation ticLabelTextOrientation)
	Sets the tic label text orientation type Created in NX11.0.0. More...
void	SetTicLength (double ticLength)
	Sets the tic length Created in NX8.0.0. More...
void	SetTicWidth (int ticWidth)
	Sets the tic width Created in NX8.0.0. More...
int	SkipLabelBegin ()
	Returns the label from which skip to be started Created in NX8.0.0. More...
int	SkipLabelFrequency ()
	Returns the label skip frequency Created in NX8.0.0. More...
int	SkipTicBegin ()
	Returns the tic from which skip to be started Created in NX8.0.0. More...
int	SkipTicFrequency ()
	Returns the tic skip frequency Created in NX8.0.0. More...
int	TicColor ()
	Returns the tic color Created in NX8.0.0. More...
int	TicDisplay ()
	Returns the transverse frames tic display type Created in NX8.0.0. More...
int	TicFont ()
	Returns the tic font Created in NX8.0.0. More...
NXOpen::Annotations::FrameBarElementStyleBuilder::LabelTextOrientation	TicLabelTextOrientation ()
	Returns the tic label text orientation type Created in NX11.0.0. More...
double	TicLength ()
	Returns the tic length Created in NX8.0.0. More...
int	TicWidth ()
	Returns the tic width Created in NX8.0.0. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a NXOpen::Annotations::FrameBarElementStyleBuilder .

This class queries and sets FrameBar preferences when creating and editing FrameBar drafting annotations.

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::FrameBarElementStyleBuilder::LabelTextOrientation

the Label text orientation

Enumerator
LabelTextOrientationAlongTic	Along Tic.
LabelTextOrientationPerpendicularToTic	Perpendicular To Tic.

Member Function Documentation

int NXOpen::Annotations::FrameBarElementStyleBuilder::ExtendedTicBegin

(

)

Returns the extended tic from which display to be started
Created in NX8.0.0.

License requirements : None

int NXOpen::Annotations::FrameBarElementStyleBuilder::ExtendedTicColor

(

)

Returns the extended tic color
Created in NX8.0.0.

License requirements : None

int NXOpen::Annotations::FrameBarElementStyleBuilder::ExtendedTicFont

(

)

Returns the extended tic font
Created in NX8.0.0.

License requirements : None

int NXOpen::Annotations::FrameBarElementStyleBuilder::ExtendedTicFrequency

(

)

Returns the extended tic display frequency
Created in NX8.0.0.

License requirements : None

double NXOpen::Annotations::FrameBarElementStyleBuilder::ExtendedTicLength

(

)

Returns the extended tic length
Created in NX8.0.0.

License requirements : None

int NXOpen::Annotations::FrameBarElementStyleBuilder::ExtendedTicWidth

(

)

Returns the extended tic width
Created in NX8.0.0.

License requirements : None

int NXOpen::Annotations::FrameBarElementStyleBuilder::LabelColor

(

)

Returns the label color
Created in NX8.0.0.

License requirements : None

int NXOpen::Annotations::FrameBarElementStyleBuilder::LabelFont

(

)

Returns the label font
Created in NX8.0.0.

License requirements : None

bool NXOpen::Annotations::FrameBarElementStyleBuilder::LabelItalicized

(

)

Returns the label font style
Created in NX8.5.0.

License requirements : None

int NXOpen::Annotations::FrameBarElementStyleBuilder::LabelName

(

)

Returns the label name
Created in NX8.0.0.

License requirements : None

int NXOpen::Annotations::FrameBarElementStyleBuilder::LabelWidth

(

)

Returns the label width
Created in NX8.0.0.

License requirements : None

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetExtendedTicBegin

(

int

displayExtendBegin

)

Sets the extended tic from which display to be started
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

displayExtendBegin

displayextendbegin

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetExtendedTicColor

(

int

extendColor

)

Sets the extended tic color
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

extendColor

extendcolor

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetExtendedTicFont

(

int

extendFont

)

Sets the extended tic font
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

extendFont

extendfont

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetExtendedTicFrequency

(

int

displayExtendFrequency

)

Sets the extended tic display frequency
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

displayExtendFrequency

displayextendfrequency

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetExtendedTicLength

(

double

extendLength

)

Sets the extended tic length
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

extendLength

extendlength

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetExtendedTicWidth

(

int

extendWidth

)

Sets the extended tic width
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

extendWidth

extendwidth

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetLabelColor

(

int

labelColor

)

Sets the label color
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

labelColor

labelcolor

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetLabelFont

(

int

labelFont

)

Sets the label font
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

labelFont

labelfont

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetLabelItalicized

(

bool

italic

)

Sets the label font style
Created in NX8.5.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

italic

italic

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetLabelName

(

int

labelName

)

Sets the label name
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

labelName

labelname

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetLabelWidth

(

int

labelWidth

)

Sets the label width
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

labelWidth

labelwidth

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetSkipLabelBegin

(

int

skipLabelBegin

)

Sets the label from which skip to be started
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

skipLabelBegin

skiplabelbegin

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetSkipLabelFrequency

(

int

skipLabelFrequency

)

Sets the label skip frequency
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

skipLabelFrequency

skiplabelfrequency

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetSkipTicBegin

(

int

skipTicBegin

)

Sets the tic from which skip to be started
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

skipTicBegin

skipticbegin

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetSkipTicFrequency

(

int

skipTicFrequency

)

Sets the tic skip frequency
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

skipTicFrequency

skipticfrequency

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetTicColor

(

int

ticColor

)

Sets the tic color
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

ticColor

ticcolor

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetTicDisplay

(

int

ticDisplay

)

Sets the transverse frames tic display type
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

ticDisplay

ticdisplay

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetTicFont

(

int

ticFont

)

Sets the tic font
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

ticFont

ticfont

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetTicLabelTextOrientation

(

NXOpen::Annotations::FrameBarElementStyleBuilder::LabelTextOrientation

ticLabelTextOrientation

)

Sets the tic label text orientation type
Created in NX11.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

ticLabelTextOrientation

ticlabeltextorientation

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetTicLength

(

double

ticLength

)

Sets the tic length
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

ticLength

ticlength

void NXOpen::Annotations::FrameBarElementStyleBuilder::SetTicWidth

(

int

ticWidth

)

Sets the tic width
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting") OR drafting ("DRAFTING")

Parameters

ticWidth

ticwidth

int NXOpen::Annotations::FrameBarElementStyleBuilder::SkipLabelBegin

(

)

Returns the label from which skip to be started
Created in NX8.0.0.

License requirements : None

int NXOpen::Annotations::FrameBarElementStyleBuilder::SkipLabelFrequency

(

)

Returns the label skip frequency
Created in NX8.0.0.

License requirements : None

int NXOpen::Annotations::FrameBarElementStyleBuilder::SkipTicBegin

(

)

Returns the tic from which skip to be started
Created in NX8.0.0.

License requirements : None

int NXOpen::Annotations::FrameBarElementStyleBuilder::SkipTicFrequency

(

)

Returns the tic skip frequency
Created in NX8.0.0.

License requirements : None

int NXOpen::Annotations::FrameBarElementStyleBuilder::TicColor

(

)

Returns the tic color
Created in NX8.0.0.

License requirements : None

int NXOpen::Annotations::FrameBarElementStyleBuilder::TicDisplay

(

)

Returns the transverse frames tic display type
Created in NX8.0.0.

License requirements : None

int NXOpen::Annotations::FrameBarElementStyleBuilder::TicFont

(

)

Returns the tic font
Created in NX8.0.0.

License requirements : None

NXOpen::Annotations::FrameBarElementStyleBuilder::LabelTextOrientation NXOpen::Annotations::FrameBarElementStyleBuilder::TicLabelTextOrientation

(

)

Returns the tic label text orientation type
Created in NX11.0.0.

License requirements : None

double NXOpen::Annotations::FrameBarElementStyleBuilder::TicLength

(

)

Returns the tic length
Created in NX8.0.0.

License requirements : None

int NXOpen::Annotations::FrameBarElementStyleBuilder::TicWidth

(

)

Returns the tic width
Created in NX8.0.0.

License requirements : None

virtual bool NXOpen::Annotations::FrameBarElementStyleBuilder::Validate ( )

virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns

Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

---

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

• Annotations_FrameBarElementStyleBuilder.hxx