Add Hyperlinks to Word document in Java

Adding hyperlinks to a Microsoft Word document can help readers to easily jump from the link to a different place, for example, to a place in the current document, to a different file or website, or to a new email message.

This article demonstrates how to add web link, email link, file link and image hyperlink to a Word document using Free Spire.Doc for Java library.

Before start with coding, you need to Download Free Spire.Doc for Java package, unzip it and import Spire.Doc.jar file from the lib folder in your project as a denpendency.

Example Code

import com.spire.doc.*;

import com.spire.doc.documents.*;

import com.spire.doc.fields.DocPicture;

public class InsertHyperlink {

    public static void main(String[] args) {

        //create a Word document

        Document doc = new Document();

        Section section = doc.addSection();

        //insert web link

        Paragraph paragraph = section.addParagraph();

        paragraph.appendText("Web Link: ");

        paragraph.appendHyperlink("https://www.yourcompany.com/","Home Page", HyperlinkType.Web_Link);

        //insert email link

        paragraph = section.addParagraph();

        paragraph.appendText("Email Link: ");

        paragraph.appendHyperlink("mailto:support@yourcompany.com","support@yourcompany.com", HyperlinkType.E_Mail_Link);

        //insert file link

        paragraph = section.addParagraph();

        paragraph.appendText("File Link: ");

        paragraph.appendHyperlink("C:\\Users\\Administrator\\Desktop\\Report.xlsx","Click to open Report.xlsx", HyperlinkType.File_Link);

        //insert image hyperlink

        paragraph = section.addParagraph();

        paragraph.appendText("Image Hyper Link: ");

        paragraph = section.addParagraph();

        DocPicture picture = paragraph.appendPicture("logo.png");

        paragraph.appendHyperlink("https://www.yourcompany.com/",picture, HyperlinkType.Web_Link);

        for (int i = 0; i < section.getParagraphs().getCount(); i++) {

            //align paragraph to center

            section.getParagraphs().get(i).getFormat().setHorizontalAlignment(HorizontalAlignment.Center);

            //add auto spacing after paragraph

            section.getParagraphs().get(i).getFormat().setAfterAutoSpacing(true);

        }

        //save to file

        doc.saveToFile("InsertHyperlinks.docx", FileFormat.Docx_2013);

    }

}