FLUT-889763-[documentation][flutter]: Revamp the Flutter PDF viewer UG #872

KrithigaPerumal · 2024-06-06T09:46:48Z

Description

Modified documentation content and added the content to the new sections.

SyncfusionBuild · 2024-06-06T09:47:43Z

Build Status: INPROGRESS 🔃
Build Location: FLUT-889763-flutter-text-selection

SyncfusionBuild · 2024-06-06T09:48:33Z

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: FLUT-889763-flutter-text-selection
Technical Error(s): 0
Spelling Error(s): 1
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
FT Layout Syntax Error(s): 0
Front matter Error(s): 6
File Path Error(s): 1
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0

SyncfusionBuild · 2024-06-06T10:29:11Z

Build Status: INPROGRESS 🔃
Build Location: FLUT-889763-flutter-text-selection

SyncfusionBuild · 2024-06-06T10:34:11Z

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: FLUT-889763-flutter-text-selection
Technical Error(s): 0
Spelling Error(s): 1
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
FT Layout Syntax Error(s): 0
Front matter Error(s): 6
File Path Error(s): 1
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0

immankumarsync · 2024-06-06T10:38:31Z

Flutter/pdf-viewer/load-document-events.md

@@ -0,0 +1,80 @@
+---
+layout: post
+title: Document Load Events in Flutter PDF Viewer (SfPdfViewer) | Syncfusion


Document Load Callbacks in Flutter PDF Viewer (SfPdfViewer) | Syncfusion

immankumarsync · 2024-06-06T10:41:11Z

Flutter/pdf-viewer/ui-customization.md

@@ -0,0 +1,88 @@
+---
+layout: post
+title: UI Customization in Flutter PDF Viewer widget (SfPdfViewer) | Syncfusion


Need to change the title

immankumarsync · 2024-06-06T10:41:53Z

Flutter/pdf-viewer/open-a-document-password-protected.md

@@ -0,0 +1,267 @@
+---


There is already a section to view the password protected files. Why a new section is needed?

SyncfusionBuild · 2024-06-06T13:02:06Z

Build Status: INPROGRESS 🔃
Build Location: FLUT-889763-flutter-text-selection

SyncfusionBuild · 2024-06-06T13:03:46Z

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: FLUT-889763-flutter-text-selection
Image Alt Text Error(s): 0
Image Size Error(s): 1
Image Name Error(s): 0
FT Layout Syntax Error(s): 0
Front matter Error(s): 20
File Path Error(s): 1
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0

SyncfusionBuild · 2024-06-07T10:45:12Z

Build Status: INQUEUE 🕒
Build Location: FLUT-889763-flutter-text-selection

SyncfusionBuild · 2024-06-07T10:56:54Z

Build Status: INPROGRESS 🔃
Build Location: FLUT-889763-flutter-text-selection

SyncfusionBuild · 2024-06-07T10:59:24Z

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: FLUT-889763-flutter-text-selection
Image Alt Text Error(s): 0
Image Size Error(s): 1
Image Name Error(s): 0
FT Layout Syntax Error(s): 0
Front matter Error(s): 21
File Path Error(s): 1
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0

SyncfusionBuild · 2024-06-10T06:06:54Z

Build Status: INPROGRESS 🔃
Build Location: FLUT-889763-flutter-text-selection

SyncfusionBuild · 2024-06-10T06:07:44Z

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: FLUT-889763-flutter-text-selection
Image Alt Text Error(s): 0
Image Size Error(s): 1
Image Name Error(s): 0
FT Layout Syntax Error(s): 0
Front matter Error(s): 21
File Path Error(s): 2
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0

immankumarsync · 2024-06-14T10:18:40Z

Flutter/pdf-viewer/add-remove-modify-annotations.md


 ## Add annotations to a PDF document

 This section will go through how to add annotations to a PDF document programmatically.

 ### Add annotations programmatically

-You can programmatically add a new annotation to the PDF document by creating an annotation instance and providing it as a parameter to the `addAnnotation` method of the `PdfViewerController` class. The following example shows how to create an instance of a highlight annotation and add it to the PDF document. Similarly, you can create and add other types of annotation.
+You can programmatically add a new annotation to the PDF document by creating an annotation instance and providing it as a parameter to the [addAnnotation](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/search.html?q=addAnnotation) method of the [PdfViewerController](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/pdfviewer/PdfViewerController-class.html) class. The following example shows how to create an instance of a highlight annotation and add it to the PDF document. Similarly, you can create and add other types of annotation.


Add proper link

Added proper link for add annotation method.

immankumarsync · 2024-06-14T10:19:53Z

Flutter/pdf-viewer/add-remove-modify-annotations.md

@@ -90,7 +90,7 @@ void removeFirstAnnotation() {

 ### Remove all the annotations

-You can programmatically remove all the annotations from a document by calling the `removeAllAnnotations` method. The optional `pageNumber` parameter can be used to clear the form field data on a specific page. By default, the pageNumber parameter is 0. Refer to the following code example. 
+You can programmatically remove all the annotations from a document by calling the [removeAllAnnotations](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/pdfviewer/PdfViewerController/removeAllAnnotations.html) method. The optional [pageNumber](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/pdfviewer/PdfViewerController/pageNumber.html) parameter can be used to clear the form field data on a specific page. By default, the pageNumber parameter is 0. Refer to the following code example. 


Remove the link for pageNumber

Removed the link for the pageNumber API.

immankumarsync · 2024-06-14T10:21:32Z

Flutter/pdf-viewer/form-filling.md

@@ -450,7 +450,7 @@ Widget build(BuildContext context) {

 ## Clear form data

-The [clearFormData](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/pdfviewer/PdfViewerController/clearFormData.html) method clears all the form field data in the PDF document. The optional `pageNumber` parameter can be used to clear the form field data on a specific page. By default, the `pageNumber` parameter is 0. Refer to the following code example.
+The [clearFormData](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/pdfviewer/PdfViewerController/clearFormData.html) method clears all the form field data in the PDF document. The optional [pageNumber](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/pdfviewer/PdfViewerController/pageNumber.html) parameter can be used to clear the form field data on a specific page. By default, the [pageNumber](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/pdfviewer/PdfViewerController/pageNumber.html) parameter is 0. Refer to the following code example.


Remove the link for both pageNumber optional parameters

Removed the link for both pageNumber optional parameters.

immankumarsync · 2024-06-14T10:22:24Z

Flutter/pdf-viewer/form-filling.md

@@ -672,7 +672,7 @@ Widget build(BuildContext context) {

 If you performed undesired actions when editing the form fields, you can undo and redo the action to restore the previous state.

-The undo and redo operations are performed by assigning the `UndoHistoryController` instance to the `undoController` property of the `SfPdfViewer`. The UndoHistoryController class contains the `undo` and `redo` methods to perform the same, respectively. The `canUndo` and `canRedo` properties are used to check whether the undo and redo operations can be performed or not, respectively. The following code example illustrates how to perform the form filling undo and redo operations programmatically with the `SfPdfViewer`.
+The undo and redo operations are performed by assigning the `UndoHistoryController` instance to the [undoController](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/pdfviewer/SfPdfViewer/undoController.html) property of the `SfPdfViewer`. The UndoHistoryController class contains the `undo` and `redo` methods to perform the same, respectively. The `canUndo` and `canRedo` properties are used to check whether the undo and redo operations can be performed or not, respectively. The following code example illustrates how to perform the form filling undo and redo operations programmatically with the `SfPdfViewer`.


Add API links for undo, redo, canUndo and canRedo APIs

Added proper API links for undo, redo, canUndo and canRedo APIs.

immankumarsync · 2024-06-14T10:23:54Z

Flutter/pdf-viewer/load-document-callbacks.md

+---
+layout: post
+title: Document Load Callbacks in Flutter PDF Viewer (SfPdfViewer) | Syncfusion
+description: Learn here all about events that notifies whether the document has been loaded or failed to get loaded in the Syncfusion Flutter PDF Viewer (SfPdfViewer).


Events -> callbacks

Changed the keyword "events" to "callbacks".

immankumarsync · 2024-06-14T10:25:44Z

Flutter/pdf-viewer/load-page-programmatically

@@ -0,0 +1,76 @@
+## Load the document with the specified page
+
+The `SfPdfViewer` allows you to load the document with the specified page using the `initialPageNumber` property. The following code example explains the same.


Add API link for initialPageNumber

Added the API link for initialPageNumber.

immankumarsync · 2024-06-14T10:25:59Z

Flutter/pdf-viewer/load-page-programmatically

+{% endhighlight %}
+{% endtabs %}
+
+N> It is recommended not to use both the [initialScrollOffset](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/pdfviewer/SfPdfViewer/initialScrollOffset.html) and `initialPageNumber` properties at the same time. If both properties are defined, the `initialPageNumber` will be prioritized over the [initialScrollOffset](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/pdfviewer/SfPdfViewer/initialScrollOffset.html)


Add API link for initialPageNumber

Added the API link for initialPageNumber.

immankumarsync · 2024-06-14T10:37:43Z

Flutter/pdf-viewer/page-navigation.md

@@ -214,7 +214,7 @@ The [onPageChanged](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/l
 * When scrolling is performed programmatically using the [jumpTo](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/pdfviewer/PdfViewerController/jumpTo.html) controller method.
 * When bookmark navigation is performed programmatically using the [jumpToBookmark](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/pdfviewer/PdfViewerController/jumpToBookmark.html) controller method.

-The [PdfPageChangedDetails](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/pdfviewer/PdfPageChangedDetails-class.html) will return the `oldPageNumber`, `newPageNumber`, `isFirstPage` and `isLastPage` values. The following code example explains the same.
+The [PdfPageChangedDetails](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/pdfviewer/PdfPageChangedDetails-class.html) will return the [oldPageNumber](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/pdfviewer/PdfPageChangedDetails/oldPageNumber.html), [newPageNumber](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/pdfviewer/PdfPageChangedDetails/newPageNumber.html), [isFirstPage](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/search.html?q=isFirstPage) and [isLastPage](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/pdfviewer/PdfPageChangedDetails/isLastPage.html) values. The following code example explains the same.


Add proper API link for isFirstPage property

Added proper API link for isFirstPage property

immankumarsync · 2024-06-14T10:44:01Z

Flutter/pdf-viewer/undo-redo.md

@@ -31,7 +31,7 @@ For desktop platforms such as Windows, macOS, and desktop web, you can use the f
 </tr>
 </table>

-You can perform the undo and redo operations in the `SfPdfViewer` by assigning the `UndoHistoryController` instance to the `undoController` property of the `SfPdfViewer`. The UndoHistoryController class contains the `undo` and `redo` methods to perform the undo and redo operations, respectively. The `canUndo` and `canRedo` properties check whether the undo and redo operations can be performed, respectively. The following code example illustrates how to perform the undo and redo operations programmatically in the `SfPdfViewer` with the help of the UndoHistoryController class.
+You can perform the undo and redo operations in the `SfPdfViewer` by assigning the `UndoHistoryController` instance to the [undoController](https://pub.dev/documentation/syncfusion_flutter_pdfviewer/latest/pdfviewer/SfPdfViewer/undoController.html) property of the `SfPdfViewer`. The UndoHistoryController class contains the `undo` and `redo` methods to perform the undo and redo operations, respectively. The `canUndo` and `canRedo` properties check whether the undo and redo operations can be performed, respectively. The following code example illustrates how to perform the undo and redo operations programmatically in the `SfPdfViewer` with the help of the UndoHistoryController class.


Add API links for undo, redo, canUndo an canRedo

Added API links for undo, redo, canUndo an canRedo.

Syncfusion-CI · 2024-06-14T11:51:44Z

Build Status: INPROGRESS 🔃
Build Location: FLUT-889763-flutter-text-selection

Syncfusion-CI · 2024-06-14T11:53:24Z

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: FLUT-889763-flutter-text-selection
Image Alt Text Error(s): 0
Image Size Error(s): 1
Image Name Error(s): 0
FT Layout Syntax Error(s): 0
Front matter Error(s): 21
File Path Error(s): 2
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0

SyncfusionBuild · 2024-06-14T13:18:05Z

Build Status: INQUEUE 🕒
Build Location: FLUT-889763-flutter-text-selection

SyncfusionBuild · 2024-06-14T13:28:55Z

Build Status: INPROGRESS 🔃
Build Location: FLUT-889763-flutter-text-selection

SyncfusionBuild · 2024-06-14T13:33:06Z

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: FLUT-889763-flutter-text-selection
Image Alt Text Error(s): 0
Image Size Error(s): 1
Image Name Error(s): 0
FT Layout Syntax Error(s): 0
Front matter Error(s): 24
File Path Error(s): 2
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0

FLUT-889763-[documentation][flutter]: Revamp the Flutter PDF viewer UG

1001995

FLUT-889763-[documentation][flutter]: Resolve spell check error.

8516e30

immankumarsync requested changes Jun 6, 2024

View reviewed changes

FLUT-889763-[documentation][flutter]: Adding links to the APIs

563a47a

FLUT-889763-[documentation][flutter]: Addressed review comments

efb5adb

FLUT-889763-[documentation][flutter]: Added links in the toc file

8e8948d

immankumarsync requested changes Jun 14, 2024

View reviewed changes

FLUT-889763-[documentation][flutter]: Addressed review comments

d324f10

FLUT-889763-[documentation][flutter]: Changes in toc file

2bffed2

		@@ -0,0 +1,76 @@
		## Load the document with the specified page

		The `SfPdfViewer` allows you to load the document with the specified page using the `initialPageNumber` property. The following code example explains the same.

FLUT-889763-[documentation][flutter]: Revamp the Flutter PDF viewer UG #872

Are you sure you want to change the base?

FLUT-889763-[documentation][flutter]: Revamp the Flutter PDF viewer UG #872

Conversation

KrithigaPerumal commented Jun 6, 2024

Description

SyncfusionBuild commented Jun 6, 2024

SyncfusionBuild commented Jun 6, 2024

SyncfusionBuild commented Jun 6, 2024

SyncfusionBuild commented Jun 6, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SyncfusionBuild commented Jun 6, 2024

SyncfusionBuild commented Jun 6, 2024

SyncfusionBuild commented Jun 7, 2024

SyncfusionBuild commented Jun 7, 2024

SyncfusionBuild commented Jun 7, 2024

SyncfusionBuild commented Jun 10, 2024

SyncfusionBuild commented Jun 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Syncfusion-CI commented Jun 14, 2024

Syncfusion-CI commented Jun 14, 2024

SyncfusionBuild commented Jun 14, 2024

SyncfusionBuild commented Jun 14, 2024

SyncfusionBuild commented Jun 14, 2024