xHarbour Reference Documentation > Function Reference

WFormat()

Defines the usable display area inside the current window.

Syntax

WFormat( [<nTopMargin>]   , ;
         [<nLeftMargin>]  , ;
         [<nBottomMargin>], ;
         [<nRightMargin>]   ) --> nWindowID

Arguments

<nTopMargin>

This is a numeric value specifying the number of rows at the top of a window that cannot be used for screen output. The default value is zero.

<nLeftMargin>

This is a numeric value specifying the number of columns at the left of a window that cannot be used for screen output. The default value is zero.

<nBottomMargin>

This is a numeric value specifying the number of rows at the bottom of a window that cannot be used for screen output. The default value is zero.

<nRightMargin>

This is a numeric value specifying the number of columns at the right of a window that cannot be used for screen output. The default value is zero.

Return

The function restricts the usable area for display inside a window to the area inside the window coordinates plus margins defined. Calling the function without parameters resets all margins to zero. WFormat() returns the ID of the current window as a numeric value.

Note:  function WBox() calls WFormat( 1, 1, 1, 1 ) so that the frame displayed by WBox() cannot be overwritten.

Info

See also:	WBox(), WSelect()
Category:	CT:Window , Windows (text mode)
Source:	ct\ctwin.c
LIB:	xhb.lib
DLL:	xhbdll.dll