Represents a component in a NXOpen.Assemblies.ComponentAssembly . More...

Inheritance diagram for NXOpen.Assemblies.Component:

Public Types
enum	RepresentationMode { Lightweight, Partial, Exact, None }
	Representation status of a component More...

Public Types inherited from NXOpen.DisplayableObject
enum	ObjectWidth { Normal, Thick, Thin, One = 5, Two, Three, Four, Five, Six, Seven, Eight, Nine }
	specifies object width for objects such as lines and text More...

enum	ObjectFont { Solid = 1, Dashed, Phantom, Centerline, Dotted, LongDashed, DottedDashed }
	specifies the object font for objects such as lines More...

Public Types inherited from NXOpen.NXObject
enum	AttributeType { Invalid, Null, Boolean, Integer, Real, String, Time, Reference, Any = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { Numeric, Textual }
	Specifies the format of the date and time attribute. More...

Public Member Functions
unsafe NXOpen.Assemblies.Component[]	GetChildren ()
	Returns the child components of this component However, it does not return non-geometric components (NGCs) To enable this method to also return NGCs, set the following environment variable: UGII_ALLOW_NGC_IN_UGOPEN=YES More...

unsafe NXOpen.NXObject	FindOccurrence (NXOpen.NXObject proto)
	Given a prototype object, returns the corresponding occurrence in this component More...

unsafe int	GetLayerOption ()
	Gets the layer option. More...

unsafe void	SetLayerOption (int layer)
	Sets the layer option. More...

unsafe void	GetPosition (out NXOpen.Point3d position, out NXOpen.Matrix3x3 orientation)
	Gets the position of a component More...

unsafe void	EstablishPositionOverride (NXOpen.Assemblies.Component parent)
	Ensures there is a positioning override on component in the given part of the given parent. More...

unsafe void	EstablishIsolatedPositionOverride (NXOpen.Assemblies.Component parent, NXOpen.Assemblies.Arrangement arrangement)
	Ensures there is an isolated positioning override for the NXOpen.Assemblies.Component in the given part of the given parent. More...

unsafe void	SetPositioningIsolated (NXOpen.Assemblies.Arrangement arrangement)
	Set positioning for the selected NXOpen.Assemblies.Component as isolated in the specified NXOpen.Assemblies.Arrangement . More...

unsafe bool	IsPositioningIsolated (NXOpen.Assemblies.Arrangement arrangement)
	Get whether positioning for the selected NXOpen.Assemblies.Component is isolated in the specified NXOpen.Assemblies.Arrangement . More...

unsafe void	RemovePositionOverride (NXOpen.Assemblies.Component parent)
	Removes the highest level positioning override on component in or below the given parent. More...

unsafe NXOpen.Assemblies.Component	GetPositionOverrideParent ()
	Find the highest level parent in which the position of component is overridden. More...

unsafe NXOpen.Assemblies.PositionOverrideType	GetPositionOverrideType ()
	Gets the type of the highest level positioning override on the component. More...

unsafe void	GetArrangements (out NXOpen.Assemblies.Arrangement[] arrangements)
	Outputs the NXOpen.Assemblies.Arrangement objects within the NXOpen.Assemblies.Component . More...

unsafe void	SetUsedArrangement (NXOpen.Assemblies.Arrangement newArrangement)
	Changes the Arrangement used for this component. More...

unsafe void	SetPositioningVaried (NXOpen.Assemblies.Component[] components, bool setAsVaried)
	Set positioning for the selected NXOpen.Assemblies.Component s across all possible NXOpen.Assemblies.Arrangement s. More...

unsafe void	Suppress ()
	Suppresses the component in the ComponentAssembly that contains its controlling Arrangement. More...

unsafe NXOpen.ErrorList	Suppress (NXOpen.Assemblies.Component[] components)
	Suppresses an array of components in the ComponentAssembly that contains their controlling Arrangement. More...

unsafe void	Unsuppress ()
	Unsuppresses the component in the ComponentAssembly that contains its controlling Arrangement. More...

unsafe NXOpen.ErrorList	Unsuppress (NXOpen.Assemblies.Component[] components)
	Unsuppresses an array of components in the ComponentAssembly that contains their controlling Arrangement. More...

unsafe void	UpdateStructure (NXOpen.Assemblies.Component[] components, int nLevels)
	Update the assembly structure for this assembly in the context of the displayed part to the specified number of levels, ignoring components already processed by previous calls. More...

unsafe void	UpdateStructure (NXOpen.Assemblies.Component[] components, int nLevels, bool checkComponentsVisited)
	Update the assembly structure for this assembly in the context of the displayed part to the specified number of levels. More...

unsafe NXOpen.Positioning.ComponentConstraint[]	GetConstraints ()
	Returns the NXOpen.Positioning.ComponentConstraint s directly connected to this component. More...

unsafe NXOpen.Assemblies.DegreesOfFreedom	GetDegreesOfFreedom ()
	Returns the NXOpen.Assemblies.DegreesOfFreedom for this component. More...

unsafe NXOpen.Assemblies.DegreesOfFreedom	GetDegreesOfFreedom (NXOpen.Assemblies.Component[] components)
	Returns the NXOpen.Assemblies.DegreesOfFreedom for this component. More...

unsafe void	RecallConstraints ()
	Recalls the NXOpen.Positioning.ComponentConstraint s previously remembered on the part of this component, creating new constraints from them. More...

unsafe NXOpen.Positioning.ComponentConstraint[]	RecallAndListConstraints ()
	Recalls the NXOpen.Positioning.ComponentConstraint s previously remembered on the part of this component, creating new constraints from them. More...

unsafe void	RemoveRememberedConstraints ()
	Remove all the remembered constraints stored on the part of this component. More...

unsafe bool	GetNonGeometricState ()
	Gets the component state as Geometric or Non-Geometric. More...

unsafe NXOpen.Assemblies.ComponentQuantity	GetComponentQuantityType ()
	Gets the quantity type of the components. More...

unsafe int	GetIntegerQuantity ()
	Gets the value of the integer quantity of component. More...

unsafe double	GetRealQuantity (out string quantityUnits)
	Gets the value of real quantity and corresponding units on this component. More...

unsafe string	GetAsRequiredQuantity ()
	Gets the as-required quantity on this component. More...

unsafe NXOpen.ErrorList	DisplayComponentsLightweight (NXOpen.Assemblies.Component[] components)
	Sets an array of components to display using the lightweight representation. More...

unsafe NXOpen.ErrorList	DisplayComponentsExact (NXOpen.Assemblies.Component[] components)
	Sets an array of components to display using the exact representation. More...

unsafe NXOpen.Assemblies.Component.RepresentationMode	GetComponentRepresentationMode ()
	Returns the representation mode for the component's bodies. More...

unsafe void	SetInstanceUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
	Creates or modifies an attribute with the option to update or not. More...

unsafe void	SetInstanceUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetInstanceUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

unsafe void	SetInstanceUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute with the option to update or not. More...

unsafe void	SetInstanceUserAttribute (string title, int index, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetInstanceTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetInstanceBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...

unsafe bool	HasInstanceUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Determines if and attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). More...

unsafe NXOpen.NXObject.AttributeInformation	GetInstanceUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...

unsafe bool	GetInstanceBooleanUserAttribute (string title, int index)
	Gets a boolean attribute by Title and array Index. More...

unsafe int	GetInstanceIntegerUserAttribute (string title, int index)
	Gets an integer attribute by Title and array Index. More...

unsafe double	GetInstanceRealUserAttribute (string title, int index)
	Gets a real attribute by Title and array Index. More...

unsafe string	GetInstanceStringUserAttribute (string title, int index)
	Gets a string attribute by Title and array Index. More...

unsafe string	GetInstanceTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetInstanceUserAttributes ()
	Gets all the attributes that have been set on the given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetInstanceUserAttributes (bool includeUnset)
	Gets all the attributes that have been set on the given object, as well as information from attribute templates that have not been set (if 'IncludeUnset' is 'true'). More...

unsafe string	GetInstanceUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...

unsafe string[]	GetInstanceUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...

unsafe void	DeleteInstanceUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
	Deletes the first attribute encountered with the given Type, Title and Index. More...

unsafe void	DeleteInstanceUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
	Deletes the attributes encountered with the given Type with option to update or not. More...

unsafe void	SetInstanceUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
	Lock or unlock the given attribute. More...

unsafe bool	GetInstanceUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
	Determine the lock of the given attribute. More...

unsafe NXOpen.PartFamily.InstanceSelectionCriteria	CreateEmptyPartFamilyInstanceSelectionCriteria (NXOpen.PartFamily.Template family)
	Creates an empty NXOpen.PartFamily.InstanceSelectionCriteria More...

unsafe NXOpen.PartFamily.InstanceSelectionCriteria	GetPartFamilyInstanceSelectionCriteria ()
	Obtains theNXOpen.PartFamily.InstanceSelectionCriteria , if it exists. More...

unsafe void	SetPartFamilyInstanceSelectionCriteria (NXOpen.PartFamily.InstanceSelectionCriteria selectionCriteria)
	Hooks NXOpen.PartFamily.InstanceSelectionCriteria to this component More...

unsafe void	DeletePartFamilyInstanceSelectionCriteria ()
	Deletes NXOpen.PartFamily.InstanceSelectionCriteria associated with this component More...

unsafe void	FindComponentPatterns (out NXOpen.Assemblies.ComponentPattern patternDefinition, out NXOpen.Assemblies.ComponentPattern[] patternDefinitions)
	Finds NXOpen.Assemblies.ComponentPattern associated with this component. More...

unsafe NXOpen.Routing.CharacteristicList	GetCharacteristics ()
	Get all of the characteristics values on the this object. More...

unsafe void	SetCharacteristics (NXOpen.Routing.CharacteristicList values)
	Set all of the characteristics values on this object. More...

unsafe int	GetIntegerCharacteristic (string name)
	Get the value of an integer characteristic associated with the input name. More...

unsafe void	SetCharacteristic (string name, int value)
	Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already. More...

unsafe double	GetRealCharacteristic (string name)
	Get the value of a real characteristic associated with the input name. More...

unsafe void	SetCharacteristic (string name, double value)
	Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already. More...

unsafe string	GetStringCharacteristic (string name)
	Get the value of a string characteristic associated with the input name. More...

unsafe void	SetCharacteristic (string name, string value)
	Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already. More...

unsafe void	DeleteCharacterstics (NXOpen.Routing.CharacteristicList values)
	Removes the input list of characteristics from this object. More...

unsafe NXOpen.Routing.CharacteristicList	GetDestinationCharacteristics ()
	Returns the destination characteristics from the input object. More...

unsafe void	SetCharacteristic2 (string title, int value)
	Sets or creates an integer type attribute associated with the input title. More...

unsafe void	SetCharacteristic2 (string title, double value)
	Sets or creates a double type attribute associated with the input title. More...

unsafe void	SetCharacteristic2 (string title, string value)
	Sets or creates a string type type attribute associated with the input title. More...

unsafe void	SetCharacteristics2 (NXOpen.Routing.CharacteristicList values)
	Sets all attributes associated with the titles from the input list, creating new attributes for the ones that don't exist already. More...

Public Member Functions inherited from NXOpen.DisplayableObject
unsafe void	Blank ()
	Blanks the object. More...

unsafe void	Unblank ()
	Unblanks the object. More...

unsafe void	Highlight ()
	Highlights the object. More...

unsafe void	Unhighlight ()
	Unhighlights the object. More...

unsafe void	SetNameLocation (NXOpen.Point3d location)
	Sets the location of the object's name. More...

unsafe void	RedisplayObject ()
	Redisplays the object in all views. More...

unsafe void	RemoveViewDependency ()
	Remove dependency on all views from an object. More...

Public Member Functions inherited from NXOpen.NXObject
unsafe void	SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
	Creates or modifies an attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...

unsafe NXOpen.AttributeIterator	CreateAttributeIterator ()
	Create an attribute iterator More...

unsafe bool	HasUserAttribute (NXOpen.AttributeIterator iterator)
	Determines if an attribute exists on the object, that satisfies the given iterator More...

unsafe bool	HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
	Gets the count of set attributes on the object, if any, of the given type. More...

unsafe int	GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
	Gets the count of attributes on the object, if any, of the given type. More...

unsafe int	GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

unsafe bool	GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
	Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...

unsafe NXOpen.NXObject.AttributeInformation	GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...

unsafe bool	GetBooleanUserAttribute (string title, int index)
	Gets a boolean attribute by Title and array Index. More...

unsafe int	GetIntegerUserAttribute (string title, int index)
	Gets an integer attribute by Title and array Index. More...

unsafe double	GetRealUserAttribute (string title, int index)
	Gets a real attribute by Title and array Index. More...

unsafe string	GetStringUserAttribute (string title, int index)
	Gets a string attribute by Title and array Index. More...

unsafe string	GetTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe NXOpen.NXObject.ComputationalTime	GetComputationalTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (NXOpen.AttributeIterator iterator)
	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes ()
	Gets all the attributes that have been set on the given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...

unsafe string	GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...

unsafe void	DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator More...

unsafe void	DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
	Deletes the first attribute encountered with the given Type, Title. More...

unsafe void	DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
	Deletes the attributes encountered with the given Type with option to update or not. More...

unsafe void	SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
	Lock or unlock the given attribute. More...

unsafe bool	GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
	Determine the lock of the given attribute. More...

unsafe NXOpen.NXObject[]	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. More...

unsafe void	SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

unsafe string	GetPdmReferenceAttributeValue (string attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
	Deletes all attributes of a specific type. More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
	Deletes all attributes of a specific type with the option to update or not. More...

unsafe void	SetAttribute (string title, int value)
	Creates or modifies an integer attribute. More...

unsafe void	SetAttribute (string title, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetAttribute (string title, double value)
	Creates or modifies a real attribute. More...

unsafe void	SetAttribute (string title, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

unsafe void	SetAttribute (string title, string value)
	Creates or modifies a string attribute. More...

unsafe void	SetAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute with the option to update or not. More...

unsafe void	SetAttribute (string title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...

unsafe void	SetAttribute (string title, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetTimeAttribute (string title, string value)
	Creates or modifies a time attribute. More...

unsafe void	SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe int	GetIntegerAttribute (string title)
	Gets an integer attribute by title. More...

unsafe double	GetRealAttribute (string title)
	Gets a real attribute by title. More...

unsafe string	GetStringAttribute (string title)
	Gets a string attribute value by title. More...

unsafe string	GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
	Gets a time attribute by title. More...

unsafe string	GetReferenceAttribute (string title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
	Deletes an attribute by type and title. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
	Deletes an attribute by type and title with the option to update or not. More...

unsafe void	SetReferenceAttribute (string title, string value)
	Creates or modifies a string attribute which uses a reference string. More...

unsafe void	SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
	Gets all the attribute titles of a specific type. More...

unsafe string[]	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...

unsafe NXOpen.INXObject	FindObject (string journalIdentifier)
	Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...

unsafe void	Print ()
	Prints a representation of this object to the system log file. More...

unsafe void	SetName (string name)
	Sets the custom name of the object. More...

Public Member Functions inherited from NXOpen.Routing.ICharacteristic
void	SetCharacteristics (NXOpen.Routing.CharacteristicList values)
	Set all of the characteristics values on this object. More...

void	DeleteCharacterstics (NXOpen.Routing.CharacteristicList values)
	Removes the input list of characteristics from this object. More...

void	SetCharacteristics2 (NXOpen.Routing.CharacteristicList values)
	Sets all attributes associated with the titles from the input list, creating new attributes for the ones that don't exist already. More...

Properties
unsafe NXOpen.Assemblies.CollaborativeContentType	CollaborativeContentType `[get]`
	Returns the collaborative content type of this component. More...

unsafe NXOpen.PDM.DesignElementRevision	DesignElementRevision `[get]`
	Returns the NXOpen.PDM.DesignElementRevision that corresponds to this component. More...

unsafe NXOpen.PDM.DesignSubordinateRevision	DesignSubordinateRevision `[get]`
	Returns the NXOpen.PDM.DesignSubordinateRevision that corresponds to this component. More...

unsafe NXOpen.Assemblies.ComponentAssembly	DirectOwner `[get]`
	Returns the NXOpen.Assemblies.ComponentAssembly which owns this component as a "Top Level" component. More...

unsafe string	DisplayName `[get]`
	Returns the displayable name of the prototype part. More...

unsafe string	EmptyPartRefsetName `[get]`
	Returns the name of the reference set which represents the empty set. More...

unsafe string	EntirePartRefsetName `[get]`
	Returns the name of the reference set which represents the entire part. More...

unsafe NXOpen.Positioning.ComponentConstraint	FixConstraint `[get]`
	Returns a fix NXOpen.Positioning.ComponentConstraint of this component. More...

unsafe bool	IsFixed `[get]`
	Returns the fixed state of this component. More...

unsafe bool	IsSuppressed `[get]`
	Returns the suppressed state of the component in its controlling arrangement. More...

unsafe NXOpen.PDM.ModelElementRevision	ModelElementRevision `[get]`
	Returns the NXOpen.PDM.ModelElementRevision that corresponds to this component. More...

unsafe NXOpen.Assemblies.Component	Parent `[get]`
	Returns the parent of the component. More...

unsafe string	ReferenceSet `[get]`
	Returns the name of the reference set used for this component More...

unsafe NXOpen.Assemblies.Subset	Subset `[get]`
	Returns the NXOpen.Assemblies.Subset that corresponds to this component. More...

unsafe NXOpen.Assemblies.Arrangement	SuppressingArrangement `[get]`
	Returns the NXOpen.Assemblies.Arrangement that controls this component's suppression state. More...

unsafe NXOpen.Assemblies.Arrangement	UsedArrangement `[get]`
	Returns the Arrangement used for this component. More...

Properties inherited from NXOpen.DisplayableObject
unsafe int	Color `[get, set]`
	Returns or sets the color of the object. More...

unsafe bool	IsBlanked `[get]`
	Returns the blank status of this object. More...

unsafe int	Layer `[get, set]`
	Returns or sets the layer that the object is in. More...

unsafe NXOpen.DisplayableObject.ObjectFont	LineFont `[get, set]`
	Returns or sets the line font of the object. More...

unsafe NXOpen.DisplayableObject.ObjectWidth	LineWidth `[get, set]`
	Returns or sets the line width of the object. More...

unsafe NXOpen.Point3d	NameLocation `[get]`
	Returns the location of the object's name. More...

Properties inherited from NXOpen.NXObject
unsafe bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

unsafe string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

unsafe string	Name `[get]`
	Returns the custom name of the object. More...

unsafe NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

unsafe NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

unsafe NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. More...

Properties inherited from NXOpen.INXObject
bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

string	Name `[get]`
	Returns the custom name of the object. More...

NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. More...

Detailed Description

Represents a component in a NXOpen.Assemblies.ComponentAssembly .

Note that a Component is an occurrence whose prototype is a NXOpen.Part . See NXOpen.NXObject.Prototype .

Components are arranged in a tree, with each component having a single parent, and one or more children. The top of the tree is the Root Component (see NXOpen.Assemblies.ComponentAssembly.RootComponent which has a a null reference (Nothing in Visual Basic) parent. The components below the root are referred to as "Top Level" components, which represent the component parts that have been added directly to the ComponentAssembly. (Calling NXOpen.Assemblies.ComponentAssembly.AddComponent will create a new Top Level component.) Components beneath the top level represent components defined in sub-assemblies of the main assembly.

Created in NX3.0.0

Member Enumeration Documentation

enum NXOpen.Assemblies.Component.RepresentationMode

Representation status of a component

Enumerator
Lightweight	The component's solid bodies are all displayed using the lightweight representation
Partial	The component's solid bodies are displayed with some being exact and some being shown lightweight
Exact	The component's solid bodies are displayed with the exact data
None	There are no bodies to display for the current component

Member Function Documentation

unsafe NXOpen.PartFamily.InstanceSelectionCriteria NXOpen.Assemblies.Component.CreateEmptyPartFamilyInstanceSelectionCriteria ( NXOpen.PartFamily.Template family )

Creates an empty NXOpen.PartFamily.InstanceSelectionCriteria

Created in NX9.0.0

License requirements: solid_modeling ("SOLIDS MODELING")

Parameters

family

Returns

unsafe void NXOpen.Assemblies.Component.DeleteCharacterstics ( NXOpen.Routing.CharacteristicList values )

Removes the input list of characteristics from this object.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

values

unsafe void NXOpen.Assemblies.Component.DeleteInstanceUserAttribute	(	NXOpen.NXObject.AttributeType	type,
		string	title,
		bool	deleteEntireArray,
		NXOpen.Update.Option	option
	)

Deletes the first attribute encountered with the given Type, Title and Index.

If a candidate attribute is not an array attribute, the DeleteEntireArray input is ignored, otherwise the last element of the array is deleted. NOTE: This method does not support the use of NXOpen.NXObject.AttributeType.Reference .

Created in NX8.0.0

License requirements: None.

Parameters

type
title
deleteEntireArray
option

unsafe void NXOpen.Assemblies.Component.DeleteInstanceUserAttributes	(	NXOpen.NXObject.AttributeType	type,
		NXOpen.Update.Option	option
	)

Deletes the attributes encountered with the given Type with option to update or not.

NOTE: This method does not support the use of NXOpen.NXObject.AttributeType.Reference .

Created in NX8.0.0

License requirements: None.

Parameters

type
option

unsafe void NXOpen.Assemblies.Component.DeletePartFamilyInstanceSelectionCriteria ( )

Deletes NXOpen.PartFamily.InstanceSelectionCriteria associated with this component

Created in NX9.0.0

License requirements: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.ErrorList NXOpen.Assemblies.Component.DisplayComponentsExact ( NXOpen.Assemblies.Component[] components )

Sets an array of components to display using the exact representation.

Created in NX7.5.0

License requirements: gateway ("UG GATEWAY")

Parameters

components Array of componets to be set to exact

Returns: list of errors encountered during the display as exact

unsafe NXOpen.ErrorList NXOpen.Assemblies.Component.DisplayComponentsLightweight ( NXOpen.Assemblies.Component[] components )

Sets an array of components to display using the lightweight representation.

Created in NX7.5.0

License requirements: gateway ("UG GATEWAY")

Parameters

components Array of components to be set to lightweight

Returns: list of errors encountered during the display as lightweight

unsafe void NXOpen.Assemblies.Component.EstablishIsolatedPositionOverride	(	NXOpen.Assemblies.Component	parent,
		NXOpen.Assemblies.Arrangement	arrangement
	)

Ensures there is an isolated positioning override for the NXOpen.Assemblies.Component in the given part of the given parent.

This method does nothing if the NXOpen.Assemblies.Component already has an isolated positioning override in the parent, or if any necessary data is unloaded.

If parent is a null reference (Nothing in Visual Basic), the isolated positioning override will be created in the same part as the NXOpen.Assemblies.Component .

Created in NX9.0.1

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

parent	The parent of the NXOpen.Assemblies.Component in which the override is to be created
arrangement	The NXOpen.Assemblies.Arrangement in which to create the isolated position override. This NXOpen.Assemblies.Arrangement must be an isolated NXOpen.Assemblies.Arrangement .

unsafe void NXOpen.Assemblies.Component.EstablishPositionOverride ( NXOpen.Assemblies.Component parent )

Ensures there is a positioning override on component in the given part of the given parent.

This method does nothing if the component already has a positioning override in the parent, or if any necessary data is unloaded.

If parent is a null reference (Nothing in Visual Basic), the positioning override will be created in the same part as the NXOpen.Assemblies.Component .

Created in NX7.5.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

parent The parent of the component in which the override is to be created

unsafe void NXOpen.Assemblies.Component.FindComponentPatterns	(	out NXOpen.Assemblies.ComponentPattern	patternDefinition,
		out NXOpen.Assemblies.ComponentPattern[]	patternDefinitions
	)

Finds NXOpen.Assemblies.ComponentPattern associated with this component.

De-allocation of memory used for list of pattern definitions is responsibility of user.

Created in NX10.0.2

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

patternDefinition	A Pattern which refers 'component' as one of its output instances
patternDefinitions	List of patterns which refer 'component' as its master component

unsafe NXOpen.NXObject NXOpen.Assemblies.Component.FindOccurrence ( NXOpen.NXObject proto )

Given a prototype object, returns the corresponding occurrence in this component

Created in NX3.0.0

License requirements: None.

Parameters

proto the prototype

Returns: the occurrence of the prototype in this component

unsafe void NXOpen.Assemblies.Component.GetArrangements ( out NXOpen.Assemblies.Arrangement[] arrangements )

Outputs the NXOpen.Assemblies.Arrangement objects within the NXOpen.Assemblies.Component .

They are output in alphabetic order.

Created in NX12.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

arrangements Alphabetically sorted arrangements

unsafe string NXOpen.Assemblies.Component.GetAsRequiredQuantity ( )

Gets the as-required quantity on this component.

Created in NX6.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns: As-Required string "A/R"

unsafe NXOpen.Routing.CharacteristicList NXOpen.Assemblies.Component.GetCharacteristics ( )

Get all of the characteristics values on the this object.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Returns

Implements NXOpen.Routing.ICharacteristic.

unsafe NXOpen.Assemblies.Component [] NXOpen.Assemblies.Component.GetChildren ( )

Returns the child components of this component However, it does not return non-geometric components (NGCs) To enable this method to also return NGCs, set the following environment variable: UGII_ALLOW_NGC_IN_UGOPEN=YES

Created in NX3.0.0

License requirements: None.

Returns

unsafe NXOpen.Assemblies.ComponentQuantity NXOpen.Assemblies.Component.GetComponentQuantityType ( )

Gets the quantity type of the components.

Returns NXOpen.Assemblies.ComponentQuantity .

Created in NX6.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns: Quantity type an enumeration value

unsafe NXOpen.Assemblies.Component.RepresentationMode NXOpen.Assemblies.Component.GetComponentRepresentationMode ( )

Returns the representation mode for the component's bodies.

This mode is dependent on the currently used reference set for the component.

Created in NX7.5.0

License requirements: None.

Returns: The mode for the components display. An enumeration value.

unsafe NXOpen.Positioning.ComponentConstraint [] NXOpen.Assemblies.Component.GetConstraints ( )

Returns the NXOpen.Positioning.ComponentConstraint s directly connected to this component.

If the part containing those constraints is not loaded then no constraints will be returned.

Created in NX5.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns: Constraints directly connected to this component

unsafe NXOpen.Assemblies.DegreesOfFreedom NXOpen.Assemblies.Component.GetDegreesOfFreedom ( )

Returns the NXOpen.Assemblies.DegreesOfFreedom for this component.

Any constraints that reference unloaded data are ignored in the degrees of freedom calculation. An example would be if a constraint was referencing geometry in an unloaded component. When this occurs there may be a greater number of degrees of freedom than if all the data were loaded.

Created in NX6.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns: The degrees of freedom of this component.

unsafe NXOpen.Assemblies.DegreesOfFreedom NXOpen.Assemblies.Component.GetDegreesOfFreedom ( NXOpen.Assemblies.Component[] components )

Returns the NXOpen.Assemblies.DegreesOfFreedom for this component.

The degrees of freedom are found relative to the components passed in. Those components are regarded as fixed and only constraints directly connecting this component with those in the array are considered.

Note that any directly connected constraints that reference unloaded data are ignored in the degrees of freedom calculation. An example would be if a constraint was referencing geometry in an unloaded component. When this occurs there may be a greater number of degrees of freedom than if all the data were loaded.

Created in NX6.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

components Components relative to which the degrees of freedom will be found.

Returns: The degrees of freedom of this component.

unsafe NXOpen.Routing.CharacteristicList NXOpen.Assemblies.Component.GetDestinationCharacteristics ( )

Returns the destination characteristics from the input object.

Retrieves the description of which destination characteristics to read from the application view and then reads those destination characteristics from the object

Ports: Reads characteristics from the port.
RCPs: Attempts to find a port at the RCP, reads characteristics from the port if it exists, otherwise reads from the stock associated with the rcp.
Segments: Reads characteristics from the stock associated with the segment.
Components: Reads characteristics directly from the component.
Stock: Reads characteristics from the stock or from the stock's data.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Returns

Implements NXOpen.Routing.ICharacteristic.

unsafe bool NXOpen.Assemblies.Component.GetInstanceBooleanUserAttribute	(	string	title,
		int	index
	)

Gets a boolean attribute by Title and array Index.

If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen.NXObject.GetUserAttributes .

Created in NX8.0.0

License requirements: None.

Parameters

title
index

Returns

unsafe int NXOpen.Assemblies.Component.GetInstanceIntegerUserAttribute	(	string	title,
		int	index
	)

Gets an integer attribute by Title and array Index.

If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen.NXObject.GetUserAttributes .

Created in NX8.0.0

License requirements: None.

Parameters

title
index

Returns

unsafe double NXOpen.Assemblies.Component.GetInstanceRealUserAttribute	(	string	title,
		int	index
	)

Gets a real attribute by Title and array Index.

If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen.NXObject.GetUserAttributes .

Created in NX8.0.0

License requirements: None.

Parameters

title
index

Returns

unsafe string NXOpen.Assemblies.Component.GetInstanceStringUserAttribute	(	string	title,
		int	index
	)

Gets a string attribute by Title and array Index.

For reference type string attributes, the calculated StringValue is returned. If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen.NXObject.GetUserAttributes . Gets a string attribute value by title.

Created in NX8.0.0

License requirements: None.

Parameters

title
index

Returns

unsafe string NXOpen.Assemblies.Component.GetInstanceTimeUserAttribute	(	string	title,
		int	index
	)

Gets a time attribute by Title and array Index.

The date format set by the Customer Defaults is used. If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen.NXObject.GetUserAttributes . Gets a time attribute by title.

Created in NX8.0.0

License requirements: None.

Parameters

title
index

Returns

unsafe NXOpen.NXObject.AttributeInformation NXOpen.Assemblies.Component.GetInstanceUserAttribute	(	string	title,
		NXOpen.NXObject.AttributeType	type,
		int	index
	)

Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.

If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen.NXObject.GetUserAttributes . The date format set by the Customer Defaults is used for attributes of type time. NOTE: This method does not support the use of NXOpen.NXObject.AttributeType.Reference . Instead, use NXOpen.NXObject.AttributeType.String . For reference type string attributes, both the ReferenceValue and the calculated StringValue are returned.

Created in NX8.0.0

License requirements: None.

Parameters

title
type
index

Returns

unsafe string NXOpen.Assemblies.Component.GetInstanceUserAttributeAsString	(	string	title,
		NXOpen.NXObject.AttributeType	type,
		int	index
	)

Gets the first attribute encountered on the object, if any, with a given title, type and array index.

The value of the attribute is converted to and returned as a string. If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time). The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen.NXObject.GetUserAttributesAsStrings . The date format set by the Customer Defaults is used for attributes of type time. NOTE: This method does not support the use of NXOpen.NXObject.AttributeType.Reference . Instead, use NXOpen.NXObject.AttributeType.String . For reference type string attributes, the calculated StringValue is returned.

Created in NX8.0.0

License requirements: None.

Parameters

title
type
index

Returns

unsafe bool NXOpen.Assemblies.Component.GetInstanceUserAttributeLock	(	string	title,
		NXOpen.NXObject.AttributeType	type
	)

Determine the lock of the given attribute.

For array attributes, the Title should be set to the array title, without the appended index. Individual array elements cannot be separately locked

Created in NX8.0.0

License requirements: None.

Parameters

title
type

Returns

unsafe NXOpen.NXObject.AttributeInformation [] NXOpen.Assemblies.Component.GetInstanceUserAttributes ( )

Gets all the attributes that have been set on the given object.

The elements of array attributes are returned individually in order of increasing indices. The returned Title of an array element is the array title (without index). The Index data member holds the index. The date format set by the Customer Defaults is used. Reference type attributes are returned as being of type NXOpen.NXObject.AttributeType.String , and both the ReferenceValue and the calculated StringValue are returned.

Created in NX8.0.0

License requirements: None.

Returns

unsafe NXOpen.NXObject.AttributeInformation [] NXOpen.Assemblies.Component.GetInstanceUserAttributes ( bool includeUnset )

Gets all the attributes that have been set on the given object, as well as information from attribute templates that have not been set (if 'IncludeUnset' is 'true').

The elements of array attributes are returned individually in order of increasing indices. The returned Title of an array element is the array title (without index). The Index data member holds the index. The date format set by the Customer Defaults is used. Reference type attributes are returnes as being of type NXOpen.NXObject.AttributeType.String , and both the ReferenceValue and the calculated StringValue are returned.

Created in NX8.0.0

License requirements: None.

Parameters

includeUnset

Returns

unsafe string [] NXOpen.Assemblies.Component.GetInstanceUserAttributesAsStrings ( )

Gets all the attributes that have been set on the given object.

The values are returned as strings. The elements of array attributes are returned individually in order of increasing indices. The returned Title of an array element is the array title (without index). The Index data member holds the index. This method does not support the use of NXOpen.NXObject.AttributeType.Reference . Reference type attributes return the calculated StringValue. The date format set by the Customer Defaults is used.

Created in NX8.0.0

License requirements: None.

Returns

unsafe int NXOpen.Assemblies.Component.GetIntegerCharacteristic ( string name )

Get the value of an integer characteristic associated with the input name.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

name

Returns

Implements NXOpen.Routing.ICharacteristic.

unsafe int NXOpen.Assemblies.Component.GetIntegerQuantity ( )

Gets the value of the integer quantity of component.

Created in NX6.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns: Integer quantity value

unsafe int NXOpen.Assemblies.Component.GetLayerOption ( )

Gets the layer option.

This controls which layer the component's geometry will appear on in its parent part.

Created in NX3.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns: The layer option of the component in its parent part -1 Means that the component's geometry has the layer settings defined in its orginal part 1-255 Means the components geometry is on the specified layer

unsafe bool NXOpen.Assemblies.Component.GetNonGeometricState ( )

Gets the component state as Geometric or Non-Geometric.

Created in NX6.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns: True if the component is non-geometric, false otherwise

unsafe NXOpen.PartFamily.InstanceSelectionCriteria NXOpen.Assemblies.Component.GetPartFamilyInstanceSelectionCriteria ( )

Obtains theNXOpen.PartFamily.InstanceSelectionCriteria , if it exists.

Created in NX9.0.0

License requirements: solid_modeling ("SOLIDS MODELING")

Returns

unsafe void NXOpen.Assemblies.Component.GetPosition	(	out NXOpen.Point3d	position,
		out NXOpen.Matrix3x3	orientation
	)

Gets the position of a component

Created in NX3.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

position	The origin of this component
orientation	The orientation of this component

unsafe NXOpen.Assemblies.Component NXOpen.Assemblies.Component.GetPositionOverrideParent ( )

Find the highest level parent in which the position of component is overridden.

This will be a null reference (Nothing in Visual Basic) if the component is not overridden. It will be the root component if the component is overridden in the same part as itself. It will be a null reference (Nothing in Visual Basic) if the position of the component is overridden in a parent assembly which is currently unloaded.

Created in NX7.5.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns

unsafe NXOpen.Assemblies.PositionOverrideType NXOpen.Assemblies.Component.GetPositionOverrideType ( )

Gets the type of the highest level positioning override on the component.

Created in NX7.5.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns

unsafe double NXOpen.Assemblies.Component.GetRealCharacteristic ( string name )

Get the value of a real characteristic associated with the input name.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

name

Returns

Implements NXOpen.Routing.ICharacteristic.

unsafe double NXOpen.Assemblies.Component.GetRealQuantity ( out string quantityUnits )

Gets the value of real quantity and corresponding units on this component.

Created in NX6.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns: Real quantity value

Parameters

quantityUnits Units

unsafe string NXOpen.Assemblies.Component.GetStringCharacteristic ( string name )

Get the value of a string characteristic associated with the input name.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

name

Returns

Implements NXOpen.Routing.ICharacteristic.

unsafe bool NXOpen.Assemblies.Component.HasInstanceUserAttribute	(	string	title,
		NXOpen.NXObject.AttributeType	type,
		int	index
	)

Determines if and attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

The first element of an array has Index 0 (zero). NOTE: This method does not support the use of NXOpen.NXObject.AttributeType.Reference . Instead, use NXOpen.NXObject.AttributeType.String .

Created in NX8.0.0

License requirements: None.

Parameters

title
type
index

Returns

unsafe bool NXOpen.Assemblies.Component.IsPositioningIsolated ( NXOpen.Assemblies.Arrangement arrangement )

Get whether positioning for the selected NXOpen.Assemblies.Component is isolated in the specified NXOpen.Assemblies.Arrangement .

Created in NX9.0.1

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

arrangement The specified NXOpen.Assemblies.Arrangement .

Returns: Whether positioning for the selected NXOpen.Assemblies.Component is isolated in the specified NXOpen.Assemblies.Arrangement .

unsafe NXOpen.Positioning.ComponentConstraint [] NXOpen.Assemblies.Component.RecallAndListConstraints ( )

Recalls the NXOpen.Positioning.ComponentConstraint s previously remembered on the part of this component, creating new constraints from them.

The new constraints are incomplete and refer to the component.

Created in NX5.0.1

License requirements: assemblies ("ASSEMBLIES MODULE")

Returns: The constraints created by the recall operation

unsafe void NXOpen.Assemblies.Component.RecallConstraints ( )

Recalls the NXOpen.Positioning.ComponentConstraint s previously remembered on the part of this component, creating new constraints from them.

The new constraints are incomplete and refer to the component.

Created in NX5.0.1

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe void NXOpen.Assemblies.Component.RemovePositionOverride ( NXOpen.Assemblies.Component parent )

Removes the highest level positioning override on component in or below the given parent.

parent may be a null reference (Nothing in Visual Basic), in which case the highest level positioning override on component is removed. This method does nothing if there is no positioning override on the component, or if any necessary data is unloaded.

Created in NX7.5.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

parent The parent of the component in or below which the override is to be removed

unsafe void NXOpen.Assemblies.Component.RemoveRememberedConstraints ( )

Remove all the remembered constraints stored on the part of this component.

Created in NX5.0.1

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe void NXOpen.Assemblies.Component.SetCharacteristic	(	string	name,
		int	value
	)

Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to integer if it's type is not integer.

Created in NX4.0.0

Deprecated in NX11.0.0. Use NXOpen.Routing.ICharacteristic.SetCharacteristic2 instead.

License requirements: routing_base ("Routing Basic")

Parameters

name
value

Implements NXOpen.Routing.ICharacteristic.

unsafe void NXOpen.Assemblies.Component.SetCharacteristic	(	string	name,
		double	value
	)

Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to real if it's type is not real.

Created in NX4.0.0

Deprecated in NX11.0.0. Use NXOpen.Routing.ICharacteristic.SetCharacteristic2 instead.

License requirements: routing_base ("Routing Basic")

Parameters

name
value

Implements NXOpen.Routing.ICharacteristic.

unsafe void NXOpen.Assemblies.Component.SetCharacteristic	(	string	name,
		string	value
	)

Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to string if it's type is not string.

Created in NX4.0.0

Deprecated in NX11.0.0. Use NXOpen.Routing.ICharacteristic.SetCharacteristic2 instead.

License requirements: routing_base ("Routing Basic")

Parameters

name
value

Implements NXOpen.Routing.ICharacteristic.

unsafe void NXOpen.Assemblies.Component.SetCharacteristic2	(	string	title,
		int	value
	)

Sets or creates an integer type attribute associated with the input title.

creating a new attribute if one doesn't exist already.

If the method is called on a stock Assemblies.Component , the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.

If the method is called on a non-stock Assemblies.Component , the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create an attribute on the object itself.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

title	Unique title for the Attribute or Characteristic
value	New Value to be set on the Attribute

Implements NXOpen.Routing.ICharacteristic.

unsafe void NXOpen.Assemblies.Component.SetCharacteristic2	(	string	title,
		double	value
	)

Sets or creates a double type attribute associated with the input title.

creating a new attribute if one doesn't exist already.

If the method is called on a stock Assemblies.Component , the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.

If the method is called on a non-stock Assemblies.Component , the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create an attribute on the object itself.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

title	Unique title for the Attribute or Characteristic
value	New Value to be set on the Attribute

Implements NXOpen.Routing.ICharacteristic.

unsafe void NXOpen.Assemblies.Component.SetCharacteristic2	(	string	title,
		string	value
	)

Sets or creates a string type type attribute associated with the input title.

creating a new attribute if one doesn't exist already.

If the method is called on a stock Assemblies.Component , the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.

If the method is called on a non-stock Assemblies.Component , the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create an attribute on the object itself.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

title	Unique title for the Attribute or Characteristic
value	New Value to be set on the Attribute

Implements NXOpen.Routing.ICharacteristic.

unsafe void NXOpen.Assemblies.Component.SetCharacteristics ( NXOpen.Routing.CharacteristicList values )

Set all of the characteristics values on this object.

Created in NX4.0.0

Deprecated in NX11.0.0. Use NXOpen.Routing.ICharacteristic.SetCharacteristics2 instead.

License requirements: routing_base ("Routing Basic")

Parameters

values

unsafe void NXOpen.Assemblies.Component.SetCharacteristics2 ( NXOpen.Routing.CharacteristicList values )

Sets all attributes associated with the titles from the input list, creating new attributes for the ones that don't exist already.

If the method is called on a stock Assemblies.Component , the method will create or edit part attributes on the stock part. For legacy parts where the attributes are on the stock component, the attributes will be moved to the stock part.

If the method is called on a non-stock Assemblies.Component , the method will create or edit attributes on the corresponding instance. For legacy parts where the attribute is on the component, the attributes will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create attributes on the object itself.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

values NXOpen.Routing.CharacteristicList having the titles, types and values of Attributes to be set

unsafe void NXOpen.Assemblies.Component.SetInstanceBooleanUserAttribute	(	string	title,
		int	index,
		bool	value,
		NXOpen.Update.Option	option
	)

Creates or modifies a boolean attribute with the option to update or not.

Created in NX8.0.0

License requirements: None.

Parameters

title
index
value
option

unsafe void NXOpen.Assemblies.Component.SetInstanceTimeUserAttribute	(	string	title,
		int	index,
		string	value,
		NXOpen.Update.Option	option
	)

Creates or modifies a time attribute with the option to update or not.

The time value is assumed to be in the current time zone of the machine running the program. NX will store the value in UTC.

Created in NX8.0.0

License requirements: None.

Parameters

title
index
value	The current date and time is used if the value is a null reference (Nothing in Visual Basic). See NXOpen.NXObject.DateAndTimeFormat for valid formats.
option

unsafe void NXOpen.Assemblies.Component.SetInstanceUserAttribute	(	NXOpen.NXObject.AttributeInformation	info,
		NXOpen.Update.Option	option
	)

Creates or modifies an attribute with the option to update or not.

NOTE: This method does not support the use of NXOpen.NXObject.AttributeType.Reference . Instead, set the type to NXOpen.NXObject.AttributeType.String and specify a ReferenceValue.

The following data members of the Info structure are ignored by this method: Alias Inherited Required Unset Locked

The following data members of an attribute cannot be edited once the attribute is set: Type Title TitleAlias Array ArrayElementIndex The dimensionality of the Unit specification (cannot change from mm to microA, but from mm to cm is fine)

The following data members can be set and modified only if the attribute is not associated with a template: Category

The following data of an attribute can be set if and only if the attribute is not associated with a template. It cannot be modified once set. Array

Created in NX8.0.0

License requirements: None.

Parameters

info
option

unsafe void NXOpen.Assemblies.Component.SetInstanceUserAttribute	(	string	title,
		int	index,
		int	value,
		NXOpen.Update.Option	option
	)

Creates or modifies an integer attribute with the option to update or not.

Created in NX8.0.0

License requirements: None.

Parameters

title
index
value
option

unsafe void NXOpen.Assemblies.Component.SetInstanceUserAttribute	(	string	title,
		int	index,
		double	value,
		NXOpen.Update.Option	option
	)

Creates or modifies a real attribute with the option to update or not.

Created in NX8.0.0

License requirements: None.

Parameters

title
index
value
option

unsafe void NXOpen.Assemblies.Component.SetInstanceUserAttribute	(	string	title,
		int	index,
		string	value,
		NXOpen.Update.Option	option
	)

Creates or modifies a string attribute with the option to update or not.

Created in NX8.0.0

License requirements: None.

Parameters

title
index
value
option

unsafe void NXOpen.Assemblies.Component.SetInstanceUserAttribute	(	string	title,
		int	index,
		NXOpen.Update.Option	option
	)

Creates or modifies a null attribute with the option to update or not.

Created in NX8.0.0

License requirements: None.

Parameters

title
index
option

unsafe void NXOpen.Assemblies.Component.SetInstanceUserAttributeLock	(	string	title,
		NXOpen.NXObject.AttributeType	type,
		bool @	lock
	)

Lock or unlock the given attribute.

For array attributes, the Title should be set to the array title, without the appended index. Individual array elements cannot be separately locked

Created in NX8.0.0

License requirements: None.

Parameters

title
type
lock

unsafe void NXOpen.Assemblies.Component.SetLayerOption ( int layer )

Sets the layer option.

This controls which layer the component's geometry will appear on in its parent part.

Created in NX3.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

layer The new layer for this component in its parent part -1 Means use the original layer settings defined in the component's part. 0 Means use the current work layer 1-255 Means use the specified layer.

unsafe void NXOpen.Assemblies.Component.SetPartFamilyInstanceSelectionCriteria ( NXOpen.PartFamily.InstanceSelectionCriteria selectionCriteria )

Hooks NXOpen.PartFamily.InstanceSelectionCriteria to this component

Created in NX9.0.0

License requirements: solid_modeling ("SOLIDS MODELING")

Parameters

selectionCriteria

unsafe void NXOpen.Assemblies.Component.SetPositioningIsolated ( NXOpen.Assemblies.Arrangement arrangement )

Set positioning for the selected NXOpen.Assemblies.Component as isolated in the specified NXOpen.Assemblies.Arrangement .

The arrangement must be an isolated arrangement defined in the same part as the component.

Created in NX9.0.1

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

arrangement The NXOpen.Assemblies.Arrangement in which to set positioning as isolated. This NXOpen.Assemblies.Arrangement must be an isolated NXOpen.Assemblies.Arrangement .

unsafe void NXOpen.Assemblies.Component.SetPositioningVaried	(	NXOpen.Assemblies.Component[]	components,
		bool	setAsVaried
	)

Set positioning for the selected NXOpen.Assemblies.Component s across all possible NXOpen.Assemblies.Arrangement s.

Positioning can be set to either the same in all NXOpen.Assemblies.Arrangement s, set_as_varied = FALSE, or individually positioned in each, set_as_varied = TRUE.

Created in NX7.5.2

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

components	The components whose positioning will be altered.
setAsVaried	If FALSE components will have same position in all NXOpen.Assemblies.Arrangement s, TRUE allows the position to be varied.

unsafe void NXOpen.Assemblies.Component.SetUsedArrangement ( NXOpen.Assemblies.Arrangement newArrangement )

Changes the Arrangement used for this component.

If this is the root component (i.e. it has no parent) then this is equivalent to setting the active arrangement in the owner. (See NXOpen.Assemblies.Component.DirectOwner and NXOpen.Assemblies.ComponentAssembly.ActiveArrangement .) For non-root components, this sets the arrangement used for this component in the context of its parent component. Note that this method should only be used for components which have children.

Created in NX3.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

newArrangement The new NXOpen.Assemblies.Arrangement . This Arrangement must be defined in a the ComponentAssembly of this Component's prototype part.

unsafe void NXOpen.Assemblies.Component.Suppress ( )

Suppresses the component in the ComponentAssembly that contains its controlling Arrangement.

The component will be suppressed in all Arrangements in the ComponentAssembly, not just in the controlling arrangement.

This is equivalent to calling:

NXOpen.Assemblies.Component.SuppressingArrangement

NXOpen.Assemblies.Arrangement.Owner

NXOpen.Assemblies.ComponentAssembly.SuppressComponents

Created in NX3.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe NXOpen.ErrorList NXOpen.Assemblies.Component.Suppress ( NXOpen.Assemblies.Component[] components )

Suppresses an array of components in the ComponentAssembly that contains their controlling Arrangement.

The component will be suppressed in all Arrangements in the ComponentAssembly.

This is equivalent to calling:

NXOpen.Assemblies.Component.SuppressingArrangement

NXOpen.Assemblies.Arrangement.Owner

And then calling

NXOpen.Assemblies.ComponentAssembly.SuppressComponents

on the component array. Note that all components should have the same suppressing Arrangement.

Created in NX3.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

components Components to be suppressed. Each component will be suppressed in its controlling arrangement. Note that the components must all be underneath the same assembly

Returns: list of errors encountered during the suppress

unsafe void NXOpen.Assemblies.Component.Unsuppress ( )

Unsuppresses the component in the ComponentAssembly that contains its controlling Arrangement.

The component will be unsuppressed in all Arrangements in the ComponentAssembly.

This is equivalent to calling:

NXOpen.Assemblies.Component.SuppressingArrangement

NXOpen.Assemblies.Arrangement.Owner

NXOpen.Assemblies.ComponentAssembly.UnsuppressComponents

Created in NX3.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe NXOpen.ErrorList NXOpen.Assemblies.Component.Unsuppress ( NXOpen.Assemblies.Component[] components )

Unsuppresses an array of components in the ComponentAssembly that contains their controlling Arrangement.

The component will be unsuppressed in all Arrangements in the ComponentAssembly. This is equivalent to calling:

NXOpen.Assemblies.Component.SuppressingArrangement

NXOpen.Assemblies.Arrangement.Owner

NXOpen.Assemblies.ComponentAssembly.UnsuppressComponents

on the component array. Note that all components should have the same suppressing Arrangement.

Created in NX3.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

Parameters

components Components to be unsuppressed. Each component will be unsuppressed in its controlling arrangement. Note that the components must all be underneath the same assembly

Returns: list of errors encountered during the unsuppress

unsafe void NXOpen.Assemblies.Component.UpdateStructure	(	NXOpen.Assemblies.Component[]	components,
		int	nLevels
	)

Update the assembly structure for this assembly in the context of the displayed part to the specified number of levels, ignoring components already processed by previous calls.

Created in NX4.0.0

License requirements: gateway ("UG GATEWAY")

Parameters

components	Component tags to start update structure from
nLevels	The number of levels to update. If -1 then all levels are updated.

unsafe void NXOpen.Assemblies.Component.UpdateStructure	(	NXOpen.Assemblies.Component[]	components,
		int	nLevels,
		bool	checkComponentsVisited
	)

Update the assembly structure for this assembly in the context of the displayed part to the specified number of levels.

Created in NX4.0.1

License requirements: gateway ("UG GATEWAY")

Parameters

components	Component tags to start update structure from
nLevels	The number of levels to update. If -1 then all levels are updated.
checkComponentsVisited	If true, only perform update structure on each component once this session.

Property Documentation

unsafe NXOpen.Assemblies.CollaborativeContentType NXOpen.Assemblies.Component.CollaborativeContentType

get

Returns the collaborative content type of this component.

Created in NX8.5.0

License requirements: None.

unsafe NXOpen.PDM.DesignElementRevision NXOpen.Assemblies.Component.DesignElementRevision

get

Returns the NXOpen.PDM.DesignElementRevision that corresponds to this component.

This can be a null reference (Nothing in Visual Basic) if the component is not a design element. This will return parent reuse design element revision if this component represent a NXOpen.PDM.DesignSubordinateRevision .

Created in NX8.5.0

Deprecated in NX11.0.0. Use NXOpen.Assemblies.Component.ModelElementRevision instead.

License requirements: None.

unsafe NXOpen.PDM.DesignSubordinateRevision NXOpen.Assemblies.Component.DesignSubordinateRevision

get

Returns the NXOpen.PDM.DesignSubordinateRevision that corresponds to this component.

This can be a null reference (Nothing in Visual Basic) if the component is not a subordinate design element.

Created in NX8.5.0

License requirements: None.

unsafe NXOpen.Assemblies.ComponentAssembly NXOpen.Assemblies.Component.DirectOwner

get

Returns the NXOpen.Assemblies.ComponentAssembly which owns this component as a "Top Level" component.

For components in a multi-level assembly, this is NOT the same the part that owns this component object. I.e. it is not the same as calling:

<see cref="NXOpen.NXObject.OwningPart"> NXOpen.NXObject.OwningPart </see>()

<see cref="NXOpen.BasePart.ComponentAssembly"> NXOpen.BasePart.ComponentAssembly </see>()

Created in NX3.0.0

License requirements: None.

unsafe string NXOpen.Assemblies.Component.DisplayName

get

Returns the displayable name of the prototype part.

Created in NX4.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe string NXOpen.Assemblies.Component.EmptyPartRefsetName

get

Returns the name of the reference set which represents the empty set.

This can be used as a parameter to NXOpen.Assemblies.ComponentAssembly.ReplaceReferenceSet .

Created in NX3.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe string NXOpen.Assemblies.Component.EntirePartRefsetName

get

Returns the name of the reference set which represents the entire part.

This can be used as a parameter to NXOpen.Assemblies.ComponentAssembly.ReplaceReferenceSet .

Created in NX3.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe NXOpen.Positioning.ComponentConstraint NXOpen.Assemblies.Component.FixConstraint

get

Returns a fix NXOpen.Positioning.ComponentConstraint of this component.

The constraint may be suppressed or a null reference (Nothing in Visual Basic). If the part controlling the position of this component is not loaded then a null reference (Nothing in Visual Basic) will be returned.

Created in NX5.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe bool NXOpen.Assemblies.Component.IsFixed

get

Returns the fixed state of this component.

True if there is an unsuppressed NXOpen.Positioning.ComponentConstraint fix constraint on this component and false otherwise. If the part controlling the position of this component is not loaded then false will be returned.

Created in NX5.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe bool NXOpen.Assemblies.Component.IsSuppressed

get

Returns the suppressed state of the component in its controlling arrangement.

(See NXOpen.Assemblies.Component.SuppressingArrangement .)

Created in NX3.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe NXOpen.PDM.ModelElementRevision NXOpen.Assemblies.Component.ModelElementRevision

get

Returns the NXOpen.PDM.ModelElementRevision that corresponds to this component.

This can be a null reference (Nothing in Visual Basic) if the component is not a model element. This will return parent reuse design element revision if this component represent a NXOpen.PDM.DesignSubordinateRevision . If component is independent design feature then this will return NXOpen.PDM.DesignFeatureRevision .

Created in NX10.0.2

License requirements: None.

unsafe NXOpen.Assemblies.Component NXOpen.Assemblies.Component.Parent

get

Returns the parent of the component.

For the root component of an assembly, this will be a null reference (Nothing in Visual Basic). See NXOpen.Assemblies.ComponentAssembly.RootComponent .

Created in NX3.0.0

License requirements: None.

unsafe string NXOpen.Assemblies.Component.ReferenceSet

get

Returns the name of the reference set used for this component

Created in NX3.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe NXOpen.Assemblies.Subset NXOpen.Assemblies.Component.Subset

get

Returns the NXOpen.Assemblies.Subset that corresponds to this component.

This can be a null reference (Nothing in Visual Basic) if the component is not a subset.

Created in NX8.5.0

License requirements: None.

unsafe NXOpen.Assemblies.Arrangement NXOpen.Assemblies.Component.SuppressingArrangement

get

Returns the NXOpen.Assemblies.Arrangement that controls this component's suppression state.

The controlling Arrangement will be defined in a NXOpen.Assemblies.ComponentAssembly in the tree above this Component.

Note: In the current release, Arrangements are only used for controlling a component's suppression state. In future releases, further attributes will be controlled via Arrangements.

Created in NX3.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

unsafe NXOpen.Assemblies.Arrangement NXOpen.Assemblies.Component.UsedArrangement

get

Returns the Arrangement used for this component.

See NXOpen.Assemblies.Component.SetUsedArrangement

Created in NX3.0.0

License requirements: assemblies ("ASSEMBLIES MODULE")

The documentation for this class was generated from the following file:

dotnet_pool/Assemblies_Component.cs

Public Types

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation