replaceVariableByWordFragment

This method offers you complete control over the contents of the generated Word document. Moreover it is fully compatible with the PDF conversion plugin.

The Word fragments should be instances of the WordFragment class.

Parameters

variables

This must be a HashMap with the names of the placeholder template variables as keys and the WordFragment instances 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 (default), 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.replaceVariableByWordFragment;

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

import com.javadocx.CreateDocxFromTemplate;
import com.javadocx.WordFragment;
import com.javadocx.elements.*;

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

        WordFragment wf = new WordFragment(docx, "document");
        
        OptionsImage imageOptions = new OptionsImage();
        imageOptions.setScaling(50)
                    .setFloatImage("right")
                    .setTextWrap(1);
        WordFragment imageFragment = new WordFragment(docx);
        imageFragment.addImage("src/examples/files/img/image.png", imageOptions);
        
        OptionsLink linkOptions = new OptionsLink();
        linkOptions.setUrl("http://www.google.es")
                   .setColor("0000FF")
                   .setUnderline("single");
        WordFragment linkFragment = new WordFragment(docx);
        linkFragment.addLink("link to Google", linkOptions);
        
        OptionsText textFootnote = new OptionsText();
        textFootnote.setText("This is the footnote text.");
        WordFragment textFootnoteFragment = new WordFragment(docx);
        textFootnoteFragment.addText(textFootnote);
        OptionsFootnote footnoteOptions = new OptionsFootnote();
        footnoteOptions.setTextDocument("here it is")
                       .setTextFootnote(textFootnoteFragment);
        WordFragment footnoteFragment = new WordFragment(docx);
        footnoteFragment.addFootnote(footnoteOptions);
        
        OptionsText textOptionsA = new OptionsText();
        textOptionsA.setText("I am going to write a link: ")
                    .setBold(true);
        WordFragment textFragmentA = new WordFragment(docx);
        textFragmentA.addText(textOptionsA);
        
        OptionsText textOptionsB = new OptionsText();
        textOptionsB.setText(" to illustrate how to include links. ");
        WordFragment textFragmentB = new WordFragment(docx);
        textFragmentB.addText(textOptionsB);
        
        OptionsText textOptionsC = new OptionsText();
        textOptionsC.setText(" As you may see is extremely simple to do so and it can be done with any other Word element. For example to include  a footnote is also as simple as this: ");
        WordFragment textFragmentC = new WordFragment(docx);
        textFragmentC.addText(textOptionsC);
        
        OptionsText textOptionsD = new OptionsText();
        textOptionsD.setText(" , as you may check there is a footnote at the bottom of the page. ")
                    .setColor("B70000");
        WordFragment textFragmentD = new WordFragment(docx);
        textFragmentD.addText(textOptionsD);
        
        ArrayList<WordFragment> runs = new ArrayList<WordFragment>();
        runs.add(imageFragment);
        runs.add(textFragmentA);
        runs.add(linkFragment);
        runs.add(textFragmentB);
        runs.add(textFragmentC);
        runs.add(footnoteFragment);
        runs.add(textFragmentD);

        wf.addText(runs);
        
        OptionsReplaceVariableByWordFragment replaceVariableByWordFragmentOptions = new OptionsReplaceVariableByWordFragment();
        replaceVariableByWordFragmentOptions.setType("block");
        
        HashMap<String, WordFragment> variables = new HashMap<String, WordFragment>();
        variables.put("WORDFRAGMENT", wf);
        
        docx.replaceVariableByWordFragment(variables, replaceVariableByWordFragmentOptions);
        
        docx.createDocx("example_replaceVariableByWordFragment_1");
    }
}

The resulting Word document looks like:

Example #2

package examples.Templates.replaceVariableByWordFragment;

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

import com.javadocx.CreateDocxFromTemplate;
import com.javadocx.WordFragment;
import com.javadocx.elements.*;

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

        WordFragment wf = new WordFragment(docx, "footnote");
        
        OptionsImage imageOptions = new OptionsImage();
        imageOptions.setScaling(10);
        WordFragment imageFragment = new WordFragment(docx, "footnote");
        imageFragment.addImage("src/examples/files/img/image.png", imageOptions);
        
        OptionsLink linkOptions = new OptionsLink();
        linkOptions.setUrl("http://www.google.es")
                   .setColor("0000FF")
                   .setUnderline("single");
        WordFragment linkFragment = new WordFragment(docx);
        linkFragment.addLink("link to Google", linkOptions);
        
        OptionsText textOptionsA = new OptionsText();
        textOptionsA.setText("I am going to write a link: ")
                    .setBold(true);
        WordFragment textFragmentA = new WordFragment(docx);
        textFragmentA.addText(textOptionsA);
        
        OptionsText textOptionsB = new OptionsText();
        textOptionsB.setText(" to illustrate how to include links in a footnote. ");
        WordFragment textFragmentB = new WordFragment(docx);
        textFragmentB.addText(textOptionsB);
        
        OptionsText textOptionsC = new OptionsText();
        textOptionsC.setText(" As you may see it is extremely simple to do so and can be done with any other Word element.");
        WordFragment textFragmentC = new WordFragment(docx);
        textFragmentC.addText(textOptionsC);
        
        ArrayList<WordFragment> runs = new ArrayList<WordFragment>();
        runs.add(imageFragment);
        runs.add(textFragmentA);
        runs.add(linkFragment);
        runs.add(textFragmentB);
        runs.add(textFragmentC);

        wf.addText(runs);
        
        OptionsReplaceVariableByWordFragment replaceVariableByWordFragmentOptions = new OptionsReplaceVariableByWordFragment();
        replaceVariableByWordFragmentOptions.setType("inline")
                                            .setTarget("footnote");
        
        HashMap<String, WordFragment> variables = new HashMap<String, WordFragment>();
        variables.put("INLINEFRAGMENT", wf);
        
        docx.replaceVariableByWordFragment(variables, replaceVariableByWordFragmentOptions);
        
        docx.createDocx("example_replaceVariableByWordFragment_2");
    }
}

The resulting Word document looks like: