Interface IUltraWinGrid

An Infragistics UltraWinGrid object.

Inherited Members

ICustomGrid.TableTestObject

Namespace: HP.LFT.SDK.WinForms

Assembly: HP.LFT.SDK.dll

Syntax

public interface IUltraWinGrid : ICustomGrid

Properties

ColumnCount

The number of columns in the current band.

Declaration

int ColumnCount { get; }

Property Value

Type	Description
int

RowCount

The number of rows in the current band.

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.

ActivateCell(string, string)

Double-clicks the specified cell in this grid.

Declaration

void ActivateCell(string rowPath, string columnHeader)

Parameters

Type	Name	Description
string	rowPath	The row as a string in the format: "n1;n2;...;nX" where n is the row number in each band level.
string	columnHeader	The column caption.

ActivateColumn(int, string)

Double-clicks the specified column header in this grid.

Declaration

void ActivateColumn(int bandLevel, string columnHeader)

Parameters

Type	Name	Description
int	bandLevel	0-based band level.
string	columnHeader	The column caption.

ActivateRow(string)

Double-clicks the specified row header in this grid.

Declaration

void ActivateRow(string rowPath)

Parameters

Type	Name	Description
string	rowPath	The row as a string in the format: "n1;n2;...nX" where n is the row number in each band level.

AddRow(string)

Adds a new row to the table band using the Add button for the corresponding band.

Declaration

void AddRow(string addButtonName)

Parameters

Type	Name	Description
string	addButtonName	The name of the Add button corresponding to the band to which you want to add a row.

AddRow(string, string)

Adds a new row to the table band using the Add button for the corresponding band.

Declaration

void AddRow(string addButtonName, string newRowPath)

Parameters

Type	Name	Description
string	addButtonName	The name of the Add button corresponding to the band to which you want to add a row.
string	newRowPath	The band path that shows where the row is added in the format: "n1;n2;...;nX" where n is the row number in each band level.

CollapseRow(int)

Collapses the specified row.

Declaration

void CollapseRow(int row)

Parameters

Type	Name	Description
int	row	0-based row number.

CollapseRow(string)

Collapses the specified row.

Declaration

void CollapseRow(string rowPath)

Parameters

Type	Name	Description
string	rowPath	The row as a string in the format: "n1;n2;...;nX" where n is the row number in each band level.

ExpandRow(int)

Expands the specified row.

Declaration

void ExpandRow(int row)

Parameters

Type	Name	Description
int	row	0-based row number.

ExpandRow(string)

Expands the specified row.

Declaration

void ExpandRow(string rowPath)

Parameters

Type	Name	Description
string	rowPath	The row as a string in the format: "n1;n2;...nX" where n is the row number in each band level.

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 the specified cell.

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

GetCell(string, string)

Returns the specified cell..

Declaration

ITableCell GetCell(string rowPath, string columnHeader)

Parameters

Type	Name	Description
string	rowPath	The row as a string in the format: "n1;n2;...;nX" where n is the row number in each band level.
string	columnHeader	The column caption.

Returns

Type	Description
ITableCell

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.

MakeCellVisible(string, string)

Scrolls the specified cell into view.

Declaration

void MakeCellVisible(string rowPath, string columnHeader)

Parameters

Type	Name	Description
string	rowPath	The row as a string in the format: "n1;n2;...nX" where n is the row number in each band level.
string	columnHeader	The column caption.

OpenSummaryDialog(int, string)

Opens the summary dialog box for the specified column.

Declaration

void OpenSummaryDialog(int bandLevel, string columnHeader)

Parameters

Type	Name	Description
int	bandLevel	The band level for which you want to open the dialog box.
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.

SelectCell(string, string)

Clicks the specified row header in this grid.

Declaration

void SelectCell(string rowPath, string columnHeader)

Parameters

Type	Name	Description
string	rowPath	The row as a string in the format: "n1;n2;...nX" where n is the row number in each band level.
string	columnHeader	The column caption.

SelectColumn(int, string)

Clicks the specified column header in this grid.

Declaration

void SelectColumn(int bandLevel, string columnHeader)

Parameters

Type	Name	Description
int	bandLevel	0-based band level.
string	columnHeader	The column caption.

SelectRow(string)

Clicks the specified row header in this grid.

Declaration

void SelectRow(string rowPath)

Parameters

Type	Name	Description
string	rowPath	The row as a string in the format: "n1;n2;...nX" where n is the row number in each band level.

SetFilter(int, string, string)

Applies the filter to the specified column.

Declaration

void SetFilter(int bandLevel, string columnHeader, string filter)

Parameters

Type	Name	Description
int	bandLevel	0-based band level.
string	columnHeader	The column caption.
string	filter	A value in the column to be used as the filter.

Sort(int, string)

Sorts the table by the specified column, ascending.

Declaration

void Sort(int bandLevel, string columnHeader)

Parameters

Type	Name	Description
int	bandLevel	0-based band level.
string	columnHeader	The column caption.

SortDescending(int, string)

Sorts the table by the specified column, descending.

Declaration

void SortDescending(int bandLevel, string columnHeader)

Parameters

Type	Name	Description
int	bandLevel	0-based band level.
string	columnHeader	The column caption.