OutputLayoutManager.ConstrainToWorkspace(Variable, Variable) Method

Top

Description

Determines whether the window specified by windowID is 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 millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

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

Method Signature

OutputLayoutManager.ConstrainToWorkspace(	Variable windowId,
	Variable constrain)

Arguments

windowId
Description:	Window ID.
Valid Range:	windowId ≥ 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(myVariable2, myVariable3);