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
BottomTrimmedMargin()Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BottomTrimmedMargin(bottomTrimmedMargin)Parameters: 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
BottomUntrimmedMargin()Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BottomUntrimmedMargin(bottomUntrimmedMargin)Parameters: 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
CreateUntrimmedMargins()Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CreateUntrimmedMargins(createUntrimmedMargins)Parameters: createUntrimmedMargins (bool) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
LeftTrimmedMargin¶
-
SheetMarginSettingsBuilder.LeftTrimmedMargin¶ Returns or sets the left margin
-------------------------------------Getter Method
Signature
LeftTrimmedMargin()Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LeftTrimmedMargin(leftTrimmedMargin)Parameters: 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
LeftUntrimmedMargin()Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LeftUntrimmedMargin(leftUntrimmedMargin)Parameters: 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
MarginLineColorFontWidth()Returns: Return type: NXOpen.LineColorFontWidthBuilderNew in version NX10.0.0.
License requirements: None.
RightTrimmedMargin¶
-
SheetMarginSettingsBuilder.RightTrimmedMargin¶ Returns or sets the right margin
-------------------------------------Getter Method
Signature
RightTrimmedMargin()Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RightTrimmedMargin(rightTrimmedMargin)Parameters: 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
RightUntrimmedMargin()Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RightUntrimmedMargin(rightUntrimmedMargin)Parameters: rightUntrimmedMargin (float) – New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
TopTrimmedMargin¶
-
SheetMarginSettingsBuilder.TopTrimmedMargin¶ Returns or sets the top margin
-------------------------------------Getter Method
Signature
TopTrimmedMargin()Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TopTrimmedMargin(topMargin)Parameters: 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
TopUntrimmedMargin()Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TopUntrimmedMargin(topUntrimmedMargin)Parameters: 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.