TXTextControl.ServerVisualization.UserInput.SendMouseWheel Method

Informs the view generator about a mouse wheel event.

Syntax

[C#]
public bool SendMouseWheel(System.Drawing.Point viewLocation, int delta, ServerVisualization.UserInput.MouseButtons button, ServerVisualization.UserInput.ModifierKeys modifierKeys);
[Visual Basic]
Public Function SendMouseWheel(ByVal viewLocation As System.Drawing.Point, ByVal delta As Integer, ByVal button As ServerVisualization.UserInput.MouseButtons, ByVal modifierKeys As ServerVisualization.UserInput.ModifierKeys) As Boolean
Parameter Description
viewLocation

Specifies the location, where the mouse wheel event occurs. The coordinates must be in pixels with an origin at the top-left corner of the view's location.

delta

Indicates the distance the wheel is rotated, expressed in multiples or divisions of 120. A positive value indicates that the wheel was rotated forward, away from the user; a negative value indicates that the wheel was rotated backward, toward the user.

button

Specifies a pressed mouse button. It can be a value from the ServerVisualization.UserInput.MouseButtons enumeration.

modifierKeys

Specifies modifier keys. It can be a combination of the ServerVisualization.UserInput.ModifierKeys values.

Return Value

If the event has been handled, the method returns true. Otherwise, it returns false.

See Also