Task(1040346): Need to improve UG documentation for .NET MAUI PDFViewer using code studio AI tools#3602
Task(1040346): Need to improve UG documentation for .NET MAUI PDFViewer using code studio AI tools#3602KSilambharasanSF4548 wants to merge 33 commits into
Conversation
|
Build Status: INQUEUE 🕒 |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: FAILURE ❌ |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: FAILURE ❌ |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: FAILURE ❌ |
|
Build Status: INPROGRESS 🔃 |
|
The running CI Job is terminated due to changes committed on the source branch for this Merge Request and CI triggered for latest commit. |
|
CI Status: ABORTED ❌ |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: SUCCESS ✅ |
92efa8c to
7eb4e49
Compare
|
Build Status: INPROGRESS 🔃 |
|
CI Status: SUCCESS ✅ |
| ## Edit annotations | ||
|
|
||
| This section will go through different methods of editing annotations in a PDF document programmatically. | ||
| This section explains different methods of editing annotations in a PDF document programmatically. The `AddAnnotation`, `RemoveAnnotation`, and property modifications on the annotations each raise their respective events: [AnnotationAdded](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.PdfViewer.SfPdfViewer.html#Syncfusion_Maui_PdfViewer_SfPdfViewer_AnnotationAdded), [AnnotationRemoved](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.PdfViewer.SfPdfViewer.html#Syncfusion_Maui_PdfViewer_SfPdfViewer_AnnotationRemoved), and [AnnotationEdited](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.PdfViewer.SfPdfViewer.html#Syncfusion_Maui_PdfViewer_SfPdfViewer_AnnotationEdited). |
There was a problem hiding this comment.
Discussing about event here is not valid.
There was a problem hiding this comment.
Changed as per previous
|
|
||
| To work with the annotation collection, ensure the following namespaces are imported in your code file: | ||
|
|
||
| {% tabs %} |
There was a problem hiding this comment.
Is the namespace section necessary here? The example seems self-explanatory, and adding a separate "import namespaces" block may not provide significant value. Consider removing it unless the sample requires explicit namespace guidance for compilation.
There was a problem hiding this comment.
Removed namespace
|
|
||
| ## AnnotationsLoaded event | ||
| The [AnnotationsLoaded](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.PdfViewer.SfPdfViewer.html#Syncfusion_Maui_PdfViewer_SfPdfViewer_AnnotationsLoaded) event occurs after all annotations in the PDF have finished loading, either when the document is opened or when annotations are imported. You can use this event to perform actions once annotations are fully available in the viewer. | ||
|
|
There was a problem hiding this comment.
Removed space
| --- | ||
|
|
||
| # Comments in .NET MAUI PDF Viewer (SfPdfViewer) | ||
|
|
There was a problem hiding this comment.
Remove the line gap.
There was a problem hiding this comment.
Removed line
|
|
||
| ## Comment panel | ||
| Annotation comments can be added to the PDF using the comment panel. Comment panel can be opened by using Built-in toolbar, In the toolbar you can see the comments button in the primary toolbar for desktop and top toolbar for mobile. The comment panel displays all annotations in the document along with their comments and replies, allowing you to add comments to any annotation and reply to existing comments or annotations. | ||
|
|
There was a problem hiding this comment.
Remove the empty line.
There was a problem hiding this comment.
Removed the line
|
|
||
| ## Adding comments or replies | ||
| Follow these steps to add comments or replies : | ||
|
|
There was a problem hiding this comment.
Remove the empty line.
There was a problem hiding this comment.
Removed the line
| ## Add comments or replies programmatically | ||
| These can add comments or replies to existing annotations programmatically by accessing the specific annotation from the Annotations collection. This allows you to enhance collaboration and provide feedback directly within the PDF. | ||
| The following example explains how to add comments or replies to specific annotations in the PDF document. | ||
|
|
There was a problem hiding this comment.
Remove the empty line.
There was a problem hiding this comment.
Removed the line
| Comments and replies can be edited through the context menu available under the More Options in the Comment Panel. Follow the steps below: | ||
| Select the annotation comment in the comment panel. | ||
| ## Editing comments and replies | ||
|
|
There was a problem hiding this comment.
Remove the empty line.
There was a problem hiding this comment.
Removed the line
| PDF Viewer allows users to obtain the PDF page coordinates relative to the PDF Viewer’s client coordinates and vice versa. It also allows you to obtain the scroll point relative to the PDF page coordinates and bring the given region into view. | ||
|
|
||
| To work with coordinate conversions, ensure the following namespaces are imported in your code file: | ||
|
|
There was a problem hiding this comment.
Is the namespace section necessary here? The example seems self-explanatory, and adding a separate "import namespaces" block may not provide significant value. Consider removing it unless the sample requires explicit namespace guidance for compilation.
There was a problem hiding this comment.
Removed namespace
|
|
||
| <ItemGroup> | ||
| <EmbeddedResource Include="Assets\PDF_Succinctly.pdf" /> | ||
| <EmbeddedResource Include="Assets/PDF_Succinctly.pdf" /> |
There was a problem hiding this comment.
Old seems to be right.
| * Unloading a document using [UnloadDocument](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.PdfViewer.SfPdfViewer.html#Syncfusion_Maui_PdfViewer_SfPdfViewer_UnloadDocument). Unloading clears the undo/redo history entirely. | ||
|
|
||
| N> The undo/redo stack is also cleared when a new document is loaded. | ||
| **Note:** The undo/redo stack is also cleared when a new document is loaded. |
There was a problem hiding this comment.
Previous code is right.
| To minimize this and provide a smoother scrolling experience, the SfPdfViewer control offers the `OverscanCount` property. This property defines how many pages should be pre-rendered and kept in memory on each side of the current viewport. Increasing this value reduces the chance of blank pages during fast scrolling but may increase memory usage. | ||
|
|
||
| The following example shows how to set `OverscanCount` property: | ||
| The following example shows how to set the `OverscanCount` property: |
There was a problem hiding this comment.
Attach the API link in all necessary places.
|
Build Status: INQUEUE 🕒 |
|
Build Status: INPROGRESS 🔃 |
Updated code examples for undo and redo commands in XAML and C#.
Removed code examples and namespace import instructions for comments panel.
Updated image paths in the Coordinates Conversion documentation to use backslashes instead of forward slashes.
Removed unnecessary code snippets and formatting for clarity.
Corrected a typographical error in the note about custom bookmarks.
Removed code snippet for importing namespace and adjusted note formatting.
Removed code snippets for importing namespaces and using SfPdfViewer in XAML.
Added code snippets for showing the comment panel in PDF Viewer.
Removed code usage examples for document load events in SfPdfViewer.
Removed code snippet for importing namespaces in C#.
Removed code usage examples for form field events in C# and XAML.
Removed code snippet and related information about namespaces and package requirements for form data import and export in .NET MAUI PDF Viewer.
Corrected formatting note regarding XFDF, FDF, JSON, and XML.
Removed code snippet for importing namespace in C#.
Removed code snippet for importing namespaces in Free Text annotations section.
184f7f0 to
584cb9f
Compare
|
Build Status: INPROGRESS 🔃 |
|
CI Status: FAILURE ❌ |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: SUCCESS ✅ |
UG Document correction using Code-Studio AI
Task Name: Need to improve UG documentation for .NET MAUI PDFViewer using code studio AI tools
Task link: https://dev.azure.com/EssentialStudio/Mobile%20and%20Desktop/_workitems/edit/1040346