HtmlControl Class

Progress Software Corporation - Testing Framework 2018.1 Automation Infrastructure
Base class for all HtmlControl's.
Inheritance Hierarchy

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

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

public class HtmlControl : Control

The HtmlControl type exposes the following members.

Constructors

  NameDescription
Public methodHtmlControl
Create a new emptry HtmlControl.
Public methodHtmlControl(Element)
Wrap the specified Element into a new HtmlControl.
Top
Properties

  NameDescription
Public propertyAttributes
All attributes defined for this HtmlControl.
Public propertyBaseElement
Gets the DOM element representing this test control
(Inherited from Control.)
Public propertyChildNodes
Get all the child element nodes of this HtmlControl.
Public propertyCode exampleClientSideLocator
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.
Public propertyCssClass
This HtmlControl's CSS class name.
Public propertyEvents
The list of events defined on this HtmlControl
Public propertyFind
Find property
Public propertyID
This HtmlControl's ID.
Public propertyIsActiveElement
Gets whether this element has the keyboard focus
Public propertyIsEnabled
Gets / sets whether this control is enabled (not disabled)
Public propertyIsRefresh
Gets whether the control is executing a Refresh call.
(Inherited from Control.)
Public propertyLocator
Gets the FindParam that describes this control. The base Control returns null.
(Inherited from Control.)
Public propertyLocatorExpression
Returns the FindExpression for this control. Since this is a abstract base class it always returns null.
(Inherited from Control.)
Public propertyMappings
Gets a mappings collection that stores customizable control specific mapping knowledge that can be later customized.
Public propertyOwnerBrowser
Gets the owner browser that owns this control.
(Inherited from Control.)
Public propertyScrollLeft
Gets / Sets the scrollLeft value of this HtmlControl.
Public propertyScrollTop
Gets / Sets the scrollTop value of this HtmlControl.
Public propertyStyles
Styles collection set on this HtmlControl and persisted in the Html stream. This collection does not contain computed styles.
Public propertyTagName
The tag name of this HtmlControl.
Protected propertyThrowOnInvalidAssignment
Gets whether the control should throw on invalid assignments
(Inherited from Control.)
Public propertyWait
Gets the HtmlWait object attached to this HtmlControl.
Top
Methods

  NameDescription
Public methodAddEventListener
Add an event handler to a Javascript event handler list on this HtmlControl.
Public methodAsjQueryControl
Convert this HtmlControl to jQueryControl.
Public methodAssignElement
Attach the specified Element to this HtmlControl and initialize its internal properties.
(Overrides ControlAssignElement(Element).)
Protected methodAssignFailed
Mark the assignment to failed. Throw if the framework is set for throwing.
(Inherited from Control.)
Public methodCallMethod(String)
Call a client side Javascript method on this HtmlControl.
Public methodCallMethodT(String)
Call a client side Javascript method on this HtmlControl and return type T.
Public methodCallMethodT(String, T)
Call a client side Javascript method on this HtmlControl with return type of T and a default return value.
Public methodCapture
Captures and returns a bitmap image of this HtmlControl.
Public methodCapture(String)
Captures and saves this HtmlControl's image to the WebAii log location as a file.
Public methodCapture(String, String)
Captures and saves this HtmlControl's image to the specified save path as the specified file name as a BMP file.
Public methodClick
Invoke a click on this HtmlControl.
Public methodClick(Boolean)
Invoke a click on this HtmlControl that will cause its browser window to close (this is common for html pop-ups).
Public methodDownload
Clicks a control using the MouseClick or Click and handles the download dialogs sequence that is produced.
Public methodDragTo(Point)
Drag this HtmlControl to an absolute screen coordinate point.
Public methodDragTo(HtmlControl)
Drag this HtmlControl to the center on the destination HtmlControl.
Public methodDragTo(Int32, Int32)
Drag this HtmlControl to a relative X/Y offset.
Public methodDragTo(HtmlControl, OffsetReference, Point)
Drag to a destination HtmlControl with an offset of where within the destination HtmlControl to drag to.
Public methodDragTo(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.
Public methodDragTo(OffsetReference, Point, Int32, Int32)
Drag this HtmlControl from a source offset to an X/Y offset from the source.
Public methodDragTo(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.
Public methodDragTo(OffsetReference, Int32, Int32, Rectangle, OffsetReference, Int32, Int32)
Drag this HtmlControl from a source offset to an X/Y offset from the source.
Public methodDragTo(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.
Public methodDragToWindowLocation
Drag this HtmlControl, using the browser window as the drop target
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodFindParentContainerTContainerControl
Traverses the DOM tree upwards until it finds the container element desired.
Public methodFocus
Give this Html element focus.
Protected methodGetAttributeAsString
Get an attribute of this element as a string
Public methodGetComputedStyle
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)
Public methodGetComputedStyleValue
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.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetRectangle
The absolute screen position and size of this HtmlControl.
Public methodGetStyle
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)
Public methodGetStyleValue
Returns any style as if you are accessing the element.style object from JavaScript.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodCode exampleGetValueT(String)
Get a property value (e.g. control.border or control.style.backgroundColor).
Public methodCode exampleGetValueT(String, Boolean)
Get a property value (e.g. control.border or control.style.backgroundColor) with ability to specify wrappedJSObject's in Firefox.
Public methodCode exampleGetValueT(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.
Public methodCode exampleGetValueT(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.
Public methodInitializeMappings
Initialize the Mappings collection. This method is called when the Mappings collection is accessed for the first time. It is then cached
Public methodInvokeEvent(ScriptEvent)
Invokes an event on this HtmlControl.
Public methodInvokeEvent(ScriptEventType)
Invokes an event on this HtmlControl.
Public methodInvokeEvent(ScriptEvent, Boolean)
Invokes an event on this HtmlControl.
Public methodInvokeEvent(ScriptEventType, Boolean)
Invokes an event on this HtmlControl.
Public methodIsVisible
Returns whether the html element is visible or not. Returns true only when computedStyle.display != 'none' && computedStyle.visibility != 'hidden'
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMouseClick
Uses the Desktop.Mouse object to move the mouse to this HtmlControl and click it.
Public methodMouseClick(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.
Public methodMouseClick(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.
Public methodMouseClick(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.
Public methodMouseClick(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.
Public methodMouseHover
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.
Public methodMouseHover(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.
Public methodMouseHover(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.
Public methodMouseHover(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.
Public methodParentTContainerControl
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.
Public methodRefresh
Refresh this control within the current DOM and update this control property values.
(Inherited from Control.)
Public methodRemoveEventListener
Removes an event handler from a Javascript event handler list on this HtmlControl.
Public methodScrollToVisible
Scroll the browsers window to make this HtmlControl visible on the page. This will method uses the ScrollToVisibleType.ElementTopAtWindowTop
Public methodScrollToVisible(ScrollToVisibleType)
Scroll the browsers window to make this HtmlControl visible on the page.
Public methodScrollToVisible(ScrollToVisibleType, Rectangle)
Scroll the browsers window so that the specified rectangle within this HtmlControl is visible on the page.
Public methodCode exampleSetValueT(String, T)
Set a property value. (e.g. control.border = 2 or control.style.backgroundColor = "red")
Public methodCode exampleSetValueT(String, T, Boolean)
Set a property value. (e.g. control.border = 2 or control.style.backgroundColor = "red") myControl.SetValue<string>("style.backgroundColor","red")
Public methodToString
Builds and returns a string representation of this element.
(Overrides ObjectToString.)
Protected methodValidateControl
Validate a HtmlControl using its LocatorExpression.
Protected methodValidateTag
Validate a tag name
Top
Extension Methods

  NameDescription
Public Extension MethodAssertAttributeOverloaded.
Assert methods based on the HtmlControl's attributes.
(Defined by HtmlControlsAssertExtensions.)
Public Extension MethodAssertAttribute(Boolean)Overloaded.
Assert methods based on the HtmlControl's attributes
(Defined by HtmlControlsAssertExtensions.)
Public Extension MethodAssertContent
Assert methods based on the HtmlControl's content.
(Defined by HtmlControlsAssertExtensions.)
Public Extension MethodAssertStyleOverloaded.
Assert methods based on the HtmlControl's style.
(Defined by HtmlControlsAssertExtensions.)
Public Extension MethodAssertStyle(Boolean)Overloaded.
Assert methods based on the HtmlControl's style.
(Defined by HtmlControlsAssertExtensions.)
Public Extension MethodTojQueryControl (Defined by jQueryExtension.)
Top
See Also

Reference

Inheritance Hierarchy

SystemObject
  ArtOfTest.WebAii.ControlsControl
    ArtOfTest.WebAii.Controls.HtmlControlsHtmlControl
      ArtOfTest.WebAii.Controls.HtmlControlsHtmlContainerControl
      ArtOfTest.WebAii.Controls.HtmlControlsHtmlImage
      ArtOfTest.WebAii.Controls.HtmlControlsHtmlInputControl
      ArtOfTest.WebAii.Controls.HtmlControlsHtmlOption
      ArtOfTest.WebAii.Controls.HtmlControlsHtmlSource
      Telerik.TestingFramework.Controls.KendoUIKendoCalendar
      Telerik.TestingFramework.Controls.KendoUIKendoFilterMenuInput
      Telerik.TestingFramework.Controls.KendoUIKendoPager
      Telerik.TestingFramework.Controls.KendoUIKendoPanel
      Telerik.TestingFramework.Controls.KendoUIKendoTab
      Telerik.TestingFramework.Controls.KendoUIKendoTreeNode
      Telerik.TestingFramework.Controls.KendoUIKendoWindow
      Telerik.WebAii.Controls.HtmlEditorSpinBox
      Telerik.WebAii.Controls.HtmlRadDockCommand