PreviewOptions class Leave feedback
On this page
Provides options to set requirements and stream delegates for preview generation.
The PreviewOptions type exposes the following members:
| Constructor | Description |
|---|---|
| init | Initializes a new PreviewOptions instance that ensures the output stream is closed. |
| init | Initializes a new instance of PreviewOptions that returns the output stream to the client for further use. |
| Property | Description |
|---|---|
| create_page_stream | The page stream creation delegate. |
| height | The page preview height. |
| page_numbers | The array of page numbers to generate previews. |
| preview_format | The preview image format. |
| release_page_stream | The page preview completion delegate. |
| width | The page preview width. |
import os
import groupdocs.watermark as gw
import groupdocs.watermark.options as gwo
output_dir = os.path.join(os.getcwd(), "preview")
os.makedirs(output_dir, exist_ok=True)
def create_page_stream(number: int):
path = os.path.join(output_dir, f"page{number}.png")
return open(path, "wb")
def release_page_stream(number: int, stream):
stream.close()
with gw.Watermarker("sample.pdf") as watermarker:
preview_options = gwo.PreviewOptions(create_page_stream, release_page_stream)
preview_options.preview_format = gwo.PreviewOptions.PreviewFormats.PNG
preview_options.page_numbers = [1, 2]
watermarker.generate_preview(preview_options)
Task guides that use PreviewOptions:
- module
groupdocs.watermark.options
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
