RevisionOptions
Inheritance: java.lang.Object
All Implemented Interfaces: java.lang.Cloneable
public class RevisionOptions implements Cloneable
Allows to control how document revisions are handled during layout process.
To learn more, visit the Converting to Fixed-page Format documentation article.
Examples:
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");
Methods
| Method | Description |
|---|---|
| getCommentColor() | Allows to specify the color to be used for comments. |
| getDeleteCellColor() | Allows to specify the color to be used for deleted cells RevisionType.DELETION. |
| getDeletedTextColor() | Allows to specify the color to be used for deleted content RevisionType.DELETION. |
| getDeletedTextEffect() | Allows to specify the effect to be applied to the deleted content RevisionType.DELETION. |
| getInsertCellColor() | Allows to specify the color to be used for inserted cells RevisionType.INSERTION. |
| getInsertedTextColor() | Allows to specify the color to be used for inserted content RevisionType.INSERTION. |
| getInsertedTextEffect() | Allows to specify the effect to be applied to the inserted content RevisionType.INSERTION. |
| getMeasurementUnit() | Allows to specify the measurement units for revision comments. |
| getMovedFromTextColor() | Allows to specify the color to be used for areas where content was moved from RevisionType.MOVING. |
| getMovedFromTextEffect() | Allows to specify the effect to be applied to the areas where content was moved from RevisionType.MOVING. |
| getMovedToTextColor() | Allows to specify the color to be used for areas where content was moved to RevisionType.MOVING. |
| getMovedToTextEffect() | Allows to specify the effect to be applied to the areas where content was moved to RevisionType.MOVING. |
| getRevisedPropertiesColor() | Allows to specify the color to be used for content with changes of formatting properties RevisionType.FORMAT_CHANGE Default value is RevisionColor.NO_HIGHLIGHT. |
| getRevisedPropertiesEffect() | Allows to specify the effect for content areas with changes of formatting properties RevisionType.FORMAT_CHANGE Default value is RevisionTextEffect.NONE |
| getRevisionBarsColor() | Allows to specify the color to be used for side bars that identify document lines containing revised information. |
| getRevisionBarsPosition() | Gets rendering position of revision bars. |
| getRevisionBarsWidth() | Gets width of revision bars, points. |
| getShowInBalloons() | Allows to specify whether the revisions are rendered in the balloons. |
| getShowOriginalRevision() | Allows to specify whether the original text should be shown instead of revised one. |
| getShowRevisionBars() | Allows to specify whether revision bars should be rendered near lines containing revised content. |
| getShowRevisionMarks() | Allow to specify whether revision text should be marked with special formatting markup. |
| setCommentColor(int value) | Allows to specify the color to be used for comments. |
| setDeleteCellColor(int value) | Allows to specify the color to be used for deleted cells RevisionType.DELETION. |
| setDeletedTextColor(int value) | Allows to specify the color to be used for deleted content RevisionType.DELETION. |
| setDeletedTextEffect(int value) | Allows to specify the effect to be applied to the deleted content RevisionType.DELETION. |
| setInsertCellColor(int value) | Allows to specify the color to be used for inserted cells RevisionType.INSERTION. |
| setInsertedTextColor(int value) | Allows to specify the color to be used for inserted content RevisionType.INSERTION. |
| setInsertedTextEffect(int value) | Allows to specify the effect to be applied to the inserted content RevisionType.INSERTION. |
| setMeasurementUnit(int value) | Allows to specify the measurement units for revision comments. |
| setMovedFromTextColor(int value) | Allows to specify the color to be used for areas where content was moved from RevisionType.MOVING. |
| setMovedFromTextEffect(int value) | Allows to specify the effect to be applied to the areas where content was moved from RevisionType.MOVING. |
| setMovedToTextColor(int value) | Allows to specify the color to be used for areas where content was moved to RevisionType.MOVING. |
| setMovedToTextEffect(int value) | Allows to specify the effect to be applied to the areas where content was moved to RevisionType.MOVING. |
| 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. |
| setRevisedPropertiesEffect(int value) | Allows to specify the effect for content areas with changes of formatting properties RevisionType.FORMAT_CHANGE Default value is RevisionTextEffect.NONE |
| setRevisionBarsColor(int value) | Allows to specify the color to be used for side bars that identify document lines containing revised information. |
| setRevisionBarsPosition(int value) | Sets rendering position of revision bars. |
| setRevisionBarsWidth(float value) | Sets width of revision bars, points. |
| setShowInBalloons(int value) | Allows to specify whether the revisions are rendered in the balloons. |
| setShowOriginalRevision(boolean value) | Allows to specify whether the original text should be shown instead of revised one. |
| setShowRevisionBars(boolean value) | Allows to specify whether revision bars should be rendered near lines containing revised content. |
| setShowRevisionMarks(boolean value) | Allow to specify whether revision text should be marked with special formatting markup. |
getCommentColor()
public int getCommentColor()
Allows to specify the color to be used for comments. Default value is RevisionColor.RED.
Remarks:
If set this property to RevisionColor.BY_AUTHOR or RevisionColor.NO_HIGHLIGHT values, as the result this property will be set to default color.
Examples:
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");
Returns: int - The corresponding int value. The returned value is one of RevisionColor constants.
getDeleteCellColor()
public int getDeleteCellColor()
Allows to specify the color to be used for deleted cells RevisionType.DELETION. Default value is RevisionColor.PINK.
Examples:
Shows how to work with insert/delete cell revision color.
Document doc = new Document(getMyDir() + "Cell revisions.docx");
doc.getLayoutOptions().getRevisionOptions().setInsertCellColor(RevisionColor.BLUE);
doc.getLayoutOptions().getRevisionOptions().setDeleteCellColor(RevisionColor.DARK_RED);
doc.save(getArtifactsDir() + "Revision.RevisionCellColor.pdf");
Returns: int - The corresponding int value. The returned value is one of RevisionColor constants.
getDeletedTextColor()
public int getDeletedTextColor()
Allows to specify the color to be used for deleted content RevisionType.DELETION. Default value is RevisionColor.BY_AUTHOR.
Examples:
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");
Returns: int - The corresponding int value. The returned value is one of RevisionColor constants.
getDeletedTextEffect()
public int getDeletedTextEffect()
Allows to specify the effect to be applied to the deleted content RevisionType.DELETION. Default value is RevisionTextEffect.STRIKE_THROUGH
Examples:
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");
Returns: int - The corresponding int value. The returned value is one of RevisionTextEffect constants.
getInsertCellColor()
public int getInsertCellColor()
Allows to specify the color to be used for inserted cells RevisionType.INSERTION. Default value is RevisionColor.BLUE.
Examples:
Shows how to work with insert/delete cell revision color.
Document doc = new Document(getMyDir() + "Cell revisions.docx");
doc.getLayoutOptions().getRevisionOptions().setInsertCellColor(RevisionColor.BLUE);
doc.getLayoutOptions().getRevisionOptions().setDeleteCellColor(RevisionColor.DARK_RED);
doc.save(getArtifactsDir() + "Revision.RevisionCellColor.pdf");
Returns: int - The corresponding int value. The returned value is one of RevisionColor constants.
getInsertedTextColor()
public int getInsertedTextColor()
Allows to specify the color to be used for inserted content RevisionType.INSERTION. Default value is RevisionColor.BY_AUTHOR.
Examples:
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");
Returns: int - The corresponding int value. The returned value is one of RevisionColor constants.
getInsertedTextEffect()
public int getInsertedTextEffect()
Allows to specify the effect to be applied to the inserted content RevisionType.INSERTION. Default value is RevisionTextEffect.UNDERLINE.
Returns: int - The corresponding int value. The returned value is one of RevisionTextEffect constants.
getMeasurementUnit()
public int getMeasurementUnit()
Allows to specify the measurement units for revision comments. Default value is MeasurementUnits.CENTIMETERS
Examples:
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);
Returns: int - The corresponding int value. The returned value is one of MeasurementUnits constants.
getMovedFromTextColor()
public int getMovedFromTextColor()
Allows to specify the color to be used for areas where content was moved from RevisionType.MOVING. Default value is RevisionColor.BY_AUTHOR.
Examples:
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");
Returns: int - The corresponding int value. The returned value is one of RevisionColor constants.
getMovedFromTextEffect()
public int getMovedFromTextEffect()
Allows to specify the effect to be applied to the areas where content was moved from RevisionType.MOVING. Default value is RevisionTextEffect.DOUBLE_STRIKE_THROUGH
Examples:
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");
Returns: int - The corresponding int value. The returned value is one of RevisionTextEffect constants.
getMovedToTextColor()
public int getMovedToTextColor()
Allows to specify the color to be used for areas where content was moved to RevisionType.MOVING. Default value is RevisionColor.BY_AUTHOR.
Examples:
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");
Returns: int - The corresponding int value. The returned value is one of RevisionColor constants.
getMovedToTextEffect()
public int getMovedToTextEffect()
Allows to specify the effect to be applied to the areas where content was moved to RevisionType.MOVING. Default value is RevisionTextEffect.DOUBLE_UNDERLINE
Returns: int - The corresponding int value. The returned value is one of RevisionTextEffect constants.
getRevisedPropertiesColor()
public int getRevisedPropertiesColor()
Allows to specify the color to be used for content with changes of formatting properties RevisionType.FORMAT_CHANGE Default value is RevisionColor.NO_HIGHLIGHT.
Examples:
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");
Returns: int - The corresponding int value. The returned value is one of RevisionColor constants.
getRevisedPropertiesEffect()
public int getRevisedPropertiesEffect()
Allows to specify the effect for content areas with changes of formatting properties RevisionType.FORMAT_CHANGE Default value is RevisionTextEffect.NONE
Returns: int - The corresponding int value. The returned value is one of RevisionTextEffect constants.
getRevisionBarsColor()
public int getRevisionBarsColor()
Allows to specify the color to be used for side bars that identify document lines containing revised information. Default value is RevisionColor.RED.
Remarks:
Setting this property to RevisionColor.BY_AUTHOR or RevisionColor.NO_HIGHLIGHT values will result in hiding revision bars from the layout.
Examples:
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");
Returns: int - The corresponding int value. The returned value is one of RevisionColor constants.
getRevisionBarsPosition()
public int getRevisionBarsPosition()
Gets rendering position of revision bars. Default value is HorizontalAlignment.OUTSIDE.
Returns: int - Rendering position of revision bars. The returned value is one of HorizontalAlignment constants.
getRevisionBarsWidth()
public float getRevisionBarsWidth()
Gets width of revision bars, points.
Examples:
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");
Returns: float - Width of revision bars, points.
getShowInBalloons()
public int getShowInBalloons()
Allows to specify whether the revisions are rendered in the balloons. Default value is ShowInBalloons.NONE.
Remarks:
Note that revisions are not rendered in balloons for CommentDisplayMode.SHOW_IN_ANNOTATIONS.
Examples:
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");
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");
Returns: int - The corresponding int value. The returned value is one of ShowInBalloons constants.
getShowOriginalRevision()
public boolean getShowOriginalRevision()
Allows to specify whether the original text should be shown instead of revised one. Default value is false .
Examples:
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");
Returns: boolean - The corresponding boolean value.
getShowRevisionBars()
public boolean getShowRevisionBars()
Allows to specify whether revision bars should be rendered near lines containing revised content. Default value is true .
Examples:
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");
Returns: boolean - The corresponding boolean value.
getShowRevisionMarks()
public boolean getShowRevisionMarks()
Allow to specify whether revision text should be marked with special formatting markup. Default value is true .
Examples:
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");
Returns: boolean - The corresponding boolean value.
setCommentColor(int value)
public void setCommentColor(int value)
Allows to specify the color to be used for comments. Default value is RevisionColor.RED.
Remarks:
If set this property to RevisionColor.BY_AUTHOR or RevisionColor.NO_HIGHLIGHT values, as the result this property will be set to default color.
Examples:
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");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of RevisionColor constants. |
setDeleteCellColor(int value)
public void setDeleteCellColor(int value)
Allows to specify the color to be used for deleted cells RevisionType.DELETION. Default value is RevisionColor.PINK.
Examples:
Shows how to work with insert/delete cell revision color.
Document doc = new Document(getMyDir() + "Cell revisions.docx");
doc.getLayoutOptions().getRevisionOptions().setInsertCellColor(RevisionColor.BLUE);
doc.getLayoutOptions().getRevisionOptions().setDeleteCellColor(RevisionColor.DARK_RED);
doc.save(getArtifactsDir() + "Revision.RevisionCellColor.pdf");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of RevisionColor constants. |
setDeletedTextColor(int value)
public void setDeletedTextColor(int value)
Allows to specify the color to be used for deleted content RevisionType.DELETION. Default value is RevisionColor.BY_AUTHOR.
Examples:
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");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of RevisionColor constants. |
setDeletedTextEffect(int value)
public void setDeletedTextEffect(int value)
Allows to specify the effect to be applied to the deleted content RevisionType.DELETION. Default value is RevisionTextEffect.STRIKE_THROUGH
Examples:
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");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of RevisionTextEffect constants. |
setInsertCellColor(int value)
public void setInsertCellColor(int value)
Allows to specify the color to be used for inserted cells RevisionType.INSERTION. Default value is RevisionColor.BLUE.
Examples:
Shows how to work with insert/delete cell revision color.
Document doc = new Document(getMyDir() + "Cell revisions.docx");
doc.getLayoutOptions().getRevisionOptions().setInsertCellColor(RevisionColor.BLUE);
doc.getLayoutOptions().getRevisionOptions().setDeleteCellColor(RevisionColor.DARK_RED);
doc.save(getArtifactsDir() + "Revision.RevisionCellColor.pdf");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of RevisionColor constants. |
setInsertedTextColor(int value)
public void setInsertedTextColor(int value)
Allows to specify the color to be used for inserted content RevisionType.INSERTION. Default value is RevisionColor.BY_AUTHOR.
Examples:
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");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of RevisionColor constants. |
setInsertedTextEffect(int value)
public void setInsertedTextEffect(int value)
Allows to specify the effect to be applied to the inserted content RevisionType.INSERTION. Default value is RevisionTextEffect.UNDERLINE.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of RevisionTextEffect constants. |
setMeasurementUnit(int value)
public void setMeasurementUnit(int value)
Allows to specify the measurement units for revision comments. Default value is MeasurementUnits.CENTIMETERS
Examples:
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);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of MeasurementUnits constants. |
setMovedFromTextColor(int value)
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.
Examples:
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");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of RevisionColor constants. |
setMovedFromTextEffect(int value)
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_THROUGH
Examples:
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");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of RevisionTextEffect constants. |
setMovedToTextColor(int value)
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.
Examples:
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");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of RevisionColor constants. |
setMovedToTextEffect(int value)
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_UNDERLINE
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of RevisionTextEffect constants. |
setRevisedPropertiesColor(int value)
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.
Examples:
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");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of RevisionColor constants. |
setRevisedPropertiesEffect(int value)
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.NONE
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of RevisionTextEffect constants. |
setRevisionBarsColor(int value)
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.
Remarks:
Setting this property to RevisionColor.BY_AUTHOR or RevisionColor.NO_HIGHLIGHT values will result in hiding revision bars from the layout.
Examples:
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");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of RevisionColor constants. |
setRevisionBarsPosition(int value)
public void setRevisionBarsPosition(int value)
Sets rendering position of revision bars. Default value is HorizontalAlignment.OUTSIDE.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | Rendering position of revision bars. The value must be one of HorizontalAlignment constants. |
setRevisionBarsWidth(float value)
public void setRevisionBarsWidth(float value)
Sets width of revision bars, points.
Examples:
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");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | float | Width of revision bars, points. |
setShowInBalloons(int value)
public void setShowInBalloons(int value)
Allows to specify whether the revisions are rendered in the balloons. Default value is ShowInBalloons.NONE.
Remarks:
Note that revisions are not rendered in balloons for CommentDisplayMode.SHOW_IN_ANNOTATIONS.
Examples:
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");
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");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of ShowInBalloons constants. |
setShowOriginalRevision(boolean value)
public void setShowOriginalRevision(boolean value)
Allows to specify whether the original text should be shown instead of revised one. Default value is false .
Examples:
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");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setShowRevisionBars(boolean value)
public void setShowRevisionBars(boolean value)
Allows to specify whether revision bars should be rendered near lines containing revised content. Default value is true .
Examples:
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");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setShowRevisionMarks(boolean value)
public void setShowRevisionMarks(boolean value)
Allow to specify whether revision text should be marked with special formatting markup. Default value is true .
Examples:
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");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
