com.aspose.words
Class CompareOptions

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

public class CompareOptions 
extends java.lang.Object

Allows to choose advanced options for document comparison operation.

Example:

Shows how to specify which document shall be used as a target during comparison
Document doc1 = new Document(getMyDir() + "Document.CompareOptions.1.docx");
Document doc2 = new Document(getMyDir() + "Document.CompareOptions.2.docx");

//ComparisonTargetType with IgnoreFormatting setting determines which document has to be used as formatting source for ranges of equal text.
CompareOptions compareOptions = new CompareOptions();
compareOptions.setIgnoreFormatting(true);
compareOptions.setIgnoreCaseChanges(false);
compareOptions.setIgnoreComments(false);
compareOptions.setIgnoreTables(false);
compareOptions.setIgnoreFields(false);
compareOptions.setIgnoreFootnotes(false);
compareOptions.setIgnoreTextboxes(false);
compareOptions.setIgnoreHeadersAndFooters(false);
compareOptions.setTarget(ComparisonTargetType.NEW);

doc1.compare(doc2, "vderyushev", new Date(), compareOptions);

doc1.save(getArtifactsDir() + "Document.CompareOptions.docx");

Constructor Summary
CompareOptions()
          
 
Property Getters/Setters Summary
booleangetIgnoreCaseChanges()
voidsetIgnoreCaseChanges(boolean value)
           True indicates that documents comparison is case insensitive. By default comparison is case sensitive.
booleangetIgnoreComments()
voidsetIgnoreComments(boolean value)
           Specifies whether to compare differences in comments. By default comments are not ignored.
booleangetIgnoreFields()
voidsetIgnoreFields(boolean value)
           Specifies whether to compare differences in fields. By default fields are not ignored.
booleangetIgnoreFootnotes()
voidsetIgnoreFootnotes(boolean value)
           Specifies whether to compare differences in footnotes and endnotes. By default footnotes are not ignored.
booleangetIgnoreFormatting()
voidsetIgnoreFormatting(boolean value)
           True indicates that formatting is ignored. By default document formatting is not ignored.
booleangetIgnoreHeadersAndFooters()
voidsetIgnoreHeadersAndFooters(boolean value)
           True indicates that headers and footers content is ignored. By default headers and footers are not ignored.
booleangetIgnoreTables()
voidsetIgnoreTables(boolean value)
           Specifies whether to compare the differences in data contained in tables. By default tables are not ignored.
booleangetIgnoreTextboxes()
voidsetIgnoreTextboxes(boolean value)
           Specifies whether to compare differences in the data contained within text boxes. By default textboxes are not ignored.
intgetTarget()
voidsetTarget(int value)
           Specifies which document shall be used as a target during comparison. The value of the property is ComparisonTargetType integer constant.
 

Constructor Detail

CompareOptions

public CompareOptions()

Property Getters/Setters Detail

getIgnoreCaseChanges/setIgnoreCaseChanges

public boolean getIgnoreCaseChanges() / public void setIgnoreCaseChanges(boolean value)
True indicates that documents comparison is case insensitive. By default comparison is case sensitive.

Example:

Shows how to specify which document shall be used as a target during comparison
Document doc1 = new Document(getMyDir() + "Document.CompareOptions.1.docx");
Document doc2 = new Document(getMyDir() + "Document.CompareOptions.2.docx");

//ComparisonTargetType with IgnoreFormatting setting determines which document has to be used as formatting source for ranges of equal text.
CompareOptions compareOptions = new CompareOptions();
compareOptions.setIgnoreFormatting(true);
compareOptions.setIgnoreCaseChanges(false);
compareOptions.setIgnoreComments(false);
compareOptions.setIgnoreTables(false);
compareOptions.setIgnoreFields(false);
compareOptions.setIgnoreFootnotes(false);
compareOptions.setIgnoreTextboxes(false);
compareOptions.setIgnoreHeadersAndFooters(false);
compareOptions.setTarget(ComparisonTargetType.NEW);

doc1.compare(doc2, "vderyushev", new Date(), compareOptions);

doc1.save(getArtifactsDir() + "Document.CompareOptions.docx");

getIgnoreComments/setIgnoreComments

public boolean getIgnoreComments() / public void setIgnoreComments(boolean value)
Specifies whether to compare differences in comments. By default comments are not ignored.

Example:

Shows how to specify which document shall be used as a target during comparison
Document doc1 = new Document(getMyDir() + "Document.CompareOptions.1.docx");
Document doc2 = new Document(getMyDir() + "Document.CompareOptions.2.docx");

//ComparisonTargetType with IgnoreFormatting setting determines which document has to be used as formatting source for ranges of equal text.
CompareOptions compareOptions = new CompareOptions();
compareOptions.setIgnoreFormatting(true);
compareOptions.setIgnoreCaseChanges(false);
compareOptions.setIgnoreComments(false);
compareOptions.setIgnoreTables(false);
compareOptions.setIgnoreFields(false);
compareOptions.setIgnoreFootnotes(false);
compareOptions.setIgnoreTextboxes(false);
compareOptions.setIgnoreHeadersAndFooters(false);
compareOptions.setTarget(ComparisonTargetType.NEW);

doc1.compare(doc2, "vderyushev", new Date(), compareOptions);

doc1.save(getArtifactsDir() + "Document.CompareOptions.docx");

getIgnoreFields/setIgnoreFields

public boolean getIgnoreFields() / public void setIgnoreFields(boolean value)
Specifies whether to compare differences in fields. By default fields are not ignored.

Example:

Shows how to specify which document shall be used as a target during comparison
Document doc1 = new Document(getMyDir() + "Document.CompareOptions.1.docx");
Document doc2 = new Document(getMyDir() + "Document.CompareOptions.2.docx");

//ComparisonTargetType with IgnoreFormatting setting determines which document has to be used as formatting source for ranges of equal text.
CompareOptions compareOptions = new CompareOptions();
compareOptions.setIgnoreFormatting(true);
compareOptions.setIgnoreCaseChanges(false);
compareOptions.setIgnoreComments(false);
compareOptions.setIgnoreTables(false);
compareOptions.setIgnoreFields(false);
compareOptions.setIgnoreFootnotes(false);
compareOptions.setIgnoreTextboxes(false);
compareOptions.setIgnoreHeadersAndFooters(false);
compareOptions.setTarget(ComparisonTargetType.NEW);

doc1.compare(doc2, "vderyushev", new Date(), compareOptions);

doc1.save(getArtifactsDir() + "Document.CompareOptions.docx");

getIgnoreFootnotes/setIgnoreFootnotes

public boolean getIgnoreFootnotes() / public void setIgnoreFootnotes(boolean value)
Specifies whether to compare differences in footnotes and endnotes. By default footnotes are not ignored.

Example:

Shows how to specify which document shall be used as a target during comparison
Document doc1 = new Document(getMyDir() + "Document.CompareOptions.1.docx");
Document doc2 = new Document(getMyDir() + "Document.CompareOptions.2.docx");

//ComparisonTargetType with IgnoreFormatting setting determines which document has to be used as formatting source for ranges of equal text.
CompareOptions compareOptions = new CompareOptions();
compareOptions.setIgnoreFormatting(true);
compareOptions.setIgnoreCaseChanges(false);
compareOptions.setIgnoreComments(false);
compareOptions.setIgnoreTables(false);
compareOptions.setIgnoreFields(false);
compareOptions.setIgnoreFootnotes(false);
compareOptions.setIgnoreTextboxes(false);
compareOptions.setIgnoreHeadersAndFooters(false);
compareOptions.setTarget(ComparisonTargetType.NEW);

doc1.compare(doc2, "vderyushev", new Date(), compareOptions);

doc1.save(getArtifactsDir() + "Document.CompareOptions.docx");

getIgnoreFormatting/setIgnoreFormatting

public boolean getIgnoreFormatting() / public void setIgnoreFormatting(boolean value)
True indicates that formatting is ignored. By default document formatting is not ignored.

Example:

Shows how to specify which document shall be used as a target during comparison
Document doc1 = new Document(getMyDir() + "Document.CompareOptions.1.docx");
Document doc2 = new Document(getMyDir() + "Document.CompareOptions.2.docx");

//ComparisonTargetType with IgnoreFormatting setting determines which document has to be used as formatting source for ranges of equal text.
CompareOptions compareOptions = new CompareOptions();
compareOptions.setIgnoreFormatting(true);
compareOptions.setIgnoreCaseChanges(false);
compareOptions.setIgnoreComments(false);
compareOptions.setIgnoreTables(false);
compareOptions.setIgnoreFields(false);
compareOptions.setIgnoreFootnotes(false);
compareOptions.setIgnoreTextboxes(false);
compareOptions.setIgnoreHeadersAndFooters(false);
compareOptions.setTarget(ComparisonTargetType.NEW);

doc1.compare(doc2, "vderyushev", new Date(), compareOptions);

doc1.save(getArtifactsDir() + "Document.CompareOptions.docx");

getIgnoreHeadersAndFooters/setIgnoreHeadersAndFooters

public boolean getIgnoreHeadersAndFooters() / public void setIgnoreHeadersAndFooters(boolean value)
True indicates that headers and footers content is ignored. By default headers and footers are not ignored.

Example:

Shows how to specify which document shall be used as a target during comparison
Document doc1 = new Document(getMyDir() + "Document.CompareOptions.1.docx");
Document doc2 = new Document(getMyDir() + "Document.CompareOptions.2.docx");

//ComparisonTargetType with IgnoreFormatting setting determines which document has to be used as formatting source for ranges of equal text.
CompareOptions compareOptions = new CompareOptions();
compareOptions.setIgnoreFormatting(true);
compareOptions.setIgnoreCaseChanges(false);
compareOptions.setIgnoreComments(false);
compareOptions.setIgnoreTables(false);
compareOptions.setIgnoreFields(false);
compareOptions.setIgnoreFootnotes(false);
compareOptions.setIgnoreTextboxes(false);
compareOptions.setIgnoreHeadersAndFooters(false);
compareOptions.setTarget(ComparisonTargetType.NEW);

doc1.compare(doc2, "vderyushev", new Date(), compareOptions);

doc1.save(getArtifactsDir() + "Document.CompareOptions.docx");

getIgnoreTables/setIgnoreTables

public boolean getIgnoreTables() / public void setIgnoreTables(boolean value)
Specifies whether to compare the differences in data contained in tables. By default tables are not ignored.

Example:

Shows how to specify which document shall be used as a target during comparison
Document doc1 = new Document(getMyDir() + "Document.CompareOptions.1.docx");
Document doc2 = new Document(getMyDir() + "Document.CompareOptions.2.docx");

//ComparisonTargetType with IgnoreFormatting setting determines which document has to be used as formatting source for ranges of equal text.
CompareOptions compareOptions = new CompareOptions();
compareOptions.setIgnoreFormatting(true);
compareOptions.setIgnoreCaseChanges(false);
compareOptions.setIgnoreComments(false);
compareOptions.setIgnoreTables(false);
compareOptions.setIgnoreFields(false);
compareOptions.setIgnoreFootnotes(false);
compareOptions.setIgnoreTextboxes(false);
compareOptions.setIgnoreHeadersAndFooters(false);
compareOptions.setTarget(ComparisonTargetType.NEW);

doc1.compare(doc2, "vderyushev", new Date(), compareOptions);

doc1.save(getArtifactsDir() + "Document.CompareOptions.docx");

getIgnoreTextboxes/setIgnoreTextboxes

public boolean getIgnoreTextboxes() / public void setIgnoreTextboxes(boolean value)
Specifies whether to compare differences in the data contained within text boxes. By default textboxes are not ignored.

Example:

Shows how to specify which document shall be used as a target during comparison
Document doc1 = new Document(getMyDir() + "Document.CompareOptions.1.docx");
Document doc2 = new Document(getMyDir() + "Document.CompareOptions.2.docx");

//ComparisonTargetType with IgnoreFormatting setting determines which document has to be used as formatting source for ranges of equal text.
CompareOptions compareOptions = new CompareOptions();
compareOptions.setIgnoreFormatting(true);
compareOptions.setIgnoreCaseChanges(false);
compareOptions.setIgnoreComments(false);
compareOptions.setIgnoreTables(false);
compareOptions.setIgnoreFields(false);
compareOptions.setIgnoreFootnotes(false);
compareOptions.setIgnoreTextboxes(false);
compareOptions.setIgnoreHeadersAndFooters(false);
compareOptions.setTarget(ComparisonTargetType.NEW);

doc1.compare(doc2, "vderyushev", new Date(), compareOptions);

doc1.save(getArtifactsDir() + "Document.CompareOptions.docx");

getTarget/setTarget

public int getTarget() / public void setTarget(int value)
Specifies which document shall be used as a target during comparison. The value of the property is ComparisonTargetType integer constant.

Example:

Shows how to specify which document shall be used as a target during comparison
Document doc1 = new Document(getMyDir() + "Document.CompareOptions.1.docx");
Document doc2 = new Document(getMyDir() + "Document.CompareOptions.2.docx");

//ComparisonTargetType with IgnoreFormatting setting determines which document has to be used as formatting source for ranges of equal text.
CompareOptions compareOptions = new CompareOptions();
compareOptions.setIgnoreFormatting(true);
compareOptions.setIgnoreCaseChanges(false);
compareOptions.setIgnoreComments(false);
compareOptions.setIgnoreTables(false);
compareOptions.setIgnoreFields(false);
compareOptions.setIgnoreFootnotes(false);
compareOptions.setIgnoreTextboxes(false);
compareOptions.setIgnoreHeadersAndFooters(false);
compareOptions.setTarget(ComparisonTargetType.NEW);

doc1.compare(doc2, "vderyushev", new Date(), compareOptions);

doc1.save(getArtifactsDir() + "Document.CompareOptions.docx");

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