Namespace Ranorex.Core

Classes

ActionDescriptor: A descriptor for actions which are essentially methods.

ActionDescriptor.Argument: Represents an argument of an action, consisting of a name, type, and description.

AttributeDescriptor: A descriptor for element attributes.

AttributeDescriptor.WeightResolvingEventArgs: Event args for the WeightResolving event. The Weight property can be dynamically changed be the handler.

CacheSessionContext: Represents a scope wherein a Ranorex.Libs.CacheSession is active.

CachedResourceManager: A wrapper around a default ResourceManager instance that caches retrieved objects.

Capability: A capability is a logical grouping of actions and attributes which belong together.

CommandLine: Represents command line arguments passed to an application.

Configuration: Contains Ranorex configuration settings.

Configuration.AbstractConfig: Base class for configuration wrapper classes that make configuration parameter easily accessible.

Configuration.AdapterConfig: A collection of configuration parameters for the Adapter class.

Configuration.ConfigurationParam: Represents a single configuration parameter with a name, type and default and current value.

Configuration.CustomConfigurationParam: Represents a custom configuration parameter that can be registered at runtime (see Register(CustomConfigurationParam) method).

Configuration.DebuggerConfiguration: A collection of configuration parameters regarding debugging in Studio.

Configuration.EffectiveDataSetDialogConfig: A collection of configuration parameters for the EffectiveDataSetDialog.

Configuration.ImagingConfig: A collection of configuration parameters for Imaging operations.

Configuration.InputConfig: A collection of configuration parameters for keyboard/mouse input.

Configuration.KeyValueStoreData: A collection of configuration parameters for the NewRecordingDialog.

Configuration.KeyboardConfig: A collection of configuration parameters for the Keyboard class.

Configuration.ManageMobileDevicesFormConfig: A collection of configuration parameters for the ManageMobileDevicesForm.

Configuration.ModuleGroupBindingDialogConfig: A collection of configuration parameters for the ModuleGroupBindingDialog.

Configuration.PluginsConfig: A collection of configuration parameters that are specific to Ranorex plugins.

Configuration.PluginsConfig.Win32Config: A collection of configuration parameters for the Win32 plugin.

Configuration.PointerConfig: A collection of configuration parameters for the Mouse and Touch classes.

Configuration.RecorderConfig: A collection of recording configuration parameters.

Configuration.ReportConfig: A collection of configuration parameters that apply to all Ranorex reports.

Configuration.RepositoryConfig: A collection of repository configuration parameters.

Configuration.RxPathConfig: A collection of configuration parameters for the RxPath class.

Configuration.SpyConfig: A collection of configuration parameters for the Spy application.

Configuration.SqlConnectorConfig: The configuration parameters for the SqlDataConnector.

Configuration.TestCasePropertyDialogConfig: A collection of configuration parameters for the TestCasePropertyDialog.

Configuration.ToolsConfig: A collection of configuration parameters that apply to all Ranorex tools.

Configuration.ValidationConfig: A collection of configuration parameters for Validate operations.

Configuration.VariableStoreEditorFormConfig: A collection of configuration parameters for the VariableStoreEditorForm.

ConsoleLogger: The standard Ranorex console logger.

Constants: API to expose various Ranorex constants to test project code.

DefaultActionAttribute: Specifies the default action of an adapter.

Descriptor: The base descriptor used by many classes in the core.

Distance.DistanceConverter: Converts Distance instances from and to string instances.

Element: 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.

ElementEngine: The ElementEngine is a singleton which controls element tree construction, element lifecycle, and manages all flavors and capabilities registered by the plugins.

ElementInfo: Represents a container for a single captured element and some additional information.

ElementSnapshot: Represents the container for a tree of element snapshots.

ExtensionMethods: Provides common "extension" methods that are available in higher .NET Frameworks but not in the 2.0 Framework.

ExtensionMethods.CastingEnumerable<T>: Converts a non-generic IEnumerable instance to a generic IEnumerable<T> by casting each element to T.

Flavor: Represents a flavor.

FlavorElement: A container for flavor-specific element data which handles the default element properties.

FlavorPlugin: Represents a plugin which provides new flavors and capabilities.

Geometry: Helper class for geometry related methods.

GlueRuleRegisteredEventArgs: EventArgs for the GlueRuleRegistered event.

LineageGlueRule: Represents a tree element creation rule.

MobileEndpointInfo: Information object to define an WebDriver endpoint.

NullableBoolTypeConverter: Converts from nullable bool to string and vice versa.

OriginalDisplayNameAttribute: Specifies the original display name for a class or member.

Plugin: Represents a general plugin for the Ranorex Core architecture.

PluginLoadedEventArgs: EventArgs for the PluginLoaded event.

PluginManager: The singleton which manages the Ranorex Core plugins.

RanorexCoreException: Exception representing errors in the Ranorex core.

RemoteEndpointFactory

Factory to create and access endpoints. Example to create and use WebDriver endpoints in code.

// Create endpoint management factory
var fac = new RemoteEndpointFactory();

// Use existing endpoints
var existing = fac.GetAll();
Report.Log(ReportLevel.Info, string.Format("Endpoints: {0}", existing.Count()));

foreach (var e in existing)
{
    Report.Log(ReportLevel.Info, string.Format("Name: {0}", e.DisplayName));
}

// Get WebDriver endpoints form the existing ones (no equivalent for mobile currently)
var webDriverEndpoints = fac.GetAllWebDriverEndpoints();
Report.Log(ReportLevel.Info, string.Format("There are '{0}' WebDriver endpoints", webDriverEndpoints.Count()));

// Create user process endpoint
var ep = fac.CreateTransientWebDriverEndpoint(new WebDriverEndpointInfo("tempEp", "http://localhost:4444/wd/hub"));

var cfg = WebDriverConfiguration.FromJson("{}");
cfg.Name = "MyConfig1";
cfg.Description = "Code sample Config";

ep.ActivateConfiguration(cfg);

ep.ConnectAsync()
    .ContinueWith(_ => ep.MakeCurrentHostAsync())
    .Wait();

var b = ep.StartBrowser("firefox", "http://www.ranorex.com");

Example to create and use Mobile endpoints in code.

// Create endpoint management factory
var fac = new RemoteEndpointFactory();

// Create mobile endpoint in that way
MobileEndpointInfo info = new MobileEndpointInfo("ExampleEndpointName", "Android", "USB", "4100331a96f1a000");
// or MobileEndpointInfo info = new MobileEndpointInfo("ExampleEndpointName", "Ios", "WLAN", "192.168.1.13");
// or MobileEndpointInfo info = new MobileEndpointInfo("ExampleEndpointName", "Android", "Emulator", "emulator-5554");
var ep = fac.CreateMobileEndpoint(info);

// Use it like other endpoints
Host.MakeCurrentHost("ExampleEndpointName");
Host.Local.RunMobileApp("ExampleEndpointName", "ranorex.RxBrowser", true);

RemoteEndpointFactoryExtensions: Extends RemoteEndpointFactory with operations to handle Mobile endpoints.

Role: Roles are predefined capabilities.

RxPath: Represents a RanoreXPath.

RxPath.CostInfo: Represents cost/scoring information for elements when creating RxPaths.

SimpleReportMetadata: A simple implementation of the IReportMetadata interface allowing an easy construction of report meta data.

TechnologyLimitation: Describes a limitation that a technology has encountered.

TechnologyLimitation.Builder: Create TechnologyLimitation instances with a fluent API.

Util: Provides common utility methods.

Util.BaseContext: A base implementation of the IDisposable interface.

Util.CursorContext: A context for setting and restoring the application's current cursor.

Util.EnUsCultureContext: Provides a context that temporarily switches the culture of the current thread to the "en-us" culture.

Util.HideFormsContext: A context for hiding and restoring all open forms of the application.

ValueConverter: Supports converting strings to various types.

Watchdog: Provides a way to abort a thread after a specified timeout.

XmlLogger: The standard Ranorex XML-logger for 2.X projects.

Structs

Distance: Represents an proportional or fixed distance in pixels.

Interfaces

GlueRuleExecutionState: Represents the current state of glue rule execution.

IAdapter: The interface for all role and capability adapters.

IElement: 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.

IHost: Represents a machine/device that provides UI elements that can be automated by Ranorex.

IPluginControl: Plugins can implement this class to add their own user controls into the ranorex core system. The plugin controls will be added in the plugins pad in the UserInterface of Ranorex Studio.

IRemoteEndpoint: An generic endpoint.

IReportLogger: An interface which has to be implemented for custom loggers.

IReportMetadata: If implemented provides meta data for report generation.

ISelfHighlight: FlavorElements implementing this interface will be treated as elements that know how they can highlight them self and thereby will not be highlighted by Ranorex's standard highlight mechanism. This is primarily required for elements that do not reside on the machine the test runner is executed on because in such cases special handling (e.g. network commands) are required.

Enums

CodeGenLanguage: Defines languages available for code generation.

Configuration.RepositoryVariableDefaultAction: Denotes available actions to perform on repository variable when changing default value of recording variable.

EnsureVisibleBehaviorType: Describes how EnsureVisible() calls are forwarded to a FlavorElement.

FindRefineMode: Mode for GetChildLineageFromPoint(Point, out FindRefineMode) search postprocessing.

LineageGlueRule.Action: Specifies the action to be performed on source elements by applicable glue rules.

PathBuildMode: The method how RxPaths are built.

Role.ScrollBarStyle: The general style of a ScrollBar.

TechnologyLimitation.LogToReportOption: Determines whether to log a limitation to the report.

UidFindResult: Represents the result status after searching for a unique id.

Delegates

Configuration.ConfigurationParam.CheckValueHandler: Checks whether the value is valid for this parameter and converts the value to a valid format if possible.

ExtensionMethods.MapDelegate<T, S>: A delegate representing a function which maps objects of type T to type S.

GlueRuleRegisteredEventHandler: An event handler delegate for the GlueRuleRegistered event.

PluginLoadedEventHandler: A delegate for the PluginLoaded event handler.

ValueFromStringDelegate: A custom handler for parsing values from strings.

ValueToStringDelegate: A custom handler creating serialized strings from values.

Table of Contents

Namespace Ranorex.Core

Classes

Structs

Interfaces

Enums

Delegates