Test Design StudioGo to Previous Topic: Error ListGo to Next Topic: Properties

Object Browser

The Object Browser tool window is a powerful feature of Test Design Studio that allows you to browse the multitude of objects that are available for your tests. Built-in references, user-defined components, COM libraries, and loaded projects all appear in the Object Browser.

To display the Object Browser, select View -> Object Browser from the main menu.

The types of items visible in the Object Browser include (but are not limited to):

References

A reference is any item that contains components that are usable by a particular language. Typical references include:
Reference TypeDescription
Built-in Reference Built-in References outline the core objects usable by a particular language. This includes objects such as a built-in functions or constants. Test Design Studio provides comprehensive, built-in references for VBScript and Unified Functional Testing.
COM Libraries Libraries that support COM technology can be loaded as a custom component to browse the objects exposed by that library. This includes common libraries such as the Microsoft Scripting Runtime that will allow you to interact with a computer's file system. Loading this library in the Object Browser will allow you to determine all the capabilities and proper use of the FileSystemObject class exposed by that library.
User-Defined Components A user-defined component represents any file that is supported by Test Design Studio that might contain useful objects for creating tests. This includes, but is not limited to, the following types of files: Unified Functional Testing Tests, Unified Functional Testing Function Libraries (*.qfl), and VBScript Libraries (*.vbs). Any supported file that is opened by Test Design Studio is automatically added to the Object Browser, or you may also add components that will always be available.
The Container Tree is displayed to the left of the Object Browser and is used to display the available references.

Members

A member is any object that is stored within a reference. Members include, but are not limited to, the following: functions/subs, classes, variables, constants, enumerations, and actions. Members are typically displayed in the Member Tree located in the top-right corner of the Object Browser. Select any reference in the Container Tree and the members of that reference will be displayed in the Member Tree.

Any member that is a container for additional members will be listed in the Container Tree as a child node to the corresponding reference the member is located within. These types of members include classes, enumerations, and actions. This allows you to select that member in the Container Tree and see the additional members of that item in the Member Tree. For example, imagine you wanted to see the members of the RegExp class that is available within the VBScript built-in reference. You would first locate and expand the VBScript reference in the Container Tree. You would then locate and select the RegExp class in the Container Tree. Finally, the functions and properties of the RegExp class would be displayed in the Member Tree.

Note:   The RegExp class selection mentioned in the example is depicted in the screen shot above.

Item Descriptions

When a reference or member is selected in the Component Tree or Member Tree, a detailed description of that item is displayed in the Description Pane. Descriptions of built-in references and their members are pre-defined. Descriptions of COM libraries and their members are based on the details provided by the author of the library. Descriptions of user-defined components are derived from specially formatted XML Comments that can be entered directly in the text.

Controlling Visible References

You have the ability to control which references are displayed in the Container Tree using the Browse combo box located on the Object Browser toolbar. The available selections are:
SelectionDescription
All ComponentsAll available references are displayed.
Built-in ReferencesOnly built-in references will be displayed.
My SolutionOnly references that are part of the currently loaded solution will be displayed.
Custom Component SetOnly references specifically loaded by the user will be displayed.
Edit Custom Component SetSelect this option to add a new custom component to the Object Browser. Once the selection is complete, the Custom Component Set selection will be active.

Adding Custom Components

Any time you want to explore the objects stored in a supported file, you can add a reference to that component. Components are added by selecting Edit Custom Component Set from the Browse combo box or by clicking the ... button on the Object Browser toolbar. This will open the Edit Custom Component Set dialog.

Select the COM tab to add COM-based libraries from a list of components currently registered on your machine. Select the Browse tab to select a specific file to be added from supported file types. Once the item to be added is selected, click the Add button. The component will then be added to the Selected Components list. When all changes are complete, click the OK button. Cancel your changes at any time by clicking the Cancel.

Removing Custom Components

If at any time you want to remove a custom component, you may do so by selecting the component in the Container Tree and clicking the Remove Reference button on the Object Browser toolbar.

You may also remove components using the Edit Custom Component Set dialog. Open the dialog using the steps outlined in Adding Custom Components above. At the bottom of the Edit Custom Component dialog is a list of all currently loaded components. Select any of the loaded components and click the Remove button to remove the component.

Container Tree Options

In addition to controlling visible reference (see above), you may also control how reference members are displayed in the Container Tree. As previously discussed, certain members are displayed as child nodes under the corresponding reference in the Container Tree. These items can be displayed in three different ways:
ViewDescription
Sort AlphabeticallyAll members are displayed in alphabetical order based on their name.
Sort by Object TypeAll members are first sorted by their object type (i.e. class, interface, enum) and then secondarily sorted by their name.
Group by Object TypeAll members of the same type are grouped under a folder node and then sorted alphabetically within that group.
To select one of these options, right-click on the Component Tree and select the option from the context menu.

Member Tree Options

The items in a member tree can be displayed in four ways:
ViewDescription
Sort AlphabeticallyAll members are displayed in alphabetical order based on their name.
Sort by Member TypeAll members are first sorted by their member type (i.e. function, property, variable) and then secondarily sorted by their name.
Sort by Member AccessAll members are first sorted by their access type (i.e. public, private) and then secondarily sorted by their name.
Group by Member TypeAll members of the same type are grouped under a folder node and then sorted alphabetically within that group.
To select one of these options, right-click on the Member Tree and select the option from the context menu. From the same context menu, you may also control if public or private members are displayed.

Searching in Object Browser

A powerful feature of the Object Browser is the ability to quickly search the items that are loaded. This can enable a user to quickly find an item for which they cannot remember the full name.

To perform a search, enter your search string in the <Search> edit box located on the Object Browser toolbar. To execute the query, press the Enter key or click the Search button on the toolbar.

The screen shot above shows the results of a search for file. As you can see, various objects containing the text file are now displayed in the Container Tree. The portion of the name that matches the search query is highlighted with a dark background. You may still select any item in the Container Tree to see the description of that item in the Description Pane.

Click the Clear Search button on the Object Browser toolbar to clear the search results and return to normal operations.

Tip:   Search will also match on the value of a constant when that value exactly matches the search phrase. This can be used to lookup error codes or other constant values for which you want to know the source.