FormGroupControl.height Method

Article
04/11/2014

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 value that indicates the height of a form group control.

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

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 control height to 120 pixels.

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.height(120, -1); 
}

Share via