Comparer class

Comparer class

Represents main class that controls the documents comparison process.

The Comparer type exposes the following members:

Constructors

Constructor Description
init Initializes new instance of Comparer class with source file path.
init Initializes new instance of Comparer with source folder path and CompareOptions.
init Initializes new instance of Comparer with source file path and LoadOptions.
init Initializes new instance of Comparer class with source file path and ComparerSettings.
init Initializes new instance of Comparer class with source file path, LoadOptions and ComparerSettings.
init Initializes new instance of Comparer class with source document stream.
init Initializes new instance of Comparer with source document stream and LoadOptions.
init Initializes new instance of Comparer class with source document stream and ComparerSettings.
init Initializes new instance of Comparer class with document stream, LoadOptions and ComparerSettings.

Properties

Property Description
source Source file that is being compared.
source_folder Source folder that is being compared.
targets List of target files to compare with source file.
target_folder Target folder that is being compared.
result Result document.

Methods

Method Description
compare Compares documents without saving result with default options
compare Compares documents and saves result to file path
compare Compares documents and saves result to file stream
compare Compares documents and saves result to file path
compare Compares documents and saves result to file stream
compare Compares documents without saving result.
compare Compares documents and save result to file path
compare Compares documents and save result to file stream
compare Compares documents without saving result.
compare Compares documents and saves result to a stream.
compare Compares documents and saves result to file path
add Adds file to comparison.
add Adds folder to comparison.
add Adds file to comparison with loading options specified.
add Adds document stream to comparison.
add Adds document stream to comparison with loading options specified.
get_changes Gets list of changes between source and target file(s).
get_changes Gets list of changes between source and target file(s).
apply_changes Accepts or rejects changes and applies them to resultant document.
apply_changes Accepts or rejects changes and applies them to resultant document.
apply_changes Accepts or rejects changes and applies them to resultant document.
apply_changes Accepts or rejects changes and applies them to resultant document.
get_result_document_stream Gets the stream of result document, returns null if stream does not exist
compare_directory Compares directory and saves result to file path
get_result_string Get result string after comparison (For Text Comparison only).

See Also

ComparerSettings class