Adjded ability to auto import XFDF

Author: S0ulDrag0n

src/WebViewer.editorPreview.tsx

@@ -19,6 +19,7 @@ export class preview extends Component<WebViewerPreviewProps> {
             xfdfAttribute: this.props.xfdfAttribute,
             enableXfdfExportButton: this.props.enableXfdfExportButton,
             enableAutoXfdfExport: this.props.enableAutoXfdfExport,
+            enableAutoXfdfImport: this.props.enableAutoXfdfImport,
             loadAsPDF: this.props.loadAsPDF,
             highContrastMode: this.props.highContrastMode,
             notesInLeftPanel: this.props.notesInLeftPanel,

src/WebViewer.tsx

@@ -20,6 +20,7 @@ export default class WebViewer extends Component<WebViewerContainerProps> {
             xfdfAttribute: this.props.xfdfAttribute,
             enableXfdfExportButton: this.props.enableXfdfExportButton,
             enableAutoXfdfExport: this.props.enableAutoXfdfExport,
+            enableAutoXfdfImport: this.props.enableAutoXfdfImport,
             loadAsPDF: this.props.loadAsPDF,
             highContrastMode: this.props.highContrastMode,
             notesInLeftPanel: this.props.notesInLeftPanel,

src/WebViewer.xml

@@ -91,6 +91,10 @@
                     <caption>Enable Auto XFDF Export</caption>
                     <description>Enable automatic saving of the annotation XFDF when annotations change.</description>
                 </property>
+                <property key="enableAutoXfdfImport" type="boolean" defaultValue="false">
+                    <caption>Enable Auto XFDF Import</caption>
+                    <description>Enable automatic importing of the annotation XFDF when the document loads.</description>
+                </property>
             </propertyGroup>
         </propertyGroup>
         <propertyGroup caption="UI">

src/components/PDFViewer.tsx

@@ -16,6 +16,7 @@ export interface InputProps {
     xfdfAttribute?: any;
     enableXfdfExportButton: boolean;
     enableAutoXfdfExport: boolean;
+    enableAutoXfdfImport: boolean;
     loadAsPDF?: boolean;
     highContrastMode?: boolean;
     notesInLeftPanel?: boolean;
@@ -142,7 +143,15 @@ const PDFViewer: React.FC<InputProps> = props => {
                             "The XFDF attribute is read-only. Please check the user permissions or allow the data source to be editable."
                         );
                     } else {
-                        const updateXfdfAttribute = async (): Promise<void> => {
+                        const updateXfdfAttribute = async (
+                            _annotations: Event | any[],
+                            _action: string,
+                            info: any
+                        ): Promise<void> => {
+                            // Skip import events
+                            if (info && info.imported) {
+                                return;
+                            }
                             const doc = Core.documentViewer.getDocument();
                             if (!doc) {
                                 return;
@@ -180,6 +189,13 @@ const PDFViewer: React.FC<InputProps> = props => {
                     currentFileId = props.fileId;
                 }
             });
+
+            Core.documentViewer.setDocumentXFDFRetriever(async () => {
+                // Only auto import when we are loading from a file entity
+                if (currentFileId && props.enableAutoXfdfImport) {
+                    return props.xfdfAttribute.value;
+                }
+            });
         });
     }, [viewer]);
 

typings/WebViewerProps.d.ts

@@ -47,6 +47,7 @@ export interface WebViewerContainerProps {
     xfdfAttribute?: EditableValue<string>;
     enableXfdfExportButton: boolean;
     enableAutoXfdfExport: boolean;
+    enableAutoXfdfImport: boolean;
     isVisible?: EditableValue<boolean>;
     containerHeight: string;
     enableDarkMode: boolean;
@@ -81,6 +82,7 @@ export interface WebViewerPreviewProps {
     onExportXfdf: {} | null;
     enableXfdfExportButton: boolean;
     enableAutoXfdfExport: boolean;
+    enableAutoXfdfImport: boolean;
     isVisible: string;
     containerHeight: string;
     enableDarkMode: boolean;