Skip to content

Commit 944342e

Browse files
Merge pull request #1546 from syncfusion-content/984774-pv-review
984774: Update the documentation corrections
2 parents b6c636b + 1cddc1b commit 944342e

File tree

77 files changed

+378
-227
lines changed

Some content is hidden

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

77 files changed

+378
-227
lines changed

Document-Processing-toc.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -490,7 +490,7 @@
490490
</li>
491491
<li>Deployment
492492
<ul>
493-
<li><a href="/document-processing/pdf/pdf-viewer/blazor/getting-started/wsl-application">Windows Subsystem for Linux</a></li>
493+
<li><a href="/document-processing/pdf/pdf-viewer/blazor/deployment/wsl-application">Windows Subsystem for Linux</a></li>
494494
<li><a href="/document-processing/pdf/pdf-viewer/blazor/deployment/aws-beanstalk-deployment">AWS Elastic Beanstalk</a></li>
495495
</ul>
496496
</li>
@@ -513,7 +513,7 @@
513513
<li><a href="/document-processing/pdf/pdf-viewer/blazor/save-pdf-file/to-box-cloud-file-storage">To Box cloud file storage</a></li>
514514
</ul>
515515
</li>
516-
<li> <a href="/document-processing/pdf/pdf-viewer/blazor/toolbar">Toolbar</a>
516+
<li> <a href="/document-processing/pdf/pdf-viewer/blazor/toolbar-overview">Toolbar</a>
517517
<ul>
518518
<li><a href="/document-processing/pdf/pdf-viewer/blazor/toolbar/primary-toolbar-customization">Primary Toolbar Customization</a></li>
519519
<li><a href="/document-processing/pdf/pdf-viewer/blazor/toolbar/annotation-toolbar-customization">Annotation Toolbar Customization</a></li>
@@ -523,7 +523,7 @@
523523
</ul>
524524
</li>
525525
<li> <a href="/document-processing/pdf/pdf-viewer/blazor/command-manager">Command Manager</a></li>
526-
<li> <a href="/document-processing/pdf/pdf-viewer/blazor/interactive-pdf-navigation">Interactive PDF Navigation</a>
526+
<li> <a href="/document-processing/pdf/pdf-viewer/blazor/interactive-pdf-navigation-overview">Interactive PDF Navigation</a>
527527
<ul>
528528
<li><a href="/document-processing/pdf/pdf-viewer/blazor/interactive-pdf-navigation/page-navigation">Page Navigation</a></li>
529529
<li><a href="/document-processing/pdf/pdf-viewer/blazor/interactive-pdf-navigation/bookmark-navigation">Bookmark Navigation</a></li>
@@ -572,7 +572,7 @@
572572
</li>
573573
<li> <a href="/document-processing/pdf/pdf-viewer/blazor/form-filling">Form Filling</a></li>
574574
<li> <a href="/document-processing/pdf/pdf-viewer/blazor/print">Print</a></li>
575-
<li> <a href="/document-processing/pdf/pdf-viewer/blazor/document-security">Document security</a>
575+
<li> <a href="/document-processing/pdf/pdf-viewer/blazor/document-security-overview">Document security</a>
576576
<ul>
577577
<li><a href="/document-processing/pdf/pdf-viewer/blazor/document-security/password-protected">Password Protected</a></li>
578578
<li><a href="/document-processing/pdf/pdf-viewer/blazor/document-security/permission">Permission</a></li>

Document-Processing/PDF/PDF-Viewer/blazor/annotation/annotations-in-mobile-view.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ control: SfPdfViewer
77
documentation: ug
88
---
99

10+
# Annotations in mobile view
11+
1012
This article explains how to work with annotations in the mobile view of the Blazor SfPdfViewer. It covers opening the annotation toolbar, adding each annotation type, adjusting properties, deleting annotations, and using the comments panel.
1113

12-
# To open the annotation toolbar
14+
## To open the annotation toolbar
1315

1416
To open the annotation toolbar, tap the **Edit Annotation** option in the mobile primary toolbar. The annotation toolbar appears at the bottom of the viewer.
1517

@@ -107,13 +109,13 @@ When finished, tap the Ink Annotation icon again to exit drawing mode. The prope
107109

108110
![Complete an ink annotation in Blazor SfPdfViewer](../images/complete-ink-annotation.png)
109111

110-
## Change annotation properties (Before adding)
112+
## Change annotation properties before adding
111113

112114
Annotation properties can be configured before placement. For example, tap the rectangle shape to show its properties toolbar, adjust the settings, and then tap and drag to place the annotation. The annotation is added using the modified properties.
113115

114116
![Change properties before adding an annotation in Blazor SfPdfViewer](../images/property-change-before-adding.gif)
115117

116-
## Change annotation properties (After adding)
118+
## Change annotation properties after adding
117119

118120
After placement, select the annotation to display its properties toolbar. Adjust the required properties; the changes are applied immediately to the selected annotation.
119121

@@ -134,3 +136,7 @@ Open the comments panel from the **more option** menu at the right end of the mo
134136
To close the comments panel, tap the Close icon within the panel.
135137

136138
![Comments panel displayed in Blazor SfPdfViewer](../images/open-cooment-panel.png)
139+
140+
## See Also
141+
142+
* [Annotation Toolbar in Mobile mode](../annotation/annotations-in-mobile-view)

Document-Processing/PDF/PDF-Viewer/blazor/annotation/comments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ N> Deleting the root comment from the comment panel also deletes the associated
109109

110110
### Show or hide the Comment panel
111111

112-
The SfPdfViewer component provides an option to show or hide the comment panel by using the `CommentPanelVisible` property.
112+
The SfPdfViewer component provides an option to show or hide the comment panel by using the [CommentPanelVisible](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_CommentPanelVisible) property.
113113

114114
The following code snippet explains how to show the comment panel.
115115

Document-Processing/PDF/PDF-Viewer/blazor/annotation/free-text-annotation.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Adjust the annotation opacity using the range slider in the Edit Opacity tool.
103103

104104
## Setting default properties during control initialization
105105

106-
Default properties for free text annotations can be set during component initialization using FreeTextSettings. These values apply to newly created annotations. Any subsequent changes made from the annotation toolbar affect only annotations created afterward.
106+
Default properties for free text annotations can be set during component initialization using [FreeTextSettings](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_FreeTextSettings). These values apply to newly created annotations. Any subsequent changes made from the annotation toolbar affect only annotations created afterward.
107107

108108
```cshtml
109109
@@ -281,8 +281,10 @@ If a custom font is not installed on the system, use FallbackFontCollection to e
281281
pdfViewer.FallbackFontCollection.Add("Courier New", new MemoryStream(System.IO.File.ReadAllBytes("wwwroot/Fonts/COUR.ttf")));
282282
}
283283
}
284+
284285
```
285286
### Adding Custom Font Families to the Annotation Toolbar Dropdown
287+
286288
Use the FontFamilies property to add custom font families to the Font Family dropdown in the annotation toolbar.
287289

288290
```cshtml
@@ -364,4 +366,5 @@ The following example illustrates loading custom fonts in FreeText annotations u
364366
## See also
365367

366368
* [How to delete the annotation programmatically](./text-markup-annotation#delete-annotation-programmatically)
367-
* [How to Load the Font Collection in SfPdfViewer](../how-to/load-font-collection)
369+
370+
* [How to Load the Font Collection in SfPdfViewer](../faqs/how-to-load-font-collection)

Document-Processing/PDF/PDF-Viewer/blazor/annotation/import-export-annotation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The SfPdfViewer component supports importing and exporting annotations as a JSON
4242

4343
## Importing annotation using SfPdfViewer API
4444

45-
Annotations can also be imported from a JSON or XFDF file, or from an in-memory object, in code-behind using the ImportAnnotationAsync method. The following example uses the SfPdfViewer2 component.
45+
Annotations can also be imported from a JSON or XFDF file, or from an in-memory object, in code-behind using the [ImportAnnotationAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_ImportAnnotationAsync_System_IO_Stream_Syncfusion_Blazor_SfPdfViewer_AnnotationDataFormat_) method. The following example uses the SfPdfViewer2 component.
4646

4747
Supported formats:
4848
- [JSON](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.AnnotationDataFormat.html#Syncfusion_Blazor_SfPdfViewer_AnnotationDataFormat_Json)
@@ -99,7 +99,7 @@ N> The Export Annotations option is disabled when the loaded PDF document does n
9999

100100
## Exporting annotation using SfPdfViewer API
101101

102-
Annotations can also be exported as a file or as a stream in code-behind using the ExportAnnotationAsync and ExportAnnotationAsStreamAsync methods. Supported formats:
102+
Annotations can also be exported as a file or as a stream in code-behind using the [ExportAnnotationAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_ExportAnnotationAsync_Syncfusion_Blazor_SfPdfViewer_AnnotationDataFormat_) and [ExportAnnotationAsStreamAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_ExportAnnotationAsStreamAsync_Syncfusion_Blazor_SfPdfViewer_AnnotationDataFormat_) methods. Supported formats:
103103

104104
- [JSON](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.AnnotationDataFormat.html#Syncfusion_Blazor_SfPdfViewer_AnnotationDataFormat_Json)
105105
- [XFDF](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.AnnotationDataFormat.html#Syncfusion_Blazor_SfPdfViewer_AnnotationDataFormat_Xfdf)
@@ -153,4 +153,4 @@ Annotations can also be exported as a file or as a stream in code-behind using t
153153

154154
## See also
155155

156-
* [How to import annotations as objects](../how-to/import-annotations-as-objects)
156+
* [How to import annotations as objects](../faqs/how-to-import-annotations-as-objects)

Document-Processing/PDF/PDF-Viewer/blazor/annotation/ink-annotation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Control the transparency using the range slider in the Edit Opacity tool.
6565

6666
## Setting default properties during the control initialization
6767

68-
Default properties for ink annotations can be configured before rendering the component using InkAnnotationSettings. After interacting with the toolbar, subsequent annotations will use the most recently selected values.
68+
Default properties for ink annotations can be configured before rendering the component using [InkAnnotationSettings](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_InkAnnotationSettings). After interacting with the toolbar, subsequent annotations will use the most recently selected values.
6969

7070
```cshtml
7171

Document-Processing/PDF/PDF-Viewer/blazor/annotation/measurement-annotation.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ The properties of line-based annotations such as Distance and Perimeter can be e
9393

9494
## Setting default properties during control initialization
9595

96-
Set default properties for measurement annotations before initializing the control using DistanceSettings, PerimeterSettings, AreaSettings, RadiusSettings, and VolumeSettings.
96+
Set default properties for measurement annotations before initializing the control using [DistanceSettings](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_DistanceSettings), [PerimeterSettings](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_PerimeterSettings), [AreaSettings](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_AreaSettings), [RadiusSettings](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_RadiusSettings), and [VolumeSettings](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_VolumeSettings).
9797

9898
```cshtml
9999
@@ -169,7 +169,7 @@ The supported units of measurement for measurement annotations are:
169169

170170
## Setting default scale ratio settings during control initialization
171171

172-
Set default scale ratio settings for measurement annotations before initializing the control using ScaleRatioSettings, as shown below.
172+
Set default scale ratio settings for measurement annotations before initializing the control using [ScaleRatioSettings](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerMeasurementSettings.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerMeasurementSettings_ScaleRatio), as shown below.
173173

174174
```cshtml
175175
@@ -193,6 +193,7 @@ Set default scale ratio settings for measurement annotations before initializing
193193
ConversionUnit = CalibrationUnit.Cm
194194
};
195195
}
196+
196197
```
197198

198199
## Add measurement annotation programmatically

Document-Processing/PDF/PDF-Viewer/blazor/annotation/shape-annotation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Properties for line-based shapes (Line and Arrow) can be adjusted in the Line Pr
9292

9393
## Setting default properties during control initialization
9494

95-
Default properties for shape annotations can be configured during initialization using LineSettings, ArrowSettings, RectangleSettings, CircleSettings, and PolygonSettings. These apply when the corresponding shape is created from the toolbar or programmatically.
95+
Default properties for shape annotations can be configured during initialization using [LineSettings](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_LineSettings), [ArrowSettings](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_AreaSettings), [RectangleSettings](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_RectangleSettings), [CircleSettings](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_CircleSettings), and [PolygonSettings](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_PolygonSettings). These apply when the corresponding shape is created from the toolbar or programmatically.
9696

9797
```cshtml
9898
@@ -190,7 +190,7 @@ The appearance of an annotation’s selector can be customized using [Annotation
190190

191191
## Add shape annotation Programmatically
192192

193-
The Blazor SfPdfViewer supports programmatic creation of shape annotationsRectangle, Line, Arrow, Circle, and Polygonusing [AddAnnotationAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_AddAnnotationAsync_Syncfusion_Blazor_SfPdfViewer_PdfAnnotation_). Ensure the document is loaded and the component reference is available before invoking API calls.
193+
The Blazor SfPdfViewer supports programmatic creation of shape annotations Rectangle, Line, Arrow, Circle, and Polygon using [AddAnnotationAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_AddAnnotationAsync_Syncfusion_Blazor_SfPdfViewer_PdfAnnotation_). Ensure the document is loaded and the component reference is available before invoking API calls.
194194

195195
Below is an example demonstrating how to use this method to add a shape annotation to a PDF document:
196196

@@ -320,7 +320,7 @@ The following code demonstrates how to delete multiple annotations at once in PD
320320

321321
## Edit shape annotation Programmatically
322322

323-
Shape annotationsRectangle, Line, Arrow, Circle, and Polygoncan be edited programmatically using [EditAnnotationAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_EditAnnotationAsync_Syncfusion_Blazor_SfPdfViewer_PdfAnnotation_). Retrieve the target annotation from [GetAnnotationsAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_GetAnnotationsAsync) and update the desired properties before submitting the edit.
323+
Shape annotations Rectangle, Line, Arrow, Circle, and Polygon can be edited programmatically using [EditAnnotationAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_EditAnnotationAsync_Syncfusion_Blazor_SfPdfViewer_PdfAnnotation_). Retrieve the target annotation from [GetAnnotationsAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_GetAnnotationsAsync) and update the desired properties before submitting the edit.
324324

325325
Below is an example demonstrating how to edit a shape annotation programmatically:
326326

Document-Processing/PDF/PDF-Viewer/blazor/annotation/stamp-annotation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ N> Only JPEG (JPG/JPEG) image formats are supported for custom stamp annotations
4949

5050
## Setting default properties during control initialization
5151

52-
Default properties for stamp annotations can be configured before the component is created by using `StampSettings`. These defaults apply to newly added stamp annotations.
52+
Default properties for stamp annotations can be configured before the component is created by using [StampSettings](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_StampSettings). These defaults apply to newly added stamp annotations.
5353

5454
After changing the default opacity using the Edit Opacity tool, the currently selected value is applied to subsequent stamps.
5555

@@ -81,7 +81,7 @@ After changing the default opacity using the Edit Opacity tool, the currently se
8181

8282
## Adding a custom stamp to the PDF document via PdfViewerCustomStampSettings
8383

84-
An image can be added as a custom stamp icon by using the `CustomStamps` property of the `PdfViewerCustomStampSettings` class.
84+
An image can be added as a custom stamp icon by using the [CustomStamps](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerCustomStampSettings.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerCustomStampSettings_CustomStamps) property of the [PdfViewerCustomStampSettings](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_CustomStampSettings) class.
8585

8686
The following example illustrates how to add an image as a stamp annotation in the SfPdfViewer.
8787

Document-Processing/PDF/PDF-Viewer/blazor/annotation/sticky-notes-annotation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Use the menu in the Comment panel to modify or delete comments, replies, and the
5353

5454
## Setting default properties during control initialization
5555

56-
Set default properties for sticky notes annotations before initializing the control using StickyNotesSettings.
56+
Set default properties for sticky notes annotations before initializing the control using [StickyNotesSettings](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_StickyNotesSettings).
5757

5858
After changing the default opacity using the Edit Opacity tool, the values are updated to the selected settings.
5959

0 commit comments

Comments
 (0)