Table of Contents

Class Win32FlavorElement

Namespace
Ranorex.Plugin
Assembly
Ranorex.Plugin.Win32.dll
public class Win32FlavorElement : FlavorElement
Inheritance
Win32FlavorElement
Derived
Inherited Members

Constructors

Win32FlavorElement(IntPtr) 

public Win32FlavorElement(IntPtr handle)

Parameters

handle IntPtr

Win32FlavorElement(IntPtr, string) 

protected Win32FlavorElement(IntPtr handle, string flavorName)

Parameters

handle IntPtr
flavorName string

Properties

AutomationId 

public string AutomationId { get; }

Property Value

string

BackgroundColor 

public string BackgroundColor { get; set; }

Property Value

string

ClassName 

public string ClassName { get; }

Property Value

string

ControlName 

public string ControlName { get; }

Property Value

string

DontCache

Indicates that the element should not be cached. Defaults to false.

protected override bool DontCache { get; }

Property Value

bool

ElementClientRectangle 

public Rectangle ElementClientRectangle { get; }

Property Value

Rectangle

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.

Handle 

public virtual IntPtr Handle { get; protected set; }

Property Value

IntPtr

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.

ProcessId 

public int ProcessId { get; }

Property Value

int

ProcessName 

public string ProcessName { get; }

Property Value

string

Text 

public string Text { get; set; }

Property Value

string

TextColor 

public string TextColor { get; set; }

Property Value

string

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

CreateCapabilityList() 

protected string[] CreateCapabilityList()

Returns

string[]

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.

GetAutomationElement() 

public AutomationElement GetAutomationElement()

Returns

AutomationElement

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.

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

Gets the descriptors for the dynamic attributes and actions that the element supports.

public override void GetDynamicDescriptors(out IList<AttributeDescriptor> attributes, out IList<ActionDescriptor> actions)

Parameters

attributes IList<AttributeDescriptor>

The dynamic attributes that the element supports.

actions IList<ActionDescriptor>

The dynamic actions that the element supports.

Remarks

The default implementation returns empty lists for attributes and actions. Any overriding method should fill the returned lists.

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.

GetElementClientRectangle(IntPtr) 

public static Rectangle GetElementClientRectangle(IntPtr hwnd)

Parameters

hwnd IntPtr

Returns

Rectangle

GetElementRectangle(IntPtr) 

public static Rectangle GetElementRectangle(IntPtr hwnd)

Parameters

hwnd IntPtr

Returns

Rectangle

GetPropertyValue(int) 

public object GetPropertyValue(int propertyId)

Parameters

propertyId int

Returns

object

GetPropertyValue(AutomationProperty) 

public object GetPropertyValue(AutomationProperty property)

Parameters

property AutomationProperty

Returns

object

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.

NativeWindowGetAttributeValue(Element, string, out object) 

public bool NativeWindowGetAttributeValue(Element element, string name, out object value)

Parameters

element Element
name string
value object

Returns

bool

NativeWindowInvokeAction(Element, string, object[], out object) 

public bool NativeWindowInvokeAction(Element element, string name, object[] args, out object value)

Parameters

element Element
name string
args object[]
value object

Returns

bool

NativeWindowSetAttributeValue(Element, string, object) 

public bool NativeWindowSetAttributeValue(Element element, string name, object value)

Parameters

element Element
name string
value object

Returns

bool

SetAttributeValue(Element, string, object)

Needs to be implemented for attribute value write access.

public override void SetAttributeValue(Element element, string name, object value)

Parameters

element Element

The element instance used.

name string

The name of the attribute (lowercased).

value object

The attribute value to be set.