Class Redaction

This class represents redaction annotation. Redaction annotations are used to mark regions of content or text of the document to eventually redact(i.e.remove the content from the document in an irreversible way).

Inheritance
object
AnnotationBase
TextMarkupAnnotationBase
Redaction
Implements
Inherited Members
Namespace: PSPDFKit.Sdk.Models.Annotation
Assembly: Sdk.dll
Syntax
public sealed class Redaction : TextMarkupAnnotationBase, IAnnotation

Properties

| Edit this page View Source

FillColor

Background color of the redacted area.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
[JsonConverter(typeof(ColorJsonConverter))]
public Color? FillColor { get; set; }
Property Value
Type Description
Color?
| Edit this page View Source

ForegroundColor

Color of the overlay text. It has no effect if there is no overlay text.

Declaration
[JsonProperty("color")]
[JsonConverter(typeof(ColorJsonConverter))]
public Color? ForegroundColor { get; set; }
Property Value
Type Description
Color?
| Edit this page View Source

OutlineColor

Color used for the redaction's border in its marked state.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
[JsonConverter(typeof(ColorJsonConverter))]
public Color? OutlineColor { get; set; }
Property Value
Type Description
Color?
| Edit this page View Source

OverlayText

Text to be displayed at the specified region when a redaction has been applied.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy), NullValueHandling = NullValueHandling.Ignore)]
public string OverlayText { get; set; }
Property Value
Type Description
string
| Edit this page View Source

RepeatOverlayText

Whether the overlay text should be repeated to fill the entire redaction area or just be drawn once. It has no effect if there is no overlay text specified.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy), NullValueHandling = NullValueHandling.Ignore)]
public bool? RepeatOverlayText { get; set; }
Property Value
Type Description
bool?

Implements

IAnnotation