CommandInput.tooltipDescription Property

Parent Object: CommandInput

Description

Gets or sets additional text to display progressively along with the tooltip. The text for the description can contain some basic HTML formatting tags to format the tags. For example the br tag can be used to create multiple paragraphs. The tooltip is always shown but as the user hovers over the control it will progressively display the tool clip and description text.

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.tooltipDescription

# Set the value of the property.
commandInput_var.tooltipDescription = 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->tooltipDescription();

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

Property Value

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

Version

Introduced in version July 2015