Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

PdfViewer.CursorMode Property

Gets or sets a value that specifies the interaction mode for keyboard and cursor.

Namespace: DevExpress.XtraPdfViewer

Assembly: DevExpress.XtraPdfViewer.v24.2.dll

NuGet Package: DevExpress.Win.PdfViewer

#Declaration

[DefaultValue(PdfCursorMode.SelectTool)]
public PdfCursorMode CursorMode { get; set; }

#Property Value

Type Default Description
PdfCursorMode SelectTool

A PdfCursorMode enumeration value.

Available values:

Name Description Example
SelectTool

This tool is used for navigation in a document. You can also select text and images in a document to copy using a keyboard and mouse.

select-cursor

HandTool

This tool is used for navigation. The end-user can browse the document by moving the mouse while pressing the left button.

PDF_Hand

MarqueeZoom

This tool is used to change the zoom level and navigate in a document. The end-user can increase the zoom level by simply clicking, decrease the zoom level by clicking while pressing the Ctrl key, or zoom in on a portion of a page by dragging the rectangle around it.

PDF_Marquee

Custom

The PDF Viewer does not handle mouse and keyboard events. You can handle these events to create your custom interaction tool. To change a cursor, use the PdfViewer.CursorMode property.

TextHighlightTool

Applies highlight formatting to text.

HighlightTextTool

TextStrikethroughTool

Applies strikethrough formatting to text.

HighlightTextTool

TextUnderlineTool

Applies underline formatting to text.

HighlightTextTool

StickyNoteTool

Creates text annotations (sticky notes).

cursor

FreeTextTool

Create a free text annotation (a text box).

cursor

CalloutTool

Create a callout (a combination of a text box and a pointer line to a specific location).

cursor

#Remarks

The PDF Viewer does not handle mouse and keyboard events. Set the CursorMode property to Custom and handle these events to create your custom interaction tool.

The code sample below shows how to handle the MouseMove event so that when the cursor hovers over the document’s surface, it appears as follows:

IMAGE

public partial class Form1 : RibbonForm
{
    Cursor currentCursor = null;

    //This property checks whether the cursor is located within the document's borders
    bool CursorIsOverPage { get { return pdfViewer.IsDocumentOpened && pdfViewer.GetDocumentPosition(pdfViewer.PointToClient(MousePosition), false) != null; } }

    public Form1()
    {
        InitializeComponent();
        pdfViewer.CursorMode = PdfCursorMode.Custom;
        pdfViewer.MouseMove += PdfViewer_MouseMove;
        currentCursor = pdfViewer.Cursor;

    }


    private void PdfViewer_MouseMove(object sender, MouseEventArgs e)
    {
        //Show the No cursor when it hovers over the document
        pdfViewer.Cursor = currentCursor != null && CursorIsOverPage ? Cursors.No : currentCursor;
    }
}

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CursorMode property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also