Share via


FormGroupControl.top Method

Sets or returns the vertical position of a form group control in pixels and specifies how the position is calculated.

Syntax

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

Run On

Client

Parameters

  • value
    Type: int
    An integer that indicates the vertical position of a form group control.
  • mode
    Type: int
    An integer value that indicates how the vertical position is calculated; optional.

Return Value

Type: int
An integer value that indicates the vertical position of a form group control in pixels.

Remarks

The mode parameter can be one of the following values:

  • -1 (default) – Use Exact mode, where the value of the value parameter is used exactly.

  • A FormTop enumeration value.

Examples

The following example calls the top method to set the vertical position to 50 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.top(50,-1); 
}

See Also

FormGroupControl Class

FormGroupControl.topMode Method

FormGroupControl.topValue Method