Groupdocs API References – groupdocs.annotation.models.annotation_models

Python-Net: AnnotationBase class

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

AnnotationBase class

Base class for all annotation types. Contains basic annotation information.

The AnnotationBase type exposes the following members:

Methods

Method	Description
clone	Returns new instance with the same values.
equals	Compares base annotations using the IEquatable Equals method.
equals	Compares base annotations using the standard object `Equals` method.
equals_annotation_base
equals_object
get_hash_code	Returns HashCode of AnnotationBase Message, PageNumber and Type Properties.

Properties

Property	Description
created_on	The annotation creation date.
id	The annotation unique identifier. This field is auto-incremented.
message	The annotation message.
page_number	The page number where the annotation should be located.
replies	The list of replies (comments) attached to the annotation.
state_before_annotation	The previous state of the text before annotating.
type	The annotation type.
user	The annotation author.

Guides

Task guides that use AnnotationBase:

AI agents and LLM integration

Python-Net: AreaAnnotation class

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

AreaAnnotation class

Represents area annotation properties.

Learn more

More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
More about adding area annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+area+annotation

The AreaAnnotation type exposes the following members:

Constructors

Constructor	Description
init	Initializes new instance of `AreaAnnotation` class.

Methods

Method	Description
clone	Returns a new instance of the area annotation with the same values.
equals	Compares area annotation using the IEquatable `Equals` method.
equals	Compares area annotation using the standard object Equals method.
equals_area_annotation
equals_object
get_hash_code	Returns the hash code of the AreaAnnotation instance.
equals_annotation_base	(inherited from `AnnotationBase`)

Properties

Property	Description
background_color	The background color of the area annotation.
box	The area annotation position.
opacity	The opacity of the area annotation.
pen_color	The pen color of the area annotation.
pen_style	The pen style of the area annotation.
pen_width	The pen width of the area annotation.
created_on	The annotation creation date. (inherited from `AnnotationBase`)
id	The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`)
message	The annotation message. (inherited from `AnnotationBase`)
page_number	The page number where the annotation should be located. (inherited from `AnnotationBase`)
replies	The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`)
state_before_annotation	The previous state of the text before annotating. (inherited from `AnnotationBase`)
type	The annotation type. (inherited from `AnnotationBase`)
user	The annotation author. (inherited from `AnnotationBase`)

Example

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

area = AreaAnnotation()
area.box = Rectangle(100, 100, 200, 80)
area.background_color = Color.yellow.to_argb()
area.pen_color = Color.red.to_argb()
area.opacity = 0.7
area.page_number = 0
area.message = "Flagged region"

with Annotator("document.pdf") as annotator:
    annotator.add(area)
    annotator.save("annotated.pdf")

Guides

Task guides that use AreaAnnotation:

Python-Net: ArrowAnnotation class

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

ArrowAnnotation class

Represents arrow annotation properties.

Learn more

More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
More about adding arrow annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+arrow+annotation

The ArrowAnnotation type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new `ArrowAnnotation` instance.

Methods

Method	Description
clone	Returns new instance with same values.
equals	Compares area annotation using IEquatable Equals method.
equals	Compares arrow annotation using standard object Equals method.
equals_arrow_annotation
equals_object
get_hash_code	Returns HashCode of the arrow annotation.
equals_annotation_base	(inherited from `AnnotationBase`)

Properties

Property	Description
box	The arrow annotation position.
opacity	The opacity of the arrow annotation.
pen_color	The arrow annotation pen color.
pen_style	The pen style of the arrow annotation.
pen_width	The pen width of the arrow annotation.
created_on	The annotation creation date. (inherited from `AnnotationBase`)
id	The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`)
message	The annotation message. (inherited from `AnnotationBase`)
page_number	The page number where the annotation should be located. (inherited from `AnnotationBase`)
replies	The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`)
state_before_annotation	The previous state of the text before annotating. (inherited from `AnnotationBase`)
type	The annotation type. (inherited from `AnnotationBase`)
user	The annotation author. (inherited from `AnnotationBase`)

Example

from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, PenStyle
from groupdocs.annotation.models.annotation_models import ArrowAnnotation
from groupdocs.pydrawing import Color

def add_arrow_annotation():
    with Annotator("./sample.pdf") as annotator:
        arrow = ArrowAnnotation()
        arrow.box = Rectangle(100, 100, 100, 100)
        arrow.pen_color = Color.blue.to_argb()
        arrow.pen_width = 2
        arrow.pen_style = PenStyle.SOLID
        arrow.opacity = 0.9
        arrow.page_number = 0
        arrow.message = "This is an arrow annotation"
        annotator.add(arrow)
        annotator.save("./output.pdf")

Guides

Task guides that use ArrowAnnotation:

Python-Net: DistanceAnnotation class

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

DistanceAnnotation class

Represents distance annotation properties.

Learn more:

More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: How to annotate documents using GroupDocs.Annotation for .NET
More about adding distance annotations to documents of various types: How to add distance annotations in C#

The DistanceAnnotation type exposes the following members:

Constructors

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

Methods

Method	Description
clone	Returns a new instance with the same values.
equals	Compares this distance annotation with another using the IEquatable Equals method.
equals	Compares distance annotation using standard object Equals method.
equals_distance_annotation
equals_object
get_hash_code	Returns HashCode of the distance annotation.
equals_annotation_base	(inherited from `AnnotationBase`)

Properties

Property	Description
box	The distance annotation position.
opacity	The opacity of the distance annotation.
pen_color	The pen color of the distance annotation.
pen_style	The pen style of the distance annotation.
pen_width	The distance annotation pen width.
created_on	The annotation creation date. (inherited from `AnnotationBase`)
id	The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`)
message	The annotation message. (inherited from `AnnotationBase`)
page_number	The page number where the annotation should be located. (inherited from `AnnotationBase`)
replies	The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`)
state_before_annotation	The previous state of the text before annotating. (inherited from `AnnotationBase`)
type	The annotation type. (inherited from `AnnotationBase`)
user	The annotation author. (inherited from `AnnotationBase`)

Example

from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, PenStyle
from groupdocs.annotation.models.annotation_models import DistanceAnnotation
from groupdocs.pydrawing import Color

def add_distance_annotation():
    with Annotator("./sample.pdf") as annotator:
        distance = DistanceAnnotation()
        distance.box = Rectangle(100, 100, 100, 100)
        distance.pen_color = Color.blue.to_argb()
        distance.pen_width = 2
        distance.pen_style = PenStyle.SOLID
        distance.opacity = 0.7
        distance.page_number = 0
        distance.message = "This is a distance annotation"
        annotator.add(distance)
        annotator.save("./output.pdf")

Guides

Task guides that use DistanceAnnotation:

Python-Net: EllipseAnnotation class

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

EllipseAnnotation class

Represents ellipse annotation properties.

Learn more

More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
More about adding ellipse annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+ellipse+annotation

The EllipseAnnotation type exposes the following members:

Constructors

Constructor	Description
init	Initializes new instance of `EllipseAnnotation` class.

Methods

Method	Description
clone	Returns a new instance with the same values.
equals	Compares this ellipse annotation with another using the IEquatable Equals method.
equals	Compares the ellipse annotation with another object using the standard object Equals method.
equals_ellipse_annotation
equals_object
get_hash_code	Returns the hash code of the ellipse annotation.
equals_annotation_base	(inherited from `AnnotationBase`)

Properties

Property	Description
background_color	The background color of the ellipse annotation.
box	The ellipse annotation position.
opacity	The opacity of the annotation.
pen_color	The pen color of the ellipse annotation.
pen_style	The pen style of the ellipse annotation.
pen_width	The pen width of the ellipse annotation.
created_on	The annotation creation date. (inherited from `AnnotationBase`)
id	The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`)
message	The annotation message. (inherited from `AnnotationBase`)
page_number	The page number where the annotation should be located. (inherited from `AnnotationBase`)
replies	The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`)
state_before_annotation	The previous state of the text before annotating. (inherited from `AnnotationBase`)
type	The annotation type. (inherited from `AnnotationBase`)
user	The annotation author. (inherited from `AnnotationBase`)

Example

from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, PenStyle
from groupdocs.annotation.models.annotation_models import EllipseAnnotation
from groupdocs.pydrawing import Color


def add_ellipse_annotation():
    with Annotator("./sample.pdf") as annotator:
        ellipse = EllipseAnnotation()
        ellipse.box = Rectangle(100, 100, 200, 120)
        ellipse.background_color = Color.from_argb(255, 144, 238, 144).to_argb()
        ellipse.pen_color = Color.green.to_argb()
        ellipse.pen_width = 2
        ellipse.pen_style = PenStyle.SOLID
        ellipse.opacity = 0.7
        ellipse.page_number = 0
        ellipse.message = "This is an ellipse annotation"
        annotator.add(ellipse)
        annotator.save("./output.pdf")


if __name__ == "__main__":
    add_ellipse_annotation()

Guides

Task guides that use EllipseAnnotation:

Python-Net: HighlightAnnotation class

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

HighlightAnnotation class

Represents highlight annotation properties.

Learn more

More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
More about adding highlight annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+highlight+annotation

The HighlightAnnotation type exposes the following members:

Constructors

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

Methods

Method	Description
clone	Returns a new instance with the same values.
equals	Compares highlight annotation using IEquatable Equals method.
equals	Compares highlight annotations using the standard object `Equals` method.
equals_highlight_annotation
equals_object
get_hash_code	Returns the hash code of the highlight annotation.
equals_annotation_base	(inherited from `AnnotationBase`)

Properties

Property	Description
background_color	The background color of the highlight annotation as an ARGB integer.
font_color	The highlight annotation text font color.
opacity	The opacity of the highlight annotation.
points	The collection of `Point` objects that describe rectangles with text.
created_on	The annotation creation date. (inherited from `AnnotationBase`)
id	The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`)
message	The annotation message. (inherited from `AnnotationBase`)
page_number	The page number where the annotation should be located. (inherited from `AnnotationBase`)
replies	The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`)
state_before_annotation	The previous state of the text before annotating. (inherited from `AnnotationBase`)
type	The annotation type. (inherited from `AnnotationBase`)
user	The annotation author. (inherited from `AnnotationBase`)

Example

from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import HighlightAnnotation
from groupdocs.pydrawing import Color


def add_highlight_annotation():
    with Annotator("./sample.pdf") as annotator:
        highlight = HighlightAnnotation()
        # Text-markup annotations are positioned by the corner points of the
        # text region: top-left, top-right, bottom-left, bottom-right
        highlight.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        highlight.background_color = Color.yellow.to_argb()
        highlight.opacity = 0.7
        highlight.page_number = 0
        highlight.message = "This is a highlight annotation"
        annotator.add(highlight)
        annotator.save("./output.pdf")

Guides

Task guides that use HighlightAnnotation:

Python-Net: ImageAnnotation class

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

ImageAnnotation class

Represents image annotation properties.

Learn more

More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
More about adding image annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+image+annotation

The ImageAnnotation type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new ImageAnnotation instance.

Methods

Method	Description
clone	Returns a new instance with the same values.
equals	Compares image annotation using IEquatable Equals method.
equals	Compares image annotation using standard object Equals method.
equals_image_annotation
equals_object
get_hash_code	Returns the hash code of the image annotation.
get_image	Gets image object.
equals_annotation_base	(inherited from `AnnotationBase`)

Properties

Property	Description
angle	The image annotation rotation angle.
box	The image annotation position.
image_data	The image annotation data.
image_extension	The image extensions (png, jpg, svg etc).
image_path	The image annotation path.
opacity	The opacity of the image annotation.
zindex	The image annotation z-index. Default value is 0.
created_on	The annotation creation date. (inherited from `AnnotationBase`)
id	The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`)
message	The annotation message. (inherited from `AnnotationBase`)
page_number	The page number where the annotation should be located. (inherited from `AnnotationBase`)
replies	The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`)
state_before_annotation	The previous state of the text before annotating. (inherited from `AnnotationBase`)
type	The annotation type. (inherited from `AnnotationBase`)
user	The annotation author. (inherited from `AnnotationBase`)

Example

from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import ImageAnnotation


def add_image_annotation():
    with Annotator("./sample.pdf") as annotator:
        image = ImageAnnotation()
        image.box = Rectangle(100, 100, 100, 100)
        image.image_path = "./stamp.png"
        image.opacity = 0.9
        image.angle = 0.0
        image.page_number = 0
        image.message = "This is an image annotation"
        annotator.add(image)
        annotator.save("./output.pdf")


if __name__ == "__main__":
    add_image_annotation()

Guides

Task guides that use ImageAnnotation:

Python-Net: LinkAnnotation class

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

LinkAnnotation class

Represents link annotation properties.

Learn more

More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
More about adding link annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+link+annotation

The LinkAnnotation type exposes the following members:

Constructors

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

Methods

Method	Description
clone	Returns a new instance with the same values.
equals	Compares this link annotation with another using the IEquatable Equals method.
equals	Compares link annotation using standard object Equals method.
equals_link_annotation
equals_object
get_hash_code	Returns HashCode of link annotation.
equals_annotation_base	(inherited from `AnnotationBase`)

Properties

Property	Description
background_color	The background color of the link annotation.
font_color	The text color of the link annotation.
opacity	The opacity of the link annotation.
points	The link annotation coordinates as a list of points.
url	The annotation link URL.
created_on	The annotation creation date. (inherited from `AnnotationBase`)
id	The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`)
message	The annotation message. (inherited from `AnnotationBase`)
page_number	The page number where the annotation should be located. (inherited from `AnnotationBase`)
replies	The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`)
state_before_annotation	The previous state of the text before annotating. (inherited from `AnnotationBase`)
type	The annotation type. (inherited from `AnnotationBase`)
user	The annotation author. (inherited from `AnnotationBase`)

Example

from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import LinkAnnotation
from groupdocs.pydrawing import Color

def add_link_annotation():
    with Annotator("./sample.pdf") as annotator:
        link = LinkAnnotation()
        link.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        link.url = "https://www.groupdocs.com"
        link.background_color = Color.azure.to_argb()
        link.opacity = 0.7
        link.page_number = 0
        link.message = "This is a link annotation"
        annotator.add(link)
        annotator.save("./output.pdf")

Guides

Task guides that use LinkAnnotation:

Python-Net: PointAnnotation class

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

PointAnnotation class

Represents point annotation properties.

Learn more

More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
More about adding point annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+point+annotation

The PointAnnotation type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new PointAnnotation instance.

Methods

Method	Description
clone	Returns new instance with the same values.
equals	Compares point annotation using IEquatable Equals method.
equals	Compares point annotation using standard object Equals method.
equals_object
equals_point_annotation
get_hash_code	Returns HashCode of the point annotation.
equals_annotation_base	(inherited from `AnnotationBase`)

Properties

Property	Description
box	The point annotation position.
created_on	The annotation creation date. (inherited from `AnnotationBase`)
id	The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`)
message	The annotation message. (inherited from `AnnotationBase`)
page_number	The page number where the annotation should be located. (inherited from `AnnotationBase`)
replies	The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`)
state_before_annotation	The previous state of the text before annotating. (inherited from `AnnotationBase`)
type	The annotation type. (inherited from `AnnotationBase`)
user	The annotation author. (inherited from `AnnotationBase`)

Example

from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import PointAnnotation


def add_point_annotation():
    with Annotator("./sample.pdf") as annotator:
        point = PointAnnotation()
        point.box = Rectangle(100, 100, 0, 0)   # a point is positioned by its box origin
        point.page_number = 0
        point.message = "This is a point annotation"
        annotator.add(point)
        annotator.save("./output.pdf")


if __name__ == "__main__":
    add_point_annotation()

Guides

Task guides that use PointAnnotation:

Python-Net: PolylineAnnotation class

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

PolylineAnnotation class

Represents polyline annotation properties.

Learn more:

More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
More about adding polyline annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+polyline+annotation

The PolylineAnnotation type exposes the following members:

Constructors

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

Methods

Method	Description
clone	Returns new instance with the same values.
equals	Compares this polyline annotation with another using the IEquatable Equals method.
equals	Compares polyline annotation using standard object Equals method.
equals_object
equals_polyline_annotation
get_hash_code	Returns hash code of the polyline annotation.
equals_annotation_base	(inherited from `AnnotationBase`)

Properties

Property	Description
box	The polyline annotation position as a `Rectangle`.
opacity	The polyline annotation opacity.
pen_color	The pen color of the polyline annotation.
pen_style	The pen style of the polyline annotation.
pen_width	The polyline annotation pen width.
svg_path	The SVG path of the polyline annotation.
created_on	The annotation creation date. (inherited from `AnnotationBase`)
id	The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`)
message	The annotation message. (inherited from `AnnotationBase`)
page_number	The page number where the annotation should be located. (inherited from `AnnotationBase`)
replies	The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`)
state_before_annotation	The previous state of the text before annotating. (inherited from `AnnotationBase`)
type	The annotation type. (inherited from `AnnotationBase`)
user	The annotation author. (inherited from `AnnotationBase`)

Example

from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, PenStyle
from groupdocs.annotation.models.annotation_models import PolylineAnnotation
from groupdocs.pydrawing import Color


def add_polyline_annotation():
    with Annotator("./sample.pdf") as annotator:
        polyline = PolylineAnnotation()
        polyline.box = Rectangle(100, 100, 200, 100)
        polyline.svg_path = "M 0 0 L 50 50 L 100 0 L 150 50"
        polyline.pen_color = Color.purple.to_argb()
        polyline.pen_width = 2
        polyline.pen_style = PenStyle.SOLID
        polyline.opacity = 0.9
        polyline.page_number = 0
        polyline.message = "This is a polyline annotation"
        annotator.add(polyline)
        annotator.save("./output.pdf")


if __name__ == "__main__":
    add_polyline_annotation()

Guides

Task guides that use PolylineAnnotation:

Python-Net: ReplacementAnnotation class

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

ReplacementAnnotation class

Represents replacement annotation properties.

Learn more

More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
More about adding replacement annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+replacement+annotation

The ReplacementAnnotation type exposes the following members:

Constructors

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

Methods

Method	Description
clone	Returns new instance with the same values.
equals	Compares replacement annotation using IEquatable Equals method.
equals	Compares the replacement annotation with another object using the standard object Equals method.
equals_object
equals_replacement_annotation
get_hash_code	Returns the hash code of the replacement annotation.
equals_annotation_base	(inherited from `AnnotationBase`)

Properties

Property	Description
background_color	The background color of the replacement annotation.
font_color	The replacement annotation text color.
font_size	The replacement annotation text size.
opacity	The replacement annotation opacity.
points	The collection of points that describe rectangles with text.
text_to_replace	The text to be replaced.
created_on	The annotation creation date. (inherited from `AnnotationBase`)
id	The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`)
message	The annotation message. (inherited from `AnnotationBase`)
page_number	The page number where the annotation should be located. (inherited from `AnnotationBase`)
replies	The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`)
state_before_annotation	The previous state of the text before annotating. (inherited from `AnnotationBase`)
type	The annotation type. (inherited from `AnnotationBase`)
user	The annotation author. (inherited from `AnnotationBase`)

Example

from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import ReplacementAnnotation
from groupdocs.pydrawing import Color


def add_replacement_annotation():
    with Annotator("./sample.pdf") as annotator:
        replacement = ReplacementAnnotation()
        replacement.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        replacement.text_to_replace = "replacement text"
        replacement.font_color = Color.black.to_argb()
        replacement.font_size = 12.0
        replacement.opacity = 0.9
        replacement.page_number = 0
        replacement.message = "This is a text replacement annotation"
        annotator.add(replacement)
        annotator.save("./output.pdf")


if __name__ == "__main__":
    add_replacement_annotation()

Guides

Task guides that use ReplacementAnnotation:

Python-Net: ResourcesRedactionAnnotation class

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

ResourcesRedactionAnnotation class

Represents resources redaction annotation properties.

Learn more:

More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
More about adding resource redaction annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+resource+redaction+annotation

The ResourcesRedactionAnnotation type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new `ResourcesRedactionAnnotation` instance.

Methods

Method	Description
clone	Returns a new instance with the same values.
equals	Compares resource redaction annotation using IEquatable Equals method.
equals	Compares resource redaction annotation using standard object Equals method.
equals_object
equals_resources_redaction_annotation
get_hash_code	Returns the hash code of the resource redaction annotation.
equals_annotation_base	(inherited from `AnnotationBase`)

Properties

Property	Description
box	The resource redaction annotation position as a `Rectangle`.
created_on	The annotation creation date. (inherited from `AnnotationBase`)
id	The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`)
message	The annotation message. (inherited from `AnnotationBase`)
page_number	The page number where the annotation should be located. (inherited from `AnnotationBase`)
replies	The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`)
state_before_annotation	The previous state of the text before annotating. (inherited from `AnnotationBase`)
type	The annotation type. (inherited from `AnnotationBase`)
user	The annotation author. (inherited from `AnnotationBase`)

Example

from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle
from groupdocs.annotation.models.annotation_models import ResourcesRedactionAnnotation

def add_resources_redaction_annotation():
    with Annotator("./sample.pdf") as annotator:
        redaction = ResourcesRedactionAnnotation()
        redaction.box = Rectangle(100, 100, 200, 80)
        redaction.page_number = 0
        redaction.message = "This is a resources redaction annotation"
        annotator.add(redaction)
        annotator.save("./output.pdf")

Guides

Task guides that use ResourcesRedactionAnnotation:

Python-Net: SearchTextFragment class

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

SearchTextFragment class

Represents searchText annotation properties.

Learn more

More about annotation types and annotating PDF: How to annotate documents using GroupDocs.Annotation for .NET (https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document)
More about adding searchText annotations to documents of various types: How to add searchText annotations in C# (https://docs.groupdocs.com/display/annotationnet/Add+searchText+annotation)

The SearchTextFragment type exposes the following members:

Constructors

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

Methods

Method	Description
clone	Returns a new instance with the same values.
equals	Compares search text annotation using IEquatable Equals method.
equals	Compares search text annotation using standard object Equals method.
equals_object
equals_search_text_fragment
get_hash_code	Returns HashCode of SearchText Annotation.
equals_annotation_base	(inherited from `AnnotationBase`)

Properties

Property	Description
background_color	The text background color.
font_color	The text color.
font_family	The text font family.
font_size	The text size.
text	The text that needs to be found.
created_on	The annotation creation date. (inherited from `AnnotationBase`)
id	The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`)
message	The annotation message. (inherited from `AnnotationBase`)
page_number	The page number where the annotation should be located. (inherited from `AnnotationBase`)
replies	The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`)
state_before_annotation	The previous state of the text before annotating. (inherited from `AnnotationBase`)
type	The annotation type. (inherited from `AnnotationBase`)
user	The annotation author. (inherited from `AnnotationBase`)

Python-Net: SquigglyAnnotation class

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

SquigglyAnnotation class

Represents squiggly annotation properties.

Learn more

More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
More about adding squiggly annotations to documents of various types: https://docs.groupdocs.com/annotation/net/add-squiggly-annotation/

The SquigglyAnnotation type exposes the following members:

Constructors

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

Methods

Method	Description
clone	Returns a new instance with the same values.
equals	Compares this squiggly annotation with another `SquigglyAnnotation` using the IEquatable Equals method.
equals	Compares the squiggly annotation with another object using the standard object Equals method.
equals_object
equals_squiggly_annotation
get_hash_code	Returns the hash code of the squiggly annotation.
equals_annotation_base	(inherited from `AnnotationBase`)

Properties

Property	Description
background_color	The background color of the squiggly annotation text.
font_color	The font color of the squiggly annotation text.
opacity	The opacity of the squiggly annotation.
points	The collection of points that describe rectangles with text.
squiggly_color	The color of the squiggly annotation.
created_on	The annotation creation date. (inherited from `AnnotationBase`)
id	The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`)
message	The annotation message. (inherited from `AnnotationBase`)
page_number	The page number where the annotation should be located. (inherited from `AnnotationBase`)
replies	The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`)
state_before_annotation	The previous state of the text before annotating. (inherited from `AnnotationBase`)
type	The annotation type. (inherited from `AnnotationBase`)
user	The annotation author. (inherited from `AnnotationBase`)

Example

from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import SquigglyAnnotation
from groupdocs.pydrawing import Color


def add_squiggly_annotation():
    with Annotator("./sample.pdf") as annotator:
        squiggly = SquigglyAnnotation()
        squiggly.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        squiggly.squiggly_color = Color.red.to_argb()
        squiggly.opacity = 0.9
        squiggly.page_number = 0
        squiggly.message = "This is a squiggly annotation"
        annotator.add(squiggly)
        annotator.save("./output.pdf")


if __name__ == "__main__":
    add_squiggly_annotation()

Guides

Task guides that use SquigglyAnnotation:

Python-Net: StrikeoutAnnotation class

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

StrikeoutAnnotation class

Represents strikeout annotation properties.

Learn more

More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
More about adding strikeout annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+strikeout+annotation

The StrikeoutAnnotation type exposes the following members:

Constructors

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

Methods

Method	Description
clone	Returns a new instance with the same values.
equals	Compares the strikeout annotation with another using the IEquatable Equals method.
equals	Compares strikeout annotation using standard object Equals method.
equals_object
equals_strikeout_annotation
get_hash_code	Returns the hash code of the strikeout annotation.
equals_annotation_base	(inherited from `AnnotationBase`)

Properties

Property	Description
background_color	The background color of the strikeout annotation text.
font_color	The font color of the strikeout annotation text.
opacity	The opacity of the strikeout annotation.
points	The collection of points that describe rectangles with text.
created_on	The annotation creation date. (inherited from `AnnotationBase`)
id	The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`)
message	The annotation message. (inherited from `AnnotationBase`)
page_number	The page number where the annotation should be located. (inherited from `AnnotationBase`)
replies	The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`)
state_before_annotation	The previous state of the text before annotating. (inherited from `AnnotationBase`)
type	The annotation type. (inherited from `AnnotationBase`)
user	The annotation author. (inherited from `AnnotationBase`)

Example

from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import StrikeoutAnnotation
from groupdocs.pydrawing import Color

def add_strikeout_annotation():
    with Annotator("./sample.pdf") as annotator:
        strikeout = StrikeoutAnnotation()
        strikeout.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        strikeout.font_color = Color.red.to_argb()
        strikeout.opacity = 0.9
        strikeout.page_number = 0
        strikeout.message = "This is a strikeout annotation"
        annotator.add(strikeout)
        annotator.save("./output.pdf")

Guides

Task guides that use StrikeoutAnnotation:

Python-Net: TextFieldAnnotation class

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

TextFieldAnnotation class

Represents text field annotation properties.

Learn more

More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: How to annotate documents using GroupDocs.Annotation for .NET
More about adding text field annotations to documents of various types: How to add text field annotations in C#

The TextFieldAnnotation type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new `TextFieldAnnotation` instance.

Methods

Method	Description
clone	Returns a new instance with the same values.
equals	Compares this text field annotation with another using the IEquatable Equals method.
equals	Compares text field annotation using standard object Equals method.
equals_object
equals_text_field_annotation
get_hash_code	Returns HashCode of the text field annotation.
equals_annotation_base	(inherited from `AnnotationBase`)

Properties

Property	Description
background_color	The background color of the text field annotation.
box	The text field annotation position.
font_color	The font color of the text field annotation.
font_family	The font family of the text field annotation.
font_size	The font size of the text field annotation.
opacity	The opacity of the text field annotation.
pen_color	The pen color of the text field annotation.
pen_style	The pen style of the text field annotation.
pen_width	The pen width of the text field annotation.
text	The text of the text field annotation.
text_horizontal_alignment	The horizontal alignment of the text.
created_on	The annotation creation date. (inherited from `AnnotationBase`)
id	The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`)
message	The annotation message. (inherited from `AnnotationBase`)
page_number	The page number where the annotation should be located. (inherited from `AnnotationBase`)
replies	The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`)
state_before_annotation	The previous state of the text before annotating. (inherited from `AnnotationBase`)
type	The annotation type. (inherited from `AnnotationBase`)
user	The annotation author. (inherited from `AnnotationBase`)

Example

from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, HorizontalAlignment
from groupdocs.annotation.models.annotation_models import TextFieldAnnotation
from groupdocs.pydrawing import Color


def add_text_field_annotation():
    with Annotator("./sample.pdf") as annotator:
        text_field = TextFieldAnnotation()
        text_field.box = Rectangle(100, 100, 150, 50)
        text_field.text = "Some text in a field"
        text_field.font_family = "Arial"
        text_field.font_size = 12.0
        text_field.font_color = Color.black.to_argb()
        text_field.background_color = Color.yellow.to_argb()
        text_field.text_horizontal_alignment = HorizontalAlignment.CENTER
        text_field.opacity = 0.9
        text_field.page_number = 0
        text_field.message = "This is a text field annotation"
        annotator.add(text_field)
        annotator.save("./output.pdf")


if __name__ == "__main__":
    add_text_field_annotation()

Guides

Task guides that use TextFieldAnnotation:

Python-Net: TextRedactionAnnotation class

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

TextRedactionAnnotation class

Represents text redaction annotation properties.

Learn more

More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
More about adding text redaction annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+text+redaction+annotation

The TextRedactionAnnotation type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new `TextRedactionAnnotation` instance.

Methods

Method	Description
clone	Returns a new instance with the same values.
equals	Compares this text redaction annotation with another using the IEquatable Equals method.
equals	Compares text redaction annotation using standard object Equals method.
equals_object
equals_text_redaction_annotation
get_hash_code	Returns hash code of the text redaction annotation.
equals_annotation_base	(inherited from `AnnotationBase`)

Properties

Property	Description
font_color	The text font color of the text redaction annotation.
points	The collection of points that describe rectangles with text.
created_on	The annotation creation date. (inherited from `AnnotationBase`)
id	The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`)
message	The annotation message. (inherited from `AnnotationBase`)
page_number	The page number where the annotation should be located. (inherited from `AnnotationBase`)
replies	The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`)
state_before_annotation	The previous state of the text before annotating. (inherited from `AnnotationBase`)
type	The annotation type. (inherited from `AnnotationBase`)
user	The annotation author. (inherited from `AnnotationBase`)

Example

from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import TextRedactionAnnotation
from groupdocs.pydrawing import Color


def add_text_redaction_annotation():
    with Annotator("./sample.pdf") as annotator:
        redaction = TextRedactionAnnotation()
        redaction.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        redaction.font_color = Color.black.to_argb()
        redaction.page_number = 0
        redaction.message = "This is a text redaction annotation"
        annotator.add(redaction)
        annotator.save("./output.pdf")


if __name__ == "__main__":
    add_text_redaction_annotation()

Guides

Task guides that use TextRedactionAnnotation:

Python-Net: UnderlineAnnotation class

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

UnderlineAnnotation class

Represents underline annotation properties.

Learn more

More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
More about adding underline annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+underline+annotation

The UnderlineAnnotation type exposes the following members:

Constructors

Constructor	Description
init	Initializes a new `UnderlineAnnotation` instance.

Methods

Method	Description
clone	Returns new instance with the same values.
equals	Compares this underline annotation with another underline annotation.
equals	Compares underline annotation using the standard object Equals method.
equals_object
equals_underline_annotation
get_hash_code	Returns HashCode of the underline annotation.
equals_annotation_base	(inherited from `AnnotationBase`)

Properties

Property	Description
background_color	The underline annotation text background color.
font_color	The text color of the underline annotation.
opacity	The underline annotation opacity.
points	The collection of points that describe rectangles with text.
underline_color	The underline annotation color as an ARGB integer.
created_on	The annotation creation date. (inherited from `AnnotationBase`)
id	The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`)
message	The annotation message. (inherited from `AnnotationBase`)
page_number	The page number where the annotation should be located. (inherited from `AnnotationBase`)
replies	The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`)
state_before_annotation	The previous state of the text before annotating. (inherited from `AnnotationBase`)
type	The annotation type. (inherited from `AnnotationBase`)
user	The annotation author. (inherited from `AnnotationBase`)

Example

from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Point
from groupdocs.annotation.models.annotation_models import UnderlineAnnotation
from groupdocs.pydrawing import Color


def add_underline_annotation():
    with Annotator("./sample.pdf") as annotator:
        underline = UnderlineAnnotation()
        underline.points = [
            Point(80, 600), Point(300, 600),
            Point(80, 575), Point(300, 575),
        ]
        underline.underline_color = Color.red.to_argb()
        underline.opacity = 0.9
        underline.page_number = 0
        underline.message = "This is an underline annotation"
        annotator.add(underline)
        annotator.save("./output.pdf")

Guides

Task guides that use UnderlineAnnotation:

Python-Net: WatermarkAnnotation class

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

WatermarkAnnotation class

Represents watermark annotation properties.

More about annotation types and annotating PDF and Microsoft Word documents, Excel spreadsheets and PowerPoint Presentations: https://docs.groupdocs.com/display/annotationnet/Add+annotation+to+the+document
More about adding watermark annotations to documents of various types: https://docs.groupdocs.com/display/annotationnet/Add+watermark+annotation

The WatermarkAnnotation type exposes the following members:

Constructors

Constructor	Description
init	Initializes new instance of WatermarkAnnotation class.

Methods

Method	Description
clone	Returns a new instance with the same values.
equals	Compares watermark annotation using IEquatable Equals method.
equals	Compares watermark annotation using the standard object Equals method.
equals_object
equals_watermark_annotation
get_hash_code	Returns the hash code of the watermark annotation.
equals_annotation_base	(inherited from `AnnotationBase`)

Properties

Property	Description
angle	The rotation angle of the watermark annotation.
auto_scale	The auto scale setting for the watermark annotation.
box	The watermark annotation position.
font_color	The watermark annotation text color.
font_family	The font family of the watermark annotation text.
font_size	The watermark annotation text size.
horizontal_alignment	The watermark horizontal alignment on the document.
opacity	The opacity of the watermark annotation.
text	The watermark text.
vertical_alignment	The vertical alignment of the watermark on the document.
created_on	The annotation creation date. (inherited from `AnnotationBase`)
id	The annotation unique identifier. This field is auto-incremented. (inherited from `AnnotationBase`)
message	The annotation message. (inherited from `AnnotationBase`)
page_number	The page number where the annotation should be located. (inherited from `AnnotationBase`)
replies	The list of replies (comments) attached to the annotation. (inherited from `AnnotationBase`)
state_before_annotation	The previous state of the text before annotating. (inherited from `AnnotationBase`)
type	The annotation type. (inherited from `AnnotationBase`)
user	The annotation author. (inherited from `AnnotationBase`)

Example

from groupdocs.annotation import Annotator
from groupdocs.annotation.models import Rectangle, HorizontalAlignment, VerticalAlignment
from groupdocs.annotation.models.annotation_models import WatermarkAnnotation
from groupdocs.pydrawing import Color

def add_watermark_annotation():
    with Annotator("./sample.pdf") as annotator:
        watermark = WatermarkAnnotation()
        watermark.box = Rectangle(100, 100, 200, 100)
        watermark.text = "Watermark"
        watermark.font_family = "Arial"
        watermark.font_size = 24.0
        watermark.font_color = Color.red.to_argb()
        watermark.angle = 45.0
        watermark.auto_scale = True
        watermark.horizontal_alignment = HorizontalAlignment.CENTER
        watermark.vertical_alignment = VerticalAlignment.CENTER
        watermark.opacity = 0.5
        watermark.page_number = 0
        watermark.message = "This is a watermark annotation"
        annotator.add(watermark)
        annotator.save("./output.pdf")

Guides

Task guides that use WatermarkAnnotation:

Groupdocs API References – groupdocs.annotation.models.annotation_models

Python-Net: AnnotationBase class

AnnotationBase class

Methods

Properties

Guides

See Also

Python-Net: AreaAnnotation class

AreaAnnotation class

Constructors

Methods

Properties

Example

Guides

See Also

Python-Net: ArrowAnnotation class

ArrowAnnotation class

Constructors

Methods

Properties

Example

Guides

See Also

Python-Net: DistanceAnnotation class

DistanceAnnotation class

Constructors

Methods

Properties

Example

Guides

See Also

Python-Net: EllipseAnnotation class

EllipseAnnotation class

Constructors

Methods

Properties

Example

Guides

See Also

Python-Net: HighlightAnnotation class

HighlightAnnotation class

Constructors

Methods

Properties

Example

Guides

See Also

Python-Net: ImageAnnotation class

ImageAnnotation class

Constructors

Methods

Properties

Example

Guides

See Also

Python-Net: LinkAnnotation class

LinkAnnotation class

Constructors

Methods

Properties

Example

Guides

See Also

Python-Net: PointAnnotation class

PointAnnotation class

Constructors

Methods

Properties

Example

Guides

See Also

Python-Net: PolylineAnnotation class

PolylineAnnotation class

Constructors

Methods

Properties

Example

Guides

See Also

Python-Net: ReplacementAnnotation class