Table of Contents

Class Column

Namespace
Ranorex
Assembly
Ranorex.Core.dll

Represents a table column.

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

Constructors

Column()

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

protected Column()

Column(Element)

Creates a new Column adapter instance.

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

Cells

Gets the cells contained in the column.

public IList<Cell> Cells { get; }

Property Value

IList<Cell>

The cells in the column.

Index

The index of the column in the table.

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 column is currently selected.

public virtual bool Selected { get; set; }

Property Value

bool

Exceptions

SetAttributeFailedException

Thrown if setting the attribute value failed.

Text

The title of the column in the table.

public virtual string Text { get; }

Property Value

string

Methods

FromElement(Element)

Converts an Element to an instance of this class.

public static Column FromElement(Element element)

Parameters

element Element

The element to convert.

Returns

Column

The Column.

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

Parameters

path string

The search path.

Returns

Column

The Column.

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

Selects the entire column.

public virtual void Select()

Exceptions

ActionFailedException

Thrown if invoking the action failed.

Operators

implicit operator Column(Element)

Implicitly converts an Element to an instance of this class.

public static implicit operator Column(Element element)

Parameters

element Element

The element to convert.

Returns

Column

The Column.

Exceptions

ArgumentNullException

If element is null.

CapabilityNotSupportedException

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

implicit operator Column(string)

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

public static implicit operator Column(string path)

Parameters

path string

The search path.

Returns

Column

The Column.

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.