insertWordFragment
- addBackgroundImage
- addFooter
- addHeader
- addLineNumbering
- addPageBorders
- addProperties
- addSection
- createDocx
- createCharacterStyle
- createListStyle
- createParagraphStyle
- createTableStyle
- docxSettings
- embedFont
- importHeadersAndFooters
- importListStyle
- importStyles
- modifyPageLayout
- removeFooters
- removeHeaders
- setBackgroundColor
- setDefaultFont
- setDocumentDefaultStyles
- setEncodeUTF8
- setLanguage
- setMarkAsFinal
- setRTL
- addBibliography
- addBookmark
- addBreak
- addChart
- addCitation
- addComment
- addCrossReference
- addDateAndHour
- addEndnote
- addExternalFile
- addFootnote
- addFormElement
- addHeading
- addImage
- addLink
- addList
- addMathEquation
- addMergeField
- addOLE
- addPageNumber
- addShape
- addSimpleField
- addSource
- addStructuredDocumentTag
- addSVG
- addTab
- addTable
- addTableContents
- addText
- addTextBox
- addWordML
- embedHTML
- clearBlocks
- deleteTemplateBlock
- getTemplateVariables
- getTemplateVariablesType
- modifyInputFields
- modifyMergeFields
- processTemplate
- removeTemplateVariable
- replaceListVariable
- replacePlaceholderImage
- replaceTableVariable
- replaceVariableByExternalFile
- replaceVariableByHtml
- replaceVariableByText
- replaceVariableByWordFragment
- replaceVariableByWordML
- setTemplateSymbol
- tickCheckbox
insertWordFragment


Inserts elements in the document.
Description
public void insertWordFragment(WordFragment wordFragment, OptionsDOCXPath referenceNode)
public void insertWordFragment(WordFragment wordFragment, OptionsDOCXPath referenceNode, Boolean forceAppend)
Parameters
wordFragment
WordFragment to be inserted.
referenceNode
Option | Type | Description |
---|---|---|
type | String | * (all, default value), break, chart, endnote (content reference, the whole paragraph is removed), footnote (content reference, the whole paragraph is removed), image, list, paragraph (also for bookmarks, links and lists), section, shape, table. |
contains | String | Contains a text string. |
occurrence | String | Exact occurrence or range of contents (e.g.: 2..9, 2.., ..9) or first() or last(). If empty iterate all elements. |
attributes | HashMap<String, String> | Contains a specific attribute key and value. |
parent | String | Main document body as default, allows to set any parent or a specific one. w:body (default), '/' (any parent) or any other specific parent (/w:tbl/, /w:tc/, /w:r/...). |
customQuery | String | Custom xpath query, overwrites any other reference. |
location | String | after (default) or default. |
forceAppend
If true appends the WordFragment if the reference node could not be found (false as default).
Code samples
Example #1
x
1
package examples.DOCXPath.insertWordFragment;
2
3
import com.javadocx.CreateDocx;
4
import com.javadocx.WordFragment;
5
import com.javadocx.elements.OptionsDOCXPath;
6
import com.javadocx.elements.OptionsParagraph;
7
import com.javadocx.elements.OptionsText;
8
9
public class Sample1 {
10
public static void main(String[] args) throws Exception {
11
CreateDocx docx = new CreateDocx();
12
13
String text = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi utaliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.";
14
15
OptionsParagraph paragraphOptions = new OptionsParagraph();
16
paragraphOptions.setBold(true)
17
.setFont("Arial");
18
19
docx.addText(text, paragraphOptions);
20
21
docx.addText(text, paragraphOptions);
22
23
OptionsText textOptions = new OptionsText();
24
textOptions.setText(" New text.")
25
.setFontSize(20)
26
.setColor("#0000ff");
27
WordFragment textFragment = new WordFragment(docx);
28
textFragment.addText(textOptions);
29
30
OptionsDOCXPath referenceNode = new OptionsDOCXPath();
31
referenceNode.setType("paragraph")
32
.setOccurrence("1")
33
.setContains("Lorem")
34
.setLocation("inlineAfter");
35
36
docx.insertWordFragment(textFragment, referenceNode);
37
38
docx.createDocx("example_insertWordFragment_1");
39
}
40
}
41
Example #2
75
1
package examples.DOCXPath.insertWordFragment;
2
3
import java.util.ArrayList;
4
import java.util.HashMap;
5
6
import com.javadocx.CreateDocxFromTemplate;
7
import com.javadocx.WordFragment;
8
import com.javadocx.elements.OptionsDOCXPath;
9
import com.javadocx.elements.OptionsTableData;
10
import com.javadocx.elements.OptionsTableProperties;
11
12
public class Sample2 {
13
public static void main(String[] args) throws Exception {
14
CreateDocxFromTemplate docx = new CreateDocxFromTemplate("src/examples/files/docxpath/breaks.docx");
15
16
WordFragment contentFragment = new WordFragment(docx);
17
18
contentFragment.addText("New text");
19
20
ArrayList<OptionsTableData> valuesRow1 = new ArrayList<OptionsTableData>();
21
22
OptionsTableData valuesRow1Cell1 = new OptionsTableData();
23
WordFragment textFragmentRow1Cell1 = new WordFragment(docx);
24
textFragmentRow1Cell1.addText("AAA");
25
valuesRow1Cell1.setValue(textFragmentRow1Cell1);
26
27
OptionsTableData valuesRow1Cell2 = new OptionsTableData();
28
WordFragment textFragmentRow1Cell2 = new WordFragment(docx);
29
textFragmentRow1Cell2.addText("BBB");
30
valuesRow1Cell2.setValue(textFragmentRow1Cell2);
31
32
valuesRow1.add(valuesRow1Cell1);
33
valuesRow1.add(valuesRow1Cell2);
34
35
ArrayList<OptionsTableData> valuesRow2 = new ArrayList<OptionsTableData>();
36
37
OptionsTableData valuesRow2Cell1 = new OptionsTableData();
38
WordFragment textFragmentRow2Cell1 = new WordFragment(docx);
39
textFragmentRow2Cell1.addText("Text");
40
valuesRow2Cell1.setValue(textFragmentRow2Cell1);
41
42
OptionsTableData valuesRow2Cell2 = new OptionsTableData();
43
WordFragment textFragmentRow2Cell2 = new WordFragment(docx);
44
textFragmentRow2Cell2.addText("Text: More text");
45
valuesRow2Cell2.setValue(textFragmentRow2Cell2);
46
47
valuesRow2.add(valuesRow2Cell1);
48
valuesRow2.add(valuesRow2Cell2);
49
50
ArrayList<ArrayList<OptionsTableData>> valuesTable = new ArrayList<ArrayList<OptionsTableData>>();
51
valuesTable.add(valuesRow1);
52
valuesTable.add(valuesRow2);
53
54
OptionsTableProperties tableProperties = new OptionsTableProperties();
55
tableProperties.setBorder("single")
56
.setTableAlign("center")
57
.setBorderWidth(10)
58
.setBorderColor("B70000");
59
60
contentFragment.addTable(valuesTable, tableProperties);
61
62
HashMap<String, String> attributes = new HashMap<String, String>();
63
attributes.put("w:type", "page");
64
65
OptionsDOCXPath referenceNode = new OptionsDOCXPath();
66
referenceNode.setType("break")
67
.setAttributes(attributes)
68
.setLocation("after");
69
70
docx.insertWordFragment(contentFragment, referenceNode);
71
72
docx.createDocx("example_insertWordFragment_2");
73
}
74
}
75