com.aspose.words

Class CommentDisplayMode

java.lang.Object

com.aspose.words.CommentDisplayMode

public class CommentDisplayMode
extends java.lang.Object

Specifies the rendering mode for document comments.

Examples:

Shows how to show comments when saving a document to a rendered format.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 builder.write("Hello world!");

 Comment comment = new Comment(doc, "John Doe", "J.D.", new Date());
 comment.setText("My comment.");
 builder.getCurrentParagraph().appendChild(comment);

 // ShowInAnnotations is only available in Pdf1.7 and Pdf1.5 formats.
 // In other formats, it will work similarly to Hide.
 doc.getLayoutOptions().setCommentDisplayMode(CommentDisplayMode.SHOW_IN_ANNOTATIONS);

 doc.save(getArtifactsDir() + "Document.ShowCommentsInAnnotations.pdf");

 // Note that it's required to rebuild the document page layout (via Document.UpdatePageLayout() method)
 // after changing the Document.LayoutOptions values.
 doc.getLayoutOptions().setCommentDisplayMode(CommentDisplayMode.SHOW_IN_BALLOONS);
 doc.updatePageLayout();

 doc.save(getArtifactsDir() + "Document.ShowCommentsInBalloons.pdf");
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	HIDE No document comments are rendered.
static int	length
static int	SHOW_IN_ANNOTATIONS Renders document comments in annotations.
static int	SHOW_IN_BALLOONS Renders document comments in balloons in the margin.

Method Summary

Modifier and Type	Method and Description
static int	fromName(java.lang.String commentDisplayModeName)
static java.lang.String	getName(int commentDisplayMode)
static int[]	getValues()
static java.lang.String	toString(int commentDisplayMode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HIDE

public static int HIDE

No document comments are rendered.

SHOW_IN_BALLOONS

public static int SHOW_IN_BALLOONS

Renders document comments in balloons in the margin. This is the default value.

SHOW_IN_ANNOTATIONS

public static int SHOW_IN_ANNOTATIONS

Renders document comments in annotations. This is only available for Pdf format.

length

public static int length

Method Detail

getName

public static java.lang.String getName(int commentDisplayMode)

toString

public static java.lang.String toString(int commentDisplayMode)

fromName

public static int fromName(java.lang.String commentDisplayModeName)

getValues

public static int[] getValues()