ConvertLayoutToSheetBuilder Class¶
-
class
NXOpen.Layout2d.
ConvertLayoutToSheetBuilder
¶ Bases:
NXOpen.Builder
Represents a Builder for converting Layout to drawing sheet
To create a new instance of this class, use
NXOpen.Layout2d.LayoutDrawingSheetCollection.CreateConvertLayoutToSheetBuilder()
New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
Name | Returns or sets the name of the drawing sheet to be created |
Number | Returns or sets the number of the drawing sheet to be created |
ProjectionAngleType | Returns or sets the sheet projection angle option |
Revision | Returns or sets the revision of the drawing sheet to be created |
SecondaryNumber | Returns or sets the secondary number of the drawing sheet to be created |
SelectLayoutSheetView | Returns the select layout sheet view to convert |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
GetScale | Gets the sheet scale |
SetScale | Sets the sheet scale |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
ConvertLayoutToSheetBuilderSheetProjectionAngleType Enumeration | the drawing sheet projection angle |
Property Detail¶
Name¶
-
ConvertLayoutToSheetBuilder.
Name
¶ Returns or sets the name of the drawing sheet to be created
-------------------------------------
Getter Method
Signature
Name
Returns: the drawing sheet name Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Name
Parameters: name (str) – drawing sheet name New in version NX12.0.0.
License requirements: nx_layout (“NX Layout”)
Number¶
-
ConvertLayoutToSheetBuilder.
Number
¶ Returns or sets the number of the drawing sheet to be created
-------------------------------------
Getter Method
Signature
Number
Returns: the drawing sheet number Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Number
Parameters: number (str) – the drawing sheet number New in version NX12.0.0.
License requirements: nx_layout (“NX Layout”)
ProjectionAngleType¶
-
ConvertLayoutToSheetBuilder.
ProjectionAngleType
¶ Returns or sets the sheet projection angle option
-------------------------------------
Getter Method
Signature
ProjectionAngleType
Returns: the projection angle type Return type: NXOpen.Layout2d.ConvertLayoutToSheetBuilderSheetProjectionAngleType
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ProjectionAngleType
Parameters: type ( NXOpen.Layout2d.ConvertLayoutToSheetBuilderSheetProjectionAngleType
) – the projection angle typeNew in version NX12.0.0.
License requirements: nx_layout (“NX Layout”)
Revision¶
-
ConvertLayoutToSheetBuilder.
Revision
¶ Returns or sets the revision of the drawing sheet to be created
-------------------------------------
Getter Method
Signature
Revision
Returns: the drawing sheet revision Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Revision
Parameters: revision (str) – the drawing sheet revision New in version NX12.0.0.
License requirements: nx_layout (“NX Layout”)
SecondaryNumber¶
-
ConvertLayoutToSheetBuilder.
SecondaryNumber
¶ Returns or sets the secondary number of the drawing sheet to be created
-------------------------------------
Getter Method
Signature
SecondaryNumber
Returns: the drawing sheet secondary number Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SecondaryNumber
Parameters: secondaryNumber (str) – the drawing sheet secondary number New in version NX12.0.0.
License requirements: nx_layout (“NX Layout”)
SelectLayoutSheetView¶
-
ConvertLayoutToSheetBuilder.
SelectLayoutSheetView
¶ Returns the select layout sheet view to convert
-------------------------------------
Getter Method
Signature
SelectLayoutSheetView
Returns: Return type: NXOpen.SelectView
New in version NX12.0.0.
License requirements: None.
Method Detail¶
GetScale¶
-
ConvertLayoutToSheetBuilder.
GetScale
¶ Gets the sheet scale
Signature
GetScale()
Returns: a tuple Return type: A tuple consisting of (numerator, denominator) numerator is a float. the scale numerator denominator is a float. the scale denominator New in version NX12.0.0.
License requirements: None.
SetScale¶
-
ConvertLayoutToSheetBuilder.
SetScale
¶ Sets the sheet scale
Signature
SetScale(numerator, denominator)
Parameters: - numerator (float) – the scale numerator
- denominator (float) – the scale denominator
New in version NX12.0.0.
License requirements: nx_layout (“NX Layout”)
Validate¶
-
ConvertLayoutToSheetBuilder.
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.