[]
产品首页 在线Demo 产品文档 API 参考 技术社区
立即试用
(Showing Draft Content)

GrapeCity.Documents.Pdf.Annotations.RedactAnnotation

Class RedactAnnotation

Namespace
GrapeCity.Documents.Pdf.Annotations
Assembly
GcDocs.Pdf.dll

Represents a redact annotation used to mark areas containing information that needs to be erased from the document. Note that redact annotations must be explicitly applied (with a call to the Redact(RedactOptions) method or one of its overloads) to actually remove the information marked for redaction from the document.

public class RedactAnnotation : MarkupAnnotation, IOwnedObject, IContentItem, IPdfDict
Inheritance
object
RedactAnnotation
Implements
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Extension Methods

Constructors

RedactAnnotation()

Initializes a new instance of the RedactAnnotation class.

public RedactAnnotation()

Properties

Area

Gets or sets the list of Quadrilateral structures defining the annotation area. The coordinates of the quadrilaterals' points are relative to the upper left corner of the page's media box, with the Y (vertical) coordinates increasing from top to bottom.

Note that if the annotation is associated with more than one page, the media box of the first of those pages is used to calculate the coordinates.

If not empty, these quadrilaterals denote the content region that is intended to be redacted. If this list is empty, the Rect entry denotes the content region that is intended to be redacted. 

public IReadOnlyList<Quadrilateral> Area { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<T><Quadrilateral>

Justification

Gets or sets the justification to be used in displaying the overlay text. See PDF specification for details.

public VariableTextJustification Justification { get; set; }

Property Value

VariableTextJustification

MarkBorderColor

Gets or sets the outline color used to highlight the annotation rectangle.

public Color? MarkBorderColor { get; set; }

Property Value

System.Drawing.Color?

MarkFillColor

Gets or sets the color used to fill the annotation rectangle.

public Color? MarkFillColor { get; set; }

Property Value

System.Drawing.Color?

OverlayAppearance

Gets the DefaultAppearance object that specifies the visual properties (font, font size etc.) used to format the overlay text.

public DefaultAppearance OverlayAppearance { get; }

Property Value

DefaultAppearance

OverlayFillColor

Gets or sets the overlay fill color with which to fill the redacted region after the affected content has been removed.

public Color OverlayFillColor { get; set; }

Property Value

System.Drawing.Color

OverlayText

Gets or sets the overlay text that should be drawn over the redacted region after the affected content has been removed.

public string OverlayText { get; set; }

Property Value

string

OverlayTextRepeat

Gets or sets a value indicating whether the text specified by OverlayText should be repeated to fill the redacted region after the affected content has been removed.

public bool OverlayTextRepeat { get; set; }

Property Value

bool

PdfArea

Gets or sets the list of Quadrilateral structures defining the annotation area. The coordinates of the quadrilaterals' points are in PDF user space coordinates. The positive X axis extends horizontally to the right, and the positive Y axis extends vertically upward, with the origin usually in the lower left corner of the page.

If not empty, these quadrilaterals denote the content region that is intended to be redacted. If this list is empty, the Rect entry denotes the content region that is intended to be redacted. 

public IReadOnlyList<Quadrilateral> PdfArea { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<T><Quadrilateral>

Methods

AddPolygon(PointF[], FillMode)

Tessellates a polygon specified by its vertices into triangles, and adds those triangles to this annotation's Area.

public void AddPolygon(PointF[] points, FillMode fillMode = FillMode.Alternate)

Parameters

points System.Drawing.PointF[]

The array of points that specify the vertices of the polygon.

fillMode FillMode

The fill mode.