Groupdocs API References – Document class

Python-Net: init constructor

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

init

Initializes a new instance of Document class.

def __init__(self, stream):
    ...

Parameter	Type	Description
stream	`io.RawIOBase`	The document stream.

init

Initializes a new Document instance.

def __init__(self, stream, password):
    ...

Parameter	Type	Description
stream	`io.RawIOBase`	The document stream.
password	`str`	The document password.

Python-Net: add_image_to_document method

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

add_image_to_document

Change image quality and add image to document.

def add_image_to_document(self, data_dir, jpg_file_name, page_number, image_quality):
    ...

Parameter	Type	Description
data_dir	`str`	Specify the path to the input PDF file.
jpg_file_name	`str`	The path to the JPG file.
page_number	`int`	Page where the image will be inserted.
image_quality	`int`	Set image quality from 1 to 100, 1 is the smallest resolution, 100 is the largest.

Python-Net: add_image_to_document_file method

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

add_image_to_document_file

def add_image_to_document_file(self):
    ...

Python-Net: add_image_to_document_string method

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

add_image_to_document_string

def add_image_to_document_string(self):
    ...

Python-Net: generate_preview method

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

generate_preview

Generates document pages preview (screenshots of every page).

def generate_preview(self, preview_options):
    ...

Parameter	Type	Description
preview_options	`PreviewOptions`	The document preview options

Example

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


if __name__ == "__main__":
    generate_document_preview()

Python-Net: generate_preview_preview_options method

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

generate_preview_preview_options

def generate_preview_preview_options(self):
    ...

Python-Net: get_document_info method

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

get_document_info

Retrieves information about the document, including its type, size, page count, and detailed page data.

def get_document_info(self):
    ...

Example

with Annotator("document.pdf") as annotator:
    info = annotator.document.get_document_info()
    print(info.file_type.file_format, info.page_count, info.size)

Python-Net: name property

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

name property

The document name.

Definition:

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

Python-Net: password property

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

password property

The document password.

Definition:

@property
def password(self):
    ...

Python-Net: stream property

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

stream property

The document stream.

Definition:

@property
def stream(self):
    ...

Groupdocs API References – Document class

Python-Net: init constructor

init

init

See Also

Python-Net: add_image_to_document method

add_image_to_document

See Also

Python-Net: add_image_to_document_file method

add_image_to_document_file

See Also

Python-Net: add_image_to_document_string method

add_image_to_document_string

See Also

Python-Net: generate_preview method

generate_preview

Example

See Also

Python-Net: generate_preview_preview_options method

generate_preview_preview_options

See Also

Python-Net: get_document_info method

get_document_info

Example

See Also

Python-Net: name property

name property

Definition:

See Also

Python-Net: password property

password property

Definition:

See Also

Python-Net: stream property

stream property

Definition:

See Also

Groupdocs API References – Document class

Python-Net: __init__ constructor

init

init

See Also

Python-Net: add_image_to_document method

add_image_to_document

See Also

Python-Net: add_image_to_document_file method

add_image_to_document_file

See Also

Python-Net: add_image_to_document_string method

add_image_to_document_string

See Also

Python-Net: generate_preview method

generate_preview

Example

See Also

Python-Net: generate_preview_preview_options method

generate_preview_preview_options

See Also

Python-Net: get_document_info method

get_document_info

Example

See Also

Python-Net: name property

name property

Definition:

See Also

Python-Net: password property

password property

Definition:

See Also

Python-Net: stream property

stream property

Definition:

See Also

Python-Net: init constructor