Represents a NXOpen. More...

Inheritance diagram for NXOpen.Annotations.PmiGeneralSetupDisplayBuilder:

Public Types
enum	AnnotationPlaneDisplayType { All, ActivePlaneOnly, None }
	the display values which determines whether or not Annotation planes will be displayed while creating and editing PMI. More...

enum	AnnotationPlaneType { XYPlaneofWCS, XZPlaneofWCS, YZPlaneofWCS, ModelViewPlane }
	the plane values which specify the annotation plane that will be used to display PMI. More...

enum	ResizeSettingsType { RelativetoSavedViewScale, RelativetoViewZoomFactor, Independently, RelativetoPartPreferences }
	the resize values which specify the method used to resize PMI. More...

Public Member Functions
unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.AnnotationPlaneType	AnnotationPlane `[get, set]`
	Returns or sets the annotation plane option which specifies the annotation plane that will be used to display PMI More...

unsafe int	AnnotationPlaneColor `[get, set]`
	Returns or sets the option specifies color of the Annotation Plane preview. More...

unsafe NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.AnnotationPlaneDisplayType	AnnotationPlaneDisplay `[get, set]`
	Returns or sets the option determines whether or not PMI should be displayed in all views on create More...

unsafe NXOpen.LineFontBuilder	AnnotationPlaneFont `[get]`
	Returns the option specifies line font for the Annotation Plane preview boundary line. More...

unsafe int	AnnotationPlaneTranslucency `[get, set]`
	Returns or sets the option specifies translucency of the Annotation Plane preview. More...

unsafe NXOpen.NXColor	BackgroundColor `[get, set]`
	Returns or sets the color of the PMI background. More...

unsafe bool	DisplayInAllViews `[get, set]`
	Returns or sets the display in all views option which determines whether or not PMI should be displayed in all views on create. More...

unsafe bool	DisplayPmiShadedModel `[get, set]`
	Returns or sets the display pmi shaded model toggle option which determines how a PMI is displayed in a shaded model. More...

unsafe bool	EnableBackground `[get, set]`
	Returns or sets the option which determines whether or not to display supported PMI with background enabled. More...

unsafe bool	EnableResize `[get, set]`
	Returns or sets the enable resize toggle option which determines whether the resize function for PMI is enabled. More...

unsafe bool	ProjectOntoPlane `[get, set]`
	Returns or sets the option to specifies project Annotation onto plane. More...

unsafe bool	ResizeOnCreate `[get, set]`
	Returns or sets the resize on create toggle option which determines whether the PMI are resized when they are created. More...

unsafe bool	ResizeOnViewSave `[get, set]`
	Returns or sets the resize on view save toggle option which determines whether the PMI are resized during a view save operation. More...

unsafe NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.ResizeSettingsType	ResizeSettings `[get, set]`
	Returns or sets the resize settings option specifies the method used to resize PMI. More...

unsafe bool	UpdateReadingDirection `[get, set]`
	Returns or sets the update reading direction toggle option which determines whether or not PMI text reading direction should be updated in response to view rotation. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Represents a NXOpen.

Annotations.PmiGeneralSetupDisplayBuilder

Created in NX1847.0.0

Member Enumeration Documentation

enum NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.AnnotationPlaneDisplayType

the display values which determines whether or not Annotation planes will be displayed while creating and editing PMI.

Enumerator
All	the display value which allow "All Annotation planes to be displayed"
ActivePlaneOnly	the display value which allow "Only Active Annotation plane to be displayed"
None	the display value which do not allow "Annotation plane to be displayed"

enum NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.AnnotationPlaneType

the plane values which specify the annotation plane that will be used to display PMI.

Enumerator
XYPlaneofWCS	the plane value which represents XY Plane of WCS type
XZPlaneofWCS	the plane value which represents XZ Plane of WCS type
YZPlaneofWCS	the plane value which represents YZ Plane of WCS type
ModelViewPlane	the plane value which represents Model View Plane type

enum NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.ResizeSettingsType

the resize values which specify the method used to resize PMI.

Enumerator
RelativetoSavedViewScale	the resize value which represents 'Settings Relative to Saved View Scale' type
RelativetoViewZoomFactor	the resize value which represents 'Settings Relative to View Zoom Factor' type
Independently	the resize value which represents 'Independent of Settings' type
RelativetoPartPreferences	the resize value which represents 'Settings Relative to Part Preferences' type

Member Function Documentation

unsafe bool NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.Validate ( )

inline

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Created in NX3.0.1

License requirements: None.

Returns: Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.AnnotationPlaneType NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.AnnotationPlane

getset

Returns or sets the annotation plane option which specifies the annotation plane that will be used to display PMI

Created in NX1847.0.0

License requirements to get this property: None.

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

unsafe int NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.AnnotationPlaneColor

getset

Returns or sets the option specifies color of the Annotation Plane preview.

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT")

unsafe NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.AnnotationPlaneDisplayType NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.AnnotationPlaneDisplay

getset

Returns or sets the option determines whether or not PMI should be displayed in all views on create

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT")

unsafe NXOpen.LineFontBuilder NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.AnnotationPlaneFont

get

Returns the option specifies line font for the Annotation Plane preview boundary line.

Created in NX1872.0.0

License requirements: None.

unsafe int NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.AnnotationPlaneTranslucency

getset

Returns or sets the option specifies translucency of the Annotation Plane preview.

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT")

unsafe NXOpen.NXColor NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.BackgroundColor

getset

Returns or sets the color of the PMI background.

Created in NX1872.0.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.DisplayInAllViews

getset

Returns or sets the display in all views option which determines whether or not PMI should be displayed in all views on create.

Created in NX1847.0.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.DisplayPmiShadedModel

getset

Returns or sets the display pmi shaded model toggle option which determines how a PMI is displayed in a shaded model.

When turned on, PMI will show through the shaded model.

Created in NX1847.0.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.EnableBackground

getset

Returns or sets the option which determines whether or not to display supported PMI with background enabled.

Created in NX1872.0.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.EnableResize

getset

Returns or sets the enable resize toggle option which determines whether the resize function for PMI is enabled.

Created in NX1847.0.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.ProjectOntoPlane

getset

Returns or sets the option to specifies project Annotation onto plane.

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT")

unsafe bool NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.ResizeOnCreate

getset

Returns or sets the resize on create toggle option which determines whether the PMI are resized when they are created.

Created in NX1847.0.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.ResizeOnViewSave

getset

Returns or sets the resize on view save toggle option which determines whether the PMI are resized during a view save operation.

Created in NX1847.0.0

License requirements to get this property: None.

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

unsafe NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.ResizeSettingsType NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.ResizeSettings

getset

Returns or sets the resize settings option specifies the method used to resize PMI.

Created in NX1847.0.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.UpdateReadingDirection

getset

Returns or sets the update reading direction toggle option which determines whether or not PMI text reading direction should be updated in response to view rotation.

Created in NX1847.0.0

License requirements to get this property: None.

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

The documentation for this class was generated from the following file:

Annotations_PmiGeneralSetupDisplayBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation