NXOpen.Drawings.VisualDrawingComparePrefsBuilder Class Reference

This class gets and sets components of Visual Overlay in Drafting Preferences. More...

Inheritance diagram for NXOpen.Drawings.VisualDrawingComparePrefsBuilder:

Public Types
enum	VisualDrawingComparePrefsMethodType { AgainstAnotherDrawing, AgainstOverlayDatainActiveDrawing }
	Compare Method Type This indicate various options of Compare Method. More...
enum	VisualDrawingComparePrefsOverlayDataToUse { AskatRuntime, AlwaysUseExistingData, AlwaysCreateNewData, CreateNewDataifNoneExists }
	Overlay Data To Use This indicate various options that can be used before Overlaying 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.Drawings.VisualDrawingComparePrefsBuilder.VisualDrawingComparePrefsMethodType	CompareMethodType [get, set]
	Returns or sets the compare method type More...
unsafe NXOpen.NXColor	OverlayColor [get, set]
	Returns or sets the overlay color More...
unsafe NXOpen.Drawings.VisualDrawingComparePrefsBuilder.VisualDrawingComparePrefsOverlayDataToUse	OverlayDataToUse [get, set]
	Returns or sets the overlay data to use 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

This class gets and sets components of Visual Overlay in Drafting Preferences.

Created in NX11.0.0

Member Enumeration Documentation

enum NXOpen.Drawings.VisualDrawingComparePrefsBuilder.VisualDrawingComparePrefsMethodType

Compare Method Type This indicate various options of Compare Method.

Enumerator
AgainstAnotherDrawing	This option is used to overlay different part over current part
AgainstOverlayDatainActiveDrawing	This option is used to overlay current part on itself

enum NXOpen.Drawings.VisualDrawingComparePrefsBuilder.VisualDrawingComparePrefsOverlayDataToUse

Overlay Data To Use This indicate various options that can be used before Overlaying

Enumerator
AskatRuntime	This option tells to show messages at rumtime
AlwaysUseExistingData	This option will use existing data to overlay
AlwaysCreateNewData	This option will always create new data
CreateNewDataifNoneExists	This option will create new data if none exists

Member Function Documentation

unsafe bool NXOpen.Drawings.VisualDrawingComparePrefsBuilder.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.Drawings.VisualDrawingComparePrefsBuilder.VisualDrawingComparePrefsMethodType NXOpen.Drawings.VisualDrawingComparePrefsBuilder.CompareMethodType

getset

Returns or sets the compare method type

Created in NX11.0.0

License requirements to get this property: None.

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

unsafe NXOpen.NXColor NXOpen.Drawings.VisualDrawingComparePrefsBuilder.OverlayColor

getset

Returns or sets the overlay color

Created in NX11.0.0

License requirements to get this property: None.

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

unsafe NXOpen.Drawings.VisualDrawingComparePrefsBuilder.VisualDrawingComparePrefsOverlayDataToUse NXOpen.Drawings.VisualDrawingComparePrefsBuilder.OverlayDataToUse

getset

Returns or sets the overlay data to use

Created in NX11.0.0

License requirements to get this property: None.

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

---

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

• Drawings_VisualDrawingComparePrefsBuilder.cs