addTextBox

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

removeSection

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

stream

ENCRYPT

encryptPDF

addTextBox

BASIC / ADVANCED / PREMIUM

Inserts text boxes into the Word document.

Description

public void addTextBox(String text) throws Exception

public void addTextBox(OptionsText textParams) throws Exception

public void addTextBox(String text, OptionsTextBox options) throws Exception

public void addTextBox(OptionsText textOptions, OptionsTextBox options) throws Exception

public void addTextBox(WordFragment content) throws Exception

public void addTextBox(WordFragment content, OptionsTextBox options) throws Exception

This method allows the insertion of a text box into your Word document.

Parameters

options

Option	Type	Description
align	String	center, left, right.
border	Boolean	Border.
borderColor	String	Hexadecimal value (#ff0000, #0000ff).
borderWidth	Double	Value in points.
contentVerticalAlign	String	top (default), center or bottom.
fillColor	String	Hexadecimal value (#ff0000, #0000ff).
height	Double	Height in points or 'auto'.
textWrap	String	tight, square, through, none.
paddingBottom	Double	Distance in cm.
paddingLeft	Double	Distance in mm.
paddingRight	Double	Distance in mm.
paddingTop	Double	Distance in mm.
width	Double	Width in points.

Code samples

Example #1

package examples.Core.addTextBox;

import com.javadocx.CreateDocx;
import com.javadocx.elements.*;

public class Sample1 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();
        
        String text = "Some text content for the textbox. 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.";
        
        OptionsTextBox textBoxOptions = new OptionsTextBox();
        textBoxOptions.setAlign("right")
                      .setPaddingLeft(10.0)
                      .setBorderColor("#b70000")
                      .setBorderWidth(4.0)
                      .setFillColor("#dddddd")
                      .setWidth(240.0);
        
        docx.addTextBox(text, textBoxOptions);
        
        docx.createDocx("example_addTextBox_1");
    }
}

The resulting Word document looks like: