Apryse Node SDK

Class: DOCXCompare

PDFNet. DOCXCompare

new DOCXCompare()

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

Classes

DOCXCompareOptions

Methods

<static> compare(original_docx_path, revised_docx_path, output_path [, 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:
Name Type Argument Description
original_docx_path string The path to the first DOCX file to compare, the "original"/"before" DOCX.
revised_docx_path string The path to the second DOCX file to compare, the "revised"/"after" DOCX.
output_path string The path where the comparison result DOCX output with tracked changes will be saved to.
options PDFNet.DOCXCompare.DOCXCompareOptions <optional>
 Comparison options (optional).
Returns:
A promise that resolves to an object of type: "PDFNet.DOCXCompareResult"
Type
Promise.<PDFNet.DOCXCompareResult>

<static> compareWithFilter(original_docx_stream, revised_docx_stream, output_stream [, 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:
Name Type Argument Description
original_docx_stream PDFNet.Filter An input filter containing the first DOCX file to compare, the "original"/"before" DOCX.
revised_docx_stream PDFNet.Filter An input filter containing the second DOCX file to compare, the "revised"/"after" DOCX.
output_stream PDFNet.Filter The output filter where the comparison result DOCX output with tracked changes will be saved to.
options PDFNet.DOCXCompare.DOCXCompareOptions <optional>
 Comparison options (optional).
Returns:
A promise that resolves to an object of type: "PDFNet.DOCXCompareResult"
Type
Promise.<PDFNet.DOCXCompareResult>

<static> createDOCXCompareOptions()

Method to create a DOCXCompareOptions object
Returns:
A promise that resolves to a PDFNet.DOCXCompare.DOCXCompareOptions.
Type
Promise.<PDFNet.DOCXCompare.DOCXCompareOptions>