UIMap Class

Article
04/28/2015

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

Inheritance Hierarchy

Object
Microsoft.VisualStudio.TestTools.UITest.Common.UIMap.UIMap

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

Syntax

'Declaration
<SerializableAttribute> _
Public Class UIMap

[SerializableAttribute]
public class UIMap

[SerializableAttribute]
public ref class UIMap

[<SerializableAttribute>]
type UIMap =  class end

public class UIMap

The UIMap type exposes the following members.

Constructors

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

Top

Properties

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

Top

Methods

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

Top

Remarks

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.