Represents a drawing sheet. More...

Inheritance diagram for NXOpen::Drawings::DrawingSheet:

Public Types
enum	ProjectionAngleType { ProjectionAngleTypeFirstAngle = 1, ProjectionAngleTypeThirdAngle }
	指定绘图板的投影角. More...

enum	StandardSheetSize { StandardSheetSizeA, StandardSheetSizeB, StandardSheetSizeC, StandardSheetSizeD, StandardSheetSizeE, StandardSheetSizeF, StandardSheetSizeH, StandardSheetSizeJ, StandardSheetSizeA0, StandardSheetSizeA1, StandardSheetSizeA2, StandardSheetSizeA3, StandardSheetSizeA4 }
	标准图纸尺寸 . More...

enum	Unit { UnitInches = 1, UnitMillimeters }
	指定图纸的单位. More...

Public Types inherited from NXOpen::NXObject
enum	AttributeType { AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger, AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference, AttributeTypeAny = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
	Specifies the format of the date and time attribute. More...

Public Member Functions
void	ActivateForSketching ()
	将此图表的视图设置为活动示意图视图 .

NXOpen::Drawings::BordersAndZones *	BordersAndZones ()
	如果存在返回边框和区域对象 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)
	返回绘图表的刻度.

NXString	GetSheetZoneReference (NXOpen::Drawings::DraftingView *viewTag)
	如果定义了表区域，则返回视图的表和区域位置或引用.

NXString	GetZoneReference (NXOpen::Drawings::DraftingView *viewTag)
	如果定义了表区域，则返回视图的区域位置或引用.

double	Height ()
	返回图纸的高度

bool	IsActiveForSketching ()
	如果该图纸的视图是活动的视图，则返回true.

bool	IsOutOfDate ()
	返回此日期是否过期的状态.

double	Length ()
	返回视图的长度.

void	Open ()
	显示并激活视图，以便编辑它

NXOpen::Drawings::DrawingSheet::ProjectionAngleType	ProjectionAngle ()
	返回视图的投影角度.

void	SetBordersAndZones (NXOpen::Drawings::BordersAndZones *bodersAndZones)
	如果存在，则设置边框和区域对象 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)
	设置视图的参数.

NXOpen::Drawings::SheetDraftingViewCollection *	SheetDraftingViews ()
	Returns the SheetDraftingViewCollection 属于此绘图表的实例 Created in NX5.0.0.

NXOpen::Drawings::SheetSectionLineCollection *	SheetSectionLines ()
	Returns the SheetSectionLineCollection 属于此绘图表的实例 Created in NX6.0.0.

NXOpen::Drawings::DrawingSheet::Unit	Units ()
	返回视图的单位.

NXOpen::View *	View ()
	Returns the View that represents this drawing sheet.

Public Member Functions inherited from NXOpen::NXObject
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type.

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

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
	Deletes an attribute by type and title.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
	Deletes an attribute by type and title.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not.

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title and Index.

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title and Index.

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

virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

std::vector < NXOpen::NXObject::AttributeInformation >	GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
	Gets all the attribute titles of a specific type.

bool	GetBooleanUserAttribute (const NXString &title, int index)
	Gets a boolean attribute by Title and array Index.

bool	GetBooleanUserAttribute (const char *title, int index)
	Gets a boolean attribute by Title and array Index.

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.

int	GetIntegerAttribute (const NXString &title)
	Gets an integer attribute by title.

int	GetIntegerAttribute (const char *title)
	Gets an integer attribute by title.

int	GetIntegerUserAttribute (const NXString &title, int index)
	Gets an integer attribute by Title and array Index.

int	GetIntegerUserAttribute (const char *title, int index)
	Gets an integer attribute by Title and array Index.

double	GetRealAttribute (const NXString &title)
	Gets a real attribute by title.

double	GetRealAttribute (const char *title)
	Gets a real attribute by title.

double	GetRealUserAttribute (const NXString &title, int index)
	Gets a real attribute by Title and array Index.

double	GetRealUserAttribute (const char *title, int index)
	Gets a real attribute by Title and array Index.

NXString	GetReferenceAttribute (const NXString &title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

NXString	GetReferenceAttribute (const char *title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

NXString	GetStringAttribute (const NXString &title)
	Gets a string attribute value by title.

NXString	GetStringAttribute (const char *title)
	Gets a string attribute value by title.

NXString	GetStringUserAttribute (const NXString &title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetStringUserAttribute (const char *title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
	Gets a time attribute by title.

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
	Gets a time attribute by title.

NXString	GetTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.

NXString	GetTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const NXString &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.

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const char *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.

NXString	GetUserAttributeAsString (const NXString &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.

NXString	GetUserAttributeAsString (const char *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.

bool	GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.

bool	GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes ()
	Gets all the attributes that have been set on the given object.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes that have been set on the given object.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes that have been set on the given object.

std::vector< NXString >	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object.

std::vector< NXOpen::NXObject * >	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes.

bool	HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

bool	HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

virtual bool	IsOccurrence ()
	Returns whether this object is an occurrence or not.

virtual NXString	JournalIdentifier ()
	Returns the identifier that would be recorded in a journal for this object.

virtual NXString	Name ()
	Returns the custom name of the object.

virtual NXOpen::Assemblies::Component *	OwningComponent ()
	Returns the owning component, if this object is an occurrence.

virtual NXOpen::BasePart *	OwningPart ()
	Returns the owning part of this object Created in NX3.0.0.

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

virtual NXOpen::INXObject *	Prototype ()
	Returns the prototype of this object if it is an occurrence.

void	SetAttribute (const NXString &title, int value)
	Creates or modifies an integer attribute.

void	SetAttribute (const char *title, int value)
	Creates or modifies an integer attribute.

void	SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetAttribute (const char *title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetAttribute (const NXString &title, double value)
	Creates or modifies a real attribute.

void	SetAttribute (const char *title, double value)
	Creates or modifies a real attribute.

void	SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetAttribute (const char *title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute.

void	SetAttribute (const char title, const char value)
	Creates or modifies a string attribute.

void	SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

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

void	SetAttribute (const NXString &title)
	Creates or modifies a null attribute which is an attribute with a title and no value.

void	SetAttribute (const char *title)
	Creates or modifies a null attribute which is an attribute with a title and no value.

void	SetAttribute (const NXString &title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetAttribute (const char *title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not.

void	SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not.

virtual void	SetName (const NXString &name)
	Sets the custom name of the object.

void	SetName (const char *name)
	Sets the custom name of the object.

void	SetReferenceAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute which uses a reference string.

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

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

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

void	SetTimeAttribute (const NXString &title, const NXString &value)
	Creates or modifies a time attribute.

void	SetTimeAttribute (const char title, const char value)
	Creates or modifies a time attribute.

void	SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

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

void	SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
	Creates or modifies an attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

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

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

void	SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

void	SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Public Member Functions inherited from NXOpen::INXObject
NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

void	SetName (const char *name)
	Sets the custom name of the object.

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 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:

ProjectionAngleTypeThirdAngle

third angle

enum NXOpen::Drawings::DrawingSheet::StandardSheetSize

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

enum NXOpen::Drawings::DrawingSheet::Unit

Specifies the units of the drawing sheet.

Enumerator:

UnitMillimeters

millimeters

Member Function Documentation

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")

NXOpen::Drawings::BordersAndZones* NXOpen::Drawings::DrawingSheet::BordersAndZones ( )

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

License requirements : drafting ("DRAFTING")

std::vector<NXOpen::Drawings::DraftingView *> NXOpen::Drawings::DrawingSheet::GetDraftingViews ( )

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

numerator	numerator
denominator	denominator

NXString NXOpen::Drawings::DrawingSheet::GetSheetZoneReference ( NXOpen::Drawings::DraftingView * viewTag )

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

viewTag viewtag

NXString NXOpen::Drawings::DrawingSheet::GetZoneReference ( NXOpen::Drawings::DraftingView * viewTag )

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

viewTag viewtag

double NXOpen::Drawings::DrawingSheet::Height ( )

Returns the height of the drawing sheet.

Created in NX3.0.0.

License requirements : None

bool NXOpen::Drawings::DrawingSheet::IsActiveForSketching ( )

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

Created in NX6.0.0.

License requirements : drafting ("DRAFTING")

bool NXOpen::Drawings::DrawingSheet::IsOutOfDate ( )

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

Created in NX3.0.0.

License requirements : None

double NXOpen::Drawings::DrawingSheet::Length ( )

Returns the length of the drawing sheet.

Created in NX3.0.0.

License requirements : None

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

NXOpen::Drawings::DrawingSheet::ProjectionAngleType NXOpen::Drawings::DrawingSheet::ProjectionAngle ( )

Returns the projection angle of the drawing sheet.

Created in NX3.0.0.

License requirements : None

void NXOpen::Drawings::DrawingSheet::SetBordersAndZones ( NXOpen::Drawings::BordersAndZones * bodersAndZones )

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

License requirements : drafting ("DRAFTING")

Parameters

bodersAndZones bodersandzones

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

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

NXOpen::Drawings::SheetDraftingViewCollection* NXOpen::Drawings::DrawingSheet::SheetDraftingViews ( )

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

NXOpen::Drawings::SheetSectionLineCollection* NXOpen::Drawings::DrawingSheet::SheetSectionLines ( )

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

NXOpen::Drawings::DrawingSheet::Unit NXOpen::Drawings::DrawingSheet::Units ( )

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

NXOpen::View* NXOpen::Drawings::DrawingSheet::View ( )

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:

Drawings_DrawingSheet.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation