ObjectGeneralPropertiesBuilder Class

class NXOpen.ObjectGeneralPropertiesBuilder

Bases: NXOpen.Builder

Represents an NXOpen.ObjectGeneralPropertiesBuilder to be used for modifying the names and properties of objects.

Input to this class can be PSM facet objects.

To create a new instance of this class, use NXOpen.PropertiesManager.CreateObjectGeneralPropertiesBuilder()

Default values.

Property	Value
Active	0
AddComponents	0
AddIndex	0
ApplyToComponent	0
Index	0
TopLevel	0
UniqueMembership	0

New in version NX8.0.0.

Properties

Property	Description
Active	Returns or sets the active.
AddComponents	Returns or sets the add components.
AddIndex	Returns or sets the add index.
ApplyToComponent	Returns or sets the apply to component.
GroupDisplayProperties	Returns or sets the group display properties.
Index	Returns or sets the index.
Name	Returns or sets the name.
NameLocationSpecified	Returns or sets the name location specified.
SelectedObjects	Returns the selected object(s) list.
Tag	Returns the Tag for this object.
TopLevel	Returns or sets the top level.
UniqueMembership	Returns or sets the unique membership.

Methods

Method	Description
ApplyToAllOccurrences	Apply name to the instance of the component.
Commit	Commits any edits that have been applied to the builder.
Delete	Delete the name of each selected object.
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.
GetNameLocation	Gets the name location
GetObject	Returns the object currently being edited by this builder.
SetNameLocation	Sets the name location.
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

Active

ObjectGeneralPropertiesBuilder.Active

Returns or sets the active.

This will activate or deactivate a group.

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

Getter Method

Signature Active

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Active

Parameters:active (bool) –

New in version NX8.0.0.

License requirements: None.

AddComponents

ObjectGeneralPropertiesBuilder.AddComponents

Returns or sets the add components.

This flag determines whether new components will be added automatically.

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

Getter Method

Signature AddComponents

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature AddComponents

Parameters:addComponents (bool) –

New in version NX8.0.0.

License requirements: None.

AddIndex

ObjectGeneralPropertiesBuilder.AddIndex

Returns or sets the add index.

An index will be appended to the name if this is set to true.

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

Getter Method

Signature AddIndex

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature AddIndex

Parameters:addIndex (bool) –

New in version NX8.0.0.

License requirements: None.

ApplyToComponent

ObjectGeneralPropertiesBuilder.ApplyToComponent

Returns or sets the apply to component.

The name will be applied to the component if this is true.

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

Getter Method

Signature ApplyToComponent

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ApplyToComponent

Parameters:applyToComponent (bool) –

New in version NX8.0.0.

License requirements: None.

GroupDisplayProperties

ObjectGeneralPropertiesBuilder.GroupDisplayProperties

Returns or sets the group display properties.

This field manages the display properties on a group.

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

Getter Method

Signature GroupDisplayProperties

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature GroupDisplayProperties

Parameters:groupDisplayProperties (bool) –

New in version NX8.0.0.

License requirements: None.

Index

ObjectGeneralPropertiesBuilder.Index

Returns or sets the index.

The index to be appended to the name if “Add Index” is set to true.

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

Getter Method

Signature Index

Returns: Return type:int

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Index

Parameters:index (int) –

New in version NX8.0.0.

License requirements: None.

Name

ObjectGeneralPropertiesBuilder.Name

Returns or sets the name.

The new name that will be applied to the selected objects.

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

Getter Method

Signature Name

Returns: Return type:str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Name

Parameters:name (str) –

New in version NX8.0.0.

License requirements: None.

NameLocationSpecified

ObjectGeneralPropertiesBuilder.NameLocationSpecified

Returns or sets the name location specified.

This states whether the name location will be changed.

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

Getter Method

Signature NameLocationSpecified

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature NameLocationSpecified

Parameters:nameLocationSpecified (bool) –

New in version NX8.0.0.

License requirements: None.

SelectedObjects

ObjectGeneralPropertiesBuilder.SelectedObjects

Returns the selected object(s) list.

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

Getter Method

Signature SelectedObjects

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX8.0.0.

License requirements: None.

TopLevel

ObjectGeneralPropertiesBuilder.TopLevel

Returns or sets the top level.

This object will be displayed at the top level of the part navigator if this is set to true. Only applies if the object selected is a group or a reference set.

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

Getter Method

Signature TopLevel

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature TopLevel

Parameters:topLevel (bool) –

New in version NX8.0.0.

License requirements: None.

UniqueMembership

ObjectGeneralPropertiesBuilder.UniqueMembership

Returns or sets the unique membership.

This field manages the unique membership property on a group.

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

Getter Method

Signature UniqueMembership

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature UniqueMembership

Parameters:uniqueMembership (bool) –

New in version NX8.0.0.

License requirements: None.

Method Detail

ApplyToAllOccurrences

ObjectGeneralPropertiesBuilder.ApplyToAllOccurrences

Apply name to the instance of the component.

All occurrences of the instance will inherit this name.

Signature ApplyToAllOccurrences()

New in version NX8.0.0.

License requirements: None.

Delete

ObjectGeneralPropertiesBuilder.Delete

Delete the name of each selected object.

Signature Delete()

New in version NX8.0.0.

License requirements: None.

GetNameLocation

ObjectGeneralPropertiesBuilder.GetNameLocation

Gets the name location

Signature GetNameLocation()

Returns: Return type:NXOpen.Point3d

New in version NX8.0.0.

License requirements: None.

SetNameLocation

ObjectGeneralPropertiesBuilder.SetNameLocation

Sets the name location.

If name location specified is true, this value will be used to change the name location of the general object.

Signature SetNameLocation(nameLocation)

Parameters:nameLocation (NXOpen.Point3d) – the name location

New in version NX8.0.0.

License requirements: None.

Validate

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