Redaction Class

A redaction annotation (PDF 1.7) identifies content that is intended to be removed from the document. The intent of redaction annotations is to enable the following process: a)Content identification. A user applies redact annotations that specify the pieces or regions of content that should be removed. Up until the next step is performed, the user can see, move and redefine these annotations. b)Content removal. The user instructs the viewer application to apply the redact annotations, after which the content in the area specified by the redact annotations is removed. In the removed content’s place, some marking appears to indicate the area has been redacted. Also, the redact annotations are removed from the PDF document.

Redaction annotations provide a mechanism for the first step in the redaction process (content identification). This allows content to be marked for redaction in a non-destructive way, thus enabling a review process for evaluating potential redactions prior to removing the specified content.

Redaction annotations shall provide enough information to be used in the second phase of the redaction process (content removal). This phase is application-specific and requires the conforming reader to remove all content identified by the redaction annotation, as well as the annotation itself.

Conforming readers that support redaction annotations shall provide a mechanism for applying content removal, and they shall remove all traces of the specified content. If a portion of an image is contained in a redaction region, that portion of the image data shall be destroyed; clipping or image masks shall not be used to hide that data. Such conforming readers shall also be diligent in their consideration of all content that can exist in a PDF document, including XML Forms Architecture (XFA) content and Extensible Metadata Platform (XMP) content.

Inheritance Hierarchy

SystemObject
pdftron.PDF.AnnotsRedaction

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

Syntax

C++

JavaScript

Copy

public sealed class Redaction : IClosable, 
	IAnnot, IMarkup

Public NotInheritable Class Redaction
	Implements IClosable, IAnnot, IMarkup

public ref class Redaction sealed : IClosable, 
	IAnnot, IMarkup

pdftron.PDF.Annots.Redaction = function();

Type.createClass(
	'pdftron.PDF.Annots.Redaction',
	null,
	Windows.Foundation.IClosable,
	pdftron.PDF.IAnnot,
	pdftron.PDF.Annots.IMarkup);

The Redaction type exposes the following members.

Constructors

	Name	Description
	Redaction	Creates an Redaction annotation and initialize it using given Cos/SDF object.

Top

Methods

	Name	Description
	Close
	Create	Creates a new Redaction annotation, in the specified document.
	DeleteCustomData	Deletes custom data associated with the given key.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Flatten	Flatten/Merge the existing annotation appearances with the page content and delete this annotation from a given page. Annotation 'flattening' refers to the operation that changes active annotations (such as markup, widgets, 3D models, etc.) into a static area that is part of the PDF document, just like the other text and images in the document.
	GetAnnotType	Gets the type.
	GetAppearance	Gets the annotation’s appearance for the given combination of annotation and appearance states.
	GetAppearance(AnnotAnnotationState)	Gets the annotation’s appearance for the given combination of annotation and appearance states.
	GetAppearance(AnnotAnnotationState, String)	Gets the annotation’s appearance for the given combination of annotation and appearance states.
	GetAppFormXO	Gets Overlay appearance of the Redaction annotation.
	GetBorderEffect	Gets the Border Effect of the Markup Annotation.
	GetBorderEffectIntensity	Sets the Border Effect of the Markup Annotation. (Optional; PDF 1.5 )
	GetBorderStyle	Gets the border style for the annotation. Typically used for Link annotations.
	GetColorAsCMYK	Gets an annotation's color.
	GetColorAsGray	Gets an annotation's color.
	GetColorAsRGB	Gets the annotation’s active appearance state.
	GetColorCompNum	Gets the color space the annotation's color is represented in.
	GetContentRect	Gets the inner bounding rectangle of the Square. (Optional; PDF 1.5)
	GetContents	Gets the contents.
	GetCreationDates	Gets the creation date of the Markup Annotation
	GetCustomData	Returns custom data associated with the given key.
	GetDate	Gets an annotation's last modified date.
	GetFlag	Gets the flag.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetInteriorColor	Sets the interior color of the Square. (Optional; PDF 1.4 )
	GetInteriorColorCompNum	Gets the number indicating interior color space of the Square.
	GetOpacity	Gets the contant opacity value corresponding to the annotation.
	GetOptionalContent	Gets optional content of an annotation.
	GetOverlayText	Gets Overlay text of the Redaction annotation.
	GetOverlayTextAppearance	Gets Overlay text appearance of the Redaction annotation.
	GetPadding	Gets the rectangle difference of the Square. (Optional; PDF 1.5)
	GetPage	Gets the page the annotation is associated with.
	GetPopup	Gets the Popup object associated with this Markup annotation.
	GetQuadForm	Gets Overlay text quadding(justification) format of the Redaction annotation.
	GetQuadPoint	Gets the QuadPoint located at a certain index of the QuadPoint Array of the Redaction annotation.
	GetQuadPointCount	Gets the number of QuadPoints in the QuadPoints Array of the Redaction annotation.
	GetRect	Gets the rect.
	GetRotation	Gets the rotation value of the annotation.The Rotation specifies the number of degrees by which the annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90.
	GetSDFObj	Gets the SDFObj.
	GetStructParent	Gets the struct parent of an annotation. (Required if the annotation is a structural content item; PDF 1.3)
	GetSubject	Gets subject of the Markup Annotation.
	GetTitle	Gets the title of the Markup Annotation.
	GetTriggerAction	Get the Action associated with the selected Annot Trigger event
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUniqueID	Gets the unique ID.
	GetUseRepeat	Gets the option of whether to use repeat for the Redaction annotation.
	IsMarkup	Checks if is markup.
	IsValid	Checks if is valid.
	RefreshAppearance	Regenerates the appearance stream for the annotation. This method can be used to auto-generate the annotation appearance after creating or modifying the annotation without providing an explicit appearance or setting the "NeedAppearances" flag in the AcroForm dictionary.
	RefreshAppearance(RefreshOptions)	A version of RefreshAppearance allowing custom options to make slight tweaks in behaviour.
	RemoveAppearance	Removes the annotation's appearance
	RemoveAppearance(AnnotAnnotationState)	Removes the annotation's appearance for the given combination of annotation and appearance states.
	RemoveAppearance(AnnotAnnotationState, String)	Removes the annotation's appearance for the given combination of annotation and appearance states.
	Resize	Resize.
	SetAppearance(Obj)	Sets the annotation’s appearance for the given combination of annotation and appearance states. (Optional; PDF 1.2)
	SetAppearance(Obj, AnnotAnnotationState)	Removes the annotation's appearance for the given combination of annotation and appearance states.
	SetAppearance(Obj, AnnotAnnotationState, String)	Sets the annotation’s appearance for the given combination of annotation and appearance states. (Optional; PDF 1.2)
	SetAppFormXO	Sets Overlay appearance of the Redaction annotation. (Optional)
	SetBorderEffectIntensity	Sets the Border Effect Intensity of the Markup Annotation. (Optional; valid only if Border effect is Cloudy)
	SetBorderStyle	Sets the border style for the annotation. Typically used for Link annotations.
	SetColor(ColorPt)	Sets an annotation's color. (Optional; PDF 1.1)
	SetColor(ColorPt, Int32)	Sets an annotation's color. (Optional; PDF 1.1)
	SetContentRect	Sets the inner bounding rectangle of the Square. (Optional; PDF 1.5)
	SetContents	Sets the contents.
	SetCreationDates	Sets the creation date of the Markup Annotation. (Optional; PDF 1.5 )
	SetCustomData	Sets the custom data associated with the specified key.
	SetDate	Sets an annotation's last modified date.
	SetDateToNow	Sets an annotation's modification date and time to the current time. This corresponds to the value of the "M" field of annotation dictionary(PDF 1.1)
	SetFlag	Sets the value of given Flag.
	SetInteriorColor	Gets the interior color of the Square.
	SetOpacity	Sets the contant opacity value corresponding to the annotation. (Optional; PDF 1.4 )
	SetOptionalContent	Sets optional content of an annotation. (Optional, PDF1.5).
	SetOverlayText	Sets Overlay text of the Redaction annotation.
	SetOverlayTextAppearance	Sets Overlay text appearance of the Redaction annotation.
	SetPadding	Sets the rectangle difference of the Square. (Optional; PDF 1.5)
	SetPage	Sets the reference to a page the annotation is associated with. (Optional PDF 1.3; not used in FDF files)
	SetPopup	Sets the Popup object associated with this Markup annotation. (Optional; PDF 1.3 )
	SetQuadForm
	SetQuadForm(RedactionQuadForm)	Creates an Redaction annotation and initialize it using given annotation object.
	SetQuadPoint	Set the QuadPoint to be located at a certain index of the QuadPoint Array of the Redaction annotation. (Optional; PDF 1.6 )
	SetRect	Sets the size and location of an annotation on its page.
	SetRotation	Sets the rotation value of the annotation.The Rotation specifies the number of degrees by which the annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90. (Optional)
	SetStructParent	Sets the struct parent of an annotation. (Required if the annotation is a structural content item; PDF 1.3)
	SetSubject	Sets subject of the Markup Annotation. (Optional; PDF 1.5 )
	SetTitle	Sets the title of the Markup Annotation. (Optional; PDF 1.1)
	SetUniqueID	Sets the unique identifier for this annotation.
	SetUseRepeat
	SetUseRepeat(Boolean)	Sets the option of whether to use repeat for the Redaction annotation.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

pdftron.PDF.Annots Namespace