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
	HtmlDocument()	Initializes a new instance of the HtmlDocument class.
	HtmlDocument(UITestControl)	Initializes a new instance of the HtmlDocument class by using the provided parent control.

Top

Properties

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

Top

Methods

	Name	Description
	CaptureImage	(Inherited from UITestControl.)
	CopyFrom	(Inherited from UITestControl.)
	DrawHighlight	(Inherited from UITestControl.)
	EnsureClickable()	(Inherited from UITestControl.)
	EnsureClickable(Point)	(Inherited from UITestControl.)
	EnsureClickable(Point)	(Inherited from UITestControl.)
	Equals	(Inherited from UITestControl.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Find	(Inherited from UITestControl.)
	FindMatchingControls	(Inherited from UITestControl.)
	GetChildren	(Inherited from UITestControl.)
	GetClickablePoint	(Inherited from UITestControl.)
	GetHashCode	(Inherited from UITestControl.)
	GetParent	(Inherited from UITestControl.)
	GetProperty	(Inherited from UITestControl.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUITestControlsForSearch	(Inherited from UITestControl.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetFocus	(Inherited from UITestControl.)
	SetProperty	(Inherited from UITestControl.)
	ToString	(Inherited from UITestControl.)
	TryFind	(Inherited from UITestControl.)
	TryGetClickablePoint(Point%)	(Inherited from UITestControl.)
	TryGetClickablePoint(Point%)	(Inherited from UITestControl.)
	WaitForControlCondition(Predicate<UITestControl>)	(Inherited from UITestControl.)
	WaitForControlCondition(Predicate<UITestControl>, Int32)	(Inherited from UITestControl.)
	WaitForControlEnabled()	(Inherited from UITestControl.)
	WaitForControlEnabled(Int32)	(Inherited from UITestControl.)
	WaitForControlExist()	(Inherited from UITestControl.)
	WaitForControlExist(Int32)	(Inherited from UITestControl.)
	WaitForControlNotExist()	(Inherited from UITestControl.)
	WaitForControlNotExist(Int32)	(Inherited from UITestControl.)
	WaitForControlPropertyEqual(String, Object)	(Inherited from UITestControl.)
	WaitForControlPropertyEqual(String, Object, Int32)	(Inherited from UITestControl.)
	WaitForControlPropertyNotEqual(String, Object)	(Inherited from UITestControl.)
	WaitForControlPropertyNotEqual(String, Object, Int32)	(Inherited from UITestControl.)
	WaitForControlReady()	(Inherited from UITestControl.)
	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