generate_preview method

generate_preview

Generates preview images of specific pages in a given image format.

def generate_preview(self, preview_options):
    ...
Parameter Type Description
preview_options PreviewOptions Image properties and page range settings.

Example

from groupdocs.redaction import Redactor, PreviewOptions, PreviewFormats

with Redactor("document.pdf") as redactor:
    options = PreviewOptions(
        format=PreviewFormats.PNG,
        start_page=1,
        end_page=5,
        create_page_stream=lambda page: open(f"page_{page}.png", "wb")
    )
    redactor.generate_preview(options)

See Also