Represents a drawing sheet. More...

Inheritance diagram for NXOpen.Drawings.DrawingSheet:

Public Types
enum	Unit { Inches = 1, Millimeters }
	Specifies the units of the drawing sheet. More...

enum	StandardSheetSize { A, B, C, D, E, F, H, J, A0, A1, A2, A3, A4 }
	Standard Drawing sizes More...

enum	ProjectionAngleType { FirstAngle = 1, ThirdAngle }
	Specifies the projection angle of a drawing sheet. More...

Public Types inherited from NXOpen.NXObject
enum	AttributeType { Invalid, Null, Boolean, Integer, Real, String, Time, Reference, Any = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { Numeric, Textual }
	Specifies the format of the date and time attribute. More...

Public Member Functions
unsafe void	Open ()
	Displays and activates the drawing sheet so that it can be edited. More...

unsafe NXOpen.Drawings.DraftingView[]	GetDraftingViews ()
	Returns the NXOpen.Drawings.DraftingView s on a sheet. More...

unsafe void	GetScale (out double numerator, out double denominator)
	Returns the scale of the drawing sheet. More...

unsafe void	SetParameters (double height, double length, double numerator, double denominator, NXOpen.Drawings.DrawingSheet.Unit units, NXOpen.Drawings.DrawingSheet.ProjectionAngleType projectionAngle, out NXOpen.Drawings.DraftingView[] associatedViews)
	Sets the parameters of the drawing sheet. More...

unsafe void	ActivateForSketching ()
	Sets this drawingsheet's view as the active sketch view. More...

unsafe void	ResetActiveForSketching ()
	Resets active for sketching view in given drawing. More...

unsafe string	GetZoneReference (NXOpen.Drawings.DraftingView viewTag)
	Returns the zone location or reference of the view if sheet zones are defined. More...

unsafe string	GetSheetZoneReference (NXOpen.Drawings.DraftingView viewTag)
	Returns the sheet and zone location or reference of the view if sheet zones are defined. More...

Public Member Functions inherited from NXOpen.NXObject
unsafe void	SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
	Creates or modifies an attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...

unsafe NXOpen.AttributeIterator	CreateAttributeIterator ()
	Create an attribute iterator More...

unsafe bool	HasUserAttribute (NXOpen.AttributeIterator iterator)
	Determines if an attribute exists on the object, that satisfies the given iterator More...

unsafe bool	HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
	Gets the count of set attributes on the object, if any, of the given type. More...

unsafe int	GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
	Gets the count of attributes on the object, if any, of the given type. More...

unsafe int	GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

unsafe bool	GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
	Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...

unsafe NXOpen.NXObject.AttributeInformation	GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...

unsafe bool	GetBooleanUserAttribute (string title, int index)
	Gets a boolean attribute by Title and array Index. More...

unsafe int	GetIntegerUserAttribute (string title, int index)
	Gets an integer attribute by Title and array Index. More...

unsafe double	GetRealUserAttribute (string title, int index)
	Gets a real attribute by Title and array Index. More...

unsafe string	GetStringUserAttribute (string title, int index)
	Gets a string attribute by Title and array Index. More...

unsafe string	GetTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe NXOpen.NXObject.ComputationalTime	GetComputationalTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (NXOpen.AttributeIterator iterator)
	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes ()
	Gets all the attributes that have been set on the given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...

unsafe string	GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...

unsafe void	DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator More...

unsafe void	DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
	Deletes the first attribute encountered with the given Type, Title. More...

unsafe void	DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
	Deletes the attributes encountered with the given Type with option to update or not. More...

unsafe void	SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
	Lock or unlock the given attribute. More...

unsafe bool	GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
	Determine the lock of the given attribute. More...

unsafe NXOpen.NXObject[]	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. More...

unsafe void	SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

unsafe string	GetPdmReferenceAttributeValue (string attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
	Deletes all attributes of a specific type. More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
	Deletes all attributes of a specific type with the option to update or not. More...

unsafe void	SetAttribute (string title, int value)
	Creates or modifies an integer attribute. More...

unsafe void	SetAttribute (string title, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetAttribute (string title, double value)
	Creates or modifies a real attribute. More...

unsafe void	SetAttribute (string title, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

unsafe void	SetAttribute (string title, string value)
	Creates or modifies a string attribute. More...

unsafe void	SetAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute with the option to update or not. More...

unsafe void	SetAttribute (string title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...

unsafe void	SetAttribute (string title, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetTimeAttribute (string title, string value)
	Creates or modifies a time attribute. More...

unsafe void	SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe int	GetIntegerAttribute (string title)
	Gets an integer attribute by title. More...

unsafe double	GetRealAttribute (string title)
	Gets a real attribute by title. More...

unsafe string	GetStringAttribute (string title)
	Gets a string attribute value by title. More...

unsafe string	GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
	Gets a time attribute by title. More...

unsafe string	GetReferenceAttribute (string title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
	Deletes an attribute by type and title. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
	Deletes an attribute by type and title with the option to update or not. More...

unsafe void	SetReferenceAttribute (string title, string value)
	Creates or modifies a string attribute which uses a reference string. More...

unsafe void	SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
	Gets all the attribute titles of a specific type. More...

unsafe string[]	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...

unsafe NXOpen.INXObject	FindObject (string journalIdentifier)
	Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...

unsafe void	Print ()
	Prints a representation of this object to the system log file. More...

unsafe void	SetName (string name)
	Sets the custom name of the object. More...

Properties
NXOpen.Drawings.SheetDraftingViewCollection	SheetDraftingViews `[get]`
	Returns the SheetDraftingViewCollection instance belonging to this drawing sheet More...

NXOpen.Drawings.SheetSectionLineCollection	SheetSectionLines `[get]`
	Returns the SheetSectionLineCollection instance belonging to this drawing sheet More...

unsafe NXOpen.Drawings.BordersAndZones	BordersAndZones `[get, set]`
	Returns or sets the borders and zones object if present More...

unsafe double	Height `[get]`
	Returns the height of the drawing sheet. More...

unsafe bool	IsActiveForSketching `[get]`
	Returns true if this drawing sheet's view is the active sketch view. More...

unsafe bool	IsOutOfDate `[get]`
	Returns the status on whether this NXOpen.Drawings.DrawingSheet is out of date. More...

unsafe double	Length `[get]`
	Returns the length of the drawing sheet. More...

unsafe NXOpen.Drawings.DrawingSheet.ProjectionAngleType	ProjectionAngle `[get]`
	Returns the projection angle of the drawing sheet. More...

unsafe NXOpen.Drawings.DrawingSheet.Unit	Units `[get]`
	Returns the units of the drawing sheet. More...

unsafe NXOpen.View	View `[get]`
	Returns the NXOpen.View that represents this drawing sheet. More...

Properties inherited from NXOpen.NXObject
unsafe bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

unsafe string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

unsafe string	Name `[get]`
	Returns the custom name of the object. More...

unsafe NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

unsafe NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

unsafe NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. More...

Properties inherited from NXOpen.INXObject
bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

string	Name `[get]`
	Returns the custom name of the object. More...

NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. More...

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.

To create or edit an instance of this class, use NXOpen.Drawings.DrawingSheetBuilder

Created in NX3.0.0

Member Enumeration Documentation

enum NXOpen.Drawings.DrawingSheet.ProjectionAngleType

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
FirstAngle
ThirdAngle

enum NXOpen.Drawings.DrawingSheet.StandardSheetSize

Standard Drawing sizes

Enumerator
A	8.5 x 11 inches
B	11 X 17 inches
C	17 X 22 inches
D	22 X 34 inches
E	34 X 44 inches
F	28 X 40 inches
H	28 X 44 inches
J	34 X 55 inches
A0	841 x 1189 millimeters
A1	594 X 841 millimeters
A2	420 X 594 millimeters
A3	297 X 420 millimeters
A4	210 X 297 millimeters

enum NXOpen.Drawings.DrawingSheet.Unit

Specifies the units of the drawing sheet.

Enumerator
Inches
Millimeters

Member Function Documentation

unsafe void NXOpen.Drawings.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

Created in NX6.0.0

License requirements: drafting ("DRAFTING")

unsafe NXOpen.Drawings.DraftingView [] NXOpen.Drawings.DrawingSheet.GetDraftingViews ( )

Returns the NXOpen.Drawings.DraftingView s on a sheet.

Created in NX3.0.0

License requirements: None.

Returns

unsafe void NXOpen.Drawings.DrawingSheet.GetScale	(	out double	numerator,
		out 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

numerator
denominator

unsafe string NXOpen.Drawings.DrawingSheet.GetSheetZoneReference ( NXOpen.Drawings.DraftingView viewTag )

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

Created in NX8.0.0

License requirements: drafting ("DRAFTING")

Parameters

viewTag

Returns

unsafe string NXOpen.Drawings.DrawingSheet.GetZoneReference ( NXOpen.Drawings.DraftingView viewTag )

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

Created in NX8.0.0

License requirements: drafting ("DRAFTING")

Parameters

viewTag

Returns

unsafe void NXOpen.Drawings.DrawingSheet.Open ( )

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

Created in NX3.0.0

License requirements: None.

unsafe void NXOpen.Drawings.DrawingSheet.ResetActiveForSketching ( )

Resets active for sketching view in given drawing.

Created in NX12.0.0

License requirements: drafting ("DRAFTING")

unsafe void NXOpen.Drawings.DrawingSheet.SetParameters	(	double	height,
		double	length,
		double	numerator,
		double	denominator,
		NXOpen.Drawings.DrawingSheet.Unit	units,
		NXOpen.Drawings.DrawingSheet.ProjectionAngleType	projectionAngle,
		out NXOpen.Drawings.DraftingView[]	associatedViews
	)

Sets the parameters of the drawing sheet.

The scale of those 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.

Created in NX3.0.0

License requirements: drafting ("DRAFTING")

Parameters

height
length
numerator
denominator
units
projectionAngle
associatedViews	List of Drafting Views that did not have their scale modified due to being defined by an expression.

Property Documentation

unsafe NXOpen.Drawings.BordersAndZones NXOpen.Drawings.DrawingSheet.BordersAndZones

getset

Returns or sets the borders and zones object if present

Created in NX8.0.0

License requirements to get this property: drafting ("DRAFTING")

License requirements to set this property: drafting ("DRAFTING")

unsafe double NXOpen.Drawings.DrawingSheet.Height

get

Returns the height of the drawing sheet.

Created in NX3.0.0

License requirements: None.

unsafe bool NXOpen.Drawings.DrawingSheet.IsActiveForSketching

get

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

Created in NX6.0.0

License requirements: drafting ("DRAFTING")

unsafe bool NXOpen.Drawings.DrawingSheet.IsOutOfDate

get

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

Created in NX3.0.0

License requirements: None.

unsafe double NXOpen.Drawings.DrawingSheet.Length

get

Returns the length of the drawing sheet.

Created in NX3.0.0

License requirements: None.

unsafe NXOpen.Drawings.DrawingSheet.ProjectionAngleType NXOpen.Drawings.DrawingSheet.ProjectionAngle

get

Returns the projection angle of the drawing sheet.

Created in NX3.0.0

License requirements: None.

NXOpen.Drawings.SheetDraftingViewCollection NXOpen.Drawings.DrawingSheet.SheetDraftingViews

get

Returns the SheetDraftingViewCollection instance belonging to this drawing sheet

Created in NX5.0.0

NXOpen.Drawings.SheetSectionLineCollection NXOpen.Drawings.DrawingSheet.SheetSectionLines

get

Returns the SheetSectionLineCollection instance belonging to this drawing sheet

Created in NX6.0.0

unsafe NXOpen.Drawings.DrawingSheet.Unit NXOpen.Drawings.DrawingSheet.Units

get

Returns the units of the drawing sheet.

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

Created in NX3.0.0

License requirements: None.

unsafe NXOpen.View NXOpen.Drawings.DrawingSheet.View

get

Returns the NXOpen.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:

dotnet_pool/Drawings_DrawingSheet.cs

Public Types

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation