NX Open C++ Reference Guide
Public Member Functions
NXOpen::ObjectGeneralPropertiesBuilder Class Reference

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

Inheritance diagram for NXOpen::ObjectGeneralPropertiesBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Member Functions

bool Active ()
 Returns the active.
bool AddComponents ()
 Returns the add components.
bool AddIndex ()
 Returns the add index.
void ApplyToAllOccurrences ()
 Apply name to the instance of the component.
bool ApplyToComponent ()
 Returns the apply to component.
void Delete ()
 Delete the name of each selected object.
NXOpen::Point3d GetNameLocation ()
 Gets the name location.
bool GroupDisplayProperties ()
 Returns the group display properties.
int Index ()
 Returns the index.
NXString Name ()
 Returns the name.
bool NameLocationSpecified ()
 Returns the name location specified.
NXOpen::SelectNXObjectListSelectedObjects ()
 Returns the selected object(s) list.
void SetActive (bool active)
 Sets the active.
void SetAddComponents (bool addComponents)
 Sets the add components.
void SetAddIndex (bool addIndex)
 Sets the add index.
void SetApplyToComponent (bool applyToComponent)
 Sets the apply to component.
void SetGroupDisplayProperties (bool groupDisplayProperties)
 Sets the group display properties.
void SetIndex (int index)
 Sets the index.
void SetName (const NXString &name)
 Sets the name.
void SetNameLocation (const NXOpen::Point3d &nameLocation)
 Sets the name location.
void SetNameLocationSpecified (bool nameLocationSpecified)
 Sets the name location specified.
void SetTopLevel (bool topLevel)
 Sets the top level.
void SetUniqueMembership (bool uniqueMembership)
 Sets the unique membership.
bool TopLevel ()
 Returns the top level.
bool UniqueMembership ()
 Returns the unique membership.

Detailed Description

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


To create a new instance of this class, use 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

Returns the active.

This will activate or deactivate a group.
Created in NX8.0.0.

License requirements : None

Returns the add components.

This flag determines whether new components will be added automatically.
Created in NX8.0.0.

License requirements : None

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

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

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

Delete the name of each selected object.


Created in NX8.0.0.

License requirements : None

Gets the name location.

Returns:

Created in NX8.0.0.

License requirements : None

Returns the group display properties.

This field manages the display properties on a group.
Created in NX8.0.0.

License requirements : None

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

Returns the name.

The new name that will be applied to the selected objects.
Created in NX8.0.0.

License requirements : None

Returns the name location specified.

This states whether the name location will be changed.
Created in NX8.0.0.

License requirements : None

Returns the selected object(s) list.


Created in NX8.0.0.

License requirements : None

Sets the active.

This will activate or deactivate a group.
Created in NX8.0.0.

License requirements : None

Parameters:
activeactive

Sets the add components.

This flag determines whether new components will be added automatically.
Created in NX8.0.0.

License requirements : None

Parameters:
addComponentsaddcomponents

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:
addIndexaddindex

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:
applyToComponentapplytocomponent

Sets the group display properties.

This field manages the display properties on a group.
Created in NX8.0.0.

License requirements : None

Parameters:
groupDisplayPropertiesgroupdisplayproperties

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:
indexindex

Sets the name.

The new name that will be applied to the selected objects.
Created in NX8.0.0.

License requirements : None

Parameters:
namename

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:
nameLocationthe name location

Sets the name location specified.

This states whether the name location will be changed.
Created in NX8.0.0.

License requirements : None

Parameters:
nameLocationSpecifiednamelocationspecified

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:
topLeveltoplevel

Sets the unique membership.

This field manages the unique membership property on a group.
Created in NX8.0.0.

License requirements : None

Parameters:
uniqueMembershipuniquemembership

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

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.