ViewStyleGeneralBuilder Class¶
-
class
NXOpen.Drawings.
ViewStyleGeneralBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents view style general builder (Drawings.
ViewStyleGeneralBuilder) which manages all the general * attributes which are necessary for all the views. * To obtain an instance of the class, we need to follow the steps: creat a new view, click the view style * button on the view dialog, edit the view style general tab.
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
AngleDecimalPointCharacter | Returns or sets the decimal point character to use for view angle display. |
AngleFormat | Returns or sets the format to use for view angle display. |
AnglePrecision | Returns or sets the precision to use for view angle display. |
AngleSetting | Returns the angle value on the GENERAL tab of the View Style Dialog |
AngleShowLeadingZeros | Returns or sets the status of leading zeros display in view angle. |
AngleShowTrailingZeros | Returns or sets the status of trailing zeros display in view angle. |
AngleValue | Returns or sets the angle value on the GENERAL tab of the View Style Dialog |
AutomaticAnchorPoint | Returns or sets the automatic anchor point toggle on the GENERAL tab of the View Style Dialog |
AutomaticUpdate | Returns or sets the automatic update toggle on the GENERAL tab of the View Style Dialog |
BoundaryStatus | Returns or sets the boundary status toggle on the GENERAL tab of the View Style Dialog |
Centerlines | Returns or sets the centerlines toggle on the GENERAL tab of the View Style Dialog |
DisplayId | Returns or sets the display identifier option on the GENERAL tab of the View Style Dialog, it controls whether the orientation or the name of the view is displayed in the graphic window |
ExtractedEdges | Returns or sets the extracted edges option on the GENERAL tab of the View Style Dialog |
FramebarHorizontal | Returns or sets the horizontal framebar toggle on the GENERAL tab of the View Style Dialog |
FramebarVertical | Returns or sets the vertical framebar toggle on the GENERAL tab of the View Style Dialog |
LegacyView | Returns or sets the leagcy view toggle on the GENERAL tab of the View Style Dialog |
LightweightView | Returns or sets the view representation enum on the GENERAL tab of the View Style Dialog |
LockmethodView | Returns or sets the lock method setting on the Configuration tab of the View Style Dialog |
Reference | Returns or sets the reference toggle on the GENERAL tab of the View Style Dialog |
Scale | Returns the scale definition on the GENERAL tab of the View Style Dialog |
ScaleLabel | Returns or sets the scale label toggle on the GENERAL tab of the View Style Dialog |
Silhouettes | Returns or sets the silhouettes toggle on the GENERAL tab of the View Style Dialog |
SnapshotView | Returns or sets the snapshot toggle on the GENERAL tab of the View Style Dialog |
Tag | Returns the Tag for this object. |
Tolerance | Returns or sets the tolerance option on the GENERAL tab of the View Style Dialog |
ToleranceValue | Returns or sets the tolerance value on the GENERAL tab of the View Style Dialog |
UVGrid | Returns or sets the uvgrid toggle on the GENERAL tab of the View Style Dialog |
ViewLabel | Returns or sets the view label toggle on the GENERAL tab of the View Style Dialog |
ViewQuality | Returns or sets the view quality option on the GENERAL tab of the View Style Dialog |
ViewRepresentation | Returns or sets the view representation option on the GENERAL tab of the View Style Dialog |
WireframeColorSource | Returns or sets the wireframe color source option on the GENERAL tab of the View Style Dialog |
Methods¶
Method | Description |
---|---|
GetRenderSet | Gets the render sets on the GENERAL tab of the View Style Dialog |
SetRenderSet | Sets the render sets on the GENERAL tab of the View Style Dialog |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
AngleDecimalPointCharacter¶
-
ViewStyleGeneralBuilder.
AngleDecimalPointCharacter
¶ Returns or sets the decimal point character to use for view angle display.
-------------------------------------
Getter Method
Signature
AngleDecimalPointCharacter
Returns: Return type: NXOpen.Preferences.DecimalPointCharacter
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AngleDecimalPointCharacter
Parameters: decimalPointCharacter ( NXOpen.Preferences.DecimalPointCharacter
) –New in version NX8.5.0.
License requirements: drafting (“DRAFTING”)
AngleFormat¶
-
ViewStyleGeneralBuilder.
AngleFormat
¶ Returns or sets the format to use for view angle display.
-------------------------------------
Getter Method
Signature
AngleFormat
Returns: Return type: NXOpen.Preferences.AngleFormat
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AngleFormat
Parameters: angleFormat ( NXOpen.Preferences.AngleFormat
) –New in version NX8.5.0.
License requirements: drafting (“DRAFTING”)
AnglePrecision¶
-
ViewStyleGeneralBuilder.
AnglePrecision
¶ Returns or sets the precision to use for view angle display.
-------------------------------------
Getter Method
Signature
AnglePrecision
Returns: Return type: int New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AnglePrecision
Parameters: anglePrecision (int) – New in version NX8.5.0.
License requirements: drafting (“DRAFTING”)
AngleSetting¶
-
ViewStyleGeneralBuilder.
AngleSetting
¶ Returns the angle value on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
AngleSetting
Returns: Returns the angle value that is on the general sub-builder Return type: NXOpen.Drawings.AssociativeAngleBuilder
New in version NX11.0.0.
License requirements: None.
AngleShowLeadingZeros¶
-
ViewStyleGeneralBuilder.
AngleShowLeadingZeros
¶ Returns or sets the status of leading zeros display in view angle.
-------------------------------------
Getter Method
Signature
AngleShowLeadingZeros
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AngleShowLeadingZeros
Parameters: showLeadingZeros (bool) – New in version NX8.5.0.
License requirements: drafting (“DRAFTING”)
AngleShowTrailingZeros¶
-
ViewStyleGeneralBuilder.
AngleShowTrailingZeros
¶ Returns or sets the status of trailing zeros display in view angle.
-------------------------------------
Getter Method
Signature
AngleShowTrailingZeros
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AngleShowTrailingZeros
Parameters: showTrailingZeros (bool) – New in version NX8.5.0.
License requirements: drafting (“DRAFTING”)
AngleValue¶
-
ViewStyleGeneralBuilder.
AngleValue
¶ Returns or sets the angle value on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
AngleValue
Returns: Returns the angle value that is on the general sub-builder Return type: float New in version NX6.0.0.
Deprecated since version NX11.0.0: Use
NXOpen.Drawings.ViewStyleGeneralBuilder.AngleSetting()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
AngleValue
Parameters: angleValue (float) – Sets a new angle value on the general sub-builder New in version NX6.0.0.
Deprecated since version NX11.0.0: Use
NXOpen.Drawings.ViewStyleGeneralBuilder.AngleSetting()
instead.License requirements: drafting (“DRAFTING”)
AutomaticAnchorPoint¶
-
ViewStyleGeneralBuilder.
AutomaticAnchorPoint
¶ Returns or sets the automatic anchor point toggle on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
AutomaticAnchorPoint
Returns: Returns the automatic anchor point toggle value that is on the general sub-builder Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AutomaticAnchorPoint
Parameters: automaticAnchorPointToggle (bool) – Sets a new aautomatic anchor point toggle value on the general sub-builder New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
AutomaticUpdate¶
-
ViewStyleGeneralBuilder.
AutomaticUpdate
¶ Returns or sets the automatic update toggle on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
AutomaticUpdate
Returns: Returns the automatic update toggle value that is on the general sub-builder Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AutomaticUpdate
Parameters: automaticUpdateToggle (bool) – Sets a new automatic update toggle value on the general sub-builder New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
BoundaryStatus¶
-
ViewStyleGeneralBuilder.
BoundaryStatus
¶ Returns or sets the boundary status toggle on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
BoundaryStatus
Returns: Returns the boundary status toggle value that is on the general sub-builder Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BoundaryStatus
Parameters: boundaryStatusToggle (bool) – Sets a new boundary status toggle value on the general sub-builder New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
Centerlines¶
-
ViewStyleGeneralBuilder.
Centerlines
¶ Returns or sets the centerlines toggle on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
Centerlines
Returns: Returns the centerlines toggle value that is on the general sub-builder Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Centerlines
Parameters: centerlinesToggle (bool) – Sets a new centerlines toggle value on the general sub-builder New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
DisplayId¶
-
ViewStyleGeneralBuilder.
DisplayId
¶ Returns or sets the display identifier option on the GENERAL tab of the View Style Dialog, it controls whether the orientation or the name of the view is displayed in the graphic window
-------------------------------------
Getter Method
Signature
DisplayId
Returns: Returns the display id option that is on the general sub-builder Return type: NXOpen.Preferences.GeneralDisplayIdOption
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplayId
Parameters: option ( NXOpen.Preferences.GeneralDisplayIdOption
) – Sets a new display id option on the general sub-builderNew in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
ExtractedEdges¶
-
ViewStyleGeneralBuilder.
ExtractedEdges
¶ Returns or sets the extracted edges option on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
ExtractedEdges
Returns: Returns the extracted edges option that is on the general sub-builder Return type: NXOpen.Preferences.GeneralExtractedEdgesOption
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExtractedEdges
Parameters: extractedEdgesOption ( NXOpen.Preferences.GeneralExtractedEdgesOption
) – Sets a new extracted edges option on the general sub-builderNew in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
FramebarHorizontal¶
-
ViewStyleGeneralBuilder.
FramebarHorizontal
¶ Returns or sets the horizontal framebar toggle on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
FramebarHorizontal
Returns: Returns the horizontal framebar toggle value that is on the general sub-builder Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FramebarHorizontal
Parameters: framebarHorizontalToggle (bool) – Sets a new horizontal framebar toggle value on the general sub-builder New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
FramebarVertical¶
-
ViewStyleGeneralBuilder.
FramebarVertical
¶ Returns or sets the vertical framebar toggle on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
FramebarVertical
Returns: Returns the vertical framebar toggle value that is on the general sub-builder Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FramebarVertical
Parameters: framebarVerticalToggle (bool) – Sets a new vertical framebar toggle value on the general sub-builder New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
LegacyView¶
-
ViewStyleGeneralBuilder.
LegacyView
¶ Returns or sets the leagcy view toggle on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
LegacyView
Returns: Returns the legacy view toggle value that is on the general sub-builder Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LegacyView
Parameters: legacyView (bool) – Sets a legacy view toggle value on the general sub-builder New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
LightweightView¶
-
ViewStyleGeneralBuilder.
LightweightView
¶ Returns or sets the view representation enum on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
LightweightView
Returns: Returns the view representation option that is on the general sub-builder Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LightweightView
Parameters: lightweightView (bool) – Sets a view representation option on the general sub-builder New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
LockmethodView¶
-
ViewStyleGeneralBuilder.
LockmethodView
¶ Returns or sets the lock method setting on the Configuration tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
LockmethodView
Returns: Returns the lock method option on the general sub-builder Return type: NXOpen.Preferences.GeneralViewLockmethodOption
New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
LockmethodView
Parameters: lockMethodView ( NXOpen.Preferences.GeneralViewLockmethodOption
) – Sets a lock method option on the general sub-builderNew in version NX11.0.1.
License requirements: drafting (“DRAFTING”)
Reference¶
-
ViewStyleGeneralBuilder.
Reference
¶ Returns or sets the reference toggle on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
Reference
Returns: Returns the reference toggle value that is on the general sub-builder Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Reference
Parameters: referenceToggle (bool) – Sets a new reference toggle value on the general sub-builder New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
Scale¶
-
ViewStyleGeneralBuilder.
Scale
¶ Returns the scale definition on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
Scale
Returns: Returns the scale definition that is on the general sub-builder Return type: NXOpen.Drawings.ViewScaleBuilder
New in version NX6.0.0.
License requirements: None.
ScaleLabel¶
-
ViewStyleGeneralBuilder.
ScaleLabel
¶ Returns or sets the scale label toggle on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
ScaleLabel
Returns: Returns the scale label toggle value that is on the general sub-builder Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ScaleLabel
Parameters: scaleLabelToggle (bool) – Sets a new scale label toggle value on the general sub-builder New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
Silhouettes¶
-
ViewStyleGeneralBuilder.
Silhouettes
¶ Returns or sets the silhouettes toggle on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
Silhouettes
Returns: Returns the silhouettes toggle value that is on the general sub-builder Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Silhouettes
Parameters: silhouettesToggle (bool) – Sets a new silhouettes toggle value on the general sub-builder New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
SnapshotView¶
-
ViewStyleGeneralBuilder.
SnapshotView
¶ Returns or sets the snapshot toggle on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
SnapshotView
Returns: Returns the snapshot view toggle value that is on the general sub-builder Return type: bool New in version NX8.0.0.
Deprecated since version NX11.0.1: Use
NXOpen.Drawings.ViewStyleGeneralBuilder.LockmethodView()
instead(the value is NXOpen.Preferences.GeneralViewPreferences.GeneralViewLockmethodOptionSnapshot).License requirements: None.
-------------------------------------
Setter Method
Signature
SnapshotView
Parameters: snapshotView (bool) – Sets a snapshot view toggle value on the general sub-builder New in version NX8.0.0.
Deprecated since version NX11.0.1: Use
NXOpen.Drawings.ViewStyleGeneralBuilder.LockmethodView()
instead(the value is NXOpen.Preferences.GeneralViewPreferences.GeneralViewLockmethodOptionSnapshot).License requirements: drafting (“DRAFTING”)
Tolerance¶
-
ViewStyleGeneralBuilder.
Tolerance
¶ Returns or sets the tolerance option on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
Tolerance
Returns: Returns the tolerance option that is on the general sub-builder Return type: NXOpen.Preferences.GeneralToleranceOption
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Tolerance
Parameters: toleranceOption ( NXOpen.Preferences.GeneralToleranceOption
) – Sets a new tolerance option on the general sub-builderNew in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
ToleranceValue¶
-
ViewStyleGeneralBuilder.
ToleranceValue
¶ Returns or sets the tolerance value on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
ToleranceValue
Returns: Returns the tolerance value that is on the general sub-builder Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceValue
Parameters: toleranceValue (float) – Sets a new tolerance value on the general sub-builder New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
UVGrid¶
-
ViewStyleGeneralBuilder.
UVGrid
¶ Returns or sets the uvgrid toggle on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
UVGrid
Returns: Returns the uv-grid toggle value that is on the general sub-builder Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UVGrid
Parameters: uVGridToggle (bool) – Sets a new uv-grid toggle value on the general sub-builder New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
ViewLabel¶
-
ViewStyleGeneralBuilder.
ViewLabel
¶ Returns or sets the view label toggle on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
ViewLabel
Returns: Returns the view label toggle value that is on the general sub-builder Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ViewLabel
Parameters: viewLabelToggle (bool) – Sets a new view label toggle value on the general sub-builder New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
ViewQuality¶
-
ViewStyleGeneralBuilder.
ViewQuality
¶ Returns or sets the view quality option on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
ViewQuality
Returns: Returns the view quality option that is on the general sub-builder Return type: NXOpen.Preferences.GeneralViewQualityOption
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ViewQuality
Parameters: viewQualityOption ( NXOpen.Preferences.GeneralViewQualityOption
) – Sets a new view quality option on the general sub-builderNew in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
ViewRepresentation¶
-
ViewStyleGeneralBuilder.
ViewRepresentation
¶ Returns or sets the view representation option on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
ViewRepresentation
Returns: Returns the view representation option that is on the general sub-builder Return type: NXOpen.Preferences.GeneralViewRepresentationOption
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ViewRepresentation
Parameters: viewRepresentation ( NXOpen.Preferences.GeneralViewRepresentationOption
) – Sets a new view representation option on the general sub-builderNew in version NX8.5.0.
License requirements: drafting (“DRAFTING”)
WireframeColorSource¶
-
ViewStyleGeneralBuilder.
WireframeColorSource
¶ Returns or sets the wireframe color source option on the GENERAL tab of the View Style Dialog
-------------------------------------
Getter Method
Signature
WireframeColorSource
Returns: Returns the wireframe color source option that is on the general sub-builder Return type: NXOpen.Preferences.GeneralWireframeColorSourceOption
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
WireframeColorSource
Parameters: wireframeColorSourceOption ( NXOpen.Preferences.GeneralWireframeColorSourceOption
) – Sets a new wireframe color source option on the general sub-builderNew in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
Method Detail¶
GetRenderSet¶
-
ViewStyleGeneralBuilder.
GetRenderSet
¶ Gets the render sets on the GENERAL tab of the View Style Dialog
Signature
GetRenderSet()
Returns: Returns the render sets that are on the general sub-builder Return type: list of NXOpen.Drawings.RenderSet
New in version NX6.0.0.
License requirements: None.
SetRenderSet¶
-
ViewStyleGeneralBuilder.
SetRenderSet
¶ Sets the render sets on the GENERAL tab of the View Style Dialog
Signature
SetRenderSet(renderSets)
Parameters: renderSets (list of NXOpen.Drawings.RenderSet
) – Sets new render sets on the general sub-builderNew in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
Validate¶
-
ViewStyleGeneralBuilder.
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.