CLIENTAREAHEIGHT Property

 

Returns a value indicating of height of the work area within the Window

 

 

Description:

 

The CLIENTAREAHEIGHT Property returns a numeric value indicating the height of the area within the Window in which other objects such as Controls can be displayed. It has a value less than the HEIGHT declared for the Window as it excludes other Window objects such as the Window borders, a HSCROLLBAR (if used) and/or a STATUSBAR (if used)

 

The image below demonstrates this. Both the CLIENTAREAHEIGHT and CLIENTAREAWIDTH values are less than the values defined for the Window HEIGHT and WIDTH

 

Client Area Height

 

Syntax:

 

    THISWINDOW | <FormName>.CLIENTAREAHEIGHT --> nFormHeight

 

Valid For Use With:

 

This Property is assumed to be available for use with all Window types

 

Notes:

  1. This property is only available after Window definition

  2. No help documentation was published with the original or subsequent releases of HMG

Properties:

 

The following Property is available after the Window has been defined

 

nFormHeight Numeric R Gets a numeric value representing the Window's client area height

 

D - Properties of this type can be used when defining a Window

R - Properties of this type can only be accessed (read) after the Window has been defined

W - Properties of this type can be changed (write) after the Window has been defined

 

See GETPROPERTY and SETPROPERTY functions for further infomation on accessing or changing properties or use semi-OOP syntax

 

Sample Code:

 

Sample code to test this Property can be found here