HtmlContainerControl Class

Progress Software Corporation - Testing Framework 2018.1 Automation Infrastructure

Base class for all container controls. Controls that are allowed to contain other Html elements.

Inheritance Hierarchy

SystemObject
  ArtOfTest.WebAii.ControlsControl
    ArtOfTest.WebAii.Controls.HtmlControlsHtmlControl
      ArtOfTest.WebAii.Controls.HtmlControlsHtmlContainerControl
        More...

Namespace: ArtOfTest.WebAii.Controls.HtmlControls
Assembly: ArtOfTest.WebAii (in ArtOfTest.WebAii.dll) Version: 2018.1.116.0 (2018.1.116.0)

Syntax

Copy

public class HtmlContainerControl : HtmlControl

Public Class HtmlContainerControl
	Inherits HtmlControl

The HtmlContainerControl type exposes the following members.

Constructors

	Name	Description
	HtmlContainerControl	Create a new HtmlContainerControl
	HtmlContainerControl(Element)	Create a new control.

Top

Properties

	Name	Description
	Attributes	All attributes defined for this HtmlControl. (Inherited from HtmlControl.)
	BaseElement	Gets the DOM element representing this test control (Inherited from Control.)
	ChildNodes	Get all the child element nodes of this HtmlControl. (Inherited from HtmlControl.)
	ClientSideLocator	Gets the client-side locator for this HtmlControl. This property can be used to define a custom client side object that this HtmlControl maps to. GetValue/SetValue properties use that object to make their calls instead of the default one. (Inherited from HtmlControl.)
	CssClass	This HtmlControl's CSS class name. (Inherited from HtmlControl.)
	Events	The list of events defined on this HtmlControl (Inherited from HtmlControl.)
	Find	Find property (Inherited from HtmlControl.)
	ID	This HtmlControl's ID. (Inherited from HtmlControl.)
	InnerText	Gets the innerText of this container control.
	IsActiveElement	Gets whether this element has the keyboard focus (Inherited from HtmlControl.)
	IsEnabled	Gets / sets whether this control is enabled (not disabled) (Inherited from HtmlControl.)
	IsRefresh	Gets whether the control is executing a Refresh call. (Inherited from Control.)
	Locator	Gets the FindParam that describes this control. The base Control returns null. (Inherited from Control.)
	LocatorExpression	Returns the FindExpression for this control. Since this is a abstract base class it always returns null. (Inherited from Control.)
	Mappings	Gets a mappings collection that stores customizable control specific mapping knowledge that can be later customized. (Inherited from HtmlControl.)
	OwnerBrowser	Gets the owner browser that owns this control. (Inherited from Control.)
	ScrollLeft	Gets / Sets the scrollLeft value of this HtmlControl. (Inherited from HtmlControl.)
	ScrollTop	Gets / Sets the scrollTop value of this HtmlControl. (Inherited from HtmlControl.)
	Styles	Styles collection set on this HtmlControl and persisted in the Html stream. This collection does not contain computed styles. (Inherited from HtmlControl.)
	TagName	The tag name of this HtmlControl. (Inherited from HtmlControl.)
	TextContent	Gets the TextContent of this container control.
	ThrowOnInvalidAssignment	Gets whether the control should throw on invalid assignments (Inherited from Control.)
	Wait	Gets the HtmlWait object attached to this HtmlControl. (Inherited from HtmlControl.)

Top

Methods

	Name	Description
	AddEventListener	Add an event handler to a Javascript event handler list on this HtmlControl. (Inherited from HtmlControl.)
	AsjQueryControl	Convert this HtmlControl to jQueryControl. (Inherited from HtmlControl.)
	AssignElement	Assign element and initialize this control. (Overrides HtmlControlAssignElement(Element).)
	AssignFailed	Mark the assignment to failed. Throw if the framework is set for throwing. (Inherited from Control.)
	CallMethod(String)	Call a client side Javascript method on this HtmlControl. (Inherited from HtmlControl.)
	CallMethodT(String, T)	Call a client side Javascript method on this HtmlControl with return type of T and a default return value. (Inherited from HtmlControl.)
	Capture	Captures and returns a bitmap image of this HtmlControl. (Inherited from HtmlControl.)
	Capture(String)	Captures and saves this HtmlControl's image to the WebAii log location as a file. (Inherited from HtmlControl.)
	Capture(String, String)	Captures and saves this HtmlControl's image to the specified save path as the specified file name as a BMP file. (Inherited from HtmlControl.)
	Click	Invoke a click on this HtmlControl. (Inherited from HtmlControl.)
	Click(Boolean)	Invoke a click on this HtmlControl that will cause its browser window to close (this is common for html pop-ups). (Inherited from HtmlControl.)
	Download	Clicks a control using the MouseClick or Click and handles the download dialogs sequence that is produced. (Inherited from HtmlControl.)
	DragTo(Point)	Drag this HtmlControl to an absolute screen coordinate point. (Inherited from HtmlControl.)
	DragTo(HtmlControl)	Drag this HtmlControl to the center on the destination HtmlControl. (Inherited from HtmlControl.)
	DragTo(Int32, Int32)	Drag this HtmlControl to a relative X/Y offset. (Inherited from HtmlControl.)
	DragTo(HtmlControl, OffsetReference, Point)	Drag to a destination HtmlControl with an offset of where within the destination HtmlControl to drag to. (Inherited from HtmlControl.)
	DragTo(OffsetReference, Point, HtmlControl)	Drag this HtmlControl by specifying a reference point on the HtmlControl rectangle to start the drag from with an offset and drop on the destination HtmlControl center. (Inherited from HtmlControl.)
	DragTo(OffsetReference, Point, Int32, Int32)	Drag this HtmlControl from a source offset to an X/Y offset from the source. (Inherited from HtmlControl.)
	DragTo(OffsetReference, Point, HtmlControl, OffsetReference, Point)	Drag this HtmlControl by specifying a reference point on the HtmlControl rectangle to start the drag from and a reference point on the destination HtmlControl to specify the drop location. (Inherited from HtmlControl.)
	DragTo(OffsetReference, Int32, Int32, Rectangle, OffsetReference, Int32, Int32)	Drag this HtmlControl from a source offset to an X/Y offset from the source. (Inherited from HtmlControl.)
	DragTo(OffsetReference, Int32, Int32, Boolean, HtmlControl, OffsetReference, Int32, Int32, Boolean)	Drag this HtmlControl by specifying a reference point on the HtmlControl rectangle to start the drag from and a reference point on the destination HtmlControl to specify the drop location. (Inherited from HtmlControl.)
	DragToWindowLocation	Drag this HtmlControl, using the browser window as the drop target (Inherited from HtmlControl.)
	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.)
	FindParentContainerTContainerControl	Traverses the DOM tree upwards until it finds the container element desired. (Inherited from HtmlControl.)
	Focus	Give this Html element focus. (Inherited from HtmlControl.)
	GetAttributeAsString	Get an attribute of this element as a string (Inherited from HtmlControl.)
	GetComputedStyle	Returns an HtmlStyle object that can be used to easily probe the style value. (i.e. convert unit styles to Int32 or color value to System.Drawing.Color) (Inherited from HtmlControl.)
	GetComputedStyleValue	Returns the computed value of the specified style. The computed style value represents the final computed value taking into account the CSS properties for this HtmlElement. (Inherited from HtmlControl.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetRectangle	The absolute screen position and size of this HtmlControl. (Inherited from HtmlControl.)
	GetStyle	Returns a HtmlStyle object that can be used to easily probe the style value. (i.e. convert unit styles to Int32 or color value to System.Drawing.Color) (Inherited from HtmlControl.)
	GetStyleValue	Returns any style as if you are accessing the element.style object from JavaScript. (Inherited from HtmlControl.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValueT(String)	Get a property value (e.g. control.border or control.style.backgroundColor). (Inherited from HtmlControl.)
	GetValueT(String, Boolean)	Get a property value (e.g. control.border or control.style.backgroundColor) with ability to specify wrappedJSObject's in Firefox. (Inherited from HtmlControl.)
	GetValueT(String, T)	Get a property value (e.g. control.border or control.style.backgroundColor) and return the specified default value if the get fails for any reason. (Inherited from HtmlControl.)
	GetValueT(String, Boolean, T)	Get a property value (e.g. control.border or control.style.backgroundColor) with ability to specify wrappedJSObject's in Firefox and return the specified default value if the get fails for any reason. (Inherited from HtmlControl.)
	InitializeMappings	Initialize the Mappings collection. This method is called when the Mappings collection is accessed for the first time. It is then cached (Inherited from HtmlControl.)
	InvokeEvent(ScriptEvent)	Invokes an event on this HtmlControl. (Inherited from HtmlControl.)
	InvokeEvent(ScriptEventType)	Invokes an event on this HtmlControl. (Inherited from HtmlControl.)
	InvokeEvent(ScriptEvent, Boolean)	Invokes an event on this HtmlControl. (Inherited from HtmlControl.)
	InvokeEvent(ScriptEventType, Boolean)	Invokes an event on this HtmlControl. (Inherited from HtmlControl.)
	IsVisible	Returns whether the html element is visible or not. Returns true only when computedStyle.display != 'none' && computedStyle.visibility != 'hidden' (Inherited from HtmlControl.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MouseClick	Uses the Desktop.Mouse object to move the mouse to this HtmlControl and click it. (Inherited from HtmlControl.)
	MouseClick(MouseClickType)	Uses the Desktop.Mouse object to move the mouse to the absolute center of this HtmlControl and simulate a left mouse click. Be sure this HtmlControl is visible in the browser window first. Call ScrollToVisible(ScrollToVisibleType) or ScrollToVisible(ScrollToVisibleType, Rectangle)first if the element could be currently outside of the browsers window. (Inherited from HtmlControl.)
	MouseClick(MouseClickType, Point, OffsetReference)	Uses the Desktop.Mouse object to move the mouse to a point relative to this HtmlControl and simulate the specified mouse click. Be sure this HtmlControl is visible in the browser window first. Call ScrollToVisible(ScrollToVisibleType) or ScrollToVisible(ScrollToVisibleType, Rectangle)first if the element could be currently outside of the browsers window. (Inherited from HtmlControl.)
	MouseClick(MouseClickType, Int32, Int32)	Uses the Desktop.Mouse object to move the mouse to a point relative to this HtmlControl and simulate the specified mouse click. Be sure this HtmlControl is visible in the browser window first. Call ScrollToVisible(ScrollToVisibleType) or ScrollToVisible(ScrollToVisibleType, Rectangle)first if the element could be currently outside of the browsers window. (Inherited from HtmlControl.)
	MouseClick(MouseClickType, Int32, Int32, OffsetReference)	Uses the Desktop.Mouse object to move the mouse to a point relative to this HtmlControl and simulate the specified mouse click. Be sure this HtmlControl is visible in the browser window first. Call ScrollToVisible(ScrollToVisibleType) or ScrollToVisible(ScrollToVisibleType, Rectangle)first if the element could be currently outside of the browsers window. (Inherited from HtmlControl.)
	MouseHover	Uses the Desktop.Mouse object to Hover over this absolute center of this HtmlControl. Be sure this HtmlControl is visible in the browser window first. Call ScrollToVisible(ScrollToVisibleType) or ScrollToVisible(ScrollToVisibleType, Rectangle)first if the element could be currently outside of the browsers window. (Inherited from HtmlControl.)
	MouseHover(Point)	Uses the Desktop.Mouse object to Hover over a point relative to this HtmlControl. Be sure this HtmlControl is visible in the browser window first. Call ScrollToVisible(ScrollToVisibleType) or ScrollToVisible(ScrollToVisibleType, Rectangle)first if the element could be currently outside of the browsers window. (Inherited from HtmlControl.)
	MouseHover(Int32, Int32)	Uses the Desktop.Mouse object to Hover over a point relative to this HtmlControl. Be sure this HtmlControl is visible in the browser window first. Call ScrollToVisible(ScrollToVisibleType) or ScrollToVisible(ScrollToVisibleType, Rectangle)first if the element could be currently outside of the browsers window. (Inherited from HtmlControl.)
	MouseHover(Int32, Int32, OffsetReference)	Uses the Desktop.Mouse object to Hover over a point relative to this HtmlControl. Be sure this HtmlControl is visible in the browser window first. Call ScrollToVisible(ScrollToVisibleType) or ScrollToVisible(ScrollToVisibleType, Rectangle)first if the element could be currently outside of the browsers window. (Inherited from HtmlControl.)
	ParentTContainerControl	Return the parent HtmlContainerControl of the desired type that this HtmlControl is contained inside of. If a parent HtmlControl of the desired type is not found, will return null. (Inherited from HtmlControl.)
	Refresh	Refresh this control within the current DOM and update this control property values. (Inherited from Control.)
	RemoveEventListener	Removes an event handler from a Javascript event handler list on this HtmlControl. (Inherited from HtmlControl.)
	ScrollToVisible	Scroll the browsers window to make this HtmlControl visible on the page. This will method uses the ScrollToVisibleType.ElementTopAtWindowTop (Inherited from HtmlControl.)
	ScrollToVisible(ScrollToVisibleType)	Scroll the browsers window to make this HtmlControl visible on the page. (Inherited from HtmlControl.)
	ScrollToVisible(ScrollToVisibleType, Rectangle)	Scroll the browsers window so that the specified rectangle within this HtmlControl is visible on the page. (Inherited from HtmlControl.)
	SetValueT(String, T)	Set a property value. (e.g. control.border = 2 or control.style.backgroundColor = "red") (Inherited from HtmlControl.)
	SetValueT(String, T, Boolean)	Set a property value. (e.g. control.border = 2 or control.style.backgroundColor = "red") myControl.SetValue<string>("style.backgroundColor","red") (Inherited from HtmlControl.)
	ToString	Builds and returns a string representation of this element. (Inherited from HtmlControl.)
	ValidateControl	Validate a HtmlControl using its LocatorExpression. (Inherited from HtmlControl.)
	ValidateTag	Validate a tag name (Inherited from HtmlControl.)

Top

Extension Methods

	Name	Description
	AssertAttribute	Overloaded. Assert methods based on the HtmlControl's attributes. (Defined by HtmlControlsAssertExtensions.)
	AssertAttribute(Boolean)	Overloaded. Assert methods based on the HtmlControl's attributes (Defined by HtmlControlsAssertExtensions.)
	AssertContent	Assert methods based on the HtmlControl's content. (Defined by HtmlControlsAssertExtensions.)
	AssertStyle	Overloaded. Assert methods based on the HtmlControl's style. (Defined by HtmlControlsAssertExtensions.)
	AssertStyle(Boolean)	Overloaded. Assert methods based on the HtmlControl's style. (Defined by HtmlControlsAssertExtensions.)
	TojQueryControl	(Defined by jQueryExtension.)

Top

Reference

ArtOfTest.WebAii.Controls.HtmlControls Namespace

Inheritance Hierarchy