public class CompareOptions extends Object
Allows to set different compare options.
Type | Property and Description |
---|---|
boolean |
isCompareDocument
Gets the value of the property compareDocumentProperty.
|
boolean |
isCompareVariable
Gets the value of the property compareVariableProperty.
|
Modifier and Type | Class and Description |
---|---|
static class |
CompareOptions.Builder
A little sugar
|
Constructor and Description |
---|
CompareOptions()
Initializes a new instance of the
CompareOptions class. |
Modifier and Type | Method and Description |
---|---|
StyleSettings |
getChangedItemStyle()
Describes style for changed components.
|
StyleSettings |
getDeletedItemStyle()
Describes style for deleted components.
|
int |
getDetalisationLevel()
Gets or sets the comparison detail level.
|
DiagramMasterSetting |
getDiagramMasterSetting()
Gets or sets the path value for master or use compare without path of master.
|
boolean |
getGenerateSummaryPage()
Indicates whether to add summary page with detected changes statistics to resultant document or not.
|
StyleSettings |
getInsertedItemStyle()
Describes style for inserted components.
|
boolean |
getMarkNestedContent()
Deprecated.
|
OriginalSize |
getOriginalSize()
Get or sets the original sizes of compared documents.
|
int |
getPaperSize()
Gets or sets the result document paper size.
|
int |
getPasswordSaveOption()
Gets or sets the password save option.
|
int |
getSensitivityOfComparison()
Gets or sets a sensitivity of comparison.
|
boolean |
isCalculateCoordinates()
Indicates whether to calculate coordinates for changed components.
|
boolean |
isCompareBookmarks()
Control to turn on comparison of bookmarks in Word format.
|
boolean |
isCompareDocumentProperty()
Gets the value of the property compareDocumentProperty.
|
boolean |
isCompareVariableProperty()
Gets the value of the property compareVariableProperty.
|
boolean |
isDetectStyleChanges()
Indicates whether to detect style changes or not.
|
boolean |
isExtendedSummaryPage()
Indicates whether to add extended file comparison information to the summary page or not.
|
boolean |
isHeaderFootersComparison()
Control to turn on comparison of header/footer contents.
|
boolean |
isLeaveGaps()
Indicates whether to display empty lines instead of inserted / deleted components in the final document or not (used with ShowInsertedContent or ShowDeletedContent properties).
|
boolean |
isMarkChangedContent()
Indicates whether to use frames for shapes in Word Processing and for rectangles in Image documents.
|
boolean |
isMarkNestedContent()
Gets or sets a value indicating whether to mark the children of the deleted or inserted element as deleted or inserted.
|
boolean |
isShowDeletedContent()
Indicates whether to show deleted components in resultant document or not.
|
boolean |
isShowInsertedContent()
Indicates whether to show inserted components in resultant document or not.
|
boolean |
isShowOnlySummaryPage()
Indicates whether to leave in the resulting document only a page with statistics of detected changes in the resulting document or not.
|
boolean |
isShowRevisions()
Indicates whether to display others revisions in the resulting document or not.
|
void |
setCalculateCoordinates(boolean value)
Indicates whether to calculate coordinates for changed components.
|
void |
setChangedItemStyle(StyleSettings value)
Describes style for changed components.
|
void |
setCompareBookmarks(boolean compareBookmarks)
Sets compare bookmarks.
|
void |
setCompareDocumentProperty(boolean compareDocumentProperty)
Control to turn on comparison of built and custom properties in Word format.
|
void |
setCompareVariableProperty(boolean compareVariableProperty)
Sets compare variable property.
|
void |
setDeletedItemStyle(StyleSettings value)
Describes style for deleted components.
|
void |
setDetalisationLevel(int value)
Gets or sets the comparison detail level.
|
void |
setDetectStyleChanges(boolean value)
Indicates whether to detect style changes or not.
|
void |
setDiagramMasterSetting(DiagramMasterSetting value)
Gets or sets the path value for master or use compare without path of master.
|
void |
setExtendedSummaryPage(boolean extendedSummaryPage)
Indicates whether to add extended file comparison information to the summary page or not.
|
void |
setGenerateSummaryPage(boolean value)
Indicates whether to add summary page with detected changes statistics to resultant document or not.
|
void |
setHeaderFootersComparison(boolean value)
Control to turn on comparison of header/footer contents.
|
void |
setInsertedItemStyle(StyleSettings value)
Describes style for inserted components.
|
void |
setLeaveGaps(boolean leaveGaps)
Indicates whether to display empty lines instead of inserted / deleted components in the final document or not (used with ShowInsertedContent or ShowDeletedContent properties).
|
void |
setMarkChangedContent(boolean value)
Indicates whether to use frames for shapes in Word Processing and for rectangles in Image documents.
|
void |
setMarkNestedContent(boolean value)
Gets or sets a value indicating whether to mark the children of the deleted or inserted element as deleted or inserted.
|
void |
setOriginalSize(OriginalSize value)
Get or sets the original sizes of compared documents.
|
void |
setPaperSize(int value)
Gets or sets the result document paper size.
|
void |
setPasswordSaveOption(int value)
Gets or sets the password save option.
|
void |
setSensitivityOfComparison(int value)
Sets sensitivity of comparison.
|
void |
setShowDeletedContent(boolean value)
Indicates whether to show deleted components in resultant document or not.
|
void |
setShowInsertedContent(boolean value)
Indicates whether to show inserted components in resultant document or not.
|
void |
setShowOnlySummaryPage(boolean auto_ShowOnlySummaryPage)
Indicates whether to leave in the resulting document only a page with statistics of detected changes in the resulting document or not.
|
void |
setShowRevisions(boolean showRevisions)
Indicates whether to display others revisions in the resulting document or not.
|
void |
setWordsSeparatorChars(char[] value)
Gets or sets an array of delimiters to split text into words.
|
public boolean isCompareDocumentProperty
public boolean isCompareVariableProperty
public CompareOptions()
Initializes a new instance of the CompareOptions
class.
public final StyleSettings getChangedItemStyle()
Describes style for changed components.
public final StyleSettings getDeletedItemStyle()
Describes style for deleted components.
public final int getDetalisationLevel()
Gets or sets the comparison detail level.
public final DiagramMasterSetting getDiagramMasterSetting()
Gets or sets the path value for master or use compare without path of master. This option only for Diagram.
Value: The master option for Diagram.public final boolean getGenerateSummaryPage()
Indicates whether to add summary page with detected changes statistics to resultant document or not.
public final StyleSettings getInsertedItemStyle()
Describes style for inserted components.
@Deprecated public final boolean getMarkNestedContent()
public final OriginalSize getOriginalSize()
Get or sets the original sizes of compared documents.
public final int getPaperSize()
Gets or sets the result document paper size.
public final int getPasswordSaveOption()
Gets or sets the password save option.
Value: The password save option.public final int getSensitivityOfComparison()
Gets or sets a sensitivity of comparison.
Value: The percentage of deleted and inserted elements of two compared objects in relation to all elements of these objects. if this percentage if exceeded, the object aren't compared but are considered completely inserted and deleted. Min value - 0% => The comparison doesn't occur for any length of the common subsequence of two compared object. Default value - 75% => Comparison occurs if the percentage of deleted and inserted elements of two compared object with respect to all elements of these objects isn't more then 75. Max value - 100% => The comparison occurs at any length of the common subsequence of two compared objects.public final boolean isCalculateCoordinates()
Indicates whether to calculate coordinates for changed components.
public boolean isCompareBookmarks()
public boolean isCompareDocumentProperty()
public boolean isCompareVariableProperty()
public final boolean isDetectStyleChanges()
Indicates whether to detect style changes or not.
public boolean isExtendedSummaryPage()
Indicates whether to add extended file comparison information to the summary page or not.
public final boolean isHeaderFootersComparison()
Control to turn on comparison of header/footer contents.
public boolean isLeaveGaps()
public final boolean isMarkChangedContent()
Indicates whether to use frames for shapes in Word Processing and for rectangles in Image documents.
public final boolean isMarkNestedContent()
Gets or sets a value indicating whether to mark the children of the deleted or inserted element as deleted or inserted.
public final boolean isShowDeletedContent()
Indicates whether to show deleted components in resultant document or not.
public final boolean isShowInsertedContent()
Indicates whether to show inserted components in resultant document or not.
public boolean isShowOnlySummaryPage()
Indicates whether to leave in the resulting document only a page with statistics of detected changes in the resulting document or not.
public boolean isShowRevisions()
public final void setCalculateCoordinates(boolean value)
Indicates whether to calculate coordinates for changed components.
value
- the valuepublic final void setChangedItemStyle(StyleSettings value)
Describes style for changed components.
value
- the valuepublic void setCompareBookmarks(boolean compareBookmarks)
compareBookmarks
- the compare bookmarkspublic void setCompareDocumentProperty(boolean compareDocumentProperty)
compareDocumentProperty
- the compare document propertypublic void setCompareVariableProperty(boolean compareVariableProperty)
compareVariableProperty
- the compare variable propertypublic final void setDeletedItemStyle(StyleSettings value)
Describes style for deleted components.
value
- the valuepublic final void setDetalisationLevel(int value)
Gets or sets the comparison detail level.
value
- the valuepublic final void setDetectStyleChanges(boolean value)
Indicates whether to detect style changes or not.
value
- the valuepublic final void setDiagramMasterSetting(DiagramMasterSetting value)
Gets or sets the path value for master or use compare without path of master. This option only for Diagram.
Value: The master option for Diagram.value
- the valuepublic void setExtendedSummaryPage(boolean extendedSummaryPage)
Indicates whether to add extended file comparison information to the summary page or not.
extendedSummaryPage
- the extended summary pagepublic final void setGenerateSummaryPage(boolean value)
Indicates whether to add summary page with detected changes statistics to resultant document or not.
value
- the valuepublic final void setHeaderFootersComparison(boolean value)
Control to turn on comparison of header/footer contents.
value
- the valuepublic final void setInsertedItemStyle(StyleSettings value)
Describes style for inserted components.
value
- the valuepublic void setLeaveGaps(boolean leaveGaps)
leaveGaps
- enabled or notpublic final void setMarkChangedContent(boolean value)
Indicates whether to use frames for shapes in Word Processing and for rectangles in Image documents.
value
- the valuepublic final void setMarkNestedContent(boolean value)
Gets or sets a value indicating whether to mark the children of the deleted or inserted element as deleted or inserted.
value
- the valuepublic final void setOriginalSize(OriginalSize value)
Get or sets the original sizes of compared documents.
value
- the valuepublic final void setPaperSize(int value)
Gets or sets the result document paper size.
value
- the valuepublic final void setPasswordSaveOption(int value)
Gets or sets the password save option.
Value: The password save option.value
- the valuepublic final void setSensitivityOfComparison(int value)
value
- the valuepublic final void setShowDeletedContent(boolean value)
Indicates whether to show deleted components in resultant document or not.
value
- the valuepublic final void setShowInsertedContent(boolean value)
Indicates whether to show inserted components in resultant document or not.
value
- the valuepublic void setShowOnlySummaryPage(boolean auto_ShowOnlySummaryPage)
Indicates whether to leave in the resulting document only a page with statistics of detected changes in the resulting document or not.
auto_ShowOnlySummaryPage
- the auto show only summary pagepublic void setShowRevisions(boolean showRevisions)
showRevisions
- the show revisionspublic final void setWordsSeparatorChars(char[] value)
Gets or sets an array of delimiters to split text into words.
Value: The words separator chars.value
- the valueCopyright © 2022. All rights reserved.