Represents a SheetBuilder. More...

Inheritance diagram for NXOpen::Diagramming::SheetBuilder:

Public Member Functions
bool	AllowJumpers ()
	Returns the flag if jumpers are allowed to use where connections cross. More...

NXString	Description ()
	Returns the description that will be visible when a template is selected in the Item Rev dialog. More...

std::vector < NXOpen::Diagramming::SheetElement * >	GetFeatures ()
	Gets all features. More...

std::vector < NXOpen::Diagramming::SheetElement * >	GetSheetElements ()
	Gets all sheet elements. More...

void	GetSize (double height, double width)
	Gets the height and width of this sheet. More...

NXOpen::Diagramming::DiagrammingJumpertype	JumperType ()
	Returns the jumper type of the sheet. More...

double	Opacity ()
	Returns the opacity of sheet. More...

NXString	PaxFileName ()
	Returns the path name of the PAX file to which the template will be written to. More...

NXString	PresentationName ()
	Returns the presentation name that will be visible in the "Presentation" column of the Item Rev dialog. More...

void	SetAllowJumpers (bool allowJumper)
	Sets the flag if jumpers are allowed to use where connections cross. More...

void	SetDescription (const NXString &description)
	Sets the description that will be visible when a template is selected in the Item Rev dialog. More...

void	SetDescription (const char *description)
	Sets the description that will be visible when a template is selected in the Item Rev dialog. More...

void	SetJumperType (NXOpen::Diagramming::DiagrammingJumpertype jumperType)
	Sets the jumper type of the sheet. More...

void	SetOpacity (double opacity)
	Sets the opacity of sheet. More...

void	SetPaxFileName (const NXString &paxFileName)
	Sets the path name of the PAX file to which the template will be written to. More...

void	SetPaxFileName (const char *paxFileName)
	Sets the path name of the PAX file to which the template will be written to. More...

void	SetPresentationName (const NXString &presentationName)
	Sets the presentation name that will be visible in the "Presentation" column of the Item Rev dialog. More...

void	SetPresentationName (const char *presentationName)
	Sets the presentation name that will be visible in the "Presentation" column of the Item Rev dialog. More...

void	SetSize (double height, double width)
	Sets the height and width of this sheet. More...

void	SetToolTip (const NXString &toolTip)
	Sets the tooltip that will be visible when a template is selected in the Item Rev dialog. More...

void	SetToolTip (const char *toolTip)
	Sets the tooltip that will be visible when a template is selected in the Item Rev dialog. More...

void	SetUnits (NXOpen::Unit *unit)
	Sets the units of the sheet. More...

void	SetUpdatePAXFile (bool updatePAXFile)
	Sets the flag to update pax file or not. More...

NXString	ToolTip ()
	Returns the tooltip that will be visible when a template is selected in the Item Rev dialog. More...

NXOpen::Unit *	Units ()
	Returns the units of the sheet. More...

bool	UpdatePAXFile ()
	Returns the flag to update pax file or not. More...

Detailed Description

Represents a SheetBuilder.

To create a new instance of this class, use NXOpen::Diagramming::SheetCollection::CreateSheetBuilder

Created in NX10.0.0.

Member Function Documentation

bool NXOpen::Diagramming::SheetBuilder::AllowJumpers ( )

Returns the flag if jumpers are allowed to use where connections cross.

Created in NX10.0.0.

License requirements : None

NXString NXOpen::Diagramming::SheetBuilder::Description ( )

Returns the description that will be visible when a template is selected in the Item Rev dialog.

Created in NX11.0.1.

License requirements : None

std::vector<NXOpen::Diagramming::SheetElement *> NXOpen::Diagramming::SheetBuilder::GetFeatures ( )

Gets all features.

Returns: Created in NX10.0.0.

License requirements : None

std::vector<NXOpen::Diagramming::SheetElement *> NXOpen::Diagramming::SheetBuilder::GetSheetElements ( )

Gets all sheet elements.

Returns: Created in NX10.0.0.

License requirements : None

void NXOpen::Diagramming::SheetBuilder::GetSize	(	double *	height,
		double *	width
	)

Gets the height and width of this sheet.

Created in NX10.0.0.

License requirements : None

Parameters

height	height
width	width

NXOpen::Diagramming::DiagrammingJumpertype NXOpen::Diagramming::SheetBuilder::JumperType ( )

Returns the jumper type of the sheet.

Created in NX11.0.0.

License requirements : None

double NXOpen::Diagramming::SheetBuilder::Opacity ( )

Returns the opacity of sheet.

0.0 is completely transparent and 1.0 is completely opaque
Created in NX10.0.0.

License requirements : None

NXString NXOpen::Diagramming::SheetBuilder::PaxFileName ( )

Returns the path name of the PAX file to which the template will be written to.

Created in NX11.0.1.

License requirements : None

NXString NXOpen::Diagramming::SheetBuilder::PresentationName ( )

Returns the presentation name that will be visible in the "Presentation" column of the Item Rev dialog.

Created in NX11.0.1.

License requirements : None

void NXOpen::Diagramming::SheetBuilder::SetAllowJumpers ( bool allowJumper )

Sets the flag if jumpers are allowed to use where connections cross.

Created in NX10.0.0.

License requirements : None

Parameters

allowJumper allowjumper

void NXOpen::Diagramming::SheetBuilder::SetDescription ( const NXString & description )

Sets the description that will be visible when a template is selected in the Item Rev dialog.

Created in NX11.0.1.

License requirements : None

Parameters

description description

void NXOpen::Diagramming::SheetBuilder::SetDescription ( const char * description )

Sets the description that will be visible when a template is selected in the Item Rev dialog.

Created in NX11.0.1.

License requirements : None

Parameters

description description

void NXOpen::Diagramming::SheetBuilder::SetJumperType ( NXOpen::Diagramming::DiagrammingJumpertype jumperType )

Sets the jumper type of the sheet.

Created in NX11.0.0.

License requirements : None

Parameters

jumperType jumpertype

void NXOpen::Diagramming::SheetBuilder::SetOpacity ( double opacity )

Sets the opacity of sheet.

0.0 is completely transparent and 1.0 is completely opaque
Created in NX10.0.0.

License requirements : None

Parameters

opacity opacity

void NXOpen::Diagramming::SheetBuilder::SetPaxFileName ( const NXString & paxFileName )

Sets the path name of the PAX file to which the template will be written to.

Created in NX11.0.1.

License requirements : None

Parameters

paxFileName paxfilename

void NXOpen::Diagramming::SheetBuilder::SetPaxFileName ( const char * paxFileName )

Sets the path name of the PAX file to which the template will be written to.

Created in NX11.0.1.

License requirements : None

Parameters

paxFileName paxfilename

void NXOpen::Diagramming::SheetBuilder::SetPresentationName ( const NXString & presentationName )

Sets the presentation name that will be visible in the "Presentation" column of the Item Rev dialog.

Created in NX11.0.1.

License requirements : None

Parameters

presentationName presentationname

void NXOpen::Diagramming::SheetBuilder::SetPresentationName ( const char * presentationName )

Sets the presentation name that will be visible in the "Presentation" column of the Item Rev dialog.

Created in NX11.0.1.

License requirements : None

Parameters

presentationName presentationname

void NXOpen::Diagramming::SheetBuilder::SetSize	(	double	height,
		double	width
	)

Sets the height and width of this sheet.

Created in NX10.0.0.

License requirements : None

Parameters

height	height
width	width

void NXOpen::Diagramming::SheetBuilder::SetToolTip ( const NXString & toolTip )

Sets the tooltip that will be visible when a template is selected in the Item Rev dialog.

Created in NX11.0.1.

License requirements : None

Parameters

toolTip tooltip

void NXOpen::Diagramming::SheetBuilder::SetToolTip ( const char * toolTip )

Sets the tooltip that will be visible when a template is selected in the Item Rev dialog.

Created in NX11.0.1.

License requirements : None

Parameters

toolTip tooltip

void NXOpen::Diagramming::SheetBuilder::SetUnits ( NXOpen::Unit * unit )

Sets the units of the sheet.

It could be either "meters" or "inches".
Created in NX10.0.0.

License requirements : None

Parameters

unit unit

void NXOpen::Diagramming::SheetBuilder::SetUpdatePAXFile ( bool updatePAXFile )

Sets the flag to update pax file or not.

Created in NX11.0.1.

License requirements : None

Parameters

updatePAXFile updatepaxfile

NXString NXOpen::Diagramming::SheetBuilder::ToolTip ( )

Returns the tooltip that will be visible when a template is selected in the Item Rev dialog.

Created in NX11.0.1.

License requirements : None

NXOpen::Unit* NXOpen::Diagramming::SheetBuilder::Units ( )

Returns the units of the sheet.

It could be either "meters" or "inches".
Created in NX10.0.0.

License requirements : None

bool NXOpen::Diagramming::SheetBuilder::UpdatePAXFile ( )

Returns the flag to update pax file or not.

Created in NX11.0.1.

License requirements : None

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

Diagramming_SheetBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation