com.aspose.words
Class Revision

java.lang.Object
    extended by com.aspose.words.Revision

public class Revision 
extends java.lang.Object

Represents a revision (tracked change) in a document node or style. Use RevisionType to check the type of this revision.

Property Getters/Setters Summary
java.lang.StringgetAuthor()
voidsetAuthor(java.lang.String value)
           Gets or sets the author of this revision. Can not be empty string or null.
java.util.DategetDateTime()
voidsetDateTime(java.util.Date value)
           Gets or sets the date/time of this revision.
RevisionGroupgetGroup()
           Gets the revision group. Returns null if the revision does not belong to any group.
NodegetParentNode()
           Gets the immediate parent node (owner) of this revision. This property will work for any revision type other than RevisionType.STYLE_DEFINITION_CHANGE.
StylegetParentStyle()
           Gets the immediate parent style (owner) of this revision. This property will work for only for the RevisionType.STYLE_DEFINITION_CHANGE revision type.
intgetRevisionType()
           Gets the type of this revision. The value of the property is RevisionType integer constant.
 
Method Summary
voidaccept()
           Accepts this revision.
voidreject()
           Reject this revision.
 

Property Getters/Setters Detail

getAuthor/setAuthor

public java.lang.String getAuthor() / public void setAuthor(java.lang.String value)
Gets or sets the author of this revision. Can not be empty string or null.

getDateTime/setDateTime

public java.util.Date getDateTime() / public void setDateTime(java.util.Date value)
Gets or sets the date/time of this revision.

getGroup

public RevisionGroup getGroup()
Gets the revision group. Returns null if the revision does not belong to any group. Revision has no group if revision type is RevisionType.StyleDefinitionChange or if the revision is not longer exist in document context (accepted/rejected).

getParentNode

public Node getParentNode()
Gets the immediate parent node (owner) of this revision. This property will work for any revision type other than RevisionType.STYLE_DEFINITION_CHANGE. If this revision relates to change of Style formatting, use ParentStyle instead.

Example:

Shows how to view revision-related properties of Inline nodes.
Document doc = new Document(getMyDir() + "Revision runs.docx");

// This document has 6 revisions
Assert.assertEquals(doc.getRevisions().getCount(), 6);

// The parent node of a revision is the run that the revision concerns, which is an Inline node
Run run = (Run) doc.getRevisions().get(0).getParentNode();

// Get the parent paragraph
Paragraph firstParagraph = run.getParentParagraph();
RunCollection runs = firstParagraph.getRuns();

Assert.assertEquals(runs.getCount(), 6);

// The text in the run at index #2 was typed after revisions were tracked, so it will count as an insert revision
// The font was changed, so it will also be a format revision
Assert.assertTrue(runs.get(2).isInsertRevision());
Assert.assertTrue(runs.get(2).isFormatRevision());

// If one node was moved from one place to another while changes were tracked,
// the node will be placed at the departure location as a "move to revision",
// and a "move from revision" node will be left behind at the origin, in case we want to reject changes
// Highlighting text and dragging it to another place with the mouse and cut-and-pasting (but not copy-pasting) both count as "move revisions"
// The node with the "IsMoveToRevision" flag is the arrival of the move operation, and the node with the "IsMoveFromRevision" flag is the departure point
Assert.assertTrue(runs.get(1).isMoveToRevision());
Assert.assertTrue(runs.get(4).isMoveFromRevision());

// If an Inline node gets deleted while changes are being tracked, it will leave behind a node with the IsDeleteRevision flag set to true until changes are accepted
Assert.assertTrue(runs.get(5).isDeleteRevision());

getParentStyle

public Style getParentStyle()
Gets the immediate parent style (owner) of this revision. This property will work for only for the RevisionType.STYLE_DEFINITION_CHANGE revision type. If this revision relates to changes on document nodes, use ParentNode instead.

getRevisionType

public int getRevisionType()
Gets the type of this revision. The value of the property is RevisionType integer constant.

Method Detail

accept

public void accept()
           throws java.lang.Exception
Accepts this revision.

reject

public void reject()
           throws java.lang.Exception
Reject this revision.

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