OnRetreat Property [Access 2003 VBA Language Reference]

Sets or returns the value of the On Retreat box in the Properties window of a report section. Read/write String.


expression Required. An expression that returns one of the objects in the Applies To list.


This property is helpful for programmatically changing the action Microsoft Access takes when an event is triggered. For example, between event calls you may want to change an expression's parameters, or switch from an event procedure to an expression or macro, depending on the circumstances under which the event was triggered.

The Retreat event occurs when Microsoft Access returns to a previous report section during report formatting.

The OnRetreat value will be one of the following, depending on the selection chosen in the Choose Builder window (accessed by clicking the Build button next to the On Retreat box in the report section's Properties window):

  • If Expression Builder is chosen, the value will be "=expression", where expression is the expression from the Expression Builder window.
  • If Macro Builder is chosen, the value is the name of the macro.
  • If Code Builder is chosen, the value will be "[Event Procedure]".

If the On Retreat box is blank, the property value is an empty string.


The following example prints the value of the OnRetreat property in the Immediate window for the "GroupHeader0" section in the "Purchase Order" report.

Debug.Print Reports("Purchase Order").Section("GroupHeader0").OnRetreat

Applies to | Section Object