SheetMarginSettingsBuilder Class¶
-
class
NXOpen.Drawings.SheetMarginSettingsBuilder¶ Bases:
NXOpen.TaggedObject,NXOpen.GeometricUtilities.IComponentBuilderRepresents the Drawing Sheet Margins Style Builder.
New in version NX10.0.0.
Properties¶
| Property | Description |
|---|---|
| BottomTrimmedMargin | Returns or sets the bottom margin |
| BottomUntrimmedMargin | Returns or sets the bottom untrimmed margin |
| CreateUntrimmedMargins | Returns or sets the create untrimmed margins |
| LeftTrimmedMargin | Returns or sets the left margin |
| LeftUntrimmedMargin | Returns or sets the left untrimmed margin |
| MarginLineColorFontWidth | Returns the margin line color, font and width |
| RightTrimmedMargin | Returns or sets the right margin |
| RightUntrimmedMargin | Returns or sets the right untrimmed margin |
| Tag | Returns the Tag for this object. |
| TopTrimmedMargin | Returns or sets the top margin |
| TopUntrimmedMargin | Returns or sets the top untrimmed 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 bottom margin
-------------------------------------Getter Method
Signature
BottomTrimmedMarginReturns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BottomTrimmedMarginParameters: bottomTrimmedMargin (float) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
BottomUntrimmedMargin¶
-
SheetMarginSettingsBuilder.BottomUntrimmedMargin¶ Returns or sets the bottom untrimmed margin
-------------------------------------Getter Method
Signature
BottomUntrimmedMarginReturns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BottomUntrimmedMarginParameters: bottomUntrimmedMargin (float) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
CreateUntrimmedMargins¶
-
SheetMarginSettingsBuilder.CreateUntrimmedMargins¶ Returns or sets the create untrimmed margins
-------------------------------------Getter Method
Signature
CreateUntrimmedMarginsReturns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CreateUntrimmedMarginsParameters: createUntrimmedMargins (bool) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
LeftTrimmedMargin¶
-
SheetMarginSettingsBuilder.LeftTrimmedMargin¶ Returns or sets the left margin
-------------------------------------Getter Method
Signature
LeftTrimmedMarginReturns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LeftTrimmedMarginParameters: leftTrimmedMargin (float) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
LeftUntrimmedMargin¶
-
SheetMarginSettingsBuilder.LeftUntrimmedMargin¶ Returns or sets the left untrimmed margin
-------------------------------------Getter Method
Signature
LeftUntrimmedMarginReturns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LeftUntrimmedMarginParameters: leftUntrimmedMargin (float) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
MarginLineColorFontWidth¶
-
SheetMarginSettingsBuilder.MarginLineColorFontWidth¶ Returns the margin line color, font and width
-------------------------------------Getter Method
Signature
MarginLineColorFontWidthReturns: Return type: NXOpen.LineColorFontWidthBuilderNew in version NX10.0.0.
License requirements: None.
RightTrimmedMargin¶
-
SheetMarginSettingsBuilder.RightTrimmedMargin¶ Returns or sets the right margin
-------------------------------------Getter Method
Signature
RightTrimmedMarginReturns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RightTrimmedMarginParameters: rightTrimmedMargin (float) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
RightUntrimmedMargin¶
-
SheetMarginSettingsBuilder.RightUntrimmedMargin¶ Returns or sets the right untrimmed margin
-------------------------------------Getter Method
Signature
RightUntrimmedMarginReturns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RightUntrimmedMarginParameters: rightUntrimmedMargin (float) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
TopTrimmedMargin¶
-
SheetMarginSettingsBuilder.TopTrimmedMargin¶ Returns or sets the top margin
-------------------------------------Getter Method
Signature
TopTrimmedMarginReturns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TopTrimmedMarginParameters: topMargin (float) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
TopUntrimmedMargin¶
-
SheetMarginSettingsBuilder.TopUntrimmedMargin¶ Returns or sets the top untrimmed margin
-------------------------------------Getter Method
Signature
TopUntrimmedMarginReturns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TopUntrimmedMarginParameters: topUntrimmedMargin (float) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
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.