RedactionAnnotation

RedactionAnnotation class

Represents Redact annotation.

public sealed class RedactionAnnotation : MarkupAnnotation

Constructors

Name Description
RedactionAnnotation(Document) Constructor for RedactionAnnotation. For using in Generator.
RedactionAnnotation(Page, Rectangle) Constructor for RedactAnnotation.

Properties

Name Description
Actions { get; } Gets list of annotatation actions.
virtual ActiveState { get; set; } Gets or sets current annotation appearance state.
override AnnotationType { get; } Gets type of annotation.
Appearance { get; } Gets appearance dictionary of the annotation.
Border { get; set; } Gets or sets annotation border characteristics. Border
BorderColor { get; set; } Gets or sets color of border which is drawn when redaction is not active.
Characteristics { get; } Gets annotation characteristics.
Color { get; set; } Gets or sets annotation color.
Contents { get; set; } Gets or sets annotation text.
CreationDate { get; } Gets date and time when annotation was created.
DefaultAppearance { get; set; } Gets or sets the default appearance string to be used in formatting the text.
FillColor { get; set; } Gets or sets color to fill annotation.
Flags { get; set; } Flags of the annotation.
FullName { get; } Gets full qualified name of the annotation.
virtual Height { get; set; } Gets or sets height of the annotation.
virtual Hyperlink { get; set; } Gets or sets the fragment hyperlink(for pdf generator).
InReplyTo { get; set; } A reference to the annotation that this annotation is “in reply to”. Both annotations must be on the same page of the document.
IsFirstParagraphInColumn { get; set; } Gets or sets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation)
IsInLineParagraph { get; set; } Gets or sets a paragraph is inline. Default is false.(for pdf generation)
IsInNewPage { get; set; } Gets or sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation)
IsKeptWithNext { get; set; } Gets or sets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation)
Margin { get; set; } Gets or sets a outer margin for paragraph (for pdf generation)
Modified { get; set; } Gets or sets date and time when annotation was recently modified.
Name { get; set; } Gets or sets annotation name on the page.
Opacity { get; set; } Gets or sets the constant opacity value to be used in painting the annotation.
OverlayText { get; set; } Text to print on redact annotation.
virtual PageIndex { get; } Gets index of page which contains annotation.
Popup { get; set; } Pop-up annotation for entering or editing the text associated with this annotation.
QuadPoint { get; set; } An array of 8xN numbers specifying the coordinates of content region that is intended to be removed.
virtual Rect { get; set; } Gets or sets annotation rectangle.
Repeat { get; set; } If true overlay text will be repated on the annotation.
ReplyType { get; set; } A string specifying the relationship (the “reply type”) between this annotation and one specified by InReplyTo.
RichText { get; set; } Gets or sets a rich text string to be displayed in the pop-up window when the annotation is opened.
States { get; } Gets appearance dictionary of annotation.
Subject { get; set; } Gets text representing desciption of the object.
TextAlignment { get; set; } Gets or sets. Alignment of Overlay Text.
TextHorizontalAlignment { get; set; } Gets or sets text alignment for annotation.
Title { get; set; } Gets or sets a text that shall be displayed in title bar of annotation.
virtual VerticalAlignment { get; set; } Gets or sets a vertical alignment of paragraph
virtual Width { get; set; } Gets or sets width of the annotation.
ZIndex { get; set; } Gets or sets a int value that indicates the Z-order of the graph. A graph with larger ZIndex will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative ZIndex will be placed behind the text in the page.

Methods

Name Description
override Accept(AnnotationSelector) Accepts visitor object to process the annotation.
virtual ChangeAfterResize(Matrix) Update parameters and appearance, according to the matrix transform.
virtual Clone() Clones this instance. Virtual method. Always return null.
override Flatten() Flattens annotation i.e. removes annotation and adds its
GetRectangle(bool) Returns rectangle of annotation taking into consideration page rotation.
Redact() Flattens annotation and redacts page contents (i.e. removes text and image under redacted annotation)

See Also