VisualDrawingComparePrefsBuilder Class¶
-
class
NXOpen.Drawings.
VisualDrawingComparePrefsBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
This class gets and sets components of Visual Overlay in Drafting Preferences.
New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
CompareMethodType | Returns or sets the compare method type |
OverlayColor | Returns or sets the overlay color |
OverlayDataToUse | Returns or sets the overlay data to use |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
VisualDrawingComparePrefsBuilderVisualDrawingComparePrefsMethodType Enumeration | Compare Method Type This indicate various options of Compare Method. |
VisualDrawingComparePrefsBuilderVisualDrawingComparePrefsOverlayDataToUse Enumeration | Overlay Data To Use This indicate various options that can be used before Overlaying |
Property Detail¶
CompareMethodType¶
-
VisualDrawingComparePrefsBuilder.
CompareMethodType
¶ Returns or sets the compare method type
-------------------------------------
Getter Method
Signature
CompareMethodType
Returns: Return type: NXOpen.Drawings.VisualDrawingComparePrefsBuilderVisualDrawingComparePrefsMethodType
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CompareMethodType
Parameters: compareMethodType ( NXOpen.Drawings.VisualDrawingComparePrefsBuilderVisualDrawingComparePrefsMethodType
) –New in version NX11.0.0.
License requirements: drafting (“DRAFTING”)
OverlayColor¶
-
VisualDrawingComparePrefsBuilder.
OverlayColor
¶ Returns or sets the overlay color
-------------------------------------
Getter Method
Signature
OverlayColor
Returns: Return type: Id New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OverlayColor
Parameters: overlayColor (Id) – New in version NX11.0.0.
License requirements: drafting (“DRAFTING”)
OverlayDataToUse¶
-
VisualDrawingComparePrefsBuilder.
OverlayDataToUse
¶ Returns or sets the overlay data to use
-------------------------------------
Getter Method
Signature
OverlayDataToUse
Returns: Return type: NXOpen.Drawings.VisualDrawingComparePrefsBuilderVisualDrawingComparePrefsOverlayDataToUse
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OverlayDataToUse
Parameters: overlayDataToUse ( NXOpen.Drawings.VisualDrawingComparePrefsBuilderVisualDrawingComparePrefsOverlayDataToUse
) –New in version NX11.0.0.
License requirements: drafting (“DRAFTING”)
Method Detail¶
Validate¶
-
VisualDrawingComparePrefsBuilder.
Validate
¶ 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.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.