UIMap Class

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

Inheritance Hierarchy


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


<SerializableAttribute> _
Public Class UIMap
public class UIMap
public ref class UIMap
type UIMap =  class end
public class UIMap

The UIMap type exposes the following members.


  Name Description
Public method UIMap Initializes a new instance of the UIMap class.



  Name Description
Public property FileName Gets or sets the name of the XML file for this map.
Public property Id Gets or sets the identifier for this map.
Public property TopLevelWindows Gets a collection of the top-level windows in this map.



  Name Description
Public method AddUIObject Adds the provided UI element to this map.
Public method AddUIObjects Adds one or more UI elements to the map.
Public method BindParameters Binds the parameters that are used in the objects of the map with the values that are specified in the provided value map.
Public method Clear Removes all objects from the map.
Public method Contains Indicates whether the provided UI object is in the map.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetCount Returns the number of UI objects in this map.
Public method GetEnumerator Returns an enumerator that can enumerate through all the objects in this map. These objects include top-level windows.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetQueryIdFromId Returns the query ID for the object that is specified by the provided ID.
Public method GetTopLevelElement Returns the top element that contains the provided UI object.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetUIObjectFromUIObjectId Returns the UI object that is specified by the provided ID.
Public method GetUIObjectNameForAction Returns the UI object that is the subject of the provided UI test action.
Public method GetUIObjectNameForElement Returns the name of the UI object that corresponds to the provided UI element.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method MergeUIObject Merges a UI object from the provided UI map into this map by using the provided name for the object.
Public method Remove Removes the given UI object from this map.
Public method ToString Returns 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.

Thread Safety

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

See Also


Microsoft.VisualStudio.TestTools.UITest.Common.UIMap Namespace