menu

WPF

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class MouseControllerEventArgs - API Reference

    Show / Hide Table of Contents

    Class MouseControllerEventArgs

    Provides event data for mouse events dispatched from the MouseControllerDispatcher to IMouseController controllers.

    Inheritance
    System.Object
    System.EventArgs
    MouseControllerEventArgs
    Inherited Members
    System.EventArgs.Empty
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.Windows.Controls.Scroll
    Assembly: Syncfusion.GridCommon.Wpf.dll
    Syntax
    public class MouseControllerEventArgs : EventArgs

    Constructors

    MouseControllerEventArgs(MouseEventArgs, Boolean, Nullable<MouseButton>, Int32, Point, Double)

    Initializes a new instance of the MouseControllerEventArgs class.

    Declaration
    public MouseControllerEventArgs(MouseEventArgs sourceEventArgs, bool isPreviewEvent, MouseButton? button, int clicks, Point location, double delta)
    Parameters
    Type Name Description
    System.Windows.Input.MouseEventArgs sourceEventArgs

    The System.Windows.Input.MouseEventArgs instance containing the underlying mouse event data.

    System.Boolean isPreviewEvent

    if set to true this is a preview event.

    System.Nullable<System.Windows.Input.MouseButton> button

    The button.

    System.Int32 clicks

    The clicks.

    System.Windows.Point location

    The mouse location.

    System.Double delta

    The mouse-wheel delta.

    Properties

    Button

    Gets the mouse button that is pressed.

    Declaration
    public MouseButton? Button { get; }
    Property Value
    Type Description
    System.Nullable<System.Windows.Input.MouseButton>

    The mouse button or null if not pressed.

    CancelCaptureInfo

    Gets the cancel capture context.

    Declaration
    public ICaptureContext CancelCaptureInfo { get; }
    Property Value
    Type Description
    ICaptureContext

    The cancel capture context.

    ClickCount

    Gets the click count (1 - single click, 2 - double click)

    Declaration
    public int ClickCount { get; }
    Property Value
    Type Description
    System.Int32

    The click count.

    Delta

    Gets the mouse wheel delta.

    Declaration
    public double Delta { get; }
    Property Value
    Type Description
    System.Double

    The delta.

    DirectlyOverRenderer

    Gets the cell renderer that the child UIElement belongs to which is returned by MouseDevice.DirectlyOver property.

    Declaration
    public ICellRenderer DirectlyOverRenderer { get; }
    Property Value
    Type Description
    ICellRenderer

    The directly over renderer.

    Handled

    Gets or sets a value indicating whether this event is handled.

    Declaration
    public bool Handled { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if event is handled; otherwise, false.

    IsMouseOverChildElement

    Gets a value indicating whether the is mouse over child UIElement.

    Declaration
    public bool IsMouseOverChildElement { get; }
    Property Value
    Type Description
    System.Boolean

    true if this instance is mouse over a child element; otherwise, false.

    IsPreviewEvent

    Gets or sets a value indicating whether this event is a preview event.

    Declaration
    public bool IsPreviewEvent { get; }
    Property Value
    Type Description
    System.Boolean

    true if this event is a preview event; otherwise, false.

    IsTracking

    Gets a value indicating whether the mouse tracking feature is enabled.

    Declaration
    public bool IsTracking { get; }
    Property Value
    Type Description
    System.Boolean

    true if this instance is tracking; otherwise, false.

    Location

    Gets or sets the mouse location.

    Declaration
    public Point Location { get; }
    Property Value
    Type Description
    System.Windows.Point

    The location.

    SourceEventArgs

    Gets the System.Windows.Input.MouseEventArgs instance containing the underlying mouse event data.

    Declaration
    public MouseEventArgs SourceEventArgs { get; }
    Property Value
    Type Description
    System.Windows.Input.MouseEventArgs

    The source event args.

    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved