Syncfusion Wpf Pdf Viewer

Syncfusion WPF PDFViewer – UI Sample Generator

Generate C# Code for the User's Project (default)

Trigger keywords: "how to", "code sample", "show me", "example", "snippet", "integrate", "wpf PdfViewer", "create sample".

Purpose: Generate clean, ready-to-use C# and XAML code snippets that users can directly insert into their WPF applications when working with the Syncfusion WPF PdfViewer control.

Workflow: 1. Build the C# code using snippets provided in the references/*.md files. 2. Before generating the sample, ask the user whether the code should be inserted into an existing XAML file in their WPF project or created as a new WPF project application. 3. If the user chooses to create a new WPF project, ask them which target framework they want to use:

• .NET Framework (e.g. 4.6, 4.7, 4.8) — uses Syncfusion.PdfViewer.WPF and targets classic .NET Framework.
• .NET Core / .NET (e.g., .NET 8, .NET 10) — uses Syncfusion.PdfViewer.WPF with <TargetFramework>net8.0-windows</TargetFramework> (or the selected version).
• Based on the user's choice, generate the .csproj file with the correct <TargetFramework> value, and tailor any framework-specific code (e.g., namespace imports, NuGet package versions, startup code) accordingly.

4. XAML generation rules — MANDATORY: analyze the reference files BEFORE writing any XAML:

⚠️ STRICT RULE — NO EXCEPTIONS:

Open and read the relevant references/*.md file(s) for the requested feature before producing any XAML.

Ask yourself: "Does the reference file contain any XAML markup for this feature?"

- YES → XAML exists in reference → include only those exact XAML elements shown in the snippet.

- NO → reference is C# only → MainWindow.xaml MUST contain only <syncfusion:PdfViewerControl> inside a <Grid>. Stop. Do not add anything else.

Checklist to run before every XAML output:

• [ ] I have opened the relevant references/*.md file.
• [ ] I have confirmed whether it contains XAML or is C#-only.
• [ ] If C#-only: my XAML contains nothing beyond <syncfusion:PdfViewerControl x:Name="pdfViewer"/> inside <Grid>.
• [ ] If XAML exists in reference: I am copying only those elements — not inventing new ones.

Forbidden (when reference has no XAML): <Button>, <ComboBox>, <Slider>, <StackPanel>, <TextBlock>, <Grid.RowDefinitions>, or any UI element that does not appear verbatim in the reference snippet.

Known C#-only features (no XAML must be generated):

• Ink / shape / stamp / text / highlight annotations (annotation.md) — all settings are C# only.
• Magnifying / zoom level (magnifying.md) — C# only.
• Interaction mode (interaction-mode.md) — C# only.
• Text selection (text-selection.md) — C# only.
• PDF layers (pdf-layers.md) — C# only.
• Redaction (redaction.md) — C# only.
• Print (print.md) — C# only.
• Export image (export-image.md) — C# only.
• Saving PDF (saving-pdf-files.md) — C# only.

Known features that DO require XAML (sourced from references):

• Commands (commands.md): navigation/zoom/annotation/undo/redo/print/unload buttons use Command="{Binding ElementName=..., Path=...}".
• Toolbar items (toolbar-items.md): classic style requires Style="{StaticResource SyncfusionPdfViewerCustomControlStyle}" on <syncfusion:PdfViewerControl>.

All XAML additions must be placed inside the same <Grid> that hosts <syncfusion:PdfViewerControl>, using a <StackPanel> or <Grid> sub-layout only when the reference snippet implies it. 5. Add only the APIs required to satisfy the user's requested functionality. Do not include optional APIs, additional. 6. C# language version compatibility: When the target framework is .NET Framework (e.g., 4.6, 4.7, 4.8), the default C# language version is 7.3. The generated C# code MUST NOT use any C# 8.0+ language features. Specifically, do NOT use:

• Switch expressions (x switch { ... })
• Nullable reference types (string?, #nullable enable, object?)
• Default interface implementations
• Ranges and indices (^1, 1..^1)
• ??= null-coalescing assignment

Use if/else or traditional switch statements instead of switch expressions. Use regular null checks (if (x != null)) instead of nullable reference type syntax. ---

Code References

All templates and operation snippets live in references/*.md. Each file is a focused snippet or template the agent will combine when generating samples.

---

Prerequisites

1. Development Environment: Visual Studio 2022 or Visual Studio Insider 2026 (recommended for .NET 10). 2. NET Framework 4.5+ or .NET Core/.NET 8+ with WPF support. 3. Syncfusion WPF NuGet Packages: Syncfusion.PdfViewer.WPF

Theme NuGet Packages

To apply a built-in theme to the WPF PdfViewerControl using SfSkinManager, install the NuGet package that matches the desired theme:

Note: Install only the NuGet package corresponding to the theme the user wants to apply. Theme support requires Syncfusion.SfSkinManager.WPF, which is included as a dependency of the theme packages.

>

Refer to: Apply theme using SfSkinManager | WPF PdfViewer Theme

Documentations

WPF PdfViewer overview

Syncfusion WPF PDF Viewer (PdfViewerControl) Skill

Overview

Display, load, and interact with PDF documents in WPF using Syncfusion's PdfViewerControl — concise, paste-ready XAML/C# examples for loading PDFs, annotations, text search, toolbar customization, printing, form filling, and many other PDF tasks.

See [SKILL.md](SKILL.md) for the full intent-routing guide and rules.

---

Key Capabilities

• PDF Loading & Display: load from file path, stream, or PdfLoadedDocument; support for encrypted PDFs and MVVM binding via ItemSource.
• Annotations: ink, shapes (line, rectangle, circle, arrow, polygon, polyline), stamp, sticky note, free text, text callout, highlight, underline, strikethrough, squiggly, and file link annotations.
• Navigation & Interaction: page navigation, thumbnails, bookmarks, hyperlinks, zoom modes, and cursor interaction modes (Selection, Panning, Marquee Zoom).
• Text Operations: text search with highlight, text selection, and full text extraction with bounds.
• Forms & Signatures: AcroForm field management, FDF import/export, and handwritten signature support.
• Toolbar & UI Customization: show/hide toolbar items, disable specific buttons, customize context menus, and apply localization.
• Document Processing: print (silent and interactive), save PDF, export pages as images, import/export annotations (FDF/XFDF), page organize (rotate, reorder, remove), and redaction.
• Advanced Features: PDF layers, PDF coordinates/scroll offsets, rendering engine switching (PDFium/SfPdf), and text extraction engine switching.

---

Getting Started

How to Integrate the Skill

Step 1: Checkout and copy the required skill

Clone or download the PDF-Viewer-SDK-Skills repository and copy the wpf-pdfviewer-code-generator skill from the skills/ directory.

Step 2: Install the skill

Place the copied skill folder in your workspace following this structure:

your-workspace/
├── .github/skills/          # or .claude/skills/ or .codestudio/skills/
│   └── wpf-pdfviewer-code-generator/
│       └── SKILL.md
├── your-project-files...
└── MainWindow.xaml

Step 3: Verify and manage your skills

Type /skills in the GitHub Copilot or Code Studio chat to quickly access the Configure Skills menu and manage your installed skills.

Step 4: Use the skill in VS Code / Code Studio

There are two ways to use the skill:

1. Slash commands – Type / in the GitHub Copilot chat to see available skills. For example:

   /wpf-pdfviewer How do I load an encrypted PDF?

2. Automatic loading – Simply describe your task naturally, and the AI Agent automatically loads the relevant skill:

   Create a WPF window with PdfViewerControl that highlights text and exports annotations to XFDF

When the wpf-pdfviewer skill is loaded, the AI Agent provides focused XAML/C# snippets and commands for PdfViewerControl.

---

Prerequisites

1. Visual Studio 2022 or later (WPF workload installed) 2. .NET Framework 4.5+ or .NET Core / .NET 8+ with WPF support 3. Syncfusion License — register your key inside the MainWindow constructor:

   SyncfusionLicenseProvider.RegisterLicense("Your-License-Key");

Free license: Syncfusion Community License

NuGet Package

dotnet add package Syncfusion.PdfViewer.WPF

---

Example Prompts

Loading & Display

• "Show me how to load a PDF from a file path using PdfViewerControl."
• "Generate code to load a password-protected PDF and suppress the built-in password dialog."
• "Provide a MVVM example where ItemSource is bound to a ViewModel property."

Annotations

• "Generate C# to enable ink annotation mode with a green color and 5px thickness."
• "Show me how to add a custom stamp image programmatically at a specific page position."
• "Provide code to listen to TextMarkupAnnotationChanged events for highlight, underline, and strikethrough."
• "How do I lock all annotations so they can't be edited or deleted?"

Navigation & Zoom

• "Show code to navigate to a specific page and zoom to 150%."
• "How do I switch the cursor to Panning mode programmatically?"
• "Generate code to handle bookmark navigation events."

Text Search & Selection

• "Show me how to search for text in the PDF and highlight all matches."
• "Provide code to retrieve the selected text and its bounds from PdfViewerControl."

Toolbar & UI Customization

• "How do I hide the default toolbar and scrollbar?"
• "Show me how to collapse a specific toolbar button like the text search button."
• "Generate code to add a custom item to the PdfViewer context menu."

Printing & Saving

• "Show me how to silently print the PDF to a specific printer."
• "Generate code to save the PDF to a file path and handle the save completed event."

Forms & Signatures

• "How do I import form data from an FDF file into the viewer?"
• "Show me how to enable handwritten signature mode and flatten signatures on save."

Export & Extraction

• "Generate code to export page 2 as a PNG image."
• "Show me how to extract all text and bounds from every page of the loaded PDF."

Advanced

• "How do I switch the rendering engine to PDFium?"
• "Show me how to mark a region for redaction and apply it."
• "Provide code to rotate and reorder pages using the page organizer."

---

Reference Files

All code snippets used by the AI Agent are organized in the references/ folder:

---

Troubleshooting

---

Resources

• WPF PdfViewer Overview
• API Reference – PdfViewerControl

---

License

Syncfusion WPF PdfViewer requires a commercial license for production use. A free community license is available for qualifying organizations.

Annotations in WPF Pdf Viewer

Annotation support in the Syncfusion WPF PdfViewer allows users to add, edit, delete, and manage various annotation types including ink, shapes, stamp, sticky note, text, text callout, text markup, file link, and more using the AnnotationMode property and annotation-specific settings.

Hyperlink Annotations in WPF Pdf Viewer

Hyperlink annotations are embedded link annotations inside the PDF content, such as URLs or document links created while authoring the PDF. These are handled through the Annotation subsystem, not through page navigation APIs.

The pdfViewer.Annotation.HyperLink property provides access to the hyperlink annotation controller, allowing you to enable or disable hyperlink interactions programmatically.

Access the Hyperlink Annotation Controller

var hyperlink = pdfViewer.Annotation.HyperLink;

Enable Hyperlink Annotations

// Enable interaction with hyperlink annotations in the PDF
pdfViewer.Annotation.HyperLink.IsEnabled = true;

Enable Ink Annotation Mode and Configure Color, Opacity, Thickness, Author, and Subject Settings

pdfViewer.AnnotationMode = PdfDocumentView.PdfViewerAnnotationMode.Ink;
pdfViewer.InkAnnotationSettings.InkColor = Colors.Green;
pdfViewer.InkAnnotationSettings.Opacity = 0.5f;
pdfViewer.InkAnnotationSettings.Thickness = 5;
pdfViewer.InkAnnotationSettings.Author = "Author";
pdfViewer.InkAnnotationSettings.Subject = "Ink Annotation";

Switch to Ink Eraser Mode

pdfViewer.AnnotationMode = PdfDocumentView.PdfViewerAnnotationMode.InkEraser;

Handle Ink Annotation Changes Using InkAnnotationChanged Event

pdfViewer.InkAnnotationChanged += PdfViewer_InkAnnotationChanged;

private void PdfViewer_InkAnnotationChanged(object sender, InkAnnotationChangedEventArgs e)
{
    AnnotationChangedAction action = e.Action;
    int pageNumber = e.PageNumber;
    PdfViewerInkSettings settings = e.Settings;
    string author = settings.Author;
    float opacity = settings.Opacity;
    System.Windows.Media.Color color = settings.InkColor;
    double thickness = settings.Thickness;
}

Enable Shape Annotation Modes (Line,Rectangle,circle,polygon,polyline,Arrow) and Configure Color, Border Effect, Fill, and Line Style Settings

// Set annotation mode for desired shape
pdfViewer.AnnotationMode = PdfDocumentView.PdfViewerAnnotationMode.Line;
pdfViewer.LineAnnotationSettings.LineColor = Colors.Blue;
pdfViewer.LineAnnotationSettings.Opacity = 0.5f;
pdfViewer.LineAnnotationSettings.Thickness = 5;

pdfViewer.AnnotationMode = PdfDocumentView.PdfViewerAnnotationMode.Rectangle;
pdfViewer.RectangleAnnotationSettings.RectangleColor = Colors.Blue;
pdfViewer.RectangleAnnotationSettings.BorderEffect = BorderEffect.Cloudy;

pdfViewer.AnnotationMode = PdfDocumentView.PdfViewerAnnotationMode.Circle;
pdfViewer.CircleAnnotationSettings.CircleColor = Colors.Blue;

pdfViewer.AnnotationMode = PdfDocumentView.PdfViewerAnnotationMode.Polygon;
pdfViewer.PolygonAnnotationSettings.StrokeColor = Colors.Blue;
pdfViewer.PolygonAnnotationSettings.FillColor = Colors.Gray;
pdfViewer.PolygonAnnotationSettings.BorderEffect = BorderEffect.Cloudy;

pdfViewer.AnnotationMode = PdfDocumentView.PdfViewerAnnotationMode.Polyline;
pdfViewer.PolylineAnnotationSettings.StrokeColor = Colors.Blue;

pdfViewer.AnnotationMode = PdfDocumentView.PdfViewerAnnotationMode.Arrow;
pdfViewer.ArrowAnnotationSettings.StrokeColor = Colors.Blue;
pdfViewer.ArrowAnnotationSettings.FillColor = Colors.Blue;
pdfViewer.ArrowAnnotationSettings.BeginLineStyle = Syncfusion.Pdf.Interactive.PdfLineEndingStyle.OpenArrow;
pdfViewer.ArrowAnnotationSettings.EndLineStyle = Syncfusion.Pdf.Interactive.PdfLineEndingStyle.Diamond;

Detect Shape Annotation Add, Edit, or Delete Actions with Type and Settings via ShapeAnnotationChanged Event

pdfViewer.ShapeAnnotationChanged += PdfViewer_ShapeAnnotationChanged;

private void PdfViewer_ShapeAnnotationChanged(object sender, ShapeAnnotationChangedEventArgs e)
{
    AnnotationChangedAction action = e.Action;
    ShapeAnnotationType annotationType = e.Type;
    int pageNumber = e.PageNumber;
    ShapeAnnotationSettings settings = e.Settings;
    string author = settings.Author;
    float opacity = settings.Opacity;
    float thickness = settings.Thickness;
}

Enable Stamp Annotation Mode and Configure Icon, Opacity, Author, and Subject Settings

pdfViewer.AnnotationMode = PdfDocumentView.PdfViewerAnnotationMode.Stamp;
pdfViewer.StampAnnotationSettings.Opacity = 0.5f;
pdfViewer.StampAnnotationSettings.Icon = Syncfusion.Pdf.Interactive.PdfRubberStampAnnotationIcon.NotApproved;
pdfViewer.StampAnnotationSettings.Author = "Author";
pdfViewer.StampAnnotationSettings.Subject = "Stamp Annotation";

Add a Custom Image Stamp Programmatically with Position and Size

int pageNumber = 1;
Image image = new Image() { Source = new BitmapImage(new Uri(@"stamp.png", UriKind.RelativeOrAbsolute)) };
PdfStampAnnotation stamp = new PdfStampAnnotation(image);
System.Windows.Point position = new System.Windows.Point(100, 100);
// Actual size
pdfViewer.AddStamp(stamp, pageNumber, position);
// Desired size
System.Windows.Size stampSize = new System.Windows.Size(200, 200);
pdfViewer.AddStamp(stamp, pageNumber, position, stampSize);

Handle Stamp Annotation Changes Using StampAnnotationChanged Event

pdfViewer.StampAnnotationChanged += PdfViewer_StampAnnotationChanged;

private void PdfViewer_StampAnnotationChanged(object sender, StampAnnotationChangedEventArgs e)
{
    AnnotationChangedAction action = e.Action;
    int pageNumber = e.PageNumber;
    PdfViewerStampSettings settings = e.Settings;
    string author = settings.Author;
    float opacity = settings.Opacity;
    PdfRubberStampAnnotationIcon icon = settings.Icon;
}

Enable Sticky Note Annotation Mode and Configure Color, Icon, Opacity, Text, Author, and Subject Settings

pdfViewer.AnnotationMode = PdfDocumentView.PdfViewerAnnotationMode.StickyNote;
pdfViewer.StickyNoteAnnotationSettings.Color = Colors.Red;
pdfViewer.StickyNoteAnnotationSettings.Opacity = 0.5f;
pdfViewer.StickyNoteAnnotationSettings.Icon = Syncfusion.Pdf.Interactive.PdfPopupIcon.Key;
pdfViewer.StickyNoteAnnotationSettings.Text = "Sticky Note";
pdfViewer.StickyNoteAnnotationSettings.Author = "Author";
pdfViewer.StickyNoteAnnotationSettings.Subject = "Sticky Note Annotation";

Handle Sticky Note Annotation Changes Using StickyNoteAnnotationChanged Event

pdfViewer.StickyNoteAnnotationChanged += PdfViewer_StickyNoteAnnotationChanged;

private void PdfViewer_StickyNoteAnnotationChanged(object sender, StickyNoteAnnotationChangedEventArgs e)
{
    AnnotationChangedAction action = e.Action;
    int pageNumber = e.PageNumber;
    PdfViewerStickyNoteSettings settings = e.Settings;
    string author = settings.Author;
    float opacity = settings.Opacity;
    PdfPopupIcon icon = settings.Icon;
}

Enable FreeText Annotation Mode and Configure Background, Border Color, Font Color, Font Size, and Font Family Settings

pdfViewer.AnnotationMode = PdfDocumentView.PdfViewerAnnotationMode.FreeText;
pdfViewer.FreeTextAnnotationSettings.Background = Colors.White;
pdfViewer.FreeTextAnnotationSettings.BorderColor = Colors.Blue;
pdfViewer.FreeTextAnnotationSettings.FontColor = Colors.Black;
pdfViewer.FreeTextAnnotationSettings.Opacity = 0.5f;
pdfViewer.FreeTextAnnotationSettings.FontSize = 16;
pdfViewer.FreeTextAnnotationSettings.FontFamily = new System.Windows.Media.FontFamily("Arial");

Enable FreeText Callout Annotation Mode and Configure Intent and Callout Line Ending Style

pdfViewer.AnnotationMode = PdfDocumentView.PdfViewerAnnotationMode.FreeText;
pdfViewer.FreeTextAnnotationSettings.Intent = Syncfusion.Pdf.Interactive.PdfAnnotationIntent.FreeTextCallout;
pdfViewer.FreeTextAnnotationSettings.CalloutLineEndingStyle = Syncfusion.Pdf.Interactive.PdfLineEndingStyle.Diamond;

Handle FreeText and Callout Annotation Changes Using FreeTextAnnotationChanged Event

pdfViewer.FreeTextAnnotationChanged += PdfViewer_FreeTextAnnotationChanged;

private void PdfViewer_FreeTextAnnotationChanged(object sender, FreeTextAnnotationChangedEventArgs e)
{
    AnnotationChangedAction action = e.Action;
    int pageNumber = e.PageNumber;
    PdfViewerFreeTextSettings settings = e.Settings;
    string author = settings.Author;
    float opacity = settings.Opacity;
    System.Windows.Media.Color backgroundColor = settings.Background;
    System.Windows.Media.Color borderColor = settings.BorderColor;
    PdfAnnotationIntent calloutIntent = settings.Intent;
    PdfLineEndingStyle calloutEndStyle = settings.CalloutLineEndingStyle;
}

Enable Highlight Annotation Mode and Configure Color, Opacity, Author, and Subject Settings

pdfViewer.AnnotationMode = PdfDocumentView.PdfViewerAnnotationMode.Highlight;
pdfViewer.HighlightAnnotationSettings.HighlightColor = System.Windows.Media.Colors.Green;
pdfViewer.HighlightAnnotationSettings.Opacity = 0.5f;
pdfViewer.HighlightAnnotationSettings.Author = "Author";
pdfViewer.HighlightAnnotationSettings.Subject = "Highlight";

Enable Underline Annotation Mode and Configure Color, Opacity, Author, and Subject Settings

pdfViewer.AnnotationMode = PdfDocumentView.PdfViewerAnnotationMode.Underline;
pdfViewer.UnderlineAnnotationSettings.UnderlineColor = System.Windows.Media.Colors.Blue;
pdfViewer.UnderlineAnnotationSettings.Opacity = 0.5f;
pdfViewer.UnderlineAnnotationSettings.Author = "Author";
pdfViewer.UnderlineAnnotationSettings.Subject = "Underline";

Enable Strikethrough Annotation Mode and Configure Color, Opacity, Author, and Subject Settings

pdfViewer.AnnotationMode = PdfDocumentView.PdfViewerAnnotationMode.Strikethrough;
pdfViewer.StrikethroughAnnotationSettings.StrikethroughColor = System.Windows.Media.Colors.Blue;
pdfViewer.StrikethroughAnnotationSettings.Opacity = 0.5f;
pdfViewer.StrikethroughAnnotationSettings.Author = "Author";
pdfViewer.StrikethroughAnnotationSettings.Subject = "Strikethrough";

Enable Squiggly Annotation Mode and Configure Color, Opacity, Author, and Subject Settings

pdfViewer.AnnotationMode = PdfDocumentView.PdfViewerAnnotationMode.Squiggly;
pdfViewer.SquigglyAnnotationSettings.Color = System.Windows.Media.Colors.Blue;
pdfViewer.SquigglyAnnotationSettings.Opacity = 0.5f;
pdfViewer.SquigglyAnnotationSettings.Author = "Author";
pdfViewer.SquigglyAnnotationSettings.Subject = "Squiggly";

Handle Text Markup Annotation Changes Using TextMarkupAnnotationChanged Event

pdfViewer.TextMarkupAnnotationChanged += PdfViewer_TextMarkupAnnotationChanged;

private void PdfViewer_TextMarkupAnnotationChanged(object sender, TextMarkupAnnotationChangedEventArgs e)
{
    AnnotationChangedAction action = e.Action;
    int pageNumber = e.PageNumber;
    TextMarkupAnnotationType type = e.Type;
    TextMarkupAnnotationSettings settings = e.Settings;
    string author = settings.Author;
    float opacity = settings.Opacity;
}

Handle File Link Annotation Click to Retrieve File Path and Open Linked File

pdfViewer.FileLinkAnnotationClicked += PdfViewer_FileLinkAnnotationClicked;

private void PdfViewer_FileLinkAnnotationClicked(object sender, FileLinkAnnotationClickedEventArgs e)
{
    int pageNumber = e.PageNumber;
    RectangleF bounds = e.Bounds;
    FileLinkAnnotationSettings settings = e.Settings;
    string filePath = settings.FileName;
    // Open file externally
    System.Diagnostics.Process.Start(filePath);
}

Configure Comments Panel Visibility and Expansion State

// Expand the comments pane
pdfViewer.CommentSettings.IsExpanded = true;
// Hide the comments button in annotation toolbar
pdfViewer.CommentSettings.IsVisible = false;

Add an Ink Annotation Programmatically via PdfLoadedDocument

PdfLoadedDocument loadedDocument = pdfViewer.LoadedDocument;
List<float> inkPoints = new List<float> { 40, 300, 60, 100, 40, 50, 40, 300 };
RectangleF rectangle = new RectangleF(0, 0, 300, 400);
PdfInkAnnotation inkAnnotation = new PdfInkAnnotation(rectangle, inkPoints);
loadedDocument.Pages[0].Annotations.Add(inkAnnotation);

Select an Annotation Programmatically by Name, Page Number, or Bring Into View

// Select by name
bool isSelected = pdfViewer.SelectAnnotation(inkAnnotationName);
// Select at a specific page
bool isSelected = pdfViewer.SelectAnnotation(inkAnnotationName, 1);
// Select and bring into view
bool isSelected = pdfViewer.SelectAnnotation(inkAnnotationName, 1, true);

Hide or Show Annotations Programmatically by Name or Page Number

bool isHidden = pdfViewer.HideAnnotation(inkAnnotationName);
bool isShown = pdfViewer.ShowAnnotation(inkAnnotationName);
// By page
bool isHidden = pdfViewer.HideAnnotation(inkAnnotationName, 1);
bool isShown = pdfViewer.ShowAnnotation(inkAnnotationName, 1);

Delete Annotations Programmatically by Name or Page, or Clear All Annotations

bool isDeleted = pdfViewer.DeleteAnnotation(inkAnnotationName);
// By page
bool isDeleted = pdfViewer.DeleteAnnotation(inkAnnotationName, 1);
// Delete all
pdfViewer.ClearAllAnnotations();
// Delete all on a specific page
pdfViewer.ClearAllAnnotations(1);

Disable Annotation Selection Using AnnotationConstraints on DocumentLoaded

pdfViewer.DocumentLoaded += PdfViewer_DocumentLoaded;

private void PdfViewer_DocumentLoaded(object sender, EventArgs args)
{
    pdfViewer.FreeTextAnnotationSettings.Constraints = ~AnnotationConstraints.Selectable;
}

Set the Current User Name as Annotation Author Using the CurrentUser Property

pdfViewer.CurrentUser = "John";

Placeholders

• Replace "John" with the actual user name to set as the annotation author.

Change Annotation Selection Border Color

pdfViewer.SelectorSettings.StrokeColor = Color.FromArgb(255, 255, 0, 0);
pdfViewer.SelectorSettings.LockedStrokeColor = Color.FromArgb(255, 0, 255, 0);

Locking Annotations

// Lock via default settings
pdfViewer.InkAnnotationSettings.IsLocked = true;
pdfViewer.FreeTextAnnotationSettings.IsLocked = true;
pdfViewer.HighlightAnnotationSettings.IsLocked = true;
pdfViewer.UnderlineAnnotationSettings.IsLocked = true;
pdfViewer.StrikethroughAnnotationSettings.IsLocked = true;
pdfViewer.StickyNoteAnnotationSettings.IsLocked = true;
pdfViewer.StampAnnotationSettings.IsLocked = true;
pdfViewer.RectangleAnnotationSettings.IsLocked = true;
pdfViewer.CircleAnnotationSettings.IsLocked = true;
pdfViewer.LineAnnotationSettings.IsLocked = true;
pdfViewer.ArrowAnnotationSettings.IsLocked = true;
pdfViewer.PolygonAnnotationSettings.IsLocked = true;
pdfViewer.PolylineAnnotationSettings.IsLocked = true;

// Lock via annotation changed event
pdfViewer.StickyNoteAnnotationChanged += Pdfviewer_StickyNoteAnnotationChanged;

private void Pdfviewer_StickyNoteAnnotationChanged(object sender, StickyNoteAnnotationChangedEventArgs e)
{
    if (e.Action == AnnotationChangedAction.Add)
        e.Settings.IsLocked = true;
}

API Reference

Commands in WPF Pdf Viewer

The Syncfusion WPF PdfViewer provides built-in commands for page navigation, zoom, text search, annotations, undo/redo, print, save, and unload operations that can be bound directly to UI elements via XAML or executed in code-behind.

Navigate to First, Last, Previous, Next, and Specific Pages Using Button Click in XAML

<syncfusion:PdfViewerControl x:Name="pdfViewerControl" />
<Button Content="First Page" Command="{Binding ElementName=pdfViewerControl, Path=FirstPageCommand, Mode=OneWay}" />
<Button Content="Last Page" Command="{Binding ElementName=pdfViewerControl, Path=LastPageCommand, Mode=OneWay}" />
<Button Content="Previous Page" Command="{Binding ElementName=pdfViewerControl, Path=PreviousPageCommand, Mode=OneWay}" />
<Button Content="Next Page" Command="{Binding ElementName=pdfViewerControl, Path=NextPageCommand, Mode=OneWay}" />
<Button Content="Go to Page 2" Command="{Binding ElementName=pdfViewerControl, Path=GoToPageCommand, Mode=OneWay}" CommandParameter="2" />

Navigate to a Specific Page Using GoToPageCommandParameter in XAML

The GoToPageCommandParameter specifies the target page index for navigation.

<syncfusion:PdfViewerControl x:Name="pdfViewerControl" />
<Button Content="Go to Page 5"
        Command="{Binding ElementName=pdfViewerControl, Path=GoToPageCommand, Mode=OneWay}"
        CommandParameter="{Binding ElementName=pdfViewerControl, Path=GoToPageCommandParameter, Mode=

Navigate to the First Page Using FirstPageCommandParameter in XAML

The FirstPageCommandParameter can be used to pass an optional parameter while executing the FirstPageCommand.

<syncfusion:PdfViewerControl x:Name="pdfViewerControl" />
<Button Content="First Page"
        Command="{Binding ElementName=pdfViewerControl, Path=FirstPageCommand, Mode=OneWay}"
        CommandParameter="{Binding ElementName=pdfViewerControl, Path=FirstPageCommandParameter, Mode=OneWay}" />

Navigate to the Last Page Using LastPageCommandParameter in XAML

<syncfusion:PdfViewerControl x:Name="pdfViewerControl" />
<Button Content="Last Page"
        Command="{Binding ElementName=pdfViewerControl, Path=LastPageCommand, Mode=OneWay}"
        CommandParameter="{Binding ElementName=pdfViewerControl, Path=LastPageCommandParameter, Mode=OneWay}" />

Navigate to the Previous Page Using PreviousPageCommandParameter in XAML

<syncfusion:PdfViewerControl x:Name="pdfViewerControl" />
<Button Content="Previous Page"
        Command="{Binding ElementName=pdfViewerControl, Path=PreviousPageCommand, Mode=OneWay}"
        CommandParameter="{Binding ElementName=pdfViewerControl, Path=PreviousPageCommandParameter, Mode=OneWay}" />

Navigate to the Next Page Using NextPageCommandParameter in XAML

<syncfusion:PdfViewerControl x:Name="pdfViewerControl" />
<Button Content="Next Page"
        Command="{Binding ElementName=pdfViewerControl, Path=NextPageCommand, Mode=OneWay}"
        CommandParameter="{Binding ElementName=pdfViewerControl, Path=NextPageCommandParameter, Mode=OneWay}" />

Rotate Pages to a Specific Angle, Clockwise, or Counterclockwise Using Code-Behind

// Rotate page 6 to 180 degrees
pdfViewer.PageOrganizer.RotatePagesCommand.Execute(new object[] { new int[] { 5 }, PdfPageRotateAngle.RotateAngle180 });

// Rotate pages 1 and 2 clockwise by 90 degrees
pdfViewer.PageOrganizer.RotatePagesClockwiseCommand.Execute(new int[] { 0, 1 });

// Rotate pages 1 and 2 counterclockwise by 90 degrees
pdfViewer.PageOrganizer.RotatePagesCounterclockwiseCommand.Execute(new int[] { 0, 1 });

Remove a Specific Page by Zero-Based Index Using Code-Behind

// Remove the 3rd page
pdfViewer.PageOrganizer.RemovePagesCommand.Execute(new int[] { 2 });

Placeholders

• Replace 2 with the zero-based index of the page to remove.

Zoom In and Zoom Out Using Button Click in XAML

<syncfusion:PdfViewerControl x:Name="pdfViewerControl" />
<Button Content="Zoom In" Command="{Binding ElementName=pdfViewerControl, Path=IncreaseZoomCommand, Mode=OneWay}" />
<Button Content="Zoom Out" Command="{Binding ElementName=pdfViewerControl, Path=DecreaseZoomCommand, Mode=OneWay}" />

Increase Zoom Level Using IncreaseZoomCommandParameter in XAML

<syncfusion:PdfViewerControl x:Name="pdfViewerControl" />
<Button Content="Zoom In"
        Command="{Binding ElementName=pdfViewerControl, Path=IncreaseZoomCommand, Mode=OneWay}"
        CommandParameter="{Binding ElementName=pdfViewerControl, Path=Increase

Decrease Zoom Level Using DecreaseZoomCommandParameter in XAML

The DecreaseZoomCommandParameter allows an optional parameter to be supplied when executing DecreaseZoomCommand.

<syncfusion:PdfViewerControl x:Name="pdfViewerControl" />
<Button Content="Zoom Out"
        Command="{Binding ElementName=pdfViewerControl, Path=DecreaseZoomCommand, Mode=OneWay}"
        CommandParameter="{Binding ElementName=pdfViewerControl, Path=DecreaseZoomCommandParameter, Mode=OneWay}" />

Search Next and Previous Occurrences of a Keyword Using Button Click in XAML

<syncfusion:PdfViewerControl x:Name="PdfViewer" />
<Button Content="Search Next" Command="{Binding ElementName=PdfViewer, Path=SearchNextCommand, Mode=OneWay}" CommandParameter="keyword" />
<Button Content="Search Previous" Command="{Binding ElementName=PdfViewer, Path=SearchPreviousCommand, Mode=OneWay}" CommandParameter="keyword" />

Placeholders

• Replace keyword with the text to search.

Search Using SearchNextCommandParameter and SearchPreviousCommandParameter in XAML

<syncfusion:PdfViewerControl x:Name="PdfViewer" />
<Button Content="Search Next"
        Command="{Binding ElementName=PdfViewer, Path=SearchNextCommand, Mode=OneWay}"
        CommandParameter="{Binding ElementName=PdfViewer, Path=SearchNextCommandParameter, Mode=OneWay}" />

<Button Content="Search Previous"
        Command="{Binding ElementName=PdfViewer, Path=SearchPreviousCommand, Mode=OneWay}"
        CommandParameter="{Binding ElementName=PdfViewer, Path=SearchPreviousCommandParameter, Mode=OneWay}" />

Enable Highlight, Underline, Strikethrough, Shape, and Ink Annotation Modes Using Button Click in XAML

<syncfusion:PdfViewerControl x:Name="pdfViewerControl" />
<Button Content="Highlight" CommandParameter="Highlight" Command="{Binding ElementName=pdfViewerControl, Path=AnnotationCommand, Mode=OneWay}" />
<Button Content="Underline" CommandParameter="Underline" Command="{Binding ElementName=pdfViewerControl, Path=AnnotationCommand, Mode=OneWay}" />
<Button Content="Strikethrough" CommandParameter="Strikethrough" Command="{Binding ElementName=pdfViewerControl, Path=AnnotationCommand, Mode=OneWay}" />
<Button Content="Line" CommandParameter="Line" Command="{Binding ElementName=pdfViewerControl, Path=AnnotationCommand, Mode=OneWay}" />
<Button Content="Rectangle" CommandParameter="Rectangle" Command="{Binding ElementName=pdfViewerControl, Path=AnnotationCommand, Mode=OneWay}" />
<Button Content="Circle" CommandParameter="Circle" Command="{Binding ElementName=pdfViewerControl, Path=AnnotationCommand, Mode=OneWay}" />
<Button Content="Arrow" CommandParameter="Arrow" Command="{Binding ElementName=pdfViewerControl, Path=AnnotationCommand, Mode=OneWay}" />
<Button Content="Ink" CommandParameter="Ink" Command="{Binding ElementName=pdfViewerControl, Path=AnnotationCommand, Mode=OneWay}" />

Set Annotation Mode Using AnnotationCommandParameter in XAML

<syncfusion:PdfViewerControl x:Name="pdfViewerControl" />
<Button Content="Rectangle"
        Command="{Binding ElementName=pdfViewerControl, Path=AnnotationCommand, Mode=OneWay}"
        CommandParameter="{Binding ElementName=pdfViewerControl, Path=AnnotationCommandParameter, Mode=OneWay}" />

Undo and Redo the Last Annotation Action Using Button Click in XAML

<syncfusion:PdfViewerControl x:Name="PdfViewer" />
<Button Content="Undo" Command="{Binding ElementName=PdfViewer, Path=UndoCommand, Mode=OneWay}" />
<Button Content="Redo" Command="{Binding ElementName=PdfViewer, Path=RedoCommand, Mode=OneWay}" />

Disable Undo and Redo Functionality by Setting the History Limit to Zero

pdfViewer.UndoRedoSettings.Limit = 0;

Undo and Redo Operations Using UndoRedoSettings (Code-Behind)

The UndoRedoSettings property of the WPF PdfViewer provides APIs to undo and redo user actions.

Undo and redo actions should always be performed only after checking their availability using CanUndo and CanRedo.

Undo the Most Recent Action Safely

Use CanUndo to determine whether an undo operation is possible before calling PerformUndo().

if (pdfViewer.UndoRedoSettings.CanUndo)
{
    pdfViewer.UndoRedoSettings.PerformUndo();
}

Redo the Most Recently Undone Action Safely

Use CanRedo to determine whether a redo operation is possible before calling PerformRedo().

if (pdfViewer.UndoRedoSettings.CanRedo)
{
    pdfViewer.UndoRedoSettings.PerformRedo();
}

Open the System Print Dialog Using Button Click in XAML

The print command opens the system print dialog, allowing the user to select a printer and configure print settings before sending the document to the printer. It can be bound to a button or menu item directly in XAML using standard WPF command binding. No additional parameters are required — invoking PrintCommand is sufficient to trigger the full print workflow. This command is useful for building custom toolbars where the built-in toolbar is hidden but printing functionality must still be exposed.

<syncfusion:PdfViewerControl x:Name="pdfViewerControl" />
<Button Content="Print" Command="{Binding ElementName=pdfViewerControl, Path=PrintCommand, Mode=OneWay}" />

Open Print Dialog Using PrintCommandParameter in XAML

<syncfusion:PdfViewerControl x:Name="pdfViewerControl" />
<Button Content="Print"
        Command="{Binding ElementName=pdfViewerControl, Path=PrintCommand, Mode=OneWay}"
        CommandParameter="{Binding ElementName=pdfViewerControl, Path=PrintCommandParameter, Mode=OneWay}" />

Save the Current PDF with Annotations and Form Data to a File Path Using Code-Behind

The save document command writes the current state of the loaded PDF — including any annotations, form field values, or page-level changes — to a file on disk. The target file path is passed directly as the command parameter when executing SaveDocumentCommand in code-behind. This is particularly important after annotation work, since all annotation types (ink, shape, text markup, stamp, sticky note, free text, etc.) are persisted into the saved file. If the path points to the same file that was loaded, the document is saved in-place; otherwise, a new file is created at the specified location.

pdfViewerControl.SaveDocumentCommand.Execute(@"C:\Output.pdf");

Placeholders

• Replace C:\Output.pdf with the desired output file path.

Unload the Current PDF Document and Free Resources Using Button Click in XAML

The unload command releases the currently loaded PDF document from the viewer, clearing the display and freeing associated resources. It can be bound to a button in XAML and requires no command parameter. Unloading a document is useful when the user switches between files, closes a document explicitly, or when the application needs to free memory before loading a new PDF. After unloading, any unsaved annotation changes or edits will be lost, so it is good practice to invoke SaveDocumentCommand first if persistence is required.

<syncfusion:PdfViewerControl x:Name="PdfViewer" />
<Button Content="Unload" Command="{Binding ElementName=PdfViewer, Path=UnloadCommand, Mode=OneWay}" />

API Reference for All Commands, Properties, and Binding Patterns

The table below summarizes every command and related property covered in this document. Commands are bindable via XAML Command / CommandParameter attributes or executable in code-behind using the .Execute() method. Properties under settings objects (e.g., UndoRedoSettings.Limit) must be set in code-behind before or after the relevant operation.

Customize Context Menu in WPF Pdf Viewer

The Syncfusion WPF PdfViewer supports customization of the default context menu items for Annotation, Text Selection, Redaction, and Signature Field using ContextMenuOpening and ContextMenuItemClickedEvent events.

Wire Context Menu Opening and Item Clicked Events to Handle and Customize the Context Menu Using Code-Behind

pdfViewer.ContextMenuOpening += PdfViewer_ContextMenuOpening;
pdfViewer.ContextMenuItemClickedEvent += PdfViewer_ContextMenuItemClickedEvent;

Add a Custom Menu Item to the Annotation, Redaction, Text Selection, or Signature Field Context Menu Using Code-Behind

private void PdfViewer_ContextMenuOpening(object sender, ContextMenuOpeningEventArgs e)
{
    if (e.Source == "Annotation")
    {
        e.MenuItems.Insert(0, new ContextMenuItem { Content = "Lock Annotation" });
        e.MenuItems.Add(new ContextMenuItem { Content = "New Menu Item" });
    }
    if (e.Source == "Redaction")
        e.MenuItems.Add(new ContextMenuItem { Content = "New Menu Item" });

    if (e.Source == "Text Selection")
        e.MenuItems.Add(new ContextMenuItem { Content = "New Menu Item" });

    if (e.Source == "Signature Field")
        e.MenuItems.Add(new ContextMenuItem { Content = "New Menu Item" });
}

Remove an Existing Menu Item from the Annotation or Text Selection Context Menu by Content Name Using Code-Behind

private void PdfViewer_ContextMenuOpening(object sender, ContextMenuOpeningEventArgs e)
{
    if (e.Source == "Annotation")
    {
        var item = e.MenuItems.FirstOrDefault(i => i.Content == "Delete");
        if (item != null) e.MenuItems.Remove(item);
    }
    if (e.Source == "Text Selection")
    {
        var item = e.MenuItems.FirstOrDefault(i => i.Content == "Copy");
        if (item != null) e.MenuItems.Remove(item);
    }
}

Hide the Context Menu for Annotation, Redaction, Text Selection, or Signature Field by Setting Handled to True Using Code-Behind

private void PdfViewer_ContextMenuOpening(object sender, ContextMenuOpeningEventArgs e)
{
    if (e.Source == "Annotation")
        e.Handled = true;

    if (e.Source == "Redaction")
        e.Handled = true;

    if (e.Source == "Text Selection")
        e.Handled = true;

    if (e.Source == "Signature Field")
        e.Handled = true;
}

Handle Context Menu Item Click and Suppress the Default Action to Retrieve Clicked Item Details Using Code-Behind

private void PdfViewer_ContextMenuItemClickedEvent(object sender, ContextMenuItemClickedEventArgs e)
{
    // Suppress default action
    e.Handled = true;

    // Retrieve clicked item details
    MessageBox.Show($"Source: {e.Source}\nClicked Item: {e.MenuItem.Content}");
}

API Reference for All Context Menu Events, Event Arguments, and Properties

Exporting PDF Pages as Images in WPF Pdf Viewer

The Syncfusion WPF PdfViewer supports exporting PDF pages as images (JPG, PNG, TIFF, BMP) via the ExportAsImage API.

---

Export a Single PDF Page as a JPEG, PNG, TIFF, or BMP Image Using ExportAsImage in Code-Behind

Exports a single PDF page to a BitmapSource by passing the zero-based page index to ExportAsImage.

PdfViewerControl pdfViewer = new PdfViewerControl();

// Load the input PDF file.
PdfLoadedDocument loadedDocument = new PdfLoadedDocument("Sample.pdf");
pdfViewer.Load(loadedDocument);

// Export the page at index 0 as a BitmapSource.
BitmapSource image = pdfViewer.ExportAsImage(0);

string output = @"..\..\Output\Image";
if (image != null)
{
    // Initialize a JPEG encoder.
    BitmapEncoder encoder = new JpegBitmapEncoder();
    encoder.Frames.Add(BitmapFrame.Create(image));

    // Save the image to the output path.
    FileStream stream = new FileStream(output + ".Jpeg", FileMode.Create);
    encoder.Save(stream);
}

loadedDocument.Dispose();
loadedDocument = null;

Placeholders

• Replace Sample.pdf with the actual PDF file path.
• Replace output path with the desired output directory.
• Swap JpegBitmapEncoder with PngBitmapEncoder, TiffBitmapEncoder, or BmpBitmapEncoder to export in PNG, TIFF, or BMP format respectively.

---

Export a Contiguous Range of PDF Pages as Images into a BitmapSource Array Using ExportAsImage in Code-Behind

Exports a contiguous range of PDF pages to a BitmapSource[] array by passing the start and end page indexes to ExportAsImage.

PdfViewerControl pdfViewer = new PdfViewerControl();

// Load the input PDF file.
PdfLoadedDocument loadedDocument = new PdfLoadedDocument("Sample.pdf");
pdfViewer.Load(loadedDocument);

// Export all pages as images.
BitmapSource[] images = pdfViewer.ExportAsImage(0, loadedDocument.Pages.Count - 1);

string output = @"..\..\Output\Image";
if (images != null)
{
    for (int i = 0; i < images.Length; i++)
    {
        BitmapEncoder encoder = new JpegBitmapEncoder();
        encoder.Frames.Add(BitmapFrame.Create(images[i]));

        FileStream stream = new FileStream(output + i.ToString() + ".Jpeg", FileMode.Create);
        encoder.Save(stream);
    }
}

loadedDocument.Dispose();
loadedDocument = null;

Placeholders

• Replace Sample.pdf with the actual PDF file path.
• Replace output path with the desired output directory.
• Adjust the start/end page indexes to export only a subset of pages.

---

Export a Single PDF Page as an Image at a Custom Pixel Width and Height with Optional Aspect Ratio Preservation Using ExportAsImage in Code-Behind

Exports a single PDF page as an image at a specified pixel width and height by passing a SizeF to ExportAsImage. Set keepAspectRatio to true to preserve the original page proportions.

// Export page at index 0 with a custom size of 1836 x 2372 pixels.
BitmapSource image = pdfViewer.ExportAsImage(0, new SizeF(1836, 2372), false);

string output = @"..\..\Output\Image";
if (image != null)
{
    BitmapEncoder encoder = new JpegBitmapEncoder();
    encoder.Frames.Add(BitmapFrame.Create(image));

    FileStream stream = new FileStream(output + ".Jpeg", FileMode.Create);
    encoder.Save(stream);
}

Placeholders

• Replace the SizeF values with the required width and height in pixels.
• Pass true as the third argument to maintain the aspect ratio of the output image.

---

Export a Range of PDF Pages as Images at a Custom Horizontal and Vertical DPI Resolution Using ExportAsImage in Code-Behind

Exports a range of PDF pages as images at a specified horizontal (DpiX) and vertical (DpiY) resolution using ExportAsImage.

int startPageIndex = 0;
int endPageIndex = 3;
float dpiX = 200;
float dpiY = 200;

BitmapSource[] images = pdfViewer.ExportAsImage(startPageIndex, endPageIndex, dpiX, dpiY);

string output = @"..\..\Output\Image";
if (images != null)
{
    for (int i = 0; i < images.Length; i++)
    {
        BitmapEncoder encoder = new JpegBitmapEncoder();
        encoder.Frames.Add(BitmapFrame.Create(images[i]));

        FileStream stream = new FileStream(output + i.ToString() + ".Jpeg", FileMode.Create);
        encoder.Save(stream);
    }
}

Placeholders

• Adjust startPageIndex and endPageIndex to the desired page range.
• Replace dpiX and dpiY with the required resolution values.

Export a Single PDF Page as an Image with Transparency Control

Exports a single PDF page to a BitmapSource while optionally preserving transparency.

BitmapSource image = pdfViewer.ExportAsImage(0, true);

Export a Range of PDF Pages as Images with Transparency Control

Exports a contiguous range of pages as a BitmapSource[].

BitmapSource[] images = pdfViewer.ExportAsImage(0, 3, true);

Export a Single PDF Page with Custom Size, DPI, and Aspect Ratio

Exports a single page with full control over image size, resolution, aspect ratio, and transparency.

BitmapSource image = pdfViewer.ExportAsImage(
    pageIndex: 0,
    customSize: new SizeF(1836, 2372),
    dpiX: 300f,
    dpiY: 300f,
    keepAspectRatio: true,
    keepTransparency: false
);

Export a Range of PDF Pages with Custom DPI

BitmapSource[] images = pdfViewer.ExportAsImage(
    startIndex: 0,
    endIndex: 2,
    dpiX: 200f,
    dpiY: 200f,
    keepTransparency: true
);

Extract Text from PDF Files in WPF Pdf Viewer

The Syncfusion WPF PdfViewer allows you to extract text from a specific page or the entire PDF file using the ExtractText method of PdfDocumentView. Text can also be retrieved with line and word bounds via TextLines and TextLine.

Extract Text from a Particular Page by Passing a Zero-Based Page Index Using ExtractText

Extracts text from a single page by passing the zero-based page index to ExtractText.

PdfDocumentView pdfDocumentView = new PdfDocumentView();
pdfDocumentView.Load(@"Sample.pdf");

TextLines textLines = new TextLines();
string extractedText = pdfDocumentView.ExtractText(0, out textLines);

Placeholders

• Replace Sample.pdf with the actual PDF file path.
• Change 0 to the required zero-based page index.

Extract Text from an Entire PDF File by Iterating All Pages Using PageCount and ExtractText

Iterates over all pages using PageCount and concatenates the extracted text from each page.

PdfDocumentView pdfDocumentView = new PdfDocumentView();
pdfDocumentView.Load(@"Sample.pdf");

TextLines textLines = new TextLines();
string extractedText = string.Empty;
for (int i = 0; i < pdfDocumentView.PageCount; i++)
{
    extractedText += pdfDocumentView.ExtractText(i, out textLines);
}

Placeholders

• Replace Sample.pdf with the actual PDF file path.

Extract Text with Line Bounds and Bounding Rectangles Using TextLines Output from ExtractText

Retrieves text line by line along with each line's bounding rectangle using the TextLines output from ExtractText.

PdfDocumentView pdfDocumentView = new PdfDocumentView();
pdfDocumentView.Load(@"Sample.pdf");

TextLines textLines = new TextLines();
pdfDocumentView.ExtractText(0, out textLines);

TextLine line = textLines[0];
string text = line.Text;
RectangleF lineBounds = line.Bounds;

Placeholders

• Replace Sample.pdf with the actual PDF file path.
• Change 0 in ExtractText to the required page index.
• Change textLines[0] to access a different line.

Extract Text with Word Bounds and Bounding Rectangles Using WordCollection Property of TextLine

Retrieves individual words within a line along with each word's bounding rectangle using the WordCollection property of TextLine.

PdfDocumentView pdfDocumentView = new PdfDocumentView();
pdfDocumentView.Load(@"Sample.pdf");

TextLines textLines = new TextLines();
pdfDocumentView.ExtractText(0, out textLines);

TextLine line = textLines[0];
List<TextWord> wordCollection = line.WordCollection;
string word = wordCollection[0].Text;
RectangleF bounds = wordCollection[0].Bounds;

Placeholders

• Replace Sample.pdf with the actual PDF file path.
• Change 0 in ExtractText to the required page index.
• Change textLines[0] and wordCollection[0] to access different lines or words.

````

Get the Index of the Currently Displayed Page Using Code-Behind

int currentPage = pdfViewer.CurrentPageIndex;

Form Filling in PDF Files in WPF Pdf Viewer

The Syncfusion WPF PdfViewer supports filling, editing, flattening, and saving AcroForm fields. You can also import/export form data and add, remove, or modify form fields at runtime.

Configure Form Settings Using FormSettings

The FormSettings property provides access to settings that control the behavior and appearance of PDF form fields in the viewer.

Show or Hide Form Field Icons Using IsIconVisible

The IsIconVisible property determines whether icons associated with form fields are displayed in the PDF viewer.

pdfViewer.FormSettings.IsIconVisible = true;  

Notes

• When set to true, form field icons are displayed.
• When set to false, form field icons are hidden.

Retrieve Clicked Form Field Details by Type Using the FormFieldClicked Event in Code-Behind

Retrieves details of a clicked form field using the FormFieldClicked event.

//Wire the FormFieldClicked event.
pdfViewer.FormFieldClicked += PdfViewer_FormFieldClicked;

private void PdfViewer_FormFieldClicked(object sender, FormFieldClickedEventArgs args)
{
    if (args.FormField is TextBox)
    {
        TextBox text = args.FormField as TextBox;
    }
    else if (args.FormField is PasswordBox)
    {
        PasswordBox passTextBox = args.FormField as PasswordBox;
    }
    else if (args.FormField is ListBox)
    {
        ListBox listBox = args.FormField as ListBox;
    }
    else if (args.FormField is ComboBox)
    {
        ComboBox comboBox = args.FormField as ComboBox;
    }
    else if (args.FormField is CheckBox)
    {
        CheckBox checkBox = args.FormField as CheckBox;
    }
    else if (args.FormField is RadioButton)
    {
        RadioButton radioBtn = args.FormField as RadioButton;
    }
}

Import Form Data from an FDF File into a PDF Document with AcroForm Fields Using Code-Behind

Imports form data into a PDF document with AcroForm fields.

//Import PDF form data
pdfViewer.ImportFormData("Import.fdf", Syncfusion.Pdf.Parsing.DataFormat.Fdf);

Placeholders

• Replace Import.fdf with the actual import file path.

Import Form Data from a Byte Array (Overload)

Imports form data provided as a byte array into a PDF document with AcroForm fields.

byte[] formData = File.ReadAllBytes("Import.fdf");
pdfViewer.ImportFormData(
    formData,
    Syncfusion.Pdf.Parsing.DataFormat.Fdf);

Export Form Data from a PDF Document to an FDF File Using Code-Behind

Exports form data from a PDF document to a file.

//Export PDF form data
pdfViewer.ExportFormData("Export.fdf", Syncfusion.Pdf.Parsing.DataFormat.Fdf, "SourceForm.pdf");

Placeholders

• Replace Export.fdf with the desired export file path.
• Replace SourceForm.pdf with the source PDF file name.

Add a Text Box Form Field Programmatically to a Page at Runtime Using Code-Behind

Adds a text box form field programmatically to the first page of the loaded document.

PdfLoadedPage page = pdfViewer.LoadedDocument.Pages[0] as PdfLoadedPage;
PdfTextBoxField textBoxField = new PdfTextBoxField(page, "FirstName");
textBoxField.Bounds = new RectangleF(0, 0, 100, 20);
pdfViewer.LoadedDocument.Form.Fields.Add(textBoxField);

Remove a Form Field at a Specified Index from the Loaded Document at Runtime Using Code-Behind

Removes a form field at a specified index from the loaded document.

if (pdfViewer.LoadedDocument.Form.Fields.Count > 0)
    pdfViewer.LoadedDocument.Form.Fields.RemoveAt(0);

Modify the Text of an Existing Text Box Form Field at a Specified Index at Runtime Using Code-Behind

Modifies the text of an existing text box form field at a specified index.

if (pdfViewer.LoadedDocument.Form.Fields[0] is PdfLoadedTextBoxField)
{
    (pdfViewer.LoadedDocument.Form.Fields[0] as PdfLoadedTextBoxField).Text = "Syncfusion";
}

Handwritten Signature in WPF Pdf Viewer

Handwritten signature support in the Syncfusion WPF PdfViewer allows users to draw, add, and customize signatures in PDF documents using HandwrittenSignatureSettings and AddHandwrittenSignature.

Enable Handwritten Signature Annotation Mode to Allow Users to Draw Signatures on a PDF Using Code-Behind

pdfViewer.AnnotationMode = PdfDocumentView.PdfViewerAnnotationMode.HandwrittenSignature;

Placeholders

• Replace sample.pdf with the actual PDF file path.

Set the Stroke Color and Opacity of Handwritten Signatures Using HandwrittenSignatureSettings in Code-Behind

pdfViewer.HandwrittenSignatureSettings.Opacity = 0.5F;
pdfViewer.HandwrittenSignatureSettings.Color = Colors.Green;

Flatten Handwritten Signatures into the PDF Page Content on Save Using FlattenSignatureOnSave in Code-Behind

pdfViewer.HandwrittenSignatureSettings.FlattenSignatureOnSave = true;

Add a Handwritten Signature to a Single PDF Page at Specified Bounds Using AddHandwrittenSignature in Code-Behind

System.Windows.Shapes.Path signature = new System.Windows.Shapes.Path();
// Set signature appearance as Data for the path here.
pdfViewer.AddHandwrittenSignature(signature, 1, new RectangleF(450, 750, 100, 100));

Placeholders

• Replace 1 with the target 1-based page number.
• Replace RectangleF(450, 750, 100, 100) with the actual bounds.

Add a Handwritten Signature to Multiple PDF Pages with Per-Page Bounds Using AddHandwrittenSignature and a Dictionary in Code-Behind

System.Windows.Shapes.Path signature = new System.Windows.Shapes.Path();
// Set signature appearance using Data property of the path here.
Dictionary<int, List<RectangleF>> bounds = new Dictionary<int, List<RectangleF>>();
bounds.Add(1, new List<RectangleF>() { new RectangleF(450, 750, 100, 100) });
bounds.Add(2, new List<RectangleF>() { new RectangleF(350, 550, 200, 200) });
pdfViewer.AddHandwrittenSignature(signature, bounds);

Handle Add, Move, Resize, Select, and Remove Actions on Handwritten Signatures Using the HandwrittenSignatureChanged Event in Code-Behind

pdfViewer.HandwrittenSignatureChanged += PdfViewer_HandwrittenSignatureChanged;

private void PdfViewer_HandwrittenSignatureChanged(object sender, HandwrittenSignatureChangedEventArgs e)
{
    if (e.Action == AnnotationChangedAction.Add)
    {
        System.Windows.Shapes.Path signature = e.Signature as System.Windows.Shapes.Path;
    }
    else if (e.Action == AnnotationChangedAction.Move)
    {
        PointF oldLocation = e.OldBounds.Location;
        PointF newLocation = e.NewBounds.Location;
    }
    else if (e.Action == AnnotationChangedAction.Select)
    {
        int pageNumber = e.PageNumber;
        PointF location = e.NewBounds.Location;
        SizeF size = e.NewBounds.Size;
    }
}

Placeholders

• Replace sample.pdf with the actual PDF file path.

API Reference for All Handwritten Signature Properties, Methods, Events, and Event Arguments

Importing and Exporting Annotations in WPF Pdf Viewer

The Syncfusion WPF PdfViewer supports exporting and importing annotation data in FDF or XFDF formats via the ExportAnnotations and ImportAnnotations APIs.

---

Export All Annotations from a Loaded PDF to an FDF or XFDF File Using ExportAnnotations in Code-Behind

Exports all annotations in the loaded PDF to a file using ExportAnnotations. Choose AnnotationDataFormat.fdf or AnnotationDataFormat.xfdf as required.

// Export annotations to an FDF file.
pdfViewer.ExportAnnotations("Annotation.fdf", AnnotationDataFormat.fdf);

// Export annotations to an XFDF file.
pdfViewer.ExportAnnotations("Annotation.xfdf", AnnotationDataFormat.xfdf);

Placeholders

• Replace "Annotation.fdf" / "Annotation.xfdf" with the desired output file path.

---

Export All Annotations from a Loaded PDF to a Memory Stream in FDF or XFDF Format for In-Memory Processing Using ExportAnnotations in Code-Behind

Exports all annotations in the loaded PDF to a Stream instead of a file, useful for in-memory processing or network transfer.

// Export annotations to a memory stream in FDF format.
Stream stream = new MemoryStream();
pdfViewer.ExportAnnotations(stream, AnnotationDataFormat.fdf);

Placeholders

• Replace AnnotationDataFormat.fdf with AnnotationDataFormat.xfdf to export in XFDF format.

---

Import Annotations from an FDF or XFDF File and Apply Them to the Currently Loaded PDF Document Using ImportAnnotations in Code-Behind

Imports annotations from an FDF or XFDF file and applies them to the currently loaded PDF document using ImportAnnotations.

// Import annotations from an FDF file.
pdfViewer.ImportAnnotations("Annotation.fdf", AnnotationDataFormat.fdf);

// Import annotations from an XFDF file.
pdfViewer.ImportAnnotations("Annotation.xfdf", AnnotationDataFormat.xfdf);

Placeholders

• Replace "Annotation.fdf" / "Annotation.xfdf" with the path to the annotation file to import.

---

Import Annotations from a Stream Containing FDF or XFDF Data and Apply Them to the Currently Loaded PDF Document Using ImportAnnotations in Code-Behind

Imports annotations from a Stream containing FDF or XFDF data and applies them to the currently loaded PDF document.

// Import annotations from a stream in FDF format.
pdfViewer.ImportAnnotations(stream, AnnotationDataFormat.fdf);

Placeholders

• Replace AnnotationDataFormat.fdf with AnnotationDataFormat.xfdf to import XFDF data.
• Ensure stream is positioned at the beginning before calling ImportAnnotations.

Interaction Modes in WPF Pdf Viewer

Interaction mode support in the Syncfusion WPF PdfViewer allows switching between Selection, Panning, and Marquee Zoom cursor modes using the CursorMode property.

Enable Text Selection Mode to Allow Users to Select and Copy Text Using Code-Behind

pdfViewerControl.CursorMode = PdfViewerCursorMode.SelectTool;
pdfViewerControl.Load(@"sample.pdf");

Enable Panning Mode to Allow Users to Drag and Scroll Through PDF Pages Using Code-Behind

pdfViewerControl.CursorMode = PdfViewerCursorMode.HandTool;
pdfViewerControl.Load(@"sample.pdf");

Enable Marquee Zoom Mode to Allow Users to Zoom Into a Selected Area Using Code-Behind

pdfViewerControl.CursorMode = PdfViewerCursorMode.MarqueeZoom;
pdfViewerControl.Load(@"sample.pdf");

Placeholders

• Replace sample.pdf with the actual PDF file path.

Set Custom Cursor for PdfViewerControl Using Code-Behind

In addition to the predefined cursor interaction modes, the cursor for the PDF viewer control can be explicitly set using the Cursor property.

pdfViewer.Cursor = Cursors.Pen;

Notes

• This sets the mouse cursor appearance when it is over the PdfViewerControl.
• Any cursor from System.Windows.Input.Cursors can be assigned.
• Cursor appearance is independent of the CursorMode setting.

API Reference for Cursor Modes, Properties, and Enum Values

Load PDF Files in WPF Pdf Viewer

Loading PDF files in the Syncfusion WPF PdfViewer is done through the Load API and the ItemSource property, which support opening both normal and encrypted documents. PDFs can be loaded from file paths, streams, or PdfLoadedDocument objects, and also via XAML data binding using ItemSource, enabling flexible integration within WPF applications.Asynchronous loading helps improve UI responsiveness, especially when loading large PDF files.

Add PdfViewerControl to the Main Window Using XAML

Add the PdfViewerControl in the MainWindow.xaml.

<Window 
    x:Class="PdfViewerDemo.MainWindow"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    WindowState="Maximized"
    xmlns:syncfusion="clr-namespace:Syncfusion.Windows.PdfViewer;assembly=Syncfusion.PdfViewer.WPF">
    <Grid>
        <syncfusion:PdfViewerControl x:Name="pdfViewer"></syncfusion:PdfViewerControl>
    </Grid>
</Window>

Load a Normal PDF from a File Path Using Code-Behind

            //Load PDF file using the file path.
            pdfViewer.Load(@"customer.pdf");

Placeholders

Replace customer.pdf with the customer-given PDF file path.

Load a Normal PDF from a Stream Using Code-Behind

        FileStream stream = new FileStream(@"customer.pdf", FileMode.Open);
        //Load PDF file using stream.
        pdfViewer.Load(stream);

Placeholders

Replace customer.pdf with the customer-given PDF file path.

Load a Password-Protected PDF from a File Path Using Code-Behind

            //Load password protected PDF file using the file path and the password.
            pdfViewer.Load(@"customer.pdf", "password");

Placeholders

• Replace customer.pdf with the customer-given PDF file path.
• Replace "password" with the actual password of the PDF.

Load a Password-Protected PDF from a Stream Using Code-Behind

         FileStream stream = new FileStream(@"customer.pdf", FileMode.Open);
         //Load password protected PDF file using stream and the password.
        pdfViewer.Load(stream, "password");

Placeholders

• Replace customer.pdf with the customer-given PDF file path.
• Replace "password" with the actual password of the PDF.

Load PDF Files Asynchronously Using LoadAsync

The LoadAsync APIs load PDF documents without blocking the UI thread and return a Task<bool> indicating whether the load operation succeeded.

Load a PDF Using PdfLoadedDocument Asynchronously

PdfLoadedDocument loadedDocument = new PdfLoadedDocument(@"customer.pdf");
bool isLoaded = await pdfViewer.LoadAsync(loadedDocument);

Load a Normal PDF from a Stream Asynchronously

FileStream stream = new FileStream(@"customer.pdf", FileMode.Open, FileAccess.Read);
bool isLoaded = await pdfViewer.LoadAsync(stream);

Load a Password-Protected PDF from a Stream Asynchronously

FileStream stream = new FileStream(@"customer.pdf", FileMode.Open, FileAccess.Read);
bool isLoaded = await pdfViewer.LoadAsync(stream, "password");

Load a Normal PDF from a File Path Asynchronously

bool isLoaded = await pdfViewer.LoadAsync(@"customer.pdf");

Load a Password-Protected PDF from a File Path Asynchronously

bool isLoaded = await pdfViewer.LoadAsync(@"customer.pdf", "password");

• All LoadAsync overloads must be awaited.
• Recommended for large documents or when UI responsiveness is critical.
• The returned bool indicates whether the load operation completed successfully.

Placeholders

• Replace customer.pdf with the customer-given PDF file path.
• Replace "password" with the actual password of the PDF.

Load a PDF Using the ItemSource Property with a File Path in Code-Behind

The ItemSource property of PdfViewerControl accepts a string file path, a Stream, or a PdfLoadedDocument object to load a PDF.

    //Load PDF file using the ItemSource property.
    pdfViewer.ItemSource = @"customer.pdf";

Placeholders

Replace customer.pdf with the customer-given PDF file path.

Load a PDF Using the ItemSource Property with a Stream in Code-Behind

    //Load PDF file as Stream using the ItemSource property.
    pdfViewer.ItemSource = new FileStream(@"customer.pdf", FileMode.Open);

Placeholders

Replace customer.pdf with the customer-given PDF file path.

Load a PDF Using the ItemSource Property with a PdfLoadedDocument Object in Code-Behind

    //Load PDF file as PdfLoadedDocument object using the ItemSource property.
    PdfLoadedDocument pdfLoadedDocument = new PdfLoadedDocument(@"customer.pdf");
    pdfViewer.ItemSource = pdfLoadedDocument;

Placeholders

Replace customer.pdf with the customer-given PDF file path.

Load a PDF by Binding the ItemSource Property to a ViewModel Using XAML and MVVM

You can bind the ItemSource property directly in XAML using a ViewModel, enabling MVVM-based PDF loading.

MainWindow.xaml

<Window 
    x:Class="PdfViewerDemo.MainWindow"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    WindowState="Maximized"
    xmlns:syncfusion="clr-namespace:Syncfusion.Windows.PdfViewer;assembly=Syncfusion.PdfViewer.WPF"
    xmlns:local="clr-namespace:PdfViewerDemo">
    <Window.DataContext>
        <local:MainViewModel/>
    </Window.DataContext>
    <Grid>
        <syncfusion:PdfViewerControl x:Name="pdfViewer"
                                     ItemSource="{Binding PdfFilePath}">
        </syncfusion:PdfViewerControl>
    </Grid>
</Window>

MainWindow.xaml.cs

    public MainWindow()
    {
        InitializeComponent();
    }

MainViewModel.cs

    public class MainViewModel : INotifyPropertyChanged
    {
        private string _pdfFilePath;

        public string PdfFilePath
        {
            get { return _pdfFilePath; }
            set
            {
                _pdfFilePath = value;
                OnPropertyChanged(nameof(PdfFilePath));
            }
        }

        public MainViewModel()
        {
            //Set the PDF file path to load via binding.
            PdfFilePath = @"customer.pdf";
        }

        public event PropertyChangedEventHandler PropertyChanged;

        protected void OnPropertyChanged(string propertyName)
        {
            PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
        }
    }

Placeholders

Replace customer.pdf with the customer-given PDF file path.

Unload the Current PDF Document and Free Resources Using Code-Behind

pdfViewer.Unload(true);

Change the Loading Indicator Spinner Color Using Code-Behind

pdfViewer.LoadingIndicator.LoaderColor = System.Windows.Media.Color.FromArgb(255, 255, 0, 0);

Change the Loading Indicator Message Text Using Code-Behind

pdfViewer.LoadingIndicator.LoadingMessage = "Document loading";

Suppress the Built-In Password Dialog and Supply the Password Programmatically Using Code-Behind

To suppress the built-in password prompt and supply the password programmatically, handle the GetDocumentPassword event and set e.Handled = true.

        pdfViewer.GetDocumentPassword += PdfViewer_GetDocumentPassword;
         string filePath = Path.GetFullPath(@"customer.pdf");
        pdfViewer.Load(filePath);

        private void PdfViewer_GetDocumentPassword(object sender, GetDocumentPasswordEventArgs e)
        {
            System.Security.SecureString secureString = new System.Security.SecureString();
            foreach (char c in "password")
                secureString.AppendChar(c);

            e.Password = secureString;

            // Set Handled to true to hide the built-in password dialog.
            e.Handled = true;
        }

Placeholders

• Replace customer.pdf with the customer-given PDF file path.
• Replace "password" with the actual password characters for the PDF.

Apply a Theme to WPF PdfViewerControl Using SfSkinManager

The WPF PdfViewerControl supports built-in themes via SfSkinManager. To apply a theme, install the corresponding Syncfusion theme NuGet package and call SfSkinManager.SetTheme in code-behind.

Required NuGet Package per Theme

Note: Install only the NuGet package that matches the theme the user wants to apply.

Apply a Theme Using SfSkinManager in Code-Behind

The following example applies the FluentLight theme. Replace the theme name and NuGet package according to the desired theme from the table above.

Step 1: Install the theme NuGet package (example for FluentLight):

Install-Package Syncfusion.Themes.FluentLight.WPF

Step 2: Add the SfSkinManager namespace to MainWindow.xaml:

<Window 
    x:Class="PdfViewerDemo.MainWindow"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    WindowState="Maximized"
    xmlns:syncfusion="clr-namespace:Syncfusion.Windows.PdfViewer;assembly=Syncfusion.PdfViewer.WPF"
    xmlns:syncfusionskin="clr-namespace:Syncfusion.SfSkinManager;assembly=Syncfusion.SfSkinManager.WPF">
    <Grid x:Name="HomeGrid">
        <syncfusion:PdfViewerControl x:Name="pdfViewer"></syncfusion:PdfViewerControl>
    </Grid>
</Window>

Step 3: Apply the theme in MainWindow.xaml.cs:

    // Apply the FluentLight theme to PdfViewerControl.
    // Replace "FluentLight" with your desired theme name (e.g., "FluentDark", "MaterialLight", "Windows11Light").
    SfSkinManager.SetTheme(pdfViewer, new Theme() { ThemeName = "FluentLight" });
    // Load a PDF after applying the theme.
    pdfViewer.Load(@"customer.pdf");

Placeholders

• Replace "FluentLight" with the desired theme name from the table above.
• Replace customer.pdf with the customer-given PDF file path.
• Install the corresponding NuGet package for the chosen theme.

References

• Apply theme using SfSkinManager
• Create a custom theme using ThemeStudio
• WPF PdfViewer Getting Started – Theme

---

API Reference for All Load Methods, Properties, and Events

Localization in WPF Pdf Viewer

Localization in the Syncfusion WPF PdfViewer allows configuring all static text (tooltips, context menus, toolbar labels, dialog messages) to a specific language by adding .resx resource files to the application. To localize the viewer, create a Resources folder in your project (new or existing), add the default English .resx file, and then add a culture-specific .resx file with translated values for the same keys. Set Thread.CurrentThread.CurrentUICulture before InitializeComponent() to activate the desired language at runtime.

Add a Resources Folder and Culture-Specific Resource Files to a New or Existing Project to Enable Localized Text in WPF PdfViewer

To localize the WPF PdfViewer, a Resources folder must exist in the project. If the project is newly created, add this folder manually. If the project already exists and does not have a Resources folder, add it in the same way. Inside this folder, place the default English resource file and a culture-specific resource file containing translated values for each key.

Steps: 1. In Solution Explorer, right-click the project → Add → New Folder → name it Resources. 2. Right-click the Resources folder → Add → New Item → select Resources File. 3. Name the default file Syncfusion.PdfViewer.WPF.resx and add it. This file holds the base (English) key-value pairs. 4. Add a second Resources File named Syncfusion.PdfViewer.WPF.[Culture].resx (e.g., Syncfusion.PdfViewer.WPF.fr.resx for French, Syncfusion.PdfViewer.WPF.de.resx for German). 5. In the culture-specific file, add the same resource keys as the default file but replace each value with the translated text for the target language. 6. Set the Access Modifier of both .resx files to Public in the resource editor.

Placeholders

• Replace [Culture] with the target culture code (e.g., fr for French, de for German, ja for Japanese).

Default English (en-US) Resource Keys and Values for Syncfusion WPF PdfViewer

The table below lists every localizable key used by the WPF PdfViewer along with its default English value. Copy these keys into your culture-specific .resx file and replace the values with translations for the target language.

Apply Localization by Setting the Thread UI Culture Before Initializing the Window in Code-Behind

Set Thread.CurrentThread.CurrentUICulture to the desired culture code before calling InitializeComponent(). This must be done before the window initializes so that the PdfViewer picks up the correct .resx file from the Resources folder. The culture-specific .resx file (e.g., Syncfusion.PdfViewer.WPF.fr.resx) must already be present in the Resources folder of the project with the translated key values.

        Thread.CurrentThread.CurrentUICulture = new CultureInfo("fr-FR");
        InitializeComponent();
        pdfViewer.Load(@"sample.pdf");

Placeholders

• Replace fr-FR with the target culture code (e.g., de-DE for German, ja-JP for Japanese, ar-SA for Arabic).
• Replace sample.pdf with the actual PDF file path.

Load Localized Resources from a Custom Assembly and Namespace Using LocalizationManager in Code-Behind

When the localization resource files are stored in a separate class library or a different assembly (not the main application project), use LocalizationManager.SetResources to point the PdfViewer to the correct assembly and namespace. Call this method after setting the UI culture and before InitializeComponent(). The Resources folder and the culture-specific .resx file must exist inside that external assembly under the specified namespace.

        Thread.CurrentThread.CurrentUICulture = new CultureInfo("fr-FR");

        // Set custom assembly and namespace for localization
        LocalizationManager.SetResources(typeof(CustomClass).Assembly, "ClassLibrary");
        InitializeComponent();

Placeholders

• Replace CustomClass with any class that belongs to the assembly containing the resource files.
• Replace ClassLibrary with the root namespace of that assembly where the Resources folder is located.
• Replace fr-FR with the desired culture code.

API Reference for All Localization Properties and Methods

Magnifying PDF Documents in WPF Pdf Viewer

The Syncfusion WPF PdfViewer allows you to magnify PDF documents programmatically using zoom APIs, set zoom modes, define zoom percentage limits, and handle zoom change notifications.

Zoom the PDF Document to a Specific Percentage Using Code-Behind

// Zoom to 235 percentage
pdfViewer.ZoomTo(235);

Get the Current Zoom Percentage of the Viewer Using Code-Behind

int currentZoomPercentage = pdfViewer.ZoomPercentage;

Set the Zoom Mode to Fit Page or Fit Width Using Code-Behind

// Fit to page
pdfViewer.ZoomMode = ZoomMode.FitPage;

// Fit to width
pdfViewer.ZoomMode = ZoomMode.FitWidth;

Define Minimum and Maximum Zoom Percentage Limits and Zoom to Maximum Using Code-Behind

// Set minimum zoom percentage (default: 50, range: 10 to MaximumZoomPercentage)
pdfViewer.MinimumZoomPercentage = 20;

// Set maximum zoom percentage (default: 400, range: MinimumZoomPercentage to 6400 for PDFium)
pdfViewer.MaximumZoomPercentage = 600;

// Zoom to max
pdfViewer.ZoomTo(pdfViewer.MaximumZoomPercentage);

Zoom to a Specific Rectangular Area of the PDF Page

The ZoomToRect method allows you to zoom into a specific rectangular region of the currently displayed PDF page. This is useful for focusing on a particular area.

private void Button_Click(object sender, RoutedEventArgs e)
{
    pdfViewer.ZoomToRect(new Rect(400, 50, 200, 150));
}

Hide the Zoom Tools in the Toolbar Using Code-Behind

pdfViewer.ToolbarSettings.ShowZoomTools = false;

Handle the ZoomChanged Event to Get the Updated Zoom Percentage Using Code-Behind

    pdfViewer.ZoomChanged += PdfViewer_ZoomChanged;
    pdfViewer.Load(@"sample.pdf");

    private void PdfViewer_ZoomChanged(object sender, ZoomEventArgs args)
    {
        int currentZoomPercentage = args.ZoomPercentage;
    }

Placeholders

• Replace sample.pdf with the actual PDF file path.

API Reference for All Zoom Properties, Methods, and Events

Navigation in WPF Pdf Viewer

Navigation support in the Syncfusion WPF PdfViewer enables page navigation, bookmark navigation, thumbnail navigation, hyperlink navigation, and table of contents (TOC) navigation.

Navigate to a Specific Page by One-Based Page Number Using Code-Behind

pdfViewer.GotoPage(2);

Go to the First Page

Navigates the viewer to the very first page of the loaded PDF document.

pdfViewer.GoToFirstPage();

Go to the Last Page

pdfViewer.GoToLastPage();

Go to the Next Page

pdfViewer.GoToNextPage();

Go to the Previous Page

pdfViewer.GoToPreviousPage();

Navigate to a Specific Page by Zero-Based Index Using Code-Behind

pdfViewer.GoToPageAtIndex(2);

Get the Total Number of Pages in the Loaded PDF Document Using Code-Behind

int pageCount = pdfViewer.PageCount;

Get the Index of the Currently Displayed Page Using Code-Behind

int currentPage = pdfViewer.CurrentPageIndex;

Navigate Using PdfDocumentView Navigation State Properties

The PdfDocumentView exposes several read-only boolean properties that indicate whether specific navigation actions are currently possible. These properties are typically used to enable or disable navigation buttons and to validate navigation commands, not to force navigation.

public bool CanGoToFirstPage { get; }
public bool CanGoToPreviousPage { get; }
public bool CanGoToNextPage { get; }
public bool CanGoToLastPage { get; }

Property Descriptions

• CanGoToFirstPage – Returns true if navigation to the first page is possible (current page is not the first page).
• CanGoToPreviousPage – Returns true if navigation to the previous page is possible.
• CanGoToNextPage – Returns true if navigation to the next page is possible.
• CanGoToLastPage – Returns true if navigation to the last page is possible (current page is not the last page).

Example Usage

The navigation state properties are commonly used to safely navigate pages and control UI elements such as toolbar buttons.

Example: Safe Navigation Based on State

Each navigation call is executed only when the corresponding state indicates it is possible.

// Navigate to the first page only if not already on the first page
if (pdfDocumentView.CanGoToFirstPage)
{
    pdfDocumentView.GoToFirstPage();
}

// Navigate to the previous page only if a previous page exists
if (pdfDocumentView.CanGoToPreviousPage)
{
    pdfDocumentView.GoToPreviousPage();
}

// Navigate to the next page only if a next page exists
if (pdfDocumentView.CanGoToNextPage)
{
    pdfDocumentView.GoToNextPage();
}

// Navigate to the last page only if not already on the last page
if (pdfDocumentView.CanGoToLastPage)
{
    pdfDocumentView.GoToLastPage();
}

Scroll the Document to a Specific Horizontal and Vertical Offset Using Code-Behind

// Scroll to horizontal offset 160 and vertical offset 400
pdfViewer.ScrollTo(160, 400);

Scroll the Document Vertically Using ScrollTo(double)

// Scroll vertically to offset 400
pdfViewer.ScrollTo(400);

Expand the Thumbnail Navigation Panel Programmatically on Window Load Using Code-Behind

pdfViewer.ThumbnailSettings.IsExpanded = true;

Hide the Thumbnail Navigation Panel Programmatically on Window Load Using Code-Behind

// Hide the thumbnail panel
pdfViewer.ThumbnailSettings.IsVisible = false;

Navigate to the First Bookmark After the Document Is Loaded Using Code-Behind

pdfViewer.DocumentLoaded += PdfViewer_DocumentLoaded;

private void PdfViewer_DocumentLoaded(object sender, EventArgs args)
{
    PdfLoadedDocument pdfLoadedDocument = pdfViewer.LoadedDocument;
    PdfBookmarkBase bookmarks = pdfLoadedDocument.Bookmarks;
    // Navigate to the first bookmark
    pdfViewer.GoToBookmark(bookmarks[0]);
}

Navigate to a Child Bookmark of a Parent Bookmark Entry Using Code-Behind

PdfLoadedDocument pdfLoadedDocument = pdfViewer.LoadedDocument;
PdfBookmarkBase bookmarks = pdfLoadedDocument.Bookmarks;
PdfBookmark fourthBookmark = bookmarks[3];
if (fourthBookmark.Count > 0)
{
    // Navigate to the first child of the fourth bookmark
    pdfViewer.GoToBookmark(bookmarks[3][0]);
}

Expand the Bookmark Navigation Panel Programmatically on Window Load Using Code-Behind

// Expand the bookmark panel
pdfViewer.BookmarkSettings.IsExpanded = true;

Disable the Bookmark Feature and Hide the Bookmark Button Using Code-Behind

pdfViewerControl.IsBookmarkEnabled = false;

Display a Notification Bar in the Viewer

The InsertNotificationBar method allows you to display a message banner inside the PDF viewer. This is useful for showing informational messages, warnings, or status updates to users.

pdfViewer.InsertNotificationBar("This is a notification bar");

Retrieve the URI of a Clicked Hyperlink by Handling the HyperlinkClicked Event Using Code-Behind

pdfViewerControl.HyperlinkClicked += PdfViewerControl_HyperlinkClicked;

private void PdfViewerControl_HyperlinkClicked(object sender, HyperlinkClickedEventArgs args)
{
    // Retrieve the clicked URI
    string uri = args.Uri;
}

Prevent Default Browser Navigation When a Hyperlink Is Clicked Using Code-Behind

pdfViewerControl.HyperlinkClicked += PdfViewerControl_HyperlinkClicked;

private void PdfViewerControl_HyperlinkClicked(object sender, HyperlinkClickedEventArgs args)
{
    // Prevent default navigation
    args.Handled = true;
}

Handle the Mouse-Over Event When the Pointer Moves Over a Hyperlink Using Code-Behind

pdfViewerControl.HyperlinkMouseOver += PdfViewerControl_HyperlinkMouseOver;

private void PdfViewerControl_HyperlinkMouseOver(object sender, EventArgs args)
{
    // Handle mouse over hyperlink
}

API Reference

Organize Pages in WPF Pdf Viewer

Organize pages support in the Syncfusion WPF PdfViewer allows you to rotate, rearrange, insert, and delete pages from a PDF document using PageOrganizer and PageOrganizerSettings.

Rotate One or More Pages to a Specific Angle Using Code-Behind

// Rotate pages at index 0 and 1 to 90 degrees
pdfViewer.PageOrganizer.Rotate(new int[] { 0, 1 }, Syncfusion.Pdf.PdfPageRotateAngle.RotateAngle90);

Placeholders

• Replace 0, 1 with the target zero-based page indexes.
• Replace RotateAngle90 with RotateAngle180 or RotateAngle270 as needed.

Rotate One or More Pages 90 Degrees Clockwise Using Code-Behind

pdfViewer.PageOrganizer.RotateClockwise(new int[] { 0, 1 });

Rotate One or More Pages 90 Degrees Counterclockwise Using Code-Behind

pdfViewer.PageOrganizer.RotateCounterclockwise(new int[] { 0, 1 });

Get the Current Rotation Angle of a Specific Page by Zero-Based Index Using Code-Behind

PdfPageRotateAngle rotatedAngle = pdfViewer.PageOrganizer.GetPageRotation(0);

Placeholders

• Replace 0 with the target zero-based page index.

Rearrange All Pages in a Custom Order by Providing Zero-Based Indexes Using Code-Behind

// Rearrange pages — swaps page 0 and page 1
pdfViewer.PageOrganizer.ReArrange(new int[] { 1, 0 });

Placeholders

• Provide all page indexes in the desired order. Any index omitted will be removed.

Remove a Single Page by Zero-Based Index Using Code-Behind

pdfViewer.PageOrganizer.RemoveAt(0);

Remove Multiple Pages by Zero-Based Indexes Using Code-Behind

pdfViewer.PageOrganizer.RemovePages(new int[] { 0, 1 });

Placeholders

• Replace 0, 1 with the target zero-based page indexes to remove.

Handle the PageSelected Event to Retrieve Selected Page Indexes from the Organizer Panel

    pdfViewer.PageSelected += PdfViewer_PageSelected;
    private void PdfViewer_PageSelected(object sender, PageSelectedEventArgs e)
    {
        if (e.SelectedPages.Length != 0)
        {
            int[] selectedPages = e.SelectedPages;
        }
    }

Placeholders

• Replace sample.pdf with the actual PDF file path.

Hide the Page Organizer Icon from the Left Pane Using Code-Behind

pdfViewer.PageOrganizerSettings.IsIconVisible = false;

Show Annotations and Form Fields in the Page Organizer Panel Using Code-Behind

pdfViewer.PageOrganizerSettings.ShowAnnotations = true;

API Reference for All PageOrganizer Methods, Commands, Events, and Settings Properties

PDF Coordinates in WPF Pdf Viewer

The Syncfusion WPF PdfViewer allows converting between client coordinates and PDF page coordinates, retrieving scroll offsets, and bringing a specific region into view.

Get the Bounding Rectangle of the PDF Viewer's Client Area (Viewport) Using Code-Behind

Rectangle clientRectangle = pdfViewerControl.ClientRectangle;

Get the Current Horizontal and Vertical Scroll Offsets and Scroll to a New Position Using Code-Behind

double horizontalOffset = pdfViewerControl.HorizontalOffset;
double verticalOffset = pdfViewerControl.VerticalOffset;

pdfViewerControl.ScrollTo(horizontalOffset + 10, verticalOffset + 10);

Convert a Client Coordinate Point to a PDF Page Coordinate Point on Page Click Using Code-Behind

private void PdfViewerControl_PageClicked(object sender, PageClickedEventArgs e)
{
    Point clientPoint = e.Position;
    int pageNumber = pdfViewerControl.GetPageNumberFromClientPoint(clientPoint);
    Point pagePoint = pdfViewerControl.ConvertClientPointToPagePoint(clientPoint, pageNumber);
}

Convert a PDF Page Coordinate Point to a Client Coordinate Point on Annotation Change Using Code-Behind

private void PdfViewer_ShapeAnnotationChanged(object sender, ShapeAnnotationChangedEventArgs e)
{
    RectangleF bounds = e.OldBounds;
    Point pagePoint = new Point(bounds.X, bounds.Y);
    int pageNumber = e.PageNumber;

    Point clientPoint = pdfViewerControl.ConvertPagePointToClientPoint(pagePoint, pageNumber);
}

Convert a PDF Page Coordinate Point to a Scroll Coordinate Point on Annotation Change Using Code-Behind

private void PdfViewer_ShapeAnnotationChanged(object sender, ShapeAnnotationChangedEventArgs e)
{
    RectangleF bounds = e.OldBounds;
    Point pagePoint = new Point(bounds.X, bounds.Y);
    int pageNumber = e.PageNumber;

    Point scrollPoint = pdfViewerControl.ConvertPagePointToScrollPoint(pagePoint, pageNumber);
}

Bring a Specific Client-Coordinate Rectangle into View and Zoom to Fit It Using Code-Behind

Rect bounds = new Rect(400, 300, 200, 400);
pdfViewerControl.ZoomToRect(bounds);

API Reference for All Coordinate Conversion Properties and Methods

PDF Rendering Engines in WPF Pdf Viewer

The Syncfusion WPF PDF Viewer supports two rendering engines to display PDF pages: PDFium (default since v16.3.0.x) and SfPdf (Syncfusion's own engine).

Use PDFium as the Default Rendering Engine Without Any Code Change

PDFium is the default rendering engine based on Google Chrome's PDF renderer, used automatically without any code change.

Set a Custom Writable Folder Path for PDFium Binary Extraction Using the ReferencePath Property

Sets a custom writable folder path using the ReferencePath property so PDFium binaries can be extracted there when the output folder has access restrictions.

    // Set a custom writable path for PDFium extraction.
    pdfViewer.ReferencePath = @"D:\ThirdPartyBinaries\";
    pdfViewer.Load("Sample.pdf");

Placeholders

• Replace D:\ThirdPartyBinaries\ with the actual writable folder path on the target machine.
• Replace Sample.pdf with the actual PDF file path or name.

Switch the Rendering Engine to SfPdf by Setting the RenderingEngine Property When PDFium Is Not Compatible

Switches the rendering engine to SfPdf by setting the RenderingEngine property, used when PDFium is not compatible with the environment.

    // Switch rendering engine to SfPdf.
    pdfViewer.RenderingEngine = PdfRenderingEngine.SfPdf;
    pdfViewer.Load("Sample.pdf");

Placeholders

Replace Sample.pdf with the actual PDF file path or name.

Text Extraction Engines in WPF Pdf Viewer

The Syncfusion WPF PDF Viewer supports two text extraction engines for text search, text selection, and text markup: PDFium (default since v19.4.0.48) and SfPdf (Syncfusion's own engine).

Use PDFium as the Default Text Extraction Engine for Improved Performance Without Any Code Change

PDFium is the default text extraction engine for improved performance, used automatically without any code change.

Switch the Text Extraction Engine to SfPdf (Legacy Engine) Using the TextExtractionEngine Property in Code-Behind

Switches the text extraction engine to SfPdf by setting the TextExtractionEngine property, used to fall back to Syncfusion's own engine.

    // Switch text extraction engine to SfPdf (legacy engine).
    pdfViewer.TextExtractionEngine = PdfTextExtractionEngine.SfPdf;
    pdfViewer.Load("Sample.pdf");

Placeholders

Replace Sample.pdf with the actual PDF file path or name.