Event Macros

Office Connector can call macros that you record to run at specific time, for example just before refreshing data, so you can carry out steps tied to events in the workbook.


Follow these steps to record a macro tied to an Office Connector event:

  1. On the Developer tab, click Record Macro (in the Code group).
  2. In the Macro name box, enter one of the macro names from the Event Macros List below.  Note that the macro name must match exactly, so using Copy and Paste might be helpful.
  3. Click OK.
  4. Carry out the steps that you want your macro to perform.
    NOTE - If you perform an action that triggers the event while you are recording it, then an infinite loop will be started.  Office Connector detects this scenario and prompts you to cancel the action, but it is best to avoid it altogether.
  5. On the Developer tab, click Stop Recording (in the Code group).

Event Macros List

ActionAssociated Macro Names
Office Connector: Save As ValuesBefore_OCSaveAsValues, After_OCSaveAsValues
Office Connector: Refresh DataBefore_TSRefreshData, After_TSRefreshData
Office Connector: Write DataBefore_TSWriteData, After_TSWriteData
Office Connector: Import DataBefore_WriteImportFiles, After_WriteImportFiles
Excel: New WorkbookOC_OnNewWorkbook, OCI_OnNewWorkbook
Excel: Saving a workbook templateOC_OnSaveTemplate, OCI_OnSaveTemplate

Advanced Usage

The default Before and After event macro functionality can be extended by manually editing the recorded macro procedures.

Canceling an Event

All of the events that start with Before_ can be canceled, preventing the action from taking place.  To accomplish this, change the macro from a Sub to a Function that returns a Long.  To cancel the action, assign a non-zero return value to the function.  For example:

Public Function Before_TSRefreshData() As Long

'Cancel the refresh if there is no job number
If IsEmpty(Range("A1")) Then
Call MsgBox("You must enter a job number before refreshing the workbook.", _
Before_TSRefreshData = -1
Exit Function
End If

End Function

Using Return Values

All of the events that start with After_ can be modified to indicate if the action was successful.  To accomplish this, add a Long parameter to the Sub.  Office Connector will pass the return code from the associated action via this parameter.  Zero indicates success and other values indicate cancellation or errors.  For example:

Public Sub After_TSRefreshData(ByVal lvOperationResult As Long)

'Don't do anything if the refresh was canceled or did not complete due to an error
If lvOperationResult <> 0 Then
Exit Sub
End If

'Run the code to perform post-refresh steps here

End Sub