DADiSP Worksheet Functions > Function Categories > Query Functions > GETWSXR

 

GETWSXR

Purpose:

Returns the right coordinate of the Worksheet or Worksheet display area.

Syntax:

GETWSXR(devcoord, region)

devcoord

-

Optional. An integer, If 0 (default), return the normalized coordinate. If 1, return device (pixel) coordinate.

region

-

Optional. An integer. If 0 (default), return the coordinate of the Worksheet. If 1, return the coordinate of the Worksheet display area.

Returns:

A real normalized coordinate or an integer device coordinate.

Example:

setwsx(0.1, 0.9);

xrn = getwsxr;

xrd = getwsxr(1);

 

The width of the displayed Worksheet is adjusted such that the left and right margins are set to 10% of the total Worksheet area width. The width of the displayed Worksheet is 90% of the total Worksheet area width.

 

The variable xrn == 0.9 contains the system independent normalized right coordinate of the Worksheet and xrd contains the system dependent pixel coordinate, e.g. xrd == 906.

Remarks:

The returned values are specified in normalized (device independent) or device (pixel based) coordinates. The coordinates of the Worksheet are relative to the upper left corner of the Worksheet display area.

 

If the region parameter is 1, the returned coordinates are for the Worksheet display area, independent of the size of the Worksheet.

 

See GETWSCOORDS to return all the coordinates of the Worksheet.

See Also:

GETMENUCOORDS

GETWSYB

GETWSYT

MENUFILE

SETMENUCOORDS

SETWSCOORDS

SETWSX

SETWSY

SETWSX

SETWSY