RevisionTextEffect (Aspose.Words for Java API Reference)

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

public class RevisionTextEffect
extends java.lang.Object

Allows to specify decoration effect for revisions of document text.

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");

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOLD` Revised content is made bold and colored.
`static int`	`COLOR` Revised content is highlighted with color only.
`static int`	`DOUBLE_STRIKE_THROUGH` Revised content is double stroked through and colored.
`static int`	`DOUBLE_UNDERLINE` Revised content is double underlined and colored.
`static int`	`HIDDEN` Revised content is hidden.
`static int`	`ITALIC` Revised content is made italic and colored.
`static int`	`length`
`static int`	`NONE` Revised content has no special effects applied.
`static int`	`STRIKE_THROUGH` Revised content is stroked through and colored.
`static int`	`UNDERLINE` Revised content is underlined and colored.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`fromName(java.lang.String revisionTextEffectName)`
`static java.lang.String`	`getName(int revisionTextEffect)`
`static int[]`	`getValues()`
`static java.lang.String`	`toString(int revisionTextEffect)`

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

- Field Detail
  - NONE
```
public static int NONE
```
    Revised content has no special effects applied. This corresponds to RevisionColor.NO_HIGHLIGHT.
  - COLOR
```
public static int COLOR
```
    Revised content is highlighted with color only.
  - BOLD
```
public static int BOLD
```
    Revised content is made bold and colored.
  - ITALIC
```
public static int ITALIC
```
    Revised content is made italic and colored.
  - UNDERLINE
```
public static int UNDERLINE
```
    Revised content is underlined and colored.
  - DOUBLE_UNDERLINE
```
public static int DOUBLE_UNDERLINE
```
    Revised content is double underlined and colored.
  - STRIKE_THROUGH
```
public static int STRIKE_THROUGH
```
    Revised content is stroked through and colored.
  - DOUBLE_STRIKE_THROUGH
```
public static int DOUBLE_STRIKE_THROUGH
```
    Revised content is double stroked through and colored.
    Remarks:
    
    Only works for RevisionType.DELETION, RevisionType.FORMAT_CHANGE and RevisionType.MOVING ('move from' type).
  - HIDDEN
```
public static int HIDDEN
```
    Revised content is hidden.
    Remarks:
    
    Only works for RevisionType.DELETION and RevisionType.MOVING ('move from' type).
  - length
```
public static int length
```
- Method Detail
  - getName
```
public static java.lang.String getName(int revisionTextEffect)
```
  - toString
```
public static java.lang.String toString(int revisionTextEffect)
```
  - fromName
```
public static int fromName(java.lang.String revisionTextEffectName)
```
  - getValues
```
public static int[] getValues()
```

Class RevisionTextEffect

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NONE

COLOR

BOLD

ITALIC

UNDERLINE

DOUBLE_UNDERLINE

STRIKE_THROUGH

DOUBLE_STRIKE_THROUGH

HIDDEN

length

Method Detail

getName

toString

fromName

getValues