HTMLTableCheckpoint.Compare

HTML Table Checkpoint Extension

previous page next page

HTMLTableCheckpoint Object

HTMLTableCheckpoint.Compare

The method compares an HTML Table Checkpoint element with a tested HTML table.

Declaration

HTMLTableCheckpointObj.Compare(xmlCheckpointName, object, reportDifference) Parameters

xmlCheckpointName	[in]	Required	String
object	[in]	Required	String
reportDifference	[in]	Required	Boolean
Result			Boolean

Description

Use the Compare method to compare the values stored in project element, to which the HTMLTableCheckpoint object corresponds, with actual data of the HTML table that is specified by the object parameter.

Parameters

The method has the following parameters:

xmlCheckpointName

Specifies the project element that contains the baseline data with which the tested table’s data will be compared. This element belongs to the Stores | XML collection of your project.

object

Specifies the full name of the tested HTML table

reportDifference

Specifies whether the method posts a warning message about each difference to the test log.

Return Value

True, if the comparison is successful and False otherwise.

Remarks

The Compare method returns True or False indicating the comparison result. It also posts a warning message for each difference found during the comparison. If there are several differences, the method will post several warning messages. To disable this functionality, pass False to the reportDifference parameter when calling the method.

For sample code, see Creating HTML Table Checkpoints in Scripts.

previous page start next page