Class

Element

Initialize an element proxy. The only property off this element that you can use is Wait.Exist() or Wait.ExistsNot()

Declaration

public Element(HtmlFindExpression findExpr, Find findObj, Browser ownerBrowser)

Parameters

Gets the absolute sibling tag index of this element within the parent node. Basically the order of this node among its siblings. Zero-based.

Declaration

public int AbsoluteSiblingTagIndex { get; set; }

Property Value

Gets the absolute that index of this element. This index is unique within a document.

Declaration

public int AbsoluteTagIndex { get; }

Property Value

Gets the list of attributes defined for this element.

Declaration

public ReadOnlyCollection<iAttribute> Attributes { get; }

Property Value

Gets the list of all parsed element of this tag including text literals, comments, malformed tags...etc.

Declaration

public ReadOnlyCollection<Element> ChildNodes { get; }

Property Value

Gets the list of child elements that are well formed markup non-text elements.

Declaration

public ReadOnlyCollection<Element> Children { get; }

Property Value

Gets the raw content of the tag that represents this element.

Declaration

public string Content { get; }

Property Value

Gets the value of the attribute ('class') if present on this tag.

Declaration

public string CssClassAttributeValue { get; }

Property Value

Gets/Sets any custom data associated with this element.

Declaration

public object Data { get; set; }

Property Value

Gets the hierarchical depth of this element

Declaration

public int Depth { get; }

Property Value

Implements ITargetElement.Depth

Gets the element type (div, table ..etc).

Declaration

public ElementType ElementType { get; }

Property Value

Gets the FindExpression used to find this element when using the Find object. This property is not set when calling the Find.Allxxx methods.

Declaration

[Browsable(false)]
public HtmlFindExpression FindExpressionUsed { get; }

Property Value

Gets a reference to the Find object used to find this element

Declaration

[Browsable(false)]
public Find FindObjectUsed { get; }

Property Value

Gets / Sets the root frame element that this element is contained in.

Declaration

public Element FrameElement { get; set; }

Property Value

Gets whether this element has an id or a name set on it.

Declaration

public bool HasIdOrName { get; }

Property Value

Get the IAutomationHost associated with this element.

Declaration

public IAutomationHost Host { get; }

Property Value

Implements ITargetElement.Host

Gets the value of the attribute ('id') if present on this tag.

Declaration

public string IdAttributeValue { get; }

Property Value

Gets the InnerMarkup of this element.

Declaration

public string InnerMarkup { get; }

Property Value

Gets this element's inner text content including all of its nested children.

Declaration

public string InnerText { get; }

Property Value

Gets the Input type (i.e. checkbox, radio...etc) if the ElementType=Input. Otherwise, will return NotSet.

Declaration

public InputElementType InputElementType { get; }

Property Value

Gets whether it is a begin tag <foo bar='me'> .

Declaration

public bool IsBeginTag { get; }

Property Value

Gets whether this element is an end tag </foo>.

Declaration

public bool IsEndTag { get; }

Property Value

Gets whether this element is a proxy element or a fully initialized element.

Declaration

[Browsable(false)]
public bool IsProxy { get; }

Property Value

Gets whether the element is self-closing (<foo />).

Declaration

public bool IsSelfClosing { get; }

Property Value

Gets whether the element is a test region or not. This function has been added for performance reasons. We don't want to call the ElementType property since it will trigger the full initialization of types.

Declaration

public bool IsTestRegion { get; }

Property Value

Implements ITargetElement.IsTestRegion

Gets the element's closing tag if it is a begin tag and not self-closing.

Declaration

public Element MatchingClosingTag { get; set; }

Property Value

Gets the value of the attribute ('name') if present on this tag

Declaration

public string NameAttributeValue { get; }

Property Value

Gets the OuterMarkup of this element.

Declaration

public string OuterMarkup { get; }

Property Value

Gets the owner browser of this element.

Declaration

[Browsable(false)]
public Browser OwnerBrowser { get; }

Property Value

Gets the Parent element.

Declaration

public Element Parent { get; }

Property Value

Returns the raw parsed element.

Declaration

public ParsedElement ParsedElement { get; }

Property Value

Implements ITargetElement.ParsedElement

Gets the parsing type set by the parser. (Markup, LiteralText, Comment..etc)

Declaration

public ParsedElementType ParsingType { get; }

Property Value

Gets the tagName of the the element

Declaration

public string TagName { get; }

Property Value

Gets the tagName occurrence of this element.

Declaration

public int TagNameIndex { get; }

Property Value

Get the technology type.

Declaration

public TechnologyType TechnologyType { get; }

Property Value

Implements ITargetElement.TechnologyType

Gets this element's inner text content without recursing through all its nested children for text.

Declaration

public string TextContent { get; }

Property Value

Gets the wait object to wait for certain conditions of this element.

Declaration

[Browsable(false)]
public Wait Wait { get; }

Property Value

Add a child element to this element.

Declaration

public virtual void AddChild(Element child)

Parameters

Remarks

Add this node as a child node.

Declaration

public void AddChildNode(ITargetElement element)

Parameters

Implements ITargetElement.AddChildNode(ITargetElement)

Returns this elements as a strongly-typed control of type TControl.

Declaration

public TControl As<TControl>() where TControl : Control, new()

Returns

Captures the image of current element.

Declaration

public Bitmap Capture()

Returns

Implements ITargetElement.Capture()

Captures the image of curent element with scaling and OS information.

Declaration

public ElementImage CaptureImage()

Returns

Implements ITargetElement.CaptureImage()

Checks the current element and its ancestors for specified control and returns a strongly-typed control of type TControl.

Declaration

public TControl CastIncludingAncestors<TControl>(int depth = 5) where TControl : Control, new()

Parameters

Returns

Whether a certain attribute is contained in this element

Declaration

public bool ContainsAttribute(iAttribute attribute, bool usePartialAttributeValue, StringComparison comparison, bool matchQuotes)

Parameters

Returns

True/False whether this element contains a specific attribute name.

Declaration

public bool ContainsAttribute(string attributeName)

Parameters

Returns

Create an Element object with a specific tagname and index.

Declaration

public static Element CreateLight(string tagName, int tagIndex)

Parameters

Returns

Defines how two Elements should be compared.

Declaration

public override bool Equals(object obj)

Parameters

Returns

Overrides object.Equals(object)

Give this element keyboard focus

Declaration

public void Focus()

Constructs a friendly name that represents this element.

Declaration

public string FriendlyName()

Returns

Find a specific attribute by name and returns it. (case-insensitive)

Declaration

public iAttribute GetAttribute(string name)

Parameters

Returns

Finds a specific attribute name in the Element list of attributes and returns its object

Declaration

public iAttribute GetAttribute(string name, bool ignoreCase)

Parameters

Returns

Gets the value of the attribute or a String.Empty if attribute does not exist.

Declaration

public string GetAttributeValueOrEmpty(string attrName)

Parameters

Returns

Get the children of this node.

Declaration

public ITargetElement[] GetChildren()

Returns

Implements ITargetElement.GetChildren()

Get the hash code for this Element.

Declaration

public override int GetHashCode()

Returns

Overrides object.GetHashCode()

Returns the FRAME or IFRAME element containing this element's document, if one exists.

Declaration

public ITargetElement GetHostParent()

Returns

Implements ITargetElement.GetHostParent()

Get the next sibling of this node. If this node is the last sibling, will return null.

Declaration

public Element GetNextSibling()

Returns

Get the parent of this node.

Declaration

public ITargetElement GetParent()

Returns

Implements ITargetElement.GetParent()

Same as InnerText but will respect any whitespaces between the tags.

Declaration

public string GetPreservedInnerText(bool trimStartEnd)

Parameters

Returns

Get the previous sibiling of this node. If this node is the first sibling, will return null.

Declaration

public Element GetPreviousSibling()

Returns

Gets the element rectangle. (X,Y) and width, height as it appears on browser and screen. Takes into account any scrolling.

Declaration

public virtual Rectangle GetRectangle()

Returns

Implements ITargetElement.GetRectangle()

Get the string representation of current element.

Declaration

public string GetStringPresentation()

Returns

Implements ITargetElement.GetStringPresentation()

Gets the text content of this element, recursing only into the listed tags

Declaration

public string GetTextContentRecursive(params string[] tags)

Parameters

Returns

Calculates the hash code for this element.

Declaration

public int GetUniqueHashCode()

Returns

Implements ITargetElement.GetUniqueHashCode()

Get a property value on this element.

Declaration

public virtual T GetValue<T>(string propertyName)

Parameters

Returns

Get a property value on this element.

Declaration

public virtual T GetValue<T>(string propertyName, T defaultValue)

Parameters

Returns

Get a property value on this element.

Declaration

[Obsolete]
public virtual T GetValue<T>(string propertyName, bool isJsWrappedObject)

Parameters

Returns

Get a property value on this element.

Declaration

[Obsolete]
public virtual T GetValue<T>(string propertyName, bool isJsWrappedObject, T defaultValue)

Parameters

Returns

Gets whether this element represents an iframe or frame

Declaration

public FrameInfo IsFrame()

Returns

Gets whether this element represents an iframe or frame

Declaration

public FrameInfo IsFrame(bool makeAbsolute, bool stripFinalBrowserSegment = false)

Parameters

Returns

Match this expression against element.

Declaration

public bool Match(IFindExpression findExpr)

Parameters

Returns

Implements ITargetElement.Match(IFindExpression)

Using the FindParamsUsed and the TestRegionIdUsed to find this element last, this methods will attempt to re-find this element in the new DOM tree.

Declaration

public virtual void Refresh()

Implements ITargetElement.Refresh()

Using the FindParamsUsed and the TestRegionIdUsed to find this element last, this methods will attempt to re-find this element in the new DOM tree.

Declaration

public virtual void Refresh(bool forceDomTreeRefresh)

Parameters

Set the matching closing tag.

Declaration

public void SetClosingTag(ITargetElement closingElement)

Parameters

Implements ITargetElement.SetClosingTag(ITargetElement)

Sets the hierarchical depth of this element.

Declaration

public void SetDepth(int depth)

Parameters

Implements ITargetElement.SetDepth(int)

Sets the parent of this Element.

Declaration

public void SetParent(ITargetElement parent)

Parameters

Implements ITargetElement.SetParent(ITargetElement)

Set a property to a value on this element.

Declaration

public virtual void SetValue<T>(string propertyName, T value)

Parameters

Set a property to a value on this element.

Declaration

public virtual void SetValue<T>(string propertyName, T value, bool isJsWrappedObject)

Parameters

String representation of an Element.

Declaration

public override string ToString()

Returns

Overrides object.ToString()