com.groupdocs.comparison.options

Class CompareOptions



  • public class CompareOptions
    extends Object

    Allows to set different compare options.

    • Property Detail

      • isCompareDocument

        Control to turn on comparison of built and custom properties in Word format.
      • isCompareVariable

        Control to turn on comparison of variables properties in Word format.
    • Constructor Detail

      • CompareOptions

        public CompareOptions()

        Initializes a new instance of the CompareOptions class.

    • Method Detail

      • getCalculateCoordinates

        public final boolean getCalculateCoordinates()

        Indicates whether to calculate coordinates for changed components.

      • getChangedItemStyle

        public final StyleSettings getChangedItemStyle()

        Describes style for changed components.

      • getDeletedItemStyle

        public final StyleSettings getDeletedItemStyle()

        Describes style for deleted components.

      • getDetalisationLevel

        public final int getDetalisationLevel()

        Gets or sets the comparison detail level.

      • getDetectStyleChanges

        public final boolean getDetectStyleChanges()

        Indicates whether to detect style changes or not.

      • getDiagramMasterSetting

        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.
      • getExtendedInfo

        public com.groupdocs.comparison.options.ExtendedInfoSummaryPage getExtendedInfo()
      • getGenerateSummaryPage

        public final boolean getGenerateSummaryPage()

        Indicates whether to add summary page with detected changes statistics to resultant document or not.

      • getHeaderFootersComparison

        public final boolean getHeaderFootersComparison()

        Control to turn on comparison of header/footer contents.

      • getInsertedItemStyle

        public final StyleSettings getInsertedItemStyle()

        Describes style for inserted components.

      • getMarkChangedContent

        public final boolean getMarkChangedContent()

        Indicates whether to use frames for shapes in Word Processing and for rectangles in Image documents.

      • getMarkNestedContent

        public final boolean getMarkNestedContent()

        Gets or sets a value indicating whether to mark the children of the deleted or inserted element as deleted or inserted.

      • getOriginalSize

        public final OriginalSize getOriginalSize()

        Get or sets the original sizes of compared documents.

      • getPaperSize

        public final int getPaperSize()

        Gets or sets the result document paper size.

      • getPasswordSaveOption

        public final int getPasswordSaveOption()

        Gets or sets the password save option.

        Value: The password save option.
      • getSensitivityOfComparison

        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.
      • getShowDeletedContent

        public final boolean getShowDeletedContent()

        Indicates whether to show deleted components in resultant document or not.

      • getShowInsertedContent

        public final boolean getShowInsertedContent()

        Indicates whether to show inserted components in resultant document or not.

      • isCompareBookmarks

        public boolean isCompareBookmarks()
        Control to turn on comparison of bookmarks in Word format.
      • isCompareDocumentProperty

        public boolean isCompareDocumentProperty()
        Control to turn on comparison of built and custom properties in Word format.
      • isCompareVariableProperty

        public boolean isCompareVariableProperty()
        Control to turn on comparison of variables properties in Word format.
      • isExtendedSummaryPage

        public boolean isExtendedSummaryPage()

        Indicates whether to add extended file comparison information to the summary page or not.

      • isShowOnlySummaryPage

        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.

      • isShowRevisions

        public boolean isShowRevisions()
        Indicates whether to display others revisions in the resulting document or not.
      • setCalculateCoordinates

        public final void setCalculateCoordinates(boolean value)

        Indicates whether to calculate coordinates for changed components.

      • setChangedItemStyle

        public final void setChangedItemStyle(StyleSettings value)

        Describes style for changed components.

      • setCompareBookmarks

        public void setCompareBookmarks(boolean compareBookmarks)
      • setCompareDocumentProperty

        public void setCompareDocumentProperty(boolean compareDocumentProperty)
        Control to turn on comparison of built and custom properties in Word format.
      • setCompareVariableProperty

        public void setCompareVariableProperty(boolean compareVariableProperty)
      • setDeletedItemStyle

        public final void setDeletedItemStyle(StyleSettings value)

        Describes style for deleted components.

      • setDetalisationLevel

        public final void setDetalisationLevel(int value)

        Gets or sets the comparison detail level.

      • setDetectStyleChanges

        public final void setDetectStyleChanges(boolean value)

        Indicates whether to detect style changes or not.

      • setDiagramMasterSetting

        public 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.
      • setExtendedInfo

        public void setExtendedInfo(com.groupdocs.comparison.options.ExtendedInfoSummaryPage extendedInfo)
      • setExtendedSummaryPage

        public void setExtendedSummaryPage(boolean extendedSummaryPage)

        Indicates whether to add extended file comparison information to the summary page or not.

      • setGenerateSummaryPage

        public final void setGenerateSummaryPage(boolean value)

        Indicates whether to add summary page with detected changes statistics to resultant document or not.

      • setHeaderFootersComparison

        public final void setHeaderFootersComparison(boolean value)

        Control to turn on comparison of header/footer contents.

      • setInsertedItemStyle

        public final void setInsertedItemStyle(StyleSettings value)

        Describes style for inserted components.

      • setMarkChangedContent

        public final void setMarkChangedContent(boolean value)

        Indicates whether to use frames for shapes in Word Processing and for rectangles in Image documents.

      • setMarkNestedContent

        public 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.

      • setOriginalSize

        public final void setOriginalSize(OriginalSize value)

        Get or sets the original sizes of compared documents.

      • setPaperSize

        public final void setPaperSize(int value)

        Gets or sets the result document paper size.

      • setPasswordSaveOption

        public final void setPasswordSaveOption(int value)

        Gets or sets the password save option.

        Value: The password save option.
      • setSensitivityOfComparison

        public final void setSensitivityOfComparison(int value)
      • setShowDeletedContent

        public final void setShowDeletedContent(boolean value)

        Indicates whether to show deleted components in resultant document or not.

      • setShowInsertedContent

        public final void setShowInsertedContent(boolean value)

        Indicates whether to show inserted components in resultant document or not.

      • setShowOnlySummaryPage

        public 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.

      • setShowRevisions

        public void setShowRevisions(boolean showRevisions)
        Indicates whether to display others revisions in the resulting document or not.
      • setWordsSeparatorChars

        public final void setWordsSeparatorChars(char[] value)

        Gets or sets an array of delimiters to split text into words.

        Value: The words separator chars.