WorkSpaceWidth

Description

Obtains the width of the workspace within the boundaries of the specified window.

Applies to

Window objects

Syntax

windowname.WorkSpaceWidth ( )

Argument

Description

windowname

The name of the window for which you want the width of the workspace area


Return value

Integer.

Returns the width of the workspace area (in PowerBuilder units) in windowname. If an error occurs, WorkSpaceWidth returns -1. If windowname is null, WorkSpaceWidth returns null.

Usage

The workspace height does not include the thickness of the frame, the title bar, menu bar, horizontal scroll bar, or any toolbars at the top or bottom. The workspace height includes the MicroHelp status bar.

The workspace width does not include the thickness of the frame, the vertical scroll bar, or any toolbars on the left or right.

Examples

This example returns the width of the workspace area in the w_employee window:

integer Width
Width = w_employee.WorkSpaceWidth()

See also

PointerX

PointerY

WorkSpaceHeight

WorkSpaceX

WorkSpaceY