RedactAnnotation

Overview

RedactAnnotation is a class in Aspose.PDF FOSS for TypeScript. Inherits from: Annotation.

A /Redact annotation (PDF 32000-1 §12.5.6.23): a mark over a region, plus the overlay to paint when it is applied.

This class declares 2 methods for RedactAnnotation objects in TypeScript programs. Available methods include: Flatten, constructor. All public members are accessible to any TypeScript application after installing the Aspose.PDF FOSS for TypeScript package. Properties: Alignment, Author, Color, Contents, Flags, FontSize, and 14 more.

Properties

NameTypeAccessDescription
QuadPointsnumber[]Read/WriteGets the quad points.
InteriorColor[number, number, number] | undefinedRead/WriteGets the interior color.
Alignment'left' | 'center' | 'right'Read/WriteGets the alignment.
OverlayTextstring | undefinedRead/WriteGets the overlay text.
RepeatbooleanRead/WriteGets the repeat.
FontSizenumberRead/WriteGets the font size.
TextColor[number, number, number]Read/WriteGets the text color.
Authorstring | undefinedRead/WriteGets the author.
OverlayPdfStream | undefinedReadGets the overlay.
SubtypestringReadGets the subtype.
Rect[number, number, number, number] | undefinedRead/WriteGets the rect.
Color[number, number, number] | undefinedRead/WriteGets the color.
Contentsstring | undefinedRead/WriteGets the contents.
Namestring | undefinedRead/WriteGets the name.
LayerLayer | undefinedRead/WriteGets the layer.
ModDateDate | string | undefinedRead/WriteGets the mod date.
FlagsnumberRead/WriteGets the flags.
PrintbooleanRead/WriteGets the print.
HiddenbooleanRead/WriteGets the hidden.
Opacitynumber | undefinedRead/WriteGets the opacity.

Methods

SignatureDescription
constructor(doc: Document, Dict: PdfDict)Calls constructor(doc, Dict) on this RedactAnnotation instance.
Flatten()booleanBake just this annotation into static page content: draw its /AP /N appearance into the page’s /Contents at its /Rect and drop it from /Annots.