Table of Contents

Class TitleBar

Namespace
Ranorex
Assembly
Ranorex.Core.dll

Represents the title bar of a form or dialog window.

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

Constructors

TitleBar()

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

protected TitleBar()

TitleBar(Element)

Creates a new TitleBar adapter instance.

public TitleBar(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[]

Text

The title bar text.

public virtual string Text { get; }

Property Value

string

Methods

FromElement(Element)

Converts an Element to an instance of this class.

public static TitleBar FromElement(Element element)

Parameters

element Element

The element to convert.

Returns

TitleBar

The TitleBar.

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

Parameters

path string

The search path.

Returns

TitleBar

The TitleBar.

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 TitleBar(Element)

Implicitly converts an Element to an instance of this class.

public static implicit operator TitleBar(Element element)

Parameters

element Element

The element to convert.

Returns

TitleBar

The TitleBar.

Exceptions

ArgumentNullException

If element is null.

CapabilityNotSupportedException

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

implicit operator TitleBar(string)

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

public static implicit operator TitleBar(string path)

Parameters

path string

The search path.

Returns

TitleBar

The TitleBar.

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.