WFCObject Method

Applies to TestComplete 14.10, last modified on June 5, 2019

Description

Use this method to obtain a scripting interface to the specified object of a Java application that was created with WFC classes. The resulting object contains both methods and properties defined in application code as well as methods, properties and actions provided by TestComplete.

Declaration

TestObj.WFCObject(Name)

TestObj A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section
Name [in]    Required    String    
Result Object

TestObj.WFCObject(ClassNameAccName)

TestObj A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section
ClassName [in]    Required    String    
AccName [in]    Required    String    
Result Object

TestObj.WFCObject(ClassNameAccNameIndex)

TestObj A variable, parameter or expression that specifies a reference to one of the objects listed in the Applies To section
ClassName [in]    Required    String    
AccName [in]    Required    String    
Index [in]    Required    Integer    
Result Object

Applies To

The method is applied to the following objects:

View Mode

To view this method in the Object Browser panel and in other panels and dialogs, activate the Advanced view mode.

Parameters

The method has the following parameters:

Name

The name of the desired object as it is specified in the tested application’s source code (the string that is returned by object’s getName method).

ClassName

The window’s class name is specified by application code (not the operating system’s class name). Note that you should specify the short class name, for instance, Form, rather than com.ms.wfc.ui.Form. You can use wildcards (* and ?) in this parameter.

AccName

Accessible window caption. You can use wildcards (* and ?) in this parameter.

Index

Index of the window among other windows belonging to the same parent object (TestObj).

The Index parameter is used only if an object contains two or more child objects that have the same class name and caption. It is used to distinguish these objects from each other. The first found object has an index of 1, the second -  2 and so on.

If there is only one child object with the specified class name and caption, index should not be specified. To decide whether the index should be used, explore your application in the Object Browser panel and use the naming format that is used by the panel.

Result Value

The WFCObject method returns an object that provides a scripting interface to an object located in a Java WFC application. If TestComplete cannot access the specified object (for example, this object does not exist), the method will return an empty stub object and post an error message to the test log. To determine whether WFCObject returns a valid object, use the Exists property of the resultant object. If this property returns False, then the returned object is a stub object and the call to WFCObject was not successful.

Remarks

The returned object contains both methods and properties defined in the application code as well as methods, properties and actions provided by TestComplete. The returned object may hold two or more methods and properties having the same name. When you call such a method or property, a naming conflict will occur. To avoid it and to specify which method or property is to be called, use the NativeJavaObject namespace.

The method is available only if the Java Application Support plugin is installed. Otherwise, the method is absent in the method list of the TestObj object.
If the plugin is installed, you cannot use the Window method to address windows of your Java WFC applications, you should use WFCObject instead.

Example

To view an example that demonstrates how to use the WFCObject method, see Addressing Objects in Java Applications.

See Also

Addressing Objects in Java Applications
Object Browser Naming Notation
Using Namespaces
About Open Applications
WaitWFCObject Method
Window Method
WaitWindow Method

Highlight search results