Groupdocs API References – groupdocs.annotation.options

Python-Net: AnnotationType class

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

AnnotationType class

The AnnotationType type exposes the following members:

Fields

Field	Description
NONE	Default value
AREA	The area annotation type that highlights rectangular area within the document page
ARROW	The annotation type that draws an arrow on the document page
DISTANCE	The annotation type that measures distance between elements of a document page
ELLIPSE	The annotation of elliptic form that marks parts of document content
LINK	The annotation type that represents a hyperlink to a remote resource
POINT	The point annotation type that sticks a comment to an any place within document page
POLYLINE	The polyline annotation type that allows add drawing shapes and freehand lines to a document page
RESOURCES_REDACTION	The annotation type that hides textual content behind black rectangle
TEXT_FIELD	The text field annotation type represents textual comment inside colored frame
TEXT_HIGHLIGHT	The annotation type that highlights and comments selected text
TEXT_REDACTION	The annotation type that fills part of selected text with black rectangle.
TEXT_REPLACEMENT	The annotation type that replaces original text with other provided text fragment
TEXT_STRIKEOUT	The annotation type that marks text fragment with a strikethrough styling
TEXT_SQUIGGLY	The annotation type that squiggly and comments selected text
SEARCH_TEXT	The annotation type that search fragment text in document
TEXT_UNDERLINE	The annotation type that marks text with a underline styling
WATERMARK	The annotation type that adds textual watermark over document page
IMAGE	The annotation type that adds image overlay over document page content
DROPDOWN	The component type that adds dropdown component for pdf document only
CHECKBOX	The annotation type that adds checkbox for pdf document
BUTTON	The annotation type that adds button for pdf document
ALL	All

Guides

Task guides that use AnnotationType:

Python-Net: CreatePageStream class

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

CreatePageStream class

Delegate that defines method to create output page preview stream.

The CreatePageStream type exposes the following members:

Constructors

Constructor	Description
init

Methods

Method	Description
begin_invoke
begin_invoke_int32
end_invoke
end_invoke_iasync_result
invoke
invoke_int32

Python-Net: LoadOptions class

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

LoadOptions class

Allows to specify additional options (such as password) when opening a document to annotate.

The LoadOptions type exposes the following members:

Constructors

Constructor	Description
init

Properties

Property	Description
font_directories	The list of font directories to load custom fonts from.
password	The document password.
version	The version of the document to load. Default is the latest version.

Example

from groupdocs.annotation import Annotator
from groupdocs.annotation.options import LoadOptions
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import AreaAnnotation
from groupdocs.pydrawing import Color


def load_password_protected_document():
    # Provide the password through LoadOptions
    load_options = LoadOptions()
    load_options.password = "secret"

    with Annotator("./protected.docx", load_options=load_options) as annotator:
        area = AreaAnnotation()
        area.box = Rectangle(100, 100, 100, 100)
        area.background_color = Color.yellow.to_argb()
        area.page_number = 0
        area.message = "Annotated a password-protected document"
        annotator.add(area)
        annotator.save("./output.docx")

Guides

Task guides that use LoadOptions:

Python-Net: PreviewFormats class

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

PreviewFormats class

The PreviewFormats type exposes the following members:

Fields

Field	Description
PNG	Png (by default), can be take a lot of disc space / traffic if page contains a lot of color graphics
JPEG	Jpeg - faster processing, small disc space using / traffic, but can be worst quality
BMP	BMP - slow processing, high disc space usage / traffic, but best quality

Guides

Task guides that use PreviewFormats:

Generate document preview

Python-Net: PreviewOptions class

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

PreviewOptions class

The class represents document preview options.

The PreviewOptions type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of `PreviewOptions` class.
init	Initializes a new PreviewOptions instance.

Properties

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.

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

Guides

Task guides that use PreviewOptions:

Generate document preview

Python-Net: ReleasePageStream class

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

ReleasePageStream class

Delegate that defines method to release output page preview stream.

The ReleasePageStream type exposes the following members:

Constructors

Constructor	Description
init

Methods

Method	Description
begin_invoke
begin_invoke_int32
begin_invoke_stream
begin_invoke_streams
end_invoke
end_invoke_iasync_result
invoke
invoke_int32
invoke_stream
invoke_streams

Python-Net: SaveOptions class

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

SaveOptions class

Allows to specify additional options (such as password) when saving an annotated document.

The SaveOptions type exposes the following members:

Constructors

Constructor	Description
init

Properties

Property	Description
annotation_types	The annotations that will be in the resultant document.
first_page	The first page number when saving a page range.
last_page	The last page number when saving a page range.
only_annotated_pages	The property indicates whether to save only annotated pages.
version	The version key that will be used to access the current version.

Example

from groupdocs.annotation import Annotator
from groupdocs.annotation.options import SaveOptions, AnnotationType

with Annotator("document.pdf") as annotator:
    options = SaveOptions()
    options.annotation_types = AnnotationType.AREA
    options.first_page = 1
    options.last_page = 2
    annotator.save("filtered.pdf", save_options=options)

Guides

Task guides that use SaveOptions:

Python-Net: WorksheetColumnsRange class

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

WorksheetColumnsRange class

Represents a range of columns for a specified worksheet.

The WorksheetColumnsRange type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of `WorksheetColumnsRange`.
init	Initializes a new instance of `WorksheetColumnsRange` class.

Groupdocs API References – groupdocs.annotation.options

Python-Net: AnnotationType class

AnnotationType class

Fields

Guides

See Also

Python-Net: CreatePageStream class

CreatePageStream class

Constructors

Methods

See Also

Python-Net: LoadOptions class

LoadOptions class

Constructors

Properties

Example

Guides

See Also

Python-Net: PreviewFormats class

PreviewFormats class

Fields

Guides

See Also

Python-Net: PreviewOptions class

PreviewOptions class

Constructors

Properties

Example

Guides

See Also

Python-Net: ReleasePageStream class

ReleasePageStream class

Constructors

Methods

See Also

Python-Net: SaveOptions class

SaveOptions class

Constructors

Properties

Example

Guides

See Also

Python-Net: WorksheetColumnsRange class

WorksheetColumnsRange class

Constructors

See Also