StrikeoutAnnotation class
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: