PreviewOptions class

PreviewOptions class

Represents document preview options.

The PreviewOptions type exposes the following members:

Constructors

Constructor Description
init
init

Properties

Property Description
height The preview images height.
hide_signatures The flag indicating whether signatures are hidden from page preview images.
page_numbers The preview images page numbers.
preview_format The preview images format.
resolution The resolution of the preview images in DPI (dots per inch). The default resolution is 96 DPI.
width The preview image width.

Example

from groupdocs.signature import Signature
from groupdocs.signature.options import PreviewOptions

def create_page_stream(page_data):
    image_name = f"preview_page_{page_data.page_number}.png"
    print(f"Saving page {page_data.page_number + 1} to {image_name}")
    return open(image_name, "wb")

with Signature("sample.pdf") as signature:
    preview_options = PreviewOptions(create_page_stream)
    preview_options.preview_format = PreviewOptions.PreviewFormats.PNG
    signature.generate_preview(preview_options)

Guides

Task guides that use PreviewOptions:

See Also