Table of Contents

Class Accessible

Namespace
Ranorex
Assembly
Ranorex.Plugin.Msaa.dll

Capability of an MSAA accessible object.

public class Accessible : Adapter, IAdapter
Inheritance
Accessible
Implements
Inherited Members

Constructors

Accessible()

Creates a new Accessible adapter instance. This constructor is used internally by the Ranorex Core Framework for performance issues!

protected Accessible()

Accessible(Element)

Creates a new Accessible adapter instance.

public Accessible(Element element)

Parameters

element Element

The element to create the adapter for.

Exceptions

NullReferenceException

If element is null.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.

Properties

DefaultAction

The default action of the accessible object.

[OriginalDisplayName("AccessibleDefaultAction")]
public virtual string DefaultAction { get; }

Property Value

string

Description

The description of the accessible object.

[OriginalDisplayName("AccessibleDescription")]
public virtual string Description { get; }

Property Value

string

Help

The help string of the accessible object.

[OriginalDisplayName("AccessibleHelp")]
public virtual string Help { get; }

Property Value

string

HelpTopic

The filename and topic identifier of the associated WinHelp file for the accessible object.

[OriginalDisplayName("AccessibleHelpTopic")]
public virtual string HelpTopic { get; }

Property Value

string

KeyboardShortcut

The keyboard shortcut of the accessible object.

[OriginalDisplayName("AccessibleKeyboardShortcut")]
public virtual string KeyboardShortcut { get; }

Property Value

string

Name

The name of the accessible object.

[OriginalDisplayName("AccessibleName")]
public virtual string Name { get; set; }

Property Value

string

Exceptions

SetAttributeFailedException

Thrown if setting the attribute value failed.

RequiredCapabilities

Capabilities required by the adapter implementation.

protected override string[] RequiredCapabilities { get; }

Property Value

string[]

Role

The role of the accessible object.

[OriginalDisplayName("AccessibleRole")]
public virtual AccessibleRole Role { get; }

Property Value

AccessibleRole

State

The state of the accessible object.

[OriginalDisplayName("AccessibleState")]
public virtual AccessibleStates State { get; }

Property Value

AccessibleStates

Value

The value of the accessible object.

[OriginalDisplayName("AccessibleValue")]
public virtual string Value { get; set; }

Property Value

string

Exceptions

SetAttributeFailedException

Thrown if setting the attribute value failed.

Methods

DoDefaultAction()

Invokes the default action of the accessible object.

[OriginalDisplayName("AccessibleDoDefaultAction")]
public virtual void DoDefaultAction()

Exceptions

ActionFailedException

Thrown if invoking the action failed.

FromElement(Element)

Converts an Element to an instance of this class.

public static Accessible FromElement(Element element)

Parameters

element Element

The element to convert.

Returns

Accessible

The Accessible.

Exceptions

ArgumentNullException

If element is null.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.

FromPath(string)

Converts a string to an instance of this class by searching the root.

public static Accessible FromPath(string path)

Parameters

path string

The search path.

Returns

Accessible

The Accessible.

Remarks

The DefaultSearchTimeout is used to search for the specified path.

Exceptions

ArgumentNullException

If path is null.

RxPathException

If the specified path is not valid.

ElementNotFoundException

If no element is found.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.

Operators

implicit operator Accessible(Element)

Implicitly converts an Element to an instance of this class.

public static implicit operator Accessible(Element element)

Parameters

element Element

The element to convert.

Returns

Accessible

The Accessible.

Exceptions

ArgumentNullException

If element is null.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.

implicit operator Accessible(string)

Implicitly converts a string to an instance of this class by searching the root.

public static implicit operator Accessible(string path)

Parameters

path string

The search path.

Returns

Accessible

The Accessible.

Remarks

The DefaultSearchTimeout is used to search for the specified path.

Exceptions

ArgumentNullException

If path is null.

RxPathException

If the specified path is not valid.

ElementNotFoundException

If no element is found.

CapabilityNotSupportedException

If the element does not support the capabilities required by this adapter.