Share via


FormGroupControl.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 height of the control 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 a call to the heightMode method to adjust the control height, based on an exact pixel value.

static void createForm(Args _args) 
{ 
    Args args; 
    Form form; 
    FormRun formRun; 
    FormBuildDesign formBuildDesign; 
    FormBuildDataSource formBuildDataSource; 
    FormBuildStringControl formBuildStringControl; 
    FormBuildGroupControl formBuildGroupControl; 
    FormGroupControl formGroupControl; 
    int idx; 
    DictTable dictTable; 
    CustTable custTable; 
 
    // Create the form header. 
    form = new Form(); 
 
    // Add data sources to the form. 
    dictTable = new DictTable(tableNum(custTable)); 
    formBuildDataSource = form.addDataSource(dictTable.name()); 
    formBuildDataSource.table(dictTable.id()); 
 
    // Create the form design. 
    formBuildDesign = form.addDesign("Design"); 
    formBuildDesign.caption("myForm"); 
 
    // Add controls. 
    formBuildGroupControl = 
 formBuildDesign.addControl(FormControlType::Group,"Group"); 
    idx = formBuildGroupControl.id(); 
  
    formBuildStringControl = 
 formBuildGroupControl.addControl(FormControlType::String,"String"); 
 
    // Add data fields to the controls. 
    formBuildGroupControl.dataSource(formBuildDataSource.id()); 
    formBuildStringControl.dataSource(formBuildDataSource.id()); 
    formBuildStringControl.dataField(2); 
 
    args = new Args(); 
    args.object(form); 
 
    // Create the run-time form. 
    formRun = classfactory.formRunClass(args); 
 
    formRun.run(); 
    formRun.detach(); 
 
    formGroupControl = formRun.control(idx); 
    formGroupControl.heightMode(-1); 
    formGroupControl.heightValue(120); 
}

See Also

Reference

FormGroupControl Class