public class

DOCXCompare

extends Object
java.lang.Object
   ↳ com.pdftron.office.DOCXCompare

Class Overview

The class DOCXCompare. A static interface into Apryse SDKs DOCX comparison functionality.

Summary

Public Methods
static DOCXCompareResult compare(String original_docx_path, String revised_docx_path, String output_path, DOCXCompareOptions options)
Compares two DOCX input files and produces a DOCX output file where differences are recorded as tracked changes.
static DOCXCompareResult compare(String original_docx_path, String revised_docx_path, String output_path)
Compares two DOCX input files and produces a DOCX output file where differences are recorded as tracked changes.
static DOCXCompareResult compareWithFilter(Filter original_docx_stream, Filter revised_docx_stream, Filter output_stream)
Compares two DOCX files as streams and writes the DOCX output file to a stream where differences are recorded as tracked changes.
static DOCXCompareResult compareWithFilter(Filter original_docx_stream, Filter revised_docx_stream, Filter output_stream, DOCXCompareOptions options)
Compares two DOCX files as streams and writes the DOCX output file to a stream where differences are recorded as tracked changes.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public static DOCXCompareResult compare (String original_docx_path, String revised_docx_path, String output_path, DOCXCompareOptions options)

Compares two DOCX input files and produces a DOCX output file where differences are recorded as tracked changes. A diff algorithm is performed on the text content of the document which results in tracked insertions, deletions, and formatting changes.

Parameters
original_docx_path The path to the first DOCX file to compare, the "original"/"before" DOCX.
revised_docx_path The path to the second DOCX file to compare, the "revised"/"after" DOCX.
output_path The path where the comparison result DOCX output with tracked changes will be saved to.
options Comparison options (optional).

public static DOCXCompareResult compare (String original_docx_path, String revised_docx_path, String output_path)

Compares two DOCX input files and produces a DOCX output file where differences are recorded as tracked changes. A diff algorithm is performed on the text content of the document which results in tracked insertions, deletions, and formatting changes.

Parameters
original_docx_path The path to the first DOCX file to compare, the "original"/"before" DOCX.
revised_docx_path The path to the second DOCX file to compare, the "revised"/"after" DOCX.
output_path The path where the comparison result DOCX output with tracked changes will be saved to.

public static DOCXCompareResult compareWithFilter (Filter original_docx_stream, Filter revised_docx_stream, Filter output_stream)

Compares two DOCX files as streams and writes the DOCX output file to a stream where differences are recorded as tracked changes. A diff algorithm is performed on the text content of the document which results in tracked insertions, deletions, and formatting changes.

Parameters
original_docx_stream An input filter containing the first DOCX file to compare, the "original"/"before" DOCX.
revised_docx_stream An input filter containing the second DOCX file to compare, the "revised"/"after" DOCX.
output_stream The output filter where the comparison result DOCX output with tracked changes will be saved to.

public static DOCXCompareResult compareWithFilter (Filter original_docx_stream, Filter revised_docx_stream, Filter output_stream, DOCXCompareOptions options)

Compares two DOCX files as streams and writes the DOCX output file to a stream where differences are recorded as tracked changes. A diff algorithm is performed on the text content of the document which results in tracked insertions, deletions, and formatting changes.

Parameters
original_docx_stream An input filter containing the first DOCX file to compare, the "original"/"before" DOCX.
revised_docx_stream An input filter containing the second DOCX file to compare, the "revised"/"after" DOCX.
output_stream The output filter where the comparison result DOCX output with tracked changes will be saved to.
options Comparison options (optional).