RevisionOptions (Aspose.Words for Java API Reference)

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

All Implemented Interfaces:

java.lang.Cloneable
```
public class RevisionOptions
extends java.lang.Object
implements java.lang.Cloneable
```
Allows to control how document revisions are handled during layout process.
To learn more, visit the Converting to Fixed-page Format documentation article.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getCommentColor()` Allows to specify the color to be used for comments.
`int`	`getDeletedTextColor()` Allows to specify the color to be used for deleted content `RevisionType.DELETION`.
`int`	`getDeletedTextEffect()` Allows to specify the effect to be applied to the deleted content `RevisionType.DELETION`.
`int`	`getInsertedTextColor()` Allows to specify the color to be used for inserted content `RevisionType.INSERTION`.
`int`	`getInsertedTextEffect()` Allows to specify the effect to be applied to the inserted content `RevisionType.INSERTION`.
`int`	`getMeasurementUnit()` Allows to specify the measurement units for revision comments.
`int`	`getMovedFromTextColor()` Allows to specify the color to be used for areas where content was moved from `RevisionType.MOVING`.
`int`	`getMovedFromTextEffect()` Allows to specify the effect to be applied to the areas where content was moved from `RevisionType.MOVING`.
`int`	`getMovedToTextColor()` Allows to specify the color to be used for areas where content was moved to `RevisionType.MOVING`.
`int`	`getMovedToTextEffect()` Allows to specify the effect to be applied to the areas where content was moved to `RevisionType.MOVING`.
`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`.
`int`	`getRevisedPropertiesEffect()` Allows to specify the effect for content areas with changes of formatting properties `RevisionType.FORMAT_CHANGE` Default value is `RevisionTextEffect.NONE` `RevisionTextEffect.HIDDEN` is not allowed and will cause `IllegalArgumentException`.
`int`	`getRevisionBarsColor()` Allows to specify the color to be used for side bars that identify document lines containing revised information.
`int`	`getRevisionBarsPosition()` Gets rendering position of revision bars.
`float`	`getRevisionBarsWidth()` Gets width of revision bars, points.
`int`	`getShowInBalloons()` Allows to specify whether the revisions are rendered in the balloons.
`boolean`	`getShowOriginalRevision()` Allows to specify whether the original text should be shown instead of revised one.
`boolean`	`getShowRevisionBars()` Allows to specify whether revision bars should be rendered near lines containing revised content.
`boolean`	`getShowRevisionMarks()` Allow to specify whether revision text should be marked with special formatting markup.
`protected java.lang.Object`	`memberwiseClone()`
`void`	`setCommentColor(int value)` Allows to specify the color to be used for comments.
`void`	`setDeletedTextColor(int value)` Allows to specify the color to be used for deleted content `RevisionType.DELETION`.
`void`	`setDeletedTextEffect(int value)` Allows to specify the effect to be applied to the deleted content `RevisionType.DELETION`.
`void`	`setInsertedTextColor(int value)` Allows to specify the color to be used for inserted content `RevisionType.INSERTION`.
`void`	`setInsertedTextEffect(int value)` Allows to specify the effect to be applied to the inserted content `RevisionType.INSERTION`.
`void`	`setMeasurementUnit(int value)` Allows to specify the measurement units for revision comments.
`void`	`setMovedFromTextColor(int value)` Allows to specify the color to be used for areas where content was moved from `RevisionType.MOVING`.
`void`	`setMovedFromTextEffect(int value)` Allows to specify the effect to be applied to the areas where content was moved from `RevisionType.MOVING`.
`void`	`setMovedToTextColor(int value)` Allows to specify the color to be used for areas where content was moved to `RevisionType.MOVING`.
`void`	`setMovedToTextEffect(int value)` Allows to specify the effect to be applied to the areas where content was moved to `RevisionType.MOVING`.
`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`.
`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` `RevisionTextEffect.HIDDEN` is not allowed and will cause `IllegalArgumentException`.
`void`	`setRevisionBarsColor(int value)` Allows to specify the color to be used for side bars that identify document lines containing revised information.
`void`	`setRevisionBarsPosition(int value)` Sets rendering position of revision bars.
`void`	`setRevisionBarsWidth(float value)` Sets width of revision bars, points.
`void`	`setShowInBalloons(int value)` Allows to specify whether the revisions are rendered in the balloons.
`void`	`setShowOriginalRevision(boolean value)` Allows to specify whether the original text should be shown instead of revised one.
`void`	`setShowRevisionBars(boolean value)` Allows to specify whether revision bars should be rendered near lines containing revised content.
`void`	`setShowRevisionMarks(boolean value)` Allow to specify whether revision text should be marked with special formatting markup.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getShowRevisionMarks
```
public boolean getShowRevisionMarks()
```
    Allow to specify whether revision text should be marked with special formatting markup. Default value is True.
    
    Returns:
    
    The corresponding boolean value.
  - setShowRevisionMarks
```
public void setShowRevisionMarks(boolean value)
```
    Allow to specify whether revision text should be marked with special formatting markup. Default value is True.
    
    Parameters:
    
    value - 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.
    
    Returns:
    
    The corresponding boolean value.
  - setShowRevisionBars
```
public void setShowRevisionBars(boolean value)
```
    Allows to specify whether revision bars should be rendered near lines containing revised content. Default value is True.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getShowOriginalRevision
```
public boolean getShowOriginalRevision()
```
    Allows to specify whether the original text should be shown instead of revised one. Default value is False.
    
    Returns:
    
    The corresponding boolean value.
  - setShowOriginalRevision
```
public void setShowOriginalRevision(boolean value)
```
    Allows to specify whether the original text should be shown instead of revised one. Default value is False.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getInsertedTextColor
```
public int getInsertedTextColor()
```
    Allows to specify the color to be used for inserted content RevisionType.INSERTION. Default value is RevisionColor.BY_AUTHOR.
    
    Returns:
    
    The corresponding int value. The returned value is one of RevisionColor constants.
  - setInsertedTextColor
```
public void setInsertedTextColor(int value)
```
    Allows to specify the color to be used for inserted content RevisionType.INSERTION. Default value is RevisionColor.BY_AUTHOR.
    
    Parameters:
    
    value - The corresponding int value. The value must be 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. Values of RevisionTextEffect.HIDDEN and RevisionTextEffect.DOUBLE_STRIKE_THROUGH are not allowed and will cause IllegalArgumentException.
    
    Returns:
    
    The corresponding int value. The returned value is one of RevisionTextEffect constants.
  - setInsertedTextEffect
```
public void setInsertedTextEffect(int value)
```
    Allows to specify the effect to be applied to the inserted content RevisionType.INSERTION. Default value is RevisionTextEffect.UNDERLINE. Values of RevisionTextEffect.HIDDEN and RevisionTextEffect.DOUBLE_STRIKE_THROUGH are not allowed and will cause IllegalArgumentException.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of RevisionTextEffect constants.
  - getDeletedTextColor
```
public int getDeletedTextColor()
```
    Allows to specify the color to be used for deleted content RevisionType.DELETION. Default value is RevisionColor.BY_AUTHOR.
    
    Returns:
    
    The corresponding int value. The returned value is one of RevisionColor constants.
  - setDeletedTextColor
```
public void setDeletedTextColor(int value)
```
    Allows to specify the color to be used for deleted content RevisionType.DELETION. Default value is RevisionColor.BY_AUTHOR.
    
    Parameters:
    
    value - The corresponding int value. The value must be 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
    
    Returns:
    
    The corresponding int value. The returned value is one of RevisionTextEffect constants.
  - setDeletedTextEffect
```
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
    
    Parameters:
    
    value - The corresponding int value. The value must be one of RevisionTextEffect 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.
    
    Returns:
    
    The corresponding int value. The returned value is one of RevisionColor constants.
  - setMovedFromTextColor
```
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.
    
    Parameters:
    
    value - The corresponding int value. The value must be 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
    
    Returns:
    
    The corresponding int value. The returned value is one of RevisionTextEffect constants.
  - setMovedFromTextEffect
```
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
    
    Parameters:
    
    value - The corresponding int value. The value must be 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.
    
    Returns:
    
    The corresponding int value. The returned value is one of RevisionColor constants.
  - setMovedToTextColor
```
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.
    
    Parameters:
    
    value - The corresponding int value. The value must be 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 Values of RevisionTextEffect.HIDDEN and RevisionTextEffect.DOUBLE_STRIKE_THROUGH are not allowed and will cause IllegalArgumentException.
    
    Returns:
    
    The corresponding int value. The returned value is one of RevisionTextEffect constants.
  - setMovedToTextEffect
```
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 Values of RevisionTextEffect.HIDDEN and RevisionTextEffect.DOUBLE_STRIKE_THROUGH are not allowed and will cause IllegalArgumentException.
    
    Parameters:
    
    value - The corresponding int value. The value must be 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.
    
    Returns:
    
    The corresponding int value. The returned value is one of RevisionColor constants.
  - setRevisedPropertiesColor
```
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.
    
    Parameters:
    
    value - The corresponding int value. The value must be 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 RevisionTextEffect.HIDDEN is not allowed and will cause IllegalArgumentException.
    
    Returns:
    
    The corresponding int value. The returned value is one of RevisionTextEffect constants.
  - setRevisedPropertiesEffect
```
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 RevisionTextEffect.HIDDEN is not allowed and will cause IllegalArgumentException.
    
    Parameters:
    
    value - The corresponding int value. The value must be 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. Setting this property to RevisionColor.BY_AUTHOR or RevisionColor.NO_HIGHLIGHT values will result in hiding revision bars from the layout.
    
    Returns:
    
    The corresponding int value. The returned value is one of RevisionColor constants.
  - setRevisionBarsColor
```
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. Setting this property to RevisionColor.BY_AUTHOR or RevisionColor.NO_HIGHLIGHT values will result in hiding revision bars from the layout.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of RevisionColor constants.
  - getRevisionBarsWidth
```
public float getRevisionBarsWidth()
```
    Gets width of revision bars, points.
    
    Returns:
    
    Width of revision bars, points.
  - setRevisionBarsWidth
```
public void setRevisionBarsWidth(float value)
```
    Sets width of revision bars, points.
    
    Parameters:
    
    value - Width of revision bars, points.
  - getRevisionBarsPosition
```
public int getRevisionBarsPosition()
```
    Gets rendering position of revision bars. Default value is HorizontalAlignment.OUTSIDE. Values of HorizontalAlignment.CENTER and HorizontalAlignment.INSIDE are not allowed and will cause IllegalArgumentException.
    
    Returns:
    
    Rendering position of revision bars. The returned value is one of HorizontalAlignment constants.
  - setRevisionBarsPosition
```
public void setRevisionBarsPosition(int value)
```
    Sets rendering position of revision bars. Default value is HorizontalAlignment.OUTSIDE. Values of HorizontalAlignment.CENTER and HorizontalAlignment.INSIDE are not allowed and will cause IllegalArgumentException.
    
    Parameters:
    
    value - Rendering position of revision bars. The value must be one of HorizontalAlignment constants.
  - getCommentColor
```
public int getCommentColor()
```
    Allows to specify the color to be used for comments. Default value 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.
    
    Returns:
    
    The corresponding int value. The returned value is one of RevisionColor constants.
  - setCommentColor
```
public void setCommentColor(int value)
```
    Allows to specify the color to be used for comments. Default value 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.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of RevisionColor constants.
  - getShowInBalloons
```
public int getShowInBalloons()
```
    Allows to specify whether the revisions are rendered in the balloons. Default value is ShowInBalloons.NONE. Note that revisions are not rendered in balloons for CommentDisplayMode.SHOW_IN_ANNOTATIONS.
    
    Returns:
    
    The corresponding int value. The returned value is one of ShowInBalloons constants.
  - setShowInBalloons
```
public void setShowInBalloons(int value)
```
    Allows to specify whether the revisions are rendered in the balloons. Default value is ShowInBalloons.NONE. Note that revisions are not rendered in balloons for CommentDisplayMode.SHOW_IN_ANNOTATIONS.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of ShowInBalloons constants.
  - getMeasurementUnit
```
public int getMeasurementUnit()
```
    Allows to specify the measurement units for revision comments. Default value is MeasurementUnits.CENTIMETERS
    
    Returns:
    
    The corresponding int value. The returned value is one of MeasurementUnits constants.
  - setMeasurementUnit
```
public void setMeasurementUnit(int value)
```
    Allows to specify the measurement units for revision comments. Default value is MeasurementUnits.CENTIMETERS
    
    Parameters:
    
    value - The corresponding int value. The value must be one of MeasurementUnits constants.
  - memberwiseClone
```
protected java.lang.Object memberwiseClone()
```

Class RevisionOptions

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getShowRevisionMarks

setShowRevisionMarks

getShowRevisionBars

setShowRevisionBars

getShowOriginalRevision

setShowOriginalRevision

getInsertedTextColor

setInsertedTextColor

getInsertedTextEffect

setInsertedTextEffect

getDeletedTextColor

setDeletedTextColor

getDeletedTextEffect

setDeletedTextEffect

getMovedFromTextColor

setMovedFromTextColor

getMovedFromTextEffect

setMovedFromTextEffect

getMovedToTextColor

setMovedToTextColor

getMovedToTextEffect

setMovedToTextEffect

getRevisedPropertiesColor

setRevisedPropertiesColor

getRevisedPropertiesEffect

setRevisedPropertiesEffect

getRevisionBarsColor

setRevisionBarsColor

getRevisionBarsWidth

setRevisionBarsWidth

getRevisionBarsPosition

setRevisionBarsPosition

getCommentColor

setCommentColor

getShowInBalloons

setShowInBalloons

getMeasurementUnit

setMeasurementUnit

memberwiseClone