addExternalFile

When inserting a DOCX document, it is recommended that the page layout of the inserted DOCX coincides with the one of the Word document you are generating with Javadocx, if not you may expect certain formatting problems.

This method is only compatible with MS Word.

Parameters

options

An array with the available options.

The possible keys and values are (required options are shown with red background):

Option	Type	Description
src	String	The path to the document that you want to insert within our current Word document.
matchSource	Boolean	If true (default value), it tries to preserve as much as possible the styles of the DOCX to be included.

Code samples

Example #1

package examples.Core.addExternalFile;

import com.javadocx.CreateDocx;
import com.javadocx.elements.OptionsExternalFile;
import com.javadocx.elements.OptionsText;

public class Sample1 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();
        
        OptionsText textElement = new OptionsText(); 
        textElement.setText("We are going to insert now a full Word document. Beware that this method is not compatible with legacy versions of Word running the docx compatibility pack.");
        docx.addText(textElement);
        
        OptionsExternalFile externalFileElement = new OptionsExternalFile();
        externalFileElement.setSrc("src/examples/files/Text.docx");
        docx.addExternalFile(externalFileElement);
        
        textElement = new OptionsText(); 
        textElement.setText("A new paragraph.");
        docx.addText(textElement);
        
        docx.createDocx("example_addDOCX_1");
    }
}

The resulting Word document looks like: