NXOpen::Drawings::MarkAsTemplateBuilder Class Reference

Represents a NXOpen::Drawings::MarkAsTemplateBuilder
To create a new instance of this class, use NXOpen::DraftingManager::CreateMarkAsTemplateBuilder

Created in NX8.0.0. More...

Inheritance diagram for NXOpen::Drawings::MarkAsTemplateBuilder:

Public Types
enum	ActionTypeEnum { ActionTypeEnumTemplateOnly, ActionTypeEnumTemplateAndPax }
	the action type enum. More...
enum	ItemTypeEnum { ItemTypeEnumAny, ItemTypeEnumNXPart, ItemTypeEnumNXDrawing }
	the item type enum. More...
enum	RelationTypeEnum { RelationTypeEnumMaster, RelationTypeEnumSpecification, RelationTypeEnumManifestation }
	the relation type enum. More...
enum	TemplateTypeEnum { TemplateTypeEnumSheet, TemplateTypeEnumReferenceExistingPart, TemplateTypeEnumStandalone }
	the template type enum. More...

Public Member Functions
NXOpen::Drawings::MarkAsTemplateBuilder::ActionTypeEnum	ActionType ()
	Returns the action type of the part. More...
NXString	Description ()
	Returns the detailed description for each template. More...
NXOpen::Drawings::MarkAsTemplateBuilder::ItemTypeEnum	ItemType ()
	Returns the item type of the part. More...
NXString	PaxFileName ()
	Returns the PAX file to be updated or created if it does not exist. More...
NXString	PresentationName ()
	Returns the presentation name of the template that will be displayed in the File->New dialog. More...
NXOpen::Drawings::MarkAsTemplateBuilder::RelationTypeEnum	RelationType ()
	Returns the relation type is required only for the managed mode. More...
void	SetActionType (NXOpen::Drawings::MarkAsTemplateBuilder::ActionTypeEnum actionType)
	Sets the action type of the part. More...
void	SetDescription (const NXString &description)
	Sets the detailed description for each template. More...
void	SetDescription (const char *description)
	Sets the detailed description for each template. More...
void	SetItemType (NXOpen::Drawings::MarkAsTemplateBuilder::ItemTypeEnum itemType)
	Sets the item type of the part. More...
void	SetPaxFileName (const NXString &filename)
	Sets the PAX file to be updated or created if it does not exist. More...
void	SetPaxFileName (const char *filename)
	Sets the PAX file to be updated or created if it does not exist. More...
void	SetPresentationName (const NXString &presentationName)
	Sets the presentation name of the template that will be displayed in the File->New dialog. More...
void	SetPresentationName (const char *presentationName)
	Sets the presentation name of the template that will be displayed in the File->New dialog. More...
void	SetRelationType (NXOpen::Drawings::MarkAsTemplateBuilder::RelationTypeEnum relationType)
	Sets the relation type is required only for the managed mode. More...
void	SetTemplateType (NXOpen::Drawings::MarkAsTemplateBuilder::TemplateTypeEnum templateType)
	Sets the template Type will be one of the following: Sheet To save it as Sheet template. More...
NXOpen::Drawings::MarkAsTemplateBuilder::TemplateTypeEnum	TemplateType ()
	Returns the template Type will be one of the following: Sheet To save it as Sheet template. 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 NXOpen::Drawings::MarkAsTemplateBuilder
To create a new instance of this class, use NXOpen::DraftingManager::CreateMarkAsTemplateBuilder

Created in NX8.0.0.

Member Enumeration Documentation

enum NXOpen::Drawings::MarkAsTemplateBuilder::ActionTypeEnum

the action type enum.

Enumerator
ActionTypeEnumTemplateOnly	template only
ActionTypeEnumTemplateAndPax	template and pax

enum NXOpen::Drawings::MarkAsTemplateBuilder::ItemTypeEnum

the item type enum.

Enumerator
ItemTypeEnumAny	any
ItemTypeEnumNXPart	nxpart
ItemTypeEnumNXDrawing	nxdrawing

enum NXOpen::Drawings::MarkAsTemplateBuilder::RelationTypeEnum

the relation type enum.

Enumerator
RelationTypeEnumMaster	master
RelationTypeEnumSpecification	specification
RelationTypeEnumManifestation	manifestation

enum NXOpen::Drawings::MarkAsTemplateBuilder::TemplateTypeEnum

the template type enum.

Enumerator
TemplateTypeEnumSheet	sheet
TemplateTypeEnumReferenceExistingPart	reference existing part
TemplateTypeEnumStandalone	standalone

Member Function Documentation

NXOpen::Drawings::MarkAsTemplateBuilder::ActionTypeEnum NXOpen::Drawings::MarkAsTemplateBuilder::ActionType

(

)

Returns the action type of the part.

Created in NX8.0.0.

License requirements : None

NXString NXOpen::Drawings::MarkAsTemplateBuilder::Description

(

)

Returns the detailed description for each template.

Created in NX8.0.0.

License requirements : None

NXOpen::Drawings::MarkAsTemplateBuilder::ItemTypeEnum NXOpen::Drawings::MarkAsTemplateBuilder::ItemType

(

)

Returns the item type of the part.

Created in NX8.0.0.

License requirements : None

NXString NXOpen::Drawings::MarkAsTemplateBuilder::PaxFileName

(

)

Returns the PAX file to be updated or created if it does not exist.

Created in NX8.0.0.

License requirements : None

NXString NXOpen::Drawings::MarkAsTemplateBuilder::PresentationName

(

)

Returns the presentation name of the template that will be displayed in the File->New dialog.

Created in NX8.0.0.

License requirements : None

NXOpen::Drawings::MarkAsTemplateBuilder::RelationTypeEnum NXOpen::Drawings::MarkAsTemplateBuilder::RelationType

(

)

Returns the relation type is required only for the managed mode.

The available options are Master Specification Manifestation

Created in NX8.0.0.

License requirements : None

void NXOpen::Drawings::MarkAsTemplateBuilder::SetActionType

(

NXOpen::Drawings::MarkAsTemplateBuilder::ActionTypeEnum

actionType

)

Sets the action type of the part.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

actionType

actiontype

void NXOpen::Drawings::MarkAsTemplateBuilder::SetDescription

(

const NXString &

description

)

Sets the detailed description for each template.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

description

description

void NXOpen::Drawings::MarkAsTemplateBuilder::SetDescription

(

const char *

description

)

Sets the detailed description for each template.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

description

description

void NXOpen::Drawings::MarkAsTemplateBuilder::SetItemType

(

NXOpen::Drawings::MarkAsTemplateBuilder::ItemTypeEnum

itemType

)

Sets the item type of the part.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

itemType

itemtype

void NXOpen::Drawings::MarkAsTemplateBuilder::SetPaxFileName

(

const NXString &

filename

)

Sets the PAX file to be updated or created if it does not exist.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

filename

filename

void NXOpen::Drawings::MarkAsTemplateBuilder::SetPaxFileName

(

const char *

filename

)

Sets the PAX file to be updated or created if it does not exist.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

filename

filename

void NXOpen::Drawings::MarkAsTemplateBuilder::SetPresentationName

(

const NXString &

presentationName

)

Sets the presentation name of the template that will be displayed in the File->New dialog.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

presentationName

presentationname

void NXOpen::Drawings::MarkAsTemplateBuilder::SetPresentationName

(

const char *

presentationName

)

Sets the presentation name of the template that will be displayed in the File->New dialog.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

presentationName

presentationname

void NXOpen::Drawings::MarkAsTemplateBuilder::SetRelationType

(

NXOpen::Drawings::MarkAsTemplateBuilder::RelationTypeEnum

relationType

)

Sets the relation type is required only for the managed mode.

The available options are Master Specification Manifestation

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

relationType

relationtype

void NXOpen::Drawings::MarkAsTemplateBuilder::SetTemplateType

(

NXOpen::Drawings::MarkAsTemplateBuilder::TemplateTypeEnum

templateType

)

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

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

templateType

templatetype

NXOpen::Drawings::MarkAsTemplateBuilder::TemplateTypeEnum NXOpen::Drawings::MarkAsTemplateBuilder::TemplateType

(

)

Returns 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

Created in NX8.0.0.

License requirements : None

---

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

• Drawings_MarkAsTemplateBuilder.hxx