Share this page
Common.txt
This function library contains generic functions that can be useful for testing objects in any application or technology and also registers these functions for use as methods with Standard Windows test objects. The functions available are:
Functions
 AddToTestResults | This function reports an event from your test run to the Test Results. |
| GetCheckedProperty | This function returns the checked property of a specified Windows object. |
| GetDateProperty | This function returns the date property of a specified Windows object. |
| GetPositionProperty | This function returns the position property of a specified Windows object. |
| GetSelectionProperty | This function returns the selection property of a specified Windows object. |
| GetTextProperty | This function returns the text property of a specified Windows object. |
| GetValueProperty | This function returns the value property of a specified Windows object. |
| OpenApp | This function opens a specified application. |
| OutputProperty | This function returns the value of a specified property. |
| VerifyChecked | This function verifies if the check status of a Windows object matches its expected check status. |
| VerifyDate | This function verifies if the date of a Windows object matches its expected date. |
| VerifyDisabled | This function verifies if the specified Windows object is enabled (not disabled). |
| VerifyEnabled | This function verifies if the specified Windows object is enabled. |
| VerifyPosition | This function verifies if the selected status of a Windows object matches its expected selection status. |
| VerifyProperty | This function checks if the value of a property matches its expected value. |
| VerifyText | This function verifies if the text in a Windows object matches its expected text. |
| VerifyValue | This function checks if the value of a Windows object matches its expected value. |
AddToTestResults Function
Description
This function reports an event from your test run to the Test Results.
Syntax
AddToTestResults (status, StepName, details)
Parameter | Description |
|---|---|
status | The status of the step being reported. Valid values are micPass, micFail, micDone or micWarning. |
StepName | The object name of the step. |
details | Description of the report event. |
GetCheckedProperty Function
Description
This function returns the checked property of a specified Windows object.
Syntax
GetCheckedProperty (obj)
Parameter | Description |
|---|---|
obj | A variable containing the object on which the function should be performed. |
IMPORTANT
This function is registered for the following objects: WinCheckBox and WinRadioButton.
GetDateProperty Function
Description
This function returns the date property of a specified Windows object.
Syntax
GetDateProperty (obj)
Parameter | Description |
|---|---|
obj | A variable containing the object on which the function should be performed. |
IMPORTANT
This function is registered for the following object: WinCalendar.
GetPositionProperty Function
Description
This function returns the position property of a specified Windows object.
Syntax
GetPositionProperty (obj)
Parameter | Description |
|---|---|
obj | A variable containing the object on which the function should be performed. |
IMPORTANT
This function is registered for the following object: WinSpin.
GetSelectionProperty Function
Description
This function returns the selection property of a specified Windows object.
Syntax
GetSelectionProperty (obj)
Parameter | Description |
|---|---|
obj | A variable containing the object on which the function should be performed. |
IMPORTANT
This function is registered for the following objects: WinList, WinListView, ListView20WndClass and ListView20WndClass.
GetTextProperty Function
Description
This function returns the text property of a specified Windows object.
Syntax
GetTextProperty (obj)
Parameter | Description |
|---|---|
obj | A variable containing the object on which the function should be performed. |
IMPORTANT
This function is registered for the following objects: Static, WinComboBox, WinEdit, and WinEditor.
GetValueProperty Function
Description
This function returns the value property of a specified Windows object.
Syntax
GetValueProperty (obj)
Parameter | Description |
|---|---|
obj | A variable containing the object on which the function should be performed. |
IMPORTANT
This function is registered for the following objects: Static, WinCalendar, WinCheckBox, WinComboBox, WinEdit, WinEditor, WinList, WinListView, WinRadioButton, WinSpin, WinTab, WinTreeView, ListView20WndClass, and ListViewWndClass.
OpenApp Function
Description
This function opens a specified application.
Syntax
OpenApp (application)
Parameter | Description |
|---|---|
application | The full name (including location) of the application you want to open. |
OutputProperty Function
Description
This function returns the value of a specified property.
Syntax
OutputProperty (obj, PropertyName)
Parameter | Description |
|---|---|
obj | A variable containing the object on which the function should be performed. |
PropertyName | The name of the property. |
Return Value
The value of the property.
IMPORTANT
This function is registered for the following objects: Dialog, Static, WinButton, WinCalendar, WinCheckBox, WinComboBox, Window, WinEdit, WinEditor, WinList, WinListView, WinObject, WinRadioButton, WinScrollBar, WinSpin, WinStatusBar, WinTab, WinToolbar, WinTreeView, ListView20WndClass, ListViewWndClass.
VerifyChecked Function
Description
This function verifies if the check status of a Windows object matches its expected check status.
Syntax
VerifyChecked (obj, ExpectedChecked)
Parameter | Description |
|---|---|
obj | The object name and object type to be checked. |
ExpectedChecked | The expected check status for the object. |
Return Value
True or False.
IMPORTANT
This function is registered for the following objects: WinCheckBox and WinRadioButton.
VerifyDate Function
Description
This function verifies if the date of a Windows object matches its expected date.
Syntax
VerifyDate (obj, ExpectedDate)
Parameter | Description |
|---|---|
obj | The object name and object type to be checked. |
ExpectedDate | The expected date for the object. |
Return Value
True or False.
IMPORTANT
This function is registered for the following object: WinCalendar.
VerifyDisabled Function
Description
This function verifies if the specified Windows object is enabled (not disabled).
Syntax
VerifyDisabled (obj)
Parameter | Description |
|---|---|
obj | The object name and object type of the property to be verified. |
Return Value
True if the object is enabled.
IMPORTANT
This function is only for backward compatibility. You should use the VerifyEnabled function.
This function is registered for the following objects: Dialog, Static, WinButton, WinCalendar, WinCheckBox, WinComboBox, Window, WinEdit, WinEditor, WinList, WinListView, WinObject, WinRadioButton, WinScrollBar, WinSpin, WinStatusBar, WinTab, WinToolbar, WinTreeView, ListView20WndClass, ListViewWndClass.
VerifyEnabled Function
Description
This function verifies if the specified Windows object is enabled.
Syntax
VerifyEnabled (obj)
Parameter | Description |
|---|---|
obj | The object name and object type of the property to be verified. |
Return Value
True if the object is enabled.
IMPORTANT
This function is registered for the following objects: Dialog, Static, WinButton, WinCalendar, WinCheckBox, WinComboBox, Window, WinEdit, WinEditor, WinList, WinListView, WinObject, WinRadioButton, WinScrollBar, WinSpin, WinStatusBar, WinTab, WinToolbar, WinTreeView, ListView20WndClass, ListViewWndClass.
VerifyPosition Function
Description
This function verifies if the selected status of a Windows object matches its expected selection status.
Syntax
VerifyPosition (obj, ExpectedPosition)
Parameter | Description |
|---|---|
obj | The object name and object type to be checked. |
ExpectedPosition | The expected position for the object. |
Return Value
True or False.
IMPORTANT
This function is registered for the following object: WinSpin.
VerifyProperty Function
Description
This function checks if the value of a property matches its expected value.
Syntax
VerifyProperty (obj, PropertyName, ExpectedValue)
Parameter | Description |
|---|---|
obj | The object name and object type of the property to be checked. |
PropertyName | The name of the property to be checked. |
ExpectedValue | The expected value of the property. |
Return Value
True or False.
IMPORTANT
This function is registered for the following objects: Dialog, Static, WinButton, WinCalendar, WinCheckBox, WinComboBox, Window, WinEdit, WinEditor, WinList, WinListView, WinObject, WinRadioButton, WinScrollBar, WinSpin, WinStatusBar, WinTab, WinToolbar, WinTreeView, ListView20WndClass, ListViewWndClass.
VerifySelection Function
Description
This function verifies if the selected status of a Windows object matches its expected selection status.
Syntax
VerifySelection (obj, ExpectedSelection)
Parameter | Description |
|---|---|
obj | The object name and object type to be checked. |
ExpectedSelection | The expected selection status for the object. |
Return Value
True or False.
IMPORTANT
This function is registered for the following objects: WinList, WinListView, ListView20WndClass, and ListView20WndClass.
VerifyText Function
Description
This function verifies if the text in a Windows object matches its expected text.
Syntax
VerifyText (obj, ExpectedText)
Parameter | Description |
|---|---|
obj | The object name and object type to be checked. |
ExpectedText | The expected text for the object. |
Return Value
True or False.
IMPORTANT
This function is registered for the following objects: Static, WinComboBox, WinEdit, and WinEditor.
VerifyValue Function
Description
This function checks if the value of a Windows object matches its expected value.
Syntax
VerifyValue (obj, ExpectedValue)
Parameter | Description |
|---|---|
obj | The object name and object type to be checked. |
ExpectedValue | The expected value of the object. |
Return Value
True or False.
IMPORTANT
This function is registered for the following objects: Static, WinCalendar, WinCheckBox, WinComboBox, WinEdit, WinEditor, WinList, WinListView, WinRadioButton, WinSpin, WinTab, WinTreeView, ListView20WndClass, and ListViewWndClass.
See also:
