Skip to content

Commit 5a4d177

Browse files
docs(PdfViewer): add form filling docs (#3098)
* docs(PdfViewer): add form filling docs * chore(PdfViewer): apply suggestions as per comments
1 parent a97dfb5 commit 5a4d177

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

components/pdfviewer/form-filling.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: Form Filling
3+
page_title: PDFViewer - Form Filling
4+
meta_title: Form Filling | PDFViewer for Blazor
5+
position: 17
6+
description: "Enable users to fill and submit PDF forms in the Blazor PDFViewer."
7+
tags: telerik,blazor,pdfviewer,form filling,forms
8+
slug: pdfviewer-form-filling
9+
---
10+
11+
# Form Filling
12+
13+
The PDFViewer enables users to fill interactive forms directly in PDF documents. You can display and edit form fields such as text boxes, checkboxes, radio buttons, and dropdowns.
14+
15+
## Supported Form Fields
16+
17+
The PDFViewer supports the following form field types:
18+
19+
* `TextBox`
20+
* `CheckBox`
21+
* `RadioButton`
22+
* `DropdownList`
23+
* `ListBox`
24+
* `Button`
25+
26+
>caption Edit form fields and download the updated PDF file
27+
28+
<demo metaUrl="client/pdfviewer/form-filling/" height="420"></demo>
29+
30+
## See Also
31+
32+
* [PDFViewer Overview](slug:pdfviewer-overview)
33+
* [PDFViewer Events](slug:pdfviewer-events)

components/pdfviewer/overview.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,10 @@ The [PdfViewer toolbar can render built-in and custom tools](slug:pdfviewer-tool
6363

6464
The PdfViewer provides a built-in option for creating and editing annotations. Explore the [available annotation types and how to work with them](slug:pdfviewer-annotations).
6565

66+
## Form Filling
67+
68+
The PdfViewer supports interactive form filling in PDF documents. You can display and edit form fields such as text boxes, checkboxes, radio buttons, and dropdowns. For more details and examples, see the [Form Filling documentation](slug:pdfviewer-form-filling).
69+
6670
## Large File Support
6771

6872
In Blazor **Server** apps, the PDF Viewer uses the **SignalR WebSocket** to:
@@ -81,6 +85,7 @@ The table below lists the PDF Viewer parameters. Also check the [PDF Viewer API
8185

8286
| Parameter | Type and Default&nbsp;Value | Description |
8387
| --- | --- | --- |
88+
| `AnnotationMode` | `PdfViewerAnnotationMode` <br /> (`Disable`) | Specifies how the PDFViewer handles [form fields](slug:pdfviewer-form-filling) in the loaded document. |
8489
| `Class` | `string` | An additional CSS class for the `<div class="k-pdf-viewer">` element. Use it to [customize the component styles and override the theme](slug:themes-override). |
8590
| `Data` | `byte[]` | The source of the currently displayed PDF file. |
8691
| `EnableLoaderContainer` | `bool` <br /> (`true`) | Determines if the PDF Viewer will show a loading animation during opening, downloading or zooming a PDF file. |
@@ -100,6 +105,7 @@ The PdfViewer exposes methods for programmatic operation. To use them, define a
100105
| --- | --- |
101106
| `Print` | Prints the loaded PDF document as an alternative to the [built-in Print button in the PDF Viewer toolbar](slug:pdfviewer-toolbar#built-in-tools). |
102107
| `Rebind` | Refreshes the PDF Viewer and ensures it is displaying the latest file `Data`. [`Rebind` is necessary when the Blazor framework cannot re-render components automatically](slug:common-features-data-binding-overview#refresh-data). |
108+
| `GetFileAsync` | Asynchronously retrieves the current PDF file data as a byte array, including any annotations or form filling changes. Returns a `Task<byte[]>`. Returns `null` if no document is loaded. |
103109

104110
>caption PDF Viewer reference and method usage
105111

0 commit comments

Comments
 (0)