Events

Events are triggered during the lifetime of a view. Not all events are fired for every view (events depends on the type of view and what functionality is used in the view).

Event Name Description
Activated Occurs when the view is activated.
ActiveSheetChanged Occurs after the active sheet has changed.
ActiveSheetChanging Occurs before the active sheet changes.
AfterBuild Occurs after the view has been built.
AfterCascadeSheetBuild Occurs after a cascade sheet has been added and the tokens have been replaced on the sheet.
AfterCascadeSheetsBuild Occurs after the cascade sheets have been built.
AfterClose Occurs after the view closes.
AfterCommentDeleted Occurs after a comment has been deleted.
AfterCommentSaved Occurs after a comment has been saved.
AfterCommentsSaved Occurs after the view's comments have been saved.
AfterCommentsSetup Occurs after the view's comments have been setup.
AfterConstruct Occurs after the view instance is created, but before the view user-interface is initialized. Allows for modifying view properties that affect the user-interface.
AfterDataSetRangeSave Occurs after a SQLPassthroughDataSetRange's changes have been saved.
AfterDataSetRangesBuild Occurs after all the SQLPassthroughDataSetRanges have been built.
AfterDataTableRangeAddRow Occurs after a row (or rows) is added to a DataTableRange either by a user adding/inserting a row(s) or when an empty row is automatically added.
AfterDataTableRangeDeleteRow Occurs after a row (or rows) is deleted from a DataTableRange.
AfterExcelTemplatePullToClient Occurs after the Excel template has been pulled from the server, but before it has been opened.
AfterExportToExcel Occurs after the view is saved as an Excel file.
AfterImportFromExcel Occurs after the view is loaded from an external workbook.
AfterImportWorksheet Occurs after a worksheet is loaded from an external workbook.
AfterInitialRetrieveFromBuild Occurs after the initial retrieve, which is performed while building the view.
AfterInitializeUI Occurs after the view UI is initialized.
AfterOpenInExcel Occurs after the workbook is opened in Excel.
AfterRangeReplaceTokens Occurs after a range token replacement.
AfterRangeRetrieve Occurs after a range is retrieved.
AfterRangeSend Occurs after a range is sent.
AfterRefresh Occurs after the view has been built.
AfterSaveAsExcel Occurs after the workbook is saved as Excel.
AfterSaveAsPdf Occurs after a view's grid data is saved as a PDF.
AfterSheetKeepOnly Occurs after an Essbase keep-only operation.
AfterSheetPivot Occurs after an Essbase pivot operation.
AfterSheetRemoveOnly Occurs after an Essbase remove-only operation.
AfterSheetReplaceTokens Occurs after tokens have been replaced on a sheet.
AfterSheetReport Occurs after an Essbase report operation.
AfterSheetRetrieve Occurs after all Essbase retrieves, if any, are performed for the sheet. If the view's retrieve policy allows the sheet to be retrieved, the event occurs whether or not any retrieves are actually performed.
AfterSheetRetrieveOperation Occurs after any Essbase retrieve operation (KeepOnly, RemoveOnly, Pivot, Report, Retrieve, ZoomIn, and ZoomOut) is performed on the sheet.
AfterSheetSend Occurs after all Essbase sends, if any, are performed for the sheet. If the view's send policy allows the sheet to be sent, the event occurs whether or not any sends are actually performed.
AfterSheetZoomIn Occurs after an Essbase zoom-in operation.
AfterSheetZoomOut Occurs after an Essbase zoom-out operation.
AfterTokenTableBuild Occurs after the token table has been built.
AfterWorkbookClose Occurs after the workbook is closed.
AfterWorkbookOpen Occurs after the workbook is opened.
AfterWorkbookRetrieve Occurs after all Essbase retrieve operations in the workbook are run.
AfterWorkbookSend Occurs after all Essbase send operations in the workbook are run.
BeforeBuild Occurs immediately after the Build view button is clicked and the view is covered.
BeforeBuildExecute Occurs immediately after the Build view button is clicked, but before the view is covered.
BeforeCascadeSheetBuild Occurs before a cascade sheet is added.
BeforeCascadeSheetsBuild Occurs before the cascade sheets are built.
BeforeCascadeSummarySheetBuild Occurs after the cascade sheets have been built, but before the cascade summary sheet is built.
BeforeClose Occurs before the view is closed.
BeforeCommentDeleted Occurs before a comment is deleted.
BeforeCommentSaved Occurs before a comment is saved.
BeforeCommentsSaved Occurs before the view's comments are saved.
BeforeCommentsSetup Occurs before the view's comments are setup.
BeforeDataSetRangeSave Occurs before a SQLPassthroughDataSetRange's changes are saved.
BeforeDataSetRangesBuild Occurs before all the SQLPassthroughDataSetRanges are built.
BeforeDataTableRangeAddRow Occurs before a row (or rows) is added to a DataTableRange either by a user adding/inserting a row(s) or when an empty row is automatically added.
BeforeDataTableRangeDeleteRow Occurs before a row (or rows) is deleted from a DataTableRange.
BeforeExcelTemplatePullToClient Occurs before the Excel template is pulled from the server.
BeforeExportToExcel Occurs before the view is saved as an Excel file.
BeforeImportFromExcel Occurs before the view is loaded from an external workbook.
BeforeImportWorksheet Occurs before a worksheet is loaded from an external workbook.
BeforeInitializeUI Occurs before the view's UI is initialized.
BeforeOpenInExcel Occurs before the workbook is opened in Excel.
BeforeOpenViewForDataCells Occurs before this view opens a target view for the context represented by one or more data cells.
BeforeOpenViewForMemberCells Occurs before this view opens a target vieww for the context represented by one or more member cells.
BeforeRangeReplaceTokens Occurs before a range token replacement.
BeforeRangeRetrieve Occurs before a range is retrieved.
BeforeRangeSend Occurs before a range is sent.
BeforeRefresh Occurs immediately after the Refresh view button is clicked and the view is covered.
BeforeRefreshExecute Occurs immediately after the Refresh view button is clicked, and before the view is covered.
BeforeSaveAsExcel Occurs before the workbook is saved as Excel.
BeforeSaveAsPdf Occurs before a view's grid data is saved as a PDF.
BeforeSelectorListItemsResolved Occurs before selector list items are resolved.
BeforeSheetKeepOnly Occurs before an Essbase keep-only operation.
BeforeSheetPivot Occurs before an Essbase pivot operation.
BeforeSheetRemoveOnly Occurs before an Essbase remove-only operation.
BeforeSheetReplaceTokens Occurs before tokens are replaced on a sheet.
BeforeSheetReport Occurs before an Essbase report operation.
BeforeSheetRetrieve Occurs before all Essbase retrieves, if any, are performed for the sheet. If the view's retrieve policy allows the sheet to be retrieved, the event occurs whether or not any retrieves are actually performed.
BeforeSheetRetrieveOperation Occurs before any Essbase retrieve operation (KeepOnly, RemoveOnly, Pivot, Report, Retrieve, ZoomIn, and ZoomOut).
BeforeSheetSend Occurs before all Essbase sends, if any, are performed for the sheet. If the view's send policy allows the sheet to be sent, the event occurs whether or not any sends are actually performed.
BeforeSheetZoomIn Occurs before an Essbase zoom-in operation.
BeforeSheetZoomOut Occurs before an Essbase zoom-out operation.
BeforeTokenTableBuild Occurs before the token table is built.
BeforeWorkbookClose Occurs before the workbook is closed.
BeforeWorkbookOpen Occurs before the workbook is opened.
BeforeWorkbookRetrieve Occurs before all Essbase retrieves are done on a workbook.
BeforeWorkbookSend Occurs before all Essbase sends are done on a workbook.
CellDoubleClicked Occurs when a cell is double-clicked.
ChartControlDataDoubleClicked Occurs when a chart control's data is double-clicked.
ClipboardPasted Occurs after a paste.
ClipboardPasting Occurs before a paste.
Deactivated Occurs when the view is deactivated.
EditCellChanged Occurs after a cell's content has changed.
EditCellChanging Occurs before cell contents change.
EssbaseExceptionOccurred Occurs when an exception occurs during an Essbase operation.
FollowHyperlink Occurs when a hyperlink is clicked.
ListDataValidationCellChanged Occurs after a cell that has list style data validation is changed. Any change to the cell, including the value, format, etc., raises the event.
Pivoting Occurs before an Essbase pivot operation is initiated by the user dragging and dropping a member cell(s) with the right mouse button.
RangeChanged Occurs after a change to one or more cells in a range has been applied.
RangeSelectionChanged Occurs after the selection cells on the sheet has changed.
RangeSelectionCleared Occurs when the user has cleared the selected cells.
RangeSelectionClearing Occurs when the user clears the selected cells.
RequestGridContextMenuID Occurs when the user right clicks a cell and before the context menu is displayed.
RequestSheetContextMenuID Occurs when the user right clicks in the sheet tab area of a worksheet or anywhere on a chart sheet and before the context menu is displayed.
SQLExceptionOccurred Occurs when an exception occurs on the server during a SQL operation.
SelectorSelectionChanged Occurs when the selected value(s) for any of the view's selectors change(s).
Shown Occurs when the view is initially shown.