WheelEvent Class

WheelEvent class

The WheelEvent interface provides specific contextual information associated with wheel events. To create an instance of the WheelEvent interface, use the WheelEvent constructor, passing an optional WheelEventInit dictionary.

public class WheelEvent : MouseEvent

Constructors

NameDescription
WheelEvent(string)Initializes a new instance of the WheelEvent class.
WheelEvent(string, IDictionary<string, object>)Initializes a new instance of the WheelEvent class.

Properties

NameDescription
AltKey { get; }Refer to the altKey attribute.
Bubbles { get; }Used to indicate whether or not an event is a bubbling event. If the event can bubble the value is true, else the value is false.
Button { get; }During mouse events caused by the depression or release of a mouse button, button MUST be used to indicate which pointer device button changed state.
Buttons { get; }During any mouse events, buttons MUST be used to indicate which combination of mouse buttons are currently being pressed, expressed as a bitmask.
Cancelable { get; }Used to indicate whether or not an event can have its default action prevented. If the default action can be prevented the value is true, else the value is false.
ClientX { get; }The horizontal coordinate at which the event occurred relative to the viewport associated with the event.
ClientY { get; }The vertical coordinate at which the event occurred relative to the viewport associated with the event.
CtrlKey { get; }Refer to the ctrlKey attribute.
CurrentTarget { get; }Used to indicate the IEventTarget whose IEventListeners are currently being processed. This is particularly useful during capturing and bubbling.
DefaultPrevented { get; }Returns true if preventDefault() was invoked while the cancelable attribute value is true, and false otherwise.
DeltaMode { get; }The deltaMode attribute contains an indication of the units of measurement for the delta values. The default value is DOM_DELTA_PIXEL (pixels).
DeltaX { get; }In user agents where the default action of the wheel event is to scroll, the value MUST be the measurement along the x-axis (in pixels, lines, or pages) to be scrolled in the case where the event is not cancelled. Otherwise, this is an implementation-specific measurement (in pixels, lines, or pages) of the movement of a wheel device around the x-axis.
DeltaY { get; }In user agents where the default action of the wheel event is to scroll, the value MUST be the measurement along the y-axis (in pixels, lines, or pages) to be scrolled in the case where the event is not cancelled. Otherwise, this is an implementation-specific measurement (in pixels, lines, or pages) of the movement of a wheel device around the y-axis.
DeltaZ { get; }In user agents where the default action of the wheel event is to scroll, the value MUST be the measurement along the z-axis (in pixels, lines, or pages) to be scrolled in the case where the event is not cancelled. Otherwise, this is an implementation-specific measurement (in pixels, lines, or pages) of the movement of a wheel device around the z-axis.
Detail { get; }Specifies some detail information about the Event, depending on the type of event.
EventPhase { get; }Used to indicate which phase of event flow is currently being evaluated.
IsTrusted { get; }The isTrusted attribute must return the value it was initialized to. When an event is created the attribute must be initialized to false.
MetaKey { get; }Refer to the metaKey attribute.
RelatedTarget { get; }Used to identify a secondary EventTarget related to a UI event, depending on the type of event.
ScreenX { get; }The horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system.
ScreenY { get; }The vertical coordinate at which the event occurred relative to the origin of the screen coordinate system.
ShiftKey { get; }Refer to the shiftKey attribute.
Target { get; }Used to indicate the IEventTarget to which the event was originally dispatched.
TimeStamp { get; }Used to specify the time (in milliseconds relative to the epoch) at which the event was created. Due to the fact that some systems may not provide this information the value of timeStamp may be not available for all events. When not available, a value of 0 will be returned. Examples of epoch time are the time of the system start or 0:0:0 UTC 1st January 1970.
Type { get; }The name of the event (case-insensitive). The name must be an XML name.
View { get; }The view attribute identifies the Window from which the event was generated. The un-initialized value of this attribute MUST be null.

Methods

NameDescription
virtual GetPlatformType()This method is used to retrieve ECMAScript object Type.
InitEvent(string, bool, bool)The InitEvent method is used to initialize the value of an Event created through the IDocumentEvent interface.
PreventDefault()If an event is cancelable, the PreventDefault method is used to signify that the event is to be canceled, meaning any default action normally taken by the implementation as a result of the event will not occur.
StopImmediatePropagation()Invoking this method prevents event from reaching any event listeners registered after the current one and when dispatched in a tree also prevents event from reaching any other objects.
StopPropagation()The StopPropagation method is used prevent further propagation of an event during event flow.

Fields

NameDescription
const DOM_DELTA_LINEThe units of measurement for the delta MUST be individual lines of text. This is the case for many form controls.
const DOM_DELTA_PAGEThe units of measurement for the delta MUST be pages, either defined as a single screen or as a demarcated page.
const DOM_DELTA_PIXELThe units of measurement for the delta MUST be pixels. This is the most typical case in most operating system and implementation configurations.

See Also