Report.ApplyFilter Event
| Access Developer Reference |
Occurs when a filter is applied to a report.
Version Information
Version Added: Access 2007
Syntax
expression.ApplyFilter(Cancel, ApplyType)
expression A variable that represents a Report object.
Parameters
| Name | Required/Optional | Data Type | Description |
|---|---|---|---|
| Cancel | Required | Integer | The setting determines if the ApplyFilter event occurs. Setting the Cancel argument to True cancels the ApplyFilter event and the filter is not applied to the report. |
| ApplyType | Required | Integer | Returns the type of filter that was applied. |
Remarks
To run a macro or event procedure when this event occurs, set the OnApplyFilter property to the name of the macro or to [Event Procedure].
You can use the ApplyFilter event to:
- Make sure the filter that is being applied is correct. For example, you may want to be sure that any filter applied to an Orders report includes criteria restricting the OrderDate field. To do this, check the report's Filter or ServerFilter property value to make sure this criteria is included in the WHERE clause expression.
- Change the display of the report before the filter is applied. For example, when you apply a certain filter, you may want to disable or hide some fields that aren't appropriate for the records displayed by this filter.
- Undo or change actions you took when the Filter event occurred. For example, you can disable or hide some controls on the report when the user is creating the filter, because you don't want these controls to be included in the filter criteria. You can then enable or show these controls after the filter is applied.
The actions in the ApplyFilter macro or event procedure occur before the filter is applied or removed, or after the Advanced Filter/Sort window is closed, but before the report is redisplayed. The criteria you've entered in the newly created filter are available to the ApplyFilter macro or event procedure as the setting of the Filter or ServerFilter property.
The ApplyFilter event does not occur when the user does one of the following:
- Applies or removes a filter by using the ApplyFilter, OpenReport, or ShowAllRecords actions in a macro, or their corresponding methods of the DoCmd object in Visual Basic.
- Uses the Close action or the Close method of the DoCmd object to close the Advanced Filter/Sort window.
- Sets the Filter or ServerFilter property or FilterOn property in a macro or Visual Basic (although you can set these properties in an ApplyFilter macro or event procedure).