Table of Contents

Class TabPage

Namespace
Ranorex
Assembly
Ranorex.Core.dll

Represents a tab page in a tab page list.

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

Constructors

TabPage()

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

protected TabPage()

TabPage(Element)

Creates a new TabPage adapter instance.

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

Image

The icon of the tab page.

public virtual Image Image { get; }

Property Value

Image

Index

The index of the tab page in the tabpage list.

public virtual int Index { get; }

Property Value

int

RequiredCapabilities

Capabilities required by the adapter implementation.

protected override string[] RequiredCapabilities { get; }

Property Value

string[]

Selected

True if the tab page is currently active.

public virtual bool Selected { get; }

Property Value

bool

Title

The title of the tab page.

public virtual string Title { get; }

Property Value

string

Methods

FromElement(Element)

Converts an Element to an instance of this class.

public static TabPage FromElement(Element element)

Parameters

element Element

The element to convert.

Returns

TabPage

The TabPage.

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

Parameters

path string

The search path.

Returns

TabPage

The TabPage.

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.

Select()

Activates the tab page.

public virtual void Select()

Exceptions

ActionFailedException

Thrown if invoking the action failed.

Operators

implicit operator TabPage(Element)

Implicitly converts an Element to an instance of this class.

public static implicit operator TabPage(Element element)

Parameters

element Element

The element to convert.

Returns

TabPage

The TabPage.

Exceptions

ArgumentNullException

If element is null.

CapabilityNotSupportedException

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

implicit operator TabPage(string)

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

public static implicit operator TabPage(string path)

Parameters

path string

The search path.

Returns

TabPage

The TabPage.

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.