Represents a Drafting::DrawingCreationWizardBuilder . More...

Inheritance diagram for NXOpen::Drafting::DrawingCreationWizardBuilder:

Public Member Functions
bool	ApplyTemplateToAll ()
	Returns the flag which controls the behavior of setting Drafting::PrimaryContentItemBuilder::GeometryTemplate on an item in Drafting::DrawingCreationWizardBuilder::PrimaryContent .

NXOpen::Drafting::AttributeItemBuilderList *	Attributes ()
	Returns the attributes.

NXString	DetailID ()
	Returns the detail id.

NXString	Discipline ()
	Returns the discipline.

NXString	DrawingStyle ()
	Returns the drawing style.

NXOpen::Assemblies::SelectComponentList *	ExcludedContent ()
	Returns the excluded content.

NXString	Folder ()
	Returns the folder.

std::vector< NXString >	GetSummary ()
	Returns the summary.

NXString	IntroductoryTemplate ()
	Returns the introductory template.

NXString	Name ()
	Returns the name.

NXString	Number ()
	Returns the number.

NXOpen::Drafting::PrimaryContentItemBuilderList *	PrimaryContent ()
	Returns the primary content.

NXOpen::SelectNXObjectList *	References ()
	Returns the references.

NXString	Revision ()
	Returns the revision.

NXOpen::Assemblies::SelectComponentList *	SecondaryContent ()
	Returns the secondary content.

void	SetApplyTemplateToAll (bool applyTemplateToAll)
	Sets the flag which controls the behavior of setting Drafting::PrimaryContentItemBuilder::GeometryTemplate on an item in Drafting::DrawingCreationWizardBuilder::PrimaryContent .

void	SetDetailID (const NXString &detailID)
	Sets the detail id.

void	SetDetailID (const char *detailID)
	Sets the detail id.

void	SetDiscipline (const NXString &discipline)
	Sets the discipline.

void	SetDiscipline (const char *discipline)
	Sets the discipline.

void	SetDrawingStyle (const NXString &drawingStyle)
	Sets the drawing style.

void	SetDrawingStyle (const char *drawingStyle)
	Sets the drawing style.

void	SetFolder (const NXString &foldername)
	Sets the folder.

void	SetFolder (const char *foldername)
	Sets the folder.

void	SetIntroductoryTemplate (const NXString &introductoryTemplate)
	Sets the introductory template.

void	SetIntroductoryTemplate (const char *introductoryTemplate)
	Sets the introductory template.

void	SetName (const NXString &name)
	Sets the name.

void	SetName (const char *name)
	Sets the name.

void	SetNumber (const NXString &number)
	Sets the number.

void	SetNumber (const char *number)
	Sets the number.

void	SetRevision (const NXString &revision)
	Sets the revision.

void	SetRevision (const char *revision)
	Sets the revision.

void	SetSummary (const std::vector< NXString > &summary)
	Sets the summary 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 Drafting::DrawingCreationWizardBuilder .

This class is used to create Booklets (i.e. a set of fully populated drawings). The builder operates in both create and edit modes as well as in native and managed (Teamcenter) modes. The following information is important when using this builder in edit mode:

Native Mode
- The Drafting::DrawingCreationWizardBuilder::SetFolder must be the first thing set after creating the builder. Setting this will populate the builder with the booklet's information.
Managed Mode
- The Drafting::DrawingCreationWizardBuilder::SetNumber and Drafting::DrawingCreationWizardBuilder::SetRevision must be the first things set after creating the builder (in that order). The setting of the Drafting::DrawingCreationWizardBuilder::SetRevision will populate the builder with the booklet's information.

To create a new instance of this class, use Drafting::AutomationManager::CreateDrawingCreationWizardBuilderFromRule
Default values.

Property

Value

ApplyTemplateToAll

0

Created in NX8.0.0.

Member Function Documentation

bool NXOpen::Drafting::DrawingCreationWizardBuilder::ApplyTemplateToAll ( )

Returns the flag which controls the behavior of setting Drafting::PrimaryContentItemBuilder::GeometryTemplate on an item in Drafting::DrawingCreationWizardBuilder::PrimaryContent .

When set to true the builder will respond to the setting of Drafting::PrimaryContentItemBuilder::GeometryTemplate on an item in Drafting::DrawingCreationWizardBuilder::PrimaryContent by setting the same value on Drafting::PrimaryContentItemBuilder::GeometryTemplate on all of the other items in Drafting::DrawingCreationWizardBuilder::PrimaryContent
Created in NX8.0.0.

License requirements : None

NXOpen::Drafting::AttributeItemBuilderList* NXOpen::Drafting::DrawingCreationWizardBuilder::Attributes ( )

Returns the attributes.

Created in NX8.0.0.

License requirements : None

NXString NXOpen::Drafting::DrawingCreationWizardBuilder::DetailID ( )

Returns the detail id.

Created in NX8.0.0.

License requirements : None

NXString NXOpen::Drafting::DrawingCreationWizardBuilder::Discipline ( )

Returns the discipline.

Created in NX8.0.0.

License requirements : None

NXString NXOpen::Drafting::DrawingCreationWizardBuilder::DrawingStyle ( )

Returns the drawing style.

Created in NX8.0.0.

License requirements : None

NXOpen::Assemblies::SelectComponentList* NXOpen::Drafting::DrawingCreationWizardBuilder::ExcludedContent ( )

Returns the excluded content.

Setting a component into Drafting::DrawingCreationWizardBuilder::ExcludedContent will cause that component to be removed from Drafting::PrimaryContentItemBuilder::Content of each item in Drafting::DrawingCreationWizardBuilder::PrimaryContent and Drafting::DrawingCreationWizardBuilder::SecondaryContent if they contain that component.
Created in NX8.0.0.

License requirements : None

NXString NXOpen::Drafting::DrawingCreationWizardBuilder::Folder ( )

Returns the folder.

Created in NX8.0.0.

License requirements : None

std::vector<NXString> NXOpen::Drafting::DrawingCreationWizardBuilder::GetSummary ( )

Returns the summary.

This is in HTML format.

Returns: Created in NX8.0.0.

License requirements : None

NXString NXOpen::Drafting::DrawingCreationWizardBuilder::IntroductoryTemplate ( )

Returns the introductory template.

Created in NX8.0.0.

License requirements : None

NXString NXOpen::Drafting::DrawingCreationWizardBuilder::Name ( )

Returns the name.

Created in NX8.0.0.

License requirements : None

NXString NXOpen::Drafting::DrawingCreationWizardBuilder::Number ( )

Returns the number.

This property is only used in managed mode and must be set before anything else.
Created in NX8.0.0.

License requirements : None

NXOpen::Drafting::PrimaryContentItemBuilderList* NXOpen::Drafting::DrawingCreationWizardBuilder::PrimaryContent ( )

Returns the primary content.

Setting a component into Drafting::PrimaryContentItemBuilder::Content of an item in Drafting::DrawingCreationWizardBuilder::PrimaryContent will cause that component to be removed from Drafting::DrawingCreationWizardBuilder::SecondaryContent and Drafting::DrawingCreationWizardBuilder::ExcludedContent if they contain that component.
Created in NX8.0.0.

License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Drafting::DrawingCreationWizardBuilder::References ( )

Returns the references.

Created in NX8.0.0.

License requirements : None

NXString NXOpen::Drafting::DrawingCreationWizardBuilder::Revision ( )

Returns the revision.

This is only used in managed mode. In edit mode it must be set after the Drafting::DrawingCreationWizardBuilder::SetNumber and at the time is set it will populate the builder with the booklet's information.
Created in NX8.0.0.

License requirements : None

NXOpen::Assemblies::SelectComponentList* NXOpen::Drafting::DrawingCreationWizardBuilder::SecondaryContent ( )

Returns the secondary content.

Setting a component into Drafting::DrawingCreationWizardBuilder::SecondaryContent will cause that component to be removed from Drafting::PrimaryContentItemBuilder::Content of each item in Drafting::DrawingCreationWizardBuilder::PrimaryContent and Drafting::DrawingCreationWizardBuilder::ExcludedContent if they contain that component.
Created in NX8.0.0.

License requirements : None

void NXOpen::Drafting::DrawingCreationWizardBuilder::SetApplyTemplateToAll ( bool applyTemplateToAll )

Sets the flag which controls the behavior of setting Drafting::PrimaryContentItemBuilder::GeometryTemplate on an item in Drafting::DrawingCreationWizardBuilder::PrimaryContent .

When set to true the builder will respond to the setting of Drafting::PrimaryContentItemBuilder::GeometryTemplate on an item in Drafting::DrawingCreationWizardBuilder::PrimaryContent by setting the same value on Drafting::PrimaryContentItemBuilder::GeometryTemplate on all of the other items in Drafting::DrawingCreationWizardBuilder::PrimaryContent
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

applyTemplateToAll applytemplatetoall

void NXOpen::Drafting::DrawingCreationWizardBuilder::SetDetailID ( const NXString & detailID )

Sets the detail id.