Click or drag to resize
Ranorex

Ranorex.Core Namespace

Provides classes that implement the core functionality of the Ranorex framework.
Classes
  ClassDescription
Public classActionDescriptor
A descriptor for actions which are essentially methods.
Public classActionDescriptorArgument
Represents an argument of an action, consisting of a name, type, and description.
Public classAttributeDescriptor
A descriptor for element attributes.
Public classAttributeDescriptorWeightResolvingEventArgs
Event args for the WeightResolving event. The Weight property can be dynamically changed be the handler.
Public classCachedResourceManager
A wrapper around a default ResourceManager instance that caches retrieved objects.
Public classCacheSessionContext
Represents a scope wherein a CacheSession is active.
Public classCapability
A capability is a logical grouping of actions and attributes which belong together.
Public classCommandLine
Represents command line arguments passed to an application.
Public classComStreamWrapper
IStream
Public classConfiguration
Contains Ranorex configuration settings.
Public classConfigurationAbstractConfig
Base class for configuration wrapper classes that make configuration parameter easily accessible.
Public classConfigurationAdapterConfig
A collection of configuration parameters for the Adapter class.
Public classConfigurationConfigurationParam
Represents a single configuration parameter with a name, type and default and current value.
Public classConfigurationCustomConfigurationParam
Represents a custom configuration parameter that can be registered at runtime (see Register(ConfigurationCustomConfigurationParam) method).
Public classConfigurationDebuggerConfiguration
A collection of configuration parameters regarding debugging in Studio.
Public classConfigurationEffectiveDataSetDialogConfig
A collection of configuration parameters for the EffectiveDataSetDialog.
Public classConfigurationImagingConfig
A collection of configuration parameters for Imaging operations.
Public classConfigurationInputConfig
A collection of configuration parameters for keyboard/mouse input.
Public classConfigurationKeyboardConfig
A collection of configuration parameters for the Keyboard class.
Public classConfigurationKeyValueStoreData
A collection of configuration parameters for the NewRecordingDialog.
Public classConfigurationManageMobileDevicesFormConfig
A collection of configuration parameters for the ManageMobileDevicesForm.
Public classConfigurationModuleGroupBindingDialogConfig
A collection of configuration parameters for the ModuleGroupBindingDialog.
Public classConfigurationPluginsConfig
A collection of configuration parameters that are specific to Ranorex plugins.
Public classConfigurationPluginsConfigWin32Config
A collection of configuration parameters for the Win32 plugin.
Public classConfigurationPointerConfig
A collection of configuration parameters for the Mouse and Touch classes.
Public classConfigurationRecorderConfig
A collection of recording configuration parameters.
Public classConfigurationReportConfig
A collection of configuration parameters that apply to all Ranorex reports.
Public classConfigurationRepositoryConfig
A collection of repository configuration parameters.
Public classConfigurationRxPathConfig
A collection of configuration parameters for the RxPath class.
Public classConfigurationSelectorsConfig
Represents the configuration settings related to selectors in Ranorex.
Public classConfigurationSpyConfig
A collection of configuration parameters for the Spy application.
Public classConfigurationSqlConnectorConfig
The configuration parameters for the SqlDataConnector.
Public classConfigurationTestCasePropertyDialogConfig
A collection of configuration parameters for the TestCasePropertyDialog.
Public classConfigurationToolsConfig
A collection of configuration parameters that apply to all Ranorex tools.
Public classConfigurationValidationConfig
A collection of configuration parameters for Validate operations.
Public classConfigurationVariableStoreEditorFormConfig
A collection of configuration parameters for the VariableStoreEditorForm.
Public classConsoleLogger
The standard Ranorex console logger.
Public classConstants
API to expose various Ranorex constants to test project code.
Public classDefaultActionAttribute
Specifies the default action of an adapter.
Public classDescriptor
The base descriptor used by many classes in the core.
Public classDistanceDistanceConverter
Converts Distance instances from and to String instances.
Public classElement
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.
Public classElementEngine
The ElementEngine is a singleton which controls element tree construction, element lifecycle, and manages all flavors and capabilities registered by the plugins.
Public classElementInfo
Represents a container for a single captured element and some additional information.
Public classElementSnapshot
Represents the container for a tree of element snapshots.
Public classElevationHelper
ElevationHelper to get the Elevation of process
Public classExtensionMethods
Provides common "extension" methods that are available in higher .NET Frameworks but not in the 2.0 Framework.
Public classExtensionMethodsCastingEnumerableT
Converts a non-generic IEnumerable instance to a generic IEnumerableT by casting each element to T.
Public classFlavor
Represents a flavor.
Public classFlavorElement
A container for flavor-specific element data which handles the default element properties.
Public classFlavorPlugin
Represents a plugin which provides new flavors and capabilities.
Public classGeometry
Helper class for geometry related methods.
Public classGlueRuleRegisteredEventArgs
EventArgs for the GlueRuleRegistered event.
Public classHostExtensions
Provides extensions for the IHost interface.
Public classIWebDriverExtensions
Utility methods for IWebDriver
Public classLineageGlueRule
Represents a tree element creation rule.
Public classMobileEndpointInfo
Information object to define an WebDriver endpoint.
Public classNullableBoolTypeConverter
Converts from nullable Boolean to String and vice versa.
Public classOriginalDisplayNameAttribute
Specifies the original display name for a class or member.
Public classPlugin
Represents a general plugin for the Ranorex Core architecture.
Public classPluginLoadedEventArgs
EventArgs for the PluginLoaded event.
Public classPluginManager
The singleton which manages the Ranorex Core plugins.
Public classRanorexCoreException
Exception representing errors in the Ranorex core.
Public classCode exampleRemoteEndpointFactory
Factory to create and access endpoints.
Examples
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);
Public classRemoteEndpointFactoryExtensions
Extends RemoteEndpointFactory with operations to handle WebDriver endpoints.
Public classRole
Roles are predefined capabilities.
Public classRotBridgeLauncher
Launches the ROT Bridge Helper
Public classRxPath
Represents a RanoreXPath.
Public classRxPathBuilder
Provides functionality to build RanoreXPath expressions for UI elements.
Public classRxPathBuilderCostInfo
Represents cost/scoring information for elements when creating RxPaths.
Public classSapBridgeManager
This is helper bridge class
Public classSapRotClient
SAPROTClient to read the ROT data from the helper exe
Public classSimpleReportMetadata
A simple implementation of the IReportMetadata interface allowing an easy construction of report meta data.
Public classTechnologyLimitation
Describes a limitation that a technology has encountered.
Public classTechnologyLimitationBuilder
Create TechnologyLimitation instances with a fluent API.
Public classUtil
Provides common utility methods.
Public classUtilBaseContext
A base implementation of the IDisposable interface.
Public classUtilCursorContext
A context for setting and restoring the application's current cursor.
Public classUtilEnUsCultureContext
Provides a context that temporarily switches the culture of the current thread to the "en-us" culture.
Public classUtilHideFormsContext
A context for hiding and restoring all open forms of the application.
Public classValueConverter
Supports converting strings to various types.
Public classWatchdog
Provides a way to abort a thread after a specified timeout.
Public classWebDriverConfiguration
A web driver configuration object which represents the capabilities required by an WebDriver endpoint.
Public classWebDriverEndpointInfo
Information object to define an WebDriver endpoint.
Public classXmlLogger
The standard Ranorex XML-logger for 2.X projects.
Structures
  StructureDescription
Public structureDistance
Represents an proportional or fixed distance in pixels.
Interfaces
  InterfaceDescription
Public interfaceGlueRuleExecutionState
Represents the current state of glue rule execution.
Public interfaceIAdapter
The interface for all role and capability adapters.
Public interfaceIElement
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.
Public interfaceIHost
Represents a machine/device that provides UI elements that can be automated by Ranorex.
Public interfaceIPluginControl
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.
Public interfaceIRemoteEndpoint
An generic endpoint.
Public interfaceIReportLogger
An interface which has to be implemented for custom loggers.
Public interfaceIReportMetadata
If implemented provides meta data for report generation.
Public interfaceISelfHighlight
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.
Public interfaceIWebDriverEndpoint
An WebDriver endpoint
Delegates
  DelegateDescription
Public delegateConfigurationConfigurationParamCheckValueHandler
Checks whether the value is valid for this parameter and converts the value to a valid format if possible.
Public delegateExtensionMethodsMapDelegateT, S
A delegate representing a function which maps objects of type T to type S.
Public delegateGlueRuleRegisteredEventHandler
An event handler delegate for the GlueRuleRegistered event.
Public delegatePluginLoadedEventHandler
A delegate for the PluginLoaded event handler.
Public delegateValueFromStringDelegate
A custom handler for parsing values from strings.
Public delegateValueToStringDelegate
A custom handler creating serialized strings from values.
Enumerations
  EnumerationDescription
Public enumerationCodeGenLanguage
Defines languages available for code generation.
Public enumerationConfigurationRepositoryVariableDefaultAction
Denotes available actions to perform on repository variable when changing default value of recording variable.
Public enumerationEnsureVisibleBehaviorType
Public enumerationFindRefineMode
Public enumerationLineageGlueRuleAction
Specifies the action to be performed on source elements by applicable glue rules.
Public enumerationPathBuildMode
The method how RxPaths are built.
Public enumerationRoleScrollBarStyle
The general style of a ScrollBar.
Public enumerationTechnologyLimitationLogToReportOption
Determines whether to log a limitation to the report.
Public enumerationUidFindResult
Represents the result status after searching for a unique id.