Class Redactor.Appearance

Class used to customize the appearance of the optional redaction overlay.

Inheritance
object
Redactor.Appearance
Inherited Members
Namespace: pdftron.PDF
Assembly: PDFNet.dll
Syntax
public class Redactor.Appearance

Constructors

Appearance()

Declaration
public Appearance()

Properties

Border

Border specifies if the overlay will be surrounded by a border.

Declaration
public bool Border { get; set; }
Property Value
Type Description
bool

EnableTextWrapping

Specifies whether text wrapping is enabled for overlay text. When true, text is wrapped across multiple lines at MaxFontSize to fit within the redaction area. When false, text is rendered on a single line, scaled between MinFontSize and MaxFontSize as needed.

Declaration
public bool EnableTextWrapping { get; set; }
Property Value
Type Description
bool

HorizTextAlignment

Specifies the text alignment in the overlay: align<0 -> text will be left aligned. align==0 -> text will be center aligned. align>0 -> text will be right aligned.

Declaration
public int HorizTextAlignment { get; set; }
Property Value
Type Description
int

MaxFontSize

Specifies the maximum font size used to represent the text in the overlay.

Declaration
public double MaxFontSize { get; set; }
Property Value
Type Description
double

MinFontSize

Specifies the minimum font size used to represent the text in the overlay.

Declaration
public double MinFontSize { get; set; }
Property Value
Type Description
double

NegativeOverlayColor

NegativeOverlayColor defines the overlay background color in RGB color space for negative redactions.

Declaration
public Color NegativeOverlayColor { get; set; }
Property Value
Type Description
Color

PositiveOverlayColor

PositiveOverlayColor defines the overlay background color in RGB color space for positive redactions.

Declaration
public Color PositiveOverlayColor { get; set; }
Property Value
Type Description
Color

RedactedContentColor

Specifies the color used to paint the regions where content was removed.

Declaration
public Color RedactedContentColor { get; set; }
Property Value
Type Description
Color
Remarks

Default value is Gray color.

RedactionOverlay

If RedactionOverlay is set to true, Redactor will draw an overlay covering all redacted regions. The rest of properties in the Appearance class defines visual properties of the overlay. if false the overlay region will not be drawn.

Declaration
public bool RedactionOverlay { get; set; }
Property Value
Type Description
bool

ShowRedactedContentRegions

Specifies whether an overlay should be drawn in place of the redacted content. This option can be used to indicate the areas where the content was removed from without revealing the content itself.

Declaration
public bool ShowRedactedContentRegions { get; set; }
Property Value
Type Description
bool
Remarks

Default value is False.

TextColor

Specifies the color used to paint the text in the overlay (in RGB).

Declaration
public Color TextColor { get; set; }
Property Value
Type Description
Color

TextFont

Specifies the font used to represent the text in the overlay.

Declaration
public Font TextFont { get; set; }
Property Value
Type Description
Font

UseOverlayText

Specifies if the text (e.g. "Redacted" etc.) should be placed on top of the overlay. The remaining properties relate to the positioning, and styling of the overlay text.

Declaration
public bool UseOverlayText { get; set; }
Property Value
Type Description
bool

VertTextAlignment

Specifies the vertical text alignment in the overlay: align<0 -> text will be bottom aligned. align==0 -> text will be center aligned. align>0 -> text will be top aligned.

Declaration
public int VertTextAlignment { get; set; }
Property Value
Type Description
int