Open topic with navigation

# UltraWinGrid

## WinForms. UltraWinGrid

UltraWinGrid

## Constructor

## new UltraWinGrid()

An Infragistics UltraWinGrid object.

# Methods

## activateCell(rowOrRowPath, columnHeader) → {Promise.<void>}

Double-clicks the specified cell in this grid..

##### Parameters:

Name | Type | Description
--- | --- | ---
`rowOrRowPath` | number | string | The 0-based row number or row path.
`columnHeader` | string | The column caption.

##### Returns:

a promise that is fulfilled when the activateCell operation ends.

Type
  Promise.<void>

## activateColumn(bandLevel, columnHeader) → {Promise.<void>}

Double-clicks the specified column header in this grid.

##### Parameters:

Name | Type | Description
--- | --- | ---
`bandLevel` | number | The 0-based band level.
`columnHeader` | string | The column caption.

##### Returns:

a promise that is fulfilled when the activateColumn operation ends.

Type
  Promise.<void>

## activateRow(rowPath) → {Promise.<void>}

Double-clicks the specified row header in this grid.

##### Parameters:

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

##### Returns:

a promise that is fulfilled when the activateRow operation ends.

Type
  Promise.<void>

## addRow(addButtonName, newRowPathopt) → {Promise.<void>}

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

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`addButtonName` | string |  | The name of the Add button corresponding to the band to which you want to add a row.
`newRowPath` | string | <optional> | 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.

##### Returns:

a promise that is fulfilled when the addRow operation ends.

Type
  Promise.<void>

## collapseRow(rowOrRowPath) → {Promise.<void>}

Collapses the specified row.

##### Parameters:

Name | Type | Description
--- | --- | ---
`rowOrRowPath` | string | number | The 0-based row index or the row as a string in the format: "n1;n2;...;nX" where n is the row number in each band level.

##### Returns:

a promise that is fulfilled when the collapseRow operation ends.

Type
  Promise.<void>

## columnCount() → {Promise.<number>}

Get the number of columns

##### Returns:

a promise that is fulfilled with the number of columns

Type
  Promise.<number>

## expandRow(rowOrRowPath) → {Promise.<void>}

Expands the specified row.

##### Parameters:

Name | Type | Description
--- | --- | ---
`rowOrRowPath` | string | number | The 0-based row index or the row as a string in the format: "n1;n2;...;nX" where n is the row number in each band level.

##### Returns:

a promise that is fulfilled when the expandRow operation ends.

Type
  Promise.<void>

## getCell(rowOrRowPath, columnOrColumnHeader) → {WinForms.TableCell}

Returns the specified cell.

##### Parameters:

Name | Type | Description
--- | --- | ---
`rowOrRowPath` | string | number | 0-based row number or row path.
`columnOrColumnHeader` | string | number | 0-based column index or column caption.

##### Returns:

the TableCell.

Type
  WinForms.TableCell

## makeCellVisible(rowOrRowPath, columnHeader) → {Promise.<void>}

Scrolls the specified cell into view.

##### Parameters:

Name | Type | Description
--- | --- | ---
`rowOrRowPath` | number | string | The 0-based row number or row path.
`columnHeader` | string | The column caption.

##### Returns:

a promise that is fulfilled when the makeCellVisible operation ends.

Type
  Promise.<void>

## openSummaryDialog(bandLevel, columnHeader) → {Promise.<void>}

Opens the summary dialog box for the specified column.

##### Parameters:

Name | Type | Description
--- | --- | ---
`bandLevel` | number | The band level for which you want to open the dialog box.
`columnHeader` | string | The column caption.

##### Returns:

a promise that is fulfilled when the openSummaryDialog operation ends.

Type
  Promise.<void>

## rowCount() → {Promise.<number>}

Get the number of rows

##### Returns:

a promise that is fulfilled with the number of rows

Type
  Promise.<number>

## selectCell(rowOrRowPath, columnHeader) → {Promise.<void>}

Selects the specified cell in this grid.

##### Parameters:

Name | Type | Description
--- | --- | ---
`rowOrRowPath` | string | number | 0-based row number or row path.
`columnHeader` | string | The column caption.

##### Returns:

a promise that is fulfilled when the selectCell operation ends.

Type
  Promise.<void>

## selectColumn(bandLevel, columnHeader) → {Promise.<void>}

Selects column by column index or column caption.

##### Parameters:

Name | Type | Description
--- | --- | ---
`bandLevel` | number | The band level for which you want to open the dialog box..
`columnHeader` | string | The column caption.

##### Returns:

a promise that is fulfilled when the selectColumn operation ends.

Type
  Promise.<void>

## selectRow(rowPath) → {Promise.<void>}

Clicks the specified row header in this grid.

##### Parameters:

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

##### Returns:

a promise that is fulfilled when the collapseRow operation ends.

Type
  Promise.<void>

## setFilter(bandLevel, columnHeader, filter) → {Promise.<void>}

Applies the specified filter string to the specified column.

##### Parameters:

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

##### Returns:

a promise that is fulfilled when the setFilter operation ends.

Type
  Promise.<void>

## sort(bandLevel, columnHeader) → {Promise.<void>}

Sorts this table by the specified column (ascending).

##### Parameters:

Name | Type | Description
--- | --- | ---
`bandLevel` | number | The 0-based band level.
`columnHeader` | string | The column caption.

##### Returns:

a promise that is fulfilled when the sort operation ends.

Type
  Promise.<void>

## sortDescending(bandLevel, columnHeader) → {Promise.<void>}

Sorts this table by the specified column (descending).

##### Parameters:

Name | Type | Description
--- | --- | ---
`bandLevel` | number | The 0-based band level.
`columnHeader` | string | The column caption.

##### Returns:

a promise that is fulfilled when the sort operation ends.

Type
  Promise.<void>

## tableTestObject() → {WinForms.Table}

Returns the Table test object this custom grid was accessed from.

##### Returns:

the tableTestObject.

Type
  WinForms.Table