Skip to content

Commit 1844ec5

Browse files
immankumarsyncimmankumarsync
authored
Merge pull request #2380 from syncfusion-content/diataxisMAUIPdfviewer
documentation(123): Updated existing MAUI PDF Viewer UG pages based on Diataxis guidelines
2 parents e3844c2 + d557072 commit 1844ec5

57 files changed

Lines changed: 1901 additions & 1209 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Document-Processing-toc.html‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1902,15 +1902,33 @@
19021902
<li>
19031903
UI
19041904
<ul>
1905-
<li><a href="/document-processing/pdf/pdf-viewer/maui/Toolbar">Toolbar</a></li>
1905+
<li>
1906+
<a href="/document-processing/pdf/pdf-viewer/maui/Toolbar">Toolbar</a>
1907+
<ul>
1908+
<li><a href="/document-processing/pdf/pdf-viewer/maui/Toolbar">Overview</a></li>
1909+
<li><a href="/document-processing/pdf/pdf-viewer/maui/Toolbar-Customization">Customize Toolbar</a></li>
1910+
</ul>
1911+
</li>
19061912
<li><a href="/document-processing/pdf/pdf-viewer/maui/UI-Customization">Customization</a></li>
19071913
</ul>
19081914
</li>
19091915
<li><a href="/document-processing/pdf/pdf-viewer/maui/Magnification">Magnification</a></li>
19101916
<li><a href="/document-processing/pdf/pdf-viewer/maui/Text-Search">Text Search</a></li>
19111917
<li><a href="/document-processing/pdf/pdf-viewer/maui/Text-Selection">Text Selection</a></li>
19121918
<li><a href="/document-processing/pdf/pdf-viewer/maui/Redaction">Redaction</a></li>
1913-
<li><a href="/document-processing/pdf/pdf-viewer/maui/Form-Filling">Form Filling</a></li>
1919+
<li>
1920+
<a href="/document-processing/pdf/pdf-viewer/maui/Form-Filling-Overview">Form Filling</a>
1921+
<ul>
1922+
<li><a href="/document-processing/pdf/pdf-viewer/maui/Form-Filling-Overview">Overview</a></li>
1923+
<li><a href="/document-processing/pdf/pdf-viewer/maui/Form-Filling-Edit">Edit Form Fields</a></li>
1924+
<li><a href="/document-processing/pdf/pdf-viewer/maui/Form-Filling-Collection">Form Field Collection</a></li>
1925+
<li><a href="/document-processing/pdf/pdf-viewer/maui/Form-Filling-Customization">Customize Form Fields</a></li>
1926+
<li><a href="/document-processing/pdf/pdf-viewer/maui/Form-Filling-Show-Hide">Show and Hide Form Fields</a></li>
1927+
<li><a href="/document-processing/pdf/pdf-viewer/maui/Form-Filling-Validation">Form Field Validation</a></li>
1928+
<li><a href="/document-processing/pdf/pdf-viewer/maui/Form-Filling-Events">Form Field Events</a></li>
1929+
<li><a href="/document-processing/pdf/pdf-viewer/maui/Form-Filling-Import-Export">Import and Export Form Data</a></li>
1930+
</ul>
1931+
</li>
19141932
<li>
19151933
<a href="/document-processing/pdf/pdf-viewer/maui/Annotations-Overview">Annotations</a>
19161934
<ul>

‎Document-Processing/PDF/PDF-Viewer/maui/Add-Remove-Modify-Annotations.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
layout: post
33
title: Add, Remove, and Edit Annotations in .NET MAUI PDF Viewer | Syncfusion
4-
description: Learn here all about adding, removing and editing annotations in a PDF document using Syncfusion<sup>®</sup> .NET MAUI PDF Viewer (SfPdfViewer) control.
4+
description: Learn how to add, remove, and edit annotations in a PDF document using the Syncfusion<sup>®</sup> .NET MAUI PDF Viewer (SfPdfViewer) control.
55
platform: document-processing
66
control: SfPdfViewer
77
documentation: ug
88
keywords: .net maui pdf viewer, .net maui view pdf, pdf viewer in .net maui, .net maui open pdf, maui pdf viewer, maui pdf view
99
---
1010

11-
# Add, Remove, and Edit Annotations in .NET MAUI PDF Viewer (SfPdfViewer)
11+
# Add, Remove, and Edit Annotations
1212

1313
This section will review the various functions in the [SfPdfViewer](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.PdfViewer.SfPdfViewer.html) for adding, removing, and editing annotations in a PDF document.
1414

@@ -190,3 +190,9 @@ private void OnAnnotationAdded(object sender, AnnotationEventArgs e)
190190

191191
{% endhighlight %}
192192
{% endtabs %}
193+
194+
## See Also
195+
- [Annotations Overview](../annotations-overview)
196+
- [Select and Deselect Annotations](../select-deselect-annotations)
197+
- [Import and Export Annotations](../import-export-annotations)
198+
- [Undo and Redo](../undo-redo)

‎Document-Processing/PDF/PDF-Viewer/maui/Annotation-Collection.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: post
33
title: Annotation Collection in .NET MAUI PDF Viewer control | Syncfusion
4-
description: Learn here all about annotation collection in Syncfusion<sup>®</sup> .NET MAUI PDF Viewer (SfPdfViewer) control and its uses.
4+
description: Learn how to access and manage the annotation collection in the Syncfusion<sup>®</sup> .NET MAUI PDF Viewer (SfPdfViewer) control.
55
platform: document-processing
66
control: SfPdfViewer
77
documentation: ug
@@ -61,3 +61,8 @@ private void OnAnnotationsLoaded(object? sender, EventArgs e)
6161

6262
{% endhighlight %}
6363
{% endtabs %}
64+
65+
## See Also
66+
- [Add, Remove, and Modify Annotations](../add-remove-modify-annotations)
67+
- [Annotations Overview](../annotations-overview)
68+
- [Select and Deselect Annotations](../select-deselect-annotations)

‎Document-Processing/PDF/PDF-Viewer/maui/Annotations-Comment.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: post
33
title: Comments in .NET MAUI PDF Viewer | Syncfusion
4-
description: Learn here all about how to add comments or replies to annotations in Syncfusion<sup>®</sup> .NET MAUI PDF Viewer (SfPdfViewer) control.
4+
description: Learn how to add and manage comments or replies on annotations in the Syncfusion<sup>®</sup> .NET MAUI PDF Viewer (SfPdfViewer) control.
55
platform: document-processing
66
control: SfPdfViewer
77
documentation: ug
@@ -92,3 +92,7 @@ Comments and replies can be deleted through the context menu available under the
9292
3. Select Delete from the context menu.
9393

9494
**Note :** Deleting the root comment from the comment panel also deletes the associated annotation.
95+
96+
## See Also
97+
- [Add, Remove, and Modify Annotations](../add-remove-modify-annotations)
98+
- [Annotations Overview](../annotations-overview)

‎Document-Processing/PDF/PDF-Viewer/maui/Annotations-Overview.md‎

Lines changed: 81 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: post
3-
title: About Annotations in .NET MAUI PDF Viewer control | Syncfusion
4-
description: Learn here all about introduction of Annotations in .NET MAUI PDF Viewer (SfPdfViewer) control, its functionalites and more.
3+
title: Annotations in .NET MAUI PDF Viewer | Syncfusion
4+
description: Learn about the annotation types and functionalities available in the Syncfusion<sup>®</sup> .NET MAUI PDF Viewer (SfPdfViewer) control.
55
platform: document-processing
66
control: SfPdfViewer
77
documentation: ug
@@ -10,28 +10,87 @@ keywords: .net maui pdf viewer, .net maui view pdf, pdf viewer in .net maui, .ne
1010

1111
# Annotations in .NET MAUI PDF Viewer (SfPdfViewer)
1212

13-
The [SfPdfViewer](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.PdfViewer.SfPdfViewer.html) allows you to add, remove and modify annotations in the PDF documents. This section will go through the various types and functionalities available in PDF Viewer for working with annotations.
13+
The [SfPdfViewer](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.PdfViewer.SfPdfViewer.html) allows you to add, remove, and modify annotations in PDF documents. Annotations are useful for marking up document content — for example, highlighting important text, drawing shapes to indicate areas of interest, adding sticky notes for reviewer comments, or stamping a document with a status indicator.
1414

15-
## Supported Annotation Types
16-
17-
The [SfPdfViewer](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.PdfViewer.SfPdfViewer.html) supports the following annotation types.
18-
19-
1. Arrow
20-
2. Circle
21-
3. Free text
22-
4. Highlight
23-
5. Ink
24-
6. Ink eraser
25-
7. Line
26-
8. Polygon
27-
9. Polyline
28-
10. Square
29-
11. Squiggly
30-
12. Stamp
31-
13. Sticky notes
32-
14. Strikeout
33-
15. Underline
15+
This section covers the annotation types and common functionalities available in the PDF Viewer. For detailed instructions on each annotation type, refer to the individual sections listed below.
3416

3517
To learn how to work with annotations, you can also check out our video tutorial below.
3618

3719
<style>#MAUISfPdfViewerVideoTutorial{width : 90% !important; height: 400px !important }</style> <iframe id='MAUISfPdfViewerVideoTutorial' src='https://www.youtube.com/embed/Vom4I_xt--I'></iframe>
20+
21+
## Supported Annotation Types
22+
23+
The [SfPdfViewer](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.PdfViewer.SfPdfViewer.html) supports the following annotation types, grouped by category.
24+
25+
### Text Markup Annotations
26+
27+
Use these annotations to mark up text content within the PDF document.
28+
29+
| Annotation | Description |
30+
|---|---|
31+
| Highlight | Highlights selected text with a color. |
32+
| Underline | Draws a line beneath selected text. |
33+
| Strikeout | Draws a line through selected text to indicate deletion. |
34+
| Squiggly | Draws a wavy underline to indicate a possible error or area of concern. |
35+
36+
For more information, see [Text Markup Annotations](../text-markups).
37+
38+
### Shape Annotations
39+
40+
Use these annotations to draw geometric shapes over PDF content.
41+
42+
| Annotation | Description |
43+
|---|---|
44+
| Arrow | Draws an arrow to point to specific content. |
45+
| Circle | Draws an ellipse or circle over the page. |
46+
| Line | Draws a straight line between two points. |
47+
| Polygon | Draws a closed polygon shape. |
48+
| Polyline | Draws an open multi-segment line. |
49+
| Square | Draws a rectangle over the page. |
50+
51+
For more information, see [Shape Annotations](../shapes).
52+
53+
### Freehand and Rich Content Annotations
54+
55+
| Annotation | Description |
56+
|---|---|
57+
| Ink | Draws freehand strokes over the page. |
58+
| Ink eraser | Erases parts of existing ink annotations. |
59+
| Free text | Adds a text box directly on the page. |
60+
| Stamp | Places an image or predefined stamp on the page. |
61+
| Sticky notes | Attaches a pop-up note to a specific location on the page. |
62+
63+
For more information, see [Ink Annotations](../ink), [Free Text Annotations](../free-text), [Stamps](../stamps), and [Sticky Notes](../sticky-notes).
64+
65+
## In This Section
66+
67+
### Annotation Types
68+
69+
| Topic | Description |
70+
|---|---|
71+
| [Text Markup Annotations](../text-markups) | Highlight, underline, strikeout, and squiggly annotations on selected text. |
72+
| [Shape Annotations](../shapes) | Draw arrows, circles, lines, polygons, polylines, and rectangles over pages. |
73+
| [Ink Annotations](../ink) | Draw freehand strokes over any page area. |
74+
| [Ink Eraser](../ink-eraser) | Erase portions of existing ink annotations. |
75+
| [Free Text Annotations](../free-text) | Place a text box directly on the page. |
76+
| [Stamps](../stamps) | Apply predefined or custom image stamps on a page. |
77+
| [Sticky Notes](../sticky-notes) | Attach pop-up notes to specific locations on a page. |
78+
79+
### Common Annotation Operations
80+
81+
| Topic | Description |
82+
|---|---|
83+
| [Add, Remove, and Modify Annotations](../add-remove-modify-annotations) | Programmatically add, update, and delete any annotation type. |
84+
| [Annotation Collection](../annotation-collection) | Access and iterate the full annotation collection. |
85+
| [Select and Deselect Annotations](../select-deselect-annotations) | Select one or more annotations programmatically. |
86+
| [Lock and Unlock Annotations](../lock-unlock) | Prevent annotations from being edited or deleted. |
87+
| [Show and Hide Annotations](../show-hide) | Toggle visibility of annotations without removing them. |
88+
| [Import and Export Annotations](../import-export-annotations) | Import/export annotation data in XFDF, FDF, JSON, and XML formats. |
89+
| [Undo and Redo](../undo-redo) | Reverse or reapply recent annotation changes. |
90+
| [Annotation Comments](../annotations-comment) | Add review comments and status to annotations. |
91+
92+
## See Also
93+
- [Add, Remove, and Modify Annotations](../add-remove-modify-annotations)
94+
- [Import and Export Annotations](../import-export-annotations)
95+
- [Save a Document](../save-a-document)
96+
- [Undo and Redo](../undo-redo)

‎Document-Processing/PDF/PDF-Viewer/maui/Coordinates-Conversion.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
---
1+
---
22
layout: post
3-
title: Working with PDF coordinates systems in MAUI PDF Viewer | Syncfusion
4-
description: Learn here all about coordinates conversion in Syncfusion<sup>®</sup> .NET MAUI PDF Viewer (SfPdfViewer) control.
3+
title: Coordinate Conversion in .NET MAUI PDF Viewer | Syncfusion
4+
description: Learn how to convert between PDF page coordinates and viewer coordinates in the Syncfusion<sup>®</sup> .NET MAUI PDF Viewer (SfPdfViewer) control.
55
platform: document-processing
66
control: SfPdfViewer
77
documentation: ug
@@ -138,3 +138,9 @@ if (annotation is SquareAnnotation squareAnnotation)
138138
}
139139
{% endhighlight %}
140140
{% endtabs %}
141+
142+
## See Also
143+
- [Annotations Overview](../annotations-overview)
144+
- [Page Navigation](../page-navigation)
145+
- [Scrolling](../scrolling)
146+

‎Document-Processing/PDF/PDF-Viewer/maui/Custom-Bookmark.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
layout: post
3-
title: Custom Bookmarks in .NET MAUI PDF Viewer Control | Syncfusion
4-
description: Discover how to navigate using custom bookmark navigation in Syncfusion<sup>®</sup> .NET MAUI PDF Viewer (SfPdfViewer) control.
3+
title: Custom Bookmarks in .NET MAUI PDF Viewer | Syncfusion
4+
description: Learn how to add, remove, and navigate using custom bookmarks in the Syncfusion<sup>®</sup> .NET MAUI PDF Viewer (SfPdfViewer) control.
55
platform: document-processing
66
control: SfPdfViewer
77
documentation: ug
8+
keywords: .net maui pdf viewer, .net maui view pdf, pdf viewer in .net maui, .net maui open pdf, maui pdf viewer, maui pdf view
89
---
910

1011
# Custom Bookmarks in .NET MAUI PDF Viewer
@@ -284,3 +285,8 @@ if (customBookmark != null)
284285

285286
{% endhighlight %}
286287
{% endtabs %}
288+
289+
## See Also
290+
- [Document Outline](../document-outline)
291+
- [Page Navigation](../page-navigation)
292+
- [Hyperlink Navigation](../hyperlink-navigation)

‎Document-Processing/PDF/PDF-Viewer/maui/Document-Link-Annotations.md‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
11
---
22
layout: post
3-
title: Document link navigation in .NET MAUI PDF Viewer control | Syncfusion
4-
description: Learn here about document link navigation in Syncfusion<sup>®</sup> .NET MAUI PDF Viewer (SfPdfViewer) control.
3+
title: Document Link Navigation in .NET MAUI PDF Viewer | Syncfusion
4+
description: Learn how to navigate using document link annotations in the Syncfusion<sup>®</sup> .NET MAUI PDF Viewer (SfPdfViewer) control.
55
platform: document-processing
66
control: SfPdfViewer
77
documentation: ug
8+
keywords: .net maui pdf viewer, .net maui view pdf, pdf viewer in .net maui, .net maui open pdf, maui pdf viewer, maui pdf view
89
---
910

1011
# Document Link Navigation in .NET MAUI PDF Viewer (SfPdfViewer)
1112

12-
The PDF viewer allows navigating from one part of the PDF document to another using document link annotations. When a document link annotation is tapped, the PDF viewer scrolls to its destination. This type of link annotation is most often used to represent the table of contents of a PDF document.
13+
The PDF viewer allows navigating from one part of the PDF document to another using document link annotations. When a document link annotation is tapped, the PDF viewer scrolls to the destination page or location defined by that annotation. This type of annotation is most commonly used to make a PDF's table of contents interactive — each entry links directly to the corresponding page in the document.
1314

14-
The document link navigation can be turned on or off using the [EnableDocumentLinkNavigation](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.PdfViewer.SfPdfViewer.html#Syncfusion_Maui_PdfViewer_SfPdfViewer_EnableDocumentLinkNavigation) property. The default value of this property is true. The code snippet below illustrates disabling the document link navigation.
15+
N> Document link annotations differ from hyperlink annotations. Document links navigate **within** the same PDF document, while hyperlinks open an external URL in the device browser. See [Hyperlink Navigation](https://help.syncfusion.com/maui/pdf-viewer/hyperlink-navigation) for details on handling external links.
16+
17+
## Enable or Disable Document Link Navigation
18+
19+
The document link navigation can be turned on or off using the [EnableDocumentLinkNavigation](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.PdfViewer.SfPdfViewer.html#Syncfusion_Maui_PdfViewer_SfPdfViewer_EnableDocumentLinkNavigation) property. The default value of this property is `true`. The code snippet below illustrates disabling the document link navigation.
1520

1621
{% tabs %}
1722
{% highlight c# %}
@@ -20,3 +25,8 @@ pdfViewer.EnableDocumentLinkNavigation = false;
2025

2126
{% endhighlight %}
2227
{% endtabs %}
28+
29+
## See Also
30+
- [Hyperlink Navigation](../hyperlink-navigation)
31+
- [Page Navigation](../page-navigation)
32+
- [Document Outline (Bookmarks)](../document-outline)

‎Document-Processing/PDF/PDF-Viewer/maui/Document-Outline.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
layout: post
3-
title: Document outline in .NET MAUI PDF Viewer control | Syncfusion
4-
description: Learn here about the document outline and outline navigation in Syncfusion<sup>®</sup> .NET MAUI PDF Viewer (SfPdfViewer) control.
3+
title: Document Outline in .NET MAUI PDF Viewer | Syncfusion
4+
description: Learn how to use the document outline view for navigation in the Syncfusion<sup>®</sup> .NET MAUI PDF Viewer (SfPdfViewer) control.
55
platform: document-processing
66
control: SfPdfViewer
77
documentation: ug
8+
keywords: .net maui pdf viewer, .net maui view pdf, pdf viewer in .net maui, .net maui open pdf, maui pdf viewer, maui pdf view
89
---
910

1011
# Document outline in .NET MAUI PDF Viewer
@@ -75,4 +76,9 @@ if (outlineElement != null)
7576
pdfViewer.GoToOutlineElement(outlineElement);
7677

7778
{% endhighlight %}
78-
{% endtabs %}
79+
{% endtabs %}
80+
81+
## See Also
82+
- [Page Navigation](../page-navigation)
83+
- [Document Link Annotations](../document-link-annotations)
84+
- [Custom Bookmark](../custom-bookmark)

‎Document-Processing/PDF/PDF-Viewer/maui/DocumentLoadNotifications.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
layout: post
3-
title: Document Load Events in .NET MAUI PDF Viewer control | Syncfusion
4-
description: Learn here all about events that notifies whether the document has been opened or not opened in the Syncfusion<sup>®</sup> .NET MAUI PDF Viewer (SfPdfViewer).
3+
title: Document Load Events in .NET MAUI PDF Viewer | Syncfusion
4+
description: Learn how to handle document load events in the Syncfusion<sup>®</sup> .NET MAUI PDF Viewer (SfPdfViewer) to detect when a document is opened or fails to open.
55
platform: document-processing
66
control: SfPdfViewer
77
documentation: ug
8+
keywords: .net maui pdf viewer, .net maui view pdf, pdf viewer in .net maui, .net maui open pdf, maui pdf viewer, maui pdf view
89
---
910

1011
# Document Load Events in .NET MAUI PDF Viewer (SfPdfViewer)
@@ -107,3 +108,8 @@ private void PdfDocumentLoadFailed(object sender, DocumentLoadFailedEventArgs e)
107108

108109
{% endhighlight %}
109110
{% endtabs %}
111+
112+
## See Also
113+
- [Open a Document](../open-a-document)
114+
- [Getting Started](../getting-started)
115+
- [Save a Document](../save-a-document)

0 commit comments

Comments
 (0)