OutputLayoutManager.ConstrainToWorkspace(Array, Variable) Method

Top

Description

Determines whether the windows specified by windowIDs are constrained to remain within the boundaries of the FreeFlyer workspace. Call OutputLayout.ApplyUpdates() to perform the action.

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

Click here to see the documentation for this object in millisecond timing precision mode.

Method Signature

OutputLayoutManager.ConstrainToWorkspace(	Array windowIds,
	Variable constrain)

Arguments

windowIds
Description:	Window IDs.
Required Size:	At least 1

constrain

Description:

Determines whether the window will be contained by its workspace.

Valid Values:

Value	Label
0	Unconstrained
1	Constrained

Return Value

Type:

number

The return value is not used.

Syntax

myVariable1 = OutputLayout.ConstrainToWorkspace(myArray1, myVariable2);