UserInterfaceGeneralEvent Object

Derived from: Event Object
Defined in namespace "adsk::core" and the header file is <Core/UserInterface/UserInterfaceGeneralEvent.h>

Description

A UserInterfaceGeneralEvent is used for user-interface related events that don't require any additional information beyond getting the event itself.

Methods

Name Description
add Add a handler to be notified when the event occurs.
classType Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().
remove Removes a handler from the event.

Properties

Name Description
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
name The name of the event - e.g. "DocumentOpening"
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():
sender The object that is firing the event. For example, in the case of a command input event this will return the command.

Accessed From

Palette.closed, TextCommandPalette.closed

Version

Introduced in version March 2017