OnApplyFilter Property [Access 2003 VBA Language Reference]
Sets or returns the value of the On Apply Filter box in the Properties window of a form. 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 Apply Filter event occurs when a filter is applied or removed.
The OnApplyFilter 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 Apply Filter box in the form'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 Apply Filter box is blank, the property value is an empty string.
The following example associates the OnApplyFilter property for the "Order Entry" form to the event "Form_ApplyFilter".
Forms("Order Entry").OnFilter = "[Event Procedure]"
Applies to | Form Object
See Also | ApplyFilter Method