Share via


FormListControl.height Method

Gets or sets the height of the control.

Syntax

public int height(int value, [int mode])

Run On

Client

Parameters

  • value
    Type: int
    An integer that indicates the height of a form list control.
  • mode
    Type: int
    An integer that indicates how the height is calculated; optional.
    This can be one of the following values:

Return Value

Type: int
The height of the control in pixels.

Remarks

Exact mode is used if the value parameter is omitted. Calculate the height according to the following table.

Mode

Height calculation

-1 – Exact

The exact height of the control in pixels is used.

0 – Auto

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

1 – Column height

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

The height and the height calculation mode can be set separately.

Examples

The following example shows a call to the height method to the set the height of the control to 120 pixels.

static void createForm(Args _args) 
{ 
    Args args; 
    Form form; 
    FormRun formRun; 
    FormBuildDesign formBuildDesign; 
    FormBuildDataSource formBuildDataSource; 
    FormBuildListControl formBuildListControl; 
    FormListControl formListControl; 
    int idx4; 
    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 a form list control. 
    formBuildListControl = 
 formBuildDesign.addControl(FormControlType::ListView,"List"); 
    idx4 = formBuildListControl.id(); 
 
    args = new Args(); 
    args.object(form); 
 
    // Create the run-time form, and then specifiy the control height. 
    formRun = classfactory.formRunClass(args); 
 
    formRun.run(); 
    formRun.detach(); 
 
    formListControl = formRun.control(idx4); 
    formListControl.height(120,-1); 
}

See Also

FormListControl Class

FormTreeControl.heightMode Method

FormTreeControl.heightValue Method