SheetZoneSettingsBuilder Class¶
-
class
NXOpen.Drawings.
SheetZoneSettingsBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents the Drawing Sheet Zone Setting Style Builder.
New in version NX10.0.0.
Properties¶
Property | Description |
---|---|
ContinueZoneIndexingAcrossSheets | Returns or sets the continue zone indexing across sheets |
CornerZoneModification | Returns or sets the corner zone modification |
CreateZoneLabels | Returns or sets the create zone labels |
CreateZoneMarkings | Returns or sets the create zone markings |
CreateZones | Returns or sets the create zones |
HorizontalSize | Returns or sets the horizontal size |
LabelColor | Returns or sets the labels color |
LabelFont | Returns or sets the labels font |
LabelHeight | Returns or sets the label height |
LabelItalicized | Returns or sets the labels font style |
LabelWidth | Returns or sets the labels width |
LabelsToSkip | Returns or sets the labels to skip |
MarkingHeight | Returns or sets the marking height |
MarkingLineColorWidth | Returns the marking line color width |
Origin | Returns or sets the origin |
Tag | Returns the Tag for this object. |
VerticalSize | Returns or sets the vertical size |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
ContinueZoneIndexingAcrossSheets¶
-
SheetZoneSettingsBuilder.
ContinueZoneIndexingAcrossSheets
¶ Returns or sets the continue zone indexing across sheets
-------------------------------------
Getter Method
Signature
ContinueZoneIndexingAcrossSheets()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ContinueZoneIndexingAcrossSheets(continueZoneIndexingAcrossSheets)
Parameters: continueZoneIndexingAcrossSheets (bool) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
CornerZoneModification¶
-
SheetZoneSettingsBuilder.
CornerZoneModification
¶ Returns or sets the corner zone modification
-------------------------------------
Getter Method
Signature
CornerZoneModification()
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CornerZoneModification(cornerZoneModification)
Parameters: cornerZoneModification (float) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
CreateZoneLabels¶
-
SheetZoneSettingsBuilder.
CreateZoneLabels
¶ Returns or sets the create zone labels
-------------------------------------
Getter Method
Signature
CreateZoneLabels()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateZoneLabels(createZoneLabels)
Parameters: createZoneLabels (bool) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
CreateZoneMarkings¶
-
SheetZoneSettingsBuilder.
CreateZoneMarkings
¶ Returns or sets the create zone markings
-------------------------------------
Getter Method
Signature
CreateZoneMarkings()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateZoneMarkings(createZoneMarkings)
Parameters: createZoneMarkings (bool) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
CreateZones¶
-
SheetZoneSettingsBuilder.
CreateZones
¶ Returns or sets the create zones
-------------------------------------
Getter Method
Signature
CreateZones()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateZones(createZones)
Parameters: createZones (bool) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
HorizontalSize¶
-
SheetZoneSettingsBuilder.
HorizontalSize
¶ Returns or sets the horizontal size
-------------------------------------
Getter Method
Signature
HorizontalSize()
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HorizontalSize(horizontalSize)
Parameters: horizontalSize (float) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
LabelColor¶
-
SheetZoneSettingsBuilder.
LabelColor
¶ Returns or sets the labels color
-------------------------------------
Getter Method
Signature
LabelColor()
Returns: Return type: int New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LabelColor(labelColor)
Parameters: labelColor (int) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
LabelFont¶
-
SheetZoneSettingsBuilder.
LabelFont
¶ Returns or sets the labels font
-------------------------------------
Getter Method
Signature
LabelFont()
Returns: Return type: int New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LabelFont(labelFont)
Parameters: labelFont (int) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
LabelHeight¶
-
SheetZoneSettingsBuilder.
LabelHeight
¶ Returns or sets the label height
-------------------------------------
Getter Method
Signature
LabelHeight()
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LabelHeight(labelHeight)
Parameters: labelHeight (float) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
LabelItalicized¶
-
SheetZoneSettingsBuilder.
LabelItalicized
¶ Returns or sets the labels font style
-------------------------------------
Getter Method
Signature
LabelItalicized()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LabelItalicized(italic)
Parameters: italic (bool) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
LabelWidth¶
-
SheetZoneSettingsBuilder.
LabelWidth
¶ Returns or sets the labels width
-------------------------------------
Getter Method
Signature
LabelWidth()
Returns: Return type: int New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LabelWidth(labelWidth)
Parameters: labelWidth (int) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
LabelsToSkip¶
-
SheetZoneSettingsBuilder.
LabelsToSkip
¶ Returns or sets the labels to skip
-------------------------------------
Getter Method
Signature
LabelsToSkip()
Returns: Return type: str New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LabelsToSkip(labelsToSkip)
Parameters: labelsToSkip (str) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
MarkingHeight¶
-
SheetZoneSettingsBuilder.
MarkingHeight
¶ Returns or sets the marking height
-------------------------------------
Getter Method
Signature
MarkingHeight()
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MarkingHeight(markingHeight)
Parameters: markingHeight (float) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
MarkingLineColorWidth¶
-
SheetZoneSettingsBuilder.
MarkingLineColorWidth
¶ Returns the marking line color width
-------------------------------------
Getter Method
Signature
MarkingLineColorWidth()
Returns: Return type: NXOpen.LineColorFontWidthBuilder
New in version NX10.0.0.
License requirements: None.
Origin¶
-
SheetZoneSettingsBuilder.
Origin
¶ Returns or sets the origin
-------------------------------------
Getter Method
Signature
Origin()
Returns: Return type: NXOpen.Drawings.ZoneOrigin
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Origin(origin)
Parameters: origin ( NXOpen.Drawings.ZoneOrigin
) –New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
VerticalSize¶
-
SheetZoneSettingsBuilder.
VerticalSize
¶ Returns or sets the vertical size
-------------------------------------
Getter Method
Signature
VerticalSize()
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
VerticalSize(verticalSize)
Parameters: verticalSize (float) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
Method Detail¶
Validate¶
-
SheetZoneSettingsBuilder.
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.