Description
Use the Caption property to determine or set the form’s caption text displayed in the title bar. By default, the form caption is the same as the form name that is returned by the Name property.
Declaration
UserForm.Caption
| Read-Write Property | Text |
Applies To
The property is applied to the following object:
Property Value
The string that contains the caption text.
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");
}
{
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
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;
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");
}
{
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");
}