addComment

Option	Type	Description
textDocument	OptionsText	WordFragment that will appear in the Word document.
textComment	WordFragment	This is the content that will show up in the corresponding footnote.
initials	String	The initial that will be shown in the comment balloon.
author	String	The name of the author of the comments.
date	String	A date string as the ones used for the strtotime Java method.

Code samples

Example #1

package examples.Core.addComment;

import java.util.ArrayList;

import com.javadocx.CreateDocx;
import com.javadocx.WordFragment;
import com.javadocx.elements.OptionsComment;
import com.javadocx.elements.OptionsImage;
import com.javadocx.elements.OptionsText;

public class Sample1 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();
        
        OptionsText textCommentOptions = new OptionsText();
        textCommentOptions.setText("The comment we want to insert.");
        WordFragment textCommentFragment = new WordFragment(docx);
        textCommentFragment.addText(textCommentOptions);
        
        OptionsImage imageOptions = new OptionsImage();
        imageOptions.setImageAlign("center")
                    .setScaling(50)
                    .setTextWrap(0);
        
        textCommentFragment.addImage("src/examples/files/img/image.png", imageOptions);
        
        OptionsText textDocumentOptions = new OptionsText();
        textDocumentOptions.setText("comment");
        
        OptionsComment commenOptions = new OptionsComment();
        commenOptions.setTextDocument(textDocumentOptions)
                     .setTextComment(textCommentFragment)
                     .setInitials("PT")
                     .setAuthor("PHPDocX Team")
                     .setDate("2000-09-01\\T00:00:00\\Z");
        
        WordFragment commentFragment = new WordFragment(docx);
        commentFragment.addComment(commenOptions);
        
        OptionsText textOptions = new OptionsText();
        textOptions.setText("Here comes the ");
        WordFragment textFragment = new WordFragment(docx);
        textFragment.addText(textOptions);
        
        OptionsText textOptionsB = new OptionsText();
        textOptionsB.setText(" and some other text.");
        WordFragment textFragmentB = new WordFragment(docx);
        textFragmentB.addText(textOptionsB);
        
        ArrayList<WordFragment> textRuns = new ArrayList<WordFragment>();
        textRuns.add(textFragment);
        textRuns.add(commentFragment);
        textRuns.add(textFragmentB);
        
        docx.addText(textRuns);
        
        docx.createDocx("example_addComment_1");
    }
}

The resulting Word document looks like: