Web Accessibility Checkpoint Operation

Applies to TestComplete 15.47, last modified on January 20, 2023

Description

The Web Accessibility Checkpoint operation performs various checking and verifying actions over web pages. For instance, using this operation you can check whether all of the IMG tags on the tested web page have the ALT attribute specified, or whether all the INPUT, SELECT, and TEXTAREA elements on the page have the TABINDEX attribute specified.

When you add the operation to your test, TestComplete displays the Checkpoint dialog, where you specify the tested web page, the verification settings and the name of the Web Accessibility project element that will be used for verification. For detailed information on working with this dialog, see the dialog’s description.

Requirements

This operation is available only if you have a license for the TestComplete Web module.

Operation Result

If the contents of the tested web page match the specified verification settings, the operation returns True and posts a checkpoint message () to the test log. Otherwise, the operation returns False and posts an error message () to the log. For information on how to check the operation’s result value, see Checking Operation Result.

Scripting Analogue

The operation is analogue to the WebAccessibility.Compare and WebAccessibility.Check scripting methods.

Child Operations

The operation cannot have child operations.

Operation Parameters

The operation uses the following parameters:

Web Accessibility Element

Specifies the name of the Web Accessibility project element that stores the verification settings. The element’s name is shown in the Operation column of the Keyword Test editor. See below for information on how to specify another element. For information on verification settings, see Web Accessibility Checkpoint Settings.

PageObject

A reference to the Page object that provides scripting access to the tested web page. The object name is shown in the Value column of the Keyword Test editor along with other parameters of the operation.

Timeout

Integer. Specifies the number of milliseconds the operation will wait until the specified Page object becomes available. Use this parameter if the tested web page is not available at the moment of the check, or if the web page contents is generated dynamically for some time after the page is loaded.

By default, Timeout is -1, what means that the waiting time is specified by the Auto-wait timeout project property. If Timeout is 0, the operation does not wait for the Page object.

This parameter is shown in the Value column of the Keyword Test editor along with other parameters of the operation.

You specify the Web Accessibility element and the Page object in the Checkpoint dialog that TestComplete calls when you append the operation to your keyword test. These parameters can be modified at any time. To do this, double-click the operation in the Keyword Test editor. This will invoke the Web Accessibility Checkpoint dialog in which you can specify a new value for the desired parameter. Other parameters can be modified in the Keyword Test editor or the Operation Parameters dialog (see below).

To specify another Web Accessibility element

To specify another Web Accessibility element that will be used by the verification procedure:

  • Select the operation’s row in the test.

  • Select the Operation cell and then click within it or press F2. This will activate the in-place editor.

  • Choose the desired Web Accessibility element from the drop-down list.

  • Press Enter to confirm the change and close the in-place editor, or press Esc to close the editor discarding any changes.

-- or --

  • Double-click the desired operation in the Keyword Test editor. This will invoke the Web Accessibility Checkpoint dialog.

To change the verification settings

To change the verification settings, edit the Web Accessibility element (since the settings are stored in the element). For detailed information see Modifying WebTesting Elements.

To change other parameters

To specify the PageObject and Timeout:

  • Select the operation in the Keyword Test editor.

  • Select the Value cell and then click within it or press F2. This will activate the in-place editor.

  • Click the ellipsis button of the in-place editor. This will display the Operation Parameters dialog in which you can specify the parameters’ values. For detailed information on setting the values in the dialog, see Specifying Operation Parameters.

  • Click OK to close the dialog and apply changes.

  • Press Enter to confirm the change and close the in-place editor, or press Esc to close the editor discarding any changes.

Remarks

For information on web accessibility checkpoints, on creating and modifying them and on how the Accessibility procedure works, see the About Web Accessibility Checkpoints section.

See Also

Checkpoints Category
About Web Accessibility Checkpoints
About Web Accessibility Element Editor
Modifying WebTesting Elements
Specifying Operation Parameters
Checking Operation Result

Highlight search results