Visual_Basic.txt

This function library contains functions for Visual Basic test objects and also registers these functions for use as methods with Visual Basic test objects. To use the functions in this file, you must also include the Common.txt function library file in your application area.

Functions

Method GetCheckedPropertyThis function returns the checked property of a specified Visual Basic object.
Method GetSelectionPropertyThis function returns the selection property of a specified Visual Basic object.
GetTextPropertyThis function returns the text property of a specified Visual Basic object.
OutputPropertyThis function returns the value of a specified property.
VerifyCheckedThis function verifies if the check status of a Visual Basic object matches its expected check status.
VerifyEnabledThis function verifies if the specified Visual Basic object is enabled.
VerifyPropertyThis function checks if the value of a property matches its expected value.
VerifySelectionThis function verifies if the selected status of a Visual Basic object matches its expected selection status.
VerifyTextThis function verifies if the text in a Visual Basic object matches its expected text.

Back to top

GetCheckedProperty Function

Description

This function returns the checked property of a specified Visual Basic 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: VbCheckBox and VbRadioButton.

Back to top

GetSelectionProperty Function

Description

This function returns the selection property of a specified Visual Basic 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: VbList, VbListView, and VbTreeView.

Back to top

GetTextProperty Function

Description

This function returns the text property of a specified Visual Basic 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: VbComboBox, VbList, VbListView, and VbTreeView.

Back to top

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 Visual Basic objects: VbButton, VbCheckBox, VbComboBox, VbEdit, VbEditor, VbFrame, VbList, VbLabel, VbListView, VbRadioButton, VbScrollBar, VbToolbar, VbTreeView, and VbWindow.

Back to top

VerifyChecked Function

Description

This function verifies if the check status of a Visual Basic 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: VbCheckBox and VbRadioButton.


.

VerifyEnabled Function

Description

This function verifies if the specified Visual Basic 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 Visual Basic objects: VbButton, VbCheckBox, VbComboBox, VbEdit, VbEditor, VbFrame, VbList, VbListView, VbRadioButton, VbScrollBar, VbToolbar, VbTreeView, and VbWindow.


.

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 Visual Basic objects: VbButton, VbCheckBox, VbComboBox, VbEdit, VbEditor, VbFrame, VbList, VbLabel, VbListView, VbRadioButton, VbScrollBar, VbToolbar, VbTreeView, and VbWindow.


.

VerifySelection Function

This function verifies if the selected status of a Visual Basic 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: VbList, VbListView, and VbTreeView.


.

VerifyText Function

Description

This function verifies if the text in a Visual Basic 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: VbComboBox, VbList, VbListView, and VbTreeView.


.

See also: