IgnorePrefixes Property

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

Description

The IgnorePrefixes property specifies whether TestComplete will ignore namespace prefixes when comparing XML documents with the Compare method of the XMLCheckpoint object. For instance, if the property is True, TestComplete will consider the following nodes as equal (the ignored parts are marked with blue):

XML

<ns1:myElement>Some value</ns1:myElement>
<myElement>Some value</myElement>

Declaration

XMLCheckpointOptionsObj.IgnorePrefixes

Read-Write Property Boolean
XMLCheckpointOptionsObj An expression, variable or parameter that specifies a reference to an XMLCheckpointOptions object

Applies To

The property is applied to the following object:

Property Value

True, if TestComplete will ignore prefixes during comparison, and False otherwise.

Remarks

The XMLCheckpointOptions object provides access to a copy of the element’s data. Changes made to the comparison settings via the IgnorePrefixes property will not be stored in the XMLCheckpoint element and will not be displayed in the XMLCheckpointOptions Element editor.

Example

The following example demonstrates how you can obtain the XMLCheckpointOtions object, set its IgnorePrefixes property value to True and compare XMLCheckpoint with the XML document.

JavaScript, JScript

function IgnorePrefixesDemo()
{

  var XMLCheckpoint, XMLOptions, XMLDoc;
  // Obtains the XMLCheckpoint object.
  XMLCheckpoint = XML.MyXMLCheckpoint;
  // Obtains the XMLCheckpointOptions object.
  XMLOptions = XMLCheckpoint.Options;

  // Enables the IgnorePrefixes XML checkpoint option.
  XMLOptions.IgnorePrefixes = true;

  // Specifies the XML document path.
  XMLDoc = "D:\\Work Folder\\XMLFile.xml";
  // Compares MyXMLCheckpoint with the XML document.
  XMLCheckpoint.Compare(XMLDoc)

}

Python

def IgnorePrefixesDemo():
  # Obtains the XMLCheckpoint object.
  XMLCheckpoint = XML.MyXMLCheckpoint
  # Obtains the XMLCheckpointOptions object.
  XMLOptions = XMLCheckpoint.Options
  # Enables the IgnorePrefixes XML checkpoint option.
  XMLOptions.IgnorePrefixes = True
  # Specifies the XML document path.
  XMLDoc = "D:\\Work Folder\\XMLFile.xml"
  # Compares MyXMLCheckpoint with the XML document.
  XMLCheckpoint.Compare(XMLDoc)

VBScript

Sub IgnorePrefixesDemo
Dim XMLCheckpoint, XMLOptions, XMLDoc

  ' Obtains the XMLCheckpoint object.
  Set XMLCheckpoint = XML.MyXMLCheckpoint
  ' Obtains the XMLCheckpointOptions object.
  Set XMLOptions = XMLCheckpoint.Options

  ' Enables the IgnorePrefixes XML checkpoint option.
  XMLOptions.IgnorePrefixes = True

  ' Specifies the XML document path.
  XMLDoc = "D:\Work Folder\XMLFile.xml"
  ' Compares MyXMLCheckpoint with the XML document.
  XMLCheckpoint.Compare(XMLDoc)

End Sub

DelphiScript

procedure IgnorePrefixesDemo();
var XMLCheckpoint, XMLOptions, XMLDoc;
begin

  // Obtains the XMLCheckpoint object.
  XMLCheckpoint := XML.MyXMLCheckpoint;
  // Obtains the XMLCheckpointOptions object.
  XMLOptions := XMLCheckpoint.Options;

  // Enables the IgnorePrefixes XML checkpoint option.
  XMLOptions.IgnorePrefixes := True;

  // Specifies the XML document path.
  XMLDoc: = 'D:\Work Folder\XMLFile.xml';
  // Compares MyXMLCheckpoint with the XML document.
  XMLCheckpoint.Compare(XMLDoc);

end;

C++Script, C#Script

function IgnorePrefixesDemo()
{

  var XMLCheckpoint, XMLOptions, XMLDoc;
  // Obtains the XMLCheckpoint object.
  XMLCheckpoint = XML["MyXMLCheckpoint"];
  // Obtains the XMLCheckpointOptions object.
  XMLOptions = XMLCheckpoint["Options"];

  // Enables the IgnorePrefixes XML checkpoint option.
  XMLOptions["IgnorePrefixes"] = true;

  // Specifies the XML document path.
  XMLDoc = "D:\\Work Folder\\XMLFile.xml";
  // Compares MyXMLCheckpoint with the XML document.
  XMLCheckpoint["Compare"](XMLDoc)

}

See Also

About XML Collection
Creating XML Checkpoints
About XML Checkpoints

Highlight search results