HtmlDocument Class

Article
03/28/2012

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

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public Class HtmlDocument _
    Inherits HtmlControl

public class HtmlDocument : HtmlControl

public ref class HtmlDocument : public HtmlControl

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	Gets the Bounding rectangle for this control. (Inherited from UITestControl.)
	Class	Gets the value of the Class attribute of this control. (Inherited from HtmlControl.)
	ClassName	Gets the class name for this control. (Inherited from UITestControl.)
	Container	Gets or sets the container of this UITestControl. (Inherited from UITestControl.)
	ControlDefinition	Gets the definition of the control in the HTML page. (Inherited from HtmlControl.)
	ControlType	Gets the type of the UI Control. (Inherited from UITestControl.)
	Enabled	Gets a value that indicates whether this control is enabled. (Inherited from UITestControl.)
	Exists	Gets a value that indicates whether this control exists on the user interface. (Inherited from UITestControl.)
	FilterProperties	Gets the property-value pair collection that is used to disambiguate a control. (Inherited from UITestControl.)
	FrameDocument	Gets a value that indicates whether this HTML document control resides in a frame.
	FriendlyName	Gets the name of this control to use in the user interface. (Inherited from UITestControl.)
	HasFocus	Gets a value that indicates whether this control currently has the focus in the user interface. (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	Gets a value that indicates whether this control is the top-level element. (Inherited from UITestControl.)
	Name	Gets the name of this control. (Inherited from UITestControl.)
	NativeElement	Gets the native technology element that corresponds to this control. (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	Gets or sets search configurations. (Inherited from UITestControl.)
	SearchProperties	Gets the property-value pair collection that is used to identify a control. (Inherited from UITestControl.)
	SearchPropertiesSetExplicitly	Gets a value that indicates whether the search properties for this control were set by the user in the user interface. (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	Gets or sets the technology framework that implements this control. (Inherited from UITestControl.)
	Title	Gets the value of the Title attribute of this control. (Inherited from HtmlControl.)
	TopParent	Gets the top-level parent of this control. (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.)
	WindowHandle	Gets the window handle for this control. (Inherited from UITestControl.)
	WindowTitles	Gets a collection of the window titles of the top-level window. (Inherited from UITestControl.)

Top

Methods

	Name	Description
	CaptureImage	Captures the image of the UITestControl. The UITestControl must be present on the screen. (Inherited from UITestControl.)
	CopyFrom	Creates a UITestControl object that references the same element on the user interface as the original UITestControl. (Inherited from UITestControl.)
	DrawHighlight	Highlights the control. (Inherited from UITestControl.)
	EnsureClickable()	Scrolls the user interface to make sure that the control is clickable. (Inherited from UITestControl.)
	EnsureClickable(Point)	Scrolls the user interface to a specific point to make sure that the control is clickable. (Inherited from UITestControl.)
	Equals	Determines whether the specified UITestControl is equal to the current UITestControl. (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	Finds the UITestControl. (Inherited from UITestControl.)
	FindMatchingControls	Returns a collection of all UITestControls that match the specified SearchProperties and FilterProperties. (Inherited from UITestControl.)
	GetChildren	Returns a collection of all first-level children of the current UITestControl. (Inherited from UITestControl.)
	GetClickablePoint	Returns a clickable point on the control. (Inherited from UITestControl.)
	GetHashCode	Returns a unique value that represents the current UITestControl instance. (Inherited from UITestControl.)
	GetParent	Returns the parent of the current UITestControl. (Inherited from UITestControl.)
	GetProperty	Gets the value of the specified property. (Inherited from UITestControl.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUITestControlsForSearch	Returns an array of UITestControl objects that will be used for searching. (Inherited from UITestControl.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetFocus	Sets the keyboard focus to the UITestControl. (Inherited from UITestControl.)
	SetProperty	Sets the value of a given property. (Inherited from UITestControl.)
	ToString	Returns a String that represents the current UITestControl. (Inherited from UITestControl.)
	TryGetClickablePoint	Returns a clickable point in the UITestControl. If the control is not clickable, this method returns false. (Inherited from UITestControl.)
	WaitForControlCondition(Predicate<UITestControl>)	Blocks the current thread until this control meets the specified condition, or until the default time-out expires. (Inherited from UITestControl.)
	WaitForControlCondition(Predicate<UITestControl>, Int32)	Blocks the current thread until this control meets the specified condition, or until the specified time-out expires. (Inherited from UITestControl.)
	WaitForControlEnabled()	Blocks the current thread until this control is enabled, or until the default time-out expires. (Inherited from UITestControl.)
	WaitForControlEnabled(Int32)	Blocks the current thread until this control is enabled, or until the specified time-out expires. (Inherited from UITestControl.)
	WaitForControlExist()	Blocks the current thread until this control occurs in the user interface, or until the default time-out expires. (Inherited from UITestControl.)
	WaitForControlExist(Int32)	Blocks the current thread until this control occurs in the user interface, or until the specified time-out expires. (Inherited from UITestControl.)
	WaitForControlNotExist()	Blocks the current thread until this control no longer exists in the user interface, or until the default time-out expires. (Inherited from UITestControl.)
	WaitForControlNotExist(Int32)	Blocks the current thread until this control no longer occurs in the user interface, or until the specified time-out expires. (Inherited from UITestControl.)
	WaitForControlPropertyEqual(String, Object)	Blocks the current thread until the specified property of this control is equal to the specified value, or until the default time-out expires. (Inherited from UITestControl.)
	WaitForControlPropertyEqual(String, Object, Int32)	Blocks the current thread until the specified property of this control is equal to the specified value, or until the specified time-out expires. (Inherited from UITestControl.)
	WaitForControlPropertyNotEqual(String, Object)	Blocks the current thread until the specified property of this control is not equal to the specified value, or until the default time-out expires. (Inherited from UITestControl.)
	WaitForControlPropertyNotEqual(String, Object, Int32)	Blocks the current thread until the specified property of this control is not equal to the specified value, or until the specified time-out expires. (Inherited from UITestControl.)
	WaitForControlReady()	Blocks the current thread until this control is ready to receive mouse or keyboard input, or until the default time-out expires. (Inherited from UITestControl.)
	WaitForControlReady(Int32)	Blocks the current thread until this control is ready to receive mouse or keyboard input, or until the specified time-out expires. (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.

Share via