MarkAsTemplateBuilder Class¶
-
class
NXOpen.Drawings.
MarkAsTemplateBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Drawings.MarkAsTemplateBuilder
To create a new instance of this class, use
NXOpen.DraftingManager.CreateMarkAsTemplateBuilder()
New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
ActionType | Returns or sets the action type of the part. |
Description | Returns or sets the detailed description for each template. |
ItemType | Returns or sets the item type of the part. |
PaxFileName | Returns or sets the PAX file to be updated or created if it does not exist. |
PresentationName | Returns or sets the presentation name of the template that will be displayed in the File->New dialog. |
RelationType | Returns or sets the relation type is required only for the managed mode. |
Tag | Returns the Tag for this object. |
TemplateType | Returns or sets the template Type will be one of the following: Sheet To save it as Sheet template. |
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. |
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. |
Enumerations¶
MarkAsTemplateBuilderActionTypeEnum Enumeration | the action type enum. |
MarkAsTemplateBuilderItemTypeEnum Enumeration | the item type enum. |
MarkAsTemplateBuilderRelationTypeEnum Enumeration | the relation type enum. |
MarkAsTemplateBuilderTemplateTypeEnum Enumeration | the template type enum. |
Property Detail¶
ActionType¶
-
MarkAsTemplateBuilder.
ActionType
¶ Returns or sets the action type of the part.
-------------------------------------
Getter Method
Signature
ActionType
Returns: Return type: NXOpen.Drawings.MarkAsTemplateBuilderActionTypeEnum
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ActionType
Parameters: actionType ( NXOpen.Drawings.MarkAsTemplateBuilderActionTypeEnum
) –New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
Description¶
-
MarkAsTemplateBuilder.
Description
¶ Returns or sets the detailed description for each template.
-------------------------------------
Getter Method
Signature
Description
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Description
Parameters: description (str) – New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
ItemType¶
-
MarkAsTemplateBuilder.
ItemType
¶ Returns or sets the item type of the part.
-------------------------------------
Getter Method
Signature
ItemType
Returns: Return type: NXOpen.Drawings.MarkAsTemplateBuilderItemTypeEnum
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ItemType
Parameters: itemType ( NXOpen.Drawings.MarkAsTemplateBuilderItemTypeEnum
) –New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
PaxFileName¶
-
MarkAsTemplateBuilder.
PaxFileName
¶ Returns or sets the PAX file to be updated or created if it does not exist.
-------------------------------------
Getter Method
Signature
PaxFileName
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PaxFileName
Parameters: filename (str) – New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
PresentationName¶
-
MarkAsTemplateBuilder.
PresentationName
¶ Returns or sets the presentation name of the template that will be displayed in the File->New dialog.
-------------------------------------
Getter Method
Signature
PresentationName
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PresentationName
Parameters: presentationName (str) – New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
RelationType¶
-
MarkAsTemplateBuilder.
RelationType
¶ Returns or sets the relation type is required only for the managed mode.
The available options are Master Specification Manifestation
-------------------------------------
Getter Method
Signature
RelationType
Returns: Return type: NXOpen.Drawings.MarkAsTemplateBuilderRelationTypeEnum
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RelationType
Parameters: relationType ( NXOpen.Drawings.MarkAsTemplateBuilderRelationTypeEnum
) –New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
TemplateType¶
-
MarkAsTemplateBuilder.
TemplateType
¶ Returns or sets the template Type will be one of the following: Sheet To save it as Sheet template.
When using Sheet templates, NX adds drawing sheets based on the template to the current work part. Master Model Drawing To save it as Master Model Drawing template. When using Master Model Drawing templates, NX create a new master model drawing from the current part. NX creates a new drawing part from the template and includes the current model as a component. 2D-Drawing To save it as 2D Drawing template. These are the templates used for 2D-drawings. These templates do not require a master model
-------------------------------------
Getter Method
Signature
TemplateType
Returns: Return type: NXOpen.Drawings.MarkAsTemplateBuilderTemplateTypeEnum
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TemplateType
Parameters: templateType ( NXOpen.Drawings.MarkAsTemplateBuilderTemplateTypeEnum
) –New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
Method Detail¶
Validate¶
-
MarkAsTemplateBuilder.
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.