OnDirty Property [Access 2003 VBA Language Reference]
Sets or returns the value of the On Dirty box in the Properties window of one of the objects in the Applies To list. 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 Dirty event occurs when the contents of a form or the text portion of a combo box changes. It also occurs when you move from one page to another page in a tab control.
The OnDirty value will be one of the following, depending on the selection chosen in the Choose Builder window (accessed by clicking Build in the object'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 Dirty box is blank, the property value is an empty string.
The following example prints the value of the OnDirty property in the Immediate window for the "Order Entry" form.
Debug.Print Forms("Order Entry").OnDirty