NXOpen .NET Reference  12.0.0
Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.Drawings.DrawingSheetCollection Class Reference

Represents a collection of drawing sheets. More...

Inheritance diagram for NXOpen.Drawings.DrawingSheetCollection:

Public Member Functions

NXOpen.Drawings.DrawingSheet[] ToArray ()
 Returns an array of NXOpen.Drawings.DrawingSheet objects. More...
 
unsafe NXOpen.Drawings.DrawingSheet InsertSheet (string 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. More...
 
unsafe NXOpen.Drawings.DrawingSheet InsertSheet (string drawingName, NXOpen.Drawings.DrawingSheet.StandardSheetSize sheetSize, double numerator, double denominator, NXOpen.Drawings.DrawingSheet.ProjectionAngleType projectionAngle)
 Inserts a sheet into a part. More...
 
unsafe NXOpen.Drawings.DrawingSheet FindObject (string journalIdentifier)
 Finds the NXOpen.Drawings.DrawingSheet with the given identifier as recorded in a journal. More...
 
unsafe
NXOpen.Drawings.DrawingSheetBuilder 
DrawingSheetBuilder (NXOpen.Drawings.DrawingSheet sheet)
 Create a drawing Sheet builder More...
 
unsafe void RefreshCurrentSheet ()
 Refresh the current Sheet More...
 

Protected Member Functions

override int EnumerateMoveNext (ref Tag currentTag, byte[] state)
 Advances the enumerator to the next element of the collection. More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 
NXOpen.Drawings.SheetTemplateManager SheetTemplates [get]
 Returns the Sheet Template Manager for part More...
 
unsafe NXOpen.Drawings.DrawingSheet CurrentDrawingSheet [get]
 Returns the currently opened drawing sheet. More...
 

Detailed Description

Represents a collection of drawing sheets.

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

Created in NX3.0.0

Member Function Documentation

unsafe NXOpen.Drawings.DrawingSheetBuilder NXOpen.Drawings.DrawingSheetCollection.DrawingSheetBuilder ( NXOpen.Drawings.DrawingSheet  sheet)

Create a drawing Sheet builder

Created in NX5.0.0

Deprecated in NX12.0.0. Use NXOpen.Drawings.DraftingDrawingSheetCollection.CreateDraftingDrawingSheetBuilder instead.

License requirements: drafting ("DRAFTING")

Parameters
sheetthe drawing sheet
Returns
the drawing sheet Builder with this identifier
override int NXOpen.Drawings.DrawingSheetCollection.EnumerateMoveNext ( ref Tag  currentTag,
byte[]  state 
)
protected

Advances the enumerator to the next element of the collection.

unsafe NXOpen.Drawings.DrawingSheet NXOpen.Drawings.DrawingSheetCollection.FindObject ( string  journalIdentifier)

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.

Created in NX3.0.0

Deprecated in NX12.0.0. Use NXOpen.Drawings.DraftingDrawingSheetCollection.FindObject instead.

License requirements: drafting ("DRAFTING")

Parameters
journalIdentifierIdentifier of the drawing sheet you want
Returns
Drawing sheet with this identifier
unsafe NXOpen.Drawings.DrawingSheet NXOpen.Drawings.DrawingSheetCollection.InsertSheet ( string  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.

Created in NX3.0.0

Deprecated in NX12.0.0. Use NXOpen.Drawings.DraftingDrawingSheetCollection.InsertSheet instead.

License requirements: drafting ("DRAFTING")

Parameters
drawingNameDrawing name
drawingUnitsUnit of sheet size
widthWidth of drawing
heightHeight of drawing
numeratorNumerator of the scale of drawing
denominatorDenominator of the scale of drawing
projectionAngleProjection angle
Returns
unsafe NXOpen.Drawings.DrawingSheet NXOpen.Drawings.DrawingSheetCollection.InsertSheet ( string  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.

Created in NX3.0.0

Deprecated in NX12.0.0. Use NXOpen.Drawings.DraftingDrawingSheetCollection.InsertSheet instead.

License requirements: drafting ("DRAFTING")

Parameters
drawingNameDrawing name
sheetSizeSheet Size
numeratorNumerator of the scale of drawing
denominatorDenominator of the scale of drawing
projectionAngleProjection angle
Returns
unsafe void NXOpen.Drawings.DrawingSheetCollection.RefreshCurrentSheet ( )

Refresh the current Sheet

Created in NX9.0.0

License requirements: drafting ("DRAFTING")

NXOpen.Drawings.DrawingSheet [] NXOpen.Drawings.DrawingSheetCollection.ToArray ( )

Returns an array of NXOpen.Drawings.DrawingSheet objects.

Property Documentation

unsafe NXOpen.Drawings.DrawingSheet NXOpen.Drawings.DrawingSheetCollection.CurrentDrawingSheet
get

Returns the currently opened drawing sheet.

This will return a null reference (Nothing in Visual Basic) if no drawing sheet is opened.

Created in NX3.0.0

License requirements: drafting ("DRAFTING")

NXOpen.Drawings.SheetTemplateManager NXOpen.Drawings.DrawingSheetCollection.SheetTemplates
get

Returns the Sheet Template Manager for part

Created in NX3.0.0

Tag NXOpen.Drawings.DrawingSheetCollection.Tag
get

Returns the tag of this object.


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