TextCommandPalette.isDockedInCanvas Property

Derived from: Palette.isDockedInCanvas

Description

Gets and sets whether this palette docks within the canvas area or against the edge of the Fusion window. The edge it docks to is controlled by the dockingState property.

When true, which is the default, docking the palette overlaps the canvas, leaving the rest of the Fusion window unchanged. When false, docking the palette spans the full edge of the Fusion window and the canvas and other content automatically resize to make room for it, the same way the Autodesk Assistant palette behaves.

This property only applies to API created palettes. Setting it on a native palette has no effect.

Syntax

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

# Set the value of the property.
textCommandPalette_var.isDockedInCanvas = propertyValue

#include <Core/UserInterface/TextCommandPalette.h>

// Get the value of the property.
boolean propertyValue = textCommandPalette_var->isDockedInCanvas();

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

// Get the value of the property.
propertyValue = textCommandPalette_var.isDockedInCanvas;

// Set the value of the property.
textCommandPalette_var.isDockedInCanvas = propertyValue;

Property Value

Version