SheetMarginSettingsBuilder Class

class NXOpen.Diagramming.SheetMarginSettingsBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

The SheetMarginSettings builder

New in version NX11.0.1.

Properties

Property	Description
BottomTrimmedMargin	Returns or sets the value of the margin in bottom border.
BottomUntrimmedMargin	Returns or sets the distance between bottom of the sheet and bottom trimmed margin.
CreateUntrimmedMargins	Returns or sets the flag indicates to create untrimmed margins or not.
LeftTrimmedMargin	Returns or sets the value of the margin in left border.
LeftUntrimmedMargin	Returns or sets the distance between left of the sheet and left trimmed margin.
MarginLineColorFontWidth	Returns the color, font and width of margin line.
RightTrimmedMargin	Returns or sets the value of the margin in right border.
RightUntrimmedMargin	Returns or sets the distance between right of the sheet and right trimmed margin.
Tag	Returns the Tag for this object.
TopTrimmedMargin	Returns or sets the value of the margin in top border.
TopUntrimmedMargin	Returns or sets the distance between top of the sheet and top trimmed margin.

Methods

Method	Description
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

BottomTrimmedMargin

SheetMarginSettingsBuilder.BottomTrimmedMargin

Returns or sets the value of the margin in bottom border.

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

Getter Method

Signature BottomTrimmedMargin

Returns: Return type:float

New in version NX11.0.1.

License requirements: None.

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

Setter Method

Signature BottomTrimmedMargin

Parameters:bottomTrimmedMargin (float) –

New in version NX11.0.1.

License requirements: None.

BottomUntrimmedMargin

SheetMarginSettingsBuilder.BottomUntrimmedMargin

Returns or sets the distance between bottom of the sheet and bottom trimmed margin.

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

Getter Method

Signature BottomUntrimmedMargin

Returns: Return type:float

New in version NX11.0.1.

License requirements: None.

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

Setter Method

Signature BottomUntrimmedMargin

Parameters:bottomUntrimmedMargin (float) –

New in version NX11.0.1.

License requirements: None.

CreateUntrimmedMargins

SheetMarginSettingsBuilder.CreateUntrimmedMargins

Returns or sets the flag indicates to create untrimmed margins or not.

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

Getter Method

Signature CreateUntrimmedMargins

Returns: Return type:bool

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature CreateUntrimmedMargins

Parameters:createUntrimmedMargins (bool) –

New in version NX10.0.0.

License requirements: None.

LeftTrimmedMargin

SheetMarginSettingsBuilder.LeftTrimmedMargin

Returns or sets the value of the margin in left border.

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

Getter Method

Signature LeftTrimmedMargin

Returns: Return type:float

New in version NX11.0.1.

License requirements: None.

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

Setter Method

Signature LeftTrimmedMargin

Parameters:leftTrimmedMargin (float) –

New in version NX11.0.1.

License requirements: None.

LeftUntrimmedMargin

SheetMarginSettingsBuilder.LeftUntrimmedMargin

Returns or sets the distance between left of the sheet and left trimmed margin.

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

Getter Method

Signature LeftUntrimmedMargin

Returns: Return type:float

New in version NX11.0.1.

License requirements: None.

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

Setter Method

Signature LeftUntrimmedMargin

Parameters:leftUntrimmedMargin (float) –

New in version NX11.0.1.

License requirements: None.

MarginLineColorFontWidth

SheetMarginSettingsBuilder.MarginLineColorFontWidth

Returns the color, font and width of margin line.

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

Getter Method

Signature MarginLineColorFontWidth

Returns: Return type:NXOpen.LineColorFontWidthBuilder

New in version NX11.0.1.

License requirements: None.

RightTrimmedMargin

SheetMarginSettingsBuilder.RightTrimmedMargin

Returns or sets the value of the margin in right border.

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

Getter Method

Signature RightTrimmedMargin

Returns: Return type:float

New in version NX11.0.1.

License requirements: None.

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

Setter Method

Signature RightTrimmedMargin

Parameters:rightTrimmedMargin (float) –

New in version NX11.0.1.

License requirements: None.

RightUntrimmedMargin

SheetMarginSettingsBuilder.RightUntrimmedMargin

Returns or sets the distance between right of the sheet and right trimmed margin.

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

Getter Method

Signature RightUntrimmedMargin

Returns: Return type:float

New in version NX11.0.1.

License requirements: None.

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

Setter Method

Signature RightUntrimmedMargin

Parameters:rightUntrimmedMargin (float) –

New in version NX11.0.1.

License requirements: None.

TopTrimmedMargin

SheetMarginSettingsBuilder.TopTrimmedMargin

Returns or sets the value of the margin in top border.

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

Getter Method

Signature TopTrimmedMargin

Returns: Return type:float

New in version NX11.0.1.

License requirements: None.

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

Setter Method

Signature TopTrimmedMargin

Parameters:topMargin (float) –

New in version NX11.0.1.

License requirements: None.

TopUntrimmedMargin

SheetMarginSettingsBuilder.TopUntrimmedMargin

Returns or sets the distance between top of the sheet and top trimmed margin.

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

Getter Method

Signature TopUntrimmedMargin

Returns: Return type:float

New in version NX11.0.1.

License requirements: None.

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

Setter Method

Signature TopUntrimmedMargin

Parameters:topUntrimmedMargin (float) –

New in version NX11.0.1.

License requirements: None.

Method Detail

Validate

SheetMarginSettingsBuilder.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.