API Reference
Class
PdfDocumentRedactions
Permanent redaction operations for one PDF document.
Inheritance
- Object
- PdfDocumentRedactions
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
- Property PdfDocument.Redactions
Methods
Apply 2 overloads
public PdfDocument Apply(IEnumerable<PdfRedactionArea> areas, PdfRedactionApplyOptions applyOptions = null, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #Returns:
PdfDocumentCreates a new PDF with content and annotations removed from the supplied areas.
Parameters
- areas System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfRedactionArea}
- applyOptions OfficeIMO.Pdf.PdfRedactionApplyOptions = null
- layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfDocument Apply(PdfRedactionPlan plan, PdfRedactionApplyOptions applyOptions = null, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #Returns:
PdfDocumentApplies a reviewed redaction plan, including exact field removal.
Parameters
- plan OfficeIMO.Pdf.PdfRedactionPlan
- applyOptions OfficeIMO.Pdf.PdfRedactionApplyOptions = null
- layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfRedactionVerificationReport AssertVerified(PdfRedactionVerificationOptions options) #Returns:
PdfRedactionVerificationReportVerifies configured markers and throws when redaction proof fails.
Parameters
- options OfficeIMO.Pdf.PdfRedactionVerificationOptions
public PdfRedactionPlan Plan(IEnumerable<PdfRedactionArea> areas, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #Returns:
PdfRedactionPlanPlans rectangle-based redaction impact without modifying the PDF.
Parameters
- areas System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfRedactionArea}
- layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfRedactionPlan Search(PdfRedactionSearchOptions search, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #Returns:
PdfRedactionPlanSearches literal text, regex, logical kinds, and form-field names into a reviewable plan.
Parameters
- search OfficeIMO.Pdf.PdfRedactionSearchOptions
- layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfOperationResult<PdfDocument> TryApply(IEnumerable<PdfRedactionArea> areas, PdfRedactionApplyOptions applyOptions = null, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #Returns:
PdfOperationResult<PdfDocument>Attempts to apply redactions and returns preflight diagnostics when blocked.
Parameters
- areas System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfRedactionArea}
- applyOptions OfficeIMO.Pdf.PdfRedactionApplyOptions = null
- layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null
- options OfficeIMO.Pdf.PdfReadOptions = null
public PdfRedactionVerificationReport Verify(PdfRedactionVerificationOptions options) #Returns:
PdfRedactionVerificationReportVerifies configured removed and retained markers in the rewritten PDF.
Parameters
- options OfficeIMO.Pdf.PdfRedactionVerificationOptions