TextRedactionAnnotation class Leave feedback
On this page
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:
| Constructor | Description |
|---|---|
| init | Initializes a new TextRedactionAnnotation instance. |
| 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) |
| 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) |
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()
Task guides that use TextRedactionAnnotation:
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.
