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

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

Property Getters/Setters Summary
intgetCommentColor()
void
setCommentColor(intvalue)
           Allows to specify the color to be used for comments. Default value for this property is RevisionColor.RED. If set this property to RevisionColor.BY_AUTHOR or RevisionColor.NO_HIGHLIGHT values, as the result this property will be set to default color.The value of the property is RevisionColor integer constant.
intgetDeletedTextColor()
void
           Allows to specify the color to be used for deleted content RevisionType.DELETION. Default value for this property is RevisionColor.BY_AUTHOR. The value of the property is RevisionColor integer constant.
intgetDeletedTextEffect()
void
           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()
void
           Allows to specify the color to be used for inserted content RevisionType.INSERTION. Default value for this property is RevisionColor.BY_AUTHOR. The value of the property is RevisionColor integer constant.
intgetInsertedTextEffect()
void
           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.
intgetMovedFromTextColor()
void
           Allows to specify the color to be used for areas where content was moved from RevisionType.MOVING. Default value for this property is RevisionColor.BY_AUTHOR. The value of the property is RevisionColor integer constant.
intgetMovedFromTextEffect()
void
           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()
void
           Allows to specify the color to be used for areas where content was moved to RevisionType.MOVING. Default value for this property is RevisionColor.BY_AUTHOR. The value of the property is RevisionColor integer constant.
intgetMovedToTextEffect()
void
           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()
void
           Allows to specify the color to be used for content with changes of formatting properties RevisionType.FORMAT_CHANGE Default value for this property is RevisionColor.NO_HIGHLIGHT. The value of the property is RevisionColor integer constant.
intgetRevisedPropertiesEffect()
void
           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()
void
           Allows to specify the color to be used for side bars that identify document lines containing revised information. Default value for this property is RevisionColor.RED. The value of the property is RevisionColor integer constant.
floatgetRevisionBarsWidth()
void
           Gets or sets width of revision bars, points.
intgetShowInBalloons()
void
           Allows to specify whether the revisions are rendered in the balloons. Default value for this property is ShowInBalloons.NONEThe value of the property is ShowInBalloons integer constant.
booleangetShowOriginalRevision()
void
           Allows to specify whether the original text should be shown instead of revised one. Default value for this property is false.
booleangetShowRevisionBars()
void
setShowRevisionBars(booleanvalue)
           Allows to specify whether revision bars should be rendered near lines containing revised content. Default value for this property is true.
booleangetShowRevisionMarks()
void
setShowRevisionMarks(booleanvalue)
           Allow to specify whether revision text should be marked with special formatting markup. Default value for this property 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 for this property is RevisionColor.RED. If set this property to RevisionColor.BY_AUTHOR or RevisionColor.NO_HIGHLIGHT values, as the result this property will be set to default color.The value of the property is RevisionColor integer constant.
      • 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 for this property is RevisionColor.BY_AUTHOR. The value of the property is RevisionColor 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 for this property is RevisionColor.BY_AUTHOR. The value of the property is RevisionColor 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 for this property is RevisionColor.BY_AUTHOR. The value of the property is RevisionColor 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 for this property is RevisionColor.BY_AUTHOR. The value of the property is RevisionColor integer constant.
      • 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 for this property is RevisionColor.NO_HIGHLIGHT. The value of the property is RevisionColor integer constant.
      • 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 for this property 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.
      • 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 for this property is ShowInBalloons.NONEThe value of the property is ShowInBalloons integer constant.

        Example:

        Shows how render tracking changes in balloons
        Document doc = new Document(getMyDir() + "ShowRevisionBalloons.docx");
        
        //Set option true, if you need render tracking changes in balloons in pdf document
        doc.getLayoutOptions().getRevisionOptions().setShowInBalloons(ShowInBalloons.FORMAT);
        
        //Check that revisions are in balloons 
        doc.save(getMyDir() + "\\Artifacts\\ShowRevisionBalloons.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 for this property 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 for this property is true.
      • 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 for this property is true.