Represents a collection of drawing sheets. More...

Inheritance diagram for NXOpen::Drawings::DrawingSheetCollection:

Classes
class	iterator
	Iterator for accessing the contents of the collection. More...

Public Member Functions
iterator	begin ()
	Returns an iterator addressing the first element.

NXOpen::Drawings::DrawingSheet *	CurrentDrawingSheet ()
	Returns the currently opened drawing sheet.

NXOpen::Drawings::DrawingSheetBuilder *	DrawingSheetBuilder (NXOpen::Drawings::DrawingSheet *sheet)
	Create a drawing Sheet builder.

iterator	end ()
	Returns an iterator addressing one past the last element.

NXOpen::Drawings::DrawingSheet *	FindObject (const NXString &journalIdentifier)
	Finds the DrawingSheet with the given identifier as recorded in a journal.

NXOpen::Drawings::DrawingSheet *	FindObject (const char *journalIdentifier)
	Finds the DrawingSheet with the given identifier as recorded in a journal.

NXOpen::Drawings::DrawingSheet *	InsertSheet (const NXString &drawingName, NXOpen::Drawings::DrawingSheet::Unit drawingUnits, double width, double height, double numerator, double denominator, NXOpen::Drawings::DrawingSheet::ProjectionAngleType projectionAngle)
	Inserts a sheet into a part.

NXOpen::Drawings::DrawingSheet *	InsertSheet (const char *drawingName, NXOpen::Drawings::DrawingSheet::Unit drawingUnits, double width, double height, double numerator, double denominator, NXOpen::Drawings::DrawingSheet::ProjectionAngleType projectionAngle)
	Inserts a sheet into a part.

NXOpen::Drawings::DrawingSheet *	InsertSheet (const NXString &drawingName, NXOpen::Drawings::DrawingSheet::StandardSheetSize sheetSize, double numerator, double denominator, NXOpen::Drawings::DrawingSheet::ProjectionAngleType projectionAngle)
	Inserts a sheet into a part.

NXOpen::Drawings::DrawingSheet *	InsertSheet (const char *drawingName, NXOpen::Drawings::DrawingSheet::StandardSheetSize sheetSize, double numerator, double denominator, NXOpen::Drawings::DrawingSheet::ProjectionAngleType projectionAngle)
	Inserts a sheet into a part.

void	RefreshCurrentSheet ()
	Refresh the current Sheet Created in NX9.0.0.

NXOpen::Drawings::SheetTemplateManager *	SheetTemplates ()
	Returns the Sheet Template Manager for part Created in NX3.0.0.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a collection of drawing sheets.

To obtain an instance of this class, refer to Part

Created in NX3.0.0.

Member Function Documentation

iterator NXOpen::Drawings::DrawingSheetCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Drawings::DrawingSheet* NXOpen::Drawings::DrawingSheetCollection::CurrentDrawingSheet ( )

Returns the currently opened drawing sheet.

This will return NULL if no drawing sheet is opened.
Created in NX3.0.0.

License requirements : drafting ("DRAFTING")

NXOpen::Drawings::DrawingSheetBuilder* NXOpen::Drawings::DrawingSheetCollection::DrawingSheetBuilder ( NXOpen::Drawings::DrawingSheet * sheet )

Create a drawing Sheet builder.

Returns: the drawing sheet Builder with this identifier
Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters

sheet the drawing sheet

iterator NXOpen::Drawings::DrawingSheetCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::Drawings::DrawingSheet* NXOpen::Drawings::DrawingSheetCollection::FindObject ( const NXString & journalIdentifier )

Finds the DrawingSheet with the given identifier as recorded in a journal.

   An object may not return the same value as its JournalIdentifier in different versions of 
   the software. However newer versions of the software should find the same object when 
   FindObject is passed older versions of its journal identifier. In general, this method 
   should not be used in handwritten code and exists to support record and playback of journals.

   An exception will be thrown if no object can be found with the given journal identifier.  @return  Drawing sheet with this identifier

Created in NX3.0.0.

License requirements : drafting ("DRAFTING")

Parameters

journalIdentifier Identifier of the drawing sheet you want

NXOpen::Drawings::DrawingSheet* NXOpen::Drawings::DrawingSheetCollection::FindObject ( const char * journalIdentifier )

Finds the DrawingSheet with the given identifier as recorded in a journal.

   An object may not return the same value as its JournalIdentifier in different versions of 
   the software. However newer versions of the software should find the same object when 
   FindObject is passed older versions of its journal identifier. In general, this method 
   should not be used in handwritten code and exists to support record and playback of journals.

   An exception will be thrown if no object can be found with the given journal identifier.  @return  Drawing sheet with this identifier

Created in NX3.0.0.

License requirements : drafting ("DRAFTING")

Parameters

journalIdentifier Identifier of the drawing sheet you want

NXOpen::Drawings::DrawingSheet* NXOpen::Drawings::DrawingSheetCollection::InsertSheet	(	const NXString &	drawingName,
		NXOpen::Drawings::DrawingSheet::Unit	drawingUnits,
		double	width,
		double	height,
		double	numerator,
		double	denominator,
		NXOpen::Drawings::DrawingSheet::ProjectionAngleType	projectionAngle
	)

Inserts a sheet into a part.

Returns: Created in NX3.0.0.

License requirements : drafting ("DRAFTING")

Parameters

drawingName	Drawing name NOTE: The full Unicode character set is not supported for this parameter.
drawingUnits	Unit of sheet size
width	Width of drawing
height	Height of drawing
numerator	Numerator of the scale of drawing
denominator	Denominator of the scale of drawing
projectionAngle	Projection angle

NXOpen::Drawings::DrawingSheet* NXOpen::Drawings::DrawingSheetCollection::InsertSheet	(	const char *	drawingName,
		NXOpen::Drawings::DrawingSheet::Unit	drawingUnits,
		double	width,
		double	height,
		double	numerator,
		double	denominator,
		NXOpen::Drawings::DrawingSheet::ProjectionAngleType	projectionAngle
	)

Inserts a sheet into a part.

Returns: Created in NX3.0.0.

License requirements : drafting ("DRAFTING")

Parameters

drawingName	Drawing name NOTE: The full Unicode character set is not supported for this parameter.
drawingUnits	Unit of sheet size
width	Width of drawing
height	Height of drawing
numerator	Numerator of the scale of drawing
denominator	Denominator of the scale of drawing
projectionAngle	Projection angle

NXOpen::Drawings::DrawingSheet* NXOpen::Drawings::DrawingSheetCollection::InsertSheet	(	const NXString &	drawingName,
		NXOpen::Drawings::DrawingSheet::StandardSheetSize	sheetSize,
		double	numerator,
		double	denominator,
		NXOpen::Drawings::DrawingSheet::ProjectionAngleType	projectionAngle
	)

Inserts a sheet into a part.

The drawings units will be inferred from the standard size.

Returns: Created in NX3.0.0.

License requirements : drafting ("DRAFTING")

Parameters

drawingName	Drawing name NOTE: The full Unicode character set is not supported for this parameter.
sheetSize	Sheet Size
numerator	Numerator of the scale of drawing
denominator	Denominator of the scale of drawing
projectionAngle	Projection angle

NXOpen::Drawings::DrawingSheet* NXOpen::Drawings::DrawingSheetCollection::InsertSheet	(	const char *	drawingName,
		NXOpen::Drawings::DrawingSheet::StandardSheetSize	sheetSize,
		double	numerator,
		double	denominator,
		NXOpen::Drawings::DrawingSheet::ProjectionAngleType	projectionAngle
	)

Inserts a sheet into a part.

The drawings units will be inferred from the standard size.

Returns: Created in NX3.0.0.

License requirements : drafting ("DRAFTING")

Parameters

drawingName	Drawing name NOTE: The full Unicode character set is not supported for this parameter.
sheetSize	Sheet Size
numerator	Numerator of the scale of drawing
denominator	Denominator of the scale of drawing
projectionAngle	Projection angle

void NXOpen::Drawings::DrawingSheetCollection::RefreshCurrentSheet ( )

Refresh the current Sheet
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

NXOpen::Drawings::SheetTemplateManager* NXOpen::Drawings::DrawingSheetCollection::SheetTemplates ( )

Returns the Sheet Template Manager for part
Created in NX3.0.0.

tag_t NXOpen::Drawings::DrawingSheetCollection::Tag ( ) const

Returns the tag of this object.

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

Drawings_DrawingSheetCollection.hxx

Classes

Public Member Functions

Detailed Description

Member Function Documentation