C# / .Net API Library Reference  4.3.2-74-ge1d4cca
Public Functions | Data Fields | Properties
PureWebMouseEventArgs Class Reference

The PureWebMouseEventArgs structure provides event arguments for mouse input events. PureWebMouseEventArgs objects are automatically generated whenever the end user interacts with a view on the client using a mouse.

About Mouse Event Filtering
Currently, client-side command filters are applied for mouse move and mouse wheel events. For mouse wheel events, the current instance delta will represent the cumulative delta of all the filtered wheel events in the list. The last element in the list, which corresponds to the current instance, will not have the cumulative delta value. Therefore, if an application needs to process the filtered list, it should ignore the current instance, and just process the events in the filtered list.

Public Functions

IList< PureWebMouseEventArgsGetFilteredEventsBySession (Guid sessionId)
 
Constructors and Destructors
 PureWebMouseEventArgs ()
 
 PureWebMouseEventArgs (Guid sessionId, string viewName)
 
 PureWebMouseEventArgs (string viewName)
 

Data Fields

MouseButtons Buttons
 
MouseButtons ChangedButton
 
double Delta
 
MouseEventType EventType
 
Modifiers Modifiers
 
double X
 
double Y
 

Properties

IList< PureWebMouseEventArgsFiltered [get, set]
 
bool Handled [get, set]
 
Guid SessionId [get]
 
String ViewName [get]
 

Usage Description

IList<PureWebMouseEventArgs> GetFilteredEventsBySession ( Guid  sessionId)
inline

Returns a list of filtered events, where the events in the list originate from the specified session. Will return null if the there are no filtered events.

Field Documentation

MouseButtons Buttons

Returns an enumeration of the mouse buttons (Left, Right, Middle, etc.) that were pressed during the event.

MouseButtons ChangedButton

Returns an enumeration of the mouse buttons (Left, Right, Middle, etc.) that were changed during the event.

double Delta

Returns a signed count of the number of detents the mouse wheel has rotated. A detent is one notch of the mouse wheel.

MouseEventType EventType

Returns the type of the mouse event that occurred, such as MouseUp, MouseDown or MouseWheel.

Returns an enumeration of any keyboard modifiers (Shift, Control, etc.) that were in effect at the time of the mouse event.

double X

Returns the X position of the mouse cursor when the event occurred, relative to the view client area.

double Y

Returns the Y position of the mouse cursor when the event occurred, relative to the view client area.

Property Documentation

IList<PureWebMouseEventArgs> Filtered
getset

Gets or sets the list of mouse events of the same type as the current instance that were filtered out of the message loop. Will be null if no events were filtered. A copy of the incoming list is made.

The current instance will also appear as the last element in the list, if it exists.

bool Handled
getsetinherited

Checks whether the event receiver has handled this event. Returns true if it has, otherwise returns false.

Guid SessionId
getinherited

Returns the content of the sessionID argument. Indicates in which session the input event occurred.

String ViewName
getinherited

Returns the content of the viewName argument. Indicates in which view the input event occurred.