com.groupdocs.comparison.options

Class CompareOptions



  • public class CompareOptions
    extends Object

    Allows to set different compare options.

    • Property Detail

      • isCompareDocument

        public boolean isCompareDocumentProperty
        Gets the value of the property compareDocumentProperty.
      • isCompareVariable

        public boolean isCompareVariableProperty
        Gets the value of the property compareVariableProperty.
    • Constructor Detail

      • CompareOptions

        public CompareOptions()

        Initializes a new instance of the CompareOptions class.

    • Method Detail

      • getChangedItemStyle

        public final StyleSettings getChangedItemStyle()

        Describes style for changed components.

        Returns:
        the changed item style
      • getDeletedItemStyle

        public final StyleSettings getDeletedItemStyle()

        Describes style for deleted components.

        Returns:
        the deleted item style
      • getDetalisationLevel

        public final int getDetalisationLevel()

        Gets or sets the comparison detail level.

        Returns:
        the detalisation level
      • 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.
        Returns:
        the diagram master setting
      • getGenerateSummaryPage

        public final boolean getGenerateSummaryPage()

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

        Returns:
        the generate summary page
      • getInsertedItemStyle

        public final StyleSettings getInsertedItemStyle()

        Describes style for inserted components.

        Returns:
        the inserted item style
      • getMarkNestedContent

        @Deprecated
        public final boolean getMarkNestedContent()
        Deprecated. 
        Gets mark nested content.
        Returns:
        the mark nested content
      • getOriginalSize

        public final OriginalSize getOriginalSize()

        Get or sets the original sizes of compared documents.

        Returns:
        the original size
      • getPaperSize

        public final int getPaperSize()

        Gets or sets the result document paper size.

        Returns:
        the paper size
      • getPasswordSaveOption

        public final int getPasswordSaveOption()

        Gets or sets the password save option.

        Value: The password save option.
        Returns:
        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.
        Returns:
        the sensitivity of comparison
      • isCalculateCoordinates

        public final boolean isCalculateCoordinates()

        Indicates whether to calculate coordinates for changed components.

        Returns:
        the boolean
      • isCompareBookmarks

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

        public boolean isCompareDocumentProperty()
        Gets the value of the property compareDocumentProperty.
      • isCompareVariableProperty

        public boolean isCompareVariableProperty()
        Gets the value of the property compareVariableProperty.
      • isDetectStyleChanges

        public final boolean isDetectStyleChanges()

        Indicates whether to detect style changes or not.

        Returns:
        the boolean
      • isExtendedSummaryPage

        public boolean isExtendedSummaryPage()

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

        Returns:
        the boolean
      • isHeaderFootersComparison

        public final boolean isHeaderFootersComparison()

        Control to turn on comparison of header/footer contents.

        Returns:
        the boolean
      • isLeaveGaps

        public 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).
        Returns:
        enabled or not
      • isMarkChangedContent

        public final boolean isMarkChangedContent()

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

        Returns:
        the boolean
      • isMarkNestedContent

        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.

        Returns:
        the boolean
      • isShowDeletedContent

        public final boolean isShowDeletedContent()

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

        Returns:
        the boolean
      • isShowInsertedContent

        public final boolean isShowInsertedContent()

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

        Returns:
        the boolean
      • 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.

        Returns:
        the boolean
      • isShowRevisions

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

        public final void setCalculateCoordinates(boolean value)

        Indicates whether to calculate coordinates for changed components.

        Parameters:
        value - the value
      • setChangedItemStyle

        public final void setChangedItemStyle(StyleSettings value)

        Describes style for changed components.

        Parameters:
        value - the value
      • setCompareBookmarks

        public void setCompareBookmarks(boolean compareBookmarks)
        Sets compare bookmarks.
        Parameters:
        compareBookmarks - the compare bookmarks
      • setCompareDocumentProperty

        public void setCompareDocumentProperty(boolean compareDocumentProperty)
        Control to turn on comparison of built and custom properties in Word format.
        Parameters:
        compareDocumentProperty - the compare document property
      • setCompareVariableProperty

        public void setCompareVariableProperty(boolean compareVariableProperty)
        Sets compare variable property.
        Parameters:
        compareVariableProperty - the compare variable property
      • setDeletedItemStyle

        public final void setDeletedItemStyle(StyleSettings value)

        Describes style for deleted components.

        Parameters:
        value - the value
      • setDetalisationLevel

        public final void setDetalisationLevel(int value)

        Gets or sets the comparison detail level.

        Parameters:
        value - the value
      • setDetectStyleChanges

        public final void setDetectStyleChanges(boolean value)

        Indicates whether to detect style changes or not.

        Parameters:
        value - the value
      • 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.
        Parameters:
        value - the value
      • setExtendedSummaryPage

        public void setExtendedSummaryPage(boolean extendedSummaryPage)

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

        Parameters:
        extendedSummaryPage - the extended summary page
      • setGenerateSummaryPage

        public final void setGenerateSummaryPage(boolean value)

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

        Parameters:
        value - the value
      • setHeaderFootersComparison

        public final void setHeaderFootersComparison(boolean value)

        Control to turn on comparison of header/footer contents.

        Parameters:
        value - the value
      • setInsertedItemStyle

        public final void setInsertedItemStyle(StyleSettings value)

        Describes style for inserted components.

        Parameters:
        value - the value
      • setLeaveGaps

        public 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).
        Parameters:
        leaveGaps - enabled or not
      • setMarkChangedContent

        public final void setMarkChangedContent(boolean value)

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

        Parameters:
        value - the value
      • 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.

        Parameters:
        value - the value
      • setOriginalSize

        public final void setOriginalSize(OriginalSize value)

        Get or sets the original sizes of compared documents.

        Parameters:
        value - the value
      • setPaperSize

        public final void setPaperSize(int value)

        Gets or sets the result document paper size.

        Parameters:
        value - the value
      • setPasswordSaveOption

        public final void setPasswordSaveOption(int value)

        Gets or sets the password save option.

        Value: The password save option.
        Parameters:
        value - the value
      • setSensitivityOfComparison

        public final void setSensitivityOfComparison(int value)
        Sets sensitivity of comparison.
        Parameters:
        value - the value
      • setShowDeletedContent

        public final void setShowDeletedContent(boolean value)

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

        Parameters:
        value - the value
      • setShowInsertedContent

        public final void setShowInsertedContent(boolean value)

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

        Parameters:
        value - the value
      • 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.

        Parameters:
        auto_ShowOnlySummaryPage - the auto show only summary page
      • setShowRevisions

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

        public final void setWordsSeparatorChars(char[] value)

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

        Value: The words separator chars.
        Parameters:
        value - the value