A base class providing low-level services for most NXOpen classes. More...

Inheritance diagram for NXOpen.NXObject:

Classes
struct	_AttributeInformation
	Contains attribute information.

struct	AttributeInformation
	Contains attribute information. More...

struct	ComputationalTime
	Holds the computational time value of a time attribute. More...

Public Types
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 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...

Properties
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

A base class providing low-level services for most NXOpen classes.

For more information on NX rules for Names and Attributes, see the Properties section of the Gateway Help.

This is an abstract class, and cannot be instantiated.

Created in NX3.0.0

Member Enumeration Documentation

enum NXOpen.NXObject.AttributeType

Specifies attribute type.

NOTE: Attributes of type reference are also string attributes. The reference type as such is deprecated.

Enumerator
Invalid	Invalid
Null	Null
Boolean	Boolean
Integer	Integer
Real	Real
String	String
Time	Time and Date
Reference	Deprecated. Do not use in new code. Previously used to denote string attributes holding a ReferenceValue
Any	All types (used only for queries)

enum NXOpen.NXObject.DateAndTimeFormat

Specifies the format of the date and time attribute.

Enumerator
Numeric	2004/04/28 22:06:15
Textual	28-Apr-2004 22:06:15

Member Function Documentation

unsafe NXOpen.AttributeIterator NXOpen.NXObject.CreateAttributeIterator ( )

Create an attribute iterator

Created in NX11.0.0

License requirements: None.

Returns: A new attribute iterator object

unsafe void NXOpen.NXObject.DeleteAllAttributesByType ( NXOpen.NXObject.AttributeType type )

Deletes all attributes of a specific type.

This method performs an immediate update except when the object is a NXOpen.Features.Feature . If a candidate attribute is an array attribute, this method will delete all the array elements. NOTE: If the input specifies reference type, then this function will delete string type non-array attributes that have a reference value. The reference type is used only to single out string type non-array attributes that contain a reference value. The use of reference type in this function is deprecated. Please use string type instead.

Created in NX3.0.0

Deprecated in NX8.0.0. Use DeleteUserAttributes instead.

License requirements: None.

Parameters

type

unsafe void NXOpen.NXObject.DeleteAllAttributesByType	(	NXOpen.NXObject.AttributeType	type,
		NXOpen.Update.Option	option
	)

Deletes all attributes of a specific type with the option to update or not.

If a candidate attribute is an array attribute, this method will delete all the array elements. NOTE: If the input specifies reference type, then this function will delete string type non-array attributes that have a reference value. The reference type is used only to single out string type non-array attributes that contain a reference value. The use of reference type in this function is deprecated. Please use string type instead.

Created in NX5.0.1

Deprecated in NX8.0.0. Use DeleteUserAttributes instead.

License requirements: None.

Parameters

type
option

unsafe void NXOpen.NXObject.DeleteAttributeByTypeAndTitle	(	NXOpen.NXObject.AttributeType	type,
		string	title
	)

Deletes an attribute by type and title.

This method performs an immediate update except when the object is a NXOpen.Features.Feature . If a candidate attribute is an array attribute, this method will delete all the array elements. NOTE: If the input specifies reference type, then this function will delete string type attributes that have a reference value. The reference type is used only to single out string type attributes that contain a reference value. The use of reference type in this function is discouraged.

Created in NX3.0.0

Deprecated in NX8.0.0. Use DeleteUserAttribute instead.

License requirements: None.

Parameters

type
title

unsafe void NXOpen.NXObject.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.

If a candidate attribute is an array attribute, this method will delete all the array elements. NOTE: If the input specifies reference type, then this function will delete string type attributes that have a reference value. The reference type is used only to single out string type attributes that contain a reference value. The use of reference type in this function is discouraged.

Created in NX5.0.1

Deprecated in NX8.0.0. Use DeleteUserAttribute instead.

License requirements: None.

Parameters

type
title
option

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

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

If a candidate attribute is not an array attribute, the DeleteEntireArray input is ignored, If a candidate attribute is an array attribute and DeleteEntireArray input is 'false', then the last element of the array is deleted. If a candidate attribute is an array attribute and DeleteEntireArray input is 'true', then the entire 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.NXObject.DeleteUserAttributes	(	NXOpen.AttributeIterator	iterator,
		NXOpen.Update.Option	option
	)

Deletes the attributes on the object, if any, that satisfy the given iterator

Created in NX8.0.0

License requirements: None.

Parameters

iterator	NXOpen.AttributeIterator
option

unsafe void NXOpen.NXObject.DeleteUserAttributes	(	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 NXOpen.INXObject NXOpen.NXObject.FindObject ( string journalIdentifier )

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Created in NX3.0.0

License requirements: None.

Parameters

journalIdentifier Journal identifier of the object

Returns

Implements NXOpen.INXObject.

unsafe NXOpen.NXObject.AttributeInformation [] NXOpen.NXObject.GetAttributeTitlesByType ( NXOpen.NXObject.AttributeType type )

Gets all the attribute titles of a specific type.

Only Title and Type are set in the returned struct. No values are returned. Array attributes are supported. The Title returned is the array title, with no index appended. Only one title is returned per array. This function does not return the titles of unset attributes. NOTE: If the input specifies reference type, then this function will get string type attributes that have a reference value. The reference type is used only to single out string type attributes that contain a reference value. The use of reference type in this function is deprecated. Please use string type instead.

Created in NX3.0.0

Deprecated in NX8.0.0. Use GetUserAttributes instead.

License requirements: None.

Parameters

type

Returns

unsafe bool NXOpen.NXObject.GetBooleanUserAttribute	(	string	title,
		int	index
	)

Gets a boolean attribute by Title and array Index.

This function will not look for unset attributes. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. 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 NXOpen.NXObject.ComputationalTime NXOpen.NXObject.GetComputationalTimeUserAttribute	(	string	title,
		int	index
	)

Gets a time attribute by Title and array Index.

The time value returned will be in the current time zone of the machine running the program. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. 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.5.2

License requirements: None.

Parameters

title
index

Returns: The time in the local time zone

unsafe int NXOpen.NXObject.GetIntegerAttribute ( string title )

Gets an integer attribute by title.

This method does not support array attributes.

Created in NX3.0.0

Deprecated in NX8.0.0. Use GetUserAttribute instead.

License requirements: None.

Parameters

title

Returns

unsafe int NXOpen.NXObject.GetIntegerUserAttribute	(	string	title,
		int	index
	)

Gets an integer attribute by Title and array Index.

This function will not look for unset attributes. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. 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 bool NXOpen.NXObject.GetNextUserAttribute	(	NXOpen.AttributeIterator	iterator,
		out NXOpen.NXObject.AttributeInformation	info
	)

Gets the next attribute encountered on the object, if any, that satisfies the given iterator.

Created in NX11.0.0

License requirements: None.

Parameters

iterator	NXOpen.AttributeIterator
info

Returns

unsafe string NXOpen.NXObject.GetPdmReferenceAttributeValue ( string attributeTitle )

Gets the value of PDM Reference attribute for given object.

User should provide attribute title and displayed value will be returned.

Created in NX12.0.0

License requirements: None.

Parameters

attributeTitle

Returns

unsafe double NXOpen.NXObject.GetRealAttribute ( string title )

Gets a real attribute by title.

This method does not support array attributes.

Created in NX3.0.0

Deprecated in NX8.0.0. Use GetUserAttribute instead.

License requirements: None.

Parameters

title

Returns

unsafe double NXOpen.NXObject.GetRealUserAttribute	(	string	title,
		int	index
	)

Gets a real attribute by Title and array Index.

This function will not look for unset attributes. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. 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.NXObject.GetReferenceAttribute ( string title )

Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

Get the attribute by title. For the calculated value, please use NXOpen.NXObject.GetUserAttribute This method does not support array attributes.

Created in NX3.0.0

Deprecated in NX8.0.0. Use GetUserAttribute instead.

License requirements: None.

Parameters

title

Returns

unsafe string NXOpen.NXObject.GetStringAttribute ( string title )

Gets a string attribute value by title.

For string attributes that use reference strings, this function returns the calculated value, not the reference string. This method does not support array attributes.

Created in NX3.0.0

Deprecated in NX8.0.0. Use GetUserAttribute instead.

License requirements: None.

Parameters

title

Returns

unsafe string NXOpen.NXObject.GetStringUserAttribute	(	string	title,
		int	index
	)

Gets a string attribute by Title and array Index.

For reference type string attributes, the calculated StringValue is returned. This function will not look for unset attributes. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. 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.NXObject.GetTimeAttribute	(	NXOpen.NXObject.DateAndTimeFormat	format,
		string	title
	)

Gets a time attribute by title.

The time returned will be in the current time zone of the machine running the program. This method does not support array attributes. This method is deprecated.

Created in NX3.0.0

Deprecated in NX8.0.0. Use GetUserAttribute instead.

License requirements: None.

Parameters

format
title

Returns

unsafe string NXOpen.NXObject.GetTimeUserAttribute	(	string	title,
		int	index
	)

Gets a time attribute by Title and array Index.

The date format set by the Customer Defaults is used. The time value returned is in the current time zone of the machine running the program. This function will not look for unset attributes. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. The first element of an array has Index 0 (zero). To get all the array elements of an array, please use NXOpen.NXObject.GetUserAttributes . NOTE: The returned string must be deleted by the caller

Created in NX8.0.0

License requirements: None.

Parameters

title
index

Returns

unsafe NXOpen.NXObject.AttributeInformation NXOpen.NXObject.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.

This function will return data for unset attributes. For non-string attribute types, the string-converted value is returned as well for convenience. If the attribute to be found is not an array, set the Index to -1, otherwise set it to the desired index. If an unset attribute is read, then the index returned has no meaning. 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 NXOpen.NXObject.AttributeInformation [] NXOpen.NXObject.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.

This function will optionally return data for unset attributes. For non-string attribute types, the string-converted value is returned as well for convenience. If the attribute cannot be found, but a template is found, then a single struct is returned with information from the template. If neither an attribute nor a template can be found, then no struct is returned (a null reference (Nothing in Visual Basic))). If a non-array attribute is found, a single struct is returned with information from that attribute. If an array attribute is found, then an array of structs is returned with information from each of the array elements of the attribute. Array elements are returned in order of increasing indices. The first element of an array has Index 0 (zero). 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 NX10.0.0

Deprecated in NX11.0.0. Use GetUserAttribute instead.

License requirements: None.

Parameters

title
includeUnset
addStringValues
type

Returns

unsafe string NXOpen.NXObject.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.

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.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, the calculated StringValue is returned.

Created in NX8.0.0

License requirements: None.

Parameters

title
type
index

Returns

unsafe int NXOpen.NXObject.GetUserAttributeCount ( NXOpen.AttributeIterator iterator )

Gets the count of set attributes on the object, if any, that satisfy the given iterator.

Array elements are counted individually.

Created in NX11.0.0

License requirements: None.

Parameters

iterator NXOpen.AttributeIterator

Returns

unsafe int NXOpen.NXObject.GetUserAttributeCount	(	NXOpen.AttributeIterator	iterator,
		bool	countArrayAsOneAttribute
	)

Gets the count of set attributes on the object, if any, that satisfy the given iterator.

Array elements are optionally counted individually.

Created in NX11.0.0

License requirements: None.

Parameters

iterator	NXOpen.AttributeIterator
countArrayAsOneAttribute

Returns

unsafe int NXOpen.NXObject.GetUserAttributeCount ( NXOpen.NXObject.AttributeType type )

Gets the count of set attributes on the object, if any, of the given type.

Will not include unset attributes. Array elements are counted individually.

Created in NX10.0.0

License requirements: None.

Parameters

type

Returns

unsafe int NXOpen.NXObject.GetUserAttributeCount	(	NXOpen.NXObject.AttributeType	type,
		bool	includeUnset,
		bool	countArrayAsOneAttribute
	)

Gets the count of attributes on the object, if any, of the given type.

Includes option to include unset attributes (i.e. to count attribute templates with no associated attributes). Includes option to count arrays as one attribute or to count array elements individually. NOTE: This method does not support the use of NXOpen.NXObject.AttributeType.Reference . Instead, use NXOpen.NXObject.AttributeType.String .

Created in NX10.0.0

License requirements: None.

Parameters

type
includeUnset
countArrayAsOneAttribute

Returns

unsafe bool NXOpen.NXObject.GetUserAttributeLock	(	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.NXObject.GetUserAttributes ( NXOpen.AttributeIterator iterator )

Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.

The results will not include information from associated attribute templates of unset attributes. 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 NX11.0.0

License requirements: None.

Parameters

iterator NXOpen.AttributeIterator

Returns

unsafe NXOpen.NXObject.AttributeInformation [] NXOpen.NXObject.GetUserAttributes ( )

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

The results will not include information from associated attribute templates of unset attributes. 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.NXObject.GetUserAttributes ( bool includeUnset )

Gets all the attributes of the given object.

Includes option to return information also from associated attribute templates of unset attributes. The values returned for unset attributes are the default values from the templates. 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 NXOpen.NXObject.AttributeInformation [] NXOpen.NXObject.GetUserAttributes	(	bool	includeUnset,
		bool	addStringValues
	)

Gets all the attributes of the given object.

Includes option to return information also from associated attribute templates of unset attributes. The values returned for unset attributes are the default values from the templates. Includes an option to return the value not only in the natural type, but also converted to a string (effective only for non-string attributes). 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.5.0

Deprecated in NX11.0.0. Use GetUserAttributes instead.

License requirements: None.

Parameters

includeUnset
addStringValues

Returns

unsafe string [] NXOpen.NXObject.GetUserAttributesAsStrings ( )

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. Reference type attributes return the calculated StringValue. The date format set by the Customer Defaults is used.

Created in NX8.0.0

Deprecated in NX8.5.0. Use GetUserAttributes instead.

License requirements: None.

Returns

unsafe int NXOpen.NXObject.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.

For unset attributes (with or without templates), the returned size will be 0. For non-array set attributes, the returned size will be 1. For array attributes, the returned size will be the count of array elements that have been set. NOTE: This method does not support the use of NXOpen.NXObject.AttributeType.Reference . Instead, use NXOpen.NXObject.AttributeType.String .

Created in NX10.0.0

License requirements: None.

Parameters

title
type

Returns

unsafe NXOpen.NXObject [] NXOpen.NXObject.GetUserAttributeSourceObjects ( )

Returns an array of objects from which this object presents attributes.

The order of the array is in inheritance order so earlier objects may be able to override objects at higher indices in the array allowing for the rules set up for the particular attributes involved. If this object itself can own attributes it will also be in the array.

Created in NX8.5.0

License requirements: None.

Returns

unsafe bool NXOpen.NXObject.HasUserAttribute ( NXOpen.AttributeIterator iterator )

Determines if an attribute exists on the object, that satisfies the given iterator

Created in NX11.0.0

License requirements: None.

Parameters

iterator NXOpen.AttributeIterator

Returns

unsafe bool NXOpen.NXObject.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.

If the attribute to be found is not an array, set the index to -1, otherwise set it to the desired index. 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 void NXOpen.NXObject.Print ( )

Prints a representation of this object to the system log file.

Created in NX3.0.0

License requirements: None.

Implements NXOpen.INXObject.

unsafe void NXOpen.NXObject.SetAttribute	(	string	title,
		int	value
	)

Creates or modifies an integer attribute.

This method performs an immediate update except when the object is a NXOpen.Features.Feature . This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX3.0.0

Deprecated in NX8.0.0. Use SetUserAttribute instead.

License requirements: None.

Parameters

title
value

unsafe void NXOpen.NXObject.SetAttribute	(	string	title,
		int	value,
		NXOpen.Update.Option	option
	)

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

This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX5.0.1

Deprecated in NX8.0.0. Use SetUserAttribute instead.

License requirements: None.

Parameters

title
value
option

unsafe void NXOpen.NXObject.SetAttribute	(	string	title,
		double	value
	)

Creates or modifies a real attribute.

This method performs an immediate update except when the object is a NXOpen.Features.Feature . This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX3.0.0

Deprecated in NX8.0.0. Use SetUserAttribute instead.

License requirements: None.

Parameters

title
value

unsafe void NXOpen.NXObject.SetAttribute	(	string	title,
		double	value,
		NXOpen.Update.Option	option
	)

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

This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX5.0.1

Deprecated in NX8.0.0. Use SetUserAttribute instead.

License requirements: None.

Parameters

title
value
option

unsafe void NXOpen.NXObject.SetAttribute	(	string	title,
		string	value
	)

Creates or modifies a string attribute.

This method performs an immediate update except when the object is a NXOpen.Features.Feature . This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX3.0.0

Deprecated in NX8.0.0. Use SetUserAttribute instead.

License requirements: None.

Parameters

title
value

unsafe void NXOpen.NXObject.SetAttribute	(	string	title,
		string	value,
		NXOpen.Update.Option	option
	)

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

This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX5.0.1

Deprecated in NX8.0.0. Use SetUserAttribute instead.

License requirements: None.

Parameters

title
value
option

unsafe void NXOpen.NXObject.SetAttribute ( string title )

Creates or modifies a null attribute which is an attribute with a title and no value.

This method performs an immediate update except when the object is a NXOpen.Features.Feature . This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX3.0.0

Deprecated in NX8.0.0. Use SetUserAttribute instead.

License requirements: None.

Parameters

title

unsafe void NXOpen.NXObject.SetAttribute	(	string	title,
		NXOpen.Update.Option	option
	)

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

This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX5.0.1

Deprecated in NX8.0.0. Use SetUserAttribute instead.

License requirements: None.

Parameters

title
option

unsafe void NXOpen.NXObject.SetBooleanUserAttribute	(	string	title,
		int	index,
		bool	value,
		NXOpen.Update.Option	option
	)

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

To set a non-array attribute, set the index = -1. Arrays can be extended only one element at a time. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0

License requirements: None.

Parameters

title
index
value
option

unsafe void NXOpen.NXObject.SetName ( string name )

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX3.0.0

License requirements: None.

Parameters

name

Implements NXOpen.INXObject.

unsafe void NXOpen.NXObject.SetPdmReferenceAttribute	(	string	attributeTitle,
		string	attributeValue
	)

Sets the value of PDM Reference attribute on the object.

User should provide attribute title and alias value that is displayed on UI. If reference attribute is of Array type it will be ignored. Alias string will be converted to internal value (i.e. session identifier) and internal value will be set on given object.

Created in NX12.0.0

License requirements: None.

Parameters

attributeTitle
attributeValue

unsafe void NXOpen.NXObject.SetReferenceAttribute	(	string	title,
		string	value
	)

Creates or modifies a string attribute which uses a reference string.

This method performs an immediate update except when the object is a NXOpen.Features.Feature . NOTE: The input value must be a valid reference string. This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX3.0.0

Deprecated in NX8.0.0. Use SetUserAttribute instead.

License requirements: None.

Parameters

title
value

unsafe void NXOpen.NXObject.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.

NOTE: The input value must be a valid reference string. This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX5.0.1

Deprecated in NX8.0.0. Use SetUserAttribute instead.

License requirements: None.

Parameters

title
value
option

unsafe void NXOpen.NXObject.SetTimeAttribute	(	string	title,
		string	value
	)

Creates or modifies a time attribute.

This method performs an immediate update except when the object is a NXOpen.Features.Feature . 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. This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX3.0.0

Deprecated in NX8.0.0. Use SetUserAttribute instead.

License requirements: None.

Parameters

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

unsafe void NXOpen.NXObject.SetTimeAttribute	(	string	title,
		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. This method does not support array attributes. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX5.0.1

Deprecated in NX8.0.0. Use SetUserAttribute instead.

License requirements: None.

Parameters

title
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.NXObject.SetTimeUserAttribute	(	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. To set a non-array attribute, set the index = -1. Arrays can be extended only one element at a time. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated. NOTE: The valid range for attributes of type date is from 01-Jan-1970 to 31-Dec-2105

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

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. To set a non-array attribute, set the index = -1. Arrays can be extended only one element at a time. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0

License requirements: None.

Parameters

title
index
value	The current date and time is used if the value is (0,0).
option

unsafe void NXOpen.NXObject.SetUserAttribute	(	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. NOTE: To set an NXOpen.NXObject.AttributeType.Time attribute, either a formatted string or a computational value may be used. If both are set (the string is not a null reference (Nothing in Visual Basic) and the computational value is not (0,0)), then the computational value will take precedence. The time value in either case is in the current time zone of the machine running the program.

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

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 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 Category Transient

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated. NOTE: The valid range for attributes of type date is from 01-Jan-1970 to 31-Dec-2105

Created in NX8.0.0

License requirements: None.

Parameters

info
option

unsafe void NXOpen.NXObject.SetUserAttribute	(	string	title,
		int	index,
		int	value,
		NXOpen.Update.Option	option
	)

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

To set a non-array attribute, set the index = -1. Arrays can be extended only one element at a time. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0

License requirements: None.

Parameters

title
index
value
option

unsafe void NXOpen.NXObject.SetUserAttribute	(	string	title,
		int	index,
		double	value,
		NXOpen.Update.Option	option
	)

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

To set a non-array attribute, set the index = -1. Arrays can be extended only one element at a time. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0

License requirements: None.

Parameters

title
index
value
option

unsafe void NXOpen.NXObject.SetUserAttribute	(	string	title,
		int	index,
		string	value,
		NXOpen.Update.Option	option
	)

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

To set a non-array attribute, set the index = -1. Arrays can be extended only one element at a time. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0

License requirements: None.

Parameters

title
index
value
option

unsafe void NXOpen.NXObject.SetUserAttribute	(	string	title,
		int	index,
		NXOpen.Update.Option	option
	)

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

To set a non-array attribute, set the index = -1. Arrays can be extended only one element at a time. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0

License requirements: None.

Parameters

title
index
option

unsafe void NXOpen.NXObject.SetUserAttributeLock	(	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. NOTE: Attributes that are reserved (OwnedBySystem), cannot be unlocked. NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0

License requirements: None.

Parameters

title
type
lock

Property Documentation

unsafe bool NXOpen.NXObject.IsOccurrence

get

Returns whether this object is an occurrence or not.

Created in NX3.0.0

License requirements: None.

unsafe string NXOpen.NXObject.JournalIdentifier

get

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

Created in NX3.0.0

License requirements: None.

unsafe string NXOpen.NXObject.Name

get

Returns the custom name of the object.

Created in NX3.0.0

License requirements: None.

unsafe NXOpen.Assemblies.Component NXOpen.NXObject.OwningComponent

get

Returns the owning component, if this object is an occurrence.

Created in NX3.0.0

License requirements: None.

unsafe NXOpen.BasePart NXOpen.NXObject.OwningPart

get

Returns the owning part of this object

Created in NX3.0.0

License requirements: None.

unsafe NXOpen.INXObject NXOpen.NXObject.Prototype

get

Returns the prototype of this object if it is an occurrence.

Created in NX3.0.0

License requirements: None.

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

dotnet_pool/NXObject.cs

Classes

Public Types

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation