Class Redactor.Appearance

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

Inheritance

System.Object

Redactor.Appearance

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: pdftron.PDF

Assembly: PDFNet.dll

Syntax

public class Appearance

Constructors

Appearance()

Declaration

public Appearance()

Fields

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

Field Value

Type	Description
System.Boolean

Remarks

Default value is False.

Properties

Border

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

Declaration

public bool Border { get; set; }

Property Value

Type	Description
System.Boolean

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
System.Int32

MaxFontSize

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

Declaration

public double MaxFontSize { get; set; }

Property Value

Type	Description
System.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
System.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
System.Drawing.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
System.Drawing.Color

RedactedContentColor

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

Declaration

public Color RedactedContentColor { get; set; }

Property Value

Type	Description
System.Drawing.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
System.Boolean

TextColor

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

Declaration

public Color TextColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

TextFont

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

Declaration

public Font TextFont { get; set; }

Property Value

Type	Description
System.Drawing.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
System.Boolean

VertTextAlignment

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

Declaration

public int VertTextAlignment { get; set; }

Property Value

Type	Description
System.Int32