Button Events

CNi

Function Group Button Events Functions    Prev page: OnValueChangedNext page: OnClick    
Function Group Declared in:
NiButtonEvents.h

'Overview' icon -- Shortcut to top of page. Overview

The Measurement Studio button control generates a variety of events in response to user input or changes in properties that are bound to a DataSocket source.

Complete the following steps to add an event handler for a particular event generated by the button control.

1. Edit a dialog resource and add a Measurement Studio button control to the dialog.

2. Right-click on the button control and select Events.

3. Select the appropriate event to handle and select Add and Edit. By default, this creates a new member function, which is named in the form shown below.

On[eventName][objectIdSuffix]

To help you find the appropriate online help, the components of the member function name are described below.

  • eventName is the event name.
  • objectIdSuffix is the last part of the ID assigned to the control.

For example, if you have a button control for which the ID is IDC_CWBUTTON1 and you want to add a handler for the Click event. The default member function name created by the ClassWizard is OnClickCwbutton1.

4. Click OK to add and edit the new event handler. Notice that the prototype of the member function matches the corresponding event listed below. You can select this link to get additional information regarding the event.

Note: Various button events pass COM VARIANT data types as parameters to the event handler. Measurement Studio includes the CNiVariant class, which provides a convenient interface for managing these VARIANT data types. Refer to the documentation for each event for further information.

'Functions' icon -- Shortcut to top of page. Functions

Global function void

OnClick()

Generated when you click the mouse on the control.
Global function void

OnCWBindingDataUpdated( short Index, LPDISPATCH Data, BOOL FAR* Ignore )

Generated when the binding data is updated.
Global function void

OnCWBindingStatusUpdated( short Index, long Status, long Error, LPCTSTR Message )

Generated when the status of the binding connection changes.
Global function void

OnDblClick()

Generated when you double-click the mouse on the control.
Global function void

OnKeyDown( short FAR* KeyCode, short Shift )

Generated when you press a key while the control has the input focus.
Global function void

OnKeyPress( short FAR* KeyAscii )

Generated when a KeyDown message generates a key while a control is active.
Global function void

OnKeyUp( short FAR* KeyCode, short Shift )

Generated when you release a key while the control has the input focus.
Global function void

OnMouseDown( short Button, short Shift, long x, long y )

Generated when you click the mouse on the control.
Global function void

OnMouseMove( short Button, short Shift, long x, long y )

Generated when you move the mouse over the control.
Global function void

OnMouseUp( short Button, short Shift, long x, long y )

Generated when you release the mouse on the control.
Global function void

OnReadyStateChange()

Generated when the ready state changes.
Global function void

OnValueChanged( BOOL Value )

Generated when the value of the button changes.