SheetZoneSettingsBuilder Class

class NXOpen.Diagramming.SheetZoneSettingsBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

The SheetZoneSettings builder

New in version NX11.0.1.

Properties

Property	Description
ContinueZoneIndexingAcrossSheets	Returns or sets the flag indicates whether the index for horizontal numeric zone labels will continue onto the next sheet or not.
CornerZoneModification	Returns or sets the corner zone modification used as determine the size of the corner zone.
CreateZoneLabels	Returns or sets the flag indicates to create zone labels or not.
CreateZoneMarkings	Returns or sets the flag indicates to create zone markings or not.
CreateZones	Returns or sets the flag indicates to create zones or not.
HorizontalSize	Returns or sets the size of the horizontal zone.
LabelColor	Returns or sets the color of the label(text).
LabelFont	Returns or sets the font of the label(text).
LabelHeight	Returns or sets the height of the label(text).
LabelItalicized	Returns or sets the flag indicates the label(text) is italic or not.
LabelWidth	Returns or sets the width of the label(text) like Regular, Bold.
LabelsToSkip	Returns or sets the characters to skip in label(text).
MarkingHeight	Returns or sets the height of the marking.
MarkingLineColorWidth	Returns the color and width of marking line.
Origin	Returns or sets the type of zone origin like TopLeft/BottomRight.
Tag	Returns the Tag for this object.
VerticalSize	Returns or sets the size of the vertical zone.

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 flag indicates whether the index for horizontal numeric zone labels will continue onto the next sheet or not.

-------------------------------------

Getter Method

Signature ContinueZoneIndexingAcrossSheets

Returns: Return type:bool

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature ContinueZoneIndexingAcrossSheets

Parameters:continueZoneIndexingAcrossSheets (bool) –

New in version NX11.0.1.

License requirements: None.

CornerZoneModification

SheetZoneSettingsBuilder.CornerZoneModification

Returns or sets the corner zone modification used as determine the size of the corner zone.

-------------------------------------

Getter Method

Signature CornerZoneModification

Returns: Return type:float

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature CornerZoneModification

Parameters:cornerZoneModification (float) –

New in version NX11.0.1.

License requirements: None.

CreateZoneLabels

SheetZoneSettingsBuilder.CreateZoneLabels

Returns or sets the flag indicates to create zone labels or not.

-------------------------------------

Getter Method

Signature CreateZoneLabels

Returns: Return type:bool

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature CreateZoneLabels

Parameters:createZoneLabels (bool) –

New in version NX11.0.1.

License requirements: None.

CreateZoneMarkings

SheetZoneSettingsBuilder.CreateZoneMarkings

Returns or sets the flag indicates to create zone markings or not.

-------------------------------------

Getter Method

Signature CreateZoneMarkings

Returns: Return type:bool

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature CreateZoneMarkings

Parameters:createZoneMarkings (bool) –

New in version NX11.0.1.

License requirements: None.

CreateZones

SheetZoneSettingsBuilder.CreateZones

Returns or sets the flag indicates to create zones or not.

-------------------------------------

Getter Method

Signature CreateZones

Returns: Return type:bool

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature CreateZones

Parameters:createZones (bool) –

New in version NX11.0.1.

License requirements: None.

HorizontalSize

SheetZoneSettingsBuilder.HorizontalSize

Returns or sets the size of the horizontal zone.

It must be greater than zero.

-------------------------------------

Getter Method

Signature HorizontalSize

Returns: Return type:float

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature HorizontalSize

Parameters:horizontalSize (float) –

New in version NX11.0.1.

License requirements: None.

LabelColor

SheetZoneSettingsBuilder.LabelColor

Returns or sets the color of the label(text).

-------------------------------------

Getter Method

Signature LabelColor

Returns: Return type:int

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature LabelColor

Parameters:labelColor (int) –

New in version NX11.0.1.

License requirements: None.

LabelFont

SheetZoneSettingsBuilder.LabelFont

Returns or sets the font of the label(text).

-------------------------------------

Getter Method

Signature LabelFont

Returns: Return type:int

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature LabelFont

Parameters:labelFont (int) –

New in version NX11.0.1.

License requirements: None.

LabelHeight

SheetZoneSettingsBuilder.LabelHeight

Returns or sets the height of the label(text).

-------------------------------------

Getter Method

Signature LabelHeight

Returns: Return type:float

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature LabelHeight

Parameters:labelHeight (float) –

New in version NX11.0.1.

License requirements: None.

LabelItalicized

SheetZoneSettingsBuilder.LabelItalicized

Returns or sets the flag indicates the label(text) is italic or not.

-------------------------------------

Getter Method

Signature LabelItalicized

Returns: Return type:bool

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature LabelItalicized

Parameters:italic (bool) –

New in version NX11.0.1.

License requirements: None.

LabelWidth

SheetZoneSettingsBuilder.LabelWidth

Returns or sets the width of the label(text) like Regular, Bold.

-------------------------------------

Getter Method

Signature LabelWidth

Returns: Return type:int

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature LabelWidth

Parameters:labelWidth (int) –

New in version NX11.0.1.

License requirements: None.

LabelsToSkip

SheetZoneSettingsBuilder.LabelsToSkip

Returns or sets the characters to skip in label(text).

-------------------------------------

Getter Method

Signature LabelsToSkip

Returns: Return type:str

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature LabelsToSkip

Parameters:labelsToSkip (str) –

New in version NX11.0.1.

License requirements: None.

MarkingHeight

SheetZoneSettingsBuilder.MarkingHeight

Returns or sets the height of the marking.

-------------------------------------

Getter Method

Signature MarkingHeight

Returns: Return type:float

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature MarkingHeight

Parameters:markingHeight (float) –

New in version NX11.0.1.

License requirements: None.

MarkingLineColorWidth

SheetZoneSettingsBuilder.MarkingLineColorWidth

Returns the color and width of marking line.

-------------------------------------

Getter Method

Signature MarkingLineColorWidth

Returns: Return type:NXOpen.LineColorFontWidthBuilder

New in version NX11.0.1.

License requirements: None.

Origin

SheetZoneSettingsBuilder.Origin

Returns or sets the type of zone origin like TopLeft/BottomRight.

-------------------------------------

Getter Method

Signature Origin

Returns: Return type:NXOpen.Diagramming.ZoneOrigin

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature Origin

Parameters:origin (NXOpen.Diagramming.ZoneOrigin) –

New in version NX11.0.1.

License requirements: None.

VerticalSize

SheetZoneSettingsBuilder.VerticalSize

Returns or sets the size of the vertical zone.

It must be greater than zero.

-------------------------------------

Getter Method

Signature VerticalSize

Returns: Return type:float

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature VerticalSize

Parameters:verticalSize (float) –

New in version NX11.0.1.

License requirements: None.

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.