Skip to content

Commit 6edcd29

Browse files
Merge pull request #2340 from syncfusion-content/EJ2-1010339-core-hf
1010339: Core documentation revamp in hotfix
2 parents 539a2f5 + bbe06ea commit 6edcd29

129 files changed

Lines changed: 2429 additions & 1737 deletions

File tree

Some content is hidden

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

Document-Processing/PDF/PDF-Viewer/asp-net-core/Redaction/mobile-view.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The Redaction Tool enables users to permanently mark and remove sensitive conten
1313

1414
![Redaction in Mobile View](./redaction-annotations-images/redaction-mobile-view.png)
1515

16-
N> In mobile view, the redaction toolbar appears at the bottom of the viewer for easy thumb access. Mobile layout activates automatically on small screens.
16+
N> In mobile view, the redaction toolbar appears at the bottom of the viewer for thumb access. The mobile layout activates automatically on small screens.
1717

1818
## Adding Redaction in Mobile View
1919

Document-Processing/PDF/PDF-Viewer/asp-net-core/Redaction/overview.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ domainurl: ##DomainURL##
1010

1111
# Redaction in ASP.NET Core PdfViewer
1212

13-
Redaction annotations are used to hide confidential or sensitive information in a PDF. The Syncfusion ASP.NET Core PDF Viewer lets you mark areas or entire pages for redaction, customize their appearance, and permanently apply them with a single action.
13+
Redaction annotations hide confidential or sensitive information in a PDF. The Syncfusion ASP.NET Core PDF Viewer enables marking areas or entire pages for redaction, customizing their appearance, and permanently applying redactions.
1414

1515
## Enable the redaction toolbar
1616

@@ -55,40 +55,40 @@ window.onload = function () {
5555
{% endhighlight %}
5656
{% endtabs %}
5757

58-
N> Prerequisites: Add the PdfViewer control to your ASP.NET Core application and ensure the redaction feature is available in the version you are using. Once applied, redaction permanently removes the selected content.
58+
N> Prerequisites: Add the PdfViewer control to the ASP.NET Core application and confirm that the redaction feature is available in the used product version. Applying redaction permanently removes the selected content.
5959

6060
![Toolbar with the Redaction tool highlighted](redaction-annotations-images/redaction-icon-toolbar.png)
6161

6262
## Add Redaction Annotations
6363

64-
You can mark specific content for redaction using the toolbar or through code.
64+
Mark specific content for redaction using the toolbar or programmatically.
6565

66-
Select the **Redaction tool** and draw over the text or graphics you want to hide. You can also add overlay text (such as “Confidential”) and adjust the style fill color, border color, and opacity.
66+
Select the **Redaction tool** and draw over the text or graphics to hide. Optionally add overlay text (for example, “Confidential”) and adjust the style: fill color, border color, and opacity.
6767

6868
![Drawing a redaction region over page content](redaction-annotations-images/adding-redaction-annotation.png)
6969

7070
## Delete Redaction Annotations
7171

72-
Redaction annotations can be removed easily:
72+
Remove redaction annotations by either:
7373

74-
- Click the **Delete** button on the toolbar, or
75-
- Select the annotation and press the **Delete** key.
74+
- Clicking the **Delete** button on the toolbar, or
75+
- Selecting the annotation and pressing the **Delete** key.
7676

7777
![Toolbar showing the Delete command for redaction](redaction-annotations-images/redaction-delete-icon.png)
7878

7979
## Redact Entire Pages
8080

81-
The viewer allows you to redact whole pages that contain sensitive information. You can choose specific pages, page ranges, or redact all pages using the built‑in dialog, or perform the same action programmatically.
81+
Redact whole pages that contain sensitive information. Choose specific pages, page ranges, or redact all pages using the built‑in dialog, or perform the same action programmatically.
8282

8383
![Toolbar showing the Redact Page option](redaction-annotations-images/redact-page-icon.png)
8484

8585
## Apply Redaction
8686

87-
Once annotations are added, you can permanently apply them to the document. This action cannot be undone.
87+
After adding annotations, permanently apply them to the document. This action is irreversible.
8888

8989
Use the **Apply Redaction** button on the toolbar or call the API method:
9090

91-
- The button is disabled until at least one redaction annotation exists.
91+
- The button remains disabled until at least one redaction annotation exists.
9292
- It becomes active when redaction annotations are present.
9393

9494
![Toolbar showing the Apply Redaction button](redaction-annotations-images/redact-button-icon.png)

Document-Processing/PDF/PDF-Viewer/asp-net-core/Redaction/programmatic-support.md

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

1010
# Programmatic support for redaction in ASP.NET Core PdfViewer
1111

12-
The Syncfusion ASP.NET Core PDF Viewer provides APIs to add, update, delete, and apply redaction annotations programmatically. You can also redact entire pages, configure default properties, and work with the redaction property panel.
12+
The Syncfusion ASP.NET Core PDF Viewer provides APIs to add, update, delete, and apply redaction annotations programmatically. The viewer also supports page redaction, configuration of default properties, and interaction with the redaction property panel.
1313

1414
## Enable the redaction toolbar
1515

@@ -324,5 +324,5 @@ The redaction property panel allows users to update annotation properties throug
324324
* [Overview of Redaction](./overview)
325325
* [Redaction UI interactions](./ui-interaction)
326326
* [Redaction Toolbar](./toolbar)
327-
* [Reaction in Mobile view](./mobile-view)
327+
* [Redaction in Mobile view](./mobile-view)
328328
* [Search Text and Redact](./search-redact)

Document-Processing/PDF/PDF-Viewer/asp-net-core/Redaction/search-redact.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ domainurl: ##DomainURL##
1010

1111
# Search text and redact in ASP.NET Core PdfViewer
1212

13-
You can search for a keyword in the loaded PDF and automatically add redaction annotations over each match. The example below wires the extractTextCompleted event, triggers text extraction, performs a search, and places redaction annotations for every result.
13+
Search for a keyword in the loaded PDF and automatically add redaction annotations for each match. The example below wires the `extractTextCompleted` event, triggers text extraction, performs a search, and adds redaction annotations for every result.
1414

15-
N> Prerequisites: Add the PdfViewer control to your ASP.NET Core application and ensure a document is loaded. Make sure the redaction feature is available in the version you are using. Once applied, redaction permanently removes the selected content.
15+
N> Prerequisites: Add the PdfViewer control to the ASP.NET Core application and ensure a document is loaded. Confirm the redaction feature is available in the used product version. Applying redaction permanently removes the selected content.
1616

1717
## Steps to add Redaction annotations on search Text Bounds
1818

@@ -111,7 +111,7 @@ N> Prerequisites: Add the PdfViewer control to your ASP.NET Core application and
111111
- Ensure the PDF is fully loaded before triggering extraction and search.
112112
- Bounds from search are in points (72 DPI). Convert to pixels (96 DPI) to align with annotation coordinates.
113113
- Customize overlay text, colors, and typography as needed.
114-
- Adding a redaction annotation covers the content visually. To permanently remove sensitive data, use the viewer's Apply Redaction action or equivalent API if available in your version.
114+
- Adding a redaction annotation covers the content visually. To permanently remove sensitive data, use the viewer's Apply Redaction action or equivalent API if available in the used product version.
115115

116116
## See also
117117

Document-Processing/PDF/PDF-Viewer/asp-net-core/Redaction/toolbar.md

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

1010
# Redaction toolbar customization in ASP.NET Core
1111

12-
The redaction toolbar in the Syncfusion ASP.NET Core PDF Viewer can be customized by rearranging existing items, hiding default items, or adding new ones. You can also place custom items at specific index positions among the existing toolbar items.
12+
Customize the redaction toolbar by rearranging existing items, hiding default items, or adding custom items. Custom items can be inserted at specific index positions among existing toolbar items.
1313

1414
## Enable the redaction toolbar
1515

@@ -60,17 +60,17 @@ Refer to the following image for the toolbar view:
6060

6161
## Show or hide the redaction toolbar
6262

63-
You can toggle the redaction toolbar either using the built‑in toolbar icon or programmatically with the `showRedactionToolbar` method.
63+
Toggle the redaction toolbar using the built‑in toolbar icon or programmatically with the `showRedactionToolbar` method.
6464

6565
### Display the redaction toolbar using the toolbar icon
6666

67-
When **RedactionEditTool** is included in the toolbar settings, clicking the redaction icon in the primary toolbar will show or hide the redaction toolbar.
67+
When `RedactionEditTool` is included in the toolbar settings, clicking the redaction icon in the primary toolbar shows or hides the redaction toolbar.
6868

6969
![Show redaction toolbar from the primary toolbar](../redaction/redaction-annotations-images/redaction-icon-toolbar.png)
7070

7171
### Display the redaction toolbar programmatically
7272

73-
You can also control visibility through code by calling `viewer.toolbar.showRedactionToolbar(true/false)`.
73+
Control visibility in code by calling `viewer.toolbar.showRedactionToolbar(true)` or `viewer.toolbar.showRedactionToolbar(false)`.
7474

7575
The following example demonstrates toggling the redaction toolbar programmatically:
7676

Document-Processing/PDF/PDF-Viewer/asp-net-core/Redaction/ui-interaction.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ documentation: ug
1111

1212
## Add redaction annotations from the toolbar
1313

14-
Use the redaction tool in the toolbar to draw over content that should be hidden. After marking, an annotation can display overlay text (for example, “Confidential”) and can be styled using fill color and other properties.
14+
Use the redaction tool to draw over content to be hidden. After marking, an annotation can display overlay text (for example, “Confidential”) and can be styled using fill color and other properties.
1515

1616
![Drawing a redaction annotation on the page](redaction-annotations-images/adding-redaction-annotation.png)
1717

@@ -37,7 +37,7 @@ After adding a redaction annotation, you can update its properties through the p
3737

3838
### Update using the property panel
3939

40-
When a redaction annotation is selected, a two‑tab property panel (General and Appearance) lets you customize text and styling. Changes are reflected instantly on the redaction mark.
40+
When a redaction annotation is selected, a two‑tab property panel (General and Appearance) lets the user customize text and styling. Changes are reflected instantly on the redaction mark.
4141

4242
The property panel can be opened in two ways:
4343

@@ -62,7 +62,7 @@ Use the General tab to define how the content will look after redaction. These s
6262

6363
![Fill Color in General Tab](redaction-annotations-images/after-redaction-fill-color.png)
6464

65-
Note: Hovering the mouse over a redaction annotation shows a preview of this final look. After you click Apply Redaction, these settings are flattened into the page and can’t be edited. Tip: Click Save in the dialog to keep your changes.
65+
N> Hovering the mouse over a redaction annotation previews the final look. After clicking Apply Redaction, these settings are flattened into the page and cannot be edited. Tip: Click Save in the dialog to keep changes.
6666

6767
#### Appearance tab
6868

@@ -72,7 +72,7 @@ Use the Appearance tab to style the redaction annotation itself (before applying
7272
* Outline Color – Optional border for the annotation.
7373
* Fill Opacity – Controls how transparent the annotation appears during review.
7474

75-
Note: The Appearance tab affects only the temporary annotation. The final look after applying redaction comes from the General tab settings.
75+
N> The Appearance tab affects only the temporary annotation. The final look after applying redaction uses the General tab settings.
7676

7777
![Appearance Tab Settings](redaction-annotations-images/redaction-annotation-appearance.png)
7878

Document-Processing/PDF/PDF-Viewer/asp-net-core/accessibility.md

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ platform: document-processing
66
control: PDF Viewer
77
documentation: ug
88
---
9-
# Accessibility in Syncfusion PDF Viewer component
9+
# Accessibility in ASP.NET Core PDF Viewer component
1010

11-
The PDF Viewer component adheres to accessibility guidelines and standards, including [ADA](https://www.ada.gov/), [Section 508](https://www.section508.gov/), and [WCAG 2.2](https://www.w3.org/TR/WCAG22/). It also integrates [WCAG roles](https://www.w3.org/TR/wai-aria/#roles) commonly used for accessibility evaluation.
11+
The PDF Viewer component adheres to accessibility guidelines and standards, including [ADA](https://www.ada.gov/), [Section 508](https://www.section508.gov/), and [WCAG 2.2](https://www.w3.org/TR/WCAG22/). It implements [WCAG roles](https://www.w3.org/TR/wai-aria/#roles) to ensure comprehensive accessibility support for all users.
12+
13+
## Accessibility compliance
1214

1315
Below is an outline of the accessibility compliance for the PDF Viewer component:
1416

@@ -58,7 +60,9 @@ Below is an outline of the accessibility compliance for the PDF Viewer component
5860

5961
## Keyboard interaction
6062

61-
The PDF Viewer component follows the [keyboard interaction](https://www.w3.org/WAI/ARIA/apg/patterns/alert/#keyboardinteraction) guidelines, making it easy for users of assistive technologies (AT) and those who rely solely on keyboard navigation. The following keyboard shortcuts are supported by the PDF Viewer component:
63+
The PDF Viewer component follows the [keyboard interaction](https://www.w3.org/WAI/ARIA/apg/patterns/alert/#keyboardinteraction) guidelines, making it accessible for users of assistive technologies and those who rely solely on keyboard navigation. The built-in keyboard shortcuts support common operations such as document navigation, zooming, searching, text selection, and annotation management.
64+
65+
### Built-in keyboard shortcuts
6266

6367
| **Press (Windows)** | **Press (Macintosh)** | **To do this** |
6468
| --- | --- | --- |
@@ -93,15 +97,30 @@ The PDF Viewer component follows the [keyboard interaction](https://www.w3.org/W
9397
| <kbd>Shift + H</kbd> | <kbd>Shift + H</kbd> | Enable pan mode |
9498
| <kbd>Shift + V</kbd> | <kbd>Shift + V</kbd> | Enable text selection mode |
9599

96-
The current implementation of our PDF Viewer includes keyboard shortcuts for functions such as scrolling, zooming, text search, printing, and annotation deletion.
100+
## Custom keyboard commands
101+
102+
In addition to the built-in keyboard shortcuts, the PDF Viewer component supports custom keyboard commands, allowing developers to define application-specific keyboard gestures and actions. This feature enhances user experience by enabling efficient navigation and interaction tailored to specific workflows.
103+
104+
### Configuring custom keyboard commands
105+
106+
Custom keyboard commands are configured through the **CommandManager** class, which manages keyboard events and executes defined commands. The CommandManager accepts a collection of custom keyboard commands via the `keyboardCommand` parameter, where each command specifies a unique name and its associated keyboard gesture.
97107

98-
To enhance user experience, we are adding additional keyboard shortcuts for actions like navigating between pages, accessing specific pages, toggling annotation tools, and displaying PDF elements (outlines, annotations, bookmarks, and thumbnails).
108+
Each keyboard gesture consists of two components:
109+
- **Key**: The primary key (represented using the `PdfKeys` enum)
110+
- **Modifier keys**: Optional modifier keys (Shift, Ctrl, Alt, or Meta combinations)
99111

100-
To support these enhancements, we are introducing a new class called **commandManager**. This class handles custom commands triggered by specific key gestures, which are defined by users and executed accordingly.
112+
### Modifier keys reference
101113

102-
The **commandManager** includes a parameter called `keyboardCommand` (which replaces `Commands`). This parameter holds a collection of custom keyboard commands specified by users. Each custom command is represented by a `KeyboardCommand` class, containing the `name` of the command and its associated `gesture` (keyboard combination).
114+
The following modifier keys can be combined with primary keys:
103115

104-
Additionally, we are introducing an `EventCallback` to the `keyboardCustomCommands` parameter for the `CommandManager`. This will handle keyboard events and trigger appropriate methods when specific key combinations are pressed.
116+
- **Ctrl** (Control key): represented by the value `1`
117+
- **Alt** (Alt key): represented by the value `2`
118+
- **Shift** (Shift key): represented by the value `4`
119+
- **Meta** (Command key on macOS or Windows key on Windows): represented by the value `8`
120+
121+
Multiple modifiers can be combined using the bitwise OR operator (`|`).
122+
123+
### Example: Defining custom keyboard commands
105124

106125
{% tabs %}
107126
{% highlight cshtml tabtitle="Standalone" %}
@@ -196,21 +215,17 @@ Additionally, we are introducing an `EventCallback` to the `keyboardCustomComman
196215
{% endhighlight %}
197216
{% endtabs %}
198217

199-
Each `keyboardCommand` object consists of a name property, specifying the `name` of the `custom command`, and a `gesture property`, defining the key gesture associated with the command.
200-
201-
For example, the first command named `customCopy` is associated with the **G** key and requires both the **Shift** and **Alt** modifier keys to be pressed simultaneously.
202-
203-
Additionally, there's an explanation of the key modifiers used in the gestures:
218+
Each `keyboardCommand` object consists of the following properties:
204219

205-
* Ctrl corresponds to the Control key, represented by the value `1`.
206-
* Alt corresponds to the Alt key, represented by the value `2`.
207-
* Shift corresponds to the Shift key, represented by the value `4`.
208-
* Meta corresponds to the Command key on macOS or the Windows key on Windows, represented by the value `8`.
220+
- **name**: The identifier for the custom command (e.g., `customCopy`, `customPaste`)
221+
- **gesture**: An object containing the key binding configuration:
222+
- **pdfKeys**: The primary key from the `PdfKeys` enum
223+
- **modifierKeys**: A combination of modifier keys using the `ModifierKeys` enum with bitwise OR operations
209224

210-
This setup allows users to perform custom actions within the PDF viewer by pressing specific key combinations, enhancing the user experience and providing more efficient navigation and interaction options.
225+
In the example above, the `customCopy` command is triggered by pressing **G** in combination with **Shift** and **Alt** keys. The gesture definition allows multiple modifier keys to be combined, enabling flexible keyboard accessibility patterns.
211226

212227
## Ensuring accessibility
213228

214-
The PDF Viewer component's accessibility levels are ensured through an [accessibility-checker](https://www.npmjs.com/package/accessibility-checker) and [axe-core](https://www.npmjs.com/package/axe-core) software tools during automated testing.
229+
The PDF Viewer component's accessibility compliance is validated through automated testing using [accessibility-checker](https://www.npmjs.com/package/accessibility-checker) and [axe-core](https://www.npmjs.com/package/axe-core) software tools.
215230

216231
N> Follow the steps provided in the [link](https://help.syncfusion.com/document-processing/pdf/pdf-viewer/asp-net-core/getting-started) to create a simple PDF Viewer sample.

0 commit comments

Comments
 (0)