API Reference

Class

PdfRedactionArea

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Modifiers sealed

Rectangle requested for redaction planning, using PDF point coordinates from the page bottom-left.

Inheritance

  • Object
  • PdfRedactionArea

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

PdfRedactionArea 4 overloads
public PdfRedactionArea(Int32 pageNumber, Double x, Double y, Double width, Double height, String label = null) #

Creates a redaction area.

Parameters

pageNumber System.Int32 requiredposition: 0
x System.Double requiredposition: 1
y System.Double requiredposition: 2
width System.Double requiredposition: 3
height System.Double requiredposition: 4
label System.String = null optionalposition: 5
public PdfRedactionArea(Int32 pageNumber, Double x, Double y, Double width, Double height, String label, PdfRedactionContentScope contentScope) #

Creates a redaction area with an explicit intersecting-content policy.

Parameters

pageNumber System.Int32 requiredposition: 0
x System.Double requiredposition: 1
y System.Double requiredposition: 2
width System.Double requiredposition: 3
height System.Double requiredposition: 4
label System.String requiredposition: 5
contentScope OfficeIMO.Pdf.PdfRedactionContentScope requiredposition: 6
public PdfRedactionArea(Int32 pageNumber, Double x, Double y, Double width, Double height, String label, PdfRedactionAppearanceMode appearanceMode) #

Creates a redaction area with an explicit visible-appearance policy.

Parameters

pageNumber System.Int32 requiredposition: 0
x System.Double requiredposition: 1
y System.Double requiredposition: 2
width System.Double requiredposition: 3
height System.Double requiredposition: 4
label System.String requiredposition: 5
appearanceMode OfficeIMO.Pdf.PdfRedactionAppearanceMode requiredposition: 6
public PdfRedactionArea(Int32 pageNumber, Double x, Double y, Double width, Double height, String label, PdfRedactionContentScope contentScope, PdfRedactionAppearanceMode appearanceMode) #

Creates a redaction area with explicit intersecting-content and visible-appearance policies.

Parameters

pageNumber System.Int32 requiredposition: 0
x System.Double requiredposition: 1
y System.Double requiredposition: 2
width System.Double requiredposition: 3
height System.Double requiredposition: 4
label System.String requiredposition: 5
contentScope OfficeIMO.Pdf.PdfRedactionContentScope requiredposition: 6
appearanceMode OfficeIMO.Pdf.PdfRedactionAppearanceMode requiredposition: 7

Properties

public Int32 PageNumber { get; } #

One-based page number.

public Double X { get; } #

Left coordinate in PDF points.

public Double Y { get; } #

Bottom coordinate in PDF points.

public Double Width { get; } #

Rectangle width in PDF points.

public Double Height { get; } #

Rectangle height in PDF points.

public String Label { get; } #

Optional caller label.

public PdfRedactionContentScope ContentScope { get; } #

Intersecting content removal policy for this reviewed area.

public PdfRedactionAppearanceMode AppearanceMode { get; } #

Visible privacy-appearance policy for this reviewed area.

public Double Right { get; } #

Right coordinate in PDF points.

public Double Top { get; } #

Top coordinate in PDF points.