PreviewOptions class Leave feedback
On this page
Provides options to set requirements and stream delegates for preview generation.
The class allows specifying the preview format, image dimensions, page numbers, and delegates that create and optionally release streams for each generated page.
The PreviewOptions type exposes the following members:
| Constructor | Description |
|---|---|
| init | Initializes a new PreviewOptions instance. The output stream will be closed after use. |
| init | Initializes a new PreviewOptions instance, causing the output stream to be returned to the client for further use. |
| Property | Description |
|---|---|
| create_page_stream | The page stream creation delegate. |
| height | The page preview height. |
| page_numbers | The page numbers to generate preview. |
| preview_format | The preview image format. |
| release_page_stream | The page preview completion delegate. |
| width | The page preview width. |
from groupdocs.redaction import Redactor, PreviewOptions
def create_page_stream(page_number: int):
# Create a file for the preview image of the given page
path = f"C:/Temp/page_{page_number}.png"
return open(path, "wb") # returns a writable binary stream
preview_options = PreviewOptions(create_page_stream)
preview_options.preview_format = PreviewOptions.PreviewFormats.PNG
preview_options.height = 640
preview_options.width = 480
preview_options.page_numbers = [1]
with Redactor("C:/Temp/SourceFile.pdf") as redactor:
redactor.generate_preview(preview_options)
- module
groupdocs.redaction.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.
