PageRedactor Class

Provides functionalities to perform page redaction.

Inheritance

System.Object

PageRedactor

Namespace: Syncfusion.Windows.PdfViewer

Assembly: Syncfusion.PdfViewer.WPF.dll

Syntax

public class PageRedactor : Object

Properties

EnableRedactionMode

Enables redaction mode. The default value is false.

Declaration

public bool EnableRedactionMode { get; set; }

Property Value

Type
System.Boolean

Methods

ApplyRedaction()

Applies redaction to the marked region.

Declaration

public void ApplyRedaction()

MarkRegions(Int32, List<RectangleF>)

Marks the regions to be redacted in the pages.

Declaration

public void MarkRegions(int pageIndex, List<RectangleF> regions)

Parameters

Type	Name	Description
System.Int32	pageIndex	The index of the page and it is a zero-based.
System.Collections.Generic.List<System.Drawing.RectangleF>	regions	Collection of rectangles to be marked for redaction in the respective pages.

Remarks

TheMarkRegions(Int32, List<RectangleF>) will clear the existing marked (unredacted) regions for redaction.Use clearExisting overload of theMarkRegions(Int32, List<RectangleF>) to not clear the existing marked (unredacted) regions.

MarkRegions(Int32, List<RectangleF>, Boolean)

Marks the regions to be redacted in the pages.

Declaration

public void MarkRegions(int pageIndex, List<RectangleF> regions, bool clearExisting)

Parameters

Type	Name	Description
System.Int32	pageIndex	The index of the page and it is a zero-based.
System.Collections.Generic.List<System.Drawing.RectangleF>	regions	Collection of rectangles to be marked for redaction in the respective pages.
System.Boolean	clearExisting	true to clear the existing marked (unredacted) regions for redaction; false to not clear the existing marked(unredacted) regions for redaction

Events

RedactionApplied

Occurs when the redaction is applied to the PDF pages.

Declaration

public event EventHandler<RedactionEventArgs> RedactionApplied

Event Type

Type
System.EventHandler<RedactionEventArgs>