TextCommandPalette.dockingOption Property

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

Description

Defines the docking behavior for this palette. This controls how the user is allowed to dock the palette.

Syntax

"textCommandPalette_var" is a variable referencing a TextCommandPalette object.

# Get the value of the property.
propertyValue = textCommandPalette_var.dockingOption

# Set the value of the property.
textCommandPalette_var.dockingOption = propertyValue
"textCommandPalette_var" is a variable referencing a TextCommandPalette object.
#include <Core/UserInterface/TextCommandPalette.h>

// Get the value of the property.
PaletteDockingOptions propertyValue = textCommandPalette_var->dockingOption();

// Set the value of the property, where value_var is a PaletteDockingOptions.
bool returnValue = textCommandPalette_var->dockingOption(value_var);

Property Value

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

Version

Introduced in version August 2017