Class MouseSelectionHandler

This class handles the mouse selection in RadRichTextBox.

Inheritance
System.Object
MouseSelectionHandler
Namespace: Telerik.Windows.Documents.Selection
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public class MouseSelectionHandler : Object

Constructors

MouseSelectionHandler(RadDocument, IDocumentEditorPresenter)

Declaration
public MouseSelectionHandler(RadDocument document, IDocumentEditorPresenter presenter)
Parameters
RadDocument document

IDocumentEditorPresenter presenter

Fields

DoubleClickTime

This maximum time between click that is considered double click.

Declaration
public static double DoubleClickTime
Field Value
System.Double

MouseDoubleClickThreshold

The number of pixels that is acceptable for the mouse to move when doble clicking.

Declaration
public static int MouseDoubleClickThreshold
Field Value
System.Int32

MouseDragThreshold

The number of pixels that is considered a drag operation.

Declaration
public static int MouseDragThreshold
Field Value
System.Int32

Properties

DropPosition

Gets the drop position for the mouse selection handler.

Declaration
public DocumentPosition DropPosition { get; }
Property Value
DocumentPosition

IsClickSelecting

Gets a value indicating whether the current mouse selection is a click selection.

Declaration
public bool IsClickSelecting { get; }
Property Value
System.Boolean

IsDragging

Gets a value indicating whether the mouse is currently dragging a selection.

Declaration
public bool IsDragging { get; }
Property Value
System.Boolean

IsMoveSelectionDragging

Determines whether the selection is currently being dragged.

Declaration
public bool IsMoveSelectionDragging { get; }
Property Value
System.Boolean

IsTracking

Gets a value indicating whether the mouse selection handler is currently tracking mouse movements.

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

Methods

CancelSelection()

Cancels the current mouse selection, resetting any selected elements to their unselected state.

Declaration
public bool CancelSelection()
Returns
System.Boolean

Returns a boolean indicating whether the selection was successfully canceled.

HandleDocumentCaretPositionChanged(Boolean, Boolean)

Handles changes to the document caret position in response to user interactions.

Declaration
public void HandleDocumentCaretPositionChanged(bool ctrlPressed, bool shiftPressed)
Parameters
System.Boolean ctrlPressed

Indicates whether the Control key is presses
System.Boolean shiftPressed

Indicates whether the Shift key is pressed

OnSelectionDragged(SelectionDragEventArgs)

Declaration
protected virtual void OnSelectionDragged(SelectionDragEventArgs e)
Parameters
SelectionDragEventArgs e

RegisterDocumentMouseDown(Boolean, Boolean, Point, UIElement, SourceType)

Registers the mouse down event for a document, allowing for custom selection behavior.

Declaration
public virtual void RegisterDocumentMouseDown(bool ctrlPressed, bool shiftPressed, Point position, UIElement originalSource = null, SourceType source)
Parameters
System.Boolean ctrlPressed

Indicates if the Control key is pressed during the mouse down event.
System.Boolean shiftPressed

Indicates if the Shift key is pressed during the mouse down event.
System.Windows.Point position

The position of the mouse cursor when the mouse down event occurred.
System.Windows.UIElement originalSource

The UI element that is the target of the mouse down event.
SourceType source

The source type of the selection event.

RegisterDocumentMouseMove(Point, SourceType)

Registers a mouse move event for the document selection handler.

Declaration
public virtual void RegisterDocumentMouseMove(Point position, SourceType source)
Parameters
System.Windows.Point position

The point in the document where the mouse move event occurs.
SourceType source

The source type that indicates where the mouse move event originated from.

RegisterDocumentMouseRightButtonDown(UIElement, SourceType)

Registers the mouse right button down event for the specified UI element in the document selection.

Declaration
public virtual void RegisterDocumentMouseRightButtonDown(UIElement originalSource, SourceType source)
Parameters
System.Windows.UIElement originalSource

The UI element to which the mouse right button down event is registered.
SourceType source

The source type indicating the origin of the selection action.

RegisterDocumentMouseUp(SourceType, Nullable<Point>)

Registers a mouse up event handler for the document selection.

Declaration
public virtual void RegisterDocumentMouseUp(SourceType source, Nullable<Point> position = null)
Parameters
SourceType source

The type of source that triggered the mouse up event.
System.Nullable<System.Windows.Point> position

An optional point representing the location of the mouse up event.

RegisterDocumentMultipleMouseDown(Boolean, Boolean, Point)

Declaration
protected virtual void RegisterDocumentMultipleMouseDown(bool ctrlPressed, bool shiftPressed, Point position)
Parameters
System.Boolean ctrlPressed

System.Boolean shiftPressed

System.Windows.Point position

RegisterDocumentSingleMouseDown(Boolean, Boolean, Point, UIElement)

Declaration
protected virtual void RegisterDocumentSingleMouseDown(bool ctrlPressed, bool shiftPressed, Point position, UIElement originalSource)
Parameters
System.Boolean ctrlPressed

System.Boolean shiftPressed

System.Windows.Point position

System.Windows.UIElement originalSource

Events

SelectionDragged

Declaration
public event EventHandler<SelectionDragEventArgs> SelectionDragged
Event Type
System.EventHandler<SelectionDragEventArgs>

Extension Methods