JA interface for the UserDefinedClass object More...

Inheritance diagram for NXOpen.UserDefinedObjects.UserDefinedClass:

Classes
class	_UserDefinedClassDisplayCallbackAdapter

class	_UserDefinedClassGenericCallbackAdapter

class	_UserDefinedClassLinkCallbackAdapter

Public Types
enum	AllowOwnedObjectSelection { Off = 1, On }
	Allow owned object selection on all objects owned by an object of this NXOpen.UserDefinedObjects.UserDefinedClass . More...

enum	AllowQueryClass { Off = 1, On }
	Allow query class from name options for a NXOpen.UserDefinedObjects.UserDefinedObject of this class. More...

enum	Selection { Off = 1, On }
	Allow query class from name options for a NXOpen.UserDefinedObjects.UserDefinedObject . More...

Public Member Functions
unsafe void	AddAttentionPointHandler (NXOpen.UserDefinedObjects.UserDefinedClass.DisplayCallback displayEvent)
	Registers the attention point callback. More...

unsafe void	AddDeleteHandler (NXOpen.UserDefinedObjects.UserDefinedClass.LinkCallback linkEvent)
	Registers the delete callback. More...

unsafe void	AddDisplayHandler (NXOpen.UserDefinedObjects.UserDefinedClass.DisplayCallback displayEvent)
	Registers UDO display callback. More...

unsafe void	AddEditHandler (NXOpen.UserDefinedObjects.UserDefinedClass.GenericCallback udoEvent)
	Registers the edit callback. More...

unsafe void	AddFitHandler (NXOpen.UserDefinedObjects.UserDefinedClass.DisplayCallback displayEvent)
	Registers the fit callback. More...

unsafe void	AddInformationHandler (NXOpen.UserDefinedObjects.UserDefinedClass.GenericCallback udoEvent)
	Registers the information callback. More...

unsafe void	AddScreenSizeFitHandler (NXOpen.UserDefinedObjects.UserDefinedClass.DisplayCallback displayEvent)
	Registers the screen size fit callback. More...

unsafe void	AddSelectionHandler (NXOpen.UserDefinedObjects.UserDefinedClass.DisplayCallback displayEvent)
	Registers the UDO selection callback. More...

unsafe void	AddSuppressHandler (NXOpen.UserDefinedObjects.UserDefinedClass.GenericCallback udoEvent)
	Registers the suppress callback. More...

unsafe void	AddUpdateHandler (NXOpen.UserDefinedObjects.UserDefinedClass.LinkCallback linkEvent)
	Registers the update callback. More...

delegate int	DisplayCallback (NXOpen.UserDefinedObjects.UserDefinedDisplayEvent eventObject)
	Prototype for display, selection, attention point, fit and screen-size-fit callbacks More...

delegate int	GenericCallback (NXOpen.UserDefinedObjects.UserDefinedEvent eventObject)
	Prototype for information, edit, and suppress callbacks More...

unsafe bool	GetIsOccurrenceableFlag ()
	Gets the is occurrenceable flag for this class. More...

delegate int	LinkCallback (NXOpen.UserDefinedObjects.UserDefinedLinkEvent eventObject)
	Prototype for update, and delete callbacks More...

unsafe void	SetIsOccurrenceableFlag (bool isOccurrenceable)
	Sets the is occurrenceable flag for this class. More...

Public Member Functions inherited from NXOpen.TransientObject
void	Dispose ()
	Frees the object from memory. More...

void	PrintTestData (String variableName)
	<exclude> More...

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

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

Protected Member Functions
override void	FreeResource ()
	Frees the memory associated with this object. More...

Properties
unsafe NXOpen.UserDefinedObjects.UserDefinedClass.AllowOwnedObjectSelection	AllowOwnedObjectSelectionOption `[get, set]`
	Returns or sets the allow owned object selection flag. More...

unsafe NXOpen.UserDefinedObjects.UserDefinedClass.AllowQueryClass	AllowQueryClassFromName `[get, set]`
	Returns or sets the allow query class from name flag. More...

unsafe string	ClassName `[get]`
	Returns the class name of the NXOpen.UserDefinedObjects.UserDefinedClass . More...

unsafe string	FriendlyName `[get]`
	Returns the friendly name of the NXOpen.UserDefinedObjects.UserDefinedClass . More...

unsafe bool	WarnUserFlag `[get, set]`
	Returns or sets the warn user flag. More...

Properties inherited from NXOpen.TransientObject
IntPtr	Handle `[get]`
	Handle of the internal object represented by this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Detailed Description

JA interface for the UserDefinedClass object

To create a new instance of this class, use NXOpen.UserDefinedObjects.UserDefinedClassManager.NewUserDefinedClass

Created in NX5.0.0

Member Enumeration Documentation

enum NXOpen.UserDefinedObjects.UserDefinedClass.AllowOwnedObjectSelection

Allow owned object selection on all objects owned by an object of this NXOpen.UserDefinedObjects.UserDefinedClass .

Enumerator
Off	You do NOT have permission to select objects owned by this class.
On	You have permission to select objects owned by this class.

enum NXOpen.UserDefinedObjects.UserDefinedClass.AllowQueryClass

Allow query class from name options for a NXOpen.UserDefinedObjects.UserDefinedObject of this class.

Enumerator
Off	You do NOT have permission to query the class from it's name.
On	You have permission to query the class from it's name.

enum NXOpen.UserDefinedObjects.UserDefinedClass.Selection

Allow query class from name options for a NXOpen.UserDefinedObjects.UserDefinedObject .

Enumerator
Off	UDO's of this class will NOT be selectable.
On	UDO's of this class will be selectable.

Member Function Documentation

unsafe void NXOpen.UserDefinedObjects.UserDefinedClass.AddAttentionPointHandler ( NXOpen.UserDefinedObjects.UserDefinedClass.DisplayCallback displayEvent )

inline

Registers the attention point callback.

Created in NX5.0.0

License requirements: None.

Parameters

displayEvent

unsafe void NXOpen.UserDefinedObjects.UserDefinedClass.AddDeleteHandler ( NXOpen.UserDefinedObjects.UserDefinedClass.LinkCallback linkEvent )

inline

Registers the delete callback.

Created in NX5.0.0

License requirements: None.

Parameters

linkEvent

unsafe void NXOpen.UserDefinedObjects.UserDefinedClass.AddDisplayHandler ( NXOpen.UserDefinedObjects.UserDefinedClass.DisplayCallback displayEvent )

inline

Registers UDO display callback.

Created in NX5.0.0

License requirements: None.

Parameters

displayEvent

unsafe void NXOpen.UserDefinedObjects.UserDefinedClass.AddEditHandler ( NXOpen.UserDefinedObjects.UserDefinedClass.GenericCallback udoEvent )

inline

Registers the edit callback.

Created in NX5.0.0

License requirements: None.

Parameters

udoEvent

unsafe void NXOpen.UserDefinedObjects.UserDefinedClass.AddFitHandler ( NXOpen.UserDefinedObjects.UserDefinedClass.DisplayCallback displayEvent )

inline

Registers the fit callback.

Created in NX5.0.0

License requirements: None.

Parameters

displayEvent

unsafe void NXOpen.UserDefinedObjects.UserDefinedClass.AddInformationHandler ( NXOpen.UserDefinedObjects.UserDefinedClass.GenericCallback udoEvent )

inline

Registers the information callback.

Created in NX5.0.0

License requirements: None.

Parameters

udoEvent

unsafe void NXOpen.UserDefinedObjects.UserDefinedClass.AddScreenSizeFitHandler ( NXOpen.UserDefinedObjects.UserDefinedClass.DisplayCallback displayEvent )

inline

Registers the screen size fit callback.

The screen size fit callback is called when it is necesary to determine the bounding box of a screen size object (one which remains the same size on the screen independent of the view scale) during a fit computation. As of NX 8.0 the only geometry types supported for User Defined Objects which are screen size are ScreenStandardText and AbsoluteRotationScreenSizeText. If your User Defined Object does not have any of these objects, then you should not call NXOpen.UserDefinedObjects.UserDefinedClass.AddScreenSizeFitHandler because to do do would incur a performance penalty.

Created in NX8.0.0

License requirements: None.

Parameters

displayEvent

unsafe void NXOpen.UserDefinedObjects.UserDefinedClass.AddSelectionHandler ( NXOpen.UserDefinedObjects.UserDefinedClass.DisplayCallback displayEvent )

inline

Registers the UDO selection callback.

Created in NX5.0.0

License requirements: None.

Parameters

displayEvent

unsafe void NXOpen.UserDefinedObjects.UserDefinedClass.AddSuppressHandler ( NXOpen.UserDefinedObjects.UserDefinedClass.GenericCallback udoEvent )

inline

Registers the suppress callback.

Note this callback is not called unless you have a UDO FEATURE. Also it *may* not get called when the system automatically suppresses the feature during update.

Also note the user should check the suppression status of the feature in their callback to see if the input udo feature is currently getting suppressed or unsuppressed.

Created in NX5.0.0

License requirements: None.

Parameters

udoEvent

unsafe void NXOpen.UserDefinedObjects.UserDefinedClass.AddUpdateHandler ( NXOpen.UserDefinedObjects.UserDefinedClass.LinkCallback linkEvent )

inline

Registers the update callback.

Created in NX5.0.0

License requirements: None.

Parameters

linkEvent

delegate int NXOpen.UserDefinedObjects.UserDefinedClass.DisplayCallback ( NXOpen.UserDefinedObjects.UserDefinedDisplayEvent eventObject )

Prototype for display, selection, attention point, fit and screen-size-fit callbacks

Created in NX5.0.0

License requirements: None.

Parameters

eventObject Event obejct

override void NXOpen.UserDefinedObjects.UserDefinedClass.FreeResource ( )

inlineprotectedvirtual

Frees the memory associated with this object.

After invocation of this method, the object is no longer valid.

Created in NX5.0.0

License requirements: None.

Implements NXOpen.TransientObject.

delegate int NXOpen.UserDefinedObjects.UserDefinedClass.GenericCallback ( NXOpen.UserDefinedObjects.UserDefinedEvent eventObject )

Prototype for information, edit, and suppress callbacks

Created in NX5.0.0

License requirements: None.

Parameters

eventObject Event obejct

unsafe bool NXOpen.UserDefinedObjects.UserDefinedClass.GetIsOccurrenceableFlag ( )

inline

Gets the is occurrenceable flag for this class.

Legacy Open C UDO's required a reference UDO to determine Occurrenceability. Occurrenceability is now set on a class by class basis (no reference UDO required). In the event that you have a legacy UDO you wish to query for occurenceability, you will need set the is occurrenceable flag with the new native language method (which does not require a reference UDO) If you do not set the is occurrenceable flag, and instead use the old open c is occurrenceable callback, you will risk error raising during this method because we will automatically pass a null reference (Nothing in Visual Basic) in as the reference UDO to the legacy is occurrenceable callback.

Created in NX5.0.0

License requirements: None.

Returns: Specifies whether or not to populate occurrences for NXOpen.UserDefinedObjects.UserDefinedObject 's of this class.

delegate int NXOpen.UserDefinedObjects.UserDefinedClass.LinkCallback ( NXOpen.UserDefinedObjects.UserDefinedLinkEvent eventObject )

Prototype for update, and delete callbacks

Created in NX5.0.0

License requirements: None.

Parameters

eventObject Event obejct

unsafe void NXOpen.UserDefinedObjects.UserDefinedClass.SetIsOccurrenceableFlag ( bool isOccurrenceable )

inline

Sets the is occurrenceable flag for this class.

Created in NX5.0.0

License requirements: None.

Parameters

isOccurrenceable Specifies whether or not to populate occurrences for NXOpen.UserDefinedObjects.UserDefinedObject 's of this class.

Property Documentation

unsafe NXOpen.UserDefinedObjects.UserDefinedClass.AllowOwnedObjectSelection NXOpen.UserDefinedObjects.UserDefinedClass.AllowOwnedObjectSelectionOption

getset

Returns or sets the allow owned object selection flag.

Specifies whether or not you have permission to select objects owned by NXOpen.UserDefinedObjects.UserDefinedObject 's of this class.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.UserDefinedObjects.UserDefinedClass.AllowQueryClass NXOpen.UserDefinedObjects.UserDefinedClass.AllowQueryClassFromName

getset

Returns or sets the allow query class from name flag.

Specifies whether or not you are allowed to query the NXOpen.UserDefinedObjects.UserDefinedObject from the class name.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.UserDefinedObjects.UserDefinedClass.ClassName

get

Returns the class name of the NXOpen.UserDefinedObjects.UserDefinedClass .

Created in NX5.0.0

License requirements: None.

unsafe string NXOpen.UserDefinedObjects.UserDefinedClass.FriendlyName

get

Returns the friendly name of the NXOpen.UserDefinedObjects.UserDefinedClass .

Created in NX5.0.0

License requirements: None.

unsafe bool NXOpen.UserDefinedObjects.UserDefinedClass.WarnUserFlag

getset

Returns or sets the warn user flag.

Specifies the behavior of warning the user if a NXOpen.UserDefinedObjects.UserDefinedObject of the given NXOpen.UserDefinedObjects.UserDefinedClass is found in a part, but the code implementing the methods for the UDO is not loaded. The default action is to not warn the user. If the UDO author sets this flag to TRUE, all UDO's of this class that are created will be marked so that the user will be warned if the UDO methods have not been loaded, but a UDO of the class is in the part. This warning will be issued to the listing window, when the first object of the given class is retrieved. This warning will only be given once per session.

This flag is set on every UDO object. Therefore for any part, there may be a mixture UDO objects of a given class, some having this flag set to TRUE and some objects having the flag set to FALSE. This is particularly true since all UDO objects created before NX 3.0 will have this flag set to FALSE. If the UDO methods for a class are not loaded, any one UDO with this flag set to TRUE in a part is enough for the warning to be issued to the listing window.

Note that the warning is only issued for UDO's in a part if the part is fully loaded.

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation