Difference between revisions of "XL3RefreshObjects"

(Created page with "Refreshes objects in the report based on type. (New in version 7.1) This allows you to refresh objects on demand. This function is for use with the XL3Link function, which ...")
 
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Refreshes objects in the report based on type. (New in version 7.1)
+
Refreshes objects in the report based on type. (New in [[Version 7.1]])
  
 
This allows you to refresh objects on demand.
 
This allows you to refresh objects on demand.
Line 36: Line 36:
  
 
==Example==
 
==Example==
You can setup a named image by inserting a picture using the standard Excel menu option.
+
This example assumes you are using cell $A$1 to hold the RunRefresh variable. We will refresh just the grids.
  
Next set the Picture name by right-clicking it, and selecting properties. The name goes in the "Alt Text" box.
+
First, create the XL3RefreshObjects, as follows:
 
+
<pre>
[[Image:DynamicPicture_SetName.png|450px|centre]]
+
=XL3RefreshObjects($A$1, True)
 +
</pre>
  
Finally set up a formula, e.g.
+
Next set up the link to fire the refresh, as follows:
 
<pre>
 
<pre>
=XL3DynamicPicture("MyLogo"; "http://www.example.com/logo.jpg")
+
=XL3Link(XL3Address($A$1),"Refresh All",,XL3Address($A$1),TRUE)
 
</pre>
 
</pre>
Here the Url paramater is fixed, but it could be set to reference another cell or concatenated text.
+
 
 +
Now clicking the hyperlink will refresh all grids in the workbook.
  
 
==See Also==
 
==See Also==
 
* [[Formula Reference]]
 
* [[Formula Reference]]
 +
* [[XL3RefreshObjectsNamed]]
  
 
[[Category:Formulae]]
 
[[Category:Formulae]]
 
[[Category:Report Management Formulae]]
 
[[Category:Report Management Formulae]]
 
[[Category:Report Management]]
 
[[Category:Report Management]]

Latest revision as of 11:41, 7 September 2012

Refreshes objects in the report based on type. (New in Version 7.1)

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 just the RunRefresh 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 XL3RefreshObjects, as follows:

=XL3RefreshObjects($A$1, 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