DrawingSheet Class — NXOpen Python API Reference 12.0.0 documentation

# DrawingSheet Class

class `NXOpen.Drawings.``DrawingSheet`

  Bases: `NXOpen.NXObject`

  Represents a drawing sheet.

  When you create a sheet using Add Child Rule in KF with the use_template option, you will need to set the option to either custom_size or standard_size afterwards. You also will need to set the scale, units, projection_angle, height, and length parameters, as these are not required when creating a sheet with a template. To create or edit an instance of this class, use `NXOpen.Drawings.DrawingSheetBuilder`

  New in version NX3.0.0.

# Properties

Property | Description
--- | ---
BordersAndZones | Returns or sets the borders and zones object if present
Height | Returns the height of the drawing sheet.
IsActiveForSketching | Returns true if this drawing sheet’s view is the active sketch view.
IsOccurrence | Returns whether this object is an occurrence or not.
IsOutOfDate | Returns the status on whether this `NXOpen.Drawings.DrawingSheet` is out of date.
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object.
Length | Returns the length of the drawing sheet.
Name | Returns the custom name of the object.
OwningComponent | Returns the owning component, if this object is an occurrence.
OwningPart | Returns the owning part of this object
ProjectionAngle | Returns the projection angle of the drawing sheet.
Prototype | Returns the prototype of this object if it is an occurrence.
Tag | Returns the Tag for this object.
Units | Returns the units of the drawing sheet.
View | Returns the `NXOpen.View` that represents this drawing sheet.
SheetDraftingViews | Returns the SheetDraftingViewCollection instance belonging to this drawing sheet
SheetSectionLines | Returns the SheetSectionLineCollection instance belonging to this drawing sheet

# Methods

Method | Description
--- | ---
ActivateForSketching | Sets this drawingsheet’s view as the active sketch view.
CreateAttributeIterator | Create an attribute iterator
DeleteAllAttributesByType | Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title.
DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes | Deletes the attributes on the object, if any, that satisfy the given iterator
FindObject | Finds the `NXOpen.NXObject` with the given identifier as recorded in a journal.
GetAttributeTitlesByType | Gets all the attribute titles of a specific type.
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index.
GetDraftingViews | Returns the :py:class:`NXOpen.Drawings.DraftingView`s on a sheet.
GetIntegerAttribute | Gets an integer attribute by title.
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index.
GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given object.
GetRealAttribute | Gets a real attribute by title.
GetRealUserAttribute | Gets a real attribute by Title and array Index.
GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetScale | Returns the scale of the drawing sheet.
GetSheetZoneReference | Returns the sheet and zone location or reference of the view if sheet zones are defined.
GetStringAttribute | Gets a string attribute value by title.
GetStringUserAttribute | Gets a string attribute by Title and array Index.
GetTimeAttribute | Gets a time attribute by title.
GetTimeUserAttribute | Gets a time attribute by Title and array Index.
GetUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount | Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock | Determine the lock of the given attribute.
GetUserAttributeSize | Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects | Returns an array of objects from which this object presents attributes.
GetUserAttributes | Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object.
GetZoneReference | Returns the zone location or reference of the view if sheet zones are defined.
HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator
Open | Displays and activates the drawing sheet so that it can be edited.
Print | Prints a representation of this object to the system log file.
ResetActiveForSketching | Resets active for sketching view in given drawing.
SetAttribute | Creates or modifies an integer attribute.
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not.
SetName | Sets the custom name of the object.
SetParameters | Sets the parameters of the drawing sheet.
SetPdmReferenceAttribute | Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string.
SetTimeAttribute | Creates or modifies a time attribute.
SetTimeUserAttribute | Creates or modifies a time attribute with the option to update or not.
SetUserAttribute | Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock | Lock or unlock the given attribute.

# Enumerations

DrawingSheetProjectionAngleType Enumeration | Specifies the projection angle of a drawing sheet.
DrawingSheetStandardSheetSize Enumeration | Standard Drawing sizes
DrawingSheetUnit Enumeration | Specifies the units of the drawing sheet.

# Property Detail

## BordersAndZones

`DrawingSheet.``BordersAndZones`

  Returns or sets the borders and zones object if present

  `-------------------------------------`

  Getter Method

  Signature `BordersAndZones`

  Returns: |
  Return type: | `NXOpen.Drawings.BordersAndZones`

  New in version NX8.0.0.

  License requirements: drafting (“DRAFTING”)

  `-------------------------------------`

  Setter Method

  Signature `BordersAndZones`

  Parameters: | bodersAndZones (`NXOpen.Drawings.BordersAndZones`) –

  New in version NX8.0.0.

  License requirements: drafting (“DRAFTING”)

## Height

`DrawingSheet.``Height`

  Returns the height of the drawing sheet.

  `-------------------------------------`

  Getter Method

  Signature `Height`

  Returns: |
  Return type: | float

  New in version NX3.0.0.

  License requirements: None.

## IsActiveForSketching

`DrawingSheet.``IsActiveForSketching`

  Returns true if this drawing sheet’s view is the active sketch view.

  `-------------------------------------`

  Getter Method

  Signature `IsActiveForSketching`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## IsOccurrence

`DrawingSheet.``IsOccurrence`

  Returns whether this object is an occurrence or not.

  `-------------------------------------`

  Getter Method

  Signature `IsOccurrence`

  Returns: | This object is an occurrence
  Return type: | bool

  New in version NX3.0.0.

  License requirements: None.

## IsOutOfDate

`DrawingSheet.``IsOutOfDate`

  Returns the status on whether this `NXOpen.Drawings.DrawingSheet` is out of date.

  `-------------------------------------`

  Getter Method

  Signature `IsOutOfDate`

  Returns: |
  Return type: | bool

  New in version NX3.0.0.

  License requirements: None.

## JournalIdentifier

`DrawingSheet.``JournalIdentifier`

  Returns the identifier that would be recorded in a journal for this object.

  This may not be the same across different releases of the software.

  `-------------------------------------`

  Getter Method

  Signature `JournalIdentifier`

  Returns: |
  Return type: | str

  New in version NX3.0.0.

  License requirements: None.

## Length

`DrawingSheet.``Length`

  Returns the length of the drawing sheet.

  `-------------------------------------`

  Getter Method

  Signature `Length`

  Returns: |
  Return type: | float

  New in version NX3.0.0.

  License requirements: None.

## Name

`DrawingSheet.``Name`

  Returns the custom name of the object.

  `-------------------------------------`

  Getter Method

  Signature `Name`

  Returns: |
  Return type: | str

  New in version NX3.0.0.

  License requirements: None.

## OwningComponent

`DrawingSheet.``OwningComponent`

  Returns the owning component, if this object is an occurrence.

  `-------------------------------------`

  Getter Method

  Signature `OwningComponent`

  Returns: |
  Return type: | `NXOpen.Assemblies.Component`

  New in version NX3.0.0.

  License requirements: None.

## OwningPart

`DrawingSheet.``OwningPart`

  Returns the owning part of this object

  `-------------------------------------`

  Getter Method

  Signature `OwningPart`

  Returns: | The owning part of this object or null if it does not have an owner
  Return type: | `NXOpen.BasePart`

  New in version NX3.0.0.

  License requirements: None.

## ProjectionAngle

`DrawingSheet.``ProjectionAngle`

  Returns the projection angle of the drawing sheet.

  `-------------------------------------`

  Getter Method

  Signature `ProjectionAngle`

  Returns: |
  Return type: | `NXOpen.Drawings.DrawingSheetProjectionAngleType`

  New in version NX3.0.0.

  License requirements: None.

## Prototype

`DrawingSheet.``Prototype`

  Returns the prototype of this object if it is an occurrence.

  `-------------------------------------`

  Getter Method

  Signature `Prototype`

  Returns: | The prototype of this object or null if this object is not an occurrence
  Return type: | `NXOpen.INXObject`

  New in version NX3.0.0.

  License requirements: None.

## Units

`DrawingSheet.``Units`

  Returns the units of the drawing sheet.

  To change the units of drawing sheet, use `NXOpen.Drawings.DrawingSheet.SetParameters()`

  `-------------------------------------`

  Getter Method

  Signature `Units`

  Returns: |
  Return type: | `NXOpen.Drawings.DrawingSheetUnit`

  New in version NX3.0.0.

  License requirements: None.

## View

`DrawingSheet.``View`

  Returns the `NXOpen.View` that represents this drawing sheet.

  `-------------------------------------`

  Getter Method

  Signature `View`

  Returns: |
  Return type: | `NXOpen.View`

  New in version NX3.0.0.

  License requirements: None.

## SheetDraftingViews

`DrawingSheet.``SheetDraftingViews`

  Returns the SheetDraftingViewCollection instance belonging to this drawing sheet

  Signature `SheetDraftingViews`

  New in version NX5.0.0.

  Returns: |
  Return type: | `NXOpen.Drawings.SheetDraftingViewCollection`

## SheetSectionLines

`DrawingSheet.``SheetSectionLines`

  Returns the SheetSectionLineCollection instance belonging to this drawing sheet

  Signature `SheetSectionLines`

  New in version NX6.0.0.

  Returns: |
  Return type: | `NXOpen.Drawings.SheetSectionLineCollection`

# Method Detail

## ActivateForSketching

`DrawingSheet.``ActivateForSketching`

  Sets this drawingsheet’s view as the active sketch view.

  Note: Can only activate a drawing sheet view for an active drawing sheet

  Signature `ActivateForSketching()`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## FindObject

`DrawingSheet.``FindObject`

  Finds the `NXOpen.NXObject` 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) – Journal identifier of the object
  Returns: |
  Return type: | `NXOpen.INXObject`

  New in version NX3.0.0.

  License requirements: None.

## GetDraftingViews

`DrawingSheet.``GetDraftingViews`

  Returns the :py:class:`NXOpen.Drawings.DraftingView`s on a sheet.

  Signature `GetDraftingViews()`

  Returns: |
  Return type: | list of `NXOpen.Drawings.DraftingView`

  New in version NX3.0.0.

  License requirements: None.

## GetScale

`DrawingSheet.``GetScale`

  Returns the scale of the drawing sheet.

  The scale of views that are defined by an expression, will not modified by this method.

  Signature `GetScale()`

  Returns: | a tuple
  Return type: | A tuple consisting of (numerator, denominator) numerator is a float. denominator is a float.

  New in version NX3.0.0.

  License requirements: None.

## GetSheetZoneReference

`DrawingSheet.``GetSheetZoneReference`

  Returns the sheet and zone location or reference of the view if sheet zones are defined.

  Signature `GetSheetZoneReference(viewTag)`

  Parameters: | viewTag (`NXOpen.Drawings.DraftingView`) –
  Returns: |
  Return type: | str

  New in version NX8.0.0.

  License requirements: drafting (“DRAFTING”)

## GetZoneReference

`DrawingSheet.``GetZoneReference`

  Returns the zone location or reference of the view if sheet zones are defined.

  Signature `GetZoneReference(viewTag)`

  Parameters: | viewTag (`NXOpen.Drawings.DraftingView`) –
  Returns: |
  Return type: | str

  New in version NX8.0.0.

  License requirements: drafting (“DRAFTING”)

## Open

`DrawingSheet.``Open`

  Displays and activates the drawing sheet so that it can be edited.

  Signature `Open()`

  New in version NX3.0.0.

  License requirements: None.

## Print

`DrawingSheet.``Print`

  Prints a representation of this object to the system log file.

  Signature `Print()`

  New in version NX3.0.0.

  License requirements: None.

## ResetActiveForSketching

`DrawingSheet.``ResetActiveForSketching`

  Resets active for sketching view in given drawing.

  Signature `ResetActiveForSketching()`

  New in version NX12.0.0.

  License requirements: drafting (“DRAFTING”)

## SetName

`DrawingSheet.``SetName`

  Sets the custom name of the object.

  NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

  Signature `SetName(name)`

  Parameters: | name (str) –

  New in version NX3.0.0.

  License requirements: None.

## SetParameters

`DrawingSheet.``SetParameters`

  Sets the parameters of the drawing sheet.

  The scale of those :py:class:`NXOpen.Drawings.DraftingView`s that are defined by an expression, will not modified by this method. Currently this method only works for drawings that are opened.

  Signature `SetParameters(height, length, numerator, denominator, units, projectionAngle)`

  Parameters:

  - height (float) –
  - length (float) –
  - numerator (float) –
  - denominator (float) –
  - units (`NXOpen.Drawings.DrawingSheetUnit`) –
  - projectionAngle (`NXOpen.Drawings.DrawingSheetProjectionAngleType`) –

  Returns: | List of Drafting Views that did not have their scale modified

  due to being defined by an expression. :rtype: list of `NXOpen.Drawings.DraftingView`

  New in version NX3.0.0.

  License requirements: drafting (“DRAFTING”)