DrawingCreationWizardBuilder Class

class NXOpen.Drafting.DrawingCreationWizardBuilder

Bases: NXOpen.Builder

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:<br/>

Native Mode

The NXOpen.Drafting.DrawingCreationWizardBuilder.Folder() must be the first thing set after creating the builder. Setting this will populate the builder with the booklet’s information.

Managed Mode

The NXOpen.Drafting.DrawingCreationWizardBuilder.Number() and NXOpen.Drafting.DrawingCreationWizardBuilder.Revision() must be the first things set after creating the builder (in that order). The setting of the NXOpen.Drafting.DrawingCreationWizardBuilder.Revision() will populate the builder with the booklet’s information.

To create a new instance of this class, use NXOpen.Drafting.AutomationManager.CreateDrawingCreationWizardBuilder()

Default values.

Property	Value
ApplyTemplateToAll	0

New in version NX8.0.0.

Properties

Property	Description
ApplyTemplateToAll	Returns or sets the flag which controls the behavior of setting NXOpen.Drafting.PrimaryContentItemBuilder.GeometryTemplate() on an item in NXOpen.Drafting.DrawingCreationWizardBuilder.PrimaryContent().
Attributes	Returns the attributes.
DetailID	Returns or sets the detail id.
Discipline	Returns or sets the discipline.
DrawingStyle	Returns or sets the drawing style.
ExcludedContent	Returns the excluded content.
Folder	Returns or sets the folder.
IntroductoryTemplate	Returns or sets the introductory template.
Name	Returns or sets the name.
Number	Returns or sets the number.
PrimaryContent	Returns the primary content.
References	Returns the references.
Revision	Returns or sets the revision.
SecondaryContent	Returns the secondary content.
Tag	Returns the Tag for this object.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
GetSummary	Returns the summary.
SetObjectCreateBuilder	Sets NXOpen.PDM.ObjectCreateBuilder
SetSummary	Sets the summary
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

ApplyTemplateToAll

DrawingCreationWizardBuilder.ApplyTemplateToAll

Returns or 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()

-------------------------------------

Getter Method

Signature ApplyTemplateToAll

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ApplyTemplateToAll

Parameters:applyTemplateToAll (bool) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

Attributes

DrawingCreationWizardBuilder.Attributes

Returns the attributes.

-------------------------------------

Getter Method

Signature Attributes

Returns: Return type:NXOpen.Drafting.AttributeItemBuilderList

New in version NX8.0.0.

License requirements: None.

DetailID

DrawingCreationWizardBuilder.DetailID

Returns or sets the detail id.

-------------------------------------

Getter Method

Signature DetailID

Returns: Return type:str

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DetailID

Parameters:detailID (str) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

Discipline

DrawingCreationWizardBuilder.Discipline

Returns or sets the discipline.

-------------------------------------

Getter Method

Signature Discipline

Returns: Return type:str

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Discipline

Parameters:discipline (str) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

DrawingStyle

DrawingCreationWizardBuilder.DrawingStyle

Returns or sets the drawing style.

-------------------------------------

Getter Method

Signature DrawingStyle

Returns: Return type:str

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DrawingStyle

Parameters:drawingStyle (str) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

ExcludedContent

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.

-------------------------------------

Getter Method

Signature ExcludedContent

Returns: Return type:NXOpen.Assemblies.SelectComponentList

New in version NX8.0.0.

License requirements: None.

Folder

DrawingCreationWizardBuilder.Folder

Returns or sets the folder.

-------------------------------------

Getter Method

Signature Folder

Returns: Return type:str

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Folder

Parameters:foldername (str) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

IntroductoryTemplate

DrawingCreationWizardBuilder.IntroductoryTemplate

Returns or sets the introductory template.

-------------------------------------

Getter Method

Signature IntroductoryTemplate

Returns: Return type:str

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IntroductoryTemplate

Parameters:introductoryTemplate (str) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

Name

DrawingCreationWizardBuilder.Name

Returns or sets the name.

-------------------------------------

Getter Method

Signature Name

Returns: Return type:str

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Name

Parameters:name (str) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

Number

DrawingCreationWizardBuilder.Number

Returns or sets the number.

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

-------------------------------------

Getter Method

Signature Number

Returns: Return type:str

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Number

Parameters:number (str) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

PrimaryContent

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.

-------------------------------------

Getter Method

Signature PrimaryContent

Returns: Return type:NXOpen.Drafting.PrimaryContentItemBuilderList

New in version NX8.0.0.

License requirements: None.

References

DrawingCreationWizardBuilder.References

Returns the references.

-------------------------------------

Getter Method

Signature References

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX8.0.0.

License requirements: None.

Revision

DrawingCreationWizardBuilder.Revision

Returns or sets the revision.

This is only used in managed mode. In edit mode it must be set after the NXOpen.Drafting.DrawingCreationWizardBuilder.Number() and at the time is set it will populate the builder with the booklet’s information.

-------------------------------------

Getter Method

Signature Revision

Returns: Return type:str

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Revision

Parameters:revision (str) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

SecondaryContent

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.

-------------------------------------

Getter Method

Signature SecondaryContent

Returns: Return type:NXOpen.Assemblies.SelectComponentList

New in version NX8.0.0.

License requirements: None.

Method Detail

GetSummary

DrawingCreationWizardBuilder.GetSummary

Returns the summary.

This is in HTML format.

Signature GetSummary()

Returns: Return type:list of str

New in version NX8.0.0.

License requirements: None.

SetObjectCreateBuilder

DrawingCreationWizardBuilder.SetObjectCreateBuilder

Sets NXOpen.PDM.ObjectCreateBuilder

Signature SetObjectCreateBuilder(objectCreateBuilder)

Parameters:objectCreateBuilder (NXOpen.PDM.ObjectCreateBuilder) –

New in version NX10.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

SetSummary

DrawingCreationWizardBuilder.SetSummary

Sets the summary

Signature SetSummary(summary)

Parameters:summary (list of str) –

New in version NX7.5.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

Validate

DrawingCreationWizardBuilder.Validate

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.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.