com.aspose.words
Class RevisionOptions

java.lang.Object
    extended by com.aspose.words.RevisionOptions
All Implemented Interfaces:
java.lang.Cloneable

public class RevisionOptions 
extends java.lang.Object

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

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,
// and also remove the bar that appears to the left of every revised line.
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.");

doc.getLayoutOptions().getRevisionOptions().setInsertedTextColor(RevisionColor.BRIGHT_GREEN);
doc.getLayoutOptions().getRevisionOptions().setShowRevisionBars(false);

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

Property Getters/Setters Summary
intgetCommentColor()
voidsetCommentColor(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.
intgetDeletedTextColor()
voidsetDeletedTextColor(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.
intgetDeletedTextEffect()
voidsetDeletedTextEffect(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.
intgetInsertedTextColor()
voidsetInsertedTextColor(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.
intgetInsertedTextEffect()
voidsetInsertedTextEffect(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.
intgetMeasurementUnit()
voidsetMeasurementUnit(int value)
           Allows to specify the measurement units for revision comments. Default value is MeasurementUnits.CENTIMETERSThe value of the property is MeasurementUnits integer constant.
intgetMovedFromTextColor()
voidsetMovedFromTextColor(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.
intgetMovedFromTextEffect()
voidsetMovedFromTextEffect(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.
intgetMovedToTextColor()
voidsetMovedToTextColor(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.
intgetMovedToTextEffect()
voidsetMovedToTextEffect(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.
intgetRevisedPropertiesColor()
voidsetRevisedPropertiesColor(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.
intgetRevisedPropertiesEffect()
voidsetRevisedPropertiesEffect(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.
intgetRevisionBarsColor()
voidsetRevisionBarsColor(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.
intgetRevisionBarsPosition()
voidsetRevisionBarsPosition(int value)
           Gets or sets rendering position of revision bars. Default value is HorizontalAlignment.OUTSIDE. The value of the property is HorizontalAlignment integer constant.
floatgetRevisionBarsWidth()
voidsetRevisionBarsWidth(float value)
           Gets or sets width of revision bars, points.
intgetShowInBalloons()
voidsetShowInBalloons(int value)
           Allows to specify whether the revisions are rendered in the balloons. Default value is ShowInBalloons.NONEThe value of the property is ShowInBalloons integer constant.
booleangetShowOriginalRevision()
voidsetShowOriginalRevision(boolean value)
           Allows to specify whether the original text should be shown instead of revised one. Default value is False.
booleangetShowRevisionBars()
voidsetShowRevisionBars(boolean value)
           Allows to specify whether revision bars should be rendered near lines containing revised content. Default value is True.
booleangetShowRevisionMarks()
voidsetShowRevisionMarks(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.

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.

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.

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,
// and also remove the bar that appears to the left of every revised line.
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.");

doc.getLayoutOptions().getRevisionOptions().setInsertedTextColor(RevisionColor.BRIGHT_GREEN);
doc.getLayoutOptions().getRevisionOptions().setShowRevisionBars(false);

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.Values of RevisionTextEffect.HIDDEN and RevisionTextEffect.DOUBLE_STRIKE_THROUGH are not allowed and will cause System.ArgumentOutOfRangeException.

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.

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.

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.

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.

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.Values of RevisionTextEffect.HIDDEN and RevisionTextEffect.DOUBLE_STRIKE_THROUGH are not allowed and will cause System.ArgumentOutOfRangeException.

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.

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.RevisionTextEffect.HIDDEN is not allowed and will cause System.ArgumentOutOfRangeException.

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.

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.Values of HorizontalAlignment.CENTER and HorizontalAlignment.INSIDE are not allowed and will cause System.ArgumentOutOfRangeException.

getRevisionBarsWidth/setRevisionBarsWidth

public float getRevisionBarsWidth() / public void setRevisionBarsWidth(float value)
Gets or sets width of revision bars, points.

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.NONEThe value of the property is ShowInBalloons integer constant.

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.

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,
// and also remove the bar that appears to the left of every revised line.
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.");

doc.getLayoutOptions().getRevisionOptions().setInsertedTextColor(RevisionColor.BRIGHT_GREEN);
doc.getLayoutOptions().getRevisionOptions().setShowRevisionBars(false);

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.

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