RanorexRanorex Documentation
Ranorex Namespace
NamespacesRanorex
The main Ranorex namespace providing classes for different UI element types. Each type has distinct actions and attributes.
Declaration Syntax
C#Visual BasicVisual C++
namespace Ranorex
Namespace Ranorex
namespace Ranorex
Types
All TypesClassesStructuresEnumerationsDelegates
IconTypeDescription
AbbrTag
The HTML 'abbr' tag.

Accessible
Capability of an MSAA accessible object.

AccessibleTreeItem
Capability of an MSAA tree item.

AcronymTag
The HTML 'acronym' tag.

ActionFailedException
Exception that is thrown when executing an action on an Element failed (see InvokeAction(String, array<Object>[]()[])).

Adapter
The base class for all role and capability adapters.

AddressTag
The HTML 'address' tag.

AirWindow
This element is an Adobe AIR application.

AndroidApp
A capability that adds additional attributes to elements that represent a mobile application.

AndroidElement
General capability for UI elements of a mobile device.

AppletTag
The HTML 'applet' tag.

ApplicationNotRespondingException
Exception that is thrown when trying to access elements corresponding to an application that is not responding.

AreaTag
The HTML 'area' tag.

ArticleTag
The HTML5 'article' tag.

AsideTag
The HTML5 'aside' tag.

ATag
The HTML 'a' tag.

AudioTag
The HTML5 'audio' tag.

BaseFontTag
The HTML 'basefont' tag.

BaseTag
The HTML 'base' tag.

BdoTag
The HTML 'bdo' tag.

BigTag
The HTML 'big' tag.

Imaging..::.BitmapMemoryPressure
Adds memory pressure to a bitmap.

BlockQuoteTag
The HTML 'blockquote' tag.

BodyTag
The HTML 'body' tag.

BrTag
The HTML 'br' tag.

BTag
The HTML 'b' tag.

Button
Represents a push button.

ButtonTag
The HTML 'button' tag.

CanvasTag
The HTML5 'canvas' tag.

CapabilityNotSupportedException
Exception that is thrown when an element does not provide a required capability.

CaptionTag
The HTML 'caption' tag.

Cell
Represents a table cell.

CenterTag
The HTML 'center' tag.

Checkable
Represents an element that allows the user to select a true or false condition.

CheckBox
Represents a check box that allows the user to select a true or false condition.

CiteTag
The HTML 'cite' tag.

CodeTag
The HTML 'code' tag.

ColGroupTag
The HTML 'colgroup' tag.

ColTag
The HTML 'col' tag.

Column
Represents a table column.

ComboBox
Represents a combo box control.

CommandTag
The HTML5 'command' tag.

CompressedImage
Represents a PNG compressed image.

Container
Represents a logical container element, such as a panel or groupbox.

ContextMenu
Represents a context popup menu.

Control
Capability of a .NET Windows Forms control.

ControlNet11
Capability of a .NET 1.1 Windows Forms control.

Validate..::.CreateScreenshot
Specifies whether to add a screenshot to the report.

DataListTag
The HTML5 'datalist' tag.

DataSources
A collection providing access to data connectors defined in the current TestSuite.

DateTime
Represents a datetime picker or calendar control.

DdTag
The HTML 'dd' tag.

Delay
Provides simple delay functionality which is automatically scaled by a configurable speed factor.

DelTag
The HTML 'del' tag.

Host..::.DeploymentModes
States how deployment shall be done.

Desktop
Represents the operating system desktop.

DetailsTag
The HTML5 'details' tag.

DfnTag
The HTML 'dfn' tag.

DirTag
The HTML 'dir' tag.

DivTag
The HTML 'div' tag.

DlTag
The HTML 'dl' tag.

DtTag
The HTML 'dt' tag.

Duration
Represents a span of time.

Duration..::.DurationConverter
Converts from Duration to String and vice versa.

ElementNotFoundException
Exception that is thrown when a specific element is not found in a search method.

EmbedTag
The HTML 'embed' tag.

EmTag
The HTML 'em' tag.

EventSubscriptionFailedException
Exception that is thrown when subscribing to or unsubscribing from an event on an Element failed (see SubscribeEvent(String, Delegate).

ExcelApplication
Capability of an Excel Application.

ExcelOleObject
Capability of an Excel OleObject.

ExcelRange
Capability of an Excel Range.

ExcelShape
Capability of an Excel Shape.

ExcelWorkBook
Capability of an Excel WorkBook.

ExcelWorkSheet
Capability of an Excel WorkSheet.

FieldSetTag
The HTML 'fieldset' tag.

FigCaptionTag
The HTML5 'figcaption' tag.

FigureTag
The HTML5 'figure' tag.

Imaging..::.FindOptions
Defines options for image find methods (see Find(Element, Bitmap) and FindSingle(Element, Bitmap) methods).

FlexDataItem
The element is a part of a flex data provider collection.

FlexElement
The element is a part of a flash application.

FlexObject
This element is a flex or flash application.

FontTag
The HTML 'font' tag.

FooterTag
The HTML5 'footer' tag.

Form
Represents an application main window or a dialog window.

FormTag
The HTML 'form' tag.

FramesetTag
The HTML 'frameset' tag.

FrameTag
The HTML 'frame' tag.

Grip
Represents an element that can be moved or dragged, e.g. a size grip for resizing windows or controls.

H1Tag
The HTML 'h1' tag.

H2Tag
The HTML 'h2' tag.

H3Tag
The HTML 'h3' tag.

H4Tag
The HTML 'h4' tag.

H5Tag
The HTML 'h5' tag.

H6Tag
The HTML 'h6' tag.

HeaderTag
The HTML5 'header' tag.

HeadTag
The HTML 'head' tag.

HGroupTag
The HTML5 'hgroup' tag.

Host
Represents the host machine running Ranorex.

HrTag
The HTML 'hr' tag.

IFrameTag
The HTML 'iframe' tag.

IHtmlTag
The HTML 'html' tag.

ImageNotFoundException
Exception that is thrown when an image is not found in a search method.

ImageValidationException
Exception that is thrown when an image is not found in a search method.

Imaging
Provides methods to create screenshots of elements, to search for images, and for image processing.

ImgTag
The HTML 'img' tag.

Indicator
Represents the indicator part of a slider or scrollbar.

InputTag
The HTML 'input' tag.

InsTag
The HTML 'ins' tag.

IosApp
A capability that adds additional attributes to elements that represent a mobile application.

IosElement
This capability adds iOS specific attributes to the UI element.

IosPicker
Capability for an iOS UIPicker control.

IosScrollView
This capability adds iOS specific attributes to the UI element.

IosTable
This capability adds iOS specific attributes to the UI element.

IsIndexTag
The HTML 'isindex' tag.

ITag
The HTML 'i' tag.

JavaApplet
This element is a Java Applet.

JavaElement
The element is a part of a Java application.

KbdTag
The HTML 'kbd' tag.

Keyboard
Provides keyboard actions and events.

KeyEventArgs
Provides data for the events of the Keyboard class.

KeyEventHandler
Represents the method that will handle the events of the Keyboard class.

KeyGenTag
The HTML5 'keygen' tag.

LabelTag
The HTML 'label' tag.

LegendTag
The HTML 'legend' tag.

Link
Represents a hyperlink.

LinkTag
The HTML 'link' tag.

List
Represents a logical list such as a listbox.

ListItem
Represents an item in a list.

LiTag
The HTML 'li' tag.

Location
Represents an abstract, relative location within an element or on the screen.

Location..::.LocationConverter
Converts Location instances from and to String instances.

MapTag
The HTML 'map' tag.

MarkTag
The HTML5 'mark' tag.

Imaging..::.Match
A match in a image find operation.

Imaging..::.MatchSimilarityComparer
Compares to matches by their similarity.

MenuBar
Represents a menu bar.

MenuItem
Represents an entry in a menubar or context menu.

MenuTag
The HTML 'menu' tag.

MetaTag
The HTML 'meta' tag.

MeterTag
The HTML5 'meter' tag.

MobileApp
A capability that adds additional attributes to elements that represent a mobile application.

MobileDevice
Represents the capability of a mobile device that is connected to Ranorex.

MobileForm
Capability that adds additional information to forms on a mobile device.

MobileUiElement
General capability for UI elements of a mobile device.

MobileWebDocument
Capablity representing a web document displayed within a web view.

Mouse
Provides mouse actions and events.

MouseEventArgs
Provides data for the events of the Mouse class.

MouseEventHandler
Represents the method that will handle the events of the Mouse class.

NativeItem
This element represents a native item (a logical part of a win32 control).

NativeWindow
This element is a native win32 window or control.

NavTag
The HTML5 'nav' tag.

NoFramesTag
The HTML 'noframes' tag.

NoScriptTag
The HTML 'noscript' tag.

ObjectTag
The HTML 'object' tag.

OlTag
The HTML 'ol' tag.

OperationFailedException
Exception that is thrown when executing an operation on an Element failed.

OptGroupTag
The HTML 'optgroup' tag.

Validate..::.Options
Provides additional options for a validation action.

OptionTag
The HTML 'option' tag.

OutputTag
The HTML5 'output' tag.

ParamTag
The HTML 'param' tag.

Picture
Represents a picture, icon, image or diagram.

PopupItemCallback
A callback to notify the client of unexpected dialogs/popups.

PopupPathCallback
A callback to notify the client of unexpected dialogs/popups.

PopupWatcher
Allows watching for unexpected dialogs and popups in the background.
Use Watch(RepoItemInfo, PopupItemCallback) or WatchAndClick(RepoItemInfo, RepoItemInfo) to register for notifications by providing a repository item or RxPath to watch for, as well as a callback to get notified or another repository item to click on if the watched element is found.

Imaging..::.Preprocessings
Defines preprocessing steps that can be performed on an image.

PreTag
The HTML 'pre' tag.

Imaging..::.Processing
Provides low-level image processing routines.

ProgressBar
Represents a progress bar.

ProgressTag
The HTML5 'progress' tag.

PTag
The HTML 'p' tag.

QTag
The HTML 'q' tag.

RadioButton
Represents a radio button which enables the user to select a single option from a group of choices.

RanorexException
The base class for all Ranorex-specific exceptions.

RawImage
Raw image data drawn by the GDI API.

RawText
Raw text drawn by the GDI API.

RawTextBlock
Raw text block drawn by the GDI API.

RecordItemIndex
Provides metadata information about the index of record items for report generation.

RemotelyInvokedDelegate
Delegate for the InvokeRemotely(RemotelyInvokedDelegate) method with input data.

Report
The Ranorex reporting service.
Used to log messages to a number of configured loggers.

ReportLevel
Defines (importance-) levels used for logging individual messages.

ReportLevel..::.ReportLevelConverter
Converts from ReportLevel to String and vice versa.

Row
Represents a table row.

RpTag
The HTML5 'rp' tag.

RtTag
The HTML5 'rt' tag.

RubyTag
The HTML5 'ruby' tag.

RxPathException
Exception that is thrown when constructing an RxPath instance fails.

SampTag
The HTML 'samp' tag.

SapElement
The element is a part of an SAP GUI application.

SapItem
The element represents an item in a SAP data-bound control.

SapWindow
The element represents a top-level window of a SAP GUI application.

ScriptTag
The HTML 'script' tag.

ScrollBar
Represents a vertical or horizontal scroll bar control.

SectionTag
The HTML5 'section' tag.

SelectTag
The HTML 'select' tag.

Separator
Represents a separator used for menus and toolbars.

SetAttributeFailedException
Exception that is thrown when setting an attribute on an Element failed (see SetAttributeValue(String, Object)).

Slider
Represents a slider or trackbar control.

SmallTag
The HTML 'small' tag.

SourceTag
The HTML5 'source' tag.

SpanTag
The HTML 'span' tag.

STag
The HTML 's' tag.

StatusBar
Represents a status bar usually located at the bottom of a form.

StrikeTag
The HTML 'strike' tag.

StrongTag
The HTML 'strong' tag.

StyleTag
The HTML 'style' tag.

SubTag
The HTML 'sub' tag.

SummaryTag
The HTML5 'summary' tag.

SupTag
The HTML 'sup' tag.

Table
Represents a table or grid, consisting of rows and columns.

TableTag
The HTML 'table' tag.

TabPage
Represents a tab page in a tab page list.

TabPageList
Represents a tab page list.

TBodyTag
The HTML 'tbody' tag.

TdTag
The HTML 'td' tag.

Text
Represents an edit box, a text area, or static text.

TextAreaTag
The HTML 'textarea' tag.

TFootTag
The HTML 'tfoot' tag.

THeadTag
The HTML 'thead' tag.

ThTag
The HTML 'th' tag.

TimeTag
The HTML5 'time' tag.

TitleBar
Represents the title bar of a form or dialog window.

TitleTag
The HTML 'title' tag.

ToggleButton
Capability for ToggleButton UI elements.

ToolBar
Represents a tool bar.

ToolTip
Represents tooltip popup.

Touch
Provides touch input actions.

Tree
Represents a tree control.

TreeItem
Represents an item in a tree.

TrTag
The HTML 'tr' tag.

TtTag
The HTML 'tt' tag.

UIAutomation
Capability of an UI AutomationElement.

UIAutomationInvoke
Capability for the UIA Invoke pattern.

UIAutomationRangeValue
Capability for the UIA RangeValue pattern.

UIAutomationToggle
Capability for the UIA Toggle pattern.

UIAutomationValue
Capability for the UIA Value pattern.

UIAutomationVirtualizedItem
Capability for the UIA VirtualizedItem pattern.

UlTag
The HTML 'ul' tag.

Unknown
Represents a UI element which cannot be further categorized.

UTag
The HTML 'u' tag.

Validate
Provides a number of different validation methods.

ValidationException
Exception that is thrown if validation using the Validate class fails.

VarTag
The HTML 'var' tag.

VideoTag
The HTML5 'video' tag.

WbrTag
The HTML5 'wbr' tag.

WebDocument
The element is an IE web document.

WebElement
This element is an IE web element.

WindowsApp
Capability for Windows UI apps.

WordApplication
Capability of an Word Application.

WordDocument
Capability of an Word Document.