TextCommandPalette.snapTo Method

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

Description

Snaps this palette to another palette.

Syntax

"textCommandPalette_var" is a variable referencing a TextCommandPalette object.
returnValue = textCommandPalette_var.snapTo(palette, snapOption)
"textCommandPalette_var" is a variable referencing a TextCommandPalette object.

#include <Core/UserInterface/TextCommandPalette.h>

returnValue = textCommandPalette_var->snapTo(palette, snapOption);

Return Value

Type Description
boolean Returns true if the palette was successfully snapped to the other palette.

Parameters

Name Type Description
palette Palette Specifies the palette to snap to.
snapOption PaletteSnapOptions Specifies how this palette should be snapped to the other palette.

Version

Introduced in version August 2017