PropertyBuilder Class

class NXOpen.Assemblies.ProductInterface.PropertyBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Assemblies.ProductInterface.PropertyBuilder builder

To create a new instance of this class, use NXOpen.Assemblies.ProductInterface.Collection.CreatePropertyBuilder()

New in version NX9.0.0.

Properties

Property Description
Description Returns or sets the description of a product interface provided by users
InterfaceUsageType Returns or sets the interface type of a product interface provided by users
Name Returns or sets the name of a product interface provided by users
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.
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.

Property Detail

Description

PropertyBuilder.Description

Returns or sets the description of a product interface provided by users

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

Getter Method

Signature Description

Returns:
Return type:str

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature Description

Parameters:description (str) –

New in version NX9.0.0.

License requirements: gateway (“UG GATEWAY”)

InterfaceUsageType

PropertyBuilder.InterfaceUsageType

Returns or sets the interface type of a product interface provided by users

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

Getter Method

Signature InterfaceUsageType

Returns:
Return type:int

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature InterfaceUsageType

Parameters:interfaceUsageType (int) – usage type to be set on the product interface object

New in version NX12.0.0.

License requirements: gateway (“UG GATEWAY”)

Name

PropertyBuilder.Name

Returns or sets the name of a product interface provided by users

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

Getter Method

Signature Name

Returns:
Return type:str

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature Name

Parameters:name (str) –

New in version NX9.0.0.

License requirements: gateway (“UG GATEWAY”)

Method Detail

Validate

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