NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Drafting::DrawingCreationWizardBuilder Class Reference

Represents a NXOpen::Drafting::DrawingCreationWizardBuilder . More...

Inheritance diagram for NXOpen::Drafting::DrawingCreationWizardBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

bool ApplyTemplateToAll ()
 Returns the flag which controls the behavior of setting NXOpen::Drafting::PrimaryContentItemBuilder::GeometryTemplate on an item in NXOpen::Drafting::DrawingCreationWizardBuilder::PrimaryContent . More...
 
NXOpen::Drafting::AttributeItemBuilderListAttributes ()
 Returns the attributes. More...
 
NXString DetailID ()
 Returns the detail id. More...
 
NXString Discipline ()
 Returns the discipline. More...
 
NXString DrawingStyle ()
 Returns the drawing style. More...
 
NXOpen::Assemblies::SelectComponentListExcludedContent ()
 Returns the excluded content. More...
 
NXString Folder ()
 Returns the folder. More...
 
std::vector< NXStringGetSummary ()
 Returns the summary. More...
 
NXString IntroductoryTemplate ()
 Returns the introductory template. More...
 
NXString Name ()
 Returns the name. More...
 
NXString Number ()
 Returns the number. More...
 
NXOpen::Drafting::PrimaryContentItemBuilderListPrimaryContent ()
 Returns the primary content. More...
 
NXOpen::SelectNXObjectListReferences ()
 Returns the references. More...
 
NXString Revision ()
 Returns the revision. More...
 
NXOpen::Assemblies::SelectComponentListSecondaryContent ()
 Returns the secondary content. More...
 
void SetApplyTemplateToAll (bool applyTemplateToAll)
 Sets the flag which controls the behavior of setting NXOpen::Drafting::PrimaryContentItemBuilder::GeometryTemplate on an item in NXOpen::Drafting::DrawingCreationWizardBuilder::PrimaryContent . More...
 
void SetDetailID (const NXString &detailID)
 Sets the detail id. More...
 
void SetDetailID (const char *detailID)
 Sets the detail id. More...
 
void SetDiscipline (const NXString &discipline)
 Sets the discipline. More...
 
void SetDiscipline (const char *discipline)
 Sets the discipline. More...
 
void SetDrawingStyle (const NXString &drawingStyle)
 Sets the drawing style. More...
 
void SetDrawingStyle (const char *drawingStyle)
 Sets the drawing style. More...
 
void SetFolder (const NXString &foldername)
 Sets the folder. More...
 
void SetFolder (const char *foldername)
 Sets the folder. More...
 
void SetIntroductoryTemplate (const NXString &introductoryTemplate)
 Sets the introductory template. More...
 
void SetIntroductoryTemplate (const char *introductoryTemplate)
 Sets the introductory template. More...
 
void SetName (const NXString &name)
 Sets the name. More...
 
void SetName (const char *name)
 Sets the name. More...
 
void SetNumber (const NXString &number)
 Sets the number. More...
 
void SetNumber (const char *number)
 Sets the number. More...
 
void SetObjectCreateBuilder (NXOpen::PDM::ObjectCreateBuilder *objectCreateBuilder)
 Sets NXOpen::PDM::ObjectCreateBuilder
Created in NX10.0.0. More...
 
void SetRevision (const NXString &revision)
 Sets the revision. More...
 
void SetRevision (const char *revision)
 Sets the revision. More...
 
void SetSummary (const std::vector< NXString > &summary)
 Sets the summary
Created in NX7.5.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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 NXOpen::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:


To create a new instance of this class, use NXOpen::Drafting::AutomationManager::CreateDrawingCreationWizardBuilder
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 NXOpen::Drafting::PrimaryContentItemBuilder::GeometryTemplate on an item in NXOpen::Drafting::DrawingCreationWizardBuilder::PrimaryContent .

When set to true the builder will respond to the setting of NXOpen::Drafting::PrimaryContentItemBuilder::GeometryTemplate on an item in NXOpen::Drafting::DrawingCreationWizardBuilder::PrimaryContent by setting the same value on NXOpen::Drafting::PrimaryContentItemBuilder::GeometryTemplate on all of the other items in NXOpen::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 NXOpen::Drafting::DrawingCreationWizardBuilder::ExcludedContent will cause that component to be removed from NXOpen::Drafting::PrimaryContentItemBuilder::Content of each item in NXOpen::Drafting::DrawingCreationWizardBuilder::PrimaryContent and NXOpen::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 NXOpen::Drafting::PrimaryContentItemBuilder::Content of an item in NXOpen::Drafting::DrawingCreationWizardBuilder::PrimaryContent will cause that component to be removed from NXOpen::Drafting::DrawingCreationWizardBuilder::SecondaryContent and NXOpen::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 NXOpen::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 NXOpen::Drafting::DrawingCreationWizardBuilder::SecondaryContent will cause that component to be removed from NXOpen::Drafting::PrimaryContentItemBuilder::Content of each item in NXOpen::Drafting::DrawingCreationWizardBuilder::PrimaryContent and NXOpen::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 NXOpen::Drafting::PrimaryContentItemBuilder::GeometryTemplate on an item in NXOpen::Drafting::DrawingCreationWizardBuilder::PrimaryContent .

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

License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
applyTemplateToAllapplytemplatetoall
void NXOpen::Drafting::DrawingCreationWizardBuilder::SetDetailID ( const NXString detailID)

Sets the detail id.


Created in NX8.0.0.

License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
detailIDdetailid
void NXOpen::Drafting::DrawingCreationWizardBuilder::SetDetailID ( const char *  detailID)

Sets the detail id.


Created in NX8.0.0.

License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
detailIDdetailid
void NXOpen::Drafting::DrawingCreationWizardBuilder::SetDiscipline ( const NXString discipline)

Sets the discipline.


Created in NX8.0.0.

License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
disciplinediscipline
void NXOpen::Drafting::DrawingCreationWizardBuilder::SetDiscipline ( const char *  discipline)

Sets the discipline.


Created in NX8.0.0.

License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
disciplinediscipline
void NXOpen::Drafting::DrawingCreationWizardBuilder::SetDrawingStyle ( const NXString drawingStyle)

Sets the drawing style.


Created in NX8.0.0.

License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
drawingStyledrawingstyle
void NXOpen::Drafting::DrawingCreationWizardBuilder::SetDrawingStyle ( const char *  drawingStyle)

Sets the drawing style.


Created in NX8.0.0.

License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
drawingStyledrawingstyle
void NXOpen::Drafting::DrawingCreationWizardBuilder::SetFolder ( const NXString foldername)

Sets the folder.


Created in NX8.0.0.

License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
foldernamefoldername
void NXOpen::Drafting::DrawingCreationWizardBuilder::SetFolder ( const char *  foldername)

Sets the folder.


Created in NX8.0.0.

License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
foldernamefoldername
void NXOpen::Drafting::DrawingCreationWizardBuilder::SetIntroductoryTemplate ( const NXString introductoryTemplate)

Sets the introductory template.


Created in NX8.0.0.

License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
introductoryTemplateintroductorytemplate
void NXOpen::Drafting::DrawingCreationWizardBuilder::SetIntroductoryTemplate ( const char *  introductoryTemplate)

Sets the introductory template.


Created in NX8.0.0.

License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
introductoryTemplateintroductorytemplate
void NXOpen::Drafting::DrawingCreationWizardBuilder::SetName ( const NXString name)

Sets the name.


Created in NX8.0.0.

License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
namename
void NXOpen::Drafting::DrawingCreationWizardBuilder::SetName ( const char *  name)

Sets the name.


Created in NX8.0.0.

License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
namename
void NXOpen::Drafting::DrawingCreationWizardBuilder::SetNumber ( const NXString number)

Sets the number.

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

License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
numbernumber
void NXOpen::Drafting::DrawingCreationWizardBuilder::SetNumber ( const char *  number)

Sets the number.

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

License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
numbernumber
void NXOpen::Drafting::DrawingCreationWizardBuilder::SetObjectCreateBuilder ( NXOpen::PDM::ObjectCreateBuilder objectCreateBuilder)

Sets NXOpen::PDM::ObjectCreateBuilder
Created in NX10.0.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
objectCreateBuilderobjectcreatebuilder
void NXOpen::Drafting::DrawingCreationWizardBuilder::SetRevision ( const NXString revision)

Sets the revision.

This is only used in managed mode. In edit mode it must be set after the NXOpen::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 : nx_drawing_auto ("NX Drawing Automation")

Parameters
revisionrevision
void NXOpen::Drafting::DrawingCreationWizardBuilder::SetRevision ( const char *  revision)

Sets the revision.

This is only used in managed mode. In edit mode it must be set after the NXOpen::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 : nx_drawing_auto ("NX Drawing Automation")

Parameters
revisionrevision
void NXOpen::Drafting::DrawingCreationWizardBuilder::SetSummary ( const std::vector< NXString > &  summary)

Sets the summary
Created in NX7.5.0.



License requirements : nx_drawing_auto ("NX Drawing Automation")

Parameters
summarysummary

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.