Class Flavor

Namespace

Ranorex.Core

Assembly

Ranorex.Core.dll

Represents a flavor.

public abstract class Flavor : MarshalByRefObject

Inheritance

object

MarshalByRefObject

Flavor

Derived

FlexFlavor

JavaFlavor

MsaaFlavor

QtFlavor

QtWebFlavor

RawTextFlavor

SapFlavor

UiaFlavor

WebFlavor

Win32Flavor

WinFormsCoreFlavor

WinFormsFlavor

WpfFlavor

Inherited Members

MarshalByRefObject.MemberwiseClone(bool)

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.CreateObjRef(Type)

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

Flavor(string, string)

Creates a new flavor.

protected Flavor(string displayName, string description)

Parameters

displayName string

The display name of the flavor.

description string

A short description of the flavor.

Flavor(string, string, string)

Creates a new flavor.

protected Flavor(string displayName, string description, string baseFlavorName)

Parameters

displayName string

The display name of the flavor.

description string

A short description of the flavor.

baseFlavorName string

The name of the flavor the flavor derives from or null.

Properties

BaseFlavor

Gets the instance of the flavor this flavor derives from. (Or null if this is not the case).

public Flavor BaseFlavor { get; }

Property Value

Flavor

The base flavor.

BaseFlavorName

The name of the flavor this flavor derives from.

public string BaseFlavorName { get; }

Property Value

string

Description

The optional descritpion of the flavor.

public string Description { get; protected set; }

Property Value

string

DisplayName

The name of instance the descriptor refers to, with arbitrary casing.

public string DisplayName { get; }

Property Value

string

Enabled

Enables or disables the flavor.

public bool Enabled { get; set; }

Property Value

bool

Remarks

If the flavor is disabled, no glue rules for this flavor are executed.

GlueRules

The list of glue rules for the flavor.

public IList<LineageGlueRule> GlueRules { get; }

Property Value

IList<LineageGlueRule>

Name

The name of the flavor.

public string Name { get; }

Property Value

string

UidAttributeName

The name of the attribute for this flavor which acts as a unique identifier for an element or null if the flavor has no uid attribute.

public virtual string UidAttributeName { get; }

Property Value

string

UseDesktopImageCapture

Defines whether capturing screenshots from elements of this flavor should use the desktop capturing method.

public virtual bool UseDesktopImageCapture { get; }

Property Value

bool

Methods

InheritsFrom(string)

Test whether the current flavor inherits from a flavor with the given name.

public bool InheritsFrom(string flavorName)

Parameters

flavorName string

Name of the flavor.

Returns

bool

True if the current flavor derives from the flavor with name flavorName.

OnGlueRuleRegistered(GlueRuleRegisteredEventArgs)

Raises the GlueRuleRegistered event.

protected virtual void OnGlueRuleRegistered(GlueRuleRegisteredEventArgs args)

Parameters

args GlueRuleRegisteredEventArgs

The GlueRuleRegisteredEventArgs instance containing the event data.

ToString()

The name of the flavor.

public override string ToString()

Returns

string

Name string.

Events

GlueRuleRegistered

Occurs when a glue rule is registered.

public event GlueRuleRegisteredEventHandler GlueRuleRegistered

Event Type

GlueRuleRegisteredEventHandler

Remarks

This event usually occurs when a plugin is loaded.