InteractionEvents Object


Description

The InteractionEvents object provides the ability to obtain input from the user. This includes selecting objects, various mouse inputs, and using the keyboard.

Methods

Name Description
CreateMiniToolbar Method that creates a MiniToolbar object associated with the parent InteractionEvents.
GetCursor Gets the cursor for the command in which this interaction takes place.
SetCursor Sets the cursor for the command in which this interaction takes place.
Start Starts this object inside Inventor. This will cause the OnActivate to fire initiating the activity linked with this object.
Stop Stops this object inside Inventor. This will cause the OnTerminate to fire halting all activity linked with this object.

Properties

Name Description
AllowCommandAliases
Application Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned.
InteractionDisabled
InteractionGraphics Gets the Interaction Graphics object.
KeyboardEvents Gets the Keyboard Events object.
ManipulatorEvents Gets the ManipulatorEvents object.
MeasureEvents Gets the Measure Events object.
MouseEvents Gets the Mouse Events object.
Name
Parent Gets the parent object from whom this object can logically be reached.
SelectEvents Gets the Selection Events object.
StatusBarText
TargetDocument Gets the Document which is the context in which this interaction takes place.
TriadEvents Gets the TriadEvents object.
Type Returns an ObjectTypeEnum indicating this object's type.

Events

Name Description
OnActivate Event that notifies the command that control has been passed to it. This event is fired when the command initially starts, (when the Start method has been called).
OnHelp Event that fires to signal the client to present help for the associated activity.
OnResume Event that notifies the command to resume execution after being suspended.
OnSuspend Event that notifies the InteractionEvents object to temporarily suspend itself. This happens when the user selects a command that stacks on the current command. Invocation of any of the view commands will cause the stacking behavior.
OnTerminate Event that notifies the command has been terminated. This can happen when the user selects another command or presses escape. It can be forced by calling the Stop method on the InteractionEvents object as well.

Accessed From

CommandManager.CreateInteractionEvents, KeyboardEvents.Parent, ManipulatorEvents.Parent, MeasureEvents.Parent, MouseEvents.Parent, SelectEvents.Parent, TriadEvents.Parent

Samples

Name Description
Basic Selection Using Interaction Events This sample demonstrates using the selection events to select a face. Selection is dependent on events and VB only supports events within a class module.
Using measure events This sample demonstrates using the measure events to measure distance and angle. Interactive measure is dependent on events and VB only supports events within a class module. To use the sample copy the InteractiveMeasureDistance and InteractiveMeasureAngle subs into a code module. Create a new class module called clsMeasure and copy all of the rest of the code into it.
Window Selection This sample demonstrates using the selection events to window-select multiple edges. Selection is dependent on events and VB only supports events within a class module.
OnDrag Event - dragging a WorkPoint This sample demonstrates the use of the OnDrag event to drag fixed work points when no command is active. This sample only allows drags parallel to the X-Y plane. This sample is dependent on events and VB only supports events within a class module.

Version

Introduced in version 5