RedactorAppearance Class

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

Inheritance Hierarchy

SystemObject
pdftron.PDFRedactorAppearance

Namespace: pdftron.PDF
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255

Syntax

C++

JavaScript

Copy

public sealed class RedactorAppearance

Public NotInheritable Class RedactorAppearance

public ref class RedactorAppearance sealed

pdftron.PDF.RedactorAppearance = function();

Type.createClass(
	'pdftron.PDF.RedactorAppearance');

The RedactorAppearance type exposes the following members.

Constructors

	Name	Description
	RedactorAppearance	Initializes a new instance of the RedactorAppearance class

Top

Properties

	Name	Description
	Border	Border specifies if the overlay will be surrounded by a border.
	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.
	MaxFontSize	Specifies the maximum font size used to represent the text in the overlay.
	MinFontSize	Specifies the font used to represent the text in the overlay.
	NegativeOverlayColor	NegativeOverlayColor defines the overlay background color in RGB color space for negative redactions.
	Overlay	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.
	OverlayText	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.
	PositiveOverlayColor	PositiveOverlayColor defines the overlay background color in RGB color space for positive redactions.
	RedactedContentColor	Specifies the color used to paint the regions where content was removed.
	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.
	TextColor	Specifies the color used to paint the text in the overlay (in RGB).
	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.

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

pdftron.PDF Namespace