Class FxWebDocumentFlavorElement

Namespace

Ranorex.Plugin

Assembly

Ranorex.Plugin.Java.dll

public class FxWebDocumentFlavorElement : JavaBaseFlavorElement

Inheritance

object

MarshalByRefObject

FlavorElement

JavaBaseFlavorElement

FxWebDocumentFlavorElement

Inherited Members

JavaBaseFlavorElement.rootContainerFlavorElement

JavaBaseFlavorElement.containerFlavorElement

JavaBaseFlavorElement.HasClazz(string)

JavaBaseFlavorElement.GetDynamicDescriptors(out IList<AttributeDescriptor>, out IList<ActionDescriptor>)

JavaBaseFlavorElement.SetAttributeValue(Element, string, object)

JavaBaseFlavorElement.GetShortTypeName()

JavaBaseFlavorElement.JavaObject

JavaBaseFlavorElement.DontCache

FlavorElement.GetChildLineageFromUid(string, out UidFindResult)

FlavorElement.GetChildLineagesFromPath(RxPath, int, bool, out int)

FlavorElement.GetInitialValues()

FlavorElement.CanReplace(FlavorElement)

FlavorElement.IsEqual(FlavorElement)

FlavorElement.HitTest(Point)

FlavorElement.AssertArgumentTypes(Type[], object[])

FlavorElement.AssertArgumentTypes(Type[], object[], bool[])

FlavorElement.AssertArgumentType(Type, object)

FlavorElement.AssertArgumentType(Type, object, bool)

FlavorElement.Flavor

FlavorElement.FlavorName

FlavorElement.IsUidDomainRoot

FlavorElement.SupportsNativePathSearch

FlavorElement.EnsureVisibleBehavior

FlavorElement.MinPathAttributes

FlavorElement.EvaluateExpensiveAttributes

MarshalByRefObject.MemberwiseClone(bool)

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.CreateObjRef(Type)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

ElementRectangle

The client or screen rectangle of the flavor element depending on the value returned by IsClientRectangle.

public override Rectangle ElementRectangle { get; }

Property Value

Rectangle

Remarks

To be implemented by the deriving class.

Enabled

True if the element is enabled. If the element cannot be enabled or disabled, return true.

public override bool Enabled { get; }

Property Value

bool

Remarks

To be implemented by the deriving class.

ForceGeometricSearchAll

Determines if the ElementRectangle is expected to be outside the bounds of its parent rectangle, and might be invisible. Forces FindChildFromPointByRectangle() to switch to 'search all' behavior.

public override bool ForceGeometricSearchAll { get; }

Property Value

bool

Remarks

To be overridden by the deriving class. Returns false by default.

HasFocus

True if the element has the focus.

public override bool HasFocus { get; }

Property Value

bool

Remarks

To be implemented by the deriving class.

IsClientRectangle

Determines if the ElementRectangle property returns client or screen coordinates.

public override bool IsClientRectangle { get; }

Property Value

bool

Remarks

To be implemented by the deriving class.

Valid

True if the flavor element is still valid.

public override bool Valid { get; }

Property Value

bool

Remarks

To be implemented by the deriving class.

Visible

True if the element is visible.

public override bool Visible { get; }

Property Value

bool

Remarks

To be implemented by the deriving class.

Methods

EnsureVisible()

Ensures that the flavor element is visible.

public override bool EnsureVisible()

Returns

bool

True if the operation was successful.

Focus()

Focuses the flavor element, if possible.

public override void Focus()

GetAttributeValue(Element, string)

Needs to be implemented for attribute value read access.

public override object GetAttributeValue(Element element, string name)

Parameters

element Element

The element instance used.

name string

The name of the attribute (lowercased).

Returns

object

The attribute value.

GetChildLineageFromPoint(Point, out FindRefineMode)

Returns a list of flavor elements that is the lineage to the flavor element at the specified screen location.

public override LinkedList<FlavorElement> GetChildLineageFromPoint(Point screenLocation, out FindRefineMode refineMode)

Parameters

screenLocation Point

The screen location to search at.

refineMode FindRefineMode

Can be set to indicate that further searching is required.

Returns

LinkedList<FlavorElement>

The lineage to the flavor element at the specified point as a list.

Remarks

The first element in the returned list is the direct child of this flavor element, the k-th element is the parent of the (k+1)-th element, and the last element is the actual flavor element at the specified screen location. Consequently, an empty list is to be returned if this element is the best fitting element at the requested point.

Returns null if the specified screenLocation is not within this or one of its descendant elements.

GetElementCapabilities(Element, out Role, out string[], out string)

Supplies the role, a list of capabilities and a preferred capability names to the caller. This method called when building a new element from the flavor element.

public override void GetElementCapabilities(Element parent, out Role role, out string[] capabilities, out string preferredCap)

Parameters

parent Element

The parent element of the element to be constructed. (for reference only)

role Role

The role the element should have.

capabilities string[]

The list of capabilities the element should have.

preferredCap string

The preferred capability the element should have.

GetRuntimeTokenValues()

Gets the runtime token values. This must be implemented by the flavors.

protected override object[] GetRuntimeTokenValues()

Returns

object[]

A collection of objects representing a runtime token.

InvokeAction(Element, string, object[])

Needs to be implemented for element action invocation.

public override object InvokeAction(Element element, string name, object[] args)

Parameters

element Element

The element instance used.

name string

The name of the action (lowercased).

args object[]

A list of invocation parameters.

Returns

object

The invocation result. Can be null if the return type is void.