NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Drawings::DrawingSheet Class Reference

Represents a drawing sheet. More...

Inheritance diagram for NXOpen::Drawings::DrawingSheet:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject

List of all members.

Public Types

enum  ProjectionAngleType { ProjectionAngleTypeFirstAngle = 1, ProjectionAngleTypeThirdAngle }
 Specifies the projection angle of a drawing sheet. More...
enum  StandardSheetSize {
  StandardSheetSizeA, StandardSheetSizeB, StandardSheetSizeC, StandardSheetSizeD,
  StandardSheetSizeE, StandardSheetSizeF, StandardSheetSizeH, StandardSheetSizeJ,
  StandardSheetSizeA0, StandardSheetSizeA1, StandardSheetSizeA2, StandardSheetSizeA3,
  StandardSheetSizeA4
}
 Standard Drawing sizes. More...
enum  Unit { UnitInches = 1, UnitMillimeters }
 Specifies the units of the drawing sheet. More...

Public Member Functions

void ActivateForSketching ()
 Sets this drawingsheet's view as the active sketch view.
NXOpen::Drawings::BordersAndZonesBordersAndZones ()
 Returns the borders and zones object if present
Created in NX8.0.0.
std::vector
< NXOpen::Drawings::DraftingView * > 
GetDraftingViews ()
 Returns the Drawings::DraftingView s on a sheet.
void GetScale (double *numerator, double *denominator)
 Returns the scale of the drawing sheet.
NXString GetSheetZoneReference (NXOpen::Drawings::DraftingView *viewTag)
 Returns the sheet and zone location or reference of the view if sheet zones are defined.
NXString GetZoneReference (NXOpen::Drawings::DraftingView *viewTag)
 Returns the zone location or reference of the view if sheet zones are defined.
double Height ()
 Returns the height of the drawing sheet.
bool IsActiveForSketching ()
 Returns true if this drawing sheet's view is the active sketch view.
bool IsOutOfDate ()
 Returns the status on whether this Drawings::DrawingSheet is out of date.
double Length ()
 Returns the length of the drawing sheet.
void Open ()
 Displays and activates the drawing sheet so that it can be edited.
NXOpen::Drawings::DrawingSheet::ProjectionAngleType ProjectionAngle ()
 Returns the projection angle of the drawing sheet.
void SetBordersAndZones (NXOpen::Drawings::BordersAndZones *bodersAndZones)
 Sets the borders and zones object if present
Created in NX8.0.0.
void SetParameters (double height, double length, double numerator, double denominator, NXOpen::Drawings::DrawingSheet::Unit units, NXOpen::Drawings::DrawingSheet::ProjectionAngleType projectionAngle, std::vector< NXOpen::Drawings::DraftingView * > &associatedViews)
 Sets the parameters of the drawing sheet.
NXOpen::Drawings::SheetDraftingViewCollectionSheetDraftingViews ()
 Returns the SheetDraftingViewCollection instance belonging to this drawing sheet
Created in NX5.0.0.
NXOpen::Drawings::SheetSectionLineCollectionSheetSectionLines ()
 Returns the SheetSectionLineCollection instance belonging to this drawing sheet
Created in NX6.0.0.
NXOpen::Drawings::DrawingSheet::Unit Units ()
 Returns the units of the drawing sheet.
NXOpen::ViewView ()
 Returns the View that represents this drawing sheet.

Detailed Description

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.
Created in NX3.0.0.


Member Enumeration Documentation

Specifies the projection angle of a drawing sheet.

All projected views and sections will then comply with the projection angle. Imported model views however, are not affected by projection angle.

Enumerator:
ProjectionAngleTypeThirdAngle 

third angle

Standard Drawing sizes.

Enumerator:
StandardSheetSizeA 

8.5 x 11 inches

StandardSheetSizeB 

11 X 17 inches

StandardSheetSizeC 

17 X 22 inches

StandardSheetSizeD 

22 X 34 inches

StandardSheetSizeE 

34 X 44 inches

StandardSheetSizeF 

28 X 40 inches

StandardSheetSizeH 

28 X 44 inches

StandardSheetSizeJ 

34 X 55 inches

StandardSheetSizeA0 

841 x 1189 millimeters

StandardSheetSizeA1 

594 X 841 millimeters

StandardSheetSizeA2 

420 X 594 millimeters

StandardSheetSizeA3 

297 X 420 millimeters

StandardSheetSizeA4 

210 X 297 millimeters

Specifies the units of the drawing sheet.

Enumerator:
UnitMillimeters 

millimeters


Member Function Documentation

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

Note: Can only activate a drawing sheet view for an active drawing sheet
Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

Returns the borders and zones object if present
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Returns the Drawings::DraftingView s on a sheet.

Returns:

Created in NX3.0.0.

License requirements : None
void NXOpen::Drawings::DrawingSheet::GetScale ( double *  numerator,
double *  denominator 
)

Returns the scale of the drawing sheet.

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

License requirements : None

Parameters:
numeratornumerator
denominatordenominator

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

Returns:

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")
Parameters:
viewTagviewtag

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

Returns:

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")
Parameters:
viewTagviewtag

Returns the height of the drawing sheet.


Created in NX3.0.0.

License requirements : None

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


Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

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


Created in NX3.0.0.

License requirements : None

Returns the length of the drawing sheet.


Created in NX3.0.0.

License requirements : None

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


Created in NX3.0.0.

License requirements : None

Returns the projection angle of the drawing sheet.


Created in NX3.0.0.

License requirements : None

Sets the borders and zones object if present
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
bodersAndZonesbodersandzones
void NXOpen::Drawings::DrawingSheet::SetParameters ( double  height,
double  length,
double  numerator,
double  denominator,
NXOpen::Drawings::DrawingSheet::Unit  units,
NXOpen::Drawings::DrawingSheet::ProjectionAngleType  projectionAngle,
std::vector< NXOpen::Drawings::DraftingView * > &  associatedViews 
)

Sets the parameters of the drawing sheet.

The scale of those 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.
Created in NX3.0.0.

License requirements : drafting ("DRAFTING")

Parameters:
heightheight
lengthlength
numeratornumerator
denominatordenominator
unitsunits
projectionAngleprojection angle
associatedViewsList of Drafting Views that did not have their scale modified due to being defined by an expression.

Returns the SheetDraftingViewCollection instance belonging to this drawing sheet
Created in NX5.0.0.


Returns the SheetSectionLineCollection instance belonging to this drawing sheet
Created in NX6.0.0.


Returns the units of the drawing sheet.

To change the units of drawing sheet, use Drawings::DrawingSheet::SetParameters
Created in NX3.0.0.

License requirements : None

Returns the View that represents this drawing sheet.


Created in NX3.0.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.