Class ActionDescriptor

Namespace

Ranorex.Core

Assembly

Ranorex.Core.dll

A descriptor for actions which are essentially methods.

public class ActionDescriptor : Descriptor, IEquatable<Descriptor>, IComparable<Descriptor>

Inheritance

object

Descriptor

ActionDescriptor

Implements

IEquatable<Descriptor>

IComparable<Descriptor>

Inherited Members

Descriptor.CreateCaseInsensitiveIdentifier(string)

Descriptor.ToString()

Descriptor.Equals(Descriptor)

Descriptor.Equals(object)

Descriptor.GetHashCode()

Descriptor.Name

Descriptor.DisplayName

Descriptor.Description

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Constructors

ActionDescriptor(string, string, Argument, IList<Argument>)

Creates a new action descriptor.

public ActionDescriptor(string name, string description, ActionDescriptor.Argument returns, IList<ActionDescriptor.Argument> arguments)

Parameters

name string

The name of the action. Should be CamelCased.

description string

A short description of the action, its parameters and what is supposed to do.

returns ActionDescriptor.Argument

The return value of the action. If nothing is returned, pass null here.

arguments IList<ActionDescriptor.Argument>

A list of key-value pairs describing the arguments for the action.

Properties

Arguments

Gets a list of key-value pairs describing the arguments of the action.

[TypeConverter(typeof(CollectionConverter))]
public IList<ActionDescriptor.Argument> Arguments { get; }

Property Value

IList<ActionDescriptor.Argument>

ProvideErrorMessage

Provides a custom representation of an error.

public Func<Exception, object[], string> ProvideErrorMessage { get; protected set; }

Property Value

Func<Exception, object[], string>

Returns

Gets the return value of this action. If this action does not return a value, the value is null.

public ActionDescriptor.Argument Returns { get; }

Property Value

ActionDescriptor.Argument

Methods

CompareTo(Descriptor)

Compares the current descriptor with another descriptor.

public override int CompareTo(Descriptor other)

Parameters

other Descriptor

A descriptor to compare with this descriptor.

Returns

int

A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings:

Value	Meaning
Less than zero	This object is less than the other parameter.
Zero	This object is equal to other.
Greater than zero	This object is greater than other.