Interface IDatagridComponent

Namespace

GroupeIsa.Neos.EndToEndTests.UI.Components

Assembly

GroupeIsa.Neos.EndToEndTests.UI.dll

Provides the functionalities of a datagrid component for automation.

[AbstractionComponent("datagrid")]
public interface IDatagridComponent : IAutomationComponent, IFocusableComponent, IDatagridReaderComponent

Inherited Members

IAutomationComponent.OwnerComponent

IAutomationComponent.IsVisible

IAutomationComponent.IsVisibleInViewPort

IAutomationComponent.Size

IAutomationComponent.WaitUntilVisible()

IAutomationComponent.WaitUntilHidden()

IAutomationComponent.ScrollIntoView()

IAutomationComponent.GetOwnerUIViewName()

IFocusableComponent.IsActiveElement

IFocusableComponent.Focus()

IFocusableComponent.SendKeys(string)

IFocusableComponent.SendKeys(params KeyboardKeys[])

IFocusableComponent.WaitUntilIsActiveElement()

IFocusableComponent.WaitUntilIsNotActiveElement()

IDatagridReaderComponent.GetCellText(int, int)

IDatagridReaderComponent.GetCellText(int, string)

IDatagridReaderComponent.GetCheckboxCellValue(int, int)

IDatagridReaderComponent.GetCheckboxCellValue(int, string)

IDatagridReaderComponent.ClickOnCell(string, string)

IDatagridReaderComponent.ClickOnCell(int)

IDatagridReaderComponent.WaitUntilLoaded()

Properties

BottomRowIndex

Gets the index of the bottom row.

int BottomRowIndex { get; }

Property Value

int

ColumnCaptions

Gets the column header captions sorted by position.

IEnumerable<string> ColumnCaptions { get; }

Property Value

IEnumerable<string>

CurrentRowIndex

Gets the current row index.

int CurrentRowIndex { get; }

Property Value

int

HasAddButton

Gets a value indicating whether the grid has no rows and the add button is displayed.

bool HasAddButton { get; }

Property Value

bool

HasRows

Gets a value indicating whether the datagrid has at least one row.

bool HasRows { get; }

Property Value

bool

HasSelectionColumn

Gets a value indicating whether the selection column exists.

bool HasSelectionColumn { get; }

Property Value

bool

IsLoaded

Gets a value indicating whether the datagrid is loaded.

bool IsLoaded { get; }

Property Value

bool

RowsCount

Gets the number of rows.

int RowsCount { get; }

Property Value

int

TopRowIndex

Gets the index of the top row.

int TopRowIndex { get; }

Property Value

int

VisibleRowsCount

Gets the number of visible rows.

int VisibleRowsCount { get; }

Property Value

int

Methods

AddColumnGrouping(int)

Adds column grouping.

void AddColumnGrouping(int colIndex)

Parameters

colIndex int

Column index (Starts at 0, the header selector cell and selection cell are excluded).

AddColumnGrouping(string)

Adds column grouping.

void AddColumnGrouping(string colName)

Parameters

colName string

Column name.

ClearAllColumnGrouping()

Clears all column groupings.

void ClearAllColumnGrouping()

ClickOnAddButton()

Clicks on the "Add" button.

bool ClickOnAddButton()

Returns

bool

A value indicating whether the action has been performed.

ClickOnCell(int, int)

Click on a cell.

bool ClickOnCell(int visibleRowIndex, int colIndex)

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colIndex int

Column index (Starts at 0, the header selector cell and selection cell are excluded).

Returns

bool

A value indicating whether the action has been performed.

Exceptions

AutomationException

Throws when the cell is not found.

ClickOnCell(int, string)

Click on a cell.

bool ClickOnCell(int visibleRowIndex, string colName)

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colName string

Column name.

Returns

bool

A value indicating whether the action has been performed.

Exceptions

AutomationException

Throws when the cell is not found.

ClickOnCheckboxCell(int, int)

Click on a checkbox cell.

bool ClickOnCheckboxCell(int visibleRowIndex, int colIndex)

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colIndex int

Column index (Starts at 0, the header selector cell and selection cell are excluded).

Returns

bool

A value indicating whether the action has been performed.

Exceptions

AutomationException

Throws when the cell is not found.

ClickOnCheckboxCell(int, string)

Click on a checkbox cell.

bool ClickOnCheckboxCell(int visibleRowIndex, string colName)

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colName string

Column name.

Returns

bool

A value indicating whether the action has been performed.

Exceptions

AutomationException

Throws when the cell is not found.

ClickOnHeaderCell(int)

Click on a header cell.

bool ClickOnHeaderCell(int colIndex)

Parameters

colIndex int

Column index (Starts at 0, the header selector cell and selection cell are excluded).

Returns

bool

A value indicating whether the action has been performed.

ClickOnHeaderCell(string)

Click on a header cell.

bool ClickOnHeaderCell(string colName)

Parameters

colName string

Column name.

Returns

bool

A value indicating whether the action has been performed.

ClickOnHeaderSelectionCell()

Click on the header selection cell.

bool ClickOnHeaderSelectionCell()

Returns

bool

A value indicating whether the action has been performed.

Exceptions

AutomationException

Throws when the datagrid has no selection cell.

ClickOnLinkCell(int, int)

Click on a link cell.

bool ClickOnLinkCell(int visibleRowIndex, int colIndex)

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colIndex int

Column index (Starts at 0, the header selector cell and selection cell are excluded).

Returns

bool

A value indicating whether the action has been performed.

Exceptions

AutomationException

Throws when the cell is not found.

ClickOnLinkCell(int, string)

Click on a link cell.

bool ClickOnLinkCell(int visibleRowIndex, string colName)

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colName string

Column name.

Returns

bool

A value indicating whether the action has been performed.

Exceptions

AutomationException

Throws when the cell is not found.

ClickOnSelectionCell(int)

Click on a row selection cell.

bool ClickOnSelectionCell(int visibleRowIndex)

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

Returns

bool

A value indicating whether the action has been performed.

Exceptions

AutomationException

Throws when the datagrid has no selection cell.

ClickOnStartSearchButton()

Clicks on the "Start search" button.

bool ClickOnStartSearchButton()

Returns

bool

A value indicating whether the action has been performed.

CollapseRow(int)

Collapses a row.

void CollapseRow(int visibleRowIndex)

Parameters

visibleRowIndex int

Index of visible row, the index of the top row is 0.

Exceptions

AutomationException

Throws when the row is not found.

CtrlClickOnCell(int, int)

Ctrl click on a cell.

bool CtrlClickOnCell(int visibleRowIndex, int colIndex)

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colIndex int

Column index (Starts at 0, the header selector cell and selection cell are excluded).

Returns

bool

A value indicating whether the action has been performed.

Exceptions

AutomationException

Throws when the cell is not found.

CtrlClickOnCell(int, string)

Ctrl click on a cell.

bool CtrlClickOnCell(int visibleRowIndex, string colName)

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colName string

Column name.

Returns

bool

A value indicating whether the action has been performed.

Exceptions

AutomationException

Throws when the cell is not found.

DoubleClickOnRow(int)

Double click on row.

void DoubleClickOnRow(int visibleRowIndex)

Parameters

visibleRowIndex int

Index of visible row, the index of the top row is 0.

Exceptions

AutomationException

Throws when the row is not found.

ExpandRow(int)

Expands a row.

void ExpandRow(int visibleRowIndex)

Parameters

visibleRowIndex int

Index of visible row, the index of the top row is 0.

Exceptions

AutomationException

Throws when the row is not found.

FindDetailButton(int)

Finds the detail button of the row if exist.

IButtonComponent? FindDetailButton(int visibleRowIndex)

Parameters

visibleRowIndex int

Index of visible row, the index of the top row is 0.

Returns

IButtonComponent

The button component or null.

FindRowIndex(string, string, bool)

Finds the index of the first visible row that meets the specified conditions.

int? FindRowIndex(string colName, string displayText, bool onlyInVisibleRows = true)

Parameters

colName string

The name of the bounded property.

displayText string

The text displayed in the cell of the specified column.

onlyInVisibleRows bool

A value indicating whether only the visible rows of the grid are searched or whether vertical scrolling is performed to search all rows.

Returns

int?

The index of the row or Null if no visible row is found.

GetActiveCell()

Gets the active cell.

IDatagridCellComponent? GetActiveCell()

Returns

IDatagridCellComponent

The active cell or null if datagrid has no active cell.

GetCell(int, int)

Gets a cell of the datagrid.

IContentComponent GetCell(int visibleRowIndex, int colIndex)

Parameters

visibleRowIndex int

Row index in the collection of visible rows. (Starts at 0).

colIndex int

Column index (Starts at 0, the header selector cell and selection cell are excluded).

Returns

IContentComponent

The cell of the datagrid.

GetColumnCaption(int)

Gets the column header caption accordings to the column index.

string GetColumnCaption(int colIndex)

Parameters

colIndex int

The index of the column.

Returns

string

The column header caption.

Exceptions

AutomationException

Throws when the column is not found.

GetColumnCaption(string)

Gets the column header caption accordings to the name of the bounded property.

string GetColumnCaption(string colName)

Parameters

colName string

The name of the bounded property.

Returns

string

The column header caption.

Exceptions

AutomationException

Throws when the column is not found.

GetColumnGroupSummary(int, int)

Gets the column group summary.

IDatagridSummaryCell GetColumnGroupSummary(int visibleRowIndex, int colIndex)

Parameters

visibleRowIndex int

Index of visible row, the index of the top row is 0.

colIndex int

Column index (Starts at 0, the header selector cell and selection cell are excluded).

Returns

IDatagridSummaryCell

The column total summary value.

GetColumnGroupSummary(int, string)

Gets the column group summary.

IDatagridSummaryCell GetColumnGroupSummary(int visibleRowIndex, string colName)

Parameters

visibleRowIndex int

Index of visible row, the index of the top row is 0.

colName string

Column name.

Returns

IDatagridSummaryCell

The column group summary.

GetColumnSort(int)

Gets the column sort.

DatagridComponentColumnSort GetColumnSort(int colIndex)

Parameters

colIndex int

Column index (Starts at 0, the header selector cell and selection cell are excluded).

Returns

DatagridComponentColumnSort

The column sort.

GetColumnSort(string)

Gets the column sort.

DatagridComponentColumnSort GetColumnSort(string colName)

Parameters

colName string

Column name.

Returns

DatagridComponentColumnSort

The column sort.

GetColumnTotalSummary(int)

Gets the column total summary.

IDatagridSummaryCell GetColumnTotalSummary(int colIndex)

Parameters

colIndex int

Column index (Starts at 0, the header selector cell and selection cell are excluded).

Returns

IDatagridSummaryCell

The column total summary type.

GetColumnTotalSummary(string)

Gets the column total summary.

IDatagridSummaryCell GetColumnTotalSummary(string colName)

Parameters

colName string

Column name.

Returns

IDatagridSummaryCell

The column total summary type.

GetDetailButton(int)

Gets the detail button of the row.

IButtonComponent? GetDetailButton(int visibleRowIndex)

Parameters

visibleRowIndex int

Index of visible row, the index of the top row is 0.

Returns

IButtonComponent

The button component or null.

GetFileCellLink(int, int)

Gets the file cell link.

string? GetFileCellLink(int visibleRowIndex, int colIndex)

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colIndex int

Column index (Starts at 0, the header selector cell and selection cell are excluded).

Returns

string

The file cell link.

GetFileCellLink(int, string)

Gets the file cell link.

string? GetFileCellLink(int visibleRowIndex, string colName)

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colName string

Column name.

Returns

string

The file cell link.

GetImageCellLink(int, int)

Gets the image cell link.

string? GetImageCellLink(int visibleRowIndex, int colIndex)

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colIndex int

Column index (Starts at 0, the header selector cell and selection cell are excluded).

Returns

string

The image cell link.

GetImageCellLink(int, string)

Gets the image cell link.

string? GetImageCellLink(int visibleRowIndex, string colName)

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colName string

Column name.

Returns

string

The image cell link.

GetImageCellSource(int, int)

Gets the image cell source.

string? GetImageCellSource(int visibleRowIndex, int colIndex)

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colIndex int

Column index (Starts at 0, the header selector cell and selection cell are excluded).

Returns

string

The image cell source.

Remarks

The source is an url with http(s): scheme or blob: scheme.

GetImageCellSource(int, string)

Gets the image cell source.

string? GetImageCellSource(int visibleRowIndex, string colName)

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colName string

Column name.

Returns

string

The image cell source.

Remarks

The source is an url with http(s): scheme or blob: scheme.

GetIndexOfAddRow()

Gets the index of the add row where the user clicks to add a new row.

int GetIndexOfAddRow()

Returns

int

The index of the add row.

Exceptions

AutomationException

Throws when there is no add row.

GetIndexOfVisibleRow(int)

Gets the index of the visible row.

int GetIndexOfVisibleRow(int visibleRowIndex)

Parameters

visibleRowIndex int

Index of visible row, the index of the top row is 0.

Returns

int

Index of the row in relation to all the rows of the grid including the non visible rows.

GetVisibleIndexOfAddRow()

Gets the visible index of the add row where the user clicks to add a new row.

int? GetVisibleIndexOfAddRow()

Returns

int?

The index of the add row or null if the add row is not visible.

Exceptions

AutomationException

Throws when there is no add row.

GetVisibleIndexOfRow(int)

Gets the visible index of a row.

int? GetVisibleIndexOfRow(int rowIndex)

Parameters

rowIndex int

The index of the row in relation to all lines.

Returns

int?

The index of the row or null if row is not visible.

HasChanges(int)

Gets a value indicating whether the data displayed by the row has changes.

bool HasChanges(int visibleRowIndex)

Parameters

visibleRowIndex int

Index of visible row, the index of the top row is 0..

Returns

bool

A value indicating whether the data displayed by the row has changes.

HasErrors(int)

Gets a value indicating whether the row has errors.

bool HasErrors(int visibleRowIndex)

Parameters

visibleRowIndex int

Index of visible row, the index of the top row is 0..

Returns

bool

The value indicating whether the row has errors.

HasWarnings(int)

Gets a value indicating whether the row has warnings.

bool HasWarnings(int visibleRowIndex)

Parameters

visibleRowIndex int

Index of visible row, the index of the top row is 0..

Returns

bool

The value indicating whether the row has warnings.

HideColumns(params string[])

Hides columns.

void HideColumns(params string[] colNames)

Parameters

colNames string[]

Column names.

IsCurrentRow(int)

Gets a value indicating whether the row is the current row.

bool IsCurrentRow(int visibleRowIndex)

Parameters

visibleRowIndex int

Index of visible row, the index of the top row is 0..

Returns

bool

The value indicating whether the row is the current row.

Exceptions

AutomationException

Throws when the row is not found.

IsGroupedColumn(int)

Gets a value indicating whether the column is grouped.

bool IsGroupedColumn(int colIndex)

Parameters

colIndex int

Column index (Starts at 0, the header selector cell and selection cell are excluded).

Returns

bool

A value indicating whether the column is grouped.

IsGroupedColumn(string)

Gets a value indicating whether the column is grouped.

bool IsGroupedColumn(string colName)

Parameters

colName string

Column name.

Returns

bool

A value indicating whether the column is grouped.

IsRowExpanded(int)

Gets a value indicating whether the row is expanded.

bool IsRowExpanded(int visibleRowIndex)

Parameters

visibleRowIndex int

Index of visible row, the index of the top row is 0.

Returns

bool

A value indicating whether the row is expanded.

Exceptions

AutomationException

Throws when the row is not found.

IsRowSelected(int)

Gets a value indicating whether the row is selected.

bool IsRowSelected(int visibleRowIndex)

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

Returns

bool

A value indicating whether the row is selected.

MoveToRow(int)

Moves the mouse on the center of a specified row.

void MoveToRow(int visibleRowIndex)

Parameters

visibleRowIndex int

Index of visible row, the index of the top row is 0.

Exceptions

AutomationException

Throws when the row is not found.

RemoveColumnGrouping(int)

Removes column grouping.

void RemoveColumnGrouping(int colIndex)

Parameters

colIndex int

Column index (Starts at 0, the header selector cell and selection cell are excluded).

RemoveColumnGrouping(string)

Removes column grouping.

void RemoveColumnGrouping(string colName)

Parameters

colName string

Column name.

ScrollToCell(int, int?)

Scrolls the grid to bring a specific cell into view.

Row and column indexes are absolute, they do not depend on datagrid scrolling.

void ScrollToCell(int rowIndex, int? colIndex = null)

Parameters

rowIndex int

Index of the row to scroll into view.

colIndex int?

Index of the column to scroll into view.

ScrollToCell(int, string)

Scrolls the grid to bring a specific cell into view.

Row index are absolute, it do not depend on datagrid scrolling.

void ScrollToCell(int rowIndex, string colName)

Parameters

rowIndex int

Index of the row to scroll into view.

colName string

The column name (property name) to scroll into view.

SelectCellInputByColumnCaption<TInputComponent>(int, string)

Selects the input component of a cell using by the column header caption.

TInputComponent SelectCellInputByColumnCaption<TInputComponent>(int visibleRowIndex, string colCaption) where TInputComponent : IInputComponent

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colCaption string

Column caption.

Returns

TInputComponent

The input component of the cell.

Type Parameters

TInputComponent

Type of the input component.

Exceptions

AutomationException

Throws when the cell is not found.

SelectCellInput<TInputComponent>(int, int)

Selects the input component of a cell.

Warning : Do not use on native checkbox cell, use GetCheckboxCellValue(int, int) instead.

TInputComponent SelectCellInput<TInputComponent>(int visibleRowIndex, int colIndex) where TInputComponent : IInputComponent

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colIndex int

Column index (Starts at 0, the header selector cell and selection cell are excluded).

Returns

TInputComponent

The input component of the cell.

Type Parameters

TInputComponent

Type of the input component.

Exceptions

AutomationException

Throws when the cell is not found.

SelectCellInput<TInputComponent>(int, string)

Selects the input component of a cell by the property name.

Warning : Do not use on native checkbox cell, use GetCheckboxCellValue(int, string) instead.

TInputComponent SelectCellInput<TInputComponent>(int visibleRowIndex, string colName) where TInputComponent : IInputComponent

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colName string

Column name (property name).

Returns

TInputComponent

The input component of the cell.

Type Parameters

TInputComponent

Type of the input component.

Exceptions

AutomationException

Throws when the cell is not found.

ShiftClickOnCell(int, int)

Shift click on a cell.

bool ShiftClickOnCell(int visibleRowIndex, int colIndex)

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colIndex int

Column index (Starts at 0, the header selector cell and selection cell are excluded).

Returns

bool

A value indicating whether the action has been performed.

Exceptions

AutomationException

Throws when the cell is not found.

ShiftClickOnCell(int, string)

Shift click on a cell.

bool ShiftClickOnCell(int visibleRowIndex, string colName)

Parameters

visibleRowIndex int

Row index in the collection of visible rows (Starts at 0).

colName string

Column name.

Returns

bool

A value indicating whether the action has been performed.

Exceptions

AutomationException

Throws when the cell is not found.

ShowColumns(params string[])

Shows columns.

void ShowColumns(params string[] colNames)

Parameters

colNames string[]

Column names.

WaitUntilHasNoRows()

Waits until the data grid has no row.

void WaitUntilHasNoRows()

Exceptions

AutomationException

Throws when at least one row is still displayed after the time limit.

WaitUntilHasRows()

Waits until the data grid has at least one row.

void WaitUntilHasRows()

Exceptions

AutomationException

Throws when no rows were displayed within the time limit.