Interface IXtraGrid

A DevExpress XtraGrid object.

Inherited Members

ICustomGrid.TableTestObject

Namespace: HP.LFT.SDK.WinForms

Assembly: HP.LFT.SDK.dll

Syntax

public interface IXtraGrid : ICustomGrid

Properties

ColumnCount

Returns the number of columns in the current view.

Declaration

int ColumnCount { get; }

Property Value

Type	Description
int

RowCount

Returns the number of rows in the current view.

Declaration

int RowCount { get; }

Property Value

Type	Description
int

Methods

ActivateCell(int, string)

Double-clicks the specified cell in this grid.

Declaration

void ActivateCell(int row, string columnHeader)

Parameters

Type	Name	Description
int	row	0-based row number.
string	columnHeader	The column caption.

ActivateColumn(int)

Double-clicks the specified column header in this grid.

Declaration

void ActivateColumn(int column)

Parameters

Type	Name	Description
int	column	0-based column index.

ActivateColumn(string)

Double-clicks the specified column header in this grid.

Declaration

void ActivateColumn(string columnHeader)

Parameters

Type	Name	Description
string	columnHeader	The column caption.

GetCell(int, int)

Returns a cell in the grid.

Declaration

ITableCell GetCell(int row, int column)

Parameters

Type	Name	Description
int	row	0-based row number.
int	column	0-based column index.

Returns

Type	Description
ITableCell

GetCell(int, string)

Returns a cell in the grid.

Declaration

ITableCell GetCell(int row, string columnHeader)

Parameters

Type	Name	Description
int	row	0-based row number.
string	columnHeader	The column caption.

Returns

Type	Description
ITableCell

GroupRows(int)

Groups table rows according to the specified column.

Declaration

void GroupRows(int column)

Parameters

Type	Name	Description
int	column	0-based column index.

GroupRows(string)

Groups table rows according to the specified column.

Declaration

void GroupRows(string columnHeader)

Parameters

Type	Name	Description
string	columnHeader	The column caption.

MakeCellVisible(int, string)

Scrolls the specified cell into view.

Declaration

void MakeCellVisible(int row, string columnHeader)

Parameters

Type	Name	Description
int	row	0-based row number.
string	columnHeader	The column caption.

SelectCell(int, string)

Selects the specified cell in this grid.

Declaration

void SelectCell(int row, string columnHeader)

Parameters

Type	Name	Description
int	row	0-based row number.
string	columnHeader	The column caption.

SelectColumn(int)

Clicks the specified column header in this grid.

Declaration

void SelectColumn(int column)

Parameters

Type	Name	Description
int	column	0-based column index.

SelectColumn(string)

Clicks the specified column header in this grid.

Declaration

void SelectColumn(string columnHeader)

Parameters

Type	Name	Description
string	columnHeader	The column caption.

SetFilter(int, string)

Applies the specified filter string to the specified column.

Declaration

void SetFilter(int column, string filter)

Parameters

Type	Name	Description
int	column	0-based column index.
string	filter	A value in the column to be used as the filter.

SetFilter(string, string)

Applies the specified filter string to the specified column.

Declaration

void SetFilter(string columnHeader, string filter)

Parameters

Type	Name	Description
string	columnHeader	The column caption.
string	filter	A value in the column to be used as the filter.

SetView(params Tuple<int, string>[])

Expands the parent rows of the specified view and makes it the current view.

Declaration

void SetView(params Tuple<int, string>[] viewPath)

Parameters

Type	Name	Description
Tuple<int, string>[]	viewPath	The hierarchical path of the view you want to display expressed using Tuples in the format: (0-based row number, relation name)

Remarks

A SetView statement without parameters must be used before the first operation on an XtraGrid table. If your test contains steps on more than one XtraGrid table, ensure that you add a SetView without parameters statement before the first step on each grid.

Sort(int)

Sorts this table by the specified column, ascending.

Declaration

void Sort(int column)

Parameters

Type	Name	Description
int	column	0-based column index.

Sort(string)

Sorts this table by the specified column, ascending.

Declaration

void Sort(string columnHeader)

Parameters

Type	Name	Description
string	columnHeader	The column caption.

SortDescending(int)

Sorts this table by the specified column, descending.

Declaration

void SortDescending(int column)

Parameters

Type	Name	Description
int	column	0-based column index.

SortDescending(string)

Sorts this table by the specified column, descending.

Declaration

void SortDescending(string columnHeader)

Parameters

Type	Name	Description
string	columnHeader	The column caption.

UngroupRows(int)

Ungroups table rows according to the specified column.

Declaration

void UngroupRows(int column)

Parameters

Type	Name	Description
int	column	0-based column index.

UngroupRows(string)

Ungroups table rows according to the specified column.

Declaration

void UngroupRows(string columnHeader)

Parameters

Type	Name	Description
string	columnHeader	The column caption.