UIObject Class

Represents an object in the user interface (UI) for the test framework.

Inheritance Hierarchy

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

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 UIObject _
    Implements ICloneable
[SerializableAttribute]
public class UIObject : ICloneable
[SerializableAttribute]
public ref class UIObject : ICloneable
[<SerializableAttribute>]
type UIObject =  
    class 
        interface ICloneable 
    end
public class UIObject implements ICloneable

The UIObject type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property Condition Gets or sets the condition of this object.
Public property ControlType Gets or sets the control type of this object.
Public property Descendants Gets a collection of all UI objects that are contained within this UI object.
Public property FriendlyName Gets or sets a friendly name for this object.
Public property Id Gets the ID for this object.
Public property Item Gets the specified UI child object in this object that has the given UI object ID.
Public property Name Gets or sets the name of the object.
Public property QueryId Gets or sets the query ID for this object.
Public property SearchConfigurations Gets or sets a string array of search configuration.
Public property SessionId Gets or sets the ID for a top-level element for the recording session.
Public property SpecialControlType Gets or sets the special type for this UI object.
Public property SupportLevel Gets or sets the level at which the current technology supports this UI object.
Public property SupportLevelWrapper Gets or sets a string version of the actual level at which the current technology supports this UI object for serialization and deserialization of the SupportLevel property.
Public property TechnologyName Gets or sets the name of the technology that supports this UI object.
Public property WindowTitles Gets a collection of the titles of the top-level windows.

Top

Methods

  Name Description
Public method Add Adds the given UI object to the descendents of this UI object, if the given UI object does not already exist.
Public method BindParameters Binds properties of this UI object to those in the given value map.
Public method Clone Returns a copy of this UI object.
Public method Contains Indicates whether the UI object that is identified by the provided ID is contained among the descendents of this UI object.
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 GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetQueryString() Returns the query ID for this UI object.
Public method GetQueryString(String) Returns the query ID of the contained UI object that is specified by the given partial ID.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetUIObjectFromId Returns a contained UI object that is based on the provided ID.
Public method GetUIObjectFromPartialUIObjectId Returns a UI object that is contained in this UI object by using the provided partial ID.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ParameterizeProperty Parameterizes the given property by using the given parameter name.
Public method Remove(String) Removes the specified UI object from the descendent objects in this UI object.
Public method Remove(UIObject) Removes the provided UI object from the descendent objects in this UI object.
Public method ToString Returns the query ID of this UI object. (Overrides Object.ToString.)

Top

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

Reference

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