Groupdocs API References – groupdocs.annotation.models

Python-Net: BorderStyle class

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

BorderStyle class

The BorderStyle type exposes the following members:

Fields

Field	Description
SOLID	Solid border
DASHED	Dashed border
BEVELED	Beveled border
INSET	Inset border
UNDERLINE	Underline border

Guides

Task guides that use BorderStyle:

AI agents and LLM integration

Python-Net: BoxStyle class

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

BoxStyle class

The BoxStyle type exposes the following members:

Fields

Field	Description
CIRCLE	Circle style
CHECK	Check style
CROSS	Cross style
DIAMOND	Diamond style
SQUARE	Square style
STAR	Star style

Guides

Task guides that use BoxStyle:

AI agents and LLM integration

Python-Net: DocumentType class

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

DocumentType class

The DocumentType type exposes the following members:

Fields

Field	Description
PDF	Pdf documen type
CELLS	Excel document type
SLIDES	PowerPoint document type
WORDS	Word document type
IMAGES	Image document type
EMAIL	Email document type
HTML	HTML document type
DIAGRAM	Visio document type
UNDEFINED	The undefined

Python-Net: HorizontalAlignment class

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

HorizontalAlignment class

The HorizontalAlignment type exposes the following members:

Fields

Field	Description
NONE	Default value, aligned wont be used
LEFT	Target will be aligned to left side
CENTER	Target will be aligned to center
RIGHT	Target will be aligned to right side

Guides

Task guides that use HorizontalAlignment:

Python-Net: PageInfo class

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

PageInfo class

Class that defines Document Page Information.

The PageInfo type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of `PageInfo`.

Properties

Property	Description
height	The page height.
page_number	The page number.
text_lines	The collection of text lines information.
width	The page width.

Python-Net: PenStyle class

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

PenStyle class

The PenStyle type exposes the following members:

Fields

Field	Description
SOLID	Specifies a solid line
DASH	Specifies a dashed line
DASH_DOT	Specifies a line consisting of dashes and dots
DOT	Specifies a dotted line
LONG_DASH	Specifies a line consisting of long dashes
DASH_DOT_DOT	Specifies a line consisting of dashes and two dots

Guides

Task guides that use PenStyle:

Add annotations

Python-Net: Point class

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

Point class

Point structure.

The Point type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new Point with the specified coordinates.

Methods

Method	Description
equals	Determines whether the specified point is equal to the current point.
equals_object
get_hash_code	Serves as the default hash function.

Properties

Property	Description
x	The X coordinate value.
y	The Y coordinate value.

Guides

Task guides that use Point:

Python-Net: Rectangle class

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

Rectangle class

Rectangle structure.

The Rectangle type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new Rectangle.

Methods

Method	Description
equals	Determines whether the specified rectangle is equal to the current rectangle.
equals_object
get_hash_code	Serves as the default hash function.

Properties

Property	Description
height	The height of the rectangle.
width	The width of the rectangle.
x	The X coordinate of the rectangle.
y	The Y coordinate of the rectangle.

Guides

Task guides that use Rectangle:

Python-Net: Reply class

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

Reply class

Represents an annotation comment.

The Reply type exposes the following members:

Constructors

Constructor	Description
init

Methods

Method	Description
clone	Returns a new instance with the same values.

Properties

Property	Description
comment	The comment text content.
id	The comment identifier.
parent_reply	The parent comment (in case current one is a reply to the original one).
replied_on	The comment creation date and time.
user	The comment author.

Example

from groupdocs.annotation.models import Reply

# Create a reply and set its comment
reply = Reply()
reply.comment = "Please double-check this"

Guides

Task guides that use Reply:

Python-Net: ResolutionQuality class

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

ResolutionQuality class

The ResolutionQuality type exposes the following members:

Fields

Field	Description
NONE	Default quality
LOW	Allows to create documents of small size with a low image quality
MEDIUM	Allows to create documents of medium size with a good image quality
HIGH	Allows to create documents of big size with a high image quality

Python-Net: Role class

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

Role class

The Role type exposes the following members:

Fields

Field	Description
VIEWER	Viewer can only view comments
EDITOR	Editor can view and edit comments

Guides

Task guides that use Role:

Python-Net: RotationDocument class

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

RotationDocument class

The RotationDocument type exposes the following members:

Fields

Field	Description
NONE	Default one. Document is not rotated.
ON90	Rotate the document 90 degrees
ON180	Rotate the document 180 degrees
ON270	Rotate the document 270 degrees

Guides

Task guides that use RotationDocument:

AI agents and LLM integration

Python-Net: TextLineInfo class

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

TextLineInfo class

Class that defines text line information.

The TextLineInfo type exposes the following members:

Properties

Property	Description
height	The line height.
left_indent	The left indent from left.
text	The line text content.
top_indent	The indent from top.
width	The line width.

Python-Net: User class

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

User class

Class that represents a user.

The User type exposes the following members:

Constructors

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

Properties

Property	Description
email	The user email address.
id	The User identifier.
name	The user name.
role	The role of the user.

Example

from groupdocs.annotation.models import User, Role

user = User(name="Tom", role=Role.EDITOR)

Guides

Task guides that use User:

Python-Net: VersionsList class

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

VersionsList class

Class that defines a serializable list of the document version information.

The VersionsList type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new instance of VersionsList.

Methods

Method	Description
add_version	Add list of the annotations.
add_version	Adds a list of annotations for a version key.
add_version_list
add_version_object
get_last_version_key	Gets the last version key.
get_penultimate_version_key	Retrieves the penultimate version key.
get_version	.
get_version	.
get_version_key_by_value	.
get_version_key_by_value_list
get_version_object
replace_last_version	.
replace_last_version_list

Properties

Property	Description
version	The current version.
versions_dictionary	The versions dictionary.

Python-Net: VerticalAlignment class

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

VerticalAlignment class

The VerticalAlignment type exposes the following members:

Fields

Field	Description
NONE	Default value, aligned wont be used
TOP	Target will be aligned to top side
CENTER	Target will be aligned to center
BOTTOM	Target will be aligned to bottom side

Guides

Task guides that use VerticalAlignment:

Groupdocs API References – groupdocs.annotation.models

Python-Net: BorderStyle class

BorderStyle class

Fields

Guides

See Also

Python-Net: BoxStyle class

BoxStyle class

Fields

Guides

See Also

Python-Net: DocumentType class

DocumentType class

Fields

See Also

Python-Net: HorizontalAlignment class

HorizontalAlignment class

Fields

Guides

See Also

Python-Net: PageInfo class

PageInfo class

Constructors

Properties

See Also

Python-Net: PenStyle class

PenStyle class

Fields

Guides

See Also

Python-Net: Point class

Point class

Constructors

Methods

Properties

Guides

See Also

Python-Net: Rectangle class

Rectangle class

Constructors

Methods

Properties

Guides

See Also

Python-Net: Reply class

Reply class

Constructors

Methods

Properties

Example

Guides

See Also

Python-Net: ResolutionQuality class

ResolutionQuality class

Fields

See Also

Python-Net: Role class

Role class

Fields

Guides

See Also

Python-Net: RotationDocument class

RotationDocument class

Fields

Guides

See Also

Python-Net: TextLineInfo class

TextLineInfo class

Properties

See Also

Python-Net: User class

User class

Constructors

Properties

Example

Guides

See Also

Python-Net: VersionsList class

VersionsList class

Constructors