ViewStyleDetailBuilder Class¶
-
class
NXOpen.Drawings.
ViewStyleDetailBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents the DETAIL tab on the View Style Dialog (Drawings.
ViewStyleDetailBuilder)
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
Align | Returns or sets the align toggle on the DETAIL tab of the View Style Dialog |
Circular | Returns or sets the circular toggle on the DETAIL tab of the View Style Dialog |
CreateIndependentDetailView | Returns or sets the create independent detail view toggle on the DETAIL tab of the View Style Dialog |
Offset | Returns or sets the offset toggle on the DETAIL tab of the View Style Dialog |
Orient | Returns or sets the orient toggle on the DETAIL tab of the View Style Dialog |
Scale | Returns or sets the scale toggle on the DETAIL tab of the View Style Dialog |
Sheet | Returns or sets the sheet toggle on the DETAIL tab of the View Style Dialog |
Tag | Returns the Tag for this object. |
ViewBoundaryColor | Returns or sets the view boundary color on the DETAIL tab of the View Style Dialog |
ViewBoundaryFont | Returns or sets the view boundary font on the DETAIL tab of the View Style Dialog |
ViewBoundaryWidth | Returns or sets the view boundary width on the DETAIL tab of the View Style Dialog |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
Align¶
-
ViewStyleDetailBuilder.
Align
¶ Returns or sets the align toggle on the DETAIL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
Align()
Returns: Returns the align toggle value that is on the detail sub-builder Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Align(alignToggle)
Parameters: alignToggle (bool) – Sets a new align toggle value on the detail sub-builder New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
Circular¶
-
ViewStyleDetailBuilder.
Circular
¶ Returns or sets the circular toggle on the DETAIL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
Circular()
Returns: Returns the circular toggle value that is on the detail sub-builder Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Circular(circularToggle)
Parameters: circularToggle (bool) – Sets a new circular toggle value on the detail sub-builder New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
CreateIndependentDetailView¶
-
ViewStyleDetailBuilder.
CreateIndependentDetailView
¶ Returns or sets the create independent detail view toggle on the DETAIL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
CreateIndependentDetailView()
Returns: Returns the create independent detail view toggle value that is on the detail sub-builder Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateIndependentDetailView(createIndependentDetailViewToggle)
Parameters: createIndependentDetailViewToggle (bool) – Sets a create independent detail view toggle value on the detail sub-builder New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
Offset¶
-
ViewStyleDetailBuilder.
Offset
¶ Returns or sets the offset toggle on the DETAIL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
Offset()
Returns: Returns the offset toggle value that is on the detail sub-builder Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Offset(offsetToggle)
Parameters: offsetToggle (bool) – Sets a new offset toggle value on the detail sub-builder New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
Orient¶
-
ViewStyleDetailBuilder.
Orient
¶ Returns or sets the orient toggle on the DETAIL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
Orient()
Returns: Returns the orient toggle value that is on the detail sub-builder Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Orient(orientToggle)
Parameters: orientToggle (bool) – Sets a new orient toggle value on the detail sub-builder New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
Scale¶
-
ViewStyleDetailBuilder.
Scale
¶ Returns or sets the scale toggle on the DETAIL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
Scale()
Returns: Returns the scale toggle value that is on the detail sub-builder Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Scale(scaleToggle)
Parameters: scaleToggle (bool) – Sets a new scale toggle value on the detail sub-builder New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
Sheet¶
-
ViewStyleDetailBuilder.
Sheet
¶ Returns or sets the sheet toggle on the DETAIL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
Sheet()
Returns: Returns the sheet toggle value that is on the detail sub-builder Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Sheet(sheetToggle)
Parameters: sheetToggle (bool) – Sets a new sheet toggle value on the detail sub-builder New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
ViewBoundaryColor¶
-
ViewStyleDetailBuilder.
ViewBoundaryColor
¶ Returns or sets the view boundary color on the DETAIL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
ViewBoundaryColor()
Returns: Returns boundary color that is on the detail sub-builder Return type: Id New in version NX6.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
ViewBoundaryColor(color)
Parameters: color (Id) – Sets the boundary color on the detail sub-builder New in version NX6.0.2.
License requirements: drafting (“DRAFTING”)
ViewBoundaryFont¶
-
ViewStyleDetailBuilder.
ViewBoundaryFont
¶ Returns or sets the view boundary font on the DETAIL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
ViewBoundaryFont()
Returns: Returns boundary font that is on the detail sub-builder Return type: NXOpen.Preferences.Font
New in version NX6.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
ViewBoundaryFont(font)
Parameters: font ( NXOpen.Preferences.Font
) – Sets the boundary font on the detail sub-builderNew in version NX6.0.2.
License requirements: drafting (“DRAFTING”)
ViewBoundaryWidth¶
-
ViewStyleDetailBuilder.
ViewBoundaryWidth
¶ Returns or sets the view boundary width on the DETAIL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
ViewBoundaryWidth()
Returns: Returns boundary width that is on the detail sub-builder Return type: NXOpen.Preferences.Width
New in version NX6.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
ViewBoundaryWidth(width)
Parameters: width ( NXOpen.Preferences.Width
) – Sets the boundary width on the detail sub-builderNew in version NX6.0.2.
License requirements: drafting (“DRAFTING”)
Method Detail¶
Validate¶
-
ViewStyleDetailBuilder.
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.