Table of Contents

Class Configuration.CustomConfigurationParam

Namespace
Ranorex.Core
Assembly
Ranorex.Core.dll

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

public class Configuration.CustomConfigurationParam : Configuration.ConfigurationParam
Inheritance
Configuration.CustomConfigurationParam
Inherited Members

Constructors

CustomConfigurationParam(CaseInsensitiveString, string, string, string, object)

Initializes a new instance of the Configuration.CustomConfigurationParam class.

public CustomConfigurationParam(CaseInsensitiveString name, string displayName, string category, string description, object defaultValue)

Parameters

name CaseInsensitiveString

The name of the parameter. Must not contain spaces or other characters that are not allowed in XML tags.

displayName string

The display name of the parameter.

category string

The category for the parameter.

description string

The description of the parameter.

defaultValue object

The default value of the parameter.

CustomConfigurationParam(CaseInsensitiveString, string, string, string, object, CheckValueHandler)

Initializes a new instance of the Configuration.CustomConfigurationParam class.

public CustomConfigurationParam(CaseInsensitiveString name, string displayName, string category, string description, object defaultValue, Configuration.ConfigurationParam.CheckValueHandler checkValueHandler)

Parameters

name CaseInsensitiveString

The name of the parameter. Must not contain spaces or other characters that are not allowed in XML tags.

displayName string

The display name of the parameter.

category string

The category for the parameter.

description string

The description of the parameter.

defaultValue object

The default value of the parameter.

checkValueHandler Configuration.ConfigurationParam.CheckValueHandler

A delegate that checks whether a value is valid for this parameter.

Properties

Category

Gets the category for this parameter.

public string Category { get; }

Property Value

string

Description

Gets the description of this parameter.

public string Description { get; }

Property Value

string

DisplayName

Gets the display name of this parameter.

public string DisplayName { get; }

Property Value

string

Visible

Defines if the parameter is displayed on the user interface or not.

public bool Visible { get; }

Property Value

bool

Methods

Clone()

Clones this instance.

public override Configuration.ConfigurationParam Clone()

Returns

Configuration.ConfigurationParam

A clone of the parameter instance.