Skip to content

Commit 9b65151

Browse files
984044:documentation partially revamped.
1 parent 7ca3064 commit 9b65151

File tree

50 files changed

+505
-563
lines changed

Some content is hidden

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

50 files changed

+505
-563
lines changed

Document-Processing-toc.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1060,16 +1060,16 @@
10601060
</li>
10611061
<li>Toolbar Customization
10621062
<ul>
1063-
<li><a href="/document-processing/pdf/pdf-viewer/javascript-es6/toolbar-customization/primary-toolbar-customization">Primary Toolbar Customization</a></li>
1064-
<li><a href="/document-processing/pdf/pdf-viewer/javascript-es6/toolbar-customization/annotation-toolbar-customization">Annotation Toolbar Customization</a></li>
1065-
<li><a href="/document-processing/pdf/pdf-viewer/javascript-es6/toolbar-customization/form-designer-toolbar-customization">Form Designer Toolbar Customization</a></li>
1063+
<li><a href="/document-processing/pdf/pdf-viewer/javascript-es6/toolbar-customization/primary-toolbar-customization">Primary Toolbar</a></li>
1064+
<li><a href="/document-processing/pdf/pdf-viewer/javascript-es6/toolbar-customization/annotation-toolbar-customization">Annotation Toolbar</a></li>
1065+
<li><a href="/document-processing/pdf/pdf-viewer/javascript-es6/toolbar-customization/form-designer-toolbar-customization">Form Designer Toolbar</a></li>
10661066
<li><a href="/document-processing/pdf/pdf-viewer/javascript-es6/organize-pdf/toolbar-organize-page">Organize Page Toolbar</a></li>
10671067
<li><a href="/document-processing/pdf/pdf-viewer/javascript-es6/toolbar-customization/mobile-toolbar">Mobile Toolbar</a></li>
10681068
<li><a href="/document-processing/pdf/pdf-viewer/javascript-es6/toolbar-customization/custom-toolbar">Custom Toolbar</a></li>
10691069
</ul>
10701070
</li>
10711071
<li><a href="/document-processing/pdf/pdf-viewer/javascript-es6/mobile-toolbar">Mobile Toolbar Interface</a></li>
1072-
<li>Interactive Navigation
1072+
<li>Interactive PDF Navigation
10731073
<ul>
10741074
<a href="/document-processing/pdf/pdf-viewer/javascript-es6/interactive-pdf-navigation/page-navigation">Page Navigation</a>
10751075
<a href="/document-processing/pdf/pdf-viewer/javascript-es6/interactive-pdf-navigation/bookmark-navigation">Bookmark Navigation</a>
@@ -1110,9 +1110,9 @@
11101110
<li>Organize Pages
11111111
<ul>
11121112
<li><a href="/document-processing/pdf/pdf-viewer/javascript-es6/organize-pdf-overview">Overview</a></li>
1113-
<li><a href="/document-processing/pdf/pdf-viewer/javascript-es6/organize-pdf/programmatic-support-for-organize-page">Programmatic Support for Organize Pa</a></li>
1113+
<li><a href="/document-processing/pdf/pdf-viewer/javascript-es6/organize-pdf/programmatic-support-for-organize-page">Programmatic Support for Organize Page</a></li>
11141114
<li><a href="/document-processing/pdf/pdf-viewer/javascript-es6/organize-pdf/ui-interactions-organize-page">UI Interactions in Organize Page</a></li>
1115-
<li><a href="/document-processing/pdf/pdf-viewer/javascript-es6/organize-pdf/toolbar-organize-page">Toolbar Organize Page</a></li>
1115+
<li><a href="/document-processing/pdf/pdf-viewer/javascript-es6/organize-pdf/toolbar-organize-page">Toolbar</a></li>
11161116
<li><a href="/document-processing/pdf/pdf-viewer/javascript-es6/organize-pdf/organize-page-mobile-view">Organize Page in Mobile View</a></li>
11171117
<li><a href="/document-processing/pdf/pdf-viewer/javascript-es6/organize-pdf/organize-pdf-events">Events in Organize Page</a></li>
11181118
</ul>

Document-Processing/PDF/PDF-Viewer/javascript-es6/how-to/add-annotation-in-text-search-ts.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,13 @@ documentation: ug
99

1010
# Add rectangle annotations using text search bounds in PDF Viewer
1111

12-
## Overview
12+
A concise guide to adding rectangle annotations at highlighted text search results in the TypeScript PDF Viewer to visually emphasize matches and improve readability.
1313

14-
This guide explains how to add rectangle annotations based on the bounds of highlighted search text in the PDF Viewer. This approach visually emphasizes search results in annotation-enabled applications.
15-
16-
## Steps to Add Rectangle Annotations on Search Result Highlight
14+
## Steps to add rectangle annotations on search result highlight
1715

1816
**Step 1:** Follow the steps provided in the [link](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/javascript-es6/getting-started) to create a simple PDF Viewer sample.
1917

20-
**Step 2:** Initialize the PDF Viewer with required modules
18+
**Step 2:** Initialize the PDF Viewer with the required modules
2119

2220
```ts
2321
import { pdf } from '@syncfusion/ej2';
@@ -56,7 +54,7 @@ pdfviewer.textSearchHighlight = function(args: TextSearchHighlightEventArgs): vo
5654

5755
**Step 4:** Add search controls
5856

59-
Ensure you have the appropriate HTML buttons for text search operations
57+
Ensure that the HTML includes buttons for text search operations.
6058

6159
```html
6260
<button id="searchText">Search Text</button>
@@ -92,6 +90,6 @@ if (searchCancelButton) {
9290
}
9391
```
9492

95-
Following these steps enables the PDF Viewer to add rectangle annotations at search result locations, increasing the visibility of matches.
93+
Following these steps enables the PDF Viewer to add rectangle annotations at search result locations, improving the visibility of matches.
9694

9795
[View Sample in GitHub](https://github.com/SyncfusionExamples/typescript-pdf-viewer-examples/tree/master/How%20to/)

Document-Processing/PDF/PDF-Viewer/javascript-es6/how-to/add-header-value.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
layout: post
33
title: Add header values to AJAX requests in TypeScript PDF Viewer | Syncfusion
4-
description: Learn how to add custom header values to PDF Viewer AJAX requests using ajaxRequestSettings and ajaxHeaders in the TypeScript PDF Viewer component.
4+
description: Learn how to include custom headers in PDF Viewer AJAX requests using ajaxRequestSettings and ajaxHeaders in the TypeScript PDF Viewer component.
55
platform: document-processing
66
control: PDF Viewer
77
documentation: ug
88
---
99

10-
# Add header values in TypeScript PDF Viewer
10+
# Add header values in the TypeScript PDF Viewer
1111

12-
To add header values to AJAX requests, use the ajaxHeaders property in the PDF Viewer’s [ajaxRequestSettings](https://ej2.syncfusion.com/documentation/api/pdfviewer/#ajaxrequestsettings). This property specifies custom headers for each outgoing request.
12+
Use the ajaxHeaders property in the PDF Viewer’s [ajaxRequestSettings](https://ej2.syncfusion.com/documentation/api/pdfviewer/#ajaxrequestsettings) to include custom headers with each AJAX request.
1313

1414
Example: Add a custom Authorization header using ajaxRequestSettings
1515

Document-Processing/PDF/PDF-Viewer/javascript-es6/how-to/add-save-button-ts.md

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
---
22
layout: post
3-
title: Add Save button in Typescript Pdfviewer control | Syncfusion
4-
description: Learn here all about How to add save button in Toolbar in Syncfusion Typescript Pdfviewer control of Syncfusion Essential JS 2 and more.
3+
title: Add Save button to the built-in toolbar in TypeScript PDF Viewer | Syncfusion
4+
description: Learn how to add, show, hide, enable, and disable a custom Save button in the built-in toolbar of the TypeScript PDF Viewer component.
55
platform: document-processing
66
control: Toolbar
77

88
documentation: ug
99
domainurl: ##DomainURL##
1010
---
1111

12-
# Add Save button in Built-In Toolbar in TS
12+
# Add a Save button to the built-in toolbar
1313

14-
PDF Viewer allows you to customize (add, show, hide, enable, and disable) existing items in a toolbar.
14+
PDF Viewer supports customizing toolbar items, including adding, showing, hiding, enabling, and disabling items.
1515

16-
* Save button - `Save` button-item can defined by [**CustomToolbarItemModel**](https://ej2.syncfusion.com/documentation/api/document-editor/customToolbarItemModel/) and with existing items in [**ToolbarSettings**](https://ej2.syncfusion.com/documentation/api/file-manager/toolbarSettings/) property. Newly added save button-item click action can be defined in [`toolbarclick`](https://ej2.syncfusion.com/documentation/api/file-manager/toolbarClickEventArgs/).
16+
- Save button: The Save button can be defined using [CustomToolbarItemModel](https://ej2.syncfusion.com/documentation/api/document-editor/customToolbarItemModel/) and included alongside existing items via [ToolbarSettings](https://ej2.syncfusion.com/documentation/api/file-manager/toolbarSettings/). Handle the click action using [`toolbarclick`](https://ej2.syncfusion.com/documentation/api/file-manager/toolbarClickEventArgs/).
1717

18-
* Show, Hide - `Save` button-item can be shown or hidden using the [`ToolbarSettings`](https://ej2.syncfusion.com/documentation/api/file-manager/toolbarSettings/) property. Pre-defined toolbar items are available with [`ToolbarItem`](https://ej2.syncfusion.com/documentation/api/chart/toolbarItems/).
18+
- Show or hide: The Save button can be shown or hidden using [ToolbarSettings](https://ej2.syncfusion.com/documentation/api/file-manager/toolbarSettings/). Predefined items are listed under [`ToolbarItem`](https://ej2.syncfusion.com/documentation/api/chart/toolbarItems/).
1919

20-
* Enable, Disable - `Save` button-item can be enabled or disable using [`enabletoolbaritem`](https://ej2.syncfusion.com/documentation/api/document-editor-container/toolbar/).
20+
- Enable or disable: The Save button can be enabled or disabled using [`enabletoolbaritem`](https://ej2.syncfusion.com/documentation/api/document-editor-container/toolbar/).
2121

2222
{% tabs %}
2323
{% highlight js tabtitle="Standalone" %}
@@ -36,7 +36,7 @@ pdfviewer.documentPath = "https://cdn.syncfusion.com/content/pdf/pdf-succinctly.
3636
pdfviewer.resourceUrl = "https://cdn.syncfusion.com/ej2/23.1.43/dist/ej2-pdfviewer-lib";
3737
pdfviewer.toolbarSettings = { toolbarItems: ['OpenOption', toolItem1, 'PageNavigationTool', 'MagnificationTool', 'PanTool', 'SelectionTool', 'SearchOption', 'PrintOption', 'UndoRedoTool', 'AnnotationEditTool', 'FormDesignerEditTool', 'CommentTool', 'SubmitForm']}
3838
pdfviewer.appendTo('#PdfViewer');
39-
//To handle custom toolbar click event.
39+
// To handle custom toolbar click event.
4040
pdfviewer.toolbarClick = function (args) {
4141
if (args.item && args.item.id === 'download') {
4242
pdfviewer.download();
@@ -63,7 +63,7 @@ pdfviewer.documentPath = "https://cdn.syncfusion.com/content/pdf/pdf-succinctly.
6363
pdfviewer.serviceUrl = 'https://document.syncfusion.com/web-services/pdf-viewer/api/pdfviewer/';
6464
pdfviewer.toolbarSettings = { toolbarItems: ['OpenOption', toolItem1, 'PageNavigationTool', 'MagnificationTool', 'PanTool', 'SelectionTool', 'SearchOption', 'PrintOption', 'UndoRedoTool', 'AnnotationEditTool', 'FormDesignerEditTool', 'CommentTool', 'SubmitForm']}
6565
pdfviewer.appendTo('#PdfViewer');
66-
//To handle custom toolbar click event.
66+
// To handle custom toolbar click event.
6767
pdfviewer.toolbarClick = function (args) {
6868
if (args.item && args.item.id === 'download') {
6969
pdfviewer.download();
@@ -75,34 +75,33 @@ function OnCreateSearch(this: any): any {
7575
{% endhighlight %}
7676
{% endtabs %}
7777

78-
N> Default value of toolbar items is ['OpenOption', 'PageNavigationTool','MagnificationTool', 'PanTool', 'SelectionTool', 'SearchOption', 'PrintOption', 'DownloadOption','UndoRedoTool', 'AnnotationEditTool', 'FormDesignerEditTool', 'CommentTool', 'SubmitForm']
78+
N> Default toolbar items: ['OpenOption', 'PageNavigationTool','MagnificationTool', 'PanTool', 'SelectionTool', 'SearchOption', 'PrintOption', 'DownloadOption','UndoRedoTool', 'AnnotationEditTool', 'FormDesignerEditTool', 'CommentTool', 'SubmitForm']
7979

80-
### Align Property
80+
### Align property
8181

82-
The align property is used to specify the alignment of a `save` button-item within the toolbar.
82+
Specifies the alignment of the Save button within the toolbar.
8383

84-
`Left`: Aligns the item to the left side of the toolbar.
85-
`Right`: Aligns the item to the right side of the toolbar.
84+
- Left: Aligns the item to the left side of the toolbar.
85+
- Right: Aligns the item to the right side of the toolbar.
8686

87-
### Tooltip Property
87+
### Tooltip property
8888

89-
The tooltip property is used to set the tooltip text for a `save` button-item. Tooltip provides additional information when a user hovers over the item.
89+
Sets the tooltip text for the Save button. The tooltip provides additional information on hover.
9090

91-
### CssClass Property
91+
### CssClass property
9292

93-
The cssClass property is used to apply custom CSS classes to a `save` button-item. It allows custom styling of the `save` button-item.
93+
Applies custom CSS classes to the Save button for styling.
9494

95-
### Prefix Property
95+
### Prefix property
9696

97-
The prefix property is used to set the CSS class or icon that should be added as a prefix to the existing content of the `save` button-item.
97+
Sets the CSS class or icon to add as a prefix to the Save button content.
9898

99-
### ID Property
99+
### ID property
100100

101-
The id property within a CustomToolbarItemModel is a compulsory attribute that plays a vital role in toolbar customization. It serves as a unique identifier for each toolbar item, facilitating distinct references and interactions.
101+
The id property within a CustomToolbarItemModel is required and uniquely identifies each toolbar item for configuration and interaction.
102102

103-
When defining or customizing toolbar items, it is mandatory to assign a specific and descriptive id to each item.
104-
These properties are commonly used when defining custom toolbar items with the `CustomToolbarItemModel`` in the context of Syncfusion PDF Viewer. When configuring the toolbar using the `ToolbarSettings`` property, you can include these properties to customize the appearance and behavior of each toolbar item.
103+
When defining or customizing toolbar items, assign a specific, descriptive id to each item. These properties are commonly used when defining custom toolbar items with `CustomToolbarItemModel` in the context of Syncfusion PDF Viewer. When configuring the toolbar using the `ToolbarSettings` property, include these properties to customize appearance and behavior.
105104

106-
N> When customizing `save` button-item, you have the flexibility to include either icons or text based on your design preference.
105+
N> When customizing the Save button, icons or text can be used based on design preference.
107106

108-
[View sample in GitHub](https://github.com/SyncfusionExamples/typescript-pdf-viewer-examples/tree/master/How%20to/Add%20Save%20Button%20In%20Toolbar)
107+
[View sample in GitHub](https://github.com/SyncfusionExamples/typescript-pdf-viewer-examples/tree/master/How%20to/Add%20Save%20Button%20In%20Toolbar)

Document-Processing/PDF/PDF-Viewer/javascript-es6/how-to/annotation-selectors.md

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

1212
Customize the annotation selector using the [annotationSelectorSettings](https://ej2.syncfusion.com/documentation/api/pdfviewer/#annotationselectorsettings) property of the PDF Viewer.
1313

14-
Example: customize the selector of a shape annotation
14+
Example: Customize the selector of a shape annotation
1515

1616
```
1717
Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
---
22
layout: post
3-
title: Change author name using annotation settings in Typescript Pdfviewer control | Syncfusion
4-
description: Learn here all about Change author name using annotation settings in Syncfusion Typescript Pdfviewer control of Syncfusion Essential JS 2 and more.
3+
title: Change author name using annotation settings in TypeScript PDF Viewer | Syncfusion
4+
description: Learn how to change the author name and related annotation settings using the annotationSettings API in the TypeScript PDF Viewer.
55
platform: document-processing
6-
control: Change author name using annotation settings
6+
control: PDF Viewer
77

88
documentation: ug
99
domainurl: ##DomainURL##
1010
---
1111

12-
# Change author name using annotation settings in Typescript Pdfviewer control
12+
# Change author name using annotation settings in TypeScript PDF Viewer
1313

14-
The Essential JavaScript PDF Viewer supports to customize a single property of the annotation settings by exposing an API for the properties common to all the annotations.
14+
The PDF Viewer allows customizing individual annotation settings using the annotationSettings API, which exposes properties common to all annotations.
1515

16-
**API Name** : annotationSettings
16+
API name: annotationSettings
1717

18-
|Property Name|Data type & Default Value|Description|
18+
| Property Name | Data type & Default Value | Description |
1919
|---|---|---|
20-
|author|String(“Guest”)|specifies the author of the annotation.|
21-
|minWidth|Number(0)|specifies the minWidth of the annotation.|
22-
|maxWidth|Number(0)|specifies the maxWidth of the annotation.|
23-
|minHeight|Number(0)|specifies the minHeight of the annotation.|
24-
|maxHeight|Number(0)|specifies the maxHeight of the annotation.|
25-
|isLock|Boolean(false)|specifies the locked action of the annotations. [If set true unable to select the annotations]|
26-
|isPrint|Boolean(true)|specifies whether the annotations are included or not in Print actions.|
27-
|isDownload|Boolean(true|specifies whether the annotations are included or not in Download actions.|
28-
|Free Text Settings|
29-
|allowOnlyTextInput|Boolean(false)|specifies the allow only text action of the free text annotation. [If set true unable to move or resize the annotations]|
30-
31-
You can change the author name and the other properties using the annotationSettings API as in the following code sample.
20+
| author | String ("Guest") | Specifies the author of the annotation. |
21+
| minWidth | Number (0) | Specifies the minimum width of the annotation. |
22+
| maxWidth | Number (0) | Specifies the maximum width of the annotation. |
23+
| minHeight | Number (0) | Specifies the minimum height of the annotation. |
24+
| maxHeight | Number (0) | Specifies the maximum height of the annotation. |
25+
| isLock | Boolean (false) | Specifies whether the annotation is locked. If true, the annotation cannot be selected. |
26+
| isPrint | Boolean (true) | Specifies whether the annotation is included in print actions. |
27+
| isDownload | Boolean (true) | Specifies whether the annotation is included in download actions. |
28+
| Free Text Settings |
29+
| allowOnlyTextInput | Boolean (false) | Specifies text-only mode for free text annotations. If true, moving or resizing is disabled. |
30+
31+
Change the author name and other properties using the annotationSettings API as shown below.
3232

3333
{% tabs %}
3434
{% highlight ts tabtitle="Standalone" %}
@@ -56,4 +56,4 @@ viewer.freeTextSettings = { allowTextOnly : true };
5656
viewer.appendTo("#pdfViewer");
5757
```
5858
{% endhighlight %}
59-
{% endtabs %}
59+
{% endtabs %}

0 commit comments

Comments
 (0)