IDLgrWindow::GetDimensions

The IDLgrWindow::GetDimensions function method returns a two-element vector, [width, height], representing the visible dimensions (in pixel units) of this window.

Syntax

Result = Obj -> [IDLgrWindow::]GetDimensions ( [, MINIMUM_VIRTUAL_DIMENSIONS=variable] [, ORIGINAL_VIRTUAL_DIMENSIONS=variable] [, VIRTUAL_DIMENSIONS=variable] [, VISIBLE_LOCATION=variable])

Return Value

Returns the visible dimensions of the window (in pixel units) in a two-element vector [width, height].

Arguments

None

Keywords

MINIMUM_VIRTUAL_DIMENSIONS

Set this keyword to a named variable that will contain a two-element vector, [width, height], representing the minimum allowed virtual dimensions for this window.

Note: Returning MINIMUM_VIRTUAL_DIMENSIONS using GetDimensions provides the width and height of the window in pixel units. The property, MINIMUM_VIRTUAL_DIMENSIONS, returns the dimensions of the window in units specified by the UNITS property.

ORIGINAL_VIRTUAL_DIMENSIONS

Set this keyword to a named variable that will contain a two-element vector, [width, height], representing the virtual dimensions in pixels for this window if the current zoom factor was 1.0.

VIRTUAL_DIMENSIONS

Set this keyword to a named variable that will contain a two-element vector, [width, height], representing the dimensions in pixels of the virtual canvas for this window.

VISIBLE_LOCATION

Set this keyword to a named variable that will contain a two-element vector, [x, y], representing the lower-left location of the visible portion of the window (relative to its virtual canvas).

Version History

6.1	Introduced