replaceTableVariable

This has to be an ArraList of HashMap. The keys of the associative array should match the names of the variables that you want to replace by their corresponding values (text strings or WordFragments).

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 (default), header, footer. This option sets the scope of the replacement procedure.
parseLineBreaks	Boolean	If true (default is false) parses the line breaks to include them in the Word document.
type	String	inline (default) or block; used by WordFragment values.

Code samples

Example #1

package examples.Templates.replaceTableVariable;

import java.util.ArrayList;
import java.util.HashMap;

import com.javadocx.CreateDocxFromTemplate;
import com.javadocx.elements.OptionsReplaceTableVariable;

public class Sample1 {
    public static void main(String[] args) throws Exception {
        CreateDocxFromTemplate docx = new CreateDocxFromTemplate("src/examples/files/TemplateSimpleTable.docx");
        
        ArrayList<HashMap<String, ?>> items = new ArrayList<HashMap<String, ?>>();
        
        HashMap<String, String> itemRowA = new HashMap<String, String>();
        itemRowA.put("ITEM", "Product A");
        itemRowA.put("REFERENCE", "107AW3");
        
        HashMap<String, String> itemRowB = new HashMap<String, String>();
        itemRowB.put("ITEM", "Product B");
        itemRowB.put("REFERENCE", "204RS67O");
        
        HashMap<String, String> itemRowC = new HashMap<String, String>();
        itemRowC.put("ITEM", "Product C");
        itemRowC.put("REFERENCE", "25GTR56");
        
        items.add(itemRowA);
        items.add(itemRowB);
        items.add(itemRowC);
        
        OptionsReplaceTableVariable replaceTableVariableOptions = new OptionsReplaceTableVariable();
        replaceTableVariableOptions.setParseLineBreaks(true);
        
        docx.replaceTableVariable(items, replaceTableVariableOptions);
        
        docx.createDocx("example_replaceTableVariable_1");
    }
}

The resulting Word document looks like:

Example #2

package examples.Templates.replaceTableVariable;

import java.util.ArrayList;
import java.util.HashMap;

import com.javadocx.CreateDocxFromTemplate;
import com.javadocx.elements.OptionsReplaceTableVariable;

public class Sample2 {
    public static void main(String[] args) throws Exception {
        CreateDocxFromTemplate docx = new CreateDocxFromTemplate("src/examples/files/TemplateComplexTable.docx");
        
        docx.setTemplateSymbol("@");
        
        ArrayList<HashMap<String, ?>> items = new ArrayList<HashMap<String, ?>>();
        
        HashMap<String, String> itemRowA = new HashMap<String, String>();
        itemRowA.put("ITEM", "Product A");
        itemRowA.put("REFERENCE", "107AW3");
        itemRowA.put("PRICE", "5.45");
        
        HashMap<String, String> itemRowB = new HashMap<String, String>();
        itemRowB.put("ITEM", "Product B");
        itemRowB.put("REFERENCE", "204RS67O");
        itemRowB.put("PRICE", "30.12");
        
        HashMap<String, String> itemRowC = new HashMap<String, String>();
        itemRowC.put("ITEM", "Product C");
        itemRowC.put("REFERENCE", "25GTR56");
        itemRowC.put("PRICE", "7.00");
        
        items.add(itemRowA);
        items.add(itemRowB);
        items.add(itemRowC);
        
        OptionsReplaceTableVariable replaceTableVariableOptions = new OptionsReplaceTableVariable();
        replaceTableVariableOptions.setParseLineBreaks(true);
        
        docx.replaceTableVariable(items, replaceTableVariableOptions);
        
        docx.createDocx("example_replaceTableVariable_2");
    }
}

The resulting Word document looks like: