SquigglyAnnotation class
Leave feedback
On this page
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:
| Constructor | Description |
|---|---|
| init | Initializes a new instance of SquigglyAnnotation. |
| 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) |
| 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) |
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()
Task guides that use SquigglyAnnotation:
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.