Skip to content

895038: update API link #563

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: hotfix/hotfix-v26.1.35
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions ej2-angular/pdfviewer/annotation/free-text-annotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ import { LinkAnnotationService, BookmarkViewService,

## How to clear the selection focus from free text annotation

The free text annotations selection focus can be cleared by using the [setAnnotationMode](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/annotation/) property of the `annotationModule`.
The free text annotations selection focus can be cleared by using the [setAnnotationMode](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/annotation/#setannotationmode) property of the `annotationModule`.

Refer to the following code sample to remove the selection focus from the annotation by using a button click.

Expand Down Expand Up @@ -151,7 +151,7 @@ RemoveSelection() {

With the PDF Viewer library, you can add a Free Text annotation to the PDF Viewer control programmatically using the [**addAnnotation()**](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/annotation/#addannotationn) method.

Here's a example of how you can utilize the **addAnnotation()** method to include a Free Text annotation programmatically
Here's a example of how you can utilize the [**addAnnotation()**](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/annotation/#addannotation) method to include a Free Text annotation programmatically

{% tabs %}
{% highlight ts tabtitle="Standalone" %}
Expand Down Expand Up @@ -351,9 +351,9 @@ Find the sample [how to move the free text annotation programmatically](https://

## Get the newly added free text annotation ID

To get the ID of a newly added free text annotation in the Syncfusion PDF viewer, you can use the **annotationAdd()** event. This event is triggered whenever a new annotation is added to the PDF document, and it provides the annotationAddEventHandler object as a parameter. You can access the ID of the new annotation through the AnnotationID property of the annotationAddEventHandler object.
To get the ID of a newly added free text annotation in the Syncfusion PDF viewer, you can use the [**annotationAdd()**](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/annotation/#addannotation) event. This event is triggered whenever a new annotation is added to the PDF document, and it provides the annotationAddEventHandler object as a parameter. You can access the ID of the new annotation through the AnnotationID property of the annotationAddEventHandler object.

Here is an example of how you can use the **annotationAdd()** event to get the ID of a new free text annotation:
Here is an example of how you can use the [**annotationAdd()**](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/annotation/#addannotation) event to get the ID of a new free text annotation:

```typescript

Expand Down
20 changes: 10 additions & 10 deletions ej2-angular/pdfviewer/form-designer/create-programmatically.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ We can open the already saved PDF document contains Form Fields in it by clickin

## Validate form fields

The form fields in the PDF Document will be validated when the [enableFormFieldsValidation](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/validateFormFieldsArgs/) is set to true and hook the validateFormFields. The validateFormFields will be triggered when the PDF document is downloaded or printed with the non-filled form fields. The non-filled fields will be obtained in the [nonFillableFields](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/validateFormFieldsArgs/) property of the event arguments of validateFormFields.
The form fields in the PDF Document will be validated when the [enableFormFieldsValidation](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#enableformfieldsvalidation) is set to true and hook the validateFormFields. The validateFormFields will be triggered when the PDF document is downloaded or printed with the non-filled form fields. The non-filled fields will be obtained in the [nonFillableFields](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/validateFormFieldsArgs/#nonfillablefields) property of the event arguments of validateFormFields.

Add the following code snippet to validate the form fields,

Expand Down Expand Up @@ -428,7 +428,7 @@ export class AppComponent implements OnInit {
{% endtabs %}
## Export and import form fields

The PDF Viewer control provides the support to export and import the form field data in the following formats using the methods `importFormFields`, `exportFormFields`, `exportFormFieldsAsObject`.
The PDF Viewer control provides the support to export and import the form field data in the following formats using the methods [importFormFields](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#importformfields), [exportFormFields](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#exportformfields), [exportFormFieldsAsObject](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#exportformfieldsasobject).

* FDF
* XFDF
Expand All @@ -437,7 +437,7 @@ The PDF Viewer control provides the support to export and import the form field

### Export and import as FDF

Using the `exportFormFields` method, the form field data can be exported in the specified data format. This method accepts two parameters:
Using the [exportFormFields](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#exportformfields) method, the form field data can be exported in the specified data format. This method accepts two parameters:

* The first one must be the destination path for the exported data. If path is not specified, it will ask for the location while exporting.
* The second parameter should be the format type of the form data.
Expand Down Expand Up @@ -602,7 +602,7 @@ Form field properties in Syncfusion PDF Viewer allow you to customize and intera

### Signature and initial fields settings

Using the `updateFormField` method, the form fields can be updated programmatically.
Using the [updateFormField](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#updateformfields) method, the form fields can be updated programmatically.

The following code example explains how to update the signature field properties on a button click.

Expand Down Expand Up @@ -738,7 +738,7 @@ The following code example explains how to update the properties of the initial

### Textbox field settings

Using the `updateFormField` method, the form fields can be updated programmatically.
Using the [updateFormField](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#updateformfields) method, the form fields can be updated programmatically.

The following code example explains how to update the Textbox field properties on a button click.

Expand Down Expand Up @@ -849,7 +849,7 @@ The following code example explains how to update the properties of the Textbox

### Password field settings

Using the `updateFormField` method, the form fields can be updated programmatically.
Using the [updateFormField](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#updateformfields) method, the form fields can be updated programmatically.

The following code example explains how to update the Password field properties on a button click.

Expand Down Expand Up @@ -958,7 +958,7 @@ The following code example explains how to update the properties of the Password

### CheckBox field settings

Using the `updateFormField` method, the form fields can be updated programmatically.
Using the [updateFormField](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#updateformfields) method, the form fields can be updated programmatically.

The following code example explains how to update the CheckBox field properties on a button click.

Expand Down Expand Up @@ -1051,7 +1051,7 @@ The following code example explains how to update the properties of the CheckBox

### RadioButton field settings

Using the `updateFormField` method, the form fields can be updated programmatically.
Using the [updateFormField](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#updateformfields) method, the form fields can be updated programmatically.

The following code example explains how to update the RadioButton field properties on a button click.

Expand Down Expand Up @@ -1144,7 +1144,7 @@ The following code example explains how to update the properties of the RadioBut

### ListBox field settings

Using the `updateFormField` method, the form fields can be updated programmatically.
Using the [updateFormField](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#updateformfields) method, the form fields can be updated programmatically.

The following code example explains how to update the ListBox field properties on a button click.

Expand Down Expand Up @@ -1253,7 +1253,7 @@ The following code example explains how to update the properties of the ListBox

### DropDown field settings

Using the `updateFormField` method, the form fields can be updated programmatically.
Using the [updateFormField](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#updateformfields) method, the form fields can be updated programmatically.

The following code example explains how to update the DropDown field properties on a button click.

Expand Down
2 changes: 1 addition & 1 deletion ej2-angular/pdfviewer/how-to/change-selection-border.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ domainurl: ##DomainURL##

# Customize the selection border

The PDF Viewer library allows you to customize the annotations selection borders using the [**annotationSelectorSettings**](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/annotationSelectorSettingsModel/#annotationselectorsettingsmodel) Property.
The PDF Viewer library allows you to customize the annotations selection borders using the [**annotationSelectorSettings**](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#annotationselectorsettings) Property.

The following steps are used to customize the selection border.

Expand Down
4 changes: 2 additions & 2 deletions ej2-angular/pdfviewer/how-to/custom-context-menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ domainurl: ##DomainURL##

# Customize context menu

PDF Viewer allows you to add custom option in context menu. It can be achieved by using the `addCustomMenu()` method and custom action is defined using the `customContextMenuSelect()`method.
PDF Viewer allows you to add custom option in context menu. It can be achieved by using the [addCustomMenu()](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#addcustommenu) method and custom action is defined using the [customContextMenuSelect()](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#customcontextmenuselect) method.

### Add Custom Option

Expand Down Expand Up @@ -101,7 +101,7 @@ The PDF Viewer feature enables customization of custom options and the ability t

#### Customize added context menu items

The following code shows how to hide/show added custom option in context menu using the `customContextMenuBeforeOpen()` method.
The following code shows how to hide/show added custom option in context menu using the [customContextMenuBeforeOpen()](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#customcontextmenubeforeopen) method.

```js
export class CustomContextMenuComponent implements OnInit {
Expand Down
4 changes: 2 additions & 2 deletions ej2-angular/pdfviewer/how-to/custom-stamp.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: post
title: Add the custom stamp based on the free text bounds | Syncfusion
Description: Learn how to add the custom stamp based on the free text bounds in Syncfusion Angular Pdfviewer component of Syncfusion Essential JS 2 and more.
description: Learn how to add the custom stamp based on the free text bounds in Syncfusion Angular Pdfviewer component of Syncfusion Essential JS 2 and more.
platform: ej2-angular
control: Add the custom stamp based on the free text bounds
documentation: ug
Expand All @@ -10,7 +10,7 @@ domainurl: ##DomainURL##

# Add the custom stamp based on the free text bounds

To add a custom stamp in the Syncfusion PDF viewer based on the free text bounds, obtain the value of the bound for the free text in the Pixel in the **annotationAdd** event while adding the free text. However, when a custom stamp is added programmatically, the offset values are set in points. So, you must convert the value of the bound for the free text into a point to add the custom stamp to the free text bounds position.
To add a custom stamp in the Syncfusion PDF viewer based on the free text bounds, obtain the value of the bound for the free text in the Pixel in the [**annotationAdd**](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#annotationadd) event while adding the free text. However, when a custom stamp is added programmatically, the offset values are set in points. So, you must convert the value of the bound for the free text into a point to add the custom stamp to the free text bounds position.

Here is an example of how you can add the custom stamp based on the free text bounds:

Expand Down
2 changes: 1 addition & 1 deletion ej2-angular/pdfviewer/how-to/download-start-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,4 +96,4 @@ By default, the cancel argument is set to `false`, indicating that the download

### Enhanced Flexibility

By leveraging the [downloadStart](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/downloadStartEventArgs/) event and its cancel argument, you gain the ability to implement custom logic to control and potentially prevent download actions based on your application's specific requirements. This enhancement provides greater flexibility in managing user interactions with PDF documents, empowering you to tailor the experience according to your needs.
By leveraging the [downloadStart](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#downloadstart) event and its cancel argument, you gain the ability to implement custom logic to control and potentially prevent download actions based on your application's specific requirements. This enhancement provides greater flexibility in managing user interactions with PDF documents, empowering you to tailor the experience according to your needs.
8 changes: 4 additions & 4 deletions ej2-angular/pdfviewer/how-to/enable-disable-annotation.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
layout: post
title: How to enable and disable the delete button based on annotation selection and unselection events | Syncfusion
Description: Learn to enable and disable delete button based on annotation events in Syncfusion Angular PDF Viewer component and more.
title: Enable and disable the delete button based on annotation | Syncfusion
description: Learn to enable and disable delete button based on annotation events in Syncfusion Angular PDF Viewer component and more.
platform: ej2-angular
control: How to enable and disable the delete button based on annotation selection and unselection events
documentation: ug
domainurl: ##DomainURL##
---

# How to enable and disable the delete button based on annotation selection and unselection events
# Enable and disable the delete button based on annotation in Angular

In the Syncfusion PDF viewer, enable and disable the delete button while selecting and unselecting annotations by using the **annotationSelect** and **annotationUnSelect** events.
In the Syncfusion PDF viewer, enable and disable the delete button while selecting and unselecting annotations by using the [**annotationSelect**](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#annotationselect) and [**annotationUnSelect**](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#annotationunselect) events.

Here is an example of how you can enable and disable the delete button while selecting and unselecting annotations:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: post
title: Get base string of the loaded document in Angular Pdfviewer component | Syncfusion
title: Get Base string of loaded document in Angular Pdfviewer | Syncfusion
description: Learn here all about Get base string of the loaded document in Syncfusion Angular Pdfviewer component of Syncfusion Essential JS 2 and more.
platform: ej2-angular
control: Get base string of the loaded document
Expand All @@ -10,7 +10,7 @@ domainurl: ##DomainURL##

# Get the Base 64 string of the loaded PDF document

The PDF Viewer library allows you to get the base 64 string of the loaded PDF document by using **saveAsBlob()** method. The entire PDF document will get as blob as like memory stream. So, we can save the blob or convert into stream and we can save it in the database. We can also load the PDF document from base 64 string using the **load()** method.
The PDF Viewer library allows you to get the base 64 string of the loaded PDF document by using [**saveAsBlob()**](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#saveasblob) method. The entire PDF document will get as blob as like memory stream. So, we can save the blob or convert into stream and we can save it in the database. We can also load the PDF document from base 64 string using the [**load()**](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#load) method.

The following steps are used to get the base 64 string of the loaded PDF document in the PDF viewer control.

Expand Down Expand Up @@ -41,7 +41,7 @@ base64ofloadedDocument() {

```

**Step 3:** Use the following code snippet inside the **saveAsBlob()** method to load the document from the base 64 string.
**Step 3:** Use the following code snippet inside the [**saveAsBlob()**](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#saveasblob) method to load the document from the base 64 string.

```typescript
// load the document from base 64 string.
Expand Down
4 changes: 2 additions & 2 deletions ej2-angular/pdfviewer/how-to/load-office-files.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: post
title: Load office files in PDF Viewer
title: Load office files in Angular Pdfviewer component | Syncfusion
description: Learn about how to load office files in Syncfusion Angular Pdfviewer component of Syncfusion Essential JS 2 and more.
platform: ej2-angular
control: How to load the Office products
Expand Down Expand Up @@ -96,7 +96,7 @@ public IActionResult GetImageStream([FromBody] Dictionary<string, string> jsonOb

```

**Step 3:** In the following code, an XMLHttpRequest will generate the responseText from the base64 string and set that text as the `documentPath` of the PDF Viewer.
**Step 3:** In the following code, an XMLHttpRequest will generate the responseText from the base64 string and set that text as the [documentPath](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#documentpath) of the PDF Viewer.

```html

Expand Down
4 changes: 2 additions & 2 deletions ej2-angular/pdfviewer/how-to/lock-annotation-in-a-document.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ The PDF Viewer provides a support to enable or disable lock option for the annot

## Lock an annotation from code behind

The annotation can be locked either by default settings or by an event using the [IsLocked](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/annotationSettings/) API.
The annotation can be locked either by default settings or by an event using the [IsLocked](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/annotationSettings/#islock) API.

The following code sample illustrates how to lock custom stamp annotation in a PDF document through [ajaxRequestSuccess](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/ajaxRequestSuccessEventArgs/) event .
The following code sample illustrates how to lock custom stamp annotation in a PDF document through [ajaxRequestSuccess](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#ajaxrequestsuccess) event .

{% tabs %}
{% highlight js tabtitle="Standalone" %}
Expand Down
4 changes: 2 additions & 2 deletions ej2-angular/pdfviewer/how-to/lock-formfield-in-a-document.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ The PDF Viewer component offers the ability to enable or disable the locking opt

## Locking Form Fields Programmatically

Form fields can be locked either by default settings or by utilizing an event and the [isReadOnly](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/formField/) API.
Form fields can be locked either by default settings or by utilizing an event and the [isReadOnly](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/formField/#isreadonly) API.

The provided code snippet exemplifies how to lock form fields in a PDF document during the document loading process. It utilizes the `documentLoad` event to add form fields and subsequently sets them as read-only using the [isReadOnly](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/formField/) API. This ensures that users cannot modify the form fields, thereby preserving data integrity.
The provided code snippet exemplifies how to lock form fields in a PDF document during the document loading process. It utilizes the [documentLoad](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/#documentload) event to add form fields and subsequently sets them as read-only using the [isReadOnly](https://ej2.syncfusion.com/angular/documentation/api/pdfviewer/formField/#isreadonly) API. This ensures that users cannot modify the form fields, thereby preserving data integrity.

{% tabs %}
{% highlight js tabtitle="Standalone" %}
Expand Down
Loading