Element Class

Represents an UI item in the global UI tree. Instances of this class dynamically implement a Role and optional Capabilities, as well as numerous standard properties.

Inheritance Hierarchy

SystemObject
SystemMarshalByRefObject
Ranorex.CoreElement

Namespace: Ranorex.Core
Assembly: Ranorex.Core (in Ranorex.Core.dll) Version: 12.7.4-git.38314c06

Syntax

Copy

[SerializableAttribute]
[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public class Element : MarshalByRefObject, IElement, 
	ISerializable

<SerializableAttribute>
<TypeConverterAttribute(GetType(ExpandableObjectConverter))>
Public Class Element
	Inherits MarshalByRefObject
	Implements IElement, ISerializable

The Element type exposes the following members.

Constructors

	Name	Description
	Element	For Ranorex internal use only. Initializes a new instance of the Element class.

Top

Properties

	Name	Description
	Actions	A list of actions the element supports. This list is aggregated from the role and the capabilities.
	Attributes	A list of attributes the element supports. This list is aggregated from the role and the capabilities.
	Capabilities	The list of the capabilities the element has.
	ChildIndex	The index of this element in the parent's child list. Is '-1' if the index is unknown.
	Children	The list of children the element has.
	ClientRectangle	The bounding rectangle of the element, relative to the parent.
	DynamicCapability	Gets a capability providing dynamic attributes and actions that the element supports.
	Enabled	True if the element is enabled.
	FlavorElement	The flavor element associated with the element. This can be null, for example when using static snapshots.
	FlavorName	The name of the flavor this element belongs to.
	HasFocus	True if the element has the focus.
	IsRemote	Gets a value indicating whether the element resides on a remote device.
	IsSnapshot	Gets a value indicating whether this instance is a snapshot.
	Item	Indexer for attribute access.
	Limitations	Gets a list of technology specify limitations that are associated with this element.
	Location	The location of the element, relative to its parent.
	Parent	The parent of the element.
	PreferredCapability	The preferred capability of the element.
	Role	The role of the element (= main capability).
	ScreenLocation	The location of the element in screen coordinates.
	ScreenRectangle	The bounding rectangle of the element in screen coordinates.
	Size	The (x,y) size of element.
	TopLevelAncestor	The top-level ancestor of the element.
	Valid	Returns true if the element is believed to be valid.
	Visible	True if the element is visible.

Top

Methods

	Name	Description
	AsT	Returns an adapter of the specified type for the element.
	CaptureCompressedImage	Captures a PNG image of the element.
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	EnsureVisible	Tries to make the element visible to the user. This is usually accomplished by bringing the element or one of its ancestors to foreground.
	Equals(Object)	Compares the element to an object. (Overrides ObjectEquals(Object).)
	Equals(Element, Element)	Returns true if the two instances are considered equal.
	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(RxPath)	Applies a Ranorex Path to the element.
	Find(RxPath, Duration)	Applies a Ranorex Path to the element.
	FindFromPoint(Point)	Find an element by screen location. The found element is a descendant of this instance or this instance itself.
	FindFromPoint(Point, RxPath)	Find an element by screen location and build its RxPath. The found element is a descendant of this instance or this instance itself.
	FindFromUid	Finds a descendant element by its unique identifier attribute (defined by the owner flavor UidAttribute name).
	FindSingle(RxPath)	Applies a Ranorex Path to the element.
	FindSingle(RxPath, Duration)	Applies a Ranorex Path to the element.
	Focus	Tries to set the focus on the element.
	FromPath	Converts a string to an element instance by searching the root.
	GetAttributeValue	Returns the value of an attribute.
	GetAttributeValueText(String)	Returns the value of an attribute converted to its string representation.
	GetAttributeValueText(String, Regex)	Returns the value of an attribute converted to its string representation. If a regex is provided, only the part of the string representation matching the regular expression is returned.
	GetHashCode	Default implementation override. (Overrides ObjectGetHashCode.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetObjectData	For Ranorex internal use only. Populates a SerializationInfo with the data needed to serialize the target object.
	GetPath(PathBuildMode)	Builds an absolute RxPath to the element.
	GetPath(PathBuildMode, Element)	Builds an RxPath to the element, relative to another element.
	GetRobustPath	Builds an absolute RxPath to the element.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasCapability	Tests if the element possesses a certain capability (or role), by name.
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	InvokeAction	Invokes an action on the element.
	InvokeActionWithText	Invokes an action on the element.
	IsAncestor	Determines whether the current element is an ancestor of the specified child element.
	IsEqual	Compares two elements by comparing their flavor elements or their screen rectangles if no flavor comparison is possible.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	SetAttributeValue(String, Object)	Sets the value of an attribute.
	SetAttributeValue(String, String)	Sets the value of an attribute.
	ToString	Returns a String that represents the current Object. (Overrides ObjectToString.)
	TryFindSingle(RxPath, Element)	Tries to apply a Ranorex Path to the element.
	TryFindSingle(RxPath, Duration, Element)	Tries to apply a Ranorex Path to the element.

Top

Operators

	Name	Description
	(String to Element)	Implicitly converts a string to an element instance by searching the root.

Top

Reference

Ranorex.Core Namespace