FormControl.heightMode Method

Gets or sets a calculation mode for the height of the control.

Syntax

public int heightMode([int value])

Run On

Client

Parameters

  • value
    Type: int
    An integer value that indicates how the control height is calculated; optional.

Return Value

Type: int
The calculation mode.

Remarks

Calculate the height according to the following table.

Mode

Height calculation

Exact

The exact height of the control in pixels is used.

Auto

The height of the control is calculated automatically, and the value parameter is ignored.

Column height

The layout of the form determines the height of the control.

The height of the control might change when the calculation mode is set to Auto or Column height.

Examples

The following example shows how to return and set the height calculation mode for a form control.

int nHeightMode; 
 
// The ctrl variable was previously assigned 
// as a form control variable. 
 
// Retrieve the height mode. 
nHeightMode = ctrl.HeightMode(); 
 
// Set the height mode. 
ctrl.heightMode(-1); 
 
// Set the height. 
ctrl.heightValue(16);

See Also

FormControl Class

FormControl.height Method

FormControl.heightValue Method