416.467.9100 | Dundas Data Visualization | Login
Welcome Guest
This is the support page for the legacy Dundas Dashboard application. For assistance with the current Dundas BI application please click here.
Dashboard v5.0

This site makes extensive use of JavaScript.

Please enable JavaScript in your web browser and reload the page before proceeding.

Data Grid - Interactions and Methods

Hide navigation
RSS
Modified on Tue, 28 May 2013 10:29 AM Categorized as Data Controls, Data Grid, Design, Scripting
Click to return to: Documentation | Designing Dashboards | DV Controls | Data Grid


Interactions

Click

The Click interaction lets you respond to mouse clicks (e.g. left mouse button down) on the data grid.

Arguments:


// To find the data point value of the clicked item: e.GetDataPointValueFromColumnId( e.ColumnId );

Context Click

The Context Click interaction lets you respond to context click events (e.g. right mouse button up) on the data grid.

Arguments:


Hover

The Hover interaction lets you respond to the user “hovering” their mouse over the data grid.

Arguments:


Group Description Collection Changed

The Group Description Collection Changed interaction lets you know when the group description collection has changed.

ImageThis is an Advanced property.

Arguments:


Mouse Enter

The Mouse Enter interaction lets you respond to the user moving the mouse into the data grid's area.

ImageThis is an Advanced property.

Arguments:


Mouse Leave

The Mouse Leave interaction lets you respond to the user moving the mouse out of the data grid's area.

ImageThis is an Advanced property.

Arguments:


Note: The Mouse Leave event occurs whenever the mouse is no longer directly over the control. For example, if you displayed a message (via the services.ShowMessage method) that appeared under the mouse, the Mouse Leave event would occur even though the mouse hasn't moved.

Mouse Move

The Mouse Move interaction lets you respond to mouse movements in the data grid's area.

ImageThis is an Advanced property.

Arguments:


Mouse Right Down

The Mouse Right Down interaction lets you respond to right mouse button down events in the data grid.

ImageThis is an Advanced property.

Arguments:


Mouse Up

The Mouse Up interaction lets you respond to the user releasing the mouse over the control's area.

ImageThis is an Advanced property.

Arguments:


On Data Changed

The On Data Changed interaction lets you respond to changes in the data grid's underlying data.

These interactions run when the data changes in this data visualization control. This could be from a parameter change, or a real-time update. The real-time updates will cause this interaction to fire on the timer, regardless of whether the actual data changed.

ImageThis is an Advanced property.

Arguments:


On Layout Updated

The On Layout Updated interaction lets you respond when the layout is updated in this data visualization control. It is fired in the same scenarios as the On Data Changed Interactions with the exception that it is fired after the control has processed the updated data.

ImageThis is an Advanced property.

Arguments:


Page Index Changed

The Page Index Changed interaction lets you respond when the current page has changed in the data pager.

ImageThis is an Advanced property.

Arguments:


Row Loaded

The Row Loaded interaction lets you respond to the loading of a data grid row.

ImageThis is an Advanced property.

Arguments:


Row Unloaded

The Row Unloaded interaction lets you respond to the unloading of a data grid row.

ImageThis is an Advanced property.

Arguments:


Selection Changed

The Selection Changed interaction lets you know when the selection has changed in the data grid.

ImageThis is an Advanced property.

Arguments:


Methods

ApplySort

Applies the specified sort direction to the specified column.


Arguments:

  • dashboardDataGridDataColumn - The dashboard data grid data column.
  • sortDirection - The sort direction.

GetCellValue

Gets the value of the specified cell.


Arguments:

  • dashboardDataGridCell - The data grid cell.

Example:

object cellValue = DataGrid1.GetCellValue(DataGrid1.LoadedRows0.Cells1);

GetColumnByDataColumnId

Gets the column by data column id.


Arguments:

  • dataColumnId - The data column id.

GetColumnByHeaderText

Gets the column by header text.


Arguments:

  • headerText - The header text.

GetColumnsByDataColumnId

Gets the columns by data column id.


Arguments:

  • dataColumnId - The data column id.

GetColumnsByHeaderText

Gets the columns by header text.


Arguments:

  • headerText - The header text.

GetSortDirection

Gets the sort direction of the specified column.


Arguments:

  • dashboardDataGridDataColumn - The dashboard data grid data column.

GetSubtotal

Gets the subtotal for the specified group and column.


Arguments:

  • group - The group.
  • dashboardDataGridDataColumn - The dashboard data grid data column.

GetTotal

Gets the total for the specified column.


Arguments:

  • dashboardDataGridDataColumn - The dashboard data grid data column.

SetSubtotal

Sets the subtotal for the specified group and column.


Arguments:

  • group - The group.
  • dashboardDataGridDataColumn - The dashboard data grid data column.
  • subtotal - The subtotal to set.

SetTotal

Sets the total for the specified column.


Arguments:

  • dashboardDataGridDataColumn - The dashboard data grid data column.
  • total - The total to set.

Related topics


Click to return to: Documentation | Designing Dashboards | DV Controls | Data Grid

About Dundas | Contact Us Follow us on Twitter! | Privacy Statement | Report Site Issues

Copyright © 2009-2014 Dundas Data Visualization, Inc.