Class FlavorPlugin

Namespace

Ranorex.Core

Assembly

Ranorex.Core.dll

Represents a plugin which provides new flavors and capabilities.

public abstract class FlavorPlugin : Plugin, IEquatable<Descriptor>, IComparable<Descriptor>

Inheritance

object

Descriptor

Plugin

FlavorPlugin

Implements

IEquatable<Descriptor>

IComparable<Descriptor>

Derived

FlexPlugin

JavaPlugin

MsaaPlugin

QtPlugin

RawTextPlugin

SapPlugin

UiaPlugin

WebPlugin

Win32Plugin

WinFormsCorePlugin

WinFormsPlugin

WpfPlugin

Inherited Members

Plugin.Url

Descriptor.CreateCaseInsensitiveIdentifier(string)

Descriptor.ToString()

Descriptor.Equals(Descriptor)

Descriptor.Equals(object)

Descriptor.GetHashCode()

Descriptor.CompareTo(Descriptor)

Descriptor.Name

Descriptor.DisplayName

Descriptor.Description

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Constructors

FlavorPlugin(string, string, string, IList<Capability>, IList<Flavor>, IList<LineageGlueRule>, IList<KeyValuePair<string, Type>>)

Constructs a flavor plugin.

protected FlavorPlugin(string name, string description, string url, IList<Capability> capabilites, IList<Flavor> flavors, IList<LineageGlueRule> glueRules, IList<KeyValuePair<string, Type>> adapterTypes)

Parameters

name string

The name of this plugin.

description string

A short description for this plugin.

url string

An optional URL for a website containing plugin information.

capabilites IList<Capability>

A list of capabilities that the plugin provides.

flavors IList<Flavor>

A list of flavors that the plugin provides.

glueRules IList<LineageGlueRule>

A list of glue rules that the plugin provides.

adapterTypes IList<KeyValuePair<string, Type>>

A list of adapter types that the plugin provides.

FlavorPlugin(string, string, string, IList<Capability>, IList<Flavor>, IList<LineageGlueRule>, IList<KeyValuePair<string, Type>>, IList<CustomConfigurationParam>)

Constructs a flavor plugin.

protected FlavorPlugin(string name, string description, string url, IList<Capability> capabilites, IList<Flavor> flavors, IList<LineageGlueRule> glueRules, IList<KeyValuePair<string, Type>> adapterTypes, IList<Configuration.CustomConfigurationParam> configurationParams)

Parameters

name string

The name of this plugin.

description string

A short description for this plugin.

url string

An optional URL for a website containing plugin information.

capabilites IList<Capability>

A list of capabilities that the plugin provides.

flavors IList<Flavor>

A list of flavors that the plugin provides.

glueRules IList<LineageGlueRule>

A list of glue rules that the plugin provides.

adapterTypes IList<KeyValuePair<string, Type>>

A list of adapter types that the plugin provides.

configurationParams IList<Configuration.CustomConfigurationParam>

A list of configuration parameters that the plugin provides.

Properties

AdapterTypes

The list of adapter types provided by the plugin.

public IList<KeyValuePair<string, Type>> AdapterTypes { get; }

Property Value

IList<KeyValuePair<string, Type>>

Remarks

This list maps capability names to types that represent adapters for the corresponding capability.

Capabilites

The list of capabilities provided by the plugin.

public IList<Capability> Capabilites { get; }

Property Value

IList<Capability>

ConfigurationParams

The list of configuration parameters provided by the plugin.

public IList<Configuration.CustomConfigurationParam> ConfigurationParams { get; }

Property Value

IList<Configuration.CustomConfigurationParam>

Flavors

The list of flavors provided by the plugin.

public IList<Flavor> Flavors { get; }

Property Value

IList<Flavor>

GlueRules

The list of glue rules provided by the plugin.

public IList<LineageGlueRule> GlueRules { get; }

Property Value

IList<LineageGlueRule>

PluginControls

Controls that the plugin requires to embed in the hosting application (Spy, Recorder, Wizard, Studio). It is not guaranteed to the plugin that these controls will always be visible in the UI, e.g. users could hide/disable them.

public virtual IList<IPluginControl> PluginControls { get; }

Property Value

IList<IPluginControl>

RequiredFlavorNames

The list of flavors required as a dependency by the plugin.

public IList<string> RequiredFlavorNames { get; }

Property Value

IList<string>

Methods

Initialize()

Initializes the plugin. This automatically registers all flavors, caps, cap handlers and rules with the ElementEngine.

public override void Initialize()