DrawingSheetCollection Class

class NXOpen.Drawings.DrawingSheetCollection

Bases: object

Represents a collection of drawing sheets.

To obtain an instance of this class, refer to NXOpen.Part

New in version NX3.0.0.

Properties

Property Description
CurrentDrawingSheet Returns the currently opened drawing sheet.
SheetTemplates Returns the Sheet Template Manager for part

Methods

Method Description
DrawingSheetBuilder Create a drawing Sheet builder
FindObject Finds the NXOpen.Drawings.DrawingSheet with the given identifier as recorded in a journal.
InsertSheet Inserts a sheet into a part.
RefreshCurrentSheet Refresh the current Sheet

Property Detail

CurrentDrawingSheet

DrawingSheetCollection.CurrentDrawingSheet

Returns the currently opened drawing sheet.

This will return None if no drawing sheet is opened.

-------------------------------------

Getter Method

Signature CurrentDrawingSheet

Returns:
Return type:NXOpen.Drawings.DrawingSheet

New in version NX3.0.0.

License requirements: drafting (“DRAFTING”)

SheetTemplates

DrawingSheetCollection.SheetTemplates

Returns the Sheet Template Manager for part

Signature SheetTemplates

New in version NX3.0.0.

Returns:
Return type:NXOpen.Drawings.SheetTemplateManager

Method Detail

DrawingSheetBuilder

DrawingSheetCollection.DrawingSheetBuilder

Create a drawing Sheet builder

Signature DrawingSheetBuilder(sheet)

Parameters:sheet (NXOpen.Drawings.DrawingSheet) – the drawing sheet
Returns:the drawing sheet Builder with this identifier
Return type:NXOpen.Drawings.DrawingSheetBuilder

New in version NX5.0.0.

Deprecated since version NX12.0.0: Use NXOpen.Drawings.DraftingDrawingSheetCollection.CreateDraftingDrawingSheetBuilder() instead.

License requirements: drafting (“DRAFTING”)

FindObject

DrawingSheetCollection.FindObject

Finds the NXOpen.Drawings.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.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Identifier of the drawing sheet you want
Returns:Drawing sheet with this identifier
Return type:NXOpen.Drawings.DrawingSheet

New in version NX3.0.0.

Deprecated since version NX12.0.0: Use NXOpen.Drawings.DraftingDrawingSheetCollection.FindObject() instead.

License requirements: drafting (“DRAFTING”)

InsertSheet

DrawingSheetCollection.InsertSheet

Overloaded method InsertSheet

  • InsertSheet(drawingName, drawingUnits, width, height, numerator, denominator, projectionAngle)
  • InsertSheet(drawingName, sheetSize, numerator, denominator, projectionAngle)

-------------------------------------

Inserts a sheet into a part.

Signature InsertSheet(drawingName, drawingUnits, width, height, numerator, denominator, projectionAngle)

Parameters:
Returns:
Return type:

NXOpen.Drawings.DrawingSheet

New in version NX3.0.0.

Deprecated since version NX12.0.0: Use NXOpen.Drawings.DraftingDrawingSheetCollection.InsertSheet() instead.

License requirements: drafting (“DRAFTING”)

-------------------------------------

Inserts a sheet into a part. The drawings units will be inferred from the standard size.

Signature InsertSheet(drawingName, sheetSize, numerator, denominator, projectionAngle)

Parameters:
Returns:
Return type:

NXOpen.Drawings.DrawingSheet

New in version NX3.0.0.

Deprecated since version NX12.0.0: Use NXOpen.Drawings.DraftingDrawingSheetCollection.InsertSheet() instead.

License requirements: drafting (“DRAFTING”)

-------------------------------------

RefreshCurrentSheet

DrawingSheetCollection.RefreshCurrentSheet

Refresh the current Sheet

Signature RefreshCurrentSheet()

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”)