How to Auto Save Document in React DOCX Editor

27 Aug 20266 minutes to read

In this article, we are going to see how to auto save the document in AWS S3. You can automatically save the edited content at regular intervals of time. It helps reduce the risk of data loss by saving an open document automatically at customized intervals.

The following example illustrates how to auto save the document in AWS S3.

  • In the client-side, using the content change event, we can automatically save the edited content at regular intervals of time. Based on the contentChanged boolean, the document is sent as DOCX format to the server-side using the saveAsBlob method.

         import * as ReactDOM from 'react-dom';
         import * as React from 'react';
         import { DocumentEditorContainerComponent,
         Toolbar,
      }  from '@syncfusion/ej2-react-documenteditor';
    
    DocumentEditorContainerComponent.Inject(Toolbar);
    function App() {
    let container: DocumentEditorContainerComponent;
    let contentChanged: boolean = false;
    React.useEffect(() => {
      onCreate()
      onContentChange()
    }, []);
    function onCreate() {
      setInterval(() => {
        if (contentChanged) {
          //You can save the document as below
          container.documentEditor.saveAsBlob('Docx').then((blob: Blob) => {
            console.log('Saved successfully');
            let exportedDocument: Blob = blob;
            //Now, save the document where ever you want.
            let formData: FormData = new FormData();
            formData.append('fileName', 'sample.docx');
            formData.append('data', exportedDocument);
            /* tslint:disable */
            var req = new XMLHttpRequest();
            // Replace your running Url here
            req.open(
              'POST',
              'http://localhost:62869/api/documenteditor/SaveToS3',
              true
            );
            req.onreadystatechange = () => {
              if (req.readyState === 4) {
                if (req.status === 200 || req.status === 304) {
                  console.log('Saved successfully');
                }
              }
            };
            req.send(formData);
          });
          contentChanged = false;
        }
      }, 1000);
    }
    
    function onContentChange() {
      contentChanged = true;
    }
    return (
      <DocumentEditorContainerComponent
        id="container"
        ref={(scope) => {
          container = scope;
        }}
        height={'590px'}
        serviceUrl="https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/"
        enableToolbar={true} created={onCreate} contentChange={onContentChange}
      />
     );
    }
    export default App;
    ReactDOM.render(<App />, document.getElementById('sample'));

The Web API hosted link https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/ utilized in the DOCX Editor’s serviceUrl property is intended solely for demonstration and evaluation purposes. For production deployment, please host your own web service with your required server configurations. You can refer and reuse the GitHub Web Service example or Docker image for hosting your own web service and use for the serviceUrl property.

  • In the server-side, configure the access key and secret key in the web.config file and register the profile in startup.cs.

    In web.config, add a key in the following format:

     <appSettings>
      <add key="AWSProfileName" value="sync_development" />
      <add key="AWSAccessKey" value="" />
      <add key="AWSSecretKey" value="" />
     </appSettings>

In startup.cs, register the profile in the following format:

   Amazon.Util.ProfileManager.RegisterProfile("sync_development","", "");
  • In the server-side, receive the stream content from the client-side and process it to save the document in AWS S3. Add a Web API in the controller file like below to save the document in AWS S3.

    [AcceptVerbs("Post")]
    [HttpPost]
    [EnableCors("AllowAllOrigins")]
    [Route("SaveToS3")]
     public string SaveToS3()
    {
      IFormFile file = HttpContext.Request.Form.Files[0];
      Stream stream = new MemoryStream();
      file.CopyTo(stream);
      UploadFileStreamToS3(stream, "documenteditor", "", "GettingStarted.docx");
      stream.Close();
      return "Sucess";
    }
    
    public bool UploadFileStreamToS3(System.IO.Stream localFilePath, string bucketName, string subDirectoryInBucket, string fileNameInS3)
    {
      AWSCredentials credentials = new StoredProfileAWSCredentials("sync_development");
      IAmazonS3 client = new AmazonS3Client(credentials, Amazon.RegionEndpoint.USEast1);
      TransferUtility utility = new TransferUtility(client);
      TransferUtilityUploadRequest request = new TransferUtilityUploadRequest();
    
      if (subDirectoryInBucket == "" || subDirectoryInBucket == null)
      {
        request.BucketName = bucketName; //no subdirectory just bucket name  
      }
      else
      {   // subdirectory and bucket name  
        request.BucketName = bucketName + @"/" + subDirectoryInBucket;
      }
      request.Key = fileNameInS3; //file name up in S3  
      request.InputStream = localFilePath;
      utility.Upload(request); //commencing the transfer
    
      return true; //indicate that the file was sent  
    }

Get the complete working sample in this link.