Form.OnInsert Property

Access Developer Reference

Sets or returns the value of the Before Insert box in the Properties window of a form. Read/write String.

Syntax

expression.OnInsert

expression A variable that represents a Form object.

Remarks

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.

Although the name of this property is OnInsert, setting this property actually sets the value of the Before Insert box.

The BeforeInsert event occurs when the user types the first character in a new record, but before the record is actually created.

The OnInsert 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 Before Insert 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 Before Insert box is blank, the property value is an empty string.

Example

The following example prints the value of the OnInsert property in the Immediate window for the "Order Entry" form.

Visual Basic for Applications
  Debug.Print Forms("Order Entry").OnInsert

See Also