PdfRedactionAppearance Class

Namespace:

GemBox.Pdf.Annotations

Assembly:

GemBox.Pdf.dll

Represents an appearance settings for a PdfRedactionAnnotation.

• C#
• VB.NET

public sealed class PdfRedactionAppearance : PdfAppearance

Public NotInheritable Class PdfRedactionAppearance
    Inherits PdfAppearance

Inheritance:

System.Object

PdfAppearance

PdfRedactionAppearance

Properties

FontColor

(Required if OverlayText is present, ignored otherwise) Gets or sets the font color of the overlay text when it is drawn after the affected content has been removed.

Default value: Red.

• C#
• VB.NET

public PdfColor FontColor { get; set; }

Public Property FontColor As PdfColor

Property Value

PdfColor

The font color of the overlay text when it is drawn after the affected content has been removed.

See Also

PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

FontFace

(Required if OverlayText is present, ignored otherwise) Gets or sets the font face of the overlay text when it is drawn after the affected content has been removed.

Default value: Helvetica.

• C#
• VB.NET

public PdfFontFace FontFace { get; set; }

Public Property FontFace As PdfFontFace

Property Value

PdfFontFace

The font face of the overlay text when it is drawn after the affected content has been removed.

Exceptions

System.ArgumentNullException

Value is null.

See Also

PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

FontSize

(Required if OverlayText is present, ignored otherwise) Gets or sets the font size of the overlay text when it is drawn after the affected content has been removed.

Set the FontSize to zero to Auto-Size text to fit redaction region.

Default value: 0 (Auto-Size text to fit redaction region).

• C#
• VB.NET

public double FontSize { get; set; }

Public Property FontSize As Double

Property Value

System.Double

The font size of the overlay text when it is drawn after the affected content has been removed.

Exceptions

System.ArgumentException

Value is either System.Double.NaN, System.Double.NegativeInfinity or System.Double.PositiveInfinity.

System.ArgumentOutOfRangeException

Value is less than 0.

See Also

PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

OverlayText

(Optional) Gets or sets a text string specifying the overlay text that should be drawn over the redacted region after the affected content has been removed.

To not use Overlay Text, set this property to null.

Default value: null.

• C#
• VB.NET

public string OverlayText { get; set; }

Public Property OverlayText As String

Property Value

System.String

A text string specifying the overlay text that should be drawn over the redacted region after the affected content has been removed.

See Also

PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

RedactedAreaFillColor

(Optional) Gets or sets the interior color with which to fill the redacted region after the affected content has been removed. If this entry is absent, the interior of the redaction region is left transparent.

Default value: Black.

• C#
• VB.NET

public PdfColor? RedactedAreaFillColor { get; set; }

Public Property RedactedAreaFillColor As PdfColor?

Property Value

System.Nullable<PdfColor>

The interior color with which to fill the redacted region after the affected content has been removed.

Exceptions

System.ArgumentException

The value's Space is not DeviceRGB.

See Also

PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

RedactionMarkFillColor

Gets or sets the fill color of the redaction mark appearance.

Default value: null.

• C#
• VB.NET

public PdfColor? RedactionMarkFillColor { get; set; }

Public Property RedactionMarkFillColor As PdfColor?

Property Value

System.Nullable<PdfColor>

The fill color of the redaction mark appearance.

Exceptions

System.ArgumentException

The value's Space is not device color space (DeviceGray, DeviceRGB, or DeviceCMYK).

RedactionMarkOpacity

Gets or sets the opacity of the redaction mark appearance.

Default value: 1.0.

• C#
• VB.NET

public double RedactionMarkOpacity { get; set; }

Public Property RedactionMarkOpacity As Double

Property Value

System.Double

The opacity of the redaction mark appearance.

RedactionMarkOutlineColor

Gets or sets the outline color of the redaction mark appearance.

Default value: Red.

• C#
• VB.NET

public PdfColor? RedactionMarkOutlineColor { get; set; }

Public Property RedactionMarkOutlineColor As PdfColor?

Property Value

System.Nullable<PdfColor>

The outline color of the redaction mark appearance.

Exceptions

System.ArgumentException

The value's Space is not device color space (DeviceGray, DeviceRGB, or DeviceCMYK).

RepeatOverlayText

(Optional) If true, then the text specified by OverlayText should be repeated to fill the redacted region after the affected content has been removed.

Default value: false.

• C#
• VB.NET

public bool RepeatOverlayText { get; set; }

Public Property RepeatOverlayText As Boolean

Property Value

System.Boolean

If true, then the text specified by OverlayText should be repeated to fill the redacted region after the affected content has been removed; otherwise, false.

See Also

PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

TextAlignment

(Optional) Gets or sets the text alignment of the overlay text when it is drawn after the affected content has been removed.

Default value: Left.

• C#
• VB.NET

public PdfTextAlignment TextAlignment { get; set; }

Public Property TextAlignment As PdfTextAlignment

Property Value

PdfTextAlignment

The text alignment of the overlay text when it is drawn after the affected content has been removed.

Exceptions

System.ArgumentException

Left, Center and Right alignments are supported for free text annotation's appearance text.

See Also

PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'

Inherited Properties

State

(Required if the appearance dictionary AP contains one or more subdictionaries; PDF 1.2) The annotation's appearance state, which selects the applicable appearance stream from an appearance subdictionary (see Section 12.5.5, "Appearance Streams"). (Inherited from PdfAppearance)

Inherited Methods

BeginInit()	Begins initialization of the PdfAppearance. Call EndInit() to end the initialization and update the appearance. If BeginInit() is called on a PdfAppearance that is already being initialized, the second and subsequent calls are ignored. (Inherited from PdfAppearance)
EndInit()	Ends initialization of the PdfAppearance by updating the changed appearance. This method will be ignored if called on a PdfAppearance that is not being initialized. (Inherited from PdfAppearance)
Get()	Gets the appearance form for the Normal appearance trigger and the current appearance State. (Inherited from PdfAppearance)
Get(PdfAppearanceTrigger)	Gets a collection of appearance states and the associated appearance forms for the specified appearance trigger. (Inherited from PdfAppearance)
Get(PdfAppearanceTrigger, PdfAppearanceState)	Gets the appearance form for the specified appearance trigger and appearance state. (Inherited from PdfAppearance)
Refresh()	Forces an update of the appearance. (Inherited from PdfAppearance)
Set(PdfAppearanceTrigger, System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<PdfAppearanceState, PdfForm>>)	Sets a collection of appearance states and the associated appearance forms for the specified appearance trigger. (Inherited from PdfAppearance)
Set(PdfAppearanceTrigger, PdfAppearanceState, PdfForm)	Sets the appearance form for the specified appearance trigger and appearance state. (Inherited from PdfAppearance)
Set(PdfForm)	Sets the appearance form for the Normal appearance trigger and the current appearance State. (Inherited from PdfAppearance)

See Also

PDF Specification ISO 32000-1:2008, section '12.5.6.23 Redaction Annotations'