AutomationPreferencesBuilder Class¶
-
class
NXOpen.Drafting.
AutomationPreferencesBuilder
¶ Bases:
NXOpen.Builder
the builder for Drafting Automation Preferences
To create a new instance of this class, use
NXOpen.Drafting.AutomationManager.CreatePreferencesBuilder()
New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
AllowFeetInchFractionForDimensionGreaterThan | Returns or sets the determination of the feet inch fraction display for dimension greater than |
AllowInchFractionToNearest | Returns or sets the determination of the display for inch fraction to nearest |
AnnotationInsideGeometry | Returns or sets the annotation inside geometry |
DisplayRegion | Returns or sets the display in non template |
DisplayRegionLabel | Returns or sets the display region label |
DistanceBetweenAnnotations | Returns or sets the distance between annotations |
EqualDimensionCompareTolerance | Returns or sets the equal dimension compare tolerance |
FeetInchFractionForDimensionGreaterThan | Returns or sets the feet inch fraction for dimension greater than |
HideFeetInchMark | Returns or sets the hide feet inch mark |
InchFractionToNearest | Returns or sets the inch fraction to nearest |
MaximumDistanceToGeometry | Returns or sets the maximum distance to geometry |
MinimumDistanceToGeometry | Returns or sets the minimum distance to geometry |
ReferenceGeometrySearchDistance | Returns or sets the reference geometry search distance |
RegionColor | Returns or sets the region color |
RegionFont | Returns or sets the region font |
RegionWidth | Returns or sets the region width |
SecondaryContentHiddenLineColor | Returns or sets the secondary content hidden line color |
SecondaryContentHiddenLineFont | Returns or sets the secondary content hidden line font |
SecondaryContentHiddenLineWidth | Returns or sets the secondary content hidden line width |
SecondaryContentVisibleLineColor | Returns or sets the secondary content visible line color |
SecondaryContentVisibleLineFont | Returns or sets the secondary content visible line font |
SecondaryContentVisibleLineWidth | Returns or sets the secondary content visible line width |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
GetRulesList | Get the ordered rules list |
SetRulesList | Set the ordered rules list |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
AllowFeetInchFractionForDimensionGreaterThan¶
-
AutomationPreferencesBuilder.
AllowFeetInchFractionForDimensionGreaterThan
¶ Returns or sets the determination of the feet inch fraction display for dimension greater than
-------------------------------------
Getter Method
Signature
AllowFeetInchFractionForDimensionGreaterThan
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AllowFeetInchFractionForDimensionGreaterThan
Parameters: allowFeetInchFractionForDimensionGreaterThan (bool) – New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
AllowInchFractionToNearest¶
-
AutomationPreferencesBuilder.
AllowInchFractionToNearest
¶ Returns or sets the determination of the display for inch fraction to nearest
-------------------------------------
Getter Method
Signature
AllowInchFractionToNearest
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AllowInchFractionToNearest
Parameters: allowInchFractionToNearest (bool) – New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
AnnotationInsideGeometry¶
-
AutomationPreferencesBuilder.
AnnotationInsideGeometry
¶ Returns or sets the annotation inside geometry
-------------------------------------
Getter Method
Signature
AnnotationInsideGeometry
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AnnotationInsideGeometry
Parameters: annotationInsideGeometry (bool) – New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
DisplayRegion¶
-
AutomationPreferencesBuilder.
DisplayRegion
¶ Returns or sets the display in non template
-------------------------------------
Getter Method
Signature
DisplayRegion
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplayRegion
Parameters: displayRegion (bool) – New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
DisplayRegionLabel¶
-
AutomationPreferencesBuilder.
DisplayRegionLabel
¶ Returns or sets the display region label
-------------------------------------
Getter Method
Signature
DisplayRegionLabel
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplayRegionLabel
Parameters: displayRegionLabel (bool) – New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
DistanceBetweenAnnotations¶
-
AutomationPreferencesBuilder.
DistanceBetweenAnnotations
¶ Returns or sets the distance between annotations
-------------------------------------
Getter Method
Signature
DistanceBetweenAnnotations
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DistanceBetweenAnnotations
Parameters: distanceBetweenAnnotations (float) – New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
EqualDimensionCompareTolerance¶
-
AutomationPreferencesBuilder.
EqualDimensionCompareTolerance
¶ Returns or sets the equal dimension compare tolerance
-------------------------------------
Getter Method
Signature
EqualDimensionCompareTolerance
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EqualDimensionCompareTolerance
Parameters: equalDimensionCompareTolerance (float) – New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
FeetInchFractionForDimensionGreaterThan¶
-
AutomationPreferencesBuilder.
FeetInchFractionForDimensionGreaterThan
¶ Returns or sets the feet inch fraction for dimension greater than
-------------------------------------
Getter Method
Signature
FeetInchFractionForDimensionGreaterThan
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FeetInchFractionForDimensionGreaterThan
Parameters: feetInchFractionForDimensionGreaterThan (float) – New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
HideFeetInchMark¶
-
AutomationPreferencesBuilder.
HideFeetInchMark
¶ Returns or sets the hide feet inch mark
-------------------------------------
Getter Method
Signature
HideFeetInchMark
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HideFeetInchMark
Parameters: hideFeetInchMark (bool) – New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
InchFractionToNearest¶
-
AutomationPreferencesBuilder.
InchFractionToNearest
¶ Returns or sets the inch fraction to nearest
-------------------------------------
Getter Method
Signature
InchFractionToNearest
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InchFractionToNearest
Parameters: inchFractionToNearest (float) – New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
MaximumDistanceToGeometry¶
-
AutomationPreferencesBuilder.
MaximumDistanceToGeometry
¶ Returns or sets the maximum distance to geometry
-------------------------------------
Getter Method
Signature
MaximumDistanceToGeometry
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaximumDistanceToGeometry
Parameters: maximumDistanceToGeometry (float) – New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
MinimumDistanceToGeometry¶
-
AutomationPreferencesBuilder.
MinimumDistanceToGeometry
¶ Returns or sets the minimum distance to geometry
-------------------------------------
Getter Method
Signature
MinimumDistanceToGeometry
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MinimumDistanceToGeometry
Parameters: minimumDistanceToGeometry (float) – New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
ReferenceGeometrySearchDistance¶
-
AutomationPreferencesBuilder.
ReferenceGeometrySearchDistance
¶ Returns or sets the reference geometry search distance
-------------------------------------
Getter Method
Signature
ReferenceGeometrySearchDistance
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReferenceGeometrySearchDistance
Parameters: referenceGeometrySearchDistance (float) – New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
RegionColor¶
-
AutomationPreferencesBuilder.
RegionColor
¶ Returns or sets the region color
-------------------------------------
Getter Method
Signature
RegionColor
Returns: Return type: Id New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RegionColor
Parameters: regionColor (Id) – New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
RegionFont¶
-
AutomationPreferencesBuilder.
RegionFont
¶ Returns or sets the region font
-------------------------------------
Getter Method
Signature
RegionFont
Returns: Return type: NXOpen.Preferences.PartDraftingFontType
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RegionFont
Parameters: regionFont ( NXOpen.Preferences.PartDraftingFontType
) –New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
RegionWidth¶
-
AutomationPreferencesBuilder.
RegionWidth
¶ Returns or sets the region width
-------------------------------------
Getter Method
Signature
RegionWidth
Returns: Return type: NXOpen.Preferences.PartDraftingWidthType
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RegionWidth
Parameters: regionWidth ( NXOpen.Preferences.PartDraftingWidthType
) –New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
SecondaryContentVisibleLineColor¶
-
AutomationPreferencesBuilder.
SecondaryContentVisibleLineColor
¶ Returns or sets the secondary content visible line color
-------------------------------------
Getter Method
Signature
SecondaryContentVisibleLineColor
Returns: Return type: Id New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SecondaryContentVisibleLineColor
Parameters: secondaryContentVisibleLineColor (Id) – New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
SecondaryContentVisibleLineFont¶
-
AutomationPreferencesBuilder.
SecondaryContentVisibleLineFont
¶ Returns or sets the secondary content visible line font
-------------------------------------
Getter Method
Signature
SecondaryContentVisibleLineFont
Returns: Return type: NXOpen.Preferences.PartDraftingFontType
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SecondaryContentVisibleLineFont
Parameters: secondaryContentVisibleLineFont ( NXOpen.Preferences.PartDraftingFontType
) –New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
SecondaryContentVisibleLineWidth¶
-
AutomationPreferencesBuilder.
SecondaryContentVisibleLineWidth
¶ Returns or sets the secondary content visible line width
-------------------------------------
Getter Method
Signature
SecondaryContentVisibleLineWidth
Returns: Return type: NXOpen.Preferences.PartDraftingWidthType
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SecondaryContentVisibleLineWidth
Parameters: secondaryContentVisibleLineWidth ( NXOpen.Preferences.PartDraftingWidthType
) –New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
Method Detail¶
GetRulesList¶
-
AutomationPreferencesBuilder.
GetRulesList
¶ Get the ordered rules list
Signature
GetRulesList()
Returns: Rules list Return type: list of str New in version NX8.0.0.
License requirements: None.
SetRulesList¶
-
AutomationPreferencesBuilder.
SetRulesList
¶ Set the ordered rules list
Signature
SetRulesList(rules)
Parameters: rules (list of str) – Rules list New in version NX8.0.0.
License requirements: nx_drawing_auto (“NX Drawing Automation”)
Validate¶
-
AutomationPreferencesBuilder.
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.