addBookmark

Option	Type	Description
type	String	The bookmark type. Possible values are "start" and "end".
name	String	The name that you want to give to the corresponding bookmark. This is the parameter that should be used within the addLink method to link to the bookmarked content.

Code samples

Example #1

package examples.Core.addBookmark;

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

public class Sample1 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();
        
        OptionsBookmark bookmarkOptionsStart = new OptionsBookmark();
        bookmarkOptionsStart.setType("start");
        bookmarkOptionsStart.setName("bookmark_name");
        docx.addBookmark(bookmarkOptionsStart);
        
        OptionsText textOptions = new OptionsText(); 
        textOptions.setText("Text that has been bookmarked.");
        docx.addText(textOptions);
        
        OptionsBookmark bookmarkOptionsEnd = new OptionsBookmark();
        bookmarkOptionsEnd.setType("end");
        bookmarkOptionsEnd.setName("bookmark_name");
        docx.addBookmark(bookmarkOptionsEnd);
        
        docx.createDocx("example_addBookmark_1");
    }
}

Example #2

package examples.Core.addBookmark;

import java.util.ArrayList;

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

public class Sample2 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();
        
        OptionsBookmark bookmarkOptionsStart = new OptionsBookmark();
        bookmarkOptionsStart.setType("start");
        bookmarkOptionsStart.setName("bookmark_name");
        WordFragment bookmarkStart = new WordFragment(docx);
        bookmarkStart.addBookmark(bookmarkOptionsStart);
        
        OptionsBookmark bookmarkOptionsEnd = new OptionsBookmark();
        bookmarkOptionsEnd.setType("end");
        bookmarkOptionsEnd.setName("bookmark_name");
        WordFragment bookmarkEnd = new WordFragment(docx);
        bookmarkEnd.addBookmark(bookmarkOptionsEnd);
        
        OptionsText textOptions = new OptionsText();
        textOptions.setText("We are only going to bookmark: ");
        WordFragment textFragment = new WordFragment(docx);
        textFragment.addText(textOptions);
        
        OptionsText textOptionsB = new OptionsText();
        textOptionsB.setText("this words.");
        WordFragment textFragmentB = new WordFragment(docx);
        textFragmentB.addText(textOptionsB);
        
        ArrayList<WordFragment> textRuns = new ArrayList<WordFragment>();
        textRuns.add(textFragment);
        textRuns.add(bookmarkStart);
        textRuns.add(textFragmentB);
        textRuns.add(bookmarkEnd);
        
        docx.addText(textRuns);
        
        docx.createDocx("example_addBookmark_2");
    }
}

The resulting Word document looks like: