Ranorex API

https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm
Admin
The Ranorex API allows users to programmatically write automated tests in code, providing access to...
Tokens:6,865,880
Snippets:54,536
Trust Score:9.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Ranorex.Report.Setup Method Code Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Report_Setup

Code examples demonstrating the `Setup` method of the `Ranorex.Report` class in C# and VB.NET. This method configures the reporting environment, specifying the minimum report level, XML report file, and console logging.

```C#
public static void Setup(
	ReportLevel minLevel,
	string xmlReportFileName,
	bool logToConsole
)
```

```VB.NET
Public Shared Sub Setup (
	minLevel As ReportLevel,
	xmlReportFileName As String,
	logToConsole As Boolean
)
```

--------------------------------

### Ranorex.Core.Reporting.TestReport.Setup Method Usage Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Core_Reporting_TestReport_Setup_2

Code examples demonstrating how to call the `Setup` method of the `TestReport` class in C# and VB.NET to initialize the Ranorex reporting system.

```VB
Public Shared Sub Setup (
	minLevel As ReportLevel,
	fileName As String,
	logToConsole As Boolean,
	enableTracingScreenshots As Boolean,
	writeInterval As Duration,
	customReportFileLocation As String
)
```

--------------------------------

### Ranorex Adapter: TouchStart Method Overloads and Example

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_QtItem

Documentation for the `TouchStart` method in the `Ranorex.Adapter` class, used to initiate touch operations, including multi-touch gestures. Various overloads support different ways of specifying the starting location. An example demonstrates a basic swipe gesture.

```APIDOC
Ranorex.Adapter Class Methods:

TouchStart(Location location)
  Description: Performs a touch start action on the adapter.
  Inherited from: Adapter

TouchStart(Double x, Double y)
  Description: Begins a multi touch operation on the adapter. Multi touch operations can be used to compose more complex touch gestures. E.g. a swipe from left to right could be composed in the following way (see C# example below).
  Useful multitouch operations always have the form: 1 TouchStart, 0-N TouchMove, 1 TouchEnd
  Inherited from: Adapter

TouchStart(Int32 x, Location location)
  Description: Performs a touch start action on the adapter.
  Inherited from: Adapter

TouchStart(Int32 x, Int32 y)
  Description: Begins a multi touch operation on the adapter. Multi touch operations can be used to compose more complex touch gestures. E.g. a swipe from left to right could be composed in the following way (see C# example below).
  Useful multitouch operations always have the form: 1 TouchStart, 0-N TouchMove, 1 TouchEnd
  Inherited from: Adapter
```

```C#
adapter.TouchStart(Location.Left);
adapter.TouchEnd(Location.Right);
```

--------------------------------

### C# Example: Configure Ranorex Test Report Setup

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Core_Reporting_TestReport_Setup_1

Demonstrates how to use the TestReport.Setup method in C# to initialize the Ranorex reporting environment. This example configures the minimum report level, specifies the log file name, enables console logging, enables tracing screenshots, and sets the report write interval.

```C#
public static void Setup(
	ReportLevel minLevel,
	string fileName,
	bool logToConsole,
	bool enableTracingScreenshots,
	Duration writeInterval
)
```

--------------------------------

### Example: Configure Ranorex Test Report Setup

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Core_Reporting_TestReport_Setup_3

Code examples demonstrating how to use the `Ranorex.Core.Reporting.TestReport.Setup` method to configure the reporting environment, including setting the minimum report level, log file name, console logging, and custom report file location.

```C#
public static void Setup(
	ReportLevel minLevel,
	string fileName,
	bool logToConsole,
	string customReportFileLocation
)
```

```VB
Public Shared Sub Setup (
	minLevel As ReportLevel,
	fileName As String,
	logToConsole As Boolean,
	customReportFileLocation As String
)
```

--------------------------------

### VB.NET Example: Configure Ranorex Test Report Setup

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Core_Reporting_TestReport_Setup_1

Illustrates how to use the TestReport.Setup method in VB.NET to initialize the Ranorex reporting environment. This example configures the minimum report level, specifies the log file name, enables console logging, enables tracing screenshots, and sets the report write interval.

```VB.NET
Public Shared Sub Setup (
	minLevel As ReportLevel,
	fileName As String,
	logToConsole As Boolean,
	enableTracingScreenshots As Boolean,
	writeInterval As Duration
)
```

--------------------------------

### PerfInterval.Start Method Code Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Core_Tracing_PerfInterval_Start

Examples demonstrating how to call the static `Start` method of the `PerfInterval` class in C# and VB.NET. This method initializes and begins a new performance interval, returning an instance of `PerfInterval`.

```C#
public static PerfInterval Start()
```

```VB.NET
Public Shared Function Start As PerfInterval
```

--------------------------------

### Ranorex Adapter.TouchStart Method Overloads and Example

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_Container

Documents the various overloads for the `TouchStart` method of the Ranorex Adapter class, which performs a touch start action or begins a multi-touch operation. Includes an example of a multi-touch swipe. All overloads inherit from the `Adapter` class.

```APIDOC
Method: TouchStart
Description: Performs a touch start action on the adapter or begins a multi-touch operation. (Inherited from Adapter class).

Overloads:
- TouchStart(Location location)
  Description: Performs a touch start action on the adapter.
- TouchStart(Double x, Double y)
  Description: Begins a multi touch operation on the adapter. Multi touch operations can be used to compose more complex touch gestures. Useful multitouch operations always have the form: 1 TouchStart, 0-N TouchMove, 1 TouchEnd.
- TouchStart(Int32 x, Location location)
  Description: Performs a touch start action on the adapter.
- TouchStart(Int32 x, Int32 y)
  Description: Begins a multi touch operation on the adapter. Multi touch operations can be used to compose more complex touch gestures. Useful multitouch operations always have the form: 1 TouchStart, 0-N TouchMove, 1 TouchEnd.
```

```C#
adapter.TouchStart(Location.Left);
adapter.TouchEnd(Location.Right);
```

--------------------------------

### Start Browser using Ranorex WebDriver

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_WebDriver_StartBrowser

Code examples demonstrating how to use the `StartBrowser` method of the `Ranorex.WebDriver` class to launch a browser with a given URL in C# and VB.

```C#
public virtual string StartBrowser(
	string Browser,
	string Url
)
```

```VB
Public Overridable Function StartBrowser (
	Browser As String,
	Url As String
) As String
```

--------------------------------

### Get Ranorex WindowsApp.AppPath Property in C# and VB

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_WindowsApp_AppPath

Example code demonstrating how to access the read-only `AppPath` property of the `Ranorex.WindowsApp` class in both C# and VB. This property returns the installation path of the application.

```C#
public virtual string AppPath { get; }
```

```VB
Public Overridable ReadOnly Property AppPath As String
	Get
```

--------------------------------

### Ranorex VideoStartingEventArgs StartVideo Property Definition

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_Core_Reporting_VideoStartingEventArgs_StartVideo

Code examples in C# and VB.NET demonstrating the syntax for defining the `StartVideo` boolean property within the `Ranorex.Core.Reporting.VideoStartingEventArgs` class. This property allows getting and setting the video recording start status.

```C#
public bool StartVideo { get; set; }
```

```VB
Public Property StartVideo As Boolean
	Get
	Set
```

--------------------------------

### Get/Set Ranorex EmbedTag Autostart Property

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_EmbedTag_Autostart

Code examples demonstrating how to get and set the 'Autostart' property of the Ranorex EmbedTag class in C# and VB.NET. This property controls whether an embedded element starts playing automatically.

```C#
public virtual string Autostart { get; set; }
```

```VB
Public Overridable Property Autostart As String
	Get
	Set
```

--------------------------------

### IWebDriverEndpoint.StartBrowser Method Syntax Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Core_IWebDriverEndpoint_StartBrowser

Code examples demonstrating the syntax for calling the `StartBrowser` method in both C# and VB.NET, used to initiate a browser session for automation.

```C#
IWebDriver StartBrowser(
	string browser,
	string url
)
```

```VB
Function StartBrowser (
	browser As String,
	url As String
) As IWebDriver
```

--------------------------------

### Manage WebDriver Endpoints with RemoteEndpointFactory (C#)

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/T_Ranorex_Core_RemoteEndpointFactory

This example demonstrates how to use the RemoteEndpointFactory to create, retrieve, and manage WebDriver endpoints. It covers listing existing endpoints, getting WebDriver-specific endpoints, creating a transient WebDriver endpoint, activating its configuration, connecting, making it the current host, and starting a browser.

```C#
// 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");
```

--------------------------------

### Ranorex Adapter TouchStart Method

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_QTag

Documentation for the `TouchStart` method of the Ranorex Adapter class, which initiates a touch action at a specified location.

```APIDOC
TouchStart(Location)
  Description: Performs a touch start action on the adapter.
  Inherited from: Adapter
```

--------------------------------

### Ranorex FramesetTag.Title Property Syntax Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_FramesetTag_Title

Syntax examples for the `Title` property of the `Ranorex.FramesetTag` class in C# and VB.NET, demonstrating how to get and set its value.

```C#
public virtual string Title { get; set; }
```

```VB
Public Overridable Property Title As String
	Get
	Set
```

--------------------------------

### Ranorex.Core.Reporting.TestReport.BeginTestContainerSetup API Reference

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Core_Reporting_TestReport_BeginTestContainerSetup

Detailed API reference for the `BeginTestContainerSetup` method within the `Ranorex.Core.Reporting.TestReport` class. This method initiates a 'Setup' container activity, pushing it onto the `ActivityStack` to structure test reports. It is part of the Ranorex.Core assembly.

```APIDOC
Method: BeginTestContainerSetup
Description: Creates a new Activity of type Setup container and pushes it on the ActivityStack.
Namespace: Ranorex.Core.Reporting
Assembly: Ranorex.Core (in Ranorex.Core.dll) Version: 12.4.0+git.30b63b20
Signature (C#): public static void BeginTestContainerSetup()
Signature (VB.NET): Public Shared Sub BeginTestContainerSetup
```

--------------------------------

### API Reference: Ranorex.Core.Reporting.TestReport.Setup Method

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Core_Reporting_TestReport_Setup_3

Detailed API documentation for the `TestReport.Setup` method, including its signature, namespace, assembly, and a comprehensive description of each parameter: `minLevel`, `fileName`, `logToConsole`, and `customReportFileLocation`.

```APIDOC
Method: Setup
Description: Sets up the reporting environment.

Namespace: Ranorex.Core.Reporting
Assembly: Ranorex.Core (in Ranorex.Core.dll) Version: 12.4.0+git.30b63b20

Parameters:
  minLevel:
    Type: Ranorex.ReportLevel
    Description: The minimum ReportLevel for messages that are to be written to the report.
  fileName:
    Type: System.String
    Description: Name of the XML log file, or null if XML logging should be disabled.
  logToConsole:
    Type: System.Boolean
    Description: If set to true, logging to console is enabled.
  customReportFileLocation:
    Type: System.String
    Description: File location for custom reports.
```

--------------------------------

### Ranorex.Core.Configuration.SpyConfig.FormState Property Code Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_Core_Configuration_SpyConfig_FormState

Code examples demonstrating how to get and set the FormState property of the Ranorex.Core.Configuration.SpyConfig class, which controls the window state of the Spy form at startup.

```C#
public FormWindowState FormState { get; set; }
```

```VB
Public Property FormState As FormWindowState
	Get
	Set
```

--------------------------------

### Ranorex IosApp.StartApp Method API Reference

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_IosApp_StartApp

API documentation for the `StartApp` method of the `Ranorex.IosApp` class, used to initiate an application on an iOS device. It includes syntax examples in C# and VB, details on parameters, return values, and exceptions.

```C#
public virtual string StartApp(
	string App,
	bool ResetInitialState
)
```

```VB
Public Overridable Function StartApp (
	App As String,
	ResetInitialState As Boolean
) As String
```

```APIDOC
Parameters:
  App:
    Type: System.String
    Description: The package name of the application to start e.g. 'ranorex.services'. Use the FetchStartableApps command to get a list of valid values from the device.
  ResetInitialState:
    Type: System.Boolean
    Description: Indicates if the app should be restarted on launch or just brought to the foreground in case the app is already running.
```

```APIDOC
Return Value:
  Type: System.String
  Description: The value that will be returned by the action invocation.
```

```APIDOC
Exceptions:
  ActionFailedException:
    Condition: Thrown if invoking the action failed.
```

--------------------------------

### Get Guid Property Syntax in Ranorex TestModuleAttribute

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_Core_Testing_TestModuleAttribute_Guid

This snippet shows the syntax for accessing the read-only 'Guid' property of the 'TestModuleAttribute' class in Ranorex. The property returns a 'CaseInsensitiveString' representing the unique ID of the test module.

```C#
public CaseInsensitiveString Guid { get; }
```

```VB
Public ReadOnly Property Guid As CaseInsensitiveString
	Get
```

--------------------------------

### Get CurrentRow Property (VB.NET)

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_Core_Data_DataContext_CurrentRow

Example demonstrating how to access the read-only CurrentRow property in VB.NET to get the currently positioned row from a DataContext object.

```VB
Public ReadOnly Property CurrentRow As Row
	Get
```

--------------------------------

### Ranorex Adapter TouchStart Method (Simple)

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/T_Ranorex_QtWindow

Performs a touch start action on the adapter. Inherited from Adapter.

```APIDOC
TouchStart(Location)
```

```APIDOC
TouchStart(Int32, Location)
```

--------------------------------

### Get CurrentRow Property (C#)

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_Core_Data_DataContext_CurrentRow

Example demonstrating how to access the read-only CurrentRow property in C# to get the currently positioned row from a DataContext object.

```C#
public Row CurrentRow { get; }
```

--------------------------------

### Get RanorexGroupMemberIds Property (WpfCoreGroupElement)

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_WpfCoreGroupElement_RanorexGroupMemberIds

This property retrieves the GUIDs used to identify the members of a DependencyObjectGroup within the Ranorex WpfCoreGroupElement class. It is a read-only property that returns an array of GUIDs.

```C#
public virtual Guid[] RanorexGroupMemberIds { get; }
```

```VB
Public Overridable ReadOnly Property RanorexGroupMemberIds As Guid()
	Get
```

--------------------------------

### API Documentation: Ranorex TestReport.Setup Method (ReportLevel, String, Boolean, Boolean, Duration)

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Core_Reporting_TestReport_Setup_1

Detailed API documentation for the Ranorex.Core.Reporting.TestReport.Setup method overload, outlining its purpose, namespace, assembly, and a comprehensive breakdown of each parameter's type and description.

```APIDOC
TestReport.Setup Method (ReportLevel, String, Boolean, Boolean, Duration)

Purpose: Sets up the reporting environment.

Namespace: Ranorex.Core.Reporting
Assembly: Ranorex.Core (in Ranorex.Core.dll) Version: 12.4.0+git.30b63b20

Parameters:
  minLevel:
    Type: RanorexReportLevel
    Description: The minimum ReportLevel for messages that are to be written to the report.
  fileName:
    Type: SystemString
    Description: Name of the XML log file, or null if XML logging should be disabled.
  logToConsole:
    Type: SystemBoolean
    Description: If set to true, logging to console is enabled.
  enableTracingScreenshots:
    Type: SystemBoolean
    Description: Determines whether screenshots should be made for every step. This provides a number of diagnostic screenshots in case of an error.
  writeInterval:
    Type: RanorexDuration
    Description: The time interval for the current report to be saved to the target file.
```

--------------------------------

### API Documentation: Ranorex Adapter.TouchStart Method

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_DelTag

Documents the `TouchStart` method within the Ranorex Adapter class. This method performs a touch start action on the adapter. It is inherited from the `Adapter` class.

```APIDOC
TouchStart(Location)
```

--------------------------------

### Ranorex.InsTag.Cite Property Syntax Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_InsTag_Cite

Code examples demonstrating the syntax for the 'Cite' property of the Ranorex.InsTag class in both C# and VB.NET, used for getting and setting the 'cite' attribute.

```C#
public virtual string Cite { get; set; }
```

```VB
Public Overridable Property Cite As String
	Get
	Set
```

--------------------------------

### TouchStart Method (Ranorex Adapter)

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_SummaryTag

Provides API documentation for the 'TouchStart' method on the Ranorex Adapter class. This method performs a touch start action on the adapter at a specified location.

```APIDOC
Class: Ranorex.Adapter
  Method: TouchStart
    Description: Performs a touch start action on the adapter.
    Overloads:
      TouchStart(Location location)
```

--------------------------------

### CsvFileTraceWriter.Initialize Method API and Code Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Core_Tracing_CsvFileTraceWriter_Initialize

Provides API documentation and code examples for the Initialize method of the CsvFileTraceWriter class, used for one-time lazy setup of the trace writer. It implements ITraceWriterInitialize.

```APIDOC
Class: CsvFileTraceWriter
Method: Initialize

Description: One-time lazy setup of the writer.

Namespace: Ranorex.Core.Tracing
Assembly: Ranorex.Core (in Ranorex.Core.dll) Version: 12.4.0+git.30b63b20

Implements:
  - ITraceWriterInitialize

Signature:
  C#: public void Initialize()
  VB: Public Sub Initialize
```

```C#
public void Initialize()
```

```VB
Public Sub Initialize
```

--------------------------------

### Ranorex.Report.Setup Method API Reference

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Report_Setup_1

Comprehensive API documentation for the Ranorex.Report.Setup static method, detailing its purpose, namespace, assembly, and all parameters with their types and descriptions.

```APIDOC
Ranorex.Report.Setup Method:
  Description: Sets up the reporting environment compatible with Ranorex version 2.X.
  Namespace: Ranorex
  Assembly: Ranorex.Core (Version: 12.4.0+git.30b63b20)
  Signature (C#): public static void Setup(ReportLevel minLevel, string xmlReportFileName, bool logToConsole, bool appendExisting)
  Signature (VB): Public Shared Sub Setup (minLevel As ReportLevel, xmlReportFileName As String, logToConsole As Boolean, appendExisting As Boolean)
  Parameters:
    minLevel:
      Type: RanorexReportLevel
      Description: The minimum ReportLevel for messages that are to be written to the report.
    xmlReportFileName:
      Type: SystemString
      Description: Name of the XML report file, or null if XML logging should be disabled.
    logToConsole:
      Type: SystemBoolean
      Description: if set to true, logging to console is enabled.
    appendExisting:
      Type: SystemBoolean
      Description: if set to true, append to existing XML file instead of overwriting it.
```

--------------------------------

### Get Ranorex CompressedImage Guid Property (VB.NET)

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_CompressedImage_Guid

Illustrates the VB.NET syntax for retrieving the read-only `Guid` property from the `Ranorex.CompressedImage` class. This property provides a unique string identifier for the image.

```VB
Public ReadOnly Property Guid As String
	Get
```

--------------------------------

### Get Ranorex CompressedImage Guid Property (C#)

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_CompressedImage_Guid

Demonstrates the C# syntax for accessing the read-only `Guid` property of the `Ranorex.CompressedImage` class. This property returns a unique string identifier for the image.

```C#
public string Guid { get; }
```

--------------------------------

### Ranorex Adapter.TouchStart Method API Reference

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Overload_Ranorex_Adapter_TouchStart

Comprehensive API documentation for the `Ranorex.Adapter.TouchStart` method, detailing its various overloads, their parameters, and their specific purposes. This reference is crucial for understanding how to programmatically initiate touch events on UI elements within Ranorex automation scripts.

```APIDOC
Ranorex.Adapter Class

Method: TouchStart
  Description: Initiates a touch action on the adapter. Supports single and multi-touch operations.

  Overloads:
    1. TouchStart(Location location)
       Description: Performs a touch start action at a specified location.

    2. TouchStart(Double x, Double y)
       Description: Begins a multi-touch operation at given coordinates. Useful for composing complex gestures.
       Example:
         adapter.TouchStart(Location.Left);
         adapter.TouchEnd(Location.Right);

    3. TouchStart(Int32 fingerId, Location location)
       Description: Performs a touch start action for a specific finger ID at a location.

    4. TouchStart(Int32 fingerId, Int32 x, Int32 y)
       Description: Begins a multi-touch operation for a specific finger ID at given coordinates. Useful for composing complex gestures.
       Example:
         adapter.TouchStart(Location.Left);
         adapter.TouchEnd(Location.Right);
```

--------------------------------

### Ranorex Adapter.TouchStart Method Overloads and Multi-Touch Example

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/T_Ranorex_CefWebDocumentDebug

Documents the various overloads of the `TouchStart` method available on the Ranorex `Adapter` class, which initiates a touch operation. This method is crucial for composing multi-touch gestures. Includes a C# example demonstrating a swipe gesture.

```APIDOC
Ranorex.Adapter.TouchStart Method Overloads:

TouchStart(Location location)
  Description: Performs a touch start action on the adapter.
  Inherited from: Ranorex.Adapter

TouchStart(Double x, Double y)
  Description: Begins a multi touch operation on the adapter. Multi touch operations can be used to compose more complex touch gestures. E.g. a swipe from left to right could be composed in the following way:
  Notes: Useful multitouch operations always have the form * 1 TouchStart * 0-N TouchMove * 1 TouchEnd
  Inherited from: Ranorex.Adapter

TouchStart(Int32 index, Location location)
  Description: Performs a touch start action on the adapter.
  Inherited from: Ranorex.Adapter

TouchStart(Int32 x, Int32 y)
  Description: Begins a multi touch operation on the adapter. Multi touch operations can be used to compose more complex touch gestures. E.g. a swipe from left to right could be composed in the following way:
  Notes: Useful multitouch operations always have the form * 1 TouchStart * 0-N TouchMove * 1 TouchEnd
  Inherited from: Ranorex.Adapter
```

```C#
adapter.TouchStart(Location.Left);
adapter.TouchEnd(Location.Right);
```

--------------------------------

### Ranorex.Adapter.TouchStart Method API Reference

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/T_Ranorex_QtElement

API documentation for the `TouchStart` method of the `Ranorex.Adapter` class, used to begin multi-touch operations. This method is inherited from the `Adapter` class.

```APIDOC
Ranorex.Adapter.TouchStart(Int32, Int32)
  Description: Begins a multi touch operation on the adapter. Multi touch operations can be used to compose more complex touch gestures. E.g. a swipe from left to right could be composed in the following way: adapter.TouchStart(Location.Left); adapter.TouchEnd(Location.Right); Useful multitouch operations always have the form * 1 TouchStart * 0-N TouchMove * 1 TouchEnd
  Inherited from: Adapter
```

--------------------------------

### Get Ranorex.Report.CustomCategoryStyles Property Syntax

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_Report_CustomCategoryStyles

Code examples demonstrating how to access the static `CustomCategoryStyles` property in Ranorex, which returns a dictionary of custom CSS styles for report categories. Examples are provided for C# and VB.NET.

```C#
public static Dictionary<string, string> CustomCategoryStyles { get; }
```

```VB.NET
Public Shared ReadOnly Property CustomCategoryStyles As Dictionary(Of String, String)
	Get
```

--------------------------------

### Get and Set Ranorex BlockQuoteTag Title Property

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_BlockQuoteTag_Title

Code examples demonstrating how to get and set the 'Title' property of the Ranorex BlockQuoteTag class in both C# and VB.NET. This property allows programmatic access to the HTML element's title attribute.

```C#
public virtual string Title { get; set; }
```

```VB
Public Overridable Property Title As String
	Get
	Set
```

--------------------------------

### Ranorex SourceTag.Sizes Property Code Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_SourceTag_Sizes

Code examples demonstrating how to get and set the 'Sizes' property of the Ranorex SourceTag class in different programming languages. This property corresponds to the 'sizes' attribute of an HTML <source> element.

```C#
public virtual string Sizes { get; set; }
```

```VB
Public Overridable Property Sizes As String
	Get
	Set
```

--------------------------------

### API Reference for Ranorex.Core.Reporting.TestReport.Setup Method

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Core_Reporting_TestReport_Setup_2

Detailed API specification for the `Setup` method, outlining its parameters, their types, and descriptions for configuring the Ranorex reporting environment.

```APIDOC
Method: TestReport.Setup(ReportLevel minLevel, string fileName, bool logToConsole, bool enableTracingScreenshots, Duration writeInterval, string customReportFileLocation)
Description: Sets up the reporting environment.
Namespace: Ranorex.Core.Reporting
Assembly: Ranorex.Core (in Ranorex.Core.dll) Version: 12.4.0+git.30b63b20

Parameters:
  minLevel: Type: RanorexReportLevel
    The minimum ReportLevel for messages that are to be written to the report.
  fileName: Type: SystemString
    Name of the XML log file, or null if XML logging should be disabled.
  logToConsole: Type: SystemBoolean
    If set to true, logging to console is enabled.
  enableTracingScreenshots: Type: SystemBoolean
    Determines whether screenshots should be made for every step. This provides a number of diagnostic screenshots in case of an error.
  writeInterval: Type: RanorexDuration
    The time interval for the current report to be saved to the target file.
  customReportFileLocation: Type: SystemString
    Folder containing custom report files.
```

--------------------------------

### Ranorex InputTag.Type Property Syntax Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_InputTag_Type

Code examples demonstrating the syntax for accessing and modifying the 'Type' property of the Ranorex InputTag class in both C# and VB.NET. This property is virtual and supports both get and set operations.

```C#
public virtual string Type { get; set; }
```

```VB
Public Overridable Property Type As String
	Get
	Set
```

--------------------------------

### C# Ranorex Adapter.TouchStart Method Signature

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Adapter_TouchStart

Demonstrates the C# syntax for the TouchStart method of the Ranorex.Adapter class, which initiates a touch action at a specified location.

```C#
public void TouchStart(
	Location location
)
```

--------------------------------

### Ranorex ColTag.Title Property Syntax Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_ColTag_Title

Code examples demonstrating the syntax for accessing and modifying the 'Title' property of the Ranorex ColTag class in both C# and VB.NET. This property allows both getting and setting its string value.

```C#
public virtual string Title { get; set; }
```

```VB
Public Overridable Property Title As String
	Get
	Set
```

--------------------------------

### Ranorex Adapter TouchStart Method

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_WebDocument

API documentation for the `TouchStart` method within the Ranorex `Adapter` class. This method performs a touch start action on the adapter.

```APIDOC
TouchStart(Location)
  Performs a touch start action on the adapter. (Inherited from Adapter.)
```

--------------------------------

### Get or Set AppletTag Align Property in Ranorex (C#, VB.NET)

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_AppletTag_Align

Code examples demonstrating how to programmatically get and set the 'Align' property of the Ranorex AppletTag object, which corresponds to the HTML applet's align attribute.

```C#
public virtual string Align { get; set; }
```

```VB.NET
Public Overridable Property Align As String
	Get
	Set
```

--------------------------------

### Ranorex.Core.Reporting.TestReport.Setup Method Parameter Details

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Core_Reporting_TestReport_Setup

Detailed documentation for the parameters of the `TestReport.Setup` method, including their types and descriptions. This method configures the Ranorex reporting environment.

```APIDOC
minLevel:
  Type: RanorexReportLevel
  Description: The minimum ReportLevel for messages that are to be written to the report.

fileName:
  Type: System.String
  Description: Name of the XML log file, or null if XML logging should be disabled.

logToConsole:
  Type: System.Boolean
  Description: If set to true, logging to console is enabled.
```

--------------------------------

### Ranorex TrackTag.Kind Property Syntax Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_TrackTag_Kind

Code examples demonstrating the syntax for defining or accessing the 'Kind' property of the Ranorex TrackTag class in C# and VB. This property is virtual/overridable and allows getting and setting a string value.

```C#
public virtual string Kind { get; set; }
```

```VB
Public Overridable Property Kind As String
	Get
	Set
```

--------------------------------

### Ranorex.Adapter.TouchStart(Location) Method API Reference

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Adapter_TouchStart

Detailed API documentation for the TouchStart method of the Ranorex.Adapter class, including its parameters and their types, namespace, and assembly information.

```APIDOC
Ranorex.Adapter.TouchStart Method:
  Description: Performs a touch start action on the adapter.
  Namespace: Ranorex
  Assembly: Ranorex.Core (in Ranorex.Core.dll) Version: 12.4.0+git.30b63b20
  Signature:
    public void TouchStart(Location location) (C#)
    Public Sub TouchStart (location As Location) (VB.NET)
  Parameters:
    location:
      Type: Ranorex.Location
      Description: The location to touch at.
```

--------------------------------

### Ranorex KbdTag.Title Property Syntax Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_KbdTag_Title

Code examples demonstrating the syntax for declaring the 'Title' property in C# and VB.NET within the Ranorex framework. This property allows getting and setting the 'title' attribute of a KbdTag element.

```C#
public virtual string Title { get; set; }
```

```VB.NET
Public Overridable Property Title As String
	Get
	Set
```

--------------------------------

### API Documentation for TouchStart Method on Ranorex Adapter

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_BTag

The `TouchStart` method performs a touch start action on a Ranorex adapter.

```APIDOC
TouchStart(Location location)
  location: The target location for the touch start.
  Description: Performs a touch start action on the adapter.
```

--------------------------------

### Get Ranorex RepoGenBaseFolder.FolderElementValid Property Code Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_Core_Repository_RepoGenBaseFolder_FolderElementValid

Code examples demonstrating the syntax for accessing the read-only FolderElementValid property, which indicates whether the cached folder element within a Ranorex repository's base folder is still valid.

```C#
protected bool FolderElementValid { get; }
```

```VB
Protected ReadOnly Property FolderElementValid As Boolean
	Get
```

--------------------------------

### Ranorex.Core.Reporting.TestReport.BeginTestSuite Method Syntax Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Core_Reporting_TestReport_BeginTestSuite_1

Provides syntax examples for the BeginTestSuite method in both C# and VB.NET, demonstrating how to call the method with its required parameters to begin a new test suite activity.

```C#
public static void BeginTestSuite(
	string testSuiteName,
	string runLabel
)
```

```VB
Public Shared Sub BeginTestSuite (
	testSuiteName As String,
	runLabel As String
)
```

--------------------------------

### Ranorex AudioTag.Loop Property Syntax Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_AudioTag_Loop

Code examples demonstrating the syntax for declaring and accessing the 'Loop' property of the Ranorex AudioTag class in both C# and VB. This property allows getting and setting the loop attribute of an audio element.

```C#
public virtual string Loop { get; set; }
```

```VB
Public Overridable Property Loop As String
	Get
	Set
```

--------------------------------

### Ranorex Adapter: TouchStart Method (Simple Overloads)

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/T_Ranorex_WordApplication

Documents the `TouchStart` method overloads on the Ranorex Adapter that perform a basic touch start action.

```APIDOC
TouchStart(Location)
  Description: Performs a touch start action on the adapter.
```

```APIDOC
TouchStart(Int32, Location)
  Description: Performs a touch start action on the adapter.
```

--------------------------------

### Ranorex Adapter.TouchStart Method

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_SampTag

Documents the TouchStart method on the Ranorex Adapter, which performs a touch start action.

```APIDOC
TouchStart:
  TouchStart(location: Location)
    location: The starting location for the touch.
  Description: Performs a touch start action on the adapter.
  Inherited From: Adapter
```

--------------------------------

### Ranorex.Adapter.TouchStart Method Overloads

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_OutputTag

Documentation for the `TouchStart` method of the `Ranorex.Adapter` class, which initiates a multi-touch operation or a single touch start action. This method is inherited from `Adapter`.

```APIDOC
Ranorex.Adapter.TouchStart(Double x, Double y)
  Description: Begins a multi touch operation on the adapter. Multi touch operations can be used to compose more complex touch gestures.
  Inherited from: Adapter

Ranorex.Adapter.TouchStart(Int32 x, Location location)
  Description: Performs a touch start action on the adapter.
  Inherited from: Adapter

Ranorex.Adapter.TouchStart(Int32 x, Int32 y)
  Description: Begins a multi touch operation on the adapter. Multi touch operations can be used to compose more complex touch gestures.
  Inherited from: Adapter
```

--------------------------------

### Ranorex Adapter TouchStart Method

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_KeyGenTag

API documentation for the TouchStart method, which performs a touch start action on a Ranorex adapter at a specified location.

```APIDOC
TouchStart(Location location)
  Description: Performs a touch start action on the adapter.
  Parameters:
    location: The target location for the touch action.
```

--------------------------------

### FetchStartableApps

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/T_Ranorex_MobileDevice

Gets a list of application identifiers that can be used with Host.RunMobileApp to start an app on the device from within the Ranorex system.

```APIDOC
FetchStartableApps(): Gets a list of application identifiers that can be used with Host.RunMobileApp to start an app on the device from within the Ranorex system.
```

--------------------------------

### Ranorex.Report.SetupDefault Method

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_Report

Initializes the Ranorex reporting environment with default settings, including 'Info' report level, XML logging, and console logging enabled. This provides a quick way to get reporting started.

```APIDOC
SetupDefault:
  Description: Sets up the reporting environment with Info, XML logging and console logging enabled.
  Signatures:
    - SetupDefault()
```

--------------------------------

### Ranorex Adapter.TouchStart Method Overloads (Basic)

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/T_Ranorex_WordDocument

Documents the basic overloads of the `TouchStart` method in the Ranorex `Adapter` class. These methods perform a simple touch start action on the adapter.

```APIDOC
Adapter.TouchStart(Location location)
  Parameters:
    location: Location
Adapter.TouchStart(Int32 index, Location location)
  Parameters:
    index: Int32
    location: Location
```

--------------------------------

### Get OraTextFieldLabelFlavorElement.IsClientRectangle Property

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_Plugin_Oracle_OraTextFieldLabelFlavorElement_IsClientRectangle

Code examples demonstrating how to access the read-only IsClientRectangle property of the OraTextFieldLabelFlavorElement class in C# and VB.NET.

```C#
public override bool IsClientRectangle { get; }
```

```VB.NET
Public Overrides ReadOnly Property IsClientRectangle As Boolean
	Get
```

--------------------------------

### Get Ranorex.Core.Element.FlavorElement Property

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_Core_Element_FlavorElement

Retrieves the FlavorElement associated with a Ranorex.Core.Element instance. This property is read-only and can return null, for example, when using static snapshots.

```C#
public FlavorElement FlavorElement { get; }
```

```VB
Public ReadOnly Property FlavorElement As FlavorElement
	Get
```

```APIDOC
Property: FlavorElement
  Access: Read-only (get)
  Type: Ranorex.Core.FlavorElement
  Implements: Ranorex.Core.IElementFlavorElement
```

--------------------------------

### Ranorex.Touch.TouchStart Method API Reference

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Touch_TouchStart_1

This section provides the detailed API specification for the `TouchStart` method, including its namespace, assembly information, and a comprehensive list of its parameters with their respective types and descriptions. It is a static method of the `Ranorex.Touch` class.

```APIDOC
Namespace: Ranorex
Assembly: Ranorex.Core (in Ranorex.Core.dll) Version: 12.4.0+git.30b63b20

Method: TouchStart
  Parameters:
    element:
      Type: Ranorex.CoreElement
      Description: The element to perform the Touch action on.
    pointer:
      Type: SystemInt32
      Description: The pointer identifier to use, with zero being the default pointer.
    location:
      Type: RanorexLocation
      Description: The location to touch at.
```

--------------------------------

### Ranorex Host.RunMobileApp Method Usage Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Host_RunMobileApp

Code examples demonstrating how to invoke the `RunMobileApp` method of the `Ranorex.Host` class in both C# and VB.NET. This method is used to programmatically start a mobile application on a specified device using its display name and unique application identifier.

```C#
public void RunMobileApp(
	string deviceDisplayName,
	string appName
)
```

```VB
Public Sub RunMobileApp (
	deviceDisplayName As String,
	appName As String
)
```

--------------------------------

### Ranorex PerfTracing.Setup Method API

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Core_Tracing_PerfTracing_Setup

The `PerfTracing.Setup` method is used to initialize and enable performance tracing in Ranorex. It requires a custom `ITraceWriter` implementation and a `PerfTracers` enumeration to specify which tracing components to activate.

```C#
public static void Setup(
	ITraceWriter customWriter,
	PerfTracers tracers
)
```

```VB
Public Shared Sub Setup (
	customWriter As ITraceWriter,
	tracers As PerfTracers
)
```

```APIDOC
Parameters:
  customWriter: Type: Ranorex.Core.TracingITraceWriter
    A custom trace writer implementing ITraceWriter.
  tracers: Type: Ranorex.Core.TracingPerfTracers
    The tracers to activate.
```

--------------------------------

### Ranorex LiTag.Type Property API and Code Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_LiTag_Type

Detailed API documentation and code examples for the Ranorex LiTag.Type property, which allows getting and setting the 'type' attribute of an HTML LiTag element. It is part of the Ranorex.Plugin.Web assembly and can throw a SetAttributeFailedException if setting the value fails.

```APIDOC
Property: Type
  Description: The 'type' attribute of the element.
  Namespace: Ranorex
  Assembly: Ranorex.Plugin.Web (in Ranorex.Plugin.Web.dll) Version: 12.4.0+git.30b63b20
  Property Value:
    Type: String
  Exceptions:
    SetAttributeFailedException: Thrown if setting the attribute value failed.
```

```C#
public virtual string Type { get; set; }
```

```VB.NET
Public Overridable Property Type As String
	Get
	Set
```

--------------------------------

### Ranorex.Report.Setup Method API Reference

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Report_Setup

Detailed API specification for the `Ranorex.Report.Setup` method, including parameter types, descriptions, and return type. This method is used to initialize the Ranorex reporting system.

```APIDOC
Ranorex.Report.Setup(minLevel, xmlReportFileName, logToConsole)

Parameters:
- minLevel:
    Type: RanorexReportLevel
    Description: The minimum ReportLevel for messages that are to be written to the report.
- xmlReportFileName:
    Type: System.String
    Description: Name of the XML report file, or null if XML logging should be disabled.
- logToConsole:
    Type: System.Boolean
    Description: If set to true, logging to console is enabled.

Return Type: void
```

--------------------------------

### Ranorex Adapter TouchStart Method

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_SupTag

Documentation for the 'TouchStart' method on the Ranorex Adapter class, which performs a touch start action.

```APIDOC
TouchStart(Location location)
  Description: Performs a touch start action on the adapter.
  Parameters:
    location: Ranorex.Core.Location - The target location for the touch start.
```

--------------------------------

### Get Valid Property in Ranorex WinFormsPosListBoxItemFlavorElement

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_Plugin_CustomControls_PosListBox_WinFormsPosListBoxItemFlavorElement_Valid

Code examples demonstrating how to access the read-only 'Valid' property of the WinFormsPosListBoxItemFlavorElement class in C# and VB.NET.

```C#
public override bool Valid { get; }
```

```VB
Public Overrides ReadOnly Property Valid As Boolean
	Get
```

--------------------------------

### Ranorex Adapter.TouchStart Method

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_MetaTag

Documentation for the `TouchStart` method within the Ranorex Adapter class. This method performs a touch start action on the adapter.

```APIDOC
TouchStart(location: Location)
  Description: Performs a touch start action on the adapter.
  Inherited from: Adapter
```

--------------------------------

### Get RequiredCapabilities Property Syntax

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_FeConvolveMatrixTag_RequiredCapabilities

Code examples demonstrating the syntax for accessing the `RequiredCapabilities` property, which is an overridden, read-only property returning an array of strings.

```C#
protected override string[] RequiredCapabilities { get; }
```

```VB
Protected Overrides ReadOnly Property RequiredCapabilities As String()
	Get
```

--------------------------------

### Get ZOrderPosition Property Syntax

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_ExcelShape_ZOrderPosition

Code examples demonstrating how to access the read-only ZOrderPosition property of the ExcelShape class in C# and VB.NET.

```C#
public virtual int ZOrderPosition { get; }
```

```VB
Public Overridable ReadOnly Property ZOrderPosition As Integer
	Get
```

--------------------------------

### API: Ranorex Adapter.TouchStart Method

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_ATag

Documents the `TouchStart` method within the Ranorex Adapter class, which performs a touch start action.

```APIDOC
Adapter.TouchStart:
  Description: Performs a touch start action on the adapter.
  Overloads:
    - Signature: TouchStart(Location location)
      Parameters:
        location: Location - The location where the touch starts.
```

--------------------------------

### Get Ranorex CompressedImage.Image Property

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_CompressedImage_Image

Code examples demonstrating how to access the read-only `Image` property of the `Ranorex.CompressedImage` class, which returns a `Bitmap` object.

```C#
public Bitmap Image { get; }
```

```VB
Public ReadOnly Property Image As Bitmap
	Get
```

--------------------------------

### API: Ranorex Adapter TouchStart Method

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_WebElement

Documentation for the `TouchStart` method of the Ranorex Adapter class, which initiates a touch action on the adapter.

```APIDOC
TouchStart(Location)
  Description: Performs a touch start action on the adapter.
  Inherited From: Adapter
```

--------------------------------

### Ranorex Adapter: TouchStart(Int32, Location) Method

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_TabPage

API documentation for the `TouchStart(Int32, Location)` method in Ranorex `Adapter` class. This method performs a touch start action on the adapter.

```APIDOC
TouchStart(Int32, Location)
  Performs a touch start action on the adapter. (Inherited from Adapter).
```

--------------------------------

### Get RanorexGroupObjectId Property Definition

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_WpfCoreGroupElement_RanorexGroupObjectId

This snippet shows the definition of the `RanorexGroupObjectId` property, which is a read-only `Guid` used to identify a `DependencyObjectGroup`. It is part of the `WpfCoreGroupElement` class.

```C#
public virtual Guid RanorexGroupObjectId { get; }
```

```VB
Public Overridable ReadOnly Property RanorexGroupObjectId As Guid
	Get
```

--------------------------------

### Ranorex.Touch.TouchStart Method API Reference (Element, Double, Double)

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/M_Ranorex_Touch_TouchStart

Detailed API documentation for the `TouchStart` method within the `Ranorex.Touch` class. This specific overload initiates a multi-touch operation on a given `Element` at precise `x` and `y` percentage coordinates. It includes syntax for C# and VB, along with parameter definitions.

```C#
public static void TouchStart(
	Element element,
	double x,
	double y
)
```

```VB
Public Shared Sub TouchStart (
	element As Element,
	x As Double,
	y As Double
)
```

```APIDOC
Parameters:
  element:
    Type: Ranorex.CoreElement
    Description: The element to perform the Touch action on.
  x:
    Type: SystemDouble
    Description: X-Coordinate to click within the element rectangle as percentage (1.0 = 100%). If the value is greater than 1.0 the click will be performed outside the element.
  y:
    Type: SystemDouble
    Description: Y-Coordinate to click within the element rectangle as percentage (1.0 = 100%). If the value is greater than 1.0 the click will be performed the element.
```

--------------------------------

### Ranorex Adapter TouchStart Method

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_DfnTag

Documents the `TouchStart` method of the Ranorex Adapter class. This method performs a touch start action on the adapter.

```APIDOC
TouchStart(Location location)
  Performs a touch start action on the adapter. (Inherited from Adapter.)
```

--------------------------------

### Get IPerfInterval.ElapsedMs Property Syntax

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_Core_Tracing_IPerfInterval_ElapsedMs

Code examples demonstrating the syntax for accessing the ElapsedMs property of the IPerfInterval interface in C# and VB.NET.

```C#
int ElapsedMs { get; }
```

```VB
ReadOnly Property ElapsedMs As Integer
	Get
```

--------------------------------

### Ranorex Adapter TouchStart Method

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_QtElement

Initiates a touch operation on the adapter. This method supports both single-point touch starts and multi-touch operations, which can be combined with `TouchMove` and `TouchEnd` for complex gestures.

```APIDOC
TouchStart(Location location)
  Performs a touch start action on the adapter. (Inherited from Adapter).
```

```APIDOC
TouchStart(Double x, Double y)
  Begins a multi touch operation on the adapter. Multi touch operations can be used to compose more complex touch gestures. E.g. a swipe from left to right could be composed in the following way:
  adapter.TouchStart(Location.Left);
  adapter.TouchEnd(Location.Right);
  Useful multitouch operations always have the form:
  * 1 TouchStart
  * 0-N TouchMove
  * 1 TouchEnd (Inherited from Adapter).
```

--------------------------------

### Accessing Ranorex.Core.Configuration.RecorderConfig.GeneratedCodeNamespace Property

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_Core_Configuration_RecorderConfig_GeneratedCodeNamespace

Code examples demonstrating how to get and set the GeneratedCodeNamespace property in both C# and VB.NET, which defines the namespace for Ranorex recorder-generated code.

```C#
public string GeneratedCodeNamespace { get; set; }
```

```VB
Public Property GeneratedCodeNamespace As String
	Get
	Set
```

--------------------------------

### Get/Set Ranorex ComboBox SelectedItemText Property

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/P_Ranorex_ComboBox_SelectedItemText

Code examples demonstrating how to get and set the `SelectedItemText` property of a `Ranorex.ComboBox` object in C# and VB.NET.

```C#
public virtual string SelectedItemText { get; set; }
```

```VB
Public Overridable Property SelectedItemText As String
	Get
	Set
```

--------------------------------

### Ranorex Adapter: TouchStartWithoutBoundsCheck Method Overloads and Multi-Touch Examples

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/T_Ranorex_VarTag

Documents the various overloads for the TouchStartWithoutBoundsCheck method on the Ranorex Adapter. This method performs a touch start action without reporting a warning if the location is outside the element, and can initiate multi-touch operations. Includes a C# example for a swipe gesture.

```APIDOC
TouchStartWithoutBoundsCheck(Location)
  Performs a touch start action on the adapter, without reporting a warning if the location is outside the element.
```

```APIDOC
TouchStartWithoutBoundsCheck(Double, Double)
  Begins a multi touch operation on the adapter, without reporting a warning if the location is outside the element. Multi touch operations can be used to compose more complex touch gestures. Useful multitouch operations always have the form:
  * 1 TouchStart
  * 0-N TouchMove
  * 1 TouchEnd
```

```C#
adapter.TouchStart(Location.Left);
adapter.TouchEnd(Location.Right);
```

```APIDOC
TouchStartWithoutBoundsCheck(Int32, Location)
  Performs a touch start action on the adapter, without reporting a warning if the location is outside the element.
```

--------------------------------

### Ranorex Adapter.TouchStart (Simple Action)

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_MenuItem

Documents overloads of the TouchStart method on the Ranorex Adapter class that perform a basic touch start action.

```APIDOC
TouchStart(Location location)
  Description: Performs a touch start action on the adapter.
  Inherited from: Adapter

TouchStart(Int32 fingerId, Location location)
  Description: Performs a touch start action on the adapter.
  Inherited from: Adapter
```

--------------------------------

### Ranorex Adapter TouchStart Method

Source: https://www.ranorex.com/Documentation/Ranorex/html/29kk6kf7-ac43-hj63-ft67-684h94367234.htm/html/Methods_T_Ranorex_IHtmlTag

Documents the `TouchStart` method of the Ranorex `Adapter` class, which performs a touch start action on the adapter.

```APIDOC
TouchStart Method (Inherited from Adapter):
  - TouchStart(Location)
```
Tokens:
Raw