com.aspose.words

Class CompareOptions

java.lang.Object

com.aspose.words.CompareOptions

public class CompareOptions
extends java.lang.Object

Allows to choose advanced options for document comparison operation.

To learn more, visit the Compare Documents documentation article.

Method Summary

Modifier and Type	Method and Description
int	getGranularity() Specifies whether changes are tracked by character or by word.
boolean	getIgnoreCaseChanges() True indicates that documents comparison is case insensitive.
boolean	getIgnoreComments() Specifies whether to compare differences in comments.
boolean	getIgnoreDmlUniqueId() Specifies whether to ignore difference in DrawingML unique Id.
boolean	getIgnoreFields() Specifies whether to compare differences in fields.
boolean	getIgnoreFootnotes() Specifies whether to compare differences in footnotes and endnotes.
boolean	getIgnoreFormatting() True indicates that formatting is ignored.
boolean	getIgnoreHeadersAndFooters() True indicates that headers and footers content is ignored.
boolean	getIgnoreTables() Specifies whether to compare the differences in data contained in tables.
boolean	getIgnoreTextboxes() Specifies whether to compare differences in the data contained within text boxes.
int	getTarget() Specifies which document shall be used as a target during comparison.
void	setGranularity(int value) Specifies whether changes are tracked by character or by word.
void	setIgnoreCaseChanges(boolean value) True indicates that documents comparison is case insensitive.
void	setIgnoreComments(boolean value) Specifies whether to compare differences in comments.
void	setIgnoreDmlUniqueId(boolean value) Specifies whether to ignore difference in DrawingML unique Id.
void	setIgnoreFields(boolean value) Specifies whether to compare differences in fields.
void	setIgnoreFootnotes(boolean value) Specifies whether to compare differences in footnotes and endnotes.
void	setIgnoreFormatting(boolean value) True indicates that formatting is ignored.
void	setIgnoreHeadersAndFooters(boolean value) True indicates that headers and footers content is ignored.
void	setIgnoreTables(boolean value) Specifies whether to compare the differences in data contained in tables.
void	setIgnoreTextboxes(boolean value) Specifies whether to compare differences in the data contained within text boxes.
void	setTarget(int value) Specifies which document shall be used as a target during comparison.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getIgnoreCaseChanges

public boolean getIgnoreCaseChanges()

True indicates that documents comparison is case insensitive. By default comparison is case sensitive.

Returns:

The corresponding boolean value.

setIgnoreCaseChanges

public void setIgnoreCaseChanges(boolean value)

True indicates that documents comparison is case insensitive. By default comparison is case sensitive.

Parameters:

value - The corresponding boolean value.

getIgnoreTables

public boolean getIgnoreTables()

Specifies whether to compare the differences in data contained in tables. By default tables are not ignored.

Returns:

The corresponding boolean value.

setIgnoreTables

public void setIgnoreTables(boolean value)

Specifies whether to compare the differences in data contained in tables. By default tables are not ignored.

Parameters:

value - The corresponding boolean value.

getIgnoreFields

public boolean getIgnoreFields()

Specifies whether to compare differences in fields. By default fields are not ignored.

Returns:

The corresponding boolean value.

setIgnoreFields

public void setIgnoreFields(boolean value)

Specifies whether to compare differences in fields. By default fields are not ignored.

Parameters:

value - The corresponding boolean value.

getIgnoreFootnotes

public boolean getIgnoreFootnotes()

Specifies whether to compare differences in footnotes and endnotes. By default footnotes are not ignored.

Returns:

The corresponding boolean value.

setIgnoreFootnotes

public void setIgnoreFootnotes(boolean value)

Specifies whether to compare differences in footnotes and endnotes. By default footnotes are not ignored.

Parameters:

value - The corresponding boolean value.

getIgnoreComments

public boolean getIgnoreComments()

Specifies whether to compare differences in comments. By default comments are not ignored.

Returns:

The corresponding boolean value.

setIgnoreComments

public void setIgnoreComments(boolean value)

Specifies whether to compare differences in comments. By default comments are not ignored.

Parameters:

value - The corresponding boolean value.

getIgnoreTextboxes

public boolean getIgnoreTextboxes()

Specifies whether to compare differences in the data contained within text boxes. By default textboxes are not ignored.

Returns:

The corresponding boolean value.

setIgnoreTextboxes

public void setIgnoreTextboxes(boolean value)

Specifies whether to compare differences in the data contained within text boxes. By default textboxes are not ignored.

Parameters:

value - The corresponding boolean value.

getIgnoreFormatting

public boolean getIgnoreFormatting()

True indicates that formatting is ignored. By default document formatting is not ignored.

Returns:

The corresponding boolean value.

setIgnoreFormatting

public void setIgnoreFormatting(boolean value)

True indicates that formatting is ignored. By default document formatting is not ignored.

Parameters:

value - The corresponding boolean value.

getIgnoreHeadersAndFooters

public boolean getIgnoreHeadersAndFooters()

True indicates that headers and footers content is ignored. By default headers and footers are not ignored.

Returns:

The corresponding boolean value.

setIgnoreHeadersAndFooters

public void setIgnoreHeadersAndFooters(boolean value)

True indicates that headers and footers content is ignored. By default headers and footers are not ignored.

Parameters:

value - The corresponding boolean value.

getTarget

public int getTarget()

Specifies which document shall be used as a target during comparison.

Returns:

The corresponding int value. The returned value is one of ComparisonTargetType constants.

setTarget

public void setTarget(int value)

Specifies which document shall be used as a target during comparison.

Parameters:

value - The corresponding int value. The value must be one of ComparisonTargetType constants.

getGranularity

public int getGranularity()

Specifies whether changes are tracked by character or by word. Default value is Granularity.WORD_LEVEL.

Returns:

The corresponding int value. The returned value is one of Granularity constants.

setGranularity

public void setGranularity(int value)

Specifies whether changes are tracked by character or by word. Default value is Granularity.WORD_LEVEL.

Parameters:

value - The corresponding int value. The value must be one of Granularity constants.

getIgnoreDmlUniqueId

public boolean getIgnoreDmlUniqueId()

Specifies whether to ignore difference in DrawingML unique Id. Default value is false.

Returns:

The corresponding boolean value.

setIgnoreDmlUniqueId

public void setIgnoreDmlUniqueId(boolean value)

Specifies whether to ignore difference in DrawingML unique Id. Default value is false.

Parameters:

value - The corresponding boolean value.