VBA: RefreshFull

Created by Damien Zwillinger, Modified on Thu, 5 Oct, 2023 at 5:56 PM by Gabriel Michaud

Applies to:

Velixo Classic
Velixo NX (when used with Excel on Desktop)

Important: Visual Basic for Applications macros are not supported by Excel Online.

Purpose

Provides a mean to check if Velixo is currently running backgrounds functions.

See Introduction to Velixo's VBA functions for general usage information.

Syntax

  objVelixo.RefreshFull [AsyncRefresh]

objVelixo A variable that represents an instance of the Velixo VBA functions class.

Parameters

Name	Description
AsyncRefresh	Optional. Boolean value that specifies if the full refresh should be done in the background. Defaults to False.

Remarks

The RefreshFull method honors Excel's Application.DisplayAlerts flag.

If DisplayAlerts is set to True, RefreshFull behaves the same as when used from the toolbar (i.e. information, warning and errors will be displayed in message boxes).

If DisplayAlerts is set to False, all information messages will be suppressed and all warning and error messages will instead be returned as exceptions.

Example

Foreground (synchronous) full refresh

A synchronous RefreshFull is useful when you want to ensure the report is refreshed before performing the next action. E.g. before report distribution.

Dim velixoObj As Velixo_Reports.VBA
Set velixoObj = CreateObject("Velixo.Reports.Vba")

Application.DisplayAlerts = False

velixoObj.RefreshFull

Application.DisplayAlerts = True

Background (asynchronous) full refresh

Dim velixoObj As Velixo_Reports.VBA
Set velixoObj = CreateObject("Velixo.Reports.Vba")

Application.DisplayAlerts = False

velixoObj.RefreshFull True

Note that in the asynchronous example, we do not set DisplayAlerts back to True after invoking RefreshFull: this is because RefreshFull True returns control immediately, so, after that line, Velixo refresh is still in progress.

In this background refresh scenario, to reset DisplayAlerts back to True and do any additional refresh post-processing, use Velixo's VBA refresh call-back.