IsFiltered Property

Applies to TestComplete 15.68, last modified on October 16, 2024

The object-driven testing (ODT) functionality is deprecated. Do not use it to create new tests. It will be removed from the product in one of the future releases. As an alternative, you can create custom classes in your scripts. For more information, see Alternatives to the ODT functionality.

Description

The ArrayObject.IsFiltered property returns True if TestComplete needs to process the given array object when walking down the custom object hierarchy in the manner described in the Controlling Object-Driven Tests topic.

Declaration

ArrayObjectObj.IsFiltered

Read-Only Property Boolean
ArrayObjectObj An expression, variable or parameter that specifies a reference to an ArrayObject object

Applies To

The property is applied to the following object:

Property Value

True if TestComplete needs to process the given array object when walking down the custom object hierarchy.

Example

The code below creates a new data group, adds the MyVariable variable to it and then adds a new property of the array type to this variable. After that, the routine checks whether the created property is processed when TestComplete is walking down the custom object hierarchy.

JavaScript, JScript

function IsFilteredExample()
{
    // Adds a new data group
    var Data = ODT.Data.AddGroup("TestData");
    // Adds a new variable of the array type
    var sVar = Data.AddVarOfArrayType("MyVariable");

    // Checks whether the variable is processed
    // when TestComplete is walking down the custom object hierarchy
    if ( sVar.IsFiltered )
       Log.Message("The MyVariable variable is processed.")
    else
       Log.Message("The MyVariable variable is not processed.");
}

VBScript

Sub IsFilteredExample
    ' Adds a new data group
    Set Data = ODT.Data.AddGroup("TestData")
    ' Adds a new variable of the array type
    Set sVar = Data.AddVarOfArrayType("MyVariable")

    ' Checks whether the variable is processed
    ' when TestComplete is walking down the custom object hierarchy
    If sVar.IsFiltered Then
       Log.Message("The MyVariable variable is processed.")
    Else
       Log.Message("The MyVariable variable is not processed.")
    End If
End Sub

DelphiScript

function IsFilteredExample;
var Data, sVar;
begin
    // Adds a new data group
    Data := ODT.Data.AddGroup('TestData');
    // Adds a new variable of the array type
    sVar := Data.AddVarOfArrayType('MyVariable');

    // Checks whether the variable is processed
    // when TestComplete is walking down the custom object hierarchy
    if ( sVar.IsFiltered ) then
       Log.Message('The MyVariable variable is processed.')
    else
       Log.Message('The MyVariable variable is not processed.');
end;

C++Script, C#Script

function IsFilteredExample()
{
    // Adds a new data group
    var Data = ODT["Data"]["AddGroup"]("TestData");
    // Adds a new variable of the array type
    var sVar = Data["AddVarOfArrayType"]("MyVariable");

    // Checks whether the variable is processed
    // when TestComplete is walking down the custom object hierarchy
    if ( sVar["IsFiltered"] )
       Log["Message"]("The MyVariable variable is processed.")
    else
       Log["Message"]("The MyVariable variable is not processed.");
}

See Also

IsFiltered Property

Highlight search results