Merger class

Merger class

Represents a group of methods intended to merge a variety of different types of documents into a single output document.

Remarks

The specified input and output files or streams, along with the desired merge and save options, are used to merge the given input documents into a single output document.

The merging functionality supports over 35 different file formats.

Inheritance: MergerProcessor

Methods

NameDescription
create()Creates new instance of the mail merger processor.
create(context)Creates new instance of the mail merger processor.
execute()Execute the processor action.
(Inherited from Processor)
from_file(input)Specifies input document for processing.
(Inherited from Processor)
from_file(input, load_options)Specifies input document for processing.
(Inherited from Processor)
from_stream(input)Specifies input document for processing.
(Inherited from Processor)
from_stream(input, load_options)Specifies input document for processing.
(Inherited from Processor)
merge(output_file, input_files)Merges the given input documents into a single output document using specified input and output file names using MergeFormatMode.KEEP_SOURCE_FORMATTING.
merge(output_file, input_files, save_format, merge_format_mode)Merges the given input documents into a single output document using specified input output file names and the final document format.
merge(output_file, input_files, save_options, merge_format_mode)Merges the given input documents into a single output document using specified input output file names and save options.
merge(output_file, input_files, load_options, save_options, merge_format_mode)Merges the given input documents into a single output document using specified input output file names and save options.
merge(input_files, merge_format_mode)Merges the given input documents into a single document and returns Document instance of the final document.
merge(input_files, load_options, merge_format_mode)Merges the given input documents into a single document and returns Document instance of the final document.
merge_docs(input_documents, merge_format_mode)Merges the given input documents into a single document and returns Document instance of the final document.
merge_streams(output_stream, input_streams, save_format)Merges the given input documents into a single output document using specified input output streams and the final document format.
merge_streams(output_stream, input_streams, save_options, merge_format_mode)Merges the given input documents into a single output document using specified input output streams and save options.
merge_streams(output_stream, input_streams, load_options, save_options, merge_format_mode)Merges the given input documents into a single output document using specified input output streams and save options.
merge_streams(input_streams, merge_format_mode)Merges the given input documents into a single document and returns Document instance of the final document.
merge_streams(input_streams, load_options, merge_format_mode)Merges the given input documents into a single document and returns Document instance of the final document.
merge_to_images(input_files, save_options, merge_format_mode)Merges the given input documents into a single output document using specified input output file names and save options. Renders the output to images.
merge_to_images_streams(input_streams, save_options, merge_format_mode)Merges the given input document streams into a single output document using specified image save options. Renders the output to images.
to_file(output)Specifies output file for the processor.
(Inherited from Processor)
to_file(output, save_options)Specifies output file for the processor.
(Inherited from Processor)
to_file(output, save_format)Specifies output file for the processor.
(Inherited from Processor)
to_stream(output, save_options)Specifies output stream for the processor.
(Inherited from Processor)
to_stream(output, save_format)Specifies output stream for the processor.
(Inherited from Processor)
to_streams(output, save_options)
(Inherited from Processor)
to_streams(output, save_format)
(Inherited from Processor)

See Also