CommandInput.tooltip Property

Parent Object: CommandInput

Description

Gets or sets the base tooltip string. This is always shown for commands. If the tooltip description and/or tool clip are also specified then the tooltip will progressively display more information as the user hovers the mouse over the control.

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

Syntax

"commandInput_var" is a variable referencing a CommandInput object.

# Get the value of the property.
propertyValue = commandInput_var.tooltip

# Set the value of the property.
commandInput_var.tooltip = propertyValue
"commandInput_var" is a variable referencing a CommandInput object.
#include <Core/UserInterface/CommandInput.h>

// Get the value of the property.
string propertyValue = commandInput_var->tooltip();

// Set the value of the property, where value_var is a string.
bool returnValue = commandInput_var->tooltip(value_var);

Property Value

This is a read/write property whose value is a string.

Version

Introduced in version July 2015