PreviewOptions class
Leave feedback
On this page
The class represents document preview options.
The PreviewOptions type exposes the following members:
| Constructor | Description |
|---|---|
| init | Initializes a new instance of PreviewOptions class. |
| init | Initializes a new PreviewOptions instance. |
| Property | Description |
|---|---|
| create_page_stream | The delegate that defines a method to create an output page preview stream. |
| height | The page preview height. |
| page_numbers | The page numbers that will be previewed. |
| preview_format | The preview image format. |
| release_page_stream | The delegate which defines method to remove output page preview stream. |
| render_annotations | The property that controls whether annotations will be generated on the preview (default is True). |
| render_comments | The property that controls whether comments will be generated on the preview; default is True and it is supported only in MS Word documents. |
| resolution | The resolution for generated images, in dots per inch. |
| width | The page preview width. |
| worksheet_columns | The worksheet columns to generate. Generation proceeds in the specified order. |
import os
from groupdocs.annotation import Annotator
from groupdocs.annotation.options import PreviewOptions, PreviewFormats
def generate_document_preview():
output_dir = "./preview"
os.makedirs(output_dir, exist_ok=True)
open_streams = {}
def create_page_stream(page_number):
stream = open(os.path.join(output_dir, f"page_{page_number}.png"), "wb")
open_streams[page_number] = stream
return stream
def release_page_stream(page_number, page_stream):
stream = open_streams.pop(page_number, None)
if stream:
stream.close()
with Annotator("./sample.pdf") as annotator:
preview_options = PreviewOptions(create_page_stream, release_page_stream)
preview_options.preview_format = PreviewFormats.PNG
preview_options.page_numbers = [1]
annotator.document.generate_preview(preview_options)
print(f"Generated page preview image(s) in {output_dir}.")
Task guides that use PreviewOptions:
- module
groupdocs.annotation.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.