CommandCreatedEvent.add Method

Parent Object: CommandCreatedEvent
Defined in namespace "adsk::core" and the header file is <Core/UserInterface/CommandCreatedEvent.h>

Description

Adds an event handler object to this event endpoint.

Syntax

Python
C++

"commandCreatedEvent_var" is a variable referencing a CommandCreatedEvent object.returnValue = commandCreatedEvent_var.add(handler)

"commandCreatedEvent_var" is a variable referencing a CommandCreatedEvent object.

#include <Core/UserInterface/CommandCreatedEvent.h>

returnValue = commandCreatedEvent_var->add(handler);

Return Value

Type	Description
boolean	Returns true if the handler was successfully added to the set of event handlers.

Parameters

Name	Type	Description
handler	CommandCreatedEventHandler	The client implemented CommandCreatedEventHandler to be called when this event is triggered.

Samples

Command Inputs API Sample

Creates a command dialog that demonstrates all of the available command inputs.

To use the sample, create a new Python or C++ script and copy and paste this code, replacing the default code. You also need to unpack this zip file which contains a resource folder into the same folder where the source code file (.py or .cpp) is.

Customizing the UI using the API Sample

Demonstrates how to work with tabs, panels, and command in the user interface. The full source for C++ and Python samples can be downloaded. This is especially useful for getting the resource files.

Version

Introduced in version August 2014