Skip to content

Commit e5e09f8

Browse files
Merge pull request #4585 from syncfusion-content/EJ2-895038-apiReference
895038: Update API reference link
2 parents 202ee16 + 1173936 commit e5e09f8

22 files changed

+35
-35
lines changed

blazor/pdfviewer-2/events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ The events provided in SfPdfViewer component are listed out as follows:
6161

6262
## Adding SfPdfViewer events to Blazor component
6363

64-
The Syncfusion SfPdfViewer events has to be wrapped inside the `PdfViewerEvents` tag.
64+
The Syncfusion SfPdfViewer events has to be wrapped inside the [PdfViewerEvents](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerEvents.html) tag.
6565

6666
```cshtml
6767

blazor/pdfviewer-2/getting-started/deploy-maui-windows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ Add the Syncfusion PDF Viewer (Next Gen) component in the **~/Pages/Index.razor*
121121
{% endhighlight %}
122122
{% endtabs %}
123123

124-
N> If the `DocumentPath` property value is not provided, the PDF Viewer (Next Gen) component will be rendered without loading a PDF document. Users can then use the open option from the toolbar to browse and open a PDF as required.
124+
N> If the [DocumentPath](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_DocumentPath) property value is not provided, the PDF Viewer (Next Gen) component will be rendered without loading a PDF document. Users can then use the open option from the toolbar to browse and open a PDF as required.
125125

126126
## Run on Windows
127127

blazor/pdfviewer-2/getting-started/server-side-application.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Add the Syncfusion PDF Viewer (Next Gen) component in the **~/Pages/Index.razor*
102102
{% endhighlight %}
103103
{% endtabs %}
104104

105-
N> If you don't provide the `DocumentPath` property value, the PDF Viewer (Next Gen) component will be rendered without loading the PDF document. Users can then use the **open** option from the toolbar to browse and open the PDF as required.
105+
N> If you don't provide the [DocumentPath](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_DocumentPath) property value, the PDF Viewer (Next Gen) component will be rendered without loading the PDF document. Users can then use the **open** option from the toolbar to browse and open the PDF as required.
106106

107107
## Run the application
108108

blazor/pdfviewer-2/getting-started/web-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ Add the Syncfusion PDF Viewer component in the **~/Pages/Index.razor** file.
224224
{% endhighlight %}
225225
{% endtabs %}
226226

227-
N> If you don’t provide the `DocumentPath` property value, the PDF Viewer (Next Gen) component will be rendered without loading the PDF document. Users can then use the **open** option from the toolbar to browse and open the PDF as required.
227+
N> If you don’t provide the [DocumentPath](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_DocumentPath) property value, the PDF Viewer (Next Gen) component will be rendered without loading the PDF document. Users can then use the **open** option from the toolbar to browse and open the PDF as required.
228228

229229
## Run the application
230230

blazor/pdfviewer-2/getting-started/web-assembly-application.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Add the Syncfusion PDF Viewer (Next Gen) component in the **~/Pages/Index.razor*
120120
{% endhighlight %}
121121
{% endtabs %}
122122

123-
N> If you don't provide the `DocumentPath` property value, the PDF Viewer (Next Gen) component will be rendered without loading the PDF document. Users can then use the **open** option from the toolbar to browse and open the PDF as required.
123+
N> If you don't provide the [DocumentPath](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_DocumentPath) property value, the PDF Viewer (Next Gen) component will be rendered without loading the PDF document. Users can then use the **open** option from the toolbar to browse and open the PDF as required.
124124

125125
## Run the application
126126

blazor/pdfviewer-2/globalization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ documentation: ug
1515

1616
## Right to Left
1717

18-
To enable right-to-left (RTL) rendering for the user interface, you can set the `EnableRtl` property of the desired control to `true`. This will ensure that the control is rendered appropriately for users who use RTL languages such as Arabic, Hebrew, Azerbaijani, Persian, and Urdu. The following code snippet demonstrates how to enable RTL rendering.
18+
To enable right-to-left (RTL) rendering for the user interface, you can set the [EnableRtl](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_EnableRtl) property of the desired control to `true`. This will ensure that the control is rendered appropriately for users who use RTL languages such as Arabic, Hebrew, Azerbaijani, Persian, and Urdu. The following code snippet demonstrates how to enable RTL rendering.
1919

2020
By setting EnableRtl to `true`, the control will adjust its layout and appearance to align text, icons, and other elements from right to left, providing an optimized user experience for RTL language users.
2121

blazor/pdfviewer-2/how-to/deploy-maui-using-android-emulator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Add the Syncfusion PDF Viewer (Next Gen) component in the **~/Pages/Index.razor*
4848
{% endhighlight %}
4949
{% endtabs %}
5050

51-
N> When developing a Blazor Android MAUI application, passing the `DocumentPath` to the PDF Viewer (Next Gen) component as a `base64 string` is needed. This ensures that the application can retrieve and render a PDF document correctly within the PDF Viewer (Next Gen) component.
51+
N> When developing a Blazor Android MAUI application, passing the [DocumentPath](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_DocumentPath) to the PDF Viewer (Next Gen) component as a `base64 string` is needed. This ensures that the application can retrieve and render a PDF document correctly within the PDF Viewer (Next Gen) component.
5252

5353
## Run on Android emulator
5454

blazor/pdfviewer-2/how-to/get-data-from-sfpdfviewer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ documentation: ug
99

1010
# Get PDF document's data from Blazor SfPdfViewer Component
1111

12-
You can get the loaded PDF document's data from the SfPdfViewer component using the `GetDocumentAsync()` method of SfPdfViewer.
12+
You can get the loaded PDF document's data from the SfPdfViewer component using the [GetDocumentAsync()](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_GetDocumentAsync) method of SfPdfViewer.
1313

1414
The following code example shows how to get the loaded/edited document data and re-load the document.
1515

blazor/pdfviewer-2/how-to/identify-the-values-in-the-undo-redo-collections.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ documentation: ug
99

1010
# Identify if the SfPdfViewer has values in the Undo, Redo collections
1111

12-
Syncfusion's Blazor SfPdfViewer component allows you to identify if the SfPdfViewer has values in the Undo and Redo collections using the `CanUndo` and `CanRedo` APIs of the SfPdfViewer.
12+
Syncfusion's Blazor SfPdfViewer component allows you to identify if the SfPdfViewer has values in the Undo and Redo collections using the [CanUndo](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_CanUndo) and [CanRedo](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_CanRedo) APIs of the SfPdfViewer.
1313

1414
The following code example shows how to achieve this based on the Undo Redo actions.
1515

blazor/pdfviewer-2/how-to/load-desired-pdf-for-initial-loading-in-hosted-sample.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: post
3-
title: Load desired PDF for initial loading in Blazor SfPdfViewer | Syncfusion
3+
title: Load PDF for initial loading in Blazor SfPdfViewer | Syncfusion
44
description: Learn here all about how to load desired PDF for initial loading in Syncfusion Blazor SfPdfViewer component and more.
55
platform: Blazor
66
control: SfPdfViewer
@@ -9,7 +9,7 @@ documentation: ug
99

1010
# Load desired PDF for initial loading in Blazor SfPdfViewer Component
1111

12-
You can load your own PDF document for initial loading as well as change the document at runtime in the Blazor SfPdfViewer component.To load your desired PDF document for initial display, you need to set the `DocumentPath` property of the SfPdfViewer component to the path of your PDF file.
12+
You can load your own PDF document for initial loading as well as change the document at runtime in the Blazor SfPdfViewer component.To load your desired PDF document for initial display, you need to set the [DocumentPath](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_DocumentPath) property of the SfPdfViewer component to the path of your PDF file.
1313

1414
```cshtml
1515
@@ -42,7 +42,7 @@ You can load your own PDF document for initial loading as well as change the doc
4242
4343
```
4444

45-
In the above code, When the `Load Another Document` button is clicked, the `LoadAnotherDocument` method is triggered. This method uses the HttpClient service to retrieve the desired PDF document as a `byte` array. The byte array is then converted to a `base64` string, and the `DocumentPath` property is updated with the new document path.
45+
In the above code, When the `Load Another Document` button is clicked, the `LoadAnotherDocument` method is triggered. This method uses the HttpClient service to retrieve the desired PDF document as a `byte` array. The byte array is then converted to a `base64` string, and the [DocumentPath](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_DocumentPath) property is updated with the new document path.
4646

4747
With this implementation, users can click the `Load Another Document` button to dynamically change the PDF document displayed in the Blazor SfPdfViewer component.
4848

blazor/pdfviewer-2/how-to/load-pdf-document-dynamically.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: post
3-
title: Load PDF documents dynamically in Blazor SfPdfViewer component| Syncfusion
3+
title: Load PDF File dynamically in Blazor SfPdfViewer component| Syncfusion
44
description: Learn here all about how to load PDF documents dynamically in Syncfusion Blazor SfPdfViewer component and more.
55
platform: Blazor
66
control: SfPdfViewer
@@ -9,7 +9,7 @@ documentation: ug
99

1010
# Load PDF documents dynamically in Blazor SfPdfViewer Component
1111

12-
At times, you might need to switch or load the PDF documents dynamically after the initial load operation. To achieve this, load the PDF document as a base64 string or file path in SfPdfViewer control using the `LoadAsync()` method dynamically.
12+
At times, you might need to switch or load the PDF documents dynamically after the initial load operation. To achieve this, load the PDF document as a base64 string or file path in SfPdfViewer control using the [LoadAsync()](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_LoadAsync_System_Byte___System_String_) method dynamically.
1313

1414
The following code example shows how to load a bas64 string dynamically.
1515

blazor/pdfviewer-2/how-to/unload-the-pdf-document-from-viewer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ documentation: ug
1111

1212
The SfPdfViewer component will automatically unload and clear the resources occupied by the PDF document when the control is disposed. Also, when loading another PDF file, the resources occupied by previous loaded file in viewer will be automatically unloaded and cleared.
1313

14-
If you want to unload and clear the resources occupied by the PDF file programmatically, invoke the `Unload()` method as shown below.
14+
If you want to unload and clear the resources occupied by the PDF file programmatically, invoke the [Unload()](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_UnloadAsync) method as shown below.
1515

1616
```cshtml
1717

blazor/pdfviewer-2/how-to/update-form-field-using-context-menu.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: post
3-
title: Update form field using context menu in Blazor SfPdfViewer | Syncfusion
3+
title: Update formField using contextMenu in Blazor SfPdfViewer | Syncfusion
44
description: Learn here all about how to update form field using context menu in Syncfusion Blazor SfPdfViewer component and more.
55
platform: Blazor
66
control: SfPdfViewer
@@ -9,7 +9,7 @@ documentation: ug
99

1010
# Update form field using context menu in Blazor SfPdfViewer Component
1111

12-
You can update the form field's at runtime using the `FormFieldClick event` and `UpdateFormFieldsAsync()` method of SfPdfViewer. The following code example explains how to open Context menu when you click on the form field and how to update the menu item content as form field's value. In this example, the Syncfusion’s ContextMenu component is used to update form field.
12+
You can update the form field's at runtime using the [FormFieldClick event](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.FormFieldClickArgs.html) and [UpdateFormFieldsAsync()](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_UpdateFormFieldsAsync_Syncfusion_Blazor_SfPdfViewer_FormField_) method of SfPdfViewer. The following code example explains how to open Context menu when you click on the form field and how to update the menu item content as form field's value. In this example, the Syncfusion’s ContextMenu component is used to update form field.
1313

1414

1515
```cshtml

blazor/pdfviewer-2/interaction.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ In this mode, the text selection can be performed in the PDF document loaded in
2020

2121
N> The panning and scrolling of the pages by touch cannot be performed in this mode.
2222

23-
You can enable or disable text selection by setting the `EnableTextSelection` property.
23+
You can enable or disable text selection by setting the [EnableTextSelection](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_EnableTextSelection) property.
2424

2525
```cshtml
2626
@@ -41,7 +41,7 @@ You can enable or disable text selection by setting the `EnableTextSelection` pr
4141

4242
In this mode, the panning and scrolling of the pages can be performed in the PDF document loaded in the SfPdfViewer, but the text selection cannot be performed.
4343

44-
You can change the interaction mode of SfPdfViewer using the `InteractionMode` property.
44+
You can change the interaction mode of SfPdfViewer using the [InteractionMode](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_InteractionMode) property.
4545

4646
```cshtml
4747
@@ -59,7 +59,7 @@ You can change the interaction mode of SfPdfViewer using the `InteractionMode` p
5959
```
6060
## Disable interaction with Annotations
6161

62-
You can disable the annotation interactions such as dragging, resizing, deleting the annotations by using the `IsLock` property of `AnnotationSettings`.
62+
You can disable the annotation interactions such as dragging, resizing, deleting the annotations by using the `IsLock` property of [AnnotationSettings](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_AnnotationSettings).
6363

6464
The following code illustrates how to disable the annotation interaction.
6565

blazor/pdfviewer-2/navigation.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The built-in toolbar of SfPdfViewer contains the following page navigation tools
2929

3030
![Blazor SfPdfViewer with Page Navigation](../pdfviewer/images/blazor-pdfviewer-page-navigation.png)
3131

32-
You can enable or disable the page navigation option in SfPdfViewer default toolbar by setting the `EnableNavigation` property.
32+
You can enable or disable the page navigation option in SfPdfViewer default toolbar by setting the [EnableNavigation](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_EnableNavigation) property.
3333

3434
```cshtml
3535
@@ -120,7 +120,7 @@ The bookmarks saved in PDF files are loaded and listed in the bookmark pane (in
120120

121121
![Blazor SfPdfViewer with Bookmark Navigation](../pdfviewer/images/blazor-pdfviewer-bookmark-navigation.png)
122122

123-
You can enable or disable the bookmark navigation pane by setting the `EnableBookmark` property.
123+
You can enable or disable the bookmark navigation pane by setting the [EnableBookmark](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_EnableBookmarkPanel) property.
124124

125125
```cshtml
126126
@@ -140,7 +140,7 @@ Page thumbnails is the miniature representation of actual pages in the PDF files
140140

141141
![Blazor SfPdfViewer with Page Thumbnail Navigation](../pdfviewer/images/blazor-pdfviewer-page-thumbnail-navigation.png)
142142

143-
You can enable or disable the thumbnail navigation pane by setting the `EnableThumbnail` property.
143+
You can enable or disable the thumbnail navigation pane by setting the [EnableThumbnail](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_EnableThumbnailPanel) property.
144144

145145
```cshtml
146146
@@ -156,7 +156,7 @@ You can enable or disable the thumbnail navigation pane by setting the `EnableTh
156156

157157
### Open thumbnail panel programmatically
158158

159-
You can view the thumbnail navigation initially while loading the PDF document in the PDFViewer using the `IsThumbnailPanelOpen` property.
159+
You can view the thumbnail navigation initially while loading the PDF document in the PDFViewer using the [IsThumbnailPanelOpen](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_IsThumbnailPanelOpen) property.
160160

161161
The following code illustrates how to open thumbnail panel programmatically.
162162

@@ -209,7 +209,7 @@ You can enable or disable both hyperlink and table of content navigation by sett
209209
210210
```
211211

212-
You can set the target attribute for a hyperlink in SfPdfViewer using the `HyperlinkOpenState` property.
212+
You can set the target attribute for a hyperlink in SfPdfViewer using the [HyperlinkOpenState](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_HyperlinkOpenState) property.
213213

214214
```cshtml
215215

blazor/pdfviewer-2/open-pdf-file/from-amazon-s3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Start by following the steps provided in this [link](https://blazor.syncfusion.c
7070
}
7171
```
7272

73-
Replace the file name with the actual document name that you want to load from Box cloud file storage. Make sure to pass the document name from the box folder to the `documentPath` property of the SfPdfViewer component
73+
Replace the file name with the actual document name that you want to load from Box cloud file storage. Make sure to pass the document name from the box folder to the [documentPath](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_DocumentPath) property of the SfPdfViewer component
7474
7575
N> Replace **Your Access Key from AWS S3**, **Your Secret Key from AWS S3**, and **Your Bucket name from AWS S3** with your actual AWS access key, secret key and bucket name
7676

blazor/pdfviewer-2/open-pdf-file/from-box-cloud-file-storage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ N> replace **Your_Box_Storage_Access_Token** with your actual box access token,
9494

9595
N> The **Box.V2.Core** NuGet package must be installed in your application to use the previous code example.
9696

97-
N> Replace `PDF_Succinctly.pdf` with the actual document name that you want to load from Box cloud file storage. Make sure to pass the document name from the box folder to the `documentPath` property of the SfPdfViewer component
97+
N> Replace `PDF_Succinctly.pdf` with the actual document name that you want to load from Box cloud file storage. Make sure to pass the document name from the box folder to the [documentPath](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_DocumentPath) property of the SfPdfViewer component
9898
9999
[View sample in GitHub](https://github.com/SyncfusionExamples/blazor-pdf-viewer-examples/tree/master/Load%20and%20Save/Open%20and%20Save%20from%20box%20cloud%20storage-SfPdfViewer)
100100

blazor/pdfviewer-2/print.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ documentation: ug
99

1010
# Print in Blazor SfPdfViewer Component
1111

12-
The SfPdfViewer supports printing the loaded PDF file by default. You can enable or disable printing by setting the `EnablePrint` property.
12+
The SfPdfViewer supports printing the loaded PDF file by default. You can enable or disable printing by setting the [EnablePrint](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.SfPdfViewer.PdfViewerBase.html#Syncfusion_Blazor_SfPdfViewer_PdfViewerBase_EnablePrint) property.
1313

1414
```cshtml
1515

0 commit comments

Comments
 (0)