JA interface for the UserDefinedObject object More...

Inheritance diagram for NXOpen.UserDefinedObjects.UserDefinedObject:

Classes
struct	_LinkDefinition
	Contains the linked object and it's status along with the type of link.

struct	LinkDefinition
	Contains the linked object and it's status along with the type of link. More...

Public Types
enum	LinkStatus { UpToDate, OutOfDate }
	Status of the object linked to a NXOpen.Features.UserDefinedObjectFeature More...

enum	LinkType { Owning, Type1, Type2, Type3, Type4 }
	Available link types for a NXOpen.Features.UserDefinedObjectFeature . More...

Public Types inherited from NXOpen.DisplayableObject
enum	ObjectFont { Solid = 1, Dashed, Phantom, Centerline, Dotted, LongDashed, DottedDashed, Eight = 11, Nine, Ten, Eleven }
	specifies the object font for objects such as lines More...

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

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 void	ClearUserDefinedObjectStatus ()
	Clears the out of data indicator (status) of this UDO More...

unsafe double[]	GetAreas ()
	Gets all of the areas stored with this UDO More...

unsafe double[]	GetAreas (int offset, int length)
	Gets the areas stored in the specified range with this UDO More...

unsafe double[]	GetDoubles ()
	Gets all of the doubles stored with this UDO More...

unsafe double[]	GetDoubles (int offset, int length)
	Gets the doubles stored in the specified range with this UDO More...

unsafe int[]	GetIntegers ()
	Gets all of the integers stored with this UDO More...

unsafe int[]	GetIntegers (int offset, int length)
	Gets the integers stored in the specified range with this UDO More...

unsafe double[]	GetLengths ()
	Gets all of the lengths stored with this UDO More...

unsafe double[]	GetLengths (int offset, int length)
	Gets the lengths stored in the specified range with this UDO More...

unsafe NXOpen.UserDefinedObjects.UserDefinedObject.LinkDefinition[]	GetLinks (NXOpen.UserDefinedObjects.UserDefinedObject.LinkType linkType)
	Gets all links with the given link type that are stored with this UDO More...

unsafe NXOpen.UserDefinedObjects.UserDefinedObject.LinkDefinition[]	GetLinks (NXOpen.UserDefinedObjects.UserDefinedObject.LinkType linkType, int offset, int length)
	Gets the links with the given link type that are stored in the specified range with this UDO More...

unsafe string[]	GetStrings ()
	Gets all of the strings stored with this UDO More...

unsafe string[]	GetStrings (int offset, int length)
	Gets the strings stored in the specified range with this UDO More...

unsafe NXOpen.Features.UserDefinedObjectFeature	GetUserDefinedObjectFeature ()
	Gets the NXOpen.Features.UserDefinedObjectFeature associated with this UDO, if there isn't an associated feature, a null reference (Nothing in Visual Basic) is returned More...

unsafe int	GetUserDefinedObjectStatus ()
	Gets the out of date indicator (status) of this UDO More...

unsafe double[]	GetVolumes ()
	Gets all of the volumes stored with this UDO More...

unsafe double[]	GetVolumes (int offset, int length)
	Gets the volumes stored in the specified range with this UDO More...

unsafe double[]	PopAreas (int numAreas)
	Removes the areas stored at the end of the area array for this UDO, and returns them in an array More...

unsafe double[]	PopDoubles (int numDoubles)
	Removes the doubles stored at the end of the double array for this UDO, and returns them in an array More...

unsafe int[]	PopIntegers (int numIntegers)
	Removes the integers stored at the end of the integer array for this UDO, and returns them in an array More...

unsafe double[]	PopLengths (int numLengths)
	Removes the lengths stored at the end of the length array for this UDO, and returns them in an array More...

unsafe NXOpen.UserDefinedObjects.UserDefinedObject.LinkDefinition[]	PopLinks (NXOpen.UserDefinedObjects.UserDefinedObject.LinkType linkType, int numLinks)
	Removes the links stored at the end of the given link type's link array for this UDO, and returns them in an array More...

unsafe string[]	PopStrings (int numStrings)
	Removes the strings stored at the end of the string array for this UDO, and returns them in an array More...

unsafe double[]	PopVolumes (int numVolumes)
	Removes the volumes stored at the end of the volume array for this UDO, and returns them in an array More...

unsafe void	PushAreas (double[] areas)
	Add the specified areas to the end of the area array for this UDO More...

unsafe void	PushDoubles (double[] doubles)
	Add the specified doubles to the end of the double array for this UDO More...

unsafe void	PushIntegers (int[] integers)
	Add the specified integers to the end of the integer array for this UDO More...

unsafe void	PushLengths (double[] lengths)
	Add the specified lengths to the end of the length array for this UDO More...

unsafe void	PushLinks (NXOpen.UserDefinedObjects.UserDefinedObject.LinkType linkType, NXOpen.UserDefinedObjects.UserDefinedObject.LinkDefinition[] links)
	Add the specified links to the end of the given link type's link array for this UDO More...

unsafe void	PushStrings (string[] strings)
	Add the specified strings to the end of the string array for this UDO More...

unsafe void	PushVolumes (double[] volumes)
	Add the specified volumes to the end of the volume array for this UDO More...

unsafe void	SetAreas (double[] areas)
	Sets all of the areas stored with this UDO More...

unsafe void	SetAreas (int offset, int length, double[] areas)
	Replaces the areas stored with this UDO in the specified range with a new array of areas More...

unsafe void	SetDoubles (double[] doubles)
	Sets all of the doubles stored with this UDO More...

unsafe void	SetDoubles (int offset, int length, double[] doubles)
	Replaces the doubles stored with this UDO in the specified range with a new array of doubles More...

unsafe void	SetIntegers (int[] integers)
	Sets all of the integers stored with this UDO More...

unsafe void	SetIntegers (int offset, int length, int[] integers)
	Replaces the integers stored with this UDO in the specified range with a new array of integers More...

unsafe void	SetLengths (double[] lengths)
	Sets all of the lengths stored with this UDO More...

unsafe void	SetLengths (int offset, int length, double[] lengths)
	Replaces the lengths stored with this UDO in the specified range with a new array of lengths More...

unsafe void	SetLinks (NXOpen.UserDefinedObjects.UserDefinedObject.LinkType linkType, NXOpen.UserDefinedObjects.UserDefinedObject.LinkDefinition[] links)
	Sets all of the links with the given link type stored with this UDO. More...

unsafe void	SetLinks (NXOpen.UserDefinedObjects.UserDefinedObject.LinkType linkType, int offset, int length, NXOpen.UserDefinedObjects.UserDefinedObject.LinkDefinition[] links)
	Replaces the links of the given link type stored with this UDO in the specified range with a new array of links More...

unsafe void	SetStrings (string[] strings)
	Sets all of the strings stored with this UDO More...

unsafe void	SetStrings (int offset, int length, string[] strings)
	Replaces the strings stored with this UDO in the specified range with a new array of strings More...

unsafe void	SetVolumes (double[] volumes)
	Sets all of the volumes stored with this UDO More...

unsafe void	SetVolumes (int offset, int length, double[] volumes)
	Replaces the volumes stored with this UDO in the specified range with a new array of volumes More...

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

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

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

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

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

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

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

Public Member Functions inherited from NXOpen.NXObject
unsafe NXOpen.AttributeIterator	CreateAttributeIterator ()
	Create an attribute iterator 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	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	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.AttributeIterator iterator, NXOpen.Update.Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator 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 NXOpen.INXObject	FindObject (string journalIdentifier)
	Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...

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

unsafe bool	GetBooleanUserAttribute (string title, int index)
	Gets a boolean 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 int	GetIntegerAttribute (string title)
	Gets an integer attribute by title. More...

unsafe int	GetIntegerUserAttribute (string title, int index)
	Gets an integer attribute by Title and array Index. 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 string	GetPdmReferenceAttributeValue (string attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

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

unsafe double	GetRealUserAttribute (string title, int index)
	Gets a real attribute by Title and array Index. 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 string	GetStringAttribute (string title)
	Gets a string attribute value by title. More...

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

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

unsafe string	GetTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. 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 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 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 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 bool	GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
	Determine the lock of the given attribute. 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 NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

unsafe string[]	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. 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 NXOpen.NXObject[]	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. 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 void	Print ()
	Prints a representation of this object to the system log file. 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	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 void	SetName (string name)
	Sets the custom name of the object. More...

unsafe void	SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
	Sets the value of PDM Reference attribute on the object. 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 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 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	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	SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
	Lock or unlock the given attribute. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe string	ClassName `[get]`
	Returns the class name of this UDO More...

unsafe NXOpen.UserDefinedObjects.UserDefinedClass	UserDefinedClass `[get, set]`
	Returns or sets the NXOpen.UserDefinedObjects.UserDefinedClass for this UDO 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.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. 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...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

JA interface for the UserDefinedObject object

Created in NX5.0.0

Member Enumeration Documentation

enum NXOpen.UserDefinedObjects.UserDefinedObject.LinkStatus

Status of the object linked to a NXOpen.Features.UserDefinedObjectFeature

Enumerator
UpToDate	The associated object is up to date.
OutOfDate	The associated object is out of date.

enum NXOpen.UserDefinedObjects.UserDefinedObject.LinkType

Available link types for a NXOpen.Features.UserDefinedObjectFeature .

Enumerator
Owning	The object is owned by the UDO
Type1	If the UDO is deleted the link between the UDO and the associated object is removed and the object is unaffected. If the UDO is updated the associated object is unaffected. If the associated object is deleted the UDO is also deleted. If the associated object is updated the UDO is updated.
Type2	If the UDO is deleted the link between the UDO and the associated object is removed and the object is deleted. If the UDO is updated the associated NX object is unaffected. If the associated object is deleted, it is left in the data model in a condemned state and remains attached to the UDO. If the associated object is updated the UDO is unaffected.
Type3	If the UDO is deleted the link between the UDO and the associated object is removed and the object is unaffected. If the UDO is updated the associated object is unaffected. If the associated object is deleted the link to the UDO is removed and the UDO is updated. If the associated object is updated the UDO is updated
Type4	If the UDO is deleted the link between the UDO and the associated object is removed and the object is unaffected. If the UDO is updated the associated object is unaffected. If the associated object is deleted the link to the UDO is removed and the UDO is unaffected. If the associated object is updated the UDO is unaffected.

Member Function Documentation

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.ClearUserDefinedObjectStatus ( )

inline

Clears the out of data indicator (status) of this UDO

Created in NX5.0.0

License requirements: None.

unsafe double [] NXOpen.UserDefinedObjects.UserDefinedObject.GetAreas ( )

inline

Gets all of the areas stored with this UDO

Created in NX5.0.0

License requirements: None.

Returns: Array of areas stored with this UDO

unsafe double [] NXOpen.UserDefinedObjects.UserDefinedObject.GetAreas	(	int	offset,
		int	length
	)

inline

Gets the areas stored in the specified range with this UDO

Created in NX5.0.0

License requirements: None.

Parameters

offset	Index into the array of areas at the start of the returned range. Valid values are 0 through (number of areas in the udo - 1) and -(number of areas in the udo) through -1. If the offset is negative, it is used to count back from the end of the area array. Therefore using -1 or (number of areas in the udo -1) for the offset will give the same result.
length	The number of areas you wish to get

Returns: Array of areas stored within the specified range of the area array for this UDO

unsafe double [] NXOpen.UserDefinedObjects.UserDefinedObject.GetDoubles ( )

inline

Gets all of the doubles stored with this UDO

Created in NX5.0.0

License requirements: None.

Returns: Array of doubles stored with this UDO

unsafe double [] NXOpen.UserDefinedObjects.UserDefinedObject.GetDoubles	(	int	offset,
		int	length
	)

inline

Gets the doubles stored in the specified range with this UDO

Created in NX5.0.0

License requirements: None.

Parameters

offset	Index into the array of doubles at the start of the returned range. Valid values are 0 through (number of doubles in the udo - 1) and -(number of doubles in the udo) through -1. If the offset is negative, it is used to count back from the end of the double array. Therefore using -1 or (number of doubles in the udo -1) for the offset will give the same result.
length	The number of doubles you wish to get

Returns: Array of doubles stored within the specified range of the double array for this UDO

unsafe int [] NXOpen.UserDefinedObjects.UserDefinedObject.GetIntegers ( )

inline

Gets all of the integers stored with this UDO

Created in NX5.0.0

License requirements: None.

Returns: Array of integers stored with this UDO

unsafe int [] NXOpen.UserDefinedObjects.UserDefinedObject.GetIntegers	(	int	offset,
		int	length
	)

inline

Gets the integers stored in the specified range with this UDO

Created in NX5.0.0

License requirements: None.

Parameters

offset	Index into the array of integers at the start of the returned range. Valid values are 0 through (number of integers in the udo - 1) and -(number of integers in the udo) through -1. If the offset is negative, it is used to count back from the end of the integer array. Therefore using -1 or (number of integers in the udo -1) for the offset will give the same result.
length	The number of integers you wish to get

Returns: Array of integers stored within the specified range of the integer array for this UDO

unsafe double [] NXOpen.UserDefinedObjects.UserDefinedObject.GetLengths ( )

inline

Gets all of the lengths stored with this UDO

Created in NX5.0.0

License requirements: None.

Returns: Array of lengths stored with this UDO

unsafe double [] NXOpen.UserDefinedObjects.UserDefinedObject.GetLengths	(	int	offset,
		int	length
	)

inline

Gets the lengths stored in the specified range with this UDO

Created in NX5.0.0

License requirements: None.

Parameters

offset	Index into the array of lengths at the start of the returned range. Valid values are 0 through (number of lengths in the udo - 1) and -(number of lengths in the udo) through -1. If the offset is negative, it is used to count back from the end of the length array. Therefore using -1 or (number of lengths in the udo -1) for the offset will give the same result.
length	The number of lengths you wish to get

Returns: Array of lengths stored within the specified range of the length array for this UDO

unsafe NXOpen.UserDefinedObjects.UserDefinedObject.LinkDefinition [] NXOpen.UserDefinedObjects.UserDefinedObject.GetLinks ( NXOpen.UserDefinedObjects.UserDefinedObject.LinkType linkType )

inline

Gets all links with the given link type that are stored with this UDO

Created in NX5.0.0

License requirements: None.

Parameters

linkType The type of links you wish to get

Returns: Array of links (with the given link type) stored with this UDO

unsafe NXOpen.UserDefinedObjects.UserDefinedObject.LinkDefinition [] NXOpen.UserDefinedObjects.UserDefinedObject.GetLinks	(	NXOpen.UserDefinedObjects.UserDefinedObject.LinkType	linkType,
		int	offset,
		int	length
	)

inline

Gets the links with the given link type that are stored in the specified range with this UDO

Created in NX5.0.0

License requirements: None.

Parameters

linkType	The type of links you wish to get
offset	Index into the array of links (with the given link type) at the start of the returned range. Valid values are 0 through (number of links of the given type in the udo - 1) and -(number of links of the given type in the udo) through -1. If the offset is negative, it is used to count back from the end of the link array. Therefore using -1 or (number of links of the given link type in the udo -1) for the offset will give the same result.
length	The number of links (with the given link type) you wish to get

Returns: Array of links stored within the specified range of the link type's link array for this UDO

unsafe string [] NXOpen.UserDefinedObjects.UserDefinedObject.GetStrings ( )

inline

Gets all of the strings stored with this UDO

Created in NX5.0.0

License requirements: None.

Returns: Array of strings stored with this UDO

unsafe string [] NXOpen.UserDefinedObjects.UserDefinedObject.GetStrings	(	int	offset,
		int	length
	)

inline

Gets the strings stored in the specified range with this UDO

Created in NX5.0.0

License requirements: None.

Parameters

offset	Index into the array of strings at the start of the returned range. Valid values are 0 through (number of strings in the udo - 1) and -(number of strings in the udo) through -1. If the offset is negative, it is used to count back from the end of the string array. Therefore using -1 or (number of strings in the udo -1) for the offset will give the same result.
length	The number of strings you wish to get

Returns: Array of strings stored within the specified range of the string array for this UDO

unsafe NXOpen.Features.UserDefinedObjectFeature NXOpen.UserDefinedObjects.UserDefinedObject.GetUserDefinedObjectFeature ( )

inline

Gets the NXOpen.Features.UserDefinedObjectFeature associated with this UDO, if there isn't an associated feature, a null reference (Nothing in Visual Basic) is returned

Created in NX5.0.0

License requirements: None.

Returns: The UserDefinedObjectFeature associated this UDO

unsafe int NXOpen.UserDefinedObjects.UserDefinedObject.GetUserDefinedObjectStatus ( )

inline

Gets the out of date indicator (status) of this UDO

Created in NX5.0.0

License requirements: None.

Returns: The status of this UDO 0 - The UDO is up to date 1 - Out of date due to addition or deletion of links to the UDO 2 - Out of date due to update being performed on an associated (linked) object in the absence of a UDO Method 3 - Out of date due to addition or deletion of links to the UDO AND update being performed on an Associated (linked) object in the absence of a UDO Method 4 - Out of date due to deletion of associated (linked) objects in the absence of a UDO method 5 - Out of date due to addition or deletion of links to the UDO AND deletion of associated (linked) objects in the absence of a UDO method 6 - Out of date due to update being performed on an associated (linked) object in the absence of a UDO Method AND deletion of associated (linked) objects in the absence of a UDO method 7 - Out of date due to addition or deletion of links to the UDO AND update being performed on an Associated (linked) object in the absence of a UDO Method AND deletion of associated (linked) objects in the absence of a UDO method

unsafe double [] NXOpen.UserDefinedObjects.UserDefinedObject.GetVolumes ( )

inline

Gets all of the volumes stored with this UDO

Created in NX5.0.0

License requirements: None.

Returns: Array of volumes stored with this UDO

unsafe double [] NXOpen.UserDefinedObjects.UserDefinedObject.GetVolumes	(	int	offset,
		int	length
	)

inline

Gets the volumes stored in the specified range with this UDO

Created in NX5.0.0

License requirements: None.

Parameters

offset	Index into the array of volumes at the start of the returned range. Valid values are 0 through (number of volumes in the udo - 1) and -(number of volumes in the udo) through -1. If the offset is negative, it is used to count back from the end of the volume array. Therefore using -1 or (number of volumes in the udo -1) for the offset will give the same result.
length	The number of volumes you wish to get

Returns: Array of volumes stored within the specified range of the volume array for this UDO

unsafe double [] NXOpen.UserDefinedObjects.UserDefinedObject.PopAreas ( int numAreas )

inline

Removes the areas stored at the end of the area array for this UDO, and returns them in an array

Created in NX5.0.0

License requirements: None.

Parameters

numAreas

Returns: Array of areas that have been removed from this UDO

unsafe double [] NXOpen.UserDefinedObjects.UserDefinedObject.PopDoubles ( int numDoubles )

inline

Removes the doubles stored at the end of the double array for this UDO, and returns them in an array

Created in NX5.0.0

License requirements: None.

Parameters

numDoubles

Returns: Array of doubles that have been removed from this UDO

unsafe int [] NXOpen.UserDefinedObjects.UserDefinedObject.PopIntegers ( int numIntegers )

inline

Removes the integers stored at the end of the integer array for this UDO, and returns them in an array

Created in NX5.0.0

License requirements: None.

Parameters

numIntegers

Returns: Array of integers that have been removed from this UDO

unsafe double [] NXOpen.UserDefinedObjects.UserDefinedObject.PopLengths ( int numLengths )

inline

Removes the lengths stored at the end of the length array for this UDO, and returns them in an array

Created in NX5.0.0

License requirements: None.

Parameters

numLengths

Returns: Array of lengths that have been removed from this UDO

unsafe NXOpen.UserDefinedObjects.UserDefinedObject.LinkDefinition [] NXOpen.UserDefinedObjects.UserDefinedObject.PopLinks	(	NXOpen.UserDefinedObjects.UserDefinedObject.LinkType	linkType,
		int	numLinks
	)

inline

Removes the links stored at the end of the given link type's link array for this UDO, and returns them in an array

Created in NX5.0.0

License requirements: None.

Parameters

linkType	The type of links you wish to remove
numLinks

Returns: Array of links (with the given link type) that have been removed from this UDO

unsafe string [] NXOpen.UserDefinedObjects.UserDefinedObject.PopStrings ( int numStrings )

inline

Removes the strings stored at the end of the string array for this UDO, and returns them in an array

Created in NX5.0.0

License requirements: None.

Parameters

numStrings

Returns: Array of strings that have been removed from this UDO

unsafe double [] NXOpen.UserDefinedObjects.UserDefinedObject.PopVolumes ( int numVolumes )

inline

Removes the volumes stored at the end of the volume array for this UDO, and returns them in an array

Created in NX5.0.0

License requirements: None.

Parameters

numVolumes

Returns: Array of volumes that have been removed from this UDO

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.PushAreas ( double[] areas )

inline

Add the specified areas to the end of the area array for this UDO

Created in NX5.0.0

License requirements: None.

Parameters

areas Array of new areas to add to this UDO. This routine is cumulutive, and will not remove any areas already stored with the UDO. It simply adds these new areas to the end of the existing area array and increases the total number of areas stored with the UDO

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.PushDoubles ( double[] doubles )

inline

Add the specified doubles to the end of the double array for this UDO

Created in NX5.0.0

License requirements: None.

Parameters

doubles Array of new doubles to add to this UDO. This routine is cumulutive, and will not remove any doubles already stored with the UDO. It simply adds these new doubles to the end of the existing double array and increases the total number of doubles stored with the UDO

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.PushIntegers ( int[] integers )

inline

Add the specified integers to the end of the integer array for this UDO

Created in NX5.0.0

License requirements: None.

Parameters

integers Array of new integers to add to this UDO. This routine is cumulutive, and will not remove any integers already stored with the UDO. It simply adds these new integers to the end of the existing integer array and increases the total number of integers stored with the UDO

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.PushLengths ( double[] lengths )

inline

Add the specified lengths to the end of the length array for this UDO

Created in NX5.0.0

License requirements: None.

Parameters

lengths Array of new lengths to add to this UDO. This routine is cumulutive, and will not remove any lengths already stored with the UDO. It simply adds these new lengths to the end of the existing length array and increases the total number of lengths stored with the UDO

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.PushLinks	(	NXOpen.UserDefinedObjects.UserDefinedObject.LinkType	linkType,
		NXOpen.UserDefinedObjects.UserDefinedObject.LinkDefinition[]	links
	)

inline

Add the specified links to the end of the given link type's link array for this UDO

Created in NX5.0.0

License requirements: None.

Parameters

linkType	The type of links you wish to add
links	Array of new links (with the given link type) to add to this UDO. This routine is cumulutive, and will not remove any links already stored with the UDO. It simply adds these new links to the end of the existing link array for the given link type and increases the total number of links of the given type stored with the UDO

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.PushStrings ( string[] strings )

inline

Add the specified strings to the end of the string array for this UDO

Created in NX5.0.0

License requirements: None.

Parameters

strings Array of new strings to add to this UDO. This routine is cumulutive, and will not remove any strings already stored with the UDO. It simply adds these new strings to the end of the existing string array and increases the total number of strings stored with the UDO

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.PushVolumes ( double[] volumes )

inline

Add the specified volumes to the end of the volume array for this UDO

Created in NX5.0.0

License requirements: None.

Parameters

volumes Array of new volumes to add to this UDO. This routine is cumulutive, and will not remove any volumes already stored with the UDO. It simply adds these new volumes to the end of the existing volume array and increases the total number of volumes stored with the UDO

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.SetAreas ( double[] areas )

inline

Sets all of the areas stored with this UDO

Created in NX5.0.0

License requirements: None.

Parameters

areas New Array of areas stored with this UDO

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.SetAreas	(	int	offset,
		int	length,
		double[]	areas
	)

inline

Replaces the areas stored with this UDO in the specified range with a new array of areas

Created in NX5.0.0

License requirements: None.

Parameters

offset	Index into the array of areas at the start of the range you wish to cut and replace. Valid values are 0 through (number of areas in the udo - 1) and -(number of areas in the udo) through -1. If the offset is negative, it is used to count back from the end of the area array. Therefore using -1 or (number of areas in the udo -1) for the offset will give the same result.
length	The number of areas in the range you wish to cut
areas	Array of areas to paste in place of the specified range.

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.SetDoubles ( double[] doubles )

inline

Sets all of the doubles stored with this UDO

Created in NX5.0.0

License requirements: None.

Parameters

doubles New Array of doubles stored with this UDO

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.SetDoubles	(	int	offset,
		int	length,
		double[]	doubles
	)

inline

Replaces the doubles stored with this UDO in the specified range with a new array of doubles

Created in NX5.0.0

License requirements: None.

Parameters

offset	Index into the array of doubles at the start of the range you wish to cut and replace. Valid values are 0 through (number of doubles in the udo - 1) and -(number of doubles in the udo) through -1. If the offset is negative, it is used to count back from the end of the double array. Therefore using -1 or (number of doubles in the udo -1) for the offset will give the same result.
length	The number of doubles in the range you wish to cut
doubles	Array of doubles to paste in place of the specified range.

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.SetIntegers ( int[] integers )

inline

Sets all of the integers stored with this UDO

Created in NX5.0.0

License requirements: None.

Parameters

integers New Array of integers stored with this UDO

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.SetIntegers	(	int	offset,
		int	length,
		int[]	integers
	)

inline

Replaces the integers stored with this UDO in the specified range with a new array of integers

Created in NX5.0.0

License requirements: None.

Parameters

offset	Index into the array of integers at the start of the range you wish to cut and replace. Valid values are 0 through (number of integers in the udo - 1) and -(number of integers in the udo) through -1. If the offset is negative, it is used to count back from the end of the integer array. Therefore using -1 or (number of integers in the udo -1) for the offset will give the same result.
length	The number of integers in the range you wish to cut
integers	Array of integers to paste in place of the specified range.

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.SetLengths ( double[] lengths )

inline

Sets all of the lengths stored with this UDO

Created in NX5.0.0

License requirements: None.

Parameters

lengths New Array of lengths stored with this UDO

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.SetLengths	(	int	offset,
		int	length,
		double[]	lengths
	)

inline

Replaces the lengths stored with this UDO in the specified range with a new array of lengths

Created in NX5.0.0

License requirements: None.

Parameters

offset	Index into the array of lengths at the start of the range you wish to cut and replace. Valid values are 0 through (number of lengths in the udo - 1) and -(number of lengths in the udo) through -1. If the offset is negative, it is used to count back from the end of the length array. Therefore using -1 or (number of lengths in the udo -1) for the offset will give the same result.
length	The number of lengths in the range you wish to cut
lengths	Array of lengths to paste in place of the specified range.

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.SetLinks	(	NXOpen.UserDefinedObjects.UserDefinedObject.LinkType	linkType,
		NXOpen.UserDefinedObjects.UserDefinedObject.LinkDefinition[]	links
	)

inline

Sets all of the links with the given link type stored with this UDO.

If you already had objects linked to the UDO via the specified link type, this operation will over-write them with the newly specified links.

Created in NX5.0.0

License requirements: None.

Parameters

linkType	The type of links you wish to set
links	New Array of links (with the given link type) stored with this UDO

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.SetLinks	(	NXOpen.UserDefinedObjects.UserDefinedObject.LinkType	linkType,
		int	offset,
		int	length,
		NXOpen.UserDefinedObjects.UserDefinedObject.LinkDefinition[]	links
	)

inline

Replaces the links of the given link type stored with this UDO in the specified range with a new array of links

Created in NX5.0.0

License requirements: None.

Parameters

linkType	The type of links you wish to set
offset	Index into the array of links (with the given link type) at the start of the range you wish to cut and replace. Valid values are 0 through (number of links with the given link type in the udo - 1) and -(number of links with the given link type in the udo) through -1. If the offset is negative, it is used to count back from the end of the link array. Therefore using -1 or (number of links with the given link type in the udo -1) for the offset will give the same result.
length	The number of links (with the given link type) in the range you wish to cut
links	Array of links (with the given link type) to paste in place of the specified range.

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.SetStrings ( string[] strings )

inline

Sets all of the strings stored with this UDO

Created in NX5.0.0

License requirements: None.

Parameters

strings New Array of strings stored with this UDO

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.SetStrings	(	int	offset,
		int	length,
		string[]	strings
	)

inline

Replaces the strings stored with this UDO in the specified range with a new array of strings

Created in NX5.0.0

License requirements: None.

Parameters

offset	Index into the array of strings at the start of the range you wish to cut and replace. Valid values are 0 through (number of strings in the udo - 1) and -(number of strings in the udo) through -1. If the offset is negative, it is used to count back from the end of the string array. Therefore using -1 or (number of strings in the udo -1) for the offset will give the same result.
length	The number of strings in the range you wish to cut
strings	Array of strings to paste in place of the specified range.

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.SetVolumes ( double[] volumes )

inline

Sets all of the volumes stored with this UDO

Created in NX5.0.0

License requirements: None.

Parameters

volumes New Array of volumes stored with this UDO

unsafe void NXOpen.UserDefinedObjects.UserDefinedObject.SetVolumes	(	int	offset,
		int	length,
		double[]	volumes
	)

inline

Replaces the volumes stored with this UDO in the specified range with a new array of volumes

Created in NX5.0.0

License requirements: None.

Parameters

offset	Index into the array of volumes at the start of the range you wish to cut and replace. Valid values are 0 through (number of volumes in the udo - 1) and -(number of volumes in the udo) through -1. If the offset is negative, it is used to count back from the end of the volume array. Therefore using -1 or (number of volumes in the udo -1) for the offset will give the same result.
length	The number of volumes in the range you wish to cut
volumes	Array of volumes to paste in place of the specified range.

Property Documentation

unsafe string NXOpen.UserDefinedObjects.UserDefinedObject.ClassName

get

Returns the class name of this UDO

Created in NX5.0.0

License requirements: None.

unsafe NXOpen.UserDefinedObjects.UserDefinedClass NXOpen.UserDefinedObjects.UserDefinedObject.UserDefinedClass

getset

Returns or sets the NXOpen.UserDefinedObjects.UserDefinedClass for this UDO

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

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

UserDefinedObjects_UserDefinedObject.cs

Classes

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation