ReplaceExpressionsBuilder Class

class NXOpen.ReplaceExpressionsBuilder

Bases: NXOpen.Builder

This class creates Replace expressions from the source part to the current work part via the naming rule defined.

To create a new instance of this class, use NXOpen.ExpressionCollection.CreateReplaceExpressionsBuilder()

New in version NX10.0.0.

Properties

Property Description
CurrentString Returns or sets the current string.
ReplaceString Returns or sets the replace string.
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

CurrentString

ReplaceExpressionsBuilder.CurrentString

Returns or sets the current string.

This string is used as the replaced string.

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

Getter Method

Signature CurrentString

Returns:
Return type:str

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature CurrentString

Parameters:currentString (str) –

New in version NX10.0.0.

License requirements: None.

ReplaceString

ReplaceExpressionsBuilder.ReplaceString

Returns or sets the replace string.

This string replaces the current string.

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

Getter Method

Signature ReplaceString

Returns:
Return type:str

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature ReplaceString

Parameters:replaceString (str) –

New in version NX10.0.0.

License requirements: None.

Method Detail

Validate

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