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 closes the output stream after use. |
| init | Initializes a new PreviewOptions instance that returns the output stream to the client for further use. |
| Property | Description |
|---|---|
| create_page_stream | The page stream creation delegate used to obtain a writable stream for each rendered page. |
| 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. |
from groupdocs.watermark import Watermarker
from groupdocs.watermark.options import PreviewOptions, PreviewFormats
def generate_preview():
# Supply a writable file stream for each page to render
def create_page_stream(page_number):
return open(f"./output-page-{page_number}.png", "wb")
with Watermarker("./sample.pdf") as watermarker:
options = PreviewOptions(create_page_stream)
options.preview_format = PreviewFormats.PNG
options.page_numbers = [1, 2]
watermarker.generate_preview(options)
if __name__ == "__main__":
generate_preview()
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.
