bUnit bUnit
Search Results for

    Show / Hide Table of Contents

    Class MouseEventDispatchExtensions

    Mouse event dispatch helper extension methods.

    Inheritance
    System.Object
    MouseEventDispatchExtensions
    Namespace: Bunit
    Assembly: Bunit.Web.dll
    Syntax
    public static class MouseEventDispatchExtensions : object

    Methods

    | Improve this Doc View Source

    Click(IElement, MouseEventArgs)

    Raises the @onclick event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static void Click(this IElement element, MouseEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    MouseEventArgs eventArgs

    The event arguments to pass to the event handler.

    | Improve this Doc View Source

    Click(IElement, Int64, Double, Double, Double, Double, Int64, Int64, Boolean, Boolean, Boolean, Boolean, Nullable<String>)

    Raises the @onclick event on element, passing the provided properties to the event handler via a object.

    Declaration
    public static void Click(this IElement element, long detail = null, double screenX = null, double screenY = null, double clientX = null, double clientY = null, long button = null, long buttons = null, bool ctrlKey = null, bool shiftKey = null, bool altKey = null, bool metaKey = null, string? type = null)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    System.Int64 detail

    A count of consecutive clicks that happened in a short amount of time, incremented by one.

    System.Double screenX

    The X coordinate of the mouse pointer in global (screen) coordinates.

    System.Double screenY

    The Y coordinate of the mouse pointer in global (screen) coordinates.

    System.Double clientX

    The X coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Double clientY

    The Y coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Int64 button

    The button number that was pressed when the mouse event was fired: Left button=0, middle button=1 (if present), right button=2. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left.

    System.Int64 buttons

    The buttons being pressed when the mouse event was fired: Left button=1, Right button=2, Middle (wheel) button=4, 4th button (typically, "Browser Back" button)=8, 5th button (typically, "Browser Forward" button)=16. If two or more buttons are pressed, returns the logical sum of the values. E.g., if Left button and Right button are pressed, returns 3 (=1 | 2).

    System.Boolean ctrlKey

    true if the control key was down when the event was fired. false otherwise.

    System.Boolean shiftKey

    true if the shift key was down when the event was fired. false otherwise.

    System.Boolean altKey

    true if the alt key was down when the event was fired. false otherwise.

    System.Boolean metaKey

    true if the meta key was down when the event was fired. false otherwise.

    System.Nullable<System.String> type

    Gets or sets the type of the event.

    | Improve this Doc View Source

    ClickAsync(IElement, MouseEventArgs)

    Raises the @onclick event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static Task ClickAsync(this IElement element, MouseEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    MouseEventArgs eventArgs

    The event arguments to pass to the event handler.

    Returns
    Type Description
    Task

    A task that completes when the event handler is done.

    | Improve this Doc View Source

    ContextMenu(IElement, MouseEventArgs)

    Raises the @oncontextmenu event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static void ContextMenu(this IElement element, MouseEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    MouseEventArgs eventArgs

    The event arguments to pass to the event handler.

    | Improve this Doc View Source

    ContextMenu(IElement, Int64, Double, Double, Double, Double, Int64, Int64, Boolean, Boolean, Boolean, Boolean, Nullable<String>)

    Raises the @oncontextmenu event on element, passing the provided properties to the event handler via a object.

    Declaration
    public static void ContextMenu(this IElement element, long detail = null, double screenX = null, double screenY = null, double clientX = null, double clientY = null, long button = null, long buttons = null, bool ctrlKey = null, bool shiftKey = null, bool altKey = null, bool metaKey = null, string? type = null)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    System.Int64 detail

    A count of consecutive clicks that happened in a short amount of time, incremented by one.

    System.Double screenX

    The X coordinate of the mouse pointer in global (screen) coordinates.

    System.Double screenY

    The Y coordinate of the mouse pointer in global (screen) coordinates.

    System.Double clientX

    The X coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Double clientY

    The Y coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Int64 button

    The button number that was pressed when the mouse event was fired: Left button=0, middle button=1 (if present), right button=2. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left.

    System.Int64 buttons

    The buttons being pressed when the mouse event was fired: Left button=1, Right button=2, Middle (wheel) button=4, 4th button (typically, "Browser Back" button)=8, 5th button (typically, "Browser Forward" button)=16. If two or more buttons are pressed, returns the logical sum of the values. E.g., if Left button and Right button are pressed, returns 3 (=1 | 2).

    System.Boolean ctrlKey

    true if the control key was down when the event was fired. false otherwise.

    System.Boolean shiftKey

    true if the shift key was down when the event was fired. false otherwise.

    System.Boolean altKey

    true if the alt key was down when the event was fired. false otherwise.

    System.Boolean metaKey

    true if the meta key was down when the event was fired. false otherwise.

    System.Nullable<System.String> type

    Gets or sets the type of the event.

    | Improve this Doc View Source

    ContextMenuAsync(IElement, MouseEventArgs)

    Raises the @oncontextmenu event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static Task ContextMenuAsync(this IElement element, MouseEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    MouseEventArgs eventArgs

    The event arguments to pass to the event handler.

    Returns
    Type Description
    Task

    A task that completes when the event handler is done.

    | Improve this Doc View Source

    DoubleClick(IElement, MouseEventArgs)

    Raises the @ondblclick event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static void DoubleClick(this IElement element, MouseEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    MouseEventArgs eventArgs

    The event arguments to pass to the event handler.

    | Improve this Doc View Source

    DoubleClick(IElement, Int64, Double, Double, Double, Double, Int64, Int64, Boolean, Boolean, Boolean, Boolean, Nullable<String>)

    Raises the @ondblclick event on element, passing the provided properties to the event handler via a object.

    Declaration
    public static void DoubleClick(this IElement element, long detail = null, double screenX = null, double screenY = null, double clientX = null, double clientY = null, long button = null, long buttons = null, bool ctrlKey = null, bool shiftKey = null, bool altKey = null, bool metaKey = null, string? type = null)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    System.Int64 detail

    A count of consecutive clicks that happened in a short amount of time, incremented by one.

    System.Double screenX

    The X coordinate of the mouse pointer in global (screen) coordinates.

    System.Double screenY

    The Y coordinate of the mouse pointer in global (screen) coordinates.

    System.Double clientX

    The X coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Double clientY

    The Y coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Int64 button

    The button number that was pressed when the mouse event was fired: Left button=0, middle button=1 (if present), right button=2. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left.

    System.Int64 buttons

    The buttons being pressed when the mouse event was fired: Left button=1, Right button=2, Middle (wheel) button=4, 4th button (typically, "Browser Back" button)=8, 5th button (typically, "Browser Forward" button)=16. If two or more buttons are pressed, returns the logical sum of the values. E.g., if Left button and Right button are pressed, returns 3 (=1 | 2).

    System.Boolean ctrlKey

    true if the control key was down when the event was fired. false otherwise.

    System.Boolean shiftKey

    true if the shift key was down when the event was fired. false otherwise.

    System.Boolean altKey

    true if the alt key was down when the event was fired. false otherwise.

    System.Boolean metaKey

    true if the meta key was down when the event was fired. false otherwise.

    System.Nullable<System.String> type

    Gets or sets the type of the event.

    | Improve this Doc View Source

    DoubleClickAsync(IElement, MouseEventArgs)

    Raises the @ondblclick event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static Task DoubleClickAsync(this IElement element, MouseEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    MouseEventArgs eventArgs

    The event arguments to pass to the event handler.

    Returns
    Type Description
    Task

    A task that completes when the event handler is done.

    | Improve this Doc View Source

    MouseDown(IElement, MouseEventArgs)

    Raises the @onmousedown event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static void MouseDown(this IElement element, MouseEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    MouseEventArgs eventArgs

    The event arguments to pass to the event handler.

    | Improve this Doc View Source

    MouseDown(IElement, Int64, Double, Double, Double, Double, Int64, Int64, Boolean, Boolean, Boolean, Boolean, Nullable<String>)

    Raises the @onmousedown event on element, passing the provided properties to the event handler via a object.

    Declaration
    public static void MouseDown(this IElement element, long detail = null, double screenX = null, double screenY = null, double clientX = null, double clientY = null, long button = null, long buttons = null, bool ctrlKey = null, bool shiftKey = null, bool altKey = null, bool metaKey = null, string? type = null)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    System.Int64 detail

    A count of consecutive clicks that happened in a short amount of time, incremented by one.

    System.Double screenX

    The X coordinate of the mouse pointer in global (screen) coordinates.

    System.Double screenY

    The Y coordinate of the mouse pointer in global (screen) coordinates.

    System.Double clientX

    The X coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Double clientY

    The Y coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Int64 button

    The button number that was pressed when the mouse event was fired: Left button=0, middle button=1 (if present), right button=2. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left.

    System.Int64 buttons

    The buttons being pressed when the mouse event was fired: Left button=1, Right button=2, Middle (wheel) button=4, 4th button (typically, "Browser Back" button)=8, 5th button (typically, "Browser Forward" button)=16. If two or more buttons are pressed, returns the logical sum of the values. E.g., if Left button and Right button are pressed, returns 3 (=1 | 2).

    System.Boolean ctrlKey

    true if the control key was down when the event was fired. false otherwise.

    System.Boolean shiftKey

    true if the shift key was down when the event was fired. false otherwise.

    System.Boolean altKey

    true if the alt key was down when the event was fired. false otherwise.

    System.Boolean metaKey

    true if the meta key was down when the event was fired. false otherwise.

    System.Nullable<System.String> type

    Gets or sets the type of the event.

    | Improve this Doc View Source

    MouseDownAsync(IElement, MouseEventArgs)

    Raises the @onmousedown event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static Task MouseDownAsync(this IElement element, MouseEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    MouseEventArgs eventArgs

    The event arguments to pass to the event handler.

    Returns
    Type Description
    Task

    A task that completes when the event handler is done.

    | Improve this Doc View Source

    MouseMove(IElement, MouseEventArgs)

    Raises the @onmousemove event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static void MouseMove(this IElement element, MouseEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    MouseEventArgs eventArgs

    The event arguments to pass to the event handler.

    | Improve this Doc View Source

    MouseMove(IElement, Int64, Double, Double, Double, Double, Int64, Int64, Boolean, Boolean, Boolean, Boolean, Nullable<String>)

    Raises the @onmousemove event on element, passing the provided properties to the event handler via a object.

    Declaration
    public static void MouseMove(this IElement element, long detail = null, double screenX = null, double screenY = null, double clientX = null, double clientY = null, long button = null, long buttons = null, bool ctrlKey = null, bool shiftKey = null, bool altKey = null, bool metaKey = null, string? type = null)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    System.Int64 detail

    A count of consecutive clicks that happened in a short amount of time, incremented by one.

    System.Double screenX

    The X coordinate of the mouse pointer in global (screen) coordinates.

    System.Double screenY

    The Y coordinate of the mouse pointer in global (screen) coordinates.

    System.Double clientX

    The X coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Double clientY

    The Y coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Int64 button

    The button number that was pressed when the mouse event was fired: Left button=0, middle button=1 (if present), right button=2. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left.

    System.Int64 buttons

    The buttons being pressed when the mouse event was fired: Left button=1, Right button=2, Middle (wheel) button=4, 4th button (typically, "Browser Back" button)=8, 5th button (typically, "Browser Forward" button)=16. If two or more buttons are pressed, returns the logical sum of the values. E.g., if Left button and Right button are pressed, returns 3 (=1 | 2).

    System.Boolean ctrlKey

    true if the control key was down when the event was fired. false otherwise.

    System.Boolean shiftKey

    true if the shift key was down when the event was fired. false otherwise.

    System.Boolean altKey

    true if the alt key was down when the event was fired. false otherwise.

    System.Boolean metaKey

    true if the meta key was down when the event was fired. false otherwise.

    System.Nullable<System.String> type

    Gets or sets the type of the event.

    | Improve this Doc View Source

    MouseMoveAsync(IElement, MouseEventArgs)

    Raises the @onmousemove event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static Task MouseMoveAsync(this IElement element, MouseEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    MouseEventArgs eventArgs

    The event arguments to pass to the event handler.

    Returns
    Type Description
    Task

    A task that completes when the event handler is done.

    | Improve this Doc View Source

    MouseOut(IElement, MouseEventArgs)

    Raises the @onmouseout event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static void MouseOut(this IElement element, MouseEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    MouseEventArgs eventArgs

    The event arguments to pass to the event handler.

    | Improve this Doc View Source

    MouseOut(IElement, Int64, Double, Double, Double, Double, Int64, Int64, Boolean, Boolean, Boolean, Boolean, Nullable<String>)

    Raises the @onmouseout event on element, passing the provided properties to the event handler via a object.

    Declaration
    public static void MouseOut(this IElement element, long detail = null, double screenX = null, double screenY = null, double clientX = null, double clientY = null, long button = null, long buttons = null, bool ctrlKey = null, bool shiftKey = null, bool altKey = null, bool metaKey = null, string? type = null)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    System.Int64 detail

    A count of consecutive clicks that happened in a short amount of time, incremented by one.

    System.Double screenX

    The X coordinate of the mouse pointer in global (screen) coordinates.

    System.Double screenY

    The Y coordinate of the mouse pointer in global (screen) coordinates.

    System.Double clientX

    The X coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Double clientY

    The Y coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Int64 button

    The button number that was pressed when the mouse event was fired: Left button=0, middle button=1 (if present), right button=2. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left.

    System.Int64 buttons

    The buttons being pressed when the mouse event was fired: Left button=1, Right button=2, Middle (wheel) button=4, 4th button (typically, "Browser Back" button)=8, 5th button (typically, "Browser Forward" button)=16. If two or more buttons are pressed, returns the logical sum of the values. E.g., if Left button and Right button are pressed, returns 3 (=1 | 2).

    System.Boolean ctrlKey

    true if the control key was down when the event was fired. false otherwise.

    System.Boolean shiftKey

    true if the shift key was down when the event was fired. false otherwise.

    System.Boolean altKey

    true if the alt key was down when the event was fired. false otherwise.

    System.Boolean metaKey

    true if the meta key was down when the event was fired. false otherwise.

    System.Nullable<System.String> type

    Gets or sets the type of the event.

    | Improve this Doc View Source

    MouseOutAsync(IElement, MouseEventArgs)

    Raises the @onmouseout event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static Task MouseOutAsync(this IElement element, MouseEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    MouseEventArgs eventArgs

    The event arguments to pass to the event handler.

    Returns
    Type Description
    Task

    A task that completes when the event handler is done.

    | Improve this Doc View Source

    MouseOver(IElement, MouseEventArgs)

    Raises the @onmouseover event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static void MouseOver(this IElement element, MouseEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    MouseEventArgs eventArgs

    The event arguments to pass to the event handler.

    | Improve this Doc View Source

    MouseOver(IElement, Int64, Double, Double, Double, Double, Int64, Int64, Boolean, Boolean, Boolean, Boolean, Nullable<String>)

    Raises the @onmouseover event on element, passing the provided properties to the event handler via a object.

    Declaration
    public static void MouseOver(this IElement element, long detail = null, double screenX = null, double screenY = null, double clientX = null, double clientY = null, long button = null, long buttons = null, bool ctrlKey = null, bool shiftKey = null, bool altKey = null, bool metaKey = null, string? type = null)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    System.Int64 detail

    A count of consecutive clicks that happened in a short amount of time, incremented by one.

    System.Double screenX

    The X coordinate of the mouse pointer in global (screen) coordinates.

    System.Double screenY

    The Y coordinate of the mouse pointer in global (screen) coordinates.

    System.Double clientX

    The X coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Double clientY

    The Y coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Int64 button

    The button number that was pressed when the mouse event was fired: Left button=0, middle button=1 (if present), right button=2. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left.

    System.Int64 buttons

    The buttons being pressed when the mouse event was fired: Left button=1, Right button=2, Middle (wheel) button=4, 4th button (typically, "Browser Back" button)=8, 5th button (typically, "Browser Forward" button)=16. If two or more buttons are pressed, returns the logical sum of the values. E.g., if Left button and Right button are pressed, returns 3 (=1 | 2).

    System.Boolean ctrlKey

    true if the control key was down when the event was fired. false otherwise.

    System.Boolean shiftKey

    true if the shift key was down when the event was fired. false otherwise.

    System.Boolean altKey

    true if the alt key was down when the event was fired. false otherwise.

    System.Boolean metaKey

    true if the meta key was down when the event was fired. false otherwise.

    System.Nullable<System.String> type

    Gets or sets the type of the event.

    | Improve this Doc View Source

    MouseOverAsync(IElement, MouseEventArgs)

    Raises the @onmouseover event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static Task MouseOverAsync(this IElement element, MouseEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    MouseEventArgs eventArgs

    The event arguments to pass to the event handler.

    Returns
    Type Description
    Task

    A task that completes when the event handler is done.

    | Improve this Doc View Source

    MouseUp(IElement, MouseEventArgs)

    Raises the @onmouseup event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static void MouseUp(this IElement element, MouseEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    MouseEventArgs eventArgs

    The event arguments to pass to the event handler.

    | Improve this Doc View Source

    MouseUp(IElement, Int64, Double, Double, Double, Double, Int64, Int64, Boolean, Boolean, Boolean, Boolean, Nullable<String>)

    Raises the @onmouseup event on element, passing the provided properties to the event handler via a object.

    Declaration
    public static void MouseUp(this IElement element, long detail = null, double screenX = null, double screenY = null, double clientX = null, double clientY = null, long button = null, long buttons = null, bool ctrlKey = null, bool shiftKey = null, bool altKey = null, bool metaKey = null, string? type = null)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    System.Int64 detail

    A count of consecutive clicks that happened in a short amount of time, incremented by one.

    System.Double screenX

    The X coordinate of the mouse pointer in global (screen) coordinates.

    System.Double screenY

    The Y coordinate of the mouse pointer in global (screen) coordinates.

    System.Double clientX

    The X coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Double clientY

    The Y coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Int64 button

    The button number that was pressed when the mouse event was fired: Left button=0, middle button=1 (if present), right button=2. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left.

    System.Int64 buttons

    The buttons being pressed when the mouse event was fired: Left button=1, Right button=2, Middle (wheel) button=4, 4th button (typically, "Browser Back" button)=8, 5th button (typically, "Browser Forward" button)=16. If two or more buttons are pressed, returns the logical sum of the values. E.g., if Left button and Right button are pressed, returns 3 (=1 | 2).

    System.Boolean ctrlKey

    true if the control key was down when the event was fired. false otherwise.

    System.Boolean shiftKey

    true if the shift key was down when the event was fired. false otherwise.

    System.Boolean altKey

    true if the alt key was down when the event was fired. false otherwise.

    System.Boolean metaKey

    true if the meta key was down when the event was fired. false otherwise.

    System.Nullable<System.String> type

    Gets or sets the type of the event.

    | Improve this Doc View Source

    MouseUpAsync(IElement, MouseEventArgs)

    Raises the @onmouseup event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static Task MouseUpAsync(this IElement element, MouseEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    MouseEventArgs eventArgs

    The event arguments to pass to the event handler.

    Returns
    Type Description
    Task

    A task that completes when the event handler is done.

    | Improve this Doc View Source

    MouseWheel(IElement, Int64, Double, Double, Double, Double, Int64, Int64, Boolean, Boolean, Boolean, Boolean, Nullable<String>, Double, Double, Double, Int64)

    Raises the @onmousewheel event on element, passing the provided properties to the event handler via a object.

    Declaration
    public static void MouseWheel(this IElement element, long detail = null, double screenX = null, double screenY = null, double clientX = null, double clientY = null, long button = null, long buttons = null, bool ctrlKey = null, bool shiftKey = null, bool altKey = null, bool metaKey = null, string? type = null, double deltaX = null, double deltaY = null, double deltaZ = null, long deltaMode = null)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    System.Int64 detail

    A count of consecutive clicks that happened in a short amount of time, incremented by one.

    System.Double screenX

    The X coordinate of the mouse pointer in global (screen) coordinates.

    System.Double screenY

    The Y coordinate of the mouse pointer in global (screen) coordinates.

    System.Double clientX

    The X coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Double clientY

    The Y coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Int64 button

    The button number that was pressed when the mouse event was fired: Left button=0, middle button=1 (if present), right button=2. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left.

    System.Int64 buttons

    The buttons being pressed when the mouse event was fired: Left button=1, Right button=2, Middle (wheel) button=4, 4th button (typically, "Browser Back" button)=8, 5th button (typically, "Browser Forward" button)=16. If two or more buttons are pressed, returns the logical sum of the values. E.g., if Left button and Right button are pressed, returns 3 (=1 | 2).

    System.Boolean ctrlKey

    true if the control key was down when the event was fired. false otherwise.

    System.Boolean shiftKey

    true if the shift key was down when the event was fired. false otherwise.

    System.Boolean altKey

    true if the alt key was down when the event was fired. false otherwise.

    System.Boolean metaKey

    true if the meta key was down when the event was fired. false otherwise.

    System.Nullable<System.String> type

    Gets or sets the type of the event.

    System.Double deltaX

    The horizontal scroll amount.

    System.Double deltaY

    The vertical scroll amount.

    System.Double deltaZ

    The scroll amount for the z-axis.

    System.Int64 deltaMode

    The unit of the delta values scroll amount.

    | Improve this Doc View Source

    MouseWheel(IElement, WheelEventArgs)

    Raises the @onmousewheel event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static void MouseWheel(this IElement element, WheelEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    WheelEventArgs eventArgs

    The event arguments to pass to the event handler.

    | Improve this Doc View Source

    MouseWheelAsync(IElement, WheelEventArgs)

    Raises the @onmousewheel event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static Task MouseWheelAsync(this IElement element, WheelEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    WheelEventArgs eventArgs

    The event arguments to pass to the event handler.

    Returns
    Type Description
    Task

    A task that completes when the event handler is done.

    | Improve this Doc View Source

    Wheel(IElement, Int64, Double, Double, Double, Double, Int64, Int64, Boolean, Boolean, Boolean, Boolean, Nullable<String>, Double, Double, Double, Int64)

    Raises the @onwheel event on element, passing the provided properties to the event handler via a object.

    Declaration
    public static void Wheel(this IElement element, long detail = null, double screenX = null, double screenY = null, double clientX = null, double clientY = null, long button = null, long buttons = null, bool ctrlKey = null, bool shiftKey = null, bool altKey = null, bool metaKey = null, string? type = null, double deltaX = null, double deltaY = null, double deltaZ = null, long deltaMode = null)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    System.Int64 detail

    A count of consecutive clicks that happened in a short amount of time, incremented by one.

    System.Double screenX

    The X coordinate of the mouse pointer in global (screen) coordinates.

    System.Double screenY

    The Y coordinate of the mouse pointer in global (screen) coordinates.

    System.Double clientX

    The X coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Double clientY

    The Y coordinate of the mouse pointer in local (DOM content) coordinates.

    System.Int64 button

    The button number that was pressed when the mouse event was fired: Left button=0, middle button=1 (if present), right button=2. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left.

    System.Int64 buttons

    The buttons being pressed when the mouse event was fired: Left button=1, Right button=2, Middle (wheel) button=4, 4th button (typically, "Browser Back" button)=8, 5th button (typically, "Browser Forward" button)=16. If two or more buttons are pressed, returns the logical sum of the values. E.g., if Left button and Right button are pressed, returns 3 (=1 | 2).

    System.Boolean ctrlKey

    true if the control key was down when the event was fired. false otherwise.

    System.Boolean shiftKey

    true if the shift key was down when the event was fired. false otherwise.

    System.Boolean altKey

    true if the alt key was down when the event was fired. false otherwise.

    System.Boolean metaKey

    true if the meta key was down when the event was fired. false otherwise.

    System.Nullable<System.String> type

    Gets or sets the type of the event.

    System.Double deltaX

    The horizontal scroll amount.

    System.Double deltaY

    The vertical scroll amount.

    System.Double deltaZ

    The scroll amount for the z-axis.

    System.Int64 deltaMode

    The unit of the delta values scroll amount.

    | Improve this Doc View Source

    Wheel(IElement, WheelEventArgs)

    Raises the @onwheel event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static void Wheel(this IElement element, WheelEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    WheelEventArgs eventArgs

    The event arguments to pass to the event handler.

    | Improve this Doc View Source

    WheelAsync(IElement, WheelEventArgs)

    Raises the @onwheel event on element, passing the provided eventArgs to the event handler.

    Declaration
    public static Task WheelAsync(this IElement element, WheelEventArgs eventArgs)
    Parameters
    Type Name Description
    IElement element

    The element to raise the event on.

    WheelEventArgs eventArgs

    The event arguments to pass to the event handler.

    Returns
    Type Description
    Task

    A task that completes when the event handler is done.

    Premium sponsor: Progress Telerik.

    Editorial support provided by Packt.

    Supported by the .NET Foundation.

    • Improve this Doc
    • View Source
    Back to top Documentation updated on 06/27/2022 20:44:01 +00:00 in commit 9a81bc9b93.