NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Classes | Public Member Functions | Protected Member Functions | List of all members
NXOpen.SelectionSubscriber Class Reference

Defines a SelectionSubscriber for managing selection events More...

Inheritance diagram for NXOpen.SelectionSubscriber:
NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Classes

class  _SelectionSubscriberOnSelectionChangeCallbackAdapter
 

Public Member Functions

unsafe void Activate ()
 Activate the subscriber so that it will receive selection change notifications. More...
 
unsafe void Deactivate ()
 Deactivate the subscriber so that it will not receive selection change notifications. More...
 
unsafe bool IsActive ()
 Is the subscriber active? More...
 
delegate void OnSelectionChangeCallback (bool clearAll, NXOpen.TaggedObject[] deselectedObjects, NXOpen.TaggedObject[] selectedObjects)
 Prototype for a callback which is called at the end of a series of changes to the set of selected objects. More...
 
unsafe void RegisterOnSelectionChangeCallback (NXOpen.SelectionSubscriber.OnSelectionChangeCallback callbackToRegister)
 Register a callback which is called at the end of a series of changes to the set of selected objects. 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 ()
 Releases resources allocated by the selection subscriber. More...
 

Additional Inherited Members

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

Detailed Description

Defines a SelectionSubscriber for managing selection events

To create a new instance of this class, use NXOpen.Selection.CreateSelectionSubscriber

Created in NX11.0.0

Member Function Documentation

unsafe void NXOpen.SelectionSubscriber.Activate ( )
inline

Activate the subscriber so that it will receive selection change notifications.

Created in NX11.0.0

License requirements: None.

unsafe void NXOpen.SelectionSubscriber.Deactivate ( )
inline

Deactivate the subscriber so that it will not receive selection change notifications.

Created in NX11.0.0

License requirements: None.

override void NXOpen.SelectionSubscriber.FreeResource ( )
inlineprotectedvirtual

Releases resources allocated by the selection subscriber.

Call this method when you are done with your selection operations.

Created in NX11.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe bool NXOpen.SelectionSubscriber.IsActive ( )
inline

Is the subscriber active?

Created in NX11.0.0

License requirements: None.

Returns
delegate void NXOpen.SelectionSubscriber.OnSelectionChangeCallback ( bool  clearAll,
NXOpen.TaggedObject[]  deselectedObjects,
NXOpen.TaggedObject[]  selectedObjects 
)

Prototype for a callback which is called at the end of a series of changes to the set of selected objects.

The series of changes are all of the changes which occur as part of the response to a single user action.

Created in NX11.0.0

License requirements: None.

Parameters
clearAllIf true, all previously selected objects are no longer selected. In this case, the Deselected Objects list will be empty, and the Selected Objects list is the set of objects that are currently selected.
deselectedObjectsObjects deselected by the user action.
selectedObjectsObjects selected by the user action.
unsafe void NXOpen.SelectionSubscriber.RegisterOnSelectionChangeCallback ( NXOpen.SelectionSubscriber.OnSelectionChangeCallback  callbackToRegister)
inline

Register a callback which is called at the end of a series of changes to the set of selected objects.

The series of changes are all of the changes which occur as part of the response to a single user action.

Created in NX11.0.0

License requirements: None.

Parameters
callbackToRegisterCallback

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