Class Configuration.ConfigurationParam

Namespace

Ranorex.Core

Assembly

Ranorex.Core.dll

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

public class Configuration.ConfigurationParam

Inheritance

object

Configuration.ConfigurationParam

Derived

Configuration.CustomConfigurationParam

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Constructors

ConfigurationParam(CaseInsensitiveString, object, CheckValueHandler, bool)

Initializes a new instance of the Configuration.ConfigurationParam class.

public ConfigurationParam(CaseInsensitiveString name, object defaultValue, Configuration.ConfigurationParam.CheckValueHandler checkValueHandler, bool local)

Parameters

name CaseInsensitiveString

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

defaultValue object

The default value of the parameter.

checkValueHandler Configuration.ConfigurationParam.CheckValueHandler

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

local bool

Defines if the parameter should be exported or not. False means it will be in the solution settings.

ConfigurationParam(CaseInsensitiveString, object, bool)

Initializes a new instance of the Configuration.ConfigurationParam class.

public ConfigurationParam(CaseInsensitiveString name, object defaultValue, bool local)

Parameters

name CaseInsensitiveString

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

defaultValue object

The default value of the parameter.

local bool

Defines if the parameter should be exported or imported. False means it will be in the solution settings.

Properties

DefaultValue

Gets the parameter's default value.

public object DefaultValue { get; }

Property Value

object

The default value.

Dirty

Gets a value specifying if the Value has been changed since last loading/saving the parameter.

public bool Dirty { get; }

Property Value

bool

DirtyIfEqualValue

Gets or sets a value indicating whether the Dirty flag is set when setting the Value even if the old and the new values are equal.

public bool DirtyIfEqualValue { get; set; }

Property Value

bool

<code>true</code> if the <xref href="Ranorex.Core.Configuration.ConfigurationParam.Dirty" data-throw-if-not-resolved="false"></xref> flag is set

when setting the Value even if the old and the new values are equal; otherwise, false.

Local

Defines if the parameter should be exported or imported.

public bool Local { get; }

Property Value

bool

Name

Gets the parameter name.

public CaseInsensitiveString Name { get; }

Property Value

CaseInsensitiveString

The name.

Remarks

The name must not contain spaces or other characters that are not allowed in XML tags.

Type

Gets the parameter's type.

public Type Type { get; }

Property Value

Type

The type.

Value

Gets or sets the value.

public object Value { get; set; }

Property Value

object

The value.

Methods

Clone()

Clones this instance.

public virtual Configuration.ConfigurationParam Clone()

Returns

Configuration.ConfigurationParam

A clone of the parameter instance.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

trueif the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the hash function

public override int GetHashCode()

Returns

int

A hash code for the current object.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.