Convert word to PDF with bookmarks navigation panel

philipru · September 20, 2023, 8:51am

Hi, I read in other posts that to convert word to PDF with a bookmarks navigation panel I need to set PdfSaveOptions.BookmarksOutlineLevel . How do I do this with the java cloud API, for example:

ApiClient apiClient = new ApiClient(/*clientId*/ "####-####-####-####-####", /*clientSecret*/ "##################", null);
WordsApi wordsApi = new WordsApi(apiClient);
byte[] requestDocument = Files.readAllBytes(Paths.get("Sample.docx").toAbsolutePath());
ConvertDocumentRequest convertRequest = new ConvertDocumentRequest(requestDocument, "pdf", null, null, null, null, null, null, null);
wordsApi.convertDocument(convertRequest);

Is it also possible to generate a TOC (table of contents) by updating the TOC field in word programatically via the cloud API prior to generating the PDF?

Thank you
Philip

tilal.ahmad · September 20, 2023, 5:17pm

@philipru

First, you need to add TOC to the Word document using the feildCode parameter value {TOC} with InsertField API method and later convert it using the SaveAs API method. Please check the Java Unit Tests for reference. Please feel free to contact us for any further assistance.

Insert Field Online in Java

github.com

aspose-words-cloud/aspose-words-cloud-java/blob/master/src/test/java/com/aspose/words/cloud/api/field/TestField.java#L263


      
              );
          
              FieldResponse result = TestInitializer.wordsApi.insertField(request);
              assertNotNull(result);
              assertNotNull(result.getField());
              assertEquals("{ NUMPAGES }", result.getField().getFieldCode());
              assertEquals("0.0.0.1", result.getField().getNodeId());
          }
          
          /*
           * Test for putting field online.
           */
          @Test
          public void testInsertFieldOnline() throws ApiException, MessagingException, IOException
          {
              byte[] requestDocument = Files.readAllBytes(Paths.get(TestInitializer.LocalTestFolder, fieldFolder + "/GetField.docx").toAbsolutePath());
              FieldInsert requestField = new FieldInsert();
              requestField.setFieldCode("{ NUMPAGES }");
          
              InsertFieldOnlineRequest request = new InsertFieldOnlineRequest(
                  requestDocument,

Convert a Document to another Format Online with Detailed Settings in Java

github.com

aspose-words-cloud/aspose-words-cloud-java/blob/master/src/test/java/com/aspose/words/cloud/api/document/TestConvertDocument.java#L95


      
              SaveResponse result = TestInitializer.wordsApi.saveAs(request);
              assertNotNull(result);
              assertNotNull(result.getSaveResult());
              assertNotNull(result.getSaveResult().getDestDocument());
          }
          
          /*
           * Test for converting document online to one of the available formats.
           */
          @Test
          public void testSaveAsOnline() throws ApiException, MessagingException, IOException
          {
              String localName = "test_multi_pages.docx";
          
              byte[] requestDocument = Files.readAllBytes(Paths.get(TestInitializer.LocalTestFolder, "Common/" + localName).toAbsolutePath());
              PdfSaveOptionsData requestSaveOptionsData = new PdfSaveOptionsData();
              requestSaveOptionsData.setFileName(TestInitializer.RemoteTestOut + "/TestSaveAs.pdf");
          
              SaveAsOnlineRequest request = new SaveAsOnlineRequest(
                  requestDocument,
                  requestSaveOptionsData,

philipru · September 22, 2023, 6:21am

Thanks for the information and examples. However, I don’t want to insert a TOC field as I already have it in the DOCX in the correct location. I just want to update it so it has the correct headings/page numbers before generating the PDF.

Many thanks
Philip

tilal.ahmad · September 22, 2023, 8:45am

@philipru

To update the existing fields in the document, you can use the UpdateFields API method as following.

github.com

aspose-words-cloud/aspose-words-cloud-java/blob/master/src/test/java/com/aspose/words/cloud/api/field/TestField.java#L782


      
              DocumentResponse result = TestInitializer.wordsApi.updateFields(request);
              assertNotNull(result);
              assertNotNull(result.getDocument());
              assertEquals("TestUpdateDocumentFields.docx", result.getDocument().getFileName());
          }
          
          /*
           * Test for posting updated fields online.
           */
          @Test
          public void testUpdateDocumentFieldsOnline() throws ApiException, MessagingException, IOException
          {
              String localFile = "Common/test_multi_pages.docx";
          
              byte[] requestDocument = Files.readAllBytes(Paths.get(TestInitializer.LocalTestFolder, localFile).toAbsolutePath());
              UpdateFieldsOnlineRequest request = new UpdateFieldsOnlineRequest(
                  requestDocument,
                  null,
                  null,
                  null,
                  null

philipru · October 16, 2023, 5:03am

Thanks! That worked.

tilal.ahmad · October 17, 2023, 4:34am

3 posts were split to a new topic: Bibliography field update issue in MS Word document