NXOpen::Drawings::ViewDetailLabelBuilder Class Reference

Represents a NXOpen::Drawings::ViewDetailLabelBuilder. More...

Inheritance diagram for NXOpen::Drawings::ViewDetailLabelBuilder:

Public Types
enum	LabelParentDisplayTypes {   LabelParentDisplayTypesNone, LabelParentDisplayTypesCircle, LabelParentDisplayTypesNote, LabelParentDisplayTypesLabel,   LabelParentDisplayTypesEmbedded, LabelParentDisplayTypesBoundary, LabelParentDisplayTypesLabelOnBoundary }
	Label on Parent Display type. More...
enum	LabelParentTextPlacement { LabelParentTextPlacementBeforeOrAfterStub, LabelParentTextPlacementAboveStub }
	Label on Parent Text Placement type. More...

Public Member Functions
bool	CustomizedViewLabel ()
	Returns the customized view label Created in NX9.0.0. More...
std::vector< NXString >	GetCustomizedViewLabelText ()
	Returns the customized view label text. More...
bool	IncludeParentheses ()
	Returns the include parentheses Created in NX9.0.0. More...
double	LabelCharacterHeightFactor ()
	Returns the section vw label letter size factor Created in NX9.0.0. More...
NXOpen::Drawings::ViewDetailLabelBuilder::LabelParentDisplayTypes	LabelParentDisplay ()
	Returns the label parent display Created in NX9.0.0. More...
NXOpen::Drawings::LabelPositionTypes	LabelPosition ()
	Returns the label position Created in NX9.0.0. More...
NXString	LabelPrefix ()
	Returns the label prefix Created in NX9.0.0. More...
NXOpen::Drawings::LetterFormatTypes	LetterFormat ()
	Returns the letter format Created in NX9.0.0. More...
NXString	ParentLabelPrefix ()
	Returns the parent label prefix Created in NX9.0.0. More...
double	PrefixCharacterHeightFactor ()
	Returns the prefix character height factor Created in NX9.0.0. More...
NXOpen::Drawings::ReferenceShowTypes	ReferenceToShow ()
	Returns the reference to show Created in NX9.0.0. More...
double	ScaleCharacterHeightFactor ()
	Returns the scale character height factor Created in NX9.0.0. More...
NXOpen::Drawings::ScalePositionTypes	ScalePosition ()
	Returns the scale position Created in NX9.0.0. More...
NXString	ScalePrefix ()
	Returns the scale prefix Created in NX9.0.0. More...
void	SetCustomizedViewLabel (bool customizedViewLabel)
	Sets the customized view label Created in NX9.0.0. More...
void	SetCustomizedViewLabelText (const std::vector< NXString > &customizedText)
	Sets the customized view label text Created in NX10.0.0. More...
void	SetIncludeParentheses (bool includeParentheses)
	Sets the include parentheses Created in NX9.0.0. More...
void	SetLabelCharacterHeightFactor (double labelCharacterHeightFactor)
	Sets the section vw label letter size factor Created in NX9.0.0. More...
void	SetLabelParentDisplay (NXOpen::Drawings::ViewDetailLabelBuilder::LabelParentDisplayTypes labelParentDisplay)
	Sets the label parent display Created in NX9.0.0. More...
void	SetLabelPosition (NXOpen::Drawings::LabelPositionTypes labelPosition)
	Sets the label position Created in NX9.0.0. More...
void	SetLabelPrefix (const NXString &labelPrefix)
	Sets the label prefix Created in NX9.0.0. More...
void	SetLabelPrefix (const char *labelPrefix)
	Sets the label prefix Created in NX9.0.0. More...
void	SetLetterFormat (NXOpen::Drawings::LetterFormatTypes letterFormat)
	Sets the letter format Created in NX9.0.0. More...
void	SetParentLabelPrefix (const NXString &parentLabelPrefix)
	Sets the parent label prefix Created in NX9.0.0. More...
void	SetParentLabelPrefix (const char *parentLabelPrefix)
	Sets the parent label prefix Created in NX9.0.0. More...
void	SetPrefixCharacterHeightFactor (double prefixCharacterHeightFactor)
	Sets the prefix character height factor Created in NX9.0.0. More...
void	SetReferenceToShow (NXOpen::Drawings::ReferenceShowTypes referenceToShow)
	Sets the reference to show Created in NX9.0.0. More...
void	SetScaleCharacterHeightFactor (double scaleCharacterHeightFactor)
	Sets the scale character height factor Created in NX9.0.0. More...
void	SetScalePosition (NXOpen::Drawings::ScalePositionTypes scalePosition)
	Sets the scale position Created in NX9.0.0. More...
void	SetScalePrefix (const NXString &scalePrefix)
	Sets the scale prefix Created in NX9.0.0. More...
void	SetScalePrefix (const char *scalePrefix)
	Sets the scale prefix Created in NX9.0.0. More...
void	SetShowViewLabel (bool showViewLabel)
	Sets the show view label Created in NX9.0.0. More...
void	SetShowViewScale (bool showViewScale)
	Sets the show view scale Created in NX9.0.0. More...
void	SetTextGapFactor (double textGapFactor)
	Sets the text gap factor Created in NX9.0.0. More...
void	SetTextPlacement (NXOpen::Drawings::ViewDetailLabelBuilder::LabelParentTextPlacement textPlacement)
	Sets the text placement Created in NX9.0.0. More...
void	SetValueFormat (NXOpen::Drawings::ScaleValueFormatTypes valueFormat)
	Sets the value format Created in NX9.0.0. More...
void	SetViewLabelOption (NXOpen::Drawings::ViewLabelTypes viewLabelOption)
	Sets the view label option Created in NX9.0.0. More...
bool	ShowViewLabel ()
	Returns the show view label Created in NX9.0.0. More...
bool	ShowViewScale ()
	Returns the show view scale Created in NX9.0.0. More...
double	TextGapFactor ()
	Returns the text gap factor Created in NX9.0.0. More...
NXOpen::Drawings::ViewDetailLabelBuilder::LabelParentTextPlacement	TextPlacement ()
	Returns the text placement Created in NX9.0.0. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
NXOpen::Drawings::ScaleValueFormatTypes	ValueFormat ()
	Returns the value format Created in NX9.0.0. More...
NXOpen::Drawings::ViewLabelTypes	ViewLabelOption ()
	Returns the view label option Created in NX9.0.0. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a NXOpen::Drawings::ViewDetailLabelBuilder.

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::Drawings::ViewDetailLabelBuilder::LabelParentDisplayTypes

Label on Parent Display type.

Enumerator
LabelParentDisplayTypesNone	none
LabelParentDisplayTypesCircle	circle
LabelParentDisplayTypesNote	note
LabelParentDisplayTypesLabel	label
LabelParentDisplayTypesEmbedded	embedded
LabelParentDisplayTypesBoundary	boundary
LabelParentDisplayTypesLabelOnBoundary	label on boundary

enum NXOpen::Drawings::ViewDetailLabelBuilder::LabelParentTextPlacement

Label on Parent Text Placement type.

Enumerator
LabelParentTextPlacementBeforeOrAfterStub	before or after stub
LabelParentTextPlacementAboveStub	above stub

Member Function Documentation

bool NXOpen::Drawings::ViewDetailLabelBuilder::CustomizedViewLabel

(

)

Returns the customized view label
Created in NX9.0.0.

License requirements : None

std::vector<NXString> NXOpen::Drawings::ViewDetailLabelBuilder::GetCustomizedViewLabelText

(

)

Returns the customized view label text.

Returns

Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

bool NXOpen::Drawings::ViewDetailLabelBuilder::IncludeParentheses

(

)

Returns the include parentheses
Created in NX9.0.0.

License requirements : None

double NXOpen::Drawings::ViewDetailLabelBuilder::LabelCharacterHeightFactor

(

)

Returns the section vw label letter size factor
Created in NX9.0.0.

License requirements : None

NXOpen::Drawings::ViewDetailLabelBuilder::LabelParentDisplayTypes NXOpen::Drawings::ViewDetailLabelBuilder::LabelParentDisplay

(

)

Returns the label parent display
Created in NX9.0.0.

License requirements : None

NXOpen::Drawings::LabelPositionTypes NXOpen::Drawings::ViewDetailLabelBuilder::LabelPosition

(

)

Returns the label position
Created in NX9.0.0.

License requirements : None

NXString NXOpen::Drawings::ViewDetailLabelBuilder::LabelPrefix

(

)

Returns the label prefix
Created in NX9.0.0.

License requirements : None

NXOpen::Drawings::LetterFormatTypes NXOpen::Drawings::ViewDetailLabelBuilder::LetterFormat

(

)

Returns the letter format
Created in NX9.0.0.

License requirements : None

NXString NXOpen::Drawings::ViewDetailLabelBuilder::ParentLabelPrefix

(

)

Returns the parent label prefix
Created in NX9.0.0.

License requirements : None

double NXOpen::Drawings::ViewDetailLabelBuilder::PrefixCharacterHeightFactor

(

)

Returns the prefix character height factor
Created in NX9.0.0.

License requirements : None

NXOpen::Drawings::ReferenceShowTypes NXOpen::Drawings::ViewDetailLabelBuilder::ReferenceToShow

(

)

Returns the reference to show
Created in NX9.0.0.

License requirements : None

double NXOpen::Drawings::ViewDetailLabelBuilder::ScaleCharacterHeightFactor

(

)

Returns the scale character height factor
Created in NX9.0.0.

License requirements : None

NXOpen::Drawings::ScalePositionTypes NXOpen::Drawings::ViewDetailLabelBuilder::ScalePosition

(

)

Returns the scale position
Created in NX9.0.0.

License requirements : None

NXString NXOpen::Drawings::ViewDetailLabelBuilder::ScalePrefix

(

)

Returns the scale prefix
Created in NX9.0.0.

License requirements : None

void NXOpen::Drawings::ViewDetailLabelBuilder::SetCustomizedViewLabel

(

bool

customizedViewLabel

)

Sets the customized view label
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

customizedViewLabel

customizedviewlabel

void NXOpen::Drawings::ViewDetailLabelBuilder::SetCustomizedViewLabelText

(

const std::vector< NXString > &

customizedText

)

Sets the customized view label text
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

customizedText

customizedtext

void NXOpen::Drawings::ViewDetailLabelBuilder::SetIncludeParentheses

(

bool

includeParentheses

)

Sets the include parentheses
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

includeParentheses

includeparentheses

void NXOpen::Drawings::ViewDetailLabelBuilder::SetLabelCharacterHeightFactor

(

double

labelCharacterHeightFactor

)

Sets the section vw label letter size factor
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

labelCharacterHeightFactor

labelcharacterheightfactor

void NXOpen::Drawings::ViewDetailLabelBuilder::SetLabelParentDisplay

(

NXOpen::Drawings::ViewDetailLabelBuilder::LabelParentDisplayTypes

labelParentDisplay

)

Sets the label parent display
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

labelParentDisplay

labelparentdisplay

void NXOpen::Drawings::ViewDetailLabelBuilder::SetLabelPosition

(

NXOpen::Drawings::LabelPositionTypes

labelPosition

)

Sets the label position
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

labelPosition

labelposition

void NXOpen::Drawings::ViewDetailLabelBuilder::SetLabelPrefix

(

const NXString &

labelPrefix

)

Sets the label prefix
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

labelPrefix

labelprefix

void NXOpen::Drawings::ViewDetailLabelBuilder::SetLabelPrefix

(

const char *

labelPrefix

)

Sets the label prefix
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

labelPrefix

labelprefix

void NXOpen::Drawings::ViewDetailLabelBuilder::SetLetterFormat

(

NXOpen::Drawings::LetterFormatTypes

letterFormat

)

Sets the letter format
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

letterFormat

letterformat

void NXOpen::Drawings::ViewDetailLabelBuilder::SetParentLabelPrefix

(

const NXString &

parentLabelPrefix

)

Sets the parent label prefix
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

parentLabelPrefix

parentlabelprefix

void NXOpen::Drawings::ViewDetailLabelBuilder::SetParentLabelPrefix

(

const char *

parentLabelPrefix

)

Sets the parent label prefix
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

parentLabelPrefix

parentlabelprefix

void NXOpen::Drawings::ViewDetailLabelBuilder::SetPrefixCharacterHeightFactor

(

double

prefixCharacterHeightFactor

)

Sets the prefix character height factor
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

prefixCharacterHeightFactor

prefixcharacterheightfactor

void NXOpen::Drawings::ViewDetailLabelBuilder::SetReferenceToShow

(

NXOpen::Drawings::ReferenceShowTypes

referenceToShow

)

Sets the reference to show
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

referenceToShow

referencetoshow

void NXOpen::Drawings::ViewDetailLabelBuilder::SetScaleCharacterHeightFactor

(

double

scaleCharacterHeightFactor

)

Sets the scale character height factor
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

scaleCharacterHeightFactor

scalecharacterheightfactor

void NXOpen::Drawings::ViewDetailLabelBuilder::SetScalePosition

(

NXOpen::Drawings::ScalePositionTypes

scalePosition

)

Sets the scale position
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

scalePosition

scaleposition

void NXOpen::Drawings::ViewDetailLabelBuilder::SetScalePrefix

(

const NXString &

scalePrefix

)

Sets the scale prefix
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

scalePrefix

scaleprefix

void NXOpen::Drawings::ViewDetailLabelBuilder::SetScalePrefix

(

const char *

scalePrefix

)

Sets the scale prefix
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

scalePrefix

scaleprefix

void NXOpen::Drawings::ViewDetailLabelBuilder::SetShowViewLabel

(

bool

showViewLabel

)

Sets the show view label
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

showViewLabel

showviewlabel

void NXOpen::Drawings::ViewDetailLabelBuilder::SetShowViewScale

(

bool

showViewScale

)

Sets the show view scale
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

showViewScale

showviewscale

void NXOpen::Drawings::ViewDetailLabelBuilder::SetTextGapFactor

(

double

textGapFactor

)

Sets the text gap factor
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

textGapFactor

textgapfactor

void NXOpen::Drawings::ViewDetailLabelBuilder::SetTextPlacement

(

NXOpen::Drawings::ViewDetailLabelBuilder::LabelParentTextPlacement

textPlacement

)

Sets the text placement
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

textPlacement

textplacement

void NXOpen::Drawings::ViewDetailLabelBuilder::SetValueFormat

(

NXOpen::Drawings::ScaleValueFormatTypes

valueFormat

)

Sets the value format
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

valueFormat

valueformat

void NXOpen::Drawings::ViewDetailLabelBuilder::SetViewLabelOption

(

NXOpen::Drawings::ViewLabelTypes

viewLabelOption

)

Sets the view label option
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

viewLabelOption

viewlabeloption

bool NXOpen::Drawings::ViewDetailLabelBuilder::ShowViewLabel

(

)

Returns the show view label
Created in NX9.0.0.

License requirements : None

bool NXOpen::Drawings::ViewDetailLabelBuilder::ShowViewScale

(

)

Returns the show view scale
Created in NX9.0.0.

License requirements : None

double NXOpen::Drawings::ViewDetailLabelBuilder::TextGapFactor

(

)

Returns the text gap factor
Created in NX9.0.0.

License requirements : None

NXOpen::Drawings::ViewDetailLabelBuilder::LabelParentTextPlacement NXOpen::Drawings::ViewDetailLabelBuilder::TextPlacement

(

)

Returns the text placement
Created in NX9.0.0.

License requirements : None

virtual bool NXOpen::Drawings::ViewDetailLabelBuilder::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.

NXOpen::Drawings::ScaleValueFormatTypes NXOpen::Drawings::ViewDetailLabelBuilder::ValueFormat

(

)

Returns the value format
Created in NX9.0.0.

License requirements : None

NXOpen::Drawings::ViewLabelTypes NXOpen::Drawings::ViewDetailLabelBuilder::ViewLabelOption

(

)

Returns the view label option
Created in NX9.0.0.

License requirements : None

---

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

• Drawings_ViewDetailLabelBuilder.hxx