Groupdocs API References – groupdocs.annotation

Python-Net: Annotator class

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

Annotator class

The Annotator class is the central component of the GroupDocs.Annotation API, designed to manage and facilitate the document annotation process across various formats.

Learn more

More about GroupDocs.Annotation features: GroupDocs.Annotation Developer Guide (https://docs.groupdocs.com/display/annotationnet/Developer+Guide)

The Annotator type exposes the following members:

Constructors

Constructor	Description
init	Initializes annotator class which accepts a document path.
init	Initializes annotator class which accepts document path and options.
init	Initializes annotator class which accepts document path and settings.
init	Initializes annotator class which accept document path, options and settings.
init	Initializes annotator class which accepts a document stream.
init	Initializes annotator class which accepts a document stream and options.
init	Initializes annotator class which accepts a document stream and settings.
init	Initializes annotator class which accepts a document stream, load options, and settings.

Methods

Method	Description
add	Adds annotation to document.
add	Adds a collection of annotations to a document.
add_annotation_base
add_list
dispose	Dispose.
export_annotations_to_xml_file	Exports annotations from the document to an XML file.
export_annotations_to_xml_file_file
export_annotations_to_xml_file_string
get	Gets collections of document annotations.
get	Returns a collection of document annotations filtered by the specified annotation type.
get_annotation_type
get_version	Retrieves annotations from a specific version.
get_version_object
get_versions_list	Retrieves the list of versions.
import_annotations_from_xml_file	Export annotations from XML file.
import_annotations_from_xml_file_file
import_annotations_from_xml_file_string
remove	Removes an annotation from the document by its identifier.
remove	Removes an annotation from the document.
remove	Removes a collection of annotations from the document using the provided annotation IDs.
remove	Removes collection of annotations from document.
remove_annotation_base
remove_int32
remove_list
save	Saves document after adding, updating or removing annotations.
save	Saves the document after adding, updating, or removing annotations.
save	Saves document after adding, updating or removing annotations.
save	Saves the document after adding, updating, or removing annotations.
save	Saves document after adding, updating or removing annotations.
save	Saves document after adding, updating or removing annotations.
save_file
save_save_options
save_stream
save_streams
save_string
update	Updates document annotation by id.
update	Updates collection of document annotations by overriding the previous list with a new one.
update_annotation_base
update_list

Properties

Property	Description
document	The document contains various information about the uploaded document.
process_pages	The count of processed pages.
rotation	The document rotation angle.

Example

from groupdocs.annotation import Annotator

def export_annotations_to_xml():
    with Annotator("./annotated.pdf") as annotator:
        annotator.export_annotations_to_xml_file(output_path="./exported_annotations.xml")
    print("Exported annotations to ./exported_annotations.xml.")

Guides

Task guides that use Annotator:

Python-Net: AnnotatorException class

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

AnnotatorException class

An error that occur during the document annotation process.

The AnnotatorException type exposes the following members:

Python-Net: AnnotatorSettings class

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

AnnotatorSettings class

Defines settings for customizing Annotator behavior.

The AnnotatorSettings type exposes the following members:

Constructors

Constructor	Description
init

Properties

Property	Description
cache	The cache.
logger	The logger.

Guides

Task guides that use AnnotatorSettings:

AI agents and LLM integration

Python-Net: ConvertFileException class

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

ConvertFileException class

The exception that is thrown if file conversion failed.

The ConvertFileException type exposes the following members:

Python-Net: CorruptedOrDamagedFileException class

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

CorruptedOrDamagedFileException class

The exception that is thrown when file is corrupted or damaged.

The CorruptedOrDamagedFileException type exposes the following members:

Python-Net: Document class

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

Document class

Represents various document properties.

The Document type exposes the following members:

Constructors

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

Methods

Method	Description
add_image_to_document	Change image quality and add image to document.
add_image_to_document_file
add_image_to_document_string
generate_preview	Generates document pages preview (screenshots of every page).
generate_preview_preview_options
get_document_info	Retrieves information about the document, including its type, size, page count, and detailed page data.

Properties

Property	Description
name	The document name.
password	The document password.
stream	The document stream.

Guides

Task guides that use Document:

AI agents and LLM integration

Python-Net: FileType class

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

FileType class

Information about file, such as type, extension, etc.

The FileType type exposes the following members:

Methods

Method	Description
equals	File type equivalence check.
equals	Equivalence check with object.
equals_file_type
equals_object
from_file_name_or_extension	Return FileType based on file name or extension.
get_hash_code	Get hash code.
get_supported_file_types	Get supported file types enumeration.
to_string	Returns a string that represents the file type.

Properties

Property	Description
extension	The file extension.
file_format	The file format.

Example

from groupdocs.annotation import FileType

# Retrieve a list of all supported file types
supported = FileType.get_supported_file_types()
print(supported)

Python-Net: FileTypeNotSupportedException class

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

FileTypeNotSupportedException class

The exception that is thrown when file type is not supported.

The FileTypeNotSupportedException type exposes the following members:

Python-Net: GroupDocsAnnotationException class

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

GroupDocsAnnotationException class

Product-root exception for ‘annotation’ — every

generated exception subclasses this, and callers can except GroupDocsAnnotationException: as a catch-all for this product without catching other GroupDocs errors.

The GroupDocsAnnotationException type exposes the following members:

Python-Net: IDocumentInfo class

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

IDocumentInfo class

Interface that defines list of available document information.

The IDocumentInfo type exposes the following members:

Properties

Property	Description
file_type	The document file type.
page_count	The amount of pages.
pages_info	The list of information about each page.
size	The file size in bytes.

Python-Net: IOException class

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

IOException class

The exception that is thrown when trying to apply format-specific annotation to the wrong file type.

The IOException type exposes the following members:

Python-Net: ImageNotLoadedException class

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

ImageNotLoadedException class

The exception that is thrown when image cannot be loaded from remote or local path. Usually happens if the provided “path” is incorrect.

The ImageNotLoadedException type exposes the following members:

Python-Net: License class

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

License class

Manages GroupDocs.Annotation licensing.

Licensed builds unlock the full feature set of the wrapper at runtime. Unlicensed builds run in evaluation mode with the same API surface but with limits on output size and watermarked content.

The License type exposes the following members:

Methods

Method	Description
set_license	Apply a license to the current process.

Guides

Task guides that use License:

Python-Net: Metered class

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

Metered class

Manages metered (pay-per-use) licensing.

Metered licenses bill on actual consumption (typically pages or documents processed). Set the public/private key pair once at application startup; the wrapper reports usage back to the GroupDocs license server in the background.

The Metered type exposes the following members:

Methods

Method	Description
get_consumption_credit	Return the remaining metered credit for the current key.
get_consumption_quantity	Return the total metered quantity consumed so far.
set_metered_key	Activate metered billing with the given public/private key pair.

Guides

Task guides that use Metered:

Python-Net: PasswordProtectedFileException class

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

PasswordProtectedFileException class

The exception that is thrown when provided password is incorrect.

The PasswordProtectedFileException type exposes the following members:

Groupdocs API References – groupdocs.annotation

Python-Net: Annotator class

Annotator class

Constructors

Methods

Properties

Example

Guides

See Also

Python-Net: AnnotatorException class

AnnotatorException class

See Also

Python-Net: AnnotatorSettings class

AnnotatorSettings class

Constructors

Properties

Guides

See Also

Python-Net: ConvertFileException class

ConvertFileException class

See Also

Python-Net: CorruptedOrDamagedFileException class

CorruptedOrDamagedFileException class

See Also

Python-Net: Document class

Document class

Constructors

Methods

Properties

Guides

See Also

Python-Net: FileType class

FileType class

Methods

Properties

Example

See Also

Python-Net: FileTypeNotSupportedException class

FileTypeNotSupportedException class

See Also

Python-Net: GroupDocsAnnotationException class

GroupDocsAnnotationException class

See Also

Python-Net: IDocumentInfo class

IDocumentInfo class

Properties

See Also

Python-Net: IOException class

IOException class

See Also

Python-Net: ImageNotLoadedException class

ImageNotLoadedException class

See Also

Python-Net: License class

License class

Methods

Guides

See Also

Python-Net: Metered class

Metered class

Methods

Guides

See Also

Python-Net: PasswordProtectedFileException class

PasswordProtectedFileException class

See Also