Share via


HtmlDocument Class

Represents an HTML document control to test the user interface (UI) of Web pages.

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.TestTools.UITesting.UITestControl
    Microsoft.VisualStudio.TestTools.UITesting.HtmlControls.HtmlControl
      Microsoft.VisualStudio.TestTools.UITesting.HtmlControls.HtmlDocument

Namespace:  Microsoft.VisualStudio.TestTools.UITesting.HtmlControls
Assemblies:   Microsoft.VisualStudio.TestTools.UITesting (in Microsoft.VisualStudio.TestTools.UITesting.dll)
  Microsoft.VisualStudio.TestTools.WindowsStore.UITesting (in Microsoft.VisualStudio.TestTools.WindowsStore.UITesting.dll)

Syntax

'Declaration
<CLSCompliantAttribute(True)> _
Public Class HtmlDocument _
    Inherits HtmlControl
[CLSCompliantAttribute(true)]
public class HtmlDocument : HtmlControl
[CLSCompliantAttribute(true)]
public ref class HtmlDocument : public HtmlControl
[<CLSCompliantAttribute(true)>]
type HtmlDocument =  
    class 
        inherit HtmlControl 
    end
public class HtmlDocument extends HtmlControl

The HtmlDocument type exposes the following members.

Constructors

  Name Description
Public method HtmlDocument() Initializes a new instance of the HtmlDocument class.
Public method HtmlDocument(UITestControl) Initializes a new instance of the HtmlDocument class by using the provided parent control.

Top

Properties

  Name Description
Public property AbsolutePath Gets the absolute path of the document.
Public property AccessKey Gets the value of the AccessKey attribute of this control. (Inherited from HtmlControl.)
Public property BoundingRectangle (Inherited from UITestControl.)
Public property Class Gets the value of the Class attribute of this control. (Inherited from HtmlControl.)
Public property ClassName (Inherited from UITestControl.)
Public property Container (Inherited from UITestControl.)
Public property ControlDefinition Gets the definition of the control in the HTML page. (Inherited from HtmlControl.)
Public property ControlType (Inherited from UITestControl.)
Public property Enabled (Inherited from UITestControl.)
Public property Exists (Inherited from UITestControl.)
Public property FilterProperties (Inherited from UITestControl.)
Public property FrameDocument Gets a value that indicates whether this HTML document control resides in a frame.
Public property FriendlyName (Inherited from UITestControl.)
Public property HasFocus (Inherited from UITestControl.)
Public property Height (Inherited from UITestControl.)
Public property HelpText Gets the value of the HelpText attribute of this control. (Inherited from HtmlControl.)
Public property Id Gets the value of the ID attribute of this control. (Inherited from HtmlControl.)
Public property InnerText Gets the text content of this control. (Inherited from HtmlControl.)
Public property IsTopParent (Inherited from UITestControl.)
Public property Left (Inherited from UITestControl.)
Public property Name (Inherited from UITestControl.)
Public property NativeElement (Inherited from UITestControl.)
Public property PageUrl Gets the URL for the document.
Public property RedirectingPage Gets a value that indicates whether this HTML document is a redirecting page.
Public property SearchConfigurations (Inherited from UITestControl.)
Public property SearchProperties (Inherited from UITestControl.)
Protected property SearchPropertiesSetExplicitly (Inherited from UITestControl.)
Public property State (Inherited from UITestControl.)
Public property TagInstance Gets the index of the control in the collection of controls on the page that has the same tag name. (Inherited from HtmlControl.)
Public property TagName Gets the tag name of this control. (Inherited from HtmlControl.)
Public property TechnologyName (Inherited from UITestControl.)
Public property Title Gets the value of the Title attribute of this control. (Inherited from HtmlControl.)
Public property Top (Inherited from UITestControl.)
Public property TopParent (Inherited from UITestControl.)
Public property Type Gets the value of the Type attribute of this control. (Inherited from HtmlControl.)
Public property ValueAttribute Gets the value of the Value attribute of this control. (Inherited from HtmlControl.)
Public property Width (Inherited from UITestControl.)
Public property WindowHandle (Inherited from UITestControl.)
Public property WindowTitles (Inherited from UITestControl.)

Top

Methods

  Name Description
Public method CaptureImage (Inherited from UITestControl.)
Public method CopyFrom (Inherited from UITestControl.)
Public method DrawHighlight (Inherited from UITestControl.)
Public method EnsureClickable() (Inherited from UITestControl.)
Public method EnsureClickable(Point) (Inherited from UITestControl.)
Public method EnsureClickable(Point) (Inherited from UITestControl.)
Public method Equals (Inherited from UITestControl.)
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 Find (Inherited from UITestControl.)
Public method FindMatchingControls (Inherited from UITestControl.)
Public method GetChildren (Inherited from UITestControl.)
Public method GetClickablePoint (Inherited from UITestControl.)
Public method GetHashCode (Inherited from UITestControl.)
Public method GetParent (Inherited from UITestControl.)
Public method GetProperty (Inherited from UITestControl.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method GetUITestControlsForSearch (Inherited from UITestControl.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method SetFocus (Inherited from UITestControl.)
Public method SetProperty (Inherited from UITestControl.)
Public method ToString (Inherited from UITestControl.)
Public method TryFind (Inherited from UITestControl.)
Public method TryGetClickablePoint(Point%) (Inherited from UITestControl.)
Public method TryGetClickablePoint(Point%) (Inherited from UITestControl.)
Public method WaitForControlCondition(Predicate<UITestControl>) (Inherited from UITestControl.)
Public method WaitForControlCondition(Predicate<UITestControl>, Int32) (Inherited from UITestControl.)
Public method WaitForControlEnabled() (Inherited from UITestControl.)
Public method WaitForControlEnabled(Int32) (Inherited from UITestControl.)
Public method WaitForControlExist() (Inherited from UITestControl.)
Public method WaitForControlExist(Int32) (Inherited from UITestControl.)
Public method WaitForControlNotExist() (Inherited from UITestControl.)
Public method WaitForControlNotExist(Int32) (Inherited from UITestControl.)
Public method WaitForControlPropertyEqual(String, Object) (Inherited from UITestControl.)
Public method WaitForControlPropertyEqual(String, Object, Int32) (Inherited from UITestControl.)
Public method WaitForControlPropertyNotEqual(String, Object) (Inherited from UITestControl.)
Public method WaitForControlPropertyNotEqual(String, Object, Int32) (Inherited from UITestControl.)
Public method WaitForControlReady() (Inherited from UITestControl.)
Public method WaitForControlReady(Int32) (Inherited from UITestControl.)

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.UITesting.HtmlControls Namespace

HtmlDocument.PropertyNames

HtmlControl