Table of Contents

Class UIAutomationScrollItem

Namespace
Ranorex
Assembly
Ranorex.Plugin.Uia.dll

Capability for the UIA ScrollItem pattern.

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

Constructors

UIAutomationScrollItem()

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

protected UIAutomationScrollItem()

UIAutomationScrollItem(Element)

Creates a new UIAutomationScrollItem adapter instance.

public UIAutomationScrollItem(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

RequiredCapabilities

Capabilities required by the adapter implementation.

protected override string[] RequiredCapabilities { get; }

Property Value

string[]

Methods

FromElement(Element)

Converts an Element to an instance of this class.

public static UIAutomationScrollItem FromElement(Element element)

Parameters

element Element

The element to convert.

Returns

UIAutomationScrollItem

The UIAutomationScrollItem.

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 UIAutomationScrollItem FromPath(string path)

Parameters

path string

The search path.

Returns

UIAutomationScrollItem

The UIAutomationScrollItem.

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.

ScrollIntoView()

Sends a request to the element to scroll into view.

[OriginalDisplayName("UIAutomationScrollItemScrollIntoView")]
public virtual void ScrollIntoView()

Exceptions

ActionFailedException

Thrown if invoking the action failed.

Operators

implicit operator UIAutomationScrollItem(Element)

Implicitly converts an Element to an instance of this class.

public static implicit operator UIAutomationScrollItem(Element element)

Parameters

element Element

The element to convert.

Returns

UIAutomationScrollItem

The UIAutomationScrollItem.

Exceptions

ArgumentNullException

If element is null.

CapabilityNotSupportedException

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

implicit operator UIAutomationScrollItem(string)

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

public static implicit operator UIAutomationScrollItem(string path)

Parameters

path string

The search path.

Returns

UIAutomationScrollItem

The UIAutomationScrollItem.

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.