InsertSheetBuilder Class

class NXOpen.LineDesigner.InsertSheetBuilder

Bases: NXOpen.Builder

Represents a LineDesigner.InsertSheet builder

To create a new instance of this class, use NXOpen.LineDesigner.LineDesignerManager.CreateInsertSheetBuilder()

Default values.

Property Value
UnitsEnum Millimeters

New in version NX9.0.0.

Properties

Property Description
NameString Returns or sets the name string
NumberString Returns or sets the number string
RevisionString Returns or sets the revision string
ScaleEnum Returns or sets the scale enum
SecondaryNumberString Returns or sets the secondary number string
SizeEnum Returns or sets the size enum
Tag Returns the Tag for this object.
UnitsEnum Returns or sets the units enum

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

InsertSheetBuilderAPIUnits Enumeration This enum represents the units types

Property Detail

NameString

InsertSheetBuilder.NameString

Returns or sets the name string

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

Getter Method

Signature NameString

Returns:
Return type:str

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

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

Setter Method

Signature NameString

Parameters:nameString (str) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

NumberString

InsertSheetBuilder.NumberString

Returns or sets the number string

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

Getter Method

Signature NumberString

Returns:
Return type:str

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

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

Setter Method

Signature NumberString

Parameters:numberString (str) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

RevisionString

InsertSheetBuilder.RevisionString

Returns or sets the revision string

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

Getter Method

Signature RevisionString

Returns:
Return type:str

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

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

Setter Method

Signature RevisionString

Parameters:revisionString (str) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

ScaleEnum

InsertSheetBuilder.ScaleEnum

Returns or sets the scale enum

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

Getter Method

Signature ScaleEnum

Returns:
Return type:int

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

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

Setter Method

Signature ScaleEnum

Parameters:scaleEnum (int) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

SecondaryNumberString

InsertSheetBuilder.SecondaryNumberString

Returns or sets the secondary number string

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

Getter Method

Signature SecondaryNumberString

Returns:
Return type:str

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

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

Setter Method

Signature SecondaryNumberString

Parameters:secondaryNumberString (str) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

SizeEnum

InsertSheetBuilder.SizeEnum

Returns or sets the size enum

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

Getter Method

Signature SizeEnum

Returns:
Return type:int

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

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

Setter Method

Signature SizeEnum

Parameters:sizeEnum (int) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

UnitsEnum

InsertSheetBuilder.UnitsEnum

Returns or sets the units enum

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

Getter Method

Signature UnitsEnum

Returns:
Return type:NXOpen.LineDesigner.InsertSheetBuilderAPIUnits

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

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

Setter Method

Signature UnitsEnum

Parameters:unitsEnum (NXOpen.LineDesigner.InsertSheetBuilderAPIUnits) –

New in version NX9.0.0.

License requirements: ld_line_designer (“FULL LINE DESIGNER”)

Method Detail

Validate

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