Groupdocs API References – PreviewOptions class

Python-Net: init constructor

Mon, 01 Jan 0001 00:00:00 +0000

init

Initializes a new instance of PreviewOptions class.

def __init__(self, create_page_stream):
    ...

Parameter	Type	Description
create_page_stream	`CreatePageStream`	Callable that defines method to create output page preview stream.

Example

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}.")

init

Initializes a new PreviewOptions instance.

def __init__(self, create_page_stream, release_page_stream):
    ...

Parameter	Type	Description
create_page_stream	`CreatePageStream`	Delegate which defines method to create output page preview stream.
release_page_stream	`ReleasePageStream`	Delegate which defines method to release output page preview stream.

Example

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}.")

Python-Net: create_page_stream property

Mon, 01 Jan 0001 00:00:00 +0000

create_page_stream property

The delegate that defines a method to create an output page preview stream.

The callable should accept a page number (int) and return a writable stream (io.RawIOBase).

Definition:

@property
def create_page_stream(self):
    ...
@create_page_stream.setter
def create_page_stream(self, value):
    ...

Python-Net: height property

Mon, 01 Jan 0001 00:00:00 +0000

height property

The page preview height.

Definition:

@property
def height(self):
    ...
@height.setter
def height(self, value):
    ...

Python-Net: page_numbers property

Mon, 01 Jan 0001 00:00:00 +0000

page_numbers property

The page numbers that will be previewed.

Definition:

@property
def page_numbers(self):
    ...
@page_numbers.setter
def page_numbers(self, value):
    ...

Python-Net: preview_format property

Mon, 01 Jan 0001 00:00:00 +0000

preview_format property

The preview image format.

Definition:

@property
def preview_format(self):
    ...
@preview_format.setter
def preview_format(self, value):
    ...

Python-Net: release_page_stream property

Mon, 01 Jan 0001 00:00:00 +0000

release_page_stream property

The delegate which defines method to remove output page preview stream.

Definition:

@property
def release_page_stream(self):
    ...
@release_page_stream.setter
def release_page_stream(self, value):
    ...

Python-Net: render_annotations property

Mon, 01 Jan 0001 00:00:00 +0000

render_annotations property

The property that controls whether annotations will be generated on the preview (default is True).

Definition:

@property
def render_annotations(self):
    ...
@render_annotations.setter
def render_annotations(self, value):
    ...

Python-Net: render_comments property

Mon, 01 Jan 0001 00:00:00 +0000

render_comments property

The property that controls whether comments will be generated on the preview; default is True and it is supported only in MS Word documents.

Definition:

@property
def render_comments(self):
    ...
@render_comments.setter
def render_comments(self, value):
    ...

Python-Net: resolution property

Mon, 01 Jan 0001 00:00:00 +0000

resolution property

The resolution for generated images, in dots per inch.

The default value is 96.

Definition:

@property
def resolution(self):
    ...
@resolution.setter
def resolution(self, value):
    ...

Python-Net: width property

Mon, 01 Jan 0001 00:00:00 +0000

width property

The page preview width.

Definition:

@property
def width(self):
    ...
@width.setter
def width(self, value):
    ...

Python-Net: worksheet_columns property

Mon, 01 Jan 0001 00:00:00 +0000

worksheet_columns property

The worksheet columns to generate. Generation proceeds in the specified order.

Definition:

@property
def worksheet_columns(self):
    ...
@worksheet_columns.setter
def worksheet_columns(self, value):
    ...

Groupdocs API References – PreviewOptions class

Python-Net: __init__ constructor

init

Example

init

Example

See Also

Python-Net: create_page_stream property

create_page_stream property

Definition:

See Also

Python-Net: height property

height property

Definition:

See Also

Python-Net: page_numbers property

page_numbers property

Definition:

See Also

Python-Net: preview_format property

preview_format property

Definition:

See Also

Python-Net: release_page_stream property

release_page_stream property

Definition:

See Also

Python-Net: render_annotations property

render_annotations property

Definition:

See Also

Python-Net: render_comments property

render_comments property

Definition:

See Also

Python-Net: resolution property

resolution property

Definition:

See Also

Python-Net: width property

width property

Definition:

See Also

Python-Net: worksheet_columns property

worksheet_columns property

Definition:

See Also

Python-Net: init constructor