Refreshes objects in the report based on type.
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
XL3RefreshObjects( [RunRefresh], [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. |
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 the RunRefresh parameter to refresh all types.
Example
This example assumes you are using cell $A$1 to hold the RunRefresh variable. Anaplan XL will refresh the grids.
First, create the XL3RefreshObjects:
=XL3RefreshObjects($A$1, True)
Next, set up the link to fire the refresh:
=XL3Link(XL3Address($A$1),"Refresh All",,XL3Address($A$1),TRUE)
Selecting the link will refresh all grids in the workbook.