Represents a CannedAnnotationBuilder. More...

Inheritance diagram for NXOpen::Diagramming::CannedAnnotationBuilder:

Public Types
enum	InheritOption { InheritOptionPreferences, InheritOptionCustomerDefaults, InheritOptionSelection }
	Represents the inherit option. More...

Public Member Functions
NXOpen::Diagramming::AnnotationBuilder *	AnnotationBuilder ()
	Returns the annotation of this canned annotation. More...

NXOpen::Diagramming::LeaderLineBuilder *	CreateLeaderLine ()
	Create a new NXOpen::Diagramming::LeaderLineBuilder builder. More...

void	Inherit (NXOpen::Diagramming::CannedAnnotationBuilder::InheritOption inheritOption, NXOpen::Diagramming::Annotation *annotation)
	Inherit. More...

NXOpen::Diagramming::LeaderLineBuilderList *	LeaderLines ()
	Returns the list of the leader lines. More...

void	SetTextBoxIndent (int indent)
	Sets the indent value of the text box in the canned annotation. More...

void	SetTextBoxModifiable (bool isModifiable)
	Sets the flag that indicates if the text box in the canned annotation is modifiable. More...

void	SetTextBoxShadowBox (bool isShadowBox)
	Sets the flag that indicates if the text box in the canned annotation has shadow box. More...

int	TextBoxIndent ()
	Returns the indent value of the text box in the canned annotation. More...

bool	TextBoxModifiable ()
	Returns the flag that indicates if the text box in the canned annotation is modifiable. More...

bool	TextBoxShadowBox ()
	Returns the flag that indicates if the text box in the canned annotation has shadow box. More...

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

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

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

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

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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 CannedAnnotationBuilder.

To create a new instance of this class, use NXOpen::Diagramming::DiagrammingManager::CreateCannedAnnotationBuilder

Created in NX10.0.0.

Member Enumeration Documentation

enum NXOpen::Diagramming::CannedAnnotationBuilder::InheritOption

Represents the inherit option.

Created in NX11.0.0.

Enumerator
InheritOptionPreferences	Setting the inherit from preferences option.
InheritOptionCustomerDefaults	Setting the inherit from customer defaults option.
InheritOptionSelection	Setting the inherit from selection option.

Member Function Documentation

NXOpen::Diagramming::AnnotationBuilder* NXOpen::Diagramming::CannedAnnotationBuilder::AnnotationBuilder ( )

Returns the annotation of this canned annotation.

Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::LeaderLineBuilder* NXOpen::Diagramming::CannedAnnotationBuilder::CreateLeaderLine ( )

Create a new NXOpen::Diagramming::LeaderLineBuilder builder.

Returns: Created in NX10.0.0.

License requirements : None

void NXOpen::Diagramming::CannedAnnotationBuilder::Inherit	(	NXOpen::Diagramming::CannedAnnotationBuilder::InheritOption	inheritOption,
		NXOpen::Diagramming::Annotation *	annotation
	)

Inherit.

Created in NX11.0.0.

License requirements : None

Parameters

inheritOption	inheritoption
annotation	annotation

NXOpen::Diagramming::LeaderLineBuilderList* NXOpen::Diagramming::CannedAnnotationBuilder::LeaderLines ( )

Returns the list of the leader lines.

Created in NX10.0.0.

License requirements : None

void NXOpen::Diagramming::CannedAnnotationBuilder::SetTextBoxIndent ( int indent )

Sets the indent value of the text box in the canned annotation.

Created in NX10.0.0.

License requirements : None

Parameters

indent indent

void NXOpen::Diagramming::CannedAnnotationBuilder::SetTextBoxModifiable ( bool isModifiable )

Sets the flag that indicates if the text box in the canned annotation is modifiable.

Created in NX10.0.0.

License requirements : None

Parameters

isModifiable ismodifiable

void NXOpen::Diagramming::CannedAnnotationBuilder::SetTextBoxShadowBox ( bool isShadowBox )

Sets the flag that indicates if the text box in the canned annotation has shadow box.

Created in NX10.0.0.

License requirements : None

Parameters

isShadowBox isshadowbox

int NXOpen::Diagramming::CannedAnnotationBuilder::TextBoxIndent ( )

Returns the indent value of the text box in the canned annotation.

Created in NX10.0.0.

License requirements : None

bool NXOpen::Diagramming::CannedAnnotationBuilder::TextBoxModifiable ( )

Returns the flag that indicates if the text box in the canned annotation is modifiable.

Created in NX10.0.0.

License requirements : None

bool NXOpen::Diagramming::CannedAnnotationBuilder::TextBoxShadowBox ( )

Returns the flag that indicates if the text box in the canned annotation has shadow box.

Created in NX10.0.0.

License requirements : None

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

Diagramming_CannedAnnotationBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation