NXOpen .NET Reference  12.0.0
Public Member Functions | Properties | List of all members
NXOpen.ObjectGeneralPropertiesBuilder Class Reference

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

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

Public Member Functions

unsafe void Delete ()
 Delete the name of each selected object. More...
 
unsafe NXOpen.Point3d GetNameLocation ()
 Gets the name location More...
 
unsafe void SetNameLocation (NXOpen.Point3d nameLocation)
 Sets the name location. More...
 
unsafe void ApplyToAllOccurrences ()
 Apply name to the instance of the component. More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 

Properties

unsafe bool Active [get, set]
 Returns or sets the active. More...
 
unsafe bool AddComponents [get, set]
 Returns or sets the add components. More...
 
unsafe bool AddIndex [get, set]
 Returns or sets the add index. More...
 
unsafe bool ApplyToComponent [get, set]
 Returns or sets the apply to component. More...
 
unsafe bool GroupDisplayProperties [get, set]
 Returns or sets the group display properties. More...
 
unsafe int Index [get, set]
 Returns or sets the index. More...
 
unsafe string Name [get, set]
 Returns or sets the name. More...
 
unsafe bool NameLocationSpecified [get, set]
 Returns or sets the name location specified. More...
 
unsafe NXOpen.SelectNXObjectList SelectedObjects [get]
 Returns the selected object(s) list. More...
 
unsafe bool TopLevel [get, set]
 Returns or sets the top level. More...
 
unsafe bool UniqueMembership [get, set]
 Returns or sets the unique membership. More...
 

Detailed Description

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

Created in NX8.0.0

Member Function Documentation

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

unsafe void NXOpen.ObjectGeneralPropertiesBuilder.Delete ( )

Delete the name of each selected object.

Created in NX8.0.0

License requirements: None.

unsafe NXOpen.Point3d NXOpen.ObjectGeneralPropertiesBuilder.GetNameLocation ( )

Gets the name location

Created in NX8.0.0

License requirements: None.

Returns
unsafe void NXOpen.ObjectGeneralPropertiesBuilder.SetNameLocation ( 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
nameLocationthe name location

Property Documentation

unsafe bool NXOpen.ObjectGeneralPropertiesBuilder.Active
getset

Returns or sets the active.

This will activate or deactivate a group.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.ObjectGeneralPropertiesBuilder.AddComponents
getset

Returns or sets the add components.

This flag determines whether new components will be added automatically.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.ObjectGeneralPropertiesBuilder.AddIndex
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.ObjectGeneralPropertiesBuilder.ApplyToComponent
getset

Returns or sets the apply to component.

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

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.ObjectGeneralPropertiesBuilder.GroupDisplayProperties
getset

Returns or sets the group display properties.

This field manages the display properties on a group.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.ObjectGeneralPropertiesBuilder.Index
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.ObjectGeneralPropertiesBuilder.Name
getset

Returns or sets the name.

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

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.ObjectGeneralPropertiesBuilder.NameLocationSpecified
getset

Returns or sets the name location specified.

This states whether the name location will be changed.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.SelectNXObjectList NXOpen.ObjectGeneralPropertiesBuilder.SelectedObjects
get

Returns the selected object(s) list.

Created in NX8.0.0

License requirements: None.

unsafe bool NXOpen.ObjectGeneralPropertiesBuilder.TopLevel
getset

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.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.ObjectGeneralPropertiesBuilder.UniqueMembership
getset

Returns or sets the unique membership.

This field manages the unique membership property on a group.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.