Click Event

See Also         Example         Applies To        

The Click event occurs only if it has been defined for a control in the Script Editor.

The TabStrip and MultiPage controls do not support the Click event. However, individual the Page objects of the MultiPage control do support the click event.

ScrollBars and SpinButtons do not support the Click event but you can bind them to fields and use the CustomPropertyChange event.

The Click event occurs in one of two cases:

• The user clicks a control with the mouse.
  
  
• The user definitively selects a value for a control with more than one possible value.

Syntax

Sub object_Click( )

The Click event syntax has these parts:

Example:

Sub CommandButton1_Click()
    MsgBox "You just clicked my button! "
End Sub

Remarks

Of the two cases where the Click event occurs, the first case applies to the CommandButton, Frame, Image Label, and Page.

The second case applies to the CheckBox, ComboBox, ListBox, and ToggleButton. It also applies to an OptionButton when the value changes to True.

The following are examples of actions that initiate the Click event:

• Clicking a blank area of a form or a disabled control (other than a list box) on the form.
  
  
• Clicking a CommandButton.
  
  
• Pressing the SPACEBAR when a CommandButton has the focus.
  
  
• Clicking a control with the left mouse button (left-clicking).
  
  
• Pressing ENTER on a form that has a command button whose Default property is set to True, as long as no other command button has the focus.
  
  
• Pressing ESC on a form that has a command button whose Cancel property is set to True, as long as no other command button has the focus.
  
  
• Pressing a control's accelerator key.

For some controls, the Click event occurs when the Value property changes. However, using the PropertyChange or CustomPropertyChange event is the preferred technique for detecting a new value for a property. The following are examples of actions that initiate the Click event due to assigning a new value to a control:

• Clicking a CheckBox or ToggleButton, pressing the SPACEBAR when one of these controls has the focus, pressing the accelerator key for one of these controls, or changing the value of the control in code.
  
  
• Changing the value of an OptionButton to True. Setting one OptionButton in a group to True sets all other buttons in the group to False, but the Click event occurs only for the button whose value changes to True.
  
  
• Selecting a value for a ComboBox or ListBox so that it unquestionably matches an item in the control's drop-down list. For example, if a list is not sorted, the first match for characters typed in the edit region may not be the only match in the list, so choosing such a value does not initiate the Click event. In a sorted list, you can use entry-matching to ensure that a selected value is a unique match for text the user types.

The Click event is not initiated when Value is set to Null.

Note Left-clicking changes the value of a control, thus it initiates the Click event. Right-clicking does not change the value of the control, so it does not initiate the Click event.

Also Note If you bind a ListBox, ComboBox, OptionButton, or CheckBox to a field, then the Click event does not fire. You need to use the PropertyChange or CustomPropertyChange event to detect the change via code.

Example:

Sub Item_PropertyChange(ByVal Name)
Set MyListBox = Item.GetInspector.ModifiedFormPages("Message").Controls("ListBox1")
Select Case Name
    Case "Mileage"
        Item.CC = MyListBox.Value
        Item.Subject = MyListBox.Value
    Case Else
End Select
End Sub