Represents a TDP::TemplatePage builder
To create a new instance of this class, use NXOpen::TDP::Manager::CreateTemplatePageBuilder

Created in NX1847.0.0. More...

Inheritance diagram for NXOpen::TDP::TemplatePageBuilder:

Public Types
enum	EnglishSizeType { EnglishSizeTypeA, EnglishSizeTypeB, EnglishSizeTypeC, EnglishSizeTypeD, EnglishSizeTypeE, EnglishSizeTypeF, EnglishSizeTypeH, EnglishSizeTypeJ, EnglishSizeTypeCustom }
	english template standard size More...

enum	MetricSizeType { MetricSizeTypeA0, MetricSizeTypeA1, MetricSizeTypeA2, MetricSizeTypeA3, MetricSizeTypeA4, MetricSizeTypeCustom }
	metric template standard size More...

enum	OrientationType { OrientationTypeLandscape, OrientationTypePortrait }
	template orientation More...

Public Member Functions
double	Height ()
	Returns the custom or standard height for the page Created in NX1847.0.0. More...

double	Length ()
	Returns the custom or standard length to be used for the page to be created or edited. More...

NXOpen::TDP::TemplatePageBuilder::OrientationType	Orientation ()
	Returns the orientation Created in NX1847.0.0. More...

NXString	PageName ()
	Returns the Page Name text Created in NX1847.0.0. More...

void	SetHeight (double customHeight)
	Sets the custom or standard height for the page Created in NX1847.0.0. More...

void	SetLength (double customLength)
	Sets the custom or standard length to be used for the page to be created or edited. More...

void	SetOrientation (NXOpen::TDP::TemplatePageBuilder::OrientationType orientation)
	Sets the orientation Created in NX1847.0.0. More...

void	SetPageName (const NXString &pageName)
	Sets the Page Name text Created in NX1847.0.0. More...

void	SetPageName (const char *pageName)
	Sets the Page Name text Created in NX1847.0.0. More...

void	SetShowPageNumber (bool showPageNumber)
	Sets the show Page number Created in NX1847.0.0. More...

void	SetStandardEnglishSize (NXOpen::TDP::TemplatePageBuilder::EnglishSizeType englishSize)
	Sets the standard english size to be used for the page to be created or edited. More...

void	SetStandardMetricSize (NXOpen::TDP::TemplatePageBuilder::MetricSizeType metricSize)
	Sets the standard metric size to be used for the page to be created or edited. More...

bool	ShowPageNumber ()
	Returns the show Page number Created in NX1847.0.0. More...

NXOpen::TDP::TemplatePageBuilder::EnglishSizeType	StandardEnglishSize ()
	Returns the standard english size to be used for the page to be created or edited. More...

NXOpen::TDP::TemplatePageBuilder::MetricSizeType	StandardMetricSize ()
	Returns the standard metric size to be used for the page to be created or edited. 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 TDP::TemplatePage builder
To create a new instance of this class, use NXOpen::TDP::Manager::CreateTemplatePageBuilder

Created in NX1847.0.0.

Member Enumeration Documentation

enum NXOpen::TDP::TemplatePageBuilder::EnglishSizeType

english template standard size

Enumerator
EnglishSizeTypeA	a
EnglishSizeTypeB	b
EnglishSizeTypeC	c
EnglishSizeTypeD	d
EnglishSizeTypeE	e
EnglishSizeTypeF	f
EnglishSizeTypeH	h
EnglishSizeTypeJ	j
EnglishSizeTypeCustom	custom

enum NXOpen::TDP::TemplatePageBuilder::MetricSizeType

metric template standard size

Enumerator
MetricSizeTypeA0	a0
MetricSizeTypeA1	a1
MetricSizeTypeA2	a2
MetricSizeTypeA3	a3
MetricSizeTypeA4	a4
MetricSizeTypeCustom	custom

enum NXOpen::TDP::TemplatePageBuilder::OrientationType

template orientation

Enumerator
OrientationTypeLandscape	landscape
OrientationTypePortrait	portrait

Member Function Documentation

double NXOpen::TDP::TemplatePageBuilder::Height ( )

Returns the custom or standard height for the page
Created in NX1847.0.0.

License requirements : None

double NXOpen::TDP::TemplatePageBuilder::Length ( )

Returns the custom or standard length to be used for the page to be created or edited.

Created in NX1847.0.0.

License requirements : None

NXOpen::TDP::TemplatePageBuilder::OrientationType NXOpen::TDP::TemplatePageBuilder::Orientation ( )

Returns the orientation
Created in NX1847.0.0.

License requirements : None

NXString NXOpen::TDP::TemplatePageBuilder::PageName ( )

Returns the Page Name text
Created in NX1847.0.0.

License requirements : None

void NXOpen::TDP::TemplatePageBuilder::SetHeight ( double customHeight )

Sets the custom or standard height for the page
Created in NX1847.0.0.

License requirements : None

Parameters

customHeight the custom height for the page

void NXOpen::TDP::TemplatePageBuilder::SetLength ( double customLength )

Sets the custom or standard length to be used for the page to be created or edited.

Created in NX1847.0.0.

License requirements : None

Parameters

customLength the custom length for the page

void NXOpen::TDP::TemplatePageBuilder::SetOrientation ( NXOpen::TDP::TemplatePageBuilder::OrientationType orientation )

Sets the orientation
Created in NX1847.0.0.

License requirements : None

Parameters

orientation the orientation for the page

void NXOpen::TDP::TemplatePageBuilder::SetPageName ( const NXString & pageName )

Sets the Page Name text
Created in NX1847.0.0.

License requirements : geometric_tol ("GDT")

Parameters

pageName name for the page

void NXOpen::TDP::TemplatePageBuilder::SetPageName ( const char * pageName )

Sets the Page Name text
Created in NX1847.0.0.

License requirements : geometric_tol ("GDT")

Parameters

pageName name for the page

void NXOpen::TDP::TemplatePageBuilder::SetShowPageNumber ( bool showPageNumber )

Sets the show Page number
Created in NX1847.0.0.

License requirements : geometric_tol ("GDT")

Parameters

showPageNumber show page number for the page

void NXOpen::TDP::TemplatePageBuilder::SetStandardEnglishSize ( NXOpen::TDP::TemplatePageBuilder::EnglishSizeType englishSize )

Sets the standard english size to be used for the page to be created or edited.

Created in NX1847.0.0.

License requirements : None

Parameters

englishSize the standard english size for the page

void NXOpen::TDP::TemplatePageBuilder::SetStandardMetricSize ( NXOpen::TDP::TemplatePageBuilder::MetricSizeType metricSize )

Sets the standard metric size to be used for the page to be created or edited.

Created in NX1847.0.0.

License requirements : None

Parameters

metricSize the standard metric size for the page

bool NXOpen::TDP::TemplatePageBuilder::ShowPageNumber ( )

Returns the show Page number
Created in NX1847.0.0.

License requirements : None

NXOpen::TDP::TemplatePageBuilder::EnglishSizeType NXOpen::TDP::TemplatePageBuilder::StandardEnglishSize ( )

Returns the standard english size to be used for the page to be created or edited.

Created in NX1847.0.0.

License requirements : None

NXOpen::TDP::TemplatePageBuilder::MetricSizeType NXOpen::TDP::TemplatePageBuilder::StandardMetricSize ( )

Returns the standard metric size to be used for the page to be created or edited.

Created in NX1847.0.0.

License requirements : None

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

TDP_TemplatePageBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation