XMLCheckpointOptions Object

Applies to TestComplete 15.41, last modified on July 01, 2022

Description

The XMLCheckpointOptions object provides a scripting interface to the comparison settings of an XMLCheckpoint project element.

To obtain the XMLCheckpointOptions object in scripts, use the Options property of the XMLCheckpoint object (these objects provide access to the XMLCheckpoint elements of the Stores | XML collection).

Note: The XMLCheckpointOptions object provides access to a copy of the element’s settings. Changes made to these settings via the properties of the XMLCheckpointOptions object will not be stored to the element and will not be displayed in the XMLCheckpointOptions Element editor.

Members

Example

The following example demonstrates how you can obtain the XMLObjectOptions object from script.

JavaScript, JScript

function XMLOptionsDemo()
{

  var CheckpointName, XMLOptions;
  // Specifies the name of the needed XML checkpoint.
  CheckpointName = "MyXMLCheckpoint";
  // Checks if the checkpoint exists in the Stores | XML collection.
  if (XML.Contains(CheckpointName) == true)
    // Obtains the options of the XML checkpoint object.
    XMLOptions = XML.MyXmlCheckpoint.Options;
  else
    Log.Error("" + CheckpointName + " does not exist in the Stores | XML collection." );


}

Python

def XMLOptionsDemo():
  # Specifies the name of the needed XML checkpoint. 
  CheckpointName = "MyXMLCheckpoint"
  # Checks if the checkpoint exists in the Stores | XML collection. 
  if XML.Contains(CheckpointName) == True:
    # Obtains the options of the XML checkpoint object.
    XMLOptions = XML.MyXmlCheckpoint.Options
  else:
    Log.Error("" + CheckpointName + " does not exist in the Stores | XML collection." )

VBScript

Sub XMLOptionsDemo
Dim XMLOptions, CheckpointName

  ' Specifies the name of the needed XML checkpoint.
  CheckpointName = "MyXMLCheckpoint"
  ' Checks if the checkpoint exists in the Stores | XML collection.
  If XML.Contains(CheckpointName) = True Then
    ' Obtains the options of the XML checkpoint object.
    Set XMLOptions = XML.MyXmlCheckpoint.Options
  Else
    Log.Error("" & CheckpointName & " does not exist in the Stores | XML collection." )
  End If

End Sub

DelphiScript

procedure XMLOptionsDemo();
var XMLOptions, CheckpointName;
begin

  // Specifies the name of the needed XML checkpoint.
  CheckpointName := 'MyXMLCheckpoint';
  // Checks if the checkpoint exists in the Stores | XML collection.
  if XML.Contains(CheckpointName) = true then
    // Obtains the options of the XML checkpoint object.
    XMLOptions := XML.MyXmlCheckpoint.Options
  else
    Log.Error('' + CheckpointName + ' does not exist in the Stores | XML collection.');

end;

C++Script, C#Script

function XMLOptionsDemo()
{

  var CheckpointName, XMLOptions;
  // Specifies the name of the needed XML checkpoint.
  CheckpointName = "MyXMLCheckpoint";
  // Checks if the checkpoint exists in the Stores | XML collection.
  if (XML["Contains"](CheckpointName) == true)
    // Obtains the options of the XML checkpoint object.
    XMLOptions = XML["MyXmlCheckpoint"]["Options"];
  else
    Log["Error"]("" + CheckpointName + " does not exist in the Stores | XML collection." );


}

See Also

About XML Collection
Creating XML Checkpoints
About XML Checkpoints
XMLCheckpoint Object
Options Property
CreateCheckpointOptions Method

Highlight search results