RevisionOptions

com.aspose.words
Class RevisionOptions

java.lang.Object
    com.aspose.words.RevisionOptions

All Implemented Interfaces:: java.lang.Cloneable

public class RevisionOptions
extends java.lang.Object
extends java.lang.Object

Allows to control how document revisions are handled during layout process.

To learn more, visit the Converting to Fixed-page Format documentation article.

Example:

Shows how to alter the appearance of revisions in a rendered output document.

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

// Insert a revision, then change the color of all revisions to green.
builder.writeln("This is not a revision.");
doc.startTrackRevisions("John Doe", new Date());
builder.writeln("This is a revision.");
doc.stopTrackRevisions();
builder.writeln("This is not a revision.");

// Remove the bar that appears to the left of every revised line.
doc.getLayoutOptions().getRevisionOptions().setInsertedTextColor(RevisionColor.BRIGHT_GREEN);
doc.getLayoutOptions().getRevisionOptions().setShowRevisionBars(false);
doc.getLayoutOptions().getRevisionOptions().setRevisionBarsPosition(HorizontalAlignment.RIGHT);

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

Property Getters/Setters Summary
`int`	`getCommentColor()`
`void`	`setCommentColor(int value)`
	Allows to specify the color to be used for comments. Default value is RevisionColor.RED. The value of the property is RevisionColor integer constant.
`int`	`getDeletedTextColor()`
`void`	`setDeletedTextColor(int value)`
	Allows to specify the color to be used for deleted content RevisionType.DELETION. Default value is RevisionColor.BY_AUTHOR. The value of the property is RevisionColor integer constant.
`int`	`getDeletedTextEffect()`
`void`	`setDeletedTextEffect(int value)`
	Allows to specify the effect to be applied to the deleted content RevisionType.DELETION. Default value is RevisionTextEffect.STRIKE_THROUGHThe value of the property is RevisionTextEffect integer constant.
`int`	`getInsertedTextColor()`
`void`	`setInsertedTextColor(int value)`
	Allows to specify the color to be used for inserted content RevisionType.INSERTION. Default value is RevisionColor.BY_AUTHOR. The value of the property is RevisionColor integer constant.
`int`	`getInsertedTextEffect()`
`void`	`setInsertedTextEffect(int value)`
	Allows to specify the effect to be applied to the inserted content RevisionType.INSERTION. Default value is RevisionTextEffect.UNDERLINE. The value of the property is RevisionTextEffect integer constant.
`int`	`getMeasurementUnit()`
`void`	`setMeasurementUnit(int value)`
	Allows to specify the measurement units for revision comments. Default value is MeasurementUnits.CENTIMETERSThe value of the property is MeasurementUnits integer constant.
`int`	`getMovedFromTextColor()`
`void`	`setMovedFromTextColor(int value)`
	Allows to specify the color to be used for areas where content was moved from RevisionType.MOVING. Default value is RevisionColor.BY_AUTHOR. The value of the property is RevisionColor integer constant.
`int`	`getMovedFromTextEffect()`
`void`	`setMovedFromTextEffect(int value)`
	Allows to specify the effect to be applied to the areas where content was moved from RevisionType.MOVING. Default value is RevisionTextEffect.DOUBLE_STRIKE_THROUGHThe value of the property is RevisionTextEffect integer constant.
`int`	`getMovedToTextColor()`
`void`	`setMovedToTextColor(int value)`
	Allows to specify the color to be used for areas where content was moved to RevisionType.MOVING. Default value is RevisionColor.BY_AUTHOR. The value of the property is RevisionColor integer constant.
`int`	`getMovedToTextEffect()`
`void`	`setMovedToTextEffect(int value)`
	Allows to specify the effect to be applied to the areas where content was moved to RevisionType.MOVING. Default value is RevisionTextEffect.DOUBLE_UNDERLINEThe value of the property is RevisionTextEffect integer constant.
`int`	`getRevisedPropertiesColor()`
`void`	`setRevisedPropertiesColor(int value)`
	Allows to specify the color to be used for content with changes of formatting properties RevisionType.FORMAT_CHANGE Default value is RevisionColor.NO_HIGHLIGHT. The value of the property is RevisionColor integer constant.
`int`	`getRevisedPropertiesEffect()`
`void`	`setRevisedPropertiesEffect(int value)`
	Allows to specify the effect for content areas with changes of formatting properties RevisionType.FORMAT_CHANGE Default value is RevisionTextEffect.NONEThe value of the property is RevisionTextEffect integer constant.
`int`	`getRevisionBarsColor()`
`void`	`setRevisionBarsColor(int value)`
	Allows to specify the color to be used for side bars that identify document lines containing revised information. Default value is RevisionColor.RED. The value of the property is RevisionColor integer constant.
`int`	`getRevisionBarsPosition()`
`void`	`setRevisionBarsPosition(int value)`
	Gets or sets rendering position of revision bars. Default value is HorizontalAlignment.OUTSIDE. The value of the property is HorizontalAlignment integer constant.
`float`	`getRevisionBarsWidth()`
`void`	`setRevisionBarsWidth(float value)`
	Gets or sets width of revision bars, points.
`int`	`getShowInBalloons()`
`void`	`setShowInBalloons(int value)`
	Allows to specify whether the revisions are rendered in the balloons. Default value is ShowInBalloons.NONE. The value of the property is ShowInBalloons integer constant.
`boolean`	`getShowOriginalRevision()`
`void`	`setShowOriginalRevision(boolean value)`
	Allows to specify whether the original text should be shown instead of revised one. Default value is `false`.
`boolean`	`getShowRevisionBars()`
`void`	`setShowRevisionBars(boolean value)`
	Allows to specify whether revision bars should be rendered near lines containing revised content. Default value is `true`.
`boolean`	`getShowRevisionMarks()`
`void`	`setShowRevisionMarks(boolean value)`
	Allow to specify whether revision text should be marked with special formatting markup. Default value is `true`.

Property Getters/Setters Detail

getCommentColor/setCommentColor
public int getCommentColor() / public void setCommentColor(int value)

Allows to specify the color to be used for comments. Default value is RevisionColor.RED. The value of the property is RevisionColor integer constant.

If set this property to RevisionColor.BY_AUTHOR or RevisionColor.NO_HIGHLIGHT values, as the result this property will be set to default color.

Example:

Shows how to modify the appearance of revisions.

Document doc = new Document(getMyDir() + "Revisions.docx");

// Get the RevisionOptions object that controls the appearance of revisions.
RevisionOptions revisionOptions = doc.getLayoutOptions().getRevisionOptions();

// Render insertion revisions in green and italic.
revisionOptions.setInsertedTextColor(RevisionColor.GREEN);
revisionOptions.setInsertedTextEffect(RevisionTextEffect.ITALIC);

// Render deletion revisions in red and bold.
revisionOptions.setDeletedTextColor(RevisionColor.RED);
revisionOptions.setDeletedTextEffect(RevisionTextEffect.BOLD);

// The same text will appear twice in a movement revision:
// once at the departure point and once at the arrival destination.
// Render the text at the moved-from revision yellow with a double strike through
// and double-underlined blue at the moved-to revision.
revisionOptions.setMovedFromTextColor(RevisionColor.YELLOW);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_STRIKE_THROUGH);
revisionOptions.setMovedToTextColor(RevisionColor.CLASSIC_BLUE);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_UNDERLINE);

// Render format revisions in dark red and bold.
revisionOptions.setRevisedPropertiesColor(RevisionColor.DARK_RED);
revisionOptions.setRevisedPropertiesEffect(RevisionTextEffect.BOLD);

// Place a thick dark blue bar on the left side of the page next to lines affected by revisions.
revisionOptions.setRevisionBarsColor(RevisionColor.DARK_BLUE);
revisionOptions.setRevisionBarsWidth(15.0f);

// Show revision marks and original text.
revisionOptions.setShowOriginalRevision(true);
revisionOptions.setShowRevisionMarks(true);

// Get movement, deletion, formatting revisions, and comments to show up in green balloons
// on the right side of the page.
revisionOptions.setShowInBalloons(ShowInBalloons.FORMAT);
revisionOptions.setCommentColor(RevisionColor.BRIGHT_GREEN);

// These features are only applicable to formats such as .pdf or .jpg.
doc.save(getArtifactsDir() + "Revision.RevisionOptions.pdf");

getDeletedTextColor/setDeletedTextColor
public int getDeletedTextColor() / public void setDeletedTextColor(int value)

Allows to specify the color to be used for deleted content RevisionType.DELETION. Default value is RevisionColor.BY_AUTHOR. The value of the property is RevisionColor integer constant.

Example:

Shows how to modify the appearance of revisions.

Document doc = new Document(getMyDir() + "Revisions.docx");

// Get the RevisionOptions object that controls the appearance of revisions.
RevisionOptions revisionOptions = doc.getLayoutOptions().getRevisionOptions();

// Render insertion revisions in green and italic.
revisionOptions.setInsertedTextColor(RevisionColor.GREEN);
revisionOptions.setInsertedTextEffect(RevisionTextEffect.ITALIC);

// Render deletion revisions in red and bold.
revisionOptions.setDeletedTextColor(RevisionColor.RED);
revisionOptions.setDeletedTextEffect(RevisionTextEffect.BOLD);

// The same text will appear twice in a movement revision:
// once at the departure point and once at the arrival destination.
// Render the text at the moved-from revision yellow with a double strike through
// and double-underlined blue at the moved-to revision.
revisionOptions.setMovedFromTextColor(RevisionColor.YELLOW);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_STRIKE_THROUGH);
revisionOptions.setMovedToTextColor(RevisionColor.CLASSIC_BLUE);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_UNDERLINE);

// Render format revisions in dark red and bold.
revisionOptions.setRevisedPropertiesColor(RevisionColor.DARK_RED);
revisionOptions.setRevisedPropertiesEffect(RevisionTextEffect.BOLD);

// Place a thick dark blue bar on the left side of the page next to lines affected by revisions.
revisionOptions.setRevisionBarsColor(RevisionColor.DARK_BLUE);
revisionOptions.setRevisionBarsWidth(15.0f);

// Show revision marks and original text.
revisionOptions.setShowOriginalRevision(true);
revisionOptions.setShowRevisionMarks(true);

// Get movement, deletion, formatting revisions, and comments to show up in green balloons
// on the right side of the page.
revisionOptions.setShowInBalloons(ShowInBalloons.FORMAT);
revisionOptions.setCommentColor(RevisionColor.BRIGHT_GREEN);

// These features are only applicable to formats such as .pdf or .jpg.
doc.save(getArtifactsDir() + "Revision.RevisionOptions.pdf");

getDeletedTextEffect/setDeletedTextEffect
public int getDeletedTextEffect() / public void setDeletedTextEffect(int value)

Allows to specify the effect to be applied to the deleted content RevisionType.DELETION. Default value is RevisionTextEffect.STRIKE_THROUGHThe value of the property is RevisionTextEffect integer constant.

Example:

Shows how to modify the appearance of revisions.

Document doc = new Document(getMyDir() + "Revisions.docx");

// Get the RevisionOptions object that controls the appearance of revisions.
RevisionOptions revisionOptions = doc.getLayoutOptions().getRevisionOptions();

// Render insertion revisions in green and italic.
revisionOptions.setInsertedTextColor(RevisionColor.GREEN);
revisionOptions.setInsertedTextEffect(RevisionTextEffect.ITALIC);

// Render deletion revisions in red and bold.
revisionOptions.setDeletedTextColor(RevisionColor.RED);
revisionOptions.setDeletedTextEffect(RevisionTextEffect.BOLD);

// The same text will appear twice in a movement revision:
// once at the departure point and once at the arrival destination.
// Render the text at the moved-from revision yellow with a double strike through
// and double-underlined blue at the moved-to revision.
revisionOptions.setMovedFromTextColor(RevisionColor.YELLOW);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_STRIKE_THROUGH);
revisionOptions.setMovedToTextColor(RevisionColor.CLASSIC_BLUE);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_UNDERLINE);

// Render format revisions in dark red and bold.
revisionOptions.setRevisedPropertiesColor(RevisionColor.DARK_RED);
revisionOptions.setRevisedPropertiesEffect(RevisionTextEffect.BOLD);

// Place a thick dark blue bar on the left side of the page next to lines affected by revisions.
revisionOptions.setRevisionBarsColor(RevisionColor.DARK_BLUE);
revisionOptions.setRevisionBarsWidth(15.0f);

// Show revision marks and original text.
revisionOptions.setShowOriginalRevision(true);
revisionOptions.setShowRevisionMarks(true);

// Get movement, deletion, formatting revisions, and comments to show up in green balloons
// on the right side of the page.
revisionOptions.setShowInBalloons(ShowInBalloons.FORMAT);
revisionOptions.setCommentColor(RevisionColor.BRIGHT_GREEN);

// These features are only applicable to formats such as .pdf or .jpg.
doc.save(getArtifactsDir() + "Revision.RevisionOptions.pdf");

getInsertedTextColor/setInsertedTextColor
public int getInsertedTextColor() / public void setInsertedTextColor(int value)

Allows to specify the color to be used for inserted content RevisionType.INSERTION. Default value is RevisionColor.BY_AUTHOR. The value of the property is RevisionColor integer constant.

Example:

Shows how to alter the appearance of revisions in a rendered output document.

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

// Insert a revision, then change the color of all revisions to green.
builder.writeln("This is not a revision.");
doc.startTrackRevisions("John Doe", new Date());
builder.writeln("This is a revision.");
doc.stopTrackRevisions();
builder.writeln("This is not a revision.");

// Remove the bar that appears to the left of every revised line.
doc.getLayoutOptions().getRevisionOptions().setInsertedTextColor(RevisionColor.BRIGHT_GREEN);
doc.getLayoutOptions().getRevisionOptions().setShowRevisionBars(false);
doc.getLayoutOptions().getRevisionOptions().setRevisionBarsPosition(HorizontalAlignment.RIGHT);

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

getInsertedTextEffect/setInsertedTextEffect
public int getInsertedTextEffect() / public void setInsertedTextEffect(int value)

Allows to specify the effect to be applied to the inserted content RevisionType.INSERTION. Default value is RevisionTextEffect.UNDERLINE. The value of the property is RevisionTextEffect integer constant.

Example:

Shows how to modify the appearance of revisions.

Document doc = new Document(getMyDir() + "Revisions.docx");

// Get the RevisionOptions object that controls the appearance of revisions.
RevisionOptions revisionOptions = doc.getLayoutOptions().getRevisionOptions();

// Render insertion revisions in green and italic.
revisionOptions.setInsertedTextColor(RevisionColor.GREEN);
revisionOptions.setInsertedTextEffect(RevisionTextEffect.ITALIC);

// Render deletion revisions in red and bold.
revisionOptions.setDeletedTextColor(RevisionColor.RED);
revisionOptions.setDeletedTextEffect(RevisionTextEffect.BOLD);

// The same text will appear twice in a movement revision:
// once at the departure point and once at the arrival destination.
// Render the text at the moved-from revision yellow with a double strike through
// and double-underlined blue at the moved-to revision.
revisionOptions.setMovedFromTextColor(RevisionColor.YELLOW);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_STRIKE_THROUGH);
revisionOptions.setMovedToTextColor(RevisionColor.CLASSIC_BLUE);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_UNDERLINE);

// Render format revisions in dark red and bold.
revisionOptions.setRevisedPropertiesColor(RevisionColor.DARK_RED);
revisionOptions.setRevisedPropertiesEffect(RevisionTextEffect.BOLD);

// Place a thick dark blue bar on the left side of the page next to lines affected by revisions.
revisionOptions.setRevisionBarsColor(RevisionColor.DARK_BLUE);
revisionOptions.setRevisionBarsWidth(15.0f);

// Show revision marks and original text.
revisionOptions.setShowOriginalRevision(true);
revisionOptions.setShowRevisionMarks(true);

// Get movement, deletion, formatting revisions, and comments to show up in green balloons
// on the right side of the page.
revisionOptions.setShowInBalloons(ShowInBalloons.FORMAT);
revisionOptions.setCommentColor(RevisionColor.BRIGHT_GREEN);

// These features are only applicable to formats such as .pdf or .jpg.
doc.save(getArtifactsDir() + "Revision.RevisionOptions.pdf");

getMeasurementUnit/setMeasurementUnit
public int getMeasurementUnit() / public void setMeasurementUnit(int value)

Allows to specify the measurement units for revision comments. Default value is MeasurementUnits.CENTIMETERSThe value of the property is MeasurementUnits integer constant.

Example:

Shows how to make a saved document conform to an older ODT schema.

Document doc = new Document(getMyDir() + "Rendering.docx");

OdtSaveOptions saveOptions = new OdtSaveOptions();
{
    saveOptions.setMeasureUnit(OdtSaveMeasureUnit.CENTIMETERS);
    saveOptions.isStrictSchema11(exportToOdt11Specs);
}

doc.save(getArtifactsDir() + "OdtSaveOptions.Odt11Schema.odt", saveOptions);

getMovedFromTextColor/setMovedFromTextColor
public int getMovedFromTextColor() / public void setMovedFromTextColor(int value)

Allows to specify the color to be used for areas where content was moved from RevisionType.MOVING. Default value is RevisionColor.BY_AUTHOR. The value of the property is RevisionColor integer constant.

Example:

Shows how to modify the appearance of revisions.

Document doc = new Document(getMyDir() + "Revisions.docx");

// Get the RevisionOptions object that controls the appearance of revisions.
RevisionOptions revisionOptions = doc.getLayoutOptions().getRevisionOptions();

// Render insertion revisions in green and italic.
revisionOptions.setInsertedTextColor(RevisionColor.GREEN);
revisionOptions.setInsertedTextEffect(RevisionTextEffect.ITALIC);

// Render deletion revisions in red and bold.
revisionOptions.setDeletedTextColor(RevisionColor.RED);
revisionOptions.setDeletedTextEffect(RevisionTextEffect.BOLD);

// The same text will appear twice in a movement revision:
// once at the departure point and once at the arrival destination.
// Render the text at the moved-from revision yellow with a double strike through
// and double-underlined blue at the moved-to revision.
revisionOptions.setMovedFromTextColor(RevisionColor.YELLOW);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_STRIKE_THROUGH);
revisionOptions.setMovedToTextColor(RevisionColor.CLASSIC_BLUE);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_UNDERLINE);

// Render format revisions in dark red and bold.
revisionOptions.setRevisedPropertiesColor(RevisionColor.DARK_RED);
revisionOptions.setRevisedPropertiesEffect(RevisionTextEffect.BOLD);

// Place a thick dark blue bar on the left side of the page next to lines affected by revisions.
revisionOptions.setRevisionBarsColor(RevisionColor.DARK_BLUE);
revisionOptions.setRevisionBarsWidth(15.0f);

// Show revision marks and original text.
revisionOptions.setShowOriginalRevision(true);
revisionOptions.setShowRevisionMarks(true);

// Get movement, deletion, formatting revisions, and comments to show up in green balloons
// on the right side of the page.
revisionOptions.setShowInBalloons(ShowInBalloons.FORMAT);
revisionOptions.setCommentColor(RevisionColor.BRIGHT_GREEN);

// These features are only applicable to formats such as .pdf or .jpg.
doc.save(getArtifactsDir() + "Revision.RevisionOptions.pdf");

getMovedFromTextEffect/setMovedFromTextEffect
public int getMovedFromTextEffect() / public void setMovedFromTextEffect(int value)

Allows to specify the effect to be applied to the areas where content was moved from RevisionType.MOVING. Default value is RevisionTextEffect.DOUBLE_STRIKE_THROUGHThe value of the property is RevisionTextEffect integer constant.

Example:

Shows how to modify the appearance of revisions.

Document doc = new Document(getMyDir() + "Revisions.docx");

// Get the RevisionOptions object that controls the appearance of revisions.
RevisionOptions revisionOptions = doc.getLayoutOptions().getRevisionOptions();

// Render insertion revisions in green and italic.
revisionOptions.setInsertedTextColor(RevisionColor.GREEN);
revisionOptions.setInsertedTextEffect(RevisionTextEffect.ITALIC);

// Render deletion revisions in red and bold.
revisionOptions.setDeletedTextColor(RevisionColor.RED);
revisionOptions.setDeletedTextEffect(RevisionTextEffect.BOLD);

// The same text will appear twice in a movement revision:
// once at the departure point and once at the arrival destination.
// Render the text at the moved-from revision yellow with a double strike through
// and double-underlined blue at the moved-to revision.
revisionOptions.setMovedFromTextColor(RevisionColor.YELLOW);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_STRIKE_THROUGH);
revisionOptions.setMovedToTextColor(RevisionColor.CLASSIC_BLUE);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_UNDERLINE);

// Render format revisions in dark red and bold.
revisionOptions.setRevisedPropertiesColor(RevisionColor.DARK_RED);
revisionOptions.setRevisedPropertiesEffect(RevisionTextEffect.BOLD);

// Place a thick dark blue bar on the left side of the page next to lines affected by revisions.
revisionOptions.setRevisionBarsColor(RevisionColor.DARK_BLUE);
revisionOptions.setRevisionBarsWidth(15.0f);

// Show revision marks and original text.
revisionOptions.setShowOriginalRevision(true);
revisionOptions.setShowRevisionMarks(true);

// Get movement, deletion, formatting revisions, and comments to show up in green balloons
// on the right side of the page.
revisionOptions.setShowInBalloons(ShowInBalloons.FORMAT);
revisionOptions.setCommentColor(RevisionColor.BRIGHT_GREEN);

// These features are only applicable to formats such as .pdf or .jpg.
doc.save(getArtifactsDir() + "Revision.RevisionOptions.pdf");

getMovedToTextColor/setMovedToTextColor
public int getMovedToTextColor() / public void setMovedToTextColor(int value)

Allows to specify the color to be used for areas where content was moved to RevisionType.MOVING. Default value is RevisionColor.BY_AUTHOR. The value of the property is RevisionColor integer constant.

Example:

Shows how to modify the appearance of revisions.

Document doc = new Document(getMyDir() + "Revisions.docx");

// Get the RevisionOptions object that controls the appearance of revisions.
RevisionOptions revisionOptions = doc.getLayoutOptions().getRevisionOptions();

// Render insertion revisions in green and italic.
revisionOptions.setInsertedTextColor(RevisionColor.GREEN);
revisionOptions.setInsertedTextEffect(RevisionTextEffect.ITALIC);

// Render deletion revisions in red and bold.
revisionOptions.setDeletedTextColor(RevisionColor.RED);
revisionOptions.setDeletedTextEffect(RevisionTextEffect.BOLD);

// The same text will appear twice in a movement revision:
// once at the departure point and once at the arrival destination.
// Render the text at the moved-from revision yellow with a double strike through
// and double-underlined blue at the moved-to revision.
revisionOptions.setMovedFromTextColor(RevisionColor.YELLOW);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_STRIKE_THROUGH);
revisionOptions.setMovedToTextColor(RevisionColor.CLASSIC_BLUE);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_UNDERLINE);

// Render format revisions in dark red and bold.
revisionOptions.setRevisedPropertiesColor(RevisionColor.DARK_RED);
revisionOptions.setRevisedPropertiesEffect(RevisionTextEffect.BOLD);

// Place a thick dark blue bar on the left side of the page next to lines affected by revisions.
revisionOptions.setRevisionBarsColor(RevisionColor.DARK_BLUE);
revisionOptions.setRevisionBarsWidth(15.0f);

// Show revision marks and original text.
revisionOptions.setShowOriginalRevision(true);
revisionOptions.setShowRevisionMarks(true);

// Get movement, deletion, formatting revisions, and comments to show up in green balloons
// on the right side of the page.
revisionOptions.setShowInBalloons(ShowInBalloons.FORMAT);
revisionOptions.setCommentColor(RevisionColor.BRIGHT_GREEN);

// These features are only applicable to formats such as .pdf or .jpg.
doc.save(getArtifactsDir() + "Revision.RevisionOptions.pdf");

getMovedToTextEffect/setMovedToTextEffect
public int getMovedToTextEffect() / public void setMovedToTextEffect(int value)

Allows to specify the effect to be applied to the areas where content was moved to RevisionType.MOVING. Default value is RevisionTextEffect.DOUBLE_UNDERLINEThe value of the property is RevisionTextEffect integer constant.

Example:

Shows how to modify the appearance of revisions.

Document doc = new Document(getMyDir() + "Revisions.docx");

// Get the RevisionOptions object that controls the appearance of revisions.
RevisionOptions revisionOptions = doc.getLayoutOptions().getRevisionOptions();

// Render insertion revisions in green and italic.
revisionOptions.setInsertedTextColor(RevisionColor.GREEN);
revisionOptions.setInsertedTextEffect(RevisionTextEffect.ITALIC);

// Render deletion revisions in red and bold.
revisionOptions.setDeletedTextColor(RevisionColor.RED);
revisionOptions.setDeletedTextEffect(RevisionTextEffect.BOLD);

// The same text will appear twice in a movement revision:
// once at the departure point and once at the arrival destination.
// Render the text at the moved-from revision yellow with a double strike through
// and double-underlined blue at the moved-to revision.
revisionOptions.setMovedFromTextColor(RevisionColor.YELLOW);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_STRIKE_THROUGH);
revisionOptions.setMovedToTextColor(RevisionColor.CLASSIC_BLUE);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_UNDERLINE);

// Render format revisions in dark red and bold.
revisionOptions.setRevisedPropertiesColor(RevisionColor.DARK_RED);
revisionOptions.setRevisedPropertiesEffect(RevisionTextEffect.BOLD);

// Place a thick dark blue bar on the left side of the page next to lines affected by revisions.
revisionOptions.setRevisionBarsColor(RevisionColor.DARK_BLUE);
revisionOptions.setRevisionBarsWidth(15.0f);

// Show revision marks and original text.
revisionOptions.setShowOriginalRevision(true);
revisionOptions.setShowRevisionMarks(true);

// Get movement, deletion, formatting revisions, and comments to show up in green balloons
// on the right side of the page.
revisionOptions.setShowInBalloons(ShowInBalloons.FORMAT);
revisionOptions.setCommentColor(RevisionColor.BRIGHT_GREEN);

// These features are only applicable to formats such as .pdf or .jpg.
doc.save(getArtifactsDir() + "Revision.RevisionOptions.pdf");

getRevisedPropertiesColor/setRevisedPropertiesColor
public int getRevisedPropertiesColor() / public void setRevisedPropertiesColor(int value)

Allows to specify the color to be used for content with changes of formatting properties RevisionType.FORMAT_CHANGE Default value is RevisionColor.NO_HIGHLIGHT. The value of the property is RevisionColor integer constant.

Example:

Shows how to modify the appearance of revisions.

Document doc = new Document(getMyDir() + "Revisions.docx");

// Get the RevisionOptions object that controls the appearance of revisions.
RevisionOptions revisionOptions = doc.getLayoutOptions().getRevisionOptions();

// Render insertion revisions in green and italic.
revisionOptions.setInsertedTextColor(RevisionColor.GREEN);
revisionOptions.setInsertedTextEffect(RevisionTextEffect.ITALIC);

// Render deletion revisions in red and bold.
revisionOptions.setDeletedTextColor(RevisionColor.RED);
revisionOptions.setDeletedTextEffect(RevisionTextEffect.BOLD);

// The same text will appear twice in a movement revision:
// once at the departure point and once at the arrival destination.
// Render the text at the moved-from revision yellow with a double strike through
// and double-underlined blue at the moved-to revision.
revisionOptions.setMovedFromTextColor(RevisionColor.YELLOW);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_STRIKE_THROUGH);
revisionOptions.setMovedToTextColor(RevisionColor.CLASSIC_BLUE);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_UNDERLINE);

// Render format revisions in dark red and bold.
revisionOptions.setRevisedPropertiesColor(RevisionColor.DARK_RED);
revisionOptions.setRevisedPropertiesEffect(RevisionTextEffect.BOLD);

// Place a thick dark blue bar on the left side of the page next to lines affected by revisions.
revisionOptions.setRevisionBarsColor(RevisionColor.DARK_BLUE);
revisionOptions.setRevisionBarsWidth(15.0f);

// Show revision marks and original text.
revisionOptions.setShowOriginalRevision(true);
revisionOptions.setShowRevisionMarks(true);

// Get movement, deletion, formatting revisions, and comments to show up in green balloons
// on the right side of the page.
revisionOptions.setShowInBalloons(ShowInBalloons.FORMAT);
revisionOptions.setCommentColor(RevisionColor.BRIGHT_GREEN);

// These features are only applicable to formats such as .pdf or .jpg.
doc.save(getArtifactsDir() + "Revision.RevisionOptions.pdf");

getRevisedPropertiesEffect/setRevisedPropertiesEffect
public int getRevisedPropertiesEffect() / public void setRevisedPropertiesEffect(int value)

Allows to specify the effect for content areas with changes of formatting properties RevisionType.FORMAT_CHANGE Default value is RevisionTextEffect.NONEThe value of the property is RevisionTextEffect integer constant.

Example:

Shows how to modify the appearance of revisions.

Document doc = new Document(getMyDir() + "Revisions.docx");

// Get the RevisionOptions object that controls the appearance of revisions.
RevisionOptions revisionOptions = doc.getLayoutOptions().getRevisionOptions();

// Render insertion revisions in green and italic.
revisionOptions.setInsertedTextColor(RevisionColor.GREEN);
revisionOptions.setInsertedTextEffect(RevisionTextEffect.ITALIC);

// Render deletion revisions in red and bold.
revisionOptions.setDeletedTextColor(RevisionColor.RED);
revisionOptions.setDeletedTextEffect(RevisionTextEffect.BOLD);

// The same text will appear twice in a movement revision:
// once at the departure point and once at the arrival destination.
// Render the text at the moved-from revision yellow with a double strike through
// and double-underlined blue at the moved-to revision.
revisionOptions.setMovedFromTextColor(RevisionColor.YELLOW);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_STRIKE_THROUGH);
revisionOptions.setMovedToTextColor(RevisionColor.CLASSIC_BLUE);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_UNDERLINE);

// Render format revisions in dark red and bold.
revisionOptions.setRevisedPropertiesColor(RevisionColor.DARK_RED);
revisionOptions.setRevisedPropertiesEffect(RevisionTextEffect.BOLD);

// Place a thick dark blue bar on the left side of the page next to lines affected by revisions.
revisionOptions.setRevisionBarsColor(RevisionColor.DARK_BLUE);
revisionOptions.setRevisionBarsWidth(15.0f);

// Show revision marks and original text.
revisionOptions.setShowOriginalRevision(true);
revisionOptions.setShowRevisionMarks(true);

// Get movement, deletion, formatting revisions, and comments to show up in green balloons
// on the right side of the page.
revisionOptions.setShowInBalloons(ShowInBalloons.FORMAT);
revisionOptions.setCommentColor(RevisionColor.BRIGHT_GREEN);

// These features are only applicable to formats such as .pdf or .jpg.
doc.save(getArtifactsDir() + "Revision.RevisionOptions.pdf");

getRevisionBarsColor/setRevisionBarsColor
public int getRevisionBarsColor() / public void setRevisionBarsColor(int value)

Allows to specify the color to be used for side bars that identify document lines containing revised information. Default value is RevisionColor.RED. The value of the property is RevisionColor integer constant.

Setting this property to RevisionColor.BY_AUTHOR or RevisionColor.NO_HIGHLIGHT values will result in hiding revision bars from the layout.

Example:

Shows how to modify the appearance of revisions.

Document doc = new Document(getMyDir() + "Revisions.docx");

// Get the RevisionOptions object that controls the appearance of revisions.
RevisionOptions revisionOptions = doc.getLayoutOptions().getRevisionOptions();

// Render insertion revisions in green and italic.
revisionOptions.setInsertedTextColor(RevisionColor.GREEN);
revisionOptions.setInsertedTextEffect(RevisionTextEffect.ITALIC);

// Render deletion revisions in red and bold.
revisionOptions.setDeletedTextColor(RevisionColor.RED);
revisionOptions.setDeletedTextEffect(RevisionTextEffect.BOLD);

// The same text will appear twice in a movement revision:
// once at the departure point and once at the arrival destination.
// Render the text at the moved-from revision yellow with a double strike through
// and double-underlined blue at the moved-to revision.
revisionOptions.setMovedFromTextColor(RevisionColor.YELLOW);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_STRIKE_THROUGH);
revisionOptions.setMovedToTextColor(RevisionColor.CLASSIC_BLUE);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_UNDERLINE);

// Render format revisions in dark red and bold.
revisionOptions.setRevisedPropertiesColor(RevisionColor.DARK_RED);
revisionOptions.setRevisedPropertiesEffect(RevisionTextEffect.BOLD);

// Place a thick dark blue bar on the left side of the page next to lines affected by revisions.
revisionOptions.setRevisionBarsColor(RevisionColor.DARK_BLUE);
revisionOptions.setRevisionBarsWidth(15.0f);

// Show revision marks and original text.
revisionOptions.setShowOriginalRevision(true);
revisionOptions.setShowRevisionMarks(true);

// Get movement, deletion, formatting revisions, and comments to show up in green balloons
// on the right side of the page.
revisionOptions.setShowInBalloons(ShowInBalloons.FORMAT);
revisionOptions.setCommentColor(RevisionColor.BRIGHT_GREEN);

// These features are only applicable to formats such as .pdf or .jpg.
doc.save(getArtifactsDir() + "Revision.RevisionOptions.pdf");

getRevisionBarsPosition/setRevisionBarsPosition
public int getRevisionBarsPosition() / public void setRevisionBarsPosition(int value)

Gets or sets rendering position of revision bars. Default value is HorizontalAlignment.OUTSIDE. The value of the property is HorizontalAlignment integer constant.

Example:

Shows how to alter the appearance of revisions in a rendered output document.

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

// Insert a revision, then change the color of all revisions to green.
builder.writeln("This is not a revision.");
doc.startTrackRevisions("John Doe", new Date());
builder.writeln("This is a revision.");
doc.stopTrackRevisions();
builder.writeln("This is not a revision.");

// Remove the bar that appears to the left of every revised line.
doc.getLayoutOptions().getRevisionOptions().setInsertedTextColor(RevisionColor.BRIGHT_GREEN);
doc.getLayoutOptions().getRevisionOptions().setShowRevisionBars(false);
doc.getLayoutOptions().getRevisionOptions().setRevisionBarsPosition(HorizontalAlignment.RIGHT);

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

getRevisionBarsWidth/setRevisionBarsWidth
public float getRevisionBarsWidth() / public void setRevisionBarsWidth(float value)

Gets or sets width of revision bars, points.

Example:

Shows how to modify the appearance of revisions.

Document doc = new Document(getMyDir() + "Revisions.docx");

// Get the RevisionOptions object that controls the appearance of revisions.
RevisionOptions revisionOptions = doc.getLayoutOptions().getRevisionOptions();

// Render insertion revisions in green and italic.
revisionOptions.setInsertedTextColor(RevisionColor.GREEN);
revisionOptions.setInsertedTextEffect(RevisionTextEffect.ITALIC);

// Render deletion revisions in red and bold.
revisionOptions.setDeletedTextColor(RevisionColor.RED);
revisionOptions.setDeletedTextEffect(RevisionTextEffect.BOLD);

// The same text will appear twice in a movement revision:
// once at the departure point and once at the arrival destination.
// Render the text at the moved-from revision yellow with a double strike through
// and double-underlined blue at the moved-to revision.
revisionOptions.setMovedFromTextColor(RevisionColor.YELLOW);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_STRIKE_THROUGH);
revisionOptions.setMovedToTextColor(RevisionColor.CLASSIC_BLUE);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_UNDERLINE);

// Render format revisions in dark red and bold.
revisionOptions.setRevisedPropertiesColor(RevisionColor.DARK_RED);
revisionOptions.setRevisedPropertiesEffect(RevisionTextEffect.BOLD);

// Place a thick dark blue bar on the left side of the page next to lines affected by revisions.
revisionOptions.setRevisionBarsColor(RevisionColor.DARK_BLUE);
revisionOptions.setRevisionBarsWidth(15.0f);

// Show revision marks and original text.
revisionOptions.setShowOriginalRevision(true);
revisionOptions.setShowRevisionMarks(true);

// Get movement, deletion, formatting revisions, and comments to show up in green balloons
// on the right side of the page.
revisionOptions.setShowInBalloons(ShowInBalloons.FORMAT);
revisionOptions.setCommentColor(RevisionColor.BRIGHT_GREEN);

// These features are only applicable to formats such as .pdf or .jpg.
doc.save(getArtifactsDir() + "Revision.RevisionOptions.pdf");

getShowInBalloons/setShowInBalloons
public int getShowInBalloons() / public void setShowInBalloons(int value)

Allows to specify whether the revisions are rendered in the balloons. Default value is ShowInBalloons.NONE. The value of the property is ShowInBalloons integer constant.

Note that revisions are not rendered in balloons for CommentDisplayMode.SHOW_IN_ANNOTATIONS.

Example:

Shows how to display revisions in balloons.

Document doc = new Document(getMyDir() + "Revisions.docx");

// By default, text that is a revision has a different color to differentiate it from the other non-revision text.
// Set a revision option to show more details about each revision in a balloon on the page's right margin.
doc.getLayoutOptions().getRevisionOptions().setShowInBalloons(ShowInBalloons.FORMAT_AND_DELETE);
doc.save(getArtifactsDir() + "Revision.ShowRevisionBalloons.pdf");

Example:

Shows how to modify the appearance of revisions.

Document doc = new Document(getMyDir() + "Revisions.docx");

// Get the RevisionOptions object that controls the appearance of revisions.
RevisionOptions revisionOptions = doc.getLayoutOptions().getRevisionOptions();

// Render insertion revisions in green and italic.
revisionOptions.setInsertedTextColor(RevisionColor.GREEN);
revisionOptions.setInsertedTextEffect(RevisionTextEffect.ITALIC);

// Render deletion revisions in red and bold.
revisionOptions.setDeletedTextColor(RevisionColor.RED);
revisionOptions.setDeletedTextEffect(RevisionTextEffect.BOLD);

// The same text will appear twice in a movement revision:
// once at the departure point and once at the arrival destination.
// Render the text at the moved-from revision yellow with a double strike through
// and double-underlined blue at the moved-to revision.
revisionOptions.setMovedFromTextColor(RevisionColor.YELLOW);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_STRIKE_THROUGH);
revisionOptions.setMovedToTextColor(RevisionColor.CLASSIC_BLUE);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_UNDERLINE);

// Render format revisions in dark red and bold.
revisionOptions.setRevisedPropertiesColor(RevisionColor.DARK_RED);
revisionOptions.setRevisedPropertiesEffect(RevisionTextEffect.BOLD);

// Place a thick dark blue bar on the left side of the page next to lines affected by revisions.
revisionOptions.setRevisionBarsColor(RevisionColor.DARK_BLUE);
revisionOptions.setRevisionBarsWidth(15.0f);

// Show revision marks and original text.
revisionOptions.setShowOriginalRevision(true);
revisionOptions.setShowRevisionMarks(true);

// Get movement, deletion, formatting revisions, and comments to show up in green balloons
// on the right side of the page.
revisionOptions.setShowInBalloons(ShowInBalloons.FORMAT);
revisionOptions.setCommentColor(RevisionColor.BRIGHT_GREEN);

// These features are only applicable to formats such as .pdf or .jpg.
doc.save(getArtifactsDir() + "Revision.RevisionOptions.pdf");

getShowOriginalRevision/setShowOriginalRevision
public boolean getShowOriginalRevision() / public void setShowOriginalRevision(boolean value)

Allows to specify whether the original text should be shown instead of revised one. Default value is false.

Example:

Shows how to modify the appearance of revisions.

Document doc = new Document(getMyDir() + "Revisions.docx");

// Get the RevisionOptions object that controls the appearance of revisions.
RevisionOptions revisionOptions = doc.getLayoutOptions().getRevisionOptions();

// Render insertion revisions in green and italic.
revisionOptions.setInsertedTextColor(RevisionColor.GREEN);
revisionOptions.setInsertedTextEffect(RevisionTextEffect.ITALIC);

// Render deletion revisions in red and bold.
revisionOptions.setDeletedTextColor(RevisionColor.RED);
revisionOptions.setDeletedTextEffect(RevisionTextEffect.BOLD);

// The same text will appear twice in a movement revision:
// once at the departure point and once at the arrival destination.
// Render the text at the moved-from revision yellow with a double strike through
// and double-underlined blue at the moved-to revision.
revisionOptions.setMovedFromTextColor(RevisionColor.YELLOW);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_STRIKE_THROUGH);
revisionOptions.setMovedToTextColor(RevisionColor.CLASSIC_BLUE);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_UNDERLINE);

// Render format revisions in dark red and bold.
revisionOptions.setRevisedPropertiesColor(RevisionColor.DARK_RED);
revisionOptions.setRevisedPropertiesEffect(RevisionTextEffect.BOLD);

// Place a thick dark blue bar on the left side of the page next to lines affected by revisions.
revisionOptions.setRevisionBarsColor(RevisionColor.DARK_BLUE);
revisionOptions.setRevisionBarsWidth(15.0f);

// Show revision marks and original text.
revisionOptions.setShowOriginalRevision(true);
revisionOptions.setShowRevisionMarks(true);

// Get movement, deletion, formatting revisions, and comments to show up in green balloons
// on the right side of the page.
revisionOptions.setShowInBalloons(ShowInBalloons.FORMAT);
revisionOptions.setCommentColor(RevisionColor.BRIGHT_GREEN);

// These features are only applicable to formats such as .pdf or .jpg.
doc.save(getArtifactsDir() + "Revision.RevisionOptions.pdf");

getShowRevisionBars/setShowRevisionBars
public boolean getShowRevisionBars() / public void setShowRevisionBars(boolean value)

Allows to specify whether revision bars should be rendered near lines containing revised content. Default value is true.

Example:

Shows how to alter the appearance of revisions in a rendered output document.

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

// Insert a revision, then change the color of all revisions to green.
builder.writeln("This is not a revision.");
doc.startTrackRevisions("John Doe", new Date());
builder.writeln("This is a revision.");
doc.stopTrackRevisions();
builder.writeln("This is not a revision.");

// Remove the bar that appears to the left of every revised line.
doc.getLayoutOptions().getRevisionOptions().setInsertedTextColor(RevisionColor.BRIGHT_GREEN);
doc.getLayoutOptions().getRevisionOptions().setShowRevisionBars(false);
doc.getLayoutOptions().getRevisionOptions().setRevisionBarsPosition(HorizontalAlignment.RIGHT);

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

getShowRevisionMarks/setShowRevisionMarks
public boolean getShowRevisionMarks() / public void setShowRevisionMarks(boolean value)

Allow to specify whether revision text should be marked with special formatting markup. Default value is true.

Example:

Shows how to modify the appearance of revisions.

Document doc = new Document(getMyDir() + "Revisions.docx");

// Get the RevisionOptions object that controls the appearance of revisions.
RevisionOptions revisionOptions = doc.getLayoutOptions().getRevisionOptions();

// Render insertion revisions in green and italic.
revisionOptions.setInsertedTextColor(RevisionColor.GREEN);
revisionOptions.setInsertedTextEffect(RevisionTextEffect.ITALIC);

// Render deletion revisions in red and bold.
revisionOptions.setDeletedTextColor(RevisionColor.RED);
revisionOptions.setDeletedTextEffect(RevisionTextEffect.BOLD);

// The same text will appear twice in a movement revision:
// once at the departure point and once at the arrival destination.
// Render the text at the moved-from revision yellow with a double strike through
// and double-underlined blue at the moved-to revision.
revisionOptions.setMovedFromTextColor(RevisionColor.YELLOW);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_STRIKE_THROUGH);
revisionOptions.setMovedToTextColor(RevisionColor.CLASSIC_BLUE);
revisionOptions.setMovedFromTextEffect(RevisionTextEffect.DOUBLE_UNDERLINE);

// Render format revisions in dark red and bold.
revisionOptions.setRevisedPropertiesColor(RevisionColor.DARK_RED);
revisionOptions.setRevisedPropertiesEffect(RevisionTextEffect.BOLD);

// Place a thick dark blue bar on the left side of the page next to lines affected by revisions.
revisionOptions.setRevisionBarsColor(RevisionColor.DARK_BLUE);
revisionOptions.setRevisionBarsWidth(15.0f);

// Show revision marks and original text.
revisionOptions.setShowOriginalRevision(true);
revisionOptions.setShowRevisionMarks(true);

// Get movement, deletion, formatting revisions, and comments to show up in green balloons
// on the right side of the page.
revisionOptions.setShowInBalloons(ShowInBalloons.FORMAT);
revisionOptions.setCommentColor(RevisionColor.BRIGHT_GREEN);

// These features are only applicable to formats such as .pdf or .jpg.
doc.save(getArtifactsDir() + "Revision.RevisionOptions.pdf");

See Also:
Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
Aspose.Words Support Forum - our preferred method of support.

com.aspose.words Class RevisionOptions

getCommentColor/setCommentColor

getDeletedTextColor/setDeletedTextColor

getDeletedTextEffect/setDeletedTextEffect

getInsertedTextColor/setInsertedTextColor

getInsertedTextEffect/setInsertedTextEffect

getMeasurementUnit/setMeasurementUnit

getMovedFromTextColor/setMovedFromTextColor

getMovedFromTextEffect/setMovedFromTextEffect

getMovedToTextColor/setMovedToTextColor

getMovedToTextEffect/setMovedToTextEffect

getRevisedPropertiesColor/setRevisedPropertiesColor

getRevisedPropertiesEffect/setRevisedPropertiesEffect

getRevisionBarsColor/setRevisionBarsColor

getRevisionBarsPosition/setRevisionBarsPosition

getRevisionBarsWidth/setRevisionBarsWidth

getShowInBalloons/setShowInBalloons

getShowOriginalRevision/setShowOriginalRevision

getShowRevisionBars/setShowRevisionBars

getShowRevisionMarks/setShowRevisionMarks

com.aspose.words
Class RevisionOptions