Showing posts with label Excel Event. Show all posts
Showing posts with label Excel Event. Show all posts

Application WorkbookRowsetComplete Event

Purpose

The WorkbookRowsetComplete event occurs when the user either drills through the recordset or invokes the rowset action on an OLAP PivotTable.

Syntax

WorkbookRowsetComplete(Wb, Description, Sheet, Success)

Required Parameters

Wb

The workbook for which the event occurs.

Description

A brief description of the event.

Sheet

The worksheet on which the recordset is created.

Success

Contains a Boolean value to indicate success or failure.

Application WorkbookModelChange Event

Purpose

Occurs when the data model is updated.

Syntax

WorkbookModelChange(Wb,Changes)

Required Parameters

Wb

The workbook

Changes

The changes to the data model.

Application SheetTableUpdate Event

Purpose

Occurs when a table on a worksheet is updated.

Syntax

SheetTableUpdate(Sh,Target)

Required Parameters

Sh

The worksheet.

Target

The table.

Application SheetPivotTableBeforeDiscardChanges Event

Purpose

Occurs before changes to a PivotTable are discarded.

Syntax

SheetPivotTableBeforeDiscardChanges(Sh, TargetPivotTable, ValueChangeStart, ValueChangeEnd)

Required Parameters

Sh

The sheet object.

TargetPivotTable

The PivotTable that contains the changes to discard.

ValueChangeStart

The index to the first change in the associated PivotTableChangeList object. The index is specified by the Order property of the ValueChange object in the PivotTableChangeList collection.

ValueChangeEnd

The index to the last change in the associated PivotTableChangeList object. The index is specified by the Order property of the ValueChange object in the PivotTableChangeList collection.

Application SheetPivotTableBeforeCommitChanges Event

Purpose

Occurs before changes are committed against the OLAP data source for a PivotTable.

Syntax

SheetPivotTableBeforeCommitChanges(Sh, TargetPivotTable, ValueChangeStart, ValueChangeEnd, Cancel)

Required Parameters

Sh

The worksheet that contains the PivotTable.

TargetPivotTable

The PivotTable that contains the changes to commit.

ValueChangeStart

The index to the first change in the associated PivotTableChangeList object. The index is specified by the Order property of the ValueChange object in the PivotTableChangeList collection.

ValueChangeEnd

The index to the last change in the associated PivotTableChangeList object. The index is specified by the Order property of the ValueChange object in the PivotTableChangeList collection.

Cancel

False when the event occurs. If the event procedure sets this argument to True, the changes are not committed against the OLAP data source of the PivotTable.

Application SheetPivotTableBeforeAllocateChanges Event

Purpose

Occurs before changes are applied to a PivotTable.

Syntax

SheetPivotTableBeforeAllocateChanges(Sh, TargetPivotTable, ValueChangeStart, ValueChangeEnd, Cancel)

Required Parameters

Sh

The worksheet that contains the PivotTable.

TargetPivotTable

The PivotTable that contains the changes to apply.

ValueChangeStart

The index to the first change in the associated PivotTableChangeList collection. The index is specified by the Order property of the ValueChange object in the PivotTableChangeList collection.

ValueChangeEnd

The index to the last change in the associated PivotTableChangeList collection. The index is specified by the Order property of the ValueChange object in the PivotTableChangeList collection.

Cancel

False when the event occurs. If the event procedure sets this argument to True, the changes are not applied to the PivotTable and all edits are lost.

Application SheetPivotTableAfterValueChange Event

Purpose

Occurs after a cell or range of cells inside a PivotTable are edited or recalculated (for cells that contain formulas).

Syntax

SheetPivotTableAfterValueChange(Sh, TargetPivotTable, TargetRange)

Required Parameters

Sh

The worksheet that contains the PivotTable

TargetPivotTable

The PivotTable that contains the edited or recalculated cells.

TargetRange

The range that contains all the edited or recalcuated cells.

Application SheetLensGalleryRenderComplete Event

Purpose

Occurs after a callout gallery’s icons (dynamic & static) have finished rendering.

Syntax

SheetLensGalleryRenderComplete(Sh)

Required Parameters

Sh

Name of a worksheet.

Application WorkbookPivotTableOpenConnection Event

Purpose

Occurs after a PivotTable report connection has been opened.

Syntax

WorkbookPivotTableOpenConnection(Wb, Target)

Required Parameters

Wb

The selected workbook.

Target

The selected PivotTable report.

Application WorkbookPivotTableCloseConnection Event

Purpose

Occurs after a PivotTable report connection has been closed.

Syntax

WorkbookPivotTableCloseConnection(Wb, Target)

Required Parameters

Wb

The selected workbook.

Target

The selected PivotTable report.

Application WorkbookOpen Event

Purpose

Occurs when a workbook is opened.

Syntax

WorkbookOpen(Wb)

Required Parameters

Wb

The workbook.

Application WorkbookNewSheet Event

Purpose

Occurs when a new sheet is created in any open workbook.

Syntax

WorkbookNewSheet(Wb, Sh)

Required Parameters

Wb

The workbook.

Sh

The new sheet.

Application WorkbookNewChart Event

Purpose

Occurs when a new chart is created in any open workbook.

Syntax

WorkbookNewChart(Wb, Ch)

Required Parameters

Wb

The workbook.

Ch

The new chart.

Application WorkbookDeactivate Event

Purpose

Occurs when any open workbook is deactivated.

Syntax

WorkbookDeactivate(Wb)

Required Parameters

Wb

The workbook.

Application WorkbookBeforeXmlImport Event

Purpose

Occurs before an existing XML data connection is refreshed, or new XML data is imported into any open Microsoft Excel workbook.

Syntax

WorkbookBeforeXmlImport(Wb, Map, Url, IsRefresh, Cancel)

Required Parameters

Wb

The target workbook.

Map

The XML map that will be used to import data.

Url

The location of the XML file to be imported.

IsRefresh

True if the event was triggered by refreshing an existing connection to XML data, False if a new mapping will be created.

Cancel

Set to True to cancel the import or refresh operation.

Application WorkbookBeforeXmlExport Event

Purpose

Occurs before Microsoft Excel saves or exports XML data from the specified workbook.

Syntax

WorkbookBeforeXmlExport(Wb, Map, Url, Cancel)

Required Parameters

Wb

The target workbook.

Map

The XML map that will be used to save or export data.

Url

The location of the XML file to be exported.

Cancel

Set to True to cancel the save or export operation.

Application WorkbookBeforeSave Event

Purpose

Occurs before any open workbook is saved.

Syntax

WorkbookBeforeSave(Wb, SaveAsUI, Cancel)

Required Parameters

Wb

The workbook.

SaveAsUI

True if the Save As dialog box will be displayed.

Cancel

False when the event occurs. If the event procedure sets this argument to True, the workbook isn't saved when the procedure is finished.

Application WorkbookBeforePrint Event

Purpose

Occurs before any open workbook is printed.

Syntax

WorkbookBeforePrint(Wb, Cancel)

Required Parameters

Wb

The workbook.

Cancel

False when the event occurs. If the event procedure sets this argument to True, the workbook isn't printed when the procedure is finished.

Application WorkbookBeforeClose Event

Purpose

Occurs immediately before any open workbook closes.

Syntax

WorkbookBeforeClose(Wb, Cancel)

Required Parameters

Wb

The workbook that's being closed

Cancel

False when the event occurs. If the event procedure sets this argument to True, the workbook doesn't close when the procedure is finished.

Application WorkbookAfterXmlImport Event

Purpose

Occurs after an existing XML data connection is refreshed, or new XML data is imported into any open Microsoft Excel workbook.

Syntax

WorkbookAfterXmlImport(Wb, Map, IsRefresh, Result)

Required Parameters

Wb

The target workbook.

Map

The XML map that was used to import data.

IsRefresh

True if the event was triggered by refreshing an existing connection to XML data, False if a new mapping was created.

Result

Indicates the results of the refresh or import operation.