Represents an NXOpen::ObjectGeneralPropertiesBuilder to be used for modifying the names and properties of objects. More...
Public Member Functions | |
| bool | Active () |
| Returns the active. More... | |
| bool | AddComponents () |
| Returns the add components. More... | |
| bool | AddIndex () |
| Returns the add index. More... | |
| void | ApplyToAllOccurrences () |
| Apply name to the instance of the component. More... | |
| bool | ApplyToComponent () |
| Returns the apply to component. More... | |
| void | Delete () |
| Delete the name of each selected object. More... | |
| NXOpen::Point3d | GetNameLocation () |
| Gets the name location. More... | |
| bool | GroupDisplayProperties () |
| Returns the group display properties. More... | |
| int | Index () |
| Returns the index. More... | |
| NXString | Name () |
| Returns the name. More... | |
| bool | NameLocationSpecified () |
| Returns the name location specified. More... | |
| NXOpen::SelectNXObjectList * | SelectedObjects () |
| Returns the selected object(s) list. More... | |
| void | SetActive (bool active) |
| Sets the active. More... | |
| void | SetAddComponents (bool addComponents) |
| Sets the add components. More... | |
| void | SetAddIndex (bool addIndex) |
| Sets the add index. More... | |
| void | SetApplyToComponent (bool applyToComponent) |
| Sets the apply to component. More... | |
| void | SetGroupDisplayProperties (bool groupDisplayProperties) |
| Sets the group display properties. More... | |
| void | SetIndex (int index) |
| Sets the index. More... | |
| void | SetName (const NXString &name) |
| Sets the name. More... | |
| void | SetName (const char *name) |
| Sets the name. More... | |
| void | SetNameLocation (const NXOpen::Point3d &nameLocation) |
| Sets the name location. More... | |
| void | SetNameLocationSpecified (bool nameLocationSpecified) |
| Sets the name location specified. More... | |
| void | SetTopLevel (bool topLevel) |
| Sets the top level. More... | |
| void | SetUniqueMembership (bool uniqueMembership) |
| Sets the unique membership. More... | |
| bool | TopLevel () |
| Returns the top level. More... | |
| bool | UniqueMembership () |
| Returns the unique membership. More... | |
 Public Member Functions inherited from NXOpen::Builder | |
| NXOpen::NXObject * | Commit () |
| Commits any edits that have been applied to the builder. More... | |
| void | Destroy () |
| Deletes the builder, and cleans up any objects created by the builder. More... | |
| std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
| For builders that create more than one object, this method returns the objects that are created by commit. More... | |
| NXOpen::NXObject * | GetObject () |
| Returns the object currently being edited by this builder. More... | |
| void | ShowResults () |
| Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
| virtual bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. More... | |
| Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
Detailed Description
Represents an NXOpen::ObjectGeneralPropertiesBuilder to be used for modifying the names and properties of 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 |
Created in NX8.0.0.
Member Function Documentation
| bool NXOpen::ObjectGeneralPropertiesBuilder::Active | ( | ) |
Returns the active.
This will activate or deactivate a group.
Created in NX8.0.0.
License requirements : None
| bool NXOpen::ObjectGeneralPropertiesBuilder::AddComponents | ( | ) |
Returns the add components.
This flag determines whether new components will be added automatically.
Created in NX8.0.0.
License requirements : None
| bool NXOpen::ObjectGeneralPropertiesBuilder::AddIndex | ( | ) |
Returns the add index.
An index will be appended to the name if this is set to true.
Created in NX8.0.0.
License requirements : None
| void NXOpen::ObjectGeneralPropertiesBuilder::ApplyToAllOccurrences | ( | ) |
Apply name to the instance of the component.
All occurrences of the instance will inherit this name.
Created in NX8.0.0.
License requirements : None
| bool NXOpen::ObjectGeneralPropertiesBuilder::ApplyToComponent | ( | ) |
Returns the apply to component.
The name will be applied to the component if this is true.
Created in NX8.0.0.
License requirements : None
| void NXOpen::ObjectGeneralPropertiesBuilder::Delete | ( | ) |
Delete the name of each selected object.
Created in NX8.0.0.
License requirements : None
| NXOpen::Point3d NXOpen::ObjectGeneralPropertiesBuilder::GetNameLocation | ( | ) |
Gets the name location.
- Returns
Created in NX8.0.0.
License requirements : None
| bool NXOpen::ObjectGeneralPropertiesBuilder::GroupDisplayProperties | ( | ) |
Returns the group display properties.
This field manages the display properties on a group.
Created in NX8.0.0.
License requirements : None
| int NXOpen::ObjectGeneralPropertiesBuilder::Index | ( | ) |
Returns the index.
The index to be appended to the name if "Add Index" is set to true.
Created in NX8.0.0.
License requirements : None
| NXString NXOpen::ObjectGeneralPropertiesBuilder::Name | ( | ) |
Returns the name.
The new name that will be applied to the selected objects.
Created in NX8.0.0.
License requirements : None
| bool NXOpen::ObjectGeneralPropertiesBuilder::NameLocationSpecified | ( | ) |
Returns the name location specified.
This states whether the name location will be changed.
Created in NX8.0.0.
License requirements : None
| NXOpen::SelectNXObjectList* NXOpen::ObjectGeneralPropertiesBuilder::SelectedObjects | ( | ) |
Returns the selected object(s) list.
Created in NX8.0.0.
License requirements : None
| void NXOpen::ObjectGeneralPropertiesBuilder::SetActive | ( | bool | active | ) |
Sets the active.
This will activate or deactivate a group.
Created in NX8.0.0.
License requirements : None
- Parameters
-
active active
| void NXOpen::ObjectGeneralPropertiesBuilder::SetAddComponents | ( | bool | addComponents | ) |
Sets the add components.
This flag determines whether new components will be added automatically.
Created in NX8.0.0.
License requirements : None
- Parameters
-
addComponents addcomponents
| void NXOpen::ObjectGeneralPropertiesBuilder::SetAddIndex | ( | bool | addIndex | ) |
Sets the add index.
An index will be appended to the name if this is set to true.
Created in NX8.0.0.
License requirements : None
- Parameters
-
addIndex addindex
| void NXOpen::ObjectGeneralPropertiesBuilder::SetApplyToComponent | ( | bool | applyToComponent | ) |
Sets the apply to component.
The name will be applied to the component if this is true.
Created in NX8.0.0.
License requirements : None
- Parameters
-
applyToComponent applytocomponent
| void NXOpen::ObjectGeneralPropertiesBuilder::SetGroupDisplayProperties | ( | bool | groupDisplayProperties | ) |
Sets the group display properties.
This field manages the display properties on a group.
Created in NX8.0.0.
License requirements : None
- Parameters
-
groupDisplayProperties groupdisplayproperties
| void NXOpen::ObjectGeneralPropertiesBuilder::SetIndex | ( | int | index | ) |
Sets the index.
The index to be appended to the name if "Add Index" is set to true.
Created in NX8.0.0.
License requirements : None
- Parameters
-
index index
| void NXOpen::ObjectGeneralPropertiesBuilder::SetName | ( | const NXString & | name | ) |
Sets the name.
The new name that will be applied to the selected objects.
Created in NX8.0.0.
License requirements : None
- Parameters
-
name name
| void NXOpen::ObjectGeneralPropertiesBuilder::SetName | ( | const char * | name | ) |
Sets the name.
The new name that will be applied to the selected objects.
Created in NX8.0.0.
License requirements : None
- Parameters
-
name name
| void NXOpen::ObjectGeneralPropertiesBuilder::SetNameLocation | ( | const NXOpen::Point3d & | nameLocation | ) |
Sets the name location.
If name location specified is true, this value will be used to change the name location of the general object.
Created in NX8.0.0.
License requirements : None
- Parameters
-
nameLocation the name location
| void NXOpen::ObjectGeneralPropertiesBuilder::SetNameLocationSpecified | ( | bool | nameLocationSpecified | ) |
Sets the name location specified.
This states whether the name location will be changed.
Created in NX8.0.0.
License requirements : None
- Parameters
-
nameLocationSpecified namelocationspecified
| void NXOpen::ObjectGeneralPropertiesBuilder::SetTopLevel | ( | bool | topLevel | ) |
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.
Created in NX8.0.0.
License requirements : None
- Parameters
-
topLevel toplevel
| void NXOpen::ObjectGeneralPropertiesBuilder::SetUniqueMembership | ( | bool | uniqueMembership | ) |
Sets the unique membership.
This field manages the unique membership property on a group.
Created in NX8.0.0.
License requirements : None
- Parameters
-
uniqueMembership uniquemembership
| bool NXOpen::ObjectGeneralPropertiesBuilder::TopLevel | ( | ) |
Returns 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.
Created in NX8.0.0.
License requirements : None
| bool NXOpen::ObjectGeneralPropertiesBuilder::UniqueMembership | ( | ) |
Returns the unique membership.
This field manages the unique membership property on a group.
Created in NX8.0.0.
License requirements : None
The documentation for this class was generated from the following file:
- ObjectGeneralPropertiesBuilder.hxx