addBackgroundImage

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

removeSection

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

stream

ENCRYPT

encryptPDF

addBackgroundImage

BASIC / ADVANCED / PREMIUM

Inserts a background image into the Word document.

Description

public void addBackgroundImage(String src) throws Exception

This method allows the insertion of a background image into a Word document.

The image can have the following extensions:

jpg or jpeg
png
gif

A background image does not behave exactly like a watermark but like a standard HTML background image: it tiles the entire background.

Parameters

Option	Type	Description
src	String	File path

Code samples

Example #1

package examples.LayoutAndGeneral.addBackgroundImage;

import com.javadocx.CreateDocx;

public class Sample1 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();
        
        docx.addBackgroundImage("image.jpg");

        docx.addText("Please, use a discrete background image so the text is easily readable.");
        docx.addText("This one is pretty annoying but it illustrates well the functionality :-)");
        
        docx.createDocx("example_addBackgroundImage_1");
    }
}

The resulting Word document looks like: