Represents a EditSymbolPieces builder  <br> To create a new instance of this class, use @link Annotations::CustomSymbolCollection::EditSymbolDisplayBuilder  Annotations::CustomSymbolCollection::EditSymbolDisplayBuilder @endlink  <br>

Default values. More...

Inheritance diagram for NXOpen::Annotations::EditSymbolDisplayBuilder:

Public Types
enum	FontTypes { FontTypesSolid, FontTypesDashed, FontTypesPhantom, FontTypesCenterline, FontTypesDotted, FontTypesLongDashed, FontTypesDottedDashed }
	The Enum represent font types. More...

enum	WidthTypes { WidthTypesThin, WidthTypesNormal, WidthTypesThick, WidthTypesThicknessOne = 6, WidthTypesThicknessTwo, WidthTypesThicknessThree, WidthTypesThicknessFour, WidthTypesThicknessFive, WidthTypesThicknessSix, WidthTypesThicknessSeven, WidthTypesThicknessEight, WidthTypesThicknessNine }
	The Enum represent width types Annotations::EditSymbolDisplayBuilder::Width and Annotations::EditSymbolDisplayBuilder::SetWidth will set this width type at builder side and will be used to apply the same on the selected contents after commit. More...

Public Member Functions
void	ApplyCfw ()
	Apply color font width Created in NX8.0.0.

void	ApplyStyle ()
	Apply text preferences Created in NX7.5.0.

NXOpen::NXColor *	Color ()
	Returns the color picker Created in NX7.5.0.

NXOpen::Annotations::EditSymbolDisplayBuilder::FontTypes	Font ()
	Returns the enum font Created in NX7.5.0.

void	SelectComponent (const NXString &sid)
	Stores index of the custom symbol component for editing display Created in NX7.5.0.

void	SelectComponent (const char *sid)
	Stores index of the custom symbol component for editing display Created in NX7.5.0.

void	SetColor (NXOpen::NXColor *colorPicker)
	Sets the color picker Created in NX7.5.0.

void	SetFont (NXOpen::Annotations::EditSymbolDisplayBuilder::FontTypes enumFont)
	Sets the enum font Created in NX7.5.0.

void	SetWidth (NXOpen::Annotations::EditSymbolDisplayBuilder::WidthTypes enumWidth)
	Sets the enum width Created in NX7.5.0.

NXOpen::Annotations::StyleBuilder *	Style ()
	Returns the style Created in NX7.5.0.

NXOpen::Annotations::EditSymbolDisplayBuilder::WidthTypes	Width ()
	Returns the enum width Created in NX7.5.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

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 a EditSymbolPieces builder  <br> To create a new instance of this class, use @link Annotations::CustomSymbolCollection::EditSymbolDisplayBuilder  Annotations::CustomSymbolCollection::EditSymbolDisplayBuilder @endlink  <br>

Default values.

Property

Value

Font

Solid

Width

Thin

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::Annotations::EditSymbolDisplayBuilder::FontTypes

The Enum represent font types.

Annotations::EditSymbolDisplayBuilder::Font and Annotations::EditSymbolDisplayBuilder::SetFont will set this font type at builder side and will be used to apply the same on the selected contents after commit

Enumerator:

FontTypesSolid	Solid type.
FontTypesDashed	Dashed Type.
FontTypesPhantom	Phantom Type.
FontTypesCenterline	Centerline.
FontTypesDotted	Dotted Type.
FontTypesLongDashed	Long Dash.
FontTypesDottedDashed	Dotted Dash.

enum NXOpen::Annotations::EditSymbolDisplayBuilder::WidthTypes

The Enum represent width types Annotations::EditSymbolDisplayBuilder::Width and Annotations::EditSymbolDisplayBuilder::SetWidth will set this width type at builder side and will be used to apply the same on the selected contents after commit.

Enumerator:

WidthTypesThin	Thin.
WidthTypesNormal	Normal.
WidthTypesThick	Thick.
WidthTypesThicknessTwo	Width Two.
WidthTypesThicknessThree	Width Three.
WidthTypesThicknessFour	Width Four.
WidthTypesThicknessFive	Width Five.
WidthTypesThicknessSix	Width Six.
WidthTypesThicknessSeven	Width Seven.
WidthTypesThicknessEight	Width Eight.
WidthTypesThicknessNine	Width Nine.

Member Function Documentation

void NXOpen::Annotations::EditSymbolDisplayBuilder::ApplyCfw ( )

Apply color font width
Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

void NXOpen::Annotations::EditSymbolDisplayBuilder::ApplyStyle ( )

Apply text preferences
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

NXOpen::NXColor* NXOpen::Annotations::EditSymbolDisplayBuilder::Color ( )

Returns the color picker
Created in NX7.5.0.

License requirements : None

NXOpen::Annotations::EditSymbolDisplayBuilder::FontTypes NXOpen::Annotations::EditSymbolDisplayBuilder::Font ( )

Returns the enum font
Created in NX7.5.0.

License requirements : None

void NXOpen::Annotations::EditSymbolDisplayBuilder::SelectComponent ( const NXString & sid )

Stores index of the custom symbol component for editing display
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

sid	sid of selected component NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Annotations::EditSymbolDisplayBuilder::SelectComponent ( const char * sid )

Stores index of the custom symbol component for editing display
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

sid	sid of selected component NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Annotations::EditSymbolDisplayBuilder::SetColor ( NXOpen::NXColor * colorPicker )

Sets the color picker
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

colorPicker colorpicker

void NXOpen::Annotations::EditSymbolDisplayBuilder::SetFont ( NXOpen::Annotations::EditSymbolDisplayBuilder::FontTypes enumFont )

Sets the enum font
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

enumFont enumfont

void NXOpen::Annotations::EditSymbolDisplayBuilder::SetWidth ( NXOpen::Annotations::EditSymbolDisplayBuilder::WidthTypes enumWidth )

Sets the enum width
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

enumWidth enumwidth

NXOpen::Annotations::StyleBuilder* NXOpen::Annotations::EditSymbolDisplayBuilder::Style ( )

Returns the style
Created in NX7.5.0.

License requirements : None

NXOpen::Annotations::EditSymbolDisplayBuilder::WidthTypes NXOpen::Annotations::EditSymbolDisplayBuilder::Width ( )

Returns the enum width
Created in NX7.5.0.

License requirements : None

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

Annotations_EditSymbolDisplayBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation