XL3RefreshSheetObjects

XL3RefreshSheetObjects
Type Report Management
Available from 9.0
Description Refreshes objects on a sheet based on type.

Refreshes objects on a sheet based on type - new in Version 9.

This allows you to refresh objects on demand.

This function is for use with the XL3Link function, which can be used to switch the refresh on.

Syntax

XL3RefreshSheetObjects( [RunRefresh], [SheetName], [RefreshGrids], [RefreshTables], [RefreshSlicers], [RefreshSmallMultiples], [RefreshTreemaps] )

Parameters

Parameter Description
RunRefresh Should the refresh fire. This should be a reference to another cell that contains TRUE or FALSE. Once the refresh fires that cell will be reset to FALSE. Use XL3Link to set the cell to true, causing a refresh.
SheetName Text. Sheet to refresh objects on.
RefreshGrids TRUE or FALSE. Refresh all Grids.
RefreshTables TRUE or FALSE. Refresh all Tables.
RefreshSlicers TRUE or FALSE. Refresh all Slicers.
RefreshSmallMultiples TRUE or FALSE. Refresh all SmallMultiples.
RefreshTreemaps TRUE or FALSE. Refresh all Treemaps.

You may also call the formula with just the RunRefresh and SheetName parameter to refresh all types.

Example

This example assumes you are using cell $A$1 to hold the RunRefresh variable. We will refresh just the grids.

First, create the XL3RefreshSheetObjects, as follows:

=XL3RefreshSheetObjects($A$1, "Sheet1", True)

Next set up the link to fire the refresh, as follows:

=XL3Link(XL3Address($A$1),"Refresh All",,XL3Address($A$1),TRUE)

Now clicking the hyperlink will refresh all grids in the workbook.

See Also