Skip to content

Commit 4a1be11

Browse files
1009416: Addressed feedback changes in vue documentation
1 parent 2c363b5 commit 4a1be11

24 files changed

Lines changed: 117 additions & 117 deletions

Document-Processing/PDF/PDF-Viewer/vue/Redaction/ui-interaction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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 comes from the General tab settings.
7676

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

Document-Processing/PDF/PDF-Viewer/vue/accessibility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The accessibility compliance for the PDF Viewer component is summarized below.
3838

3939
<div><img src="https://cdn.syncfusion.com/content/images/documentation/not-supported.png" alt="No"> - The component does not meet the requirement.</div>
4040

41-
Note: Mobile device support is marked as partial due to platform-level constraints on hover interactions, complex keyboard navigation, and screen reader capabilities that vary by device and browser.
41+
N> Mobile device support is marked as partial due to platform-level constraints on hover interactions, complex keyboard navigation, and screen reader capabilities that vary by device and browser.
4242

4343
## WAI-ARIA attributes
4444

Document-Processing/PDF/PDF-Viewer/vue/download.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The Vue PDF Viewer lets users download the currently loaded PDF. Enable the down
1313

1414
![PDF Viewer toolbar with download button](./images/download.png)
1515

16-
> Note: When loading documents from other origins, ensure that CORS is correctly configured on the server. In server-backed mode, the document is streamed through the serviceUrl endpoint, which must allow download requests.
16+
N> When loading documents from other origins, ensure that CORS is correctly configured on the server. In server-backed mode, the document is streamed through the serviceUrl endpoint, which must allow download requests.
1717

1818
To invoke download programmatically, use the following snippet:
1919

Document-Processing/PDF/PDF-Viewer/vue/event.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The following table lists commonly used events supported by the PDF Viewer compo
6868
| [`validateFormFields`](#validateformfields) | Triggers when form field validation fails. |
6969
| [`zoomChange`](#zoomchange) | Triggers when the magnification value changes. |
7070

71-
Note: For annotation and signature events, see the dedicated Annotations Events topic.
71+
For annotation and signature events, see the dedicated Annotations Events topic.
7272

7373
## bookmarkClick
7474

Document-Processing/PDF/PDF-Viewer/vue/forms/form-designer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Designed form fields can be saved into the PDF document and printed with their a
4545

4646
## Enable Form Designer
4747

48-
To enable form design features, inject the [FormDesigner](https://ej2.syncfusion.com/vue/documentation/api/pdfviewer/formdesigner) module into the PDF Viewer. After injecting the module, use the `enableFormDesigner` property or API to enable or disable the Form Designer option in the main toolbar (set to `true` to enable). Note: the standalone examples below show `enableFormDesigner` set to `false`; change this to `true` to enable form design in those samples.
48+
To enable form design features, inject the [FormDesigner](https://ej2.syncfusion.com/vue/documentation/api/pdfviewer/formdesigner) module into the PDF Viewer. After injecting the module, use the `enableFormDesigner` property or API to enable or disable the Form Designer option in the main toolbar (set to `true` to enable). The standalone examples below show `enableFormDesigner` set to `false`; change this to `true` to enable form design in those samples.
4949

5050
{% tabs %}
5151
{% highlight html tabtitle="Composition API (~/src/App.vue)" %}

Document-Processing/PDF/PDF-Viewer/vue/forms/import-export-form-fields/import-form-fields.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The **PDF Viewer** lets you import values into interactive form fields in the cu
1818
## API to use
1919
- [importFormFields](https://ej2.syncfusion.com/vue/documentation/api/pdfviewer/index-default#importformfields)(sourceOrObject, format)
2020

21-
Note: If you’re using a **server-backed viewer**, set `serviceUrl` before importing.
21+
N> If a **server-backed viewer** is used, set `serviceUrl` before importing.
2222

2323
### Import FDF
2424

Document-Processing/PDF/PDF-Viewer/vue/how-to/extract-text-option.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The `extractTextOption` property controls the amount of text and layout informat
1515
### Available Options:
1616

1717
- **None** — Do not extract or return any text or layout data. Use this option to minimize memory usage when textual information is not required.
18-
- **TextOnly** — Return plain text only; layout and bounds are omitted. Note: using `TextOnly` may disable some viewer text features such as synchronous `findText`; use `findTextAsync` when asynchronous search is required.
18+
- **TextOnly** — Return plain text only; layout and bounds are omitted. Using `TextOnly` may disable some viewer text features such as synchronous `findText`; use `findTextAsync` when asynchronous search is required.
1919
- **BoundsOnly** — Return layout and positional data (bounds) without the plain text content.
2020
- **TextAndBounds** — Return both plain text and its positional information (bounds). This is the default and is useful when both content and layout are required.
2121

Document-Processing/PDF/PDF-Viewer/vue/open-pdf-file/from-amazon-s3.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ N> Replace the placeholder values with valid values when testing. Do not embed p
4343

4444
<script>
4545
AWS.config.update({
46-
region: '**Your Region**', // Update this your region
47-
accessKeyId: '*Your Access Key*', // Update this with your access key id
48-
secretAccessKey: '*Your Security Access Key*', // Update this with your secret access key
46+
region: '**Your Region**', // Update this with the region
47+
accessKeyId: '*Your Access Key*', // Update this with the access key id
48+
secretAccessKey: '*Your Security Access Key*', // Update this with the secret access key
4949
});
5050
</script>
5151

@@ -107,9 +107,9 @@ Create a basic PDF Viewer sample by following the instructions in the [getting s
107107

108108
**Step 2:** Modify the `PdfViewerController.cs` File in the Web Service Project
109109

110-
1. Create a web service project in .NET Core 3.0 or above. You can refer to this [link](https://www.syncfusion.com/kb/11063/how-to-create-pdf-viewer-web-service-in-net-core-3-0-and-above) for instructions on how to create a web service project.
110+
1. Create a web service project in .NET Core 3.0 or above. Refer to this [link](https://www.syncfusion.com/kb/11063/how-to-create-pdf-viewer-web-service-in-net-core-3-0-and-above) for instructions on how to create a web service project.
111111

112-
2. Open the `PdfViewerController.cs` file in your web service project.
112+
2. Open the `PdfViewerController.cs` file in the web service project.
113113

114114
3. Import the required namespaces at the top of the file:
115115

@@ -161,7 +161,7 @@ public async Task<IActionResult> Load([FromBody] Dictionary<string, string> json
161161
{
162162
RegionEndpoint bucketRegion = RegionEndpoint.USEast1;
163163

164-
// Configure the AWS SDK with your access credentials and other settings
164+
// Configure the AWS SDK with the access credentials and other settings
165165
var s3Client = new AmazonS3Client(_accessKey, _secretKey, bucketRegion);
166166

167167
string document = jsonObject["document"];
@@ -186,7 +186,7 @@ public async Task<IActionResult> Load([FromBody] Dictionary<string, string> json
186186
}
187187
```
188188

189-
6. Open the `appsettings.json` file in your web service project. Add the following lines below the existing `"AllowedHosts"` configuration.
189+
6. Open the `appsettings.json` file in the web service project. Add the following lines below the existing `"AllowedHosts"` configuration.
190190

191191
```json
192192
{
@@ -207,7 +207,7 @@ N> Replace the placeholders with actual values when testing. For production depl
207207

208208
**Step 3:** Configure the PDF Viewer component
209209

210-
Set the serviceUrl to your web service endpoint (replace the localhost URL with your server URL). Set documentPath to the PDF file name to load from AWS S3. Ensure the document name matches an object in your bucket.
210+
Set the serviceUrl to the web service endpoint (replace the localhost URL with the server URL). Set documentPath to the PDF file name to load from AWS S3. Ensure the document name matches an object in the bucket.
211211

212212
{% tabs %}
213213
{% highlight html tabtitle="Composition API (~/src/App.vue)" %}
@@ -226,7 +226,7 @@ import {
226226
ThumbnailView, Print, TextSelection, TextSearch, Annotation, FormFields, FormDesigner
227227
} from '@syncfusion/ej2-vue-pdfviewer';
228228

229-
// Replace the "localhost:44396" with the actual URL of your server
229+
// Replace the "localhost:44396" with the actual URL of the server
230230
const serviceUrl = "https://localhost:44396/pdfviewer";
231231
const documentPath = "PDF_Succinctly.pdf";
232232

@@ -258,7 +258,7 @@ export default {
258258
},
259259
data() {
260260
return {
261-
// Replace the "localhost:44396" with the actual URL of your server
261+
// Replace the "localhost:44396" with the actual URL of the server
262262
serviceUrl: "https://localhost:44396/pdfviewer",
263263
documentPath: "PDF_Succinctly.pdf"
264264
};
@@ -273,6 +273,6 @@ export default {
273273
{% endhighlight %}
274274
{% endtabs %}
275275

276-
N> The **AWSSDK.S3** NuGet package must be installed in your application to use the previous code example.
276+
N> The **AWSSDK.S3** NuGet package must be installed in the application to use the previous code example.
277277

278278
[View sample in GitHub](https://github.com/SyncfusionExamples/open-save-pdf-documents-in-aws-s3/tree/master/Open%20and%20Save%20PDF%20in%20AWS%20S3%20using%20Server-Backend)

Document-Processing/PDF/PDF-Viewer/vue/open-pdf-file/from-azure-active-directory.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ This article explains how to load and save PDF files from Azure Active Directory
4949
1. **Assign the Storage Blob Data Contributor role**
5050
- In the Storage account, open **Access control (IAM)****Add role assignment**.
5151
- Select **Storage Blob Data Contributor**, choose **User, group, or service principal**, and add the registered application as a member.
52-
- Click on **Select members** and search for your registered application by name or client ID.
53-
- Select your application and click **Select**.
52+
- Click on **Select members** and search for the registered application by name or client ID.
53+
- Select the application and click **Select**.
5454
- Click **Review + assign** to finalize the role assignment.
5555

5656
![Assign role to application in Azure](../images/add-role.png)
@@ -62,7 +62,7 @@ This article explains how to load and save PDF files from Azure Active Directory
6262
- In the Storage account, open **Containers**, create or select a container, and upload the PDF document intended for viewing.
6363

6464
2. **Upload the PDF file**:
65-
- Create a new container and upload the PDF document you want to access in the PDF Viewer.
65+
- Create a new container and upload the PDF document the want to access in the PDF Viewer.
6666

6767
![Upload PDF to Azure Blob container](../images/upload-pdf.png)
6868
---
@@ -71,11 +71,11 @@ This article explains how to load and save PDF files from Azure Active Directory
7171

7272
1. **Configure server-side code**:
7373
- Open the server-side application (for example, ASP.NET Core) and configure the following details in the `PdfViewerController` file:
74-
- `tenantId` (your Azure AD tenant ID),
75-
- `clientId` (your registered application client ID),
76-
- `clientSecret` (your registered application client secret),
77-
- `blobServiceEndpoint` (your storage account blob service URL),
78-
- `containerName` (your container name in Azure Blob Storage).
74+
- `tenantId` (Azure AD tenant ID),
75+
- `clientId` (registered application client ID),
76+
- `clientSecret` (registered application client secret),
77+
- `blobServiceEndpoint` (storage account blob service URL),
78+
- `containerName` (container name in Azure Blob Storage).
7979

8080
2. **Run the web service**:
8181
- After saving the configuration values, run the web service so that the Vue application can reach it.
@@ -207,7 +207,7 @@ export default {
207207

208208
return {
209209
// Path to the document
210-
documentPath: "", // You can set this to an initial document URL or keep it empty
210+
documentPath: "", // Set this to an initial document URL or keep it empty
211211
// URL for the service (used by the Syncfusion PDF Viewer)
212212
serviceUrl: "https://localhost:44308/pdfviewer",
213213
// Toolbar settings

Document-Processing/PDF/PDF-Viewer/vue/open-pdf-file/from-azure-blob-storage.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Follow the getting-started guide in this [link](https://help.syncfusion.com/docu
3636

3737
2. Use the `SASUrl` to fetch the PDF file, convert the response to an `ArrayBuffer`, and then transform it into a `Uint8Array`. Convert the `Uint8Array` into a Base64 string and load it into the PDF Viewer.
3838

39-
N> Replace **Your SAS Url in Azure** with the actual SAS URL for your Azure Blob Storage account.
39+
N> Replace **Your SAS Url in Azure** with the actual SAS URL for the Azure Blob Storage account.
4040

4141
{% tabs %}
4242
{% highlight html tabtitle="Options API (~/src/App.vue)" %}
@@ -64,7 +64,7 @@ N> Replace **Your SAS Url in Azure** with the actual SAS URL for your Azure Blob
6464
{% endhighlight %}
6565
{% endtabs %}
6666

67-
N> The **npm install @azure/storage-blob** package must be installed in your application to use the previous code example.
67+
N> The **npm install @azure/storage-blob** package must be installed in the application to use the previous code example.
6868

6969
[View sample in GitHub](https://github.com/SyncfusionExamples/open-save-pdf-documents-in-azure-blob-storage/tree/master/Open%20and%20Save%20PDF%20in%20Azure%20Blob%20Storage%20using%20Standalone).
7070

@@ -78,9 +78,9 @@ Follow the getting-started guide in this [link](https://help.syncfusion.com/docu
7878

7979
**Step 2:** Modify the `PdfViewerController.cs` File in the Web Service Project
8080

81-
1. Create a web service project in .NET Core 3.0 or above. You can refer to this [link](https://www.syncfusion.com/kb/11063/how-to-create-pdf-viewer-web-service-in-net-core-3-0-and-above) for instructions on how to create a web service project.
81+
1. Create a web service project in .NET Core 3.0 or above. Refer to this [link](https://www.syncfusion.com/kb/11063/how-to-create-pdf-viewer-web-service-in-net-core-3-0-and-above) for instructions on how to create a web service project.
8282

83-
2. Open the `PdfViewerController.cs` file in your web service project.
83+
2. Open the `PdfViewerController.cs` file in the web service project.
8484

8585
3. Import the required namespaces at the top of the file:
8686

@@ -141,7 +141,7 @@ public IActionResult Load([FromBody] Dictionary<string, string> jsonObject)
141141
}
142142
```
143143

144-
6. Open the `appsettings.json` file in your web service project and add the following lines below the existing `"AllowedHosts"` configuration:
144+
6. Open the `appsettings.json` file in the web service project and add the following lines below the existing `"AllowedHosts"` configuration:
145145

146146
```json
147147
{
@@ -157,11 +157,11 @@ public IActionResult Load([FromBody] Dictionary<string, string> jsonObject)
157157
}
158158
```
159159

160-
Note: Do not store secrets in source control. Use secure configuration options such as Azure Key Vault, environment variables, or a secrets manager to hold connection strings.
160+
N> Do not store secrets in source control. Use secure configuration options such as Azure Key Vault, environment variables, or a secrets manager to hold connection strings.
161161

162162
**Step 3:** Configure the PDF Viewer component
163163

164-
Set the `serviceUrl` property of the PDF Viewer component to your web service endpoint (replace `https://localhost:44396/pdfviewer` with the actual URL of your server). Set the `documentPath` property to the PDF file name to load from Azure Blob Storage. Ensure the document name exists in your Azure container.
164+
Set the `serviceUrl` property of the PDF Viewer component to the web service endpoint (replace `https://localhost:44396/pdfviewer` with the actual URL of the server). Set the `documentPath` property to the PDF file name to load from Azure Blob Storage. Ensure the document name exists in the Azure container.
165165

166166
{% tabs %}
167167
{% highlight html tabtitle="Composition API (Server-Backed)" %}
@@ -181,7 +181,7 @@ import {
181181
ThumbnailView, Print, TextSelection, TextSearch, Annotation, FormFields, FormDesigner
182182
} from '@syncfusion/ej2-vue-pdfviewer';
183183

184-
// Replace the "localhost:44396" with the actual URL of your server
184+
// Replace the "localhost:44396" with the actual URL of the server
185185
const serviceUrl = "https://localhost:44396/pdfviewer";
186186
const documentPath = "PDF_Succinctly.pdf";
187187

@@ -213,7 +213,7 @@ export default {
213213
},
214214
data() {
215215
return {
216-
// Replace the "localhost:44396" with the actual URL of your server
216+
// Replace the "localhost:44396" with the actual URL of the server
217217
serviceUrl: "https://localhost:44396/pdfviewer",
218218
documentPath: "PDF_Succinctly.pdf"
219219
};
@@ -228,6 +228,6 @@ export default {
228228
{% endhighlight %}
229229
{% endtabs %}
230230

231-
N> The `Azure.Storage.Blobs` NuGet package must be installed in your application to use the previous code example.
231+
N> The `Azure.Storage.Blobs` NuGet package must be installed in the application to use the previous code example.
232232

233233
[View sample in GitHub](https://github.com/SyncfusionExamples/open-save-pdf-documents-in-azure-blob-storage/tree/master/Open%20and%20Save%20PDF%20in%20Azure%20Blob%20Storage%20using%20Server-Backend).

0 commit comments

Comments
 (0)