We recommend using Visual Studio 2017
This documentation is archived and is not being maintained.

UIMap Class

Represents a map of user interface (UI) elements for serialization and deserialization of a UITest object.


Namespace:  Microsoft.VisualStudio.TestTools.UITest.Common.UIMap
Assembly:  Microsoft.VisualStudio.TestTools.UITest.Common (in Microsoft.VisualStudio.TestTools.UITest.Common.dll)

public class UIMap

The UIMap type exposes the following members.

Public methodUIMapInitializes a new instance of the UIMap class.

Public propertyFileNameGets or sets the name of the XML file for this map.
Public propertyIdGets or sets the identifier for this map.
Public propertyTopLevelWindowsGets a collection of the top-level windows in this map.

Public methodAddUIObjectAdds the provided UI element to this map.
Public methodAddUIObjectsAdds one or more UI elements to the map.
Public methodBindParametersBinds the parameters that are used in the objects of the map with the values that are specified in the provided value map.
Public methodClearRemoves all objects from the map.
Public methodContainsIndicates whether the provided UI object is in the map.
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetCountReturns the number of UI objects in this map.
Public methodGetEnumeratorReturns an enumerator that can enumerate through all the objects in this map. These objects include top-level windows.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetQueryIdFromIdReturns the query ID for the object that is specified by the provided ID.
Public methodGetTopLevelElementReturns the top element that contains the provided UI object.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetUIObjectFromUIObjectIdReturns the UI object that is specified by the provided ID.
Public methodGetUIObjectNameForActionReturns the UI object that is the subject of the provided UI test action.
Public methodGetUIObjectNameForElementReturns the name of the UI object that corresponds to the provided UI element.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodMergeUIObjectMerges a UI object from the provided UI map into this map by using the provided name for the object.
Public methodRemoveRemoves the given UI object from this map.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

This class is created and populated by the test framework and is used internally to invoke UITestAction objects. It is not intended to be used by your code.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.