replaceVariableByWordML

Only use this method if you really understand the OOXML standard. Javadocx does not validate the WordML against any scheme so you have to make sure by your own that the WordML is correctly encoded. Moreover, this method does not take care by its own of internal/external relationships included in the WordML code.

Parameters

variables

This must be a HashMap with the names of the placeholder template variables as keys and the WordML strings that should replace them as values.

options

Option	Type	Description
firstMatch	Boolean	If the variable appears more than once within the Word document and firstMatch is set to true, Javadocx will only replace the first ocurrence of the variable within the Word document.
target	String	Possible values are: document, header, footer, footnote, endnote, comment. This option sets the scope of the replacement procedure.
type	String	Possible values are: block (default): replaces the variable and removes its containing paragraph. inline: only replaces the variable by the WordFragment inline content (it may be used to replace a variable by formatted text).

Code samples

Example #1

package examples.Templates.replaceVariableByWordML;

import java.util.HashMap;

import com.javadocx.CreateDocxFromTemplate;

public class Sample1 {
    public static void main(String[] args) throws Exception {
        CreateDocxFromTemplate docx = new CreateDocxFromTemplate("src/examples/files/TemplateWordML.docx");

        // beware that this method does not take care of relationships and dependences so you have to make sure that the wordML is 'self-contained' we recommend to avoid this method unless one really knows the underlying OOXML standard
        String wordML = "<w:p><w:r><w:t xml:space=\"preserve\">This is a simple paragraph with some </w:t></w:r><w:r><w:rPr><w:b/></w:rPr><w:t>bold</w:t></w:r><w:r><w:t xml:space=\"preserve\"> text.</w:t></w:r></w:p>";
        
        HashMap<String, String> variables = new HashMap<String, String>();
        variables.put("WORDML", wordML);
        
        docx.replaceVariableByWordML(variables);
        
        docx.createDocx("example_replaceVariableByWordML_1");
    }
}

The resulting Word document looks like: