UserForm.Left Property

Applies to TestComplete 14.40, last modified on April 22, 2021

Description

Use the Left property to obtain or set the horizontal coordinate of the form’s left edge, relative to the screen. The default value of the Left property is such that the form is centered on the screen horizontally when it is displayed for the first time. This value is equal to:

aqConvert.VarToInt((Sys.Desktop.Width - UserFormObj.Width)/2)

If you need the form to appear in the custom position on the screen, use the Left property to specify the desired horizontal coordinate, and the Top property to specify the vertical coordinate.

Declaration

UserForm.Left

Read-Write Property Integer

Applies To

The property is applied to the following object:

Property Value

An integer value that specifies the horizontal position of the form’s left edge, in pixels.

Example

The following code snippet sets the form’s caption, size and initial position on the screen, displays the form and checks which form button the user has pressed to close the form.

JavaScript, JScript

function FormTest()
{

  var TestForm, mr;
  // Obtains the user form
  TestForm = UserForms.FormByName("TestForm");

  // Sets the form’s caption
  TestForm.Caption = "Press any button";
  // Sets the coordinates of the form’s top edge
  TestForm.Left = 500;
  TestForm.Top = 500;

  // Sets the form’s size
  TestForm.Width = 214;
  TestForm.Height = 100;

  // Displays the form and checks what button the user has pressed
  mr = TestForm.ShowModal();
  if (mr == mrOK)
    ShowMessage("The OK button was pressed");
  else
    ShowMessage("The Cancel button was pressed");

}

Python

def FormTest():
  # Obtains the user form
  TestForm = UserForms.FormByName["TestForm"]
  # Sets the form's caption
  TestForm.Caption = "Press any button"
  # Sets the coordinates of the form's top edge
  TestForm.Left = 500
  TestForm.Top = 500
  # Sets the form's size
  TestForm.Width = 214
  TestForm.Height = 100
  # Displays the form and checks what button the user has pressed
  mr = TestForm.ShowModal()
  if mr == mrOK:
    ShowMessage("The OK button was pressed")
  else:
    ShowMessage("The Cancel button was pressed")

VBScript

Sub FormTest

  Dim TestForm, mr

  ' Obtains the user form
  Set TestForm = UserForms.FormByName("TestForm")

  ' Sets the form’s caption
  TestForm.Caption = "Press any button"
  ' Sets the coordinates of the form’s top edge
  TestForm.Left = 500
  TestForm.Top = 500

  ' Sets the form’s size
  TestForm.Width = 214
  TestForm.Height = 100

  ' Displays the form and checks what button the user has pressed
  mr = TestForm.ShowModal
  If mr = mrOK Then
    ShowMessage "The OK button was pressed"
  Else
    ShowMessage "The Cancel button was pressed"
  End If

End Sub

DelphiScript

procedure FormTest();
var TestForm, mr;
begin

  // Obtains the user form
  TestForm := UserForms.FormByName('TestForm');

  // Sets the form’s caption
  TestForm.Caption := 'Press any button';
  // Sets the coordinates of the form’s top edge
  TestForm.Left := 500;
  TestForm.Top := 500;

  // Sets the form’s size
  TestForm.Width := 214;
  TestForm.Height := 100;

  // Displays the form and checks what button the user has pressed
  mr := TestForm.ShowModal;
  if mr = mrOK then
    ShowMessage('The OK button was pressed')
  else
    ShowMessage('The Cancel button was pressed');

end;

C++Script, C#Script

function FormTest()
{

  var TestForm, mr;
  // Obtains the user form
  TestForm = UserForms["FormByName"]("TestForm");

  // Sets the form’s caption
  TestForm["Caption"] = "Press any button";
  // Sets the coordinates of the form’s top edge
  TestForm["Left"] = 500;
  TestForm["Top"] = 500;

  // Sets the form’s size
  TestForm["Width"] = 214;
  TestForm["Height"] = 100;

  // Displays the form and checks what button the user has pressed
  mr = TestForm["ShowModal"]();
  if (mr == mrOK)
    ShowMessage("The OK button was pressed");
  else
    ShowMessage("The Cancel button was pressed");

}

See Also

Height Property
Top Property
Width Property

Highlight search results