Vicon Shogun banner

Description

Floats a docking window.

This command gives the user the ability to programmatically "float" a docking window, as well as control its position on the screen. Usually, the user does this by clicking and dragging the mouse.

If neither -left nor -top are specified, the docking window's position is cascaded in relation to other docking windows.

Both Shogun Post's docking windows and user windows can be controlled using this command.

Functional area

Interface

Command syntax

Syntax

floatWindow "windowName" [-left integer] [-top integer] [-width integer] [-height integer]

Arguments

NameTypeRequiredComments
windowNamestringyesName of the window to float. Can be one of Shogun Post's docking windows or a user window.

Flags

NameFlag argumentsArgument typeExclusive toComments
left1integerSpecifies the position, in pixels, of the left side of the docking window, from the top left corner of the screen.
top1integerSpecifies the position, in pixels, of the top side of the docking window, from the top left corner of the screen.
width1integerSpecifies the width, in pixels, of the docking window
height1integerSpecifies the height in pixels, of the docking window

Return value

void

Examples

// Create a user window and specify its screen position and size 
createWindow "FloatTest";
floatWindow "FloatTest" -left 100 -top 300 -width 300 -height 200;

Additional information

Related commands