API Reference
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
public PdfDocument AddAnnotation(PdfRedactionAnnotationOptions options) #PdfDocumentAdds standard PDF /Redact review annotations for every canonical area in a region.
Parameters
- options OfficeIMO.Pdf.PdfRedactionAnnotationOptions
public PdfDocument Apply(IEnumerable<PdfRedactionArea> areas, PdfRedactionApplyOptions applyOptions = null, PdfTextLayoutOptions layoutOptions = null, PdfLoadOptions options = null) #PdfDocumentCreates a new PDF with intersecting 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.PdfLoadOptions = null
public PdfDocument Apply(PdfRedactionPlan plan, PdfRedactionApplyOptions applyOptions = null, PdfTextLayoutOptions layoutOptions = null, PdfLoadOptions options = null) #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.PdfLoadOptions = null
public PdfOperationResult<PdfDocument> ApplyResult(IEnumerable<PdfRedactionArea> areas, PdfRedactionApplyOptions applyOptions = null, PdfTextLayoutOptions layoutOptions = null, PdfLoadOptions options = null) #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.PdfLoadOptions = null
public PdfRedactionApplyResult ApplyWithEvidence(PdfRedactionPlan plan, PdfRedactionApplyOptions applyOptions = null, PdfRedactionVerificationOptions verificationOptions = null, PdfTextLayoutOptions layoutOptions = null, PdfLoadOptions options = null) #PdfRedactionApplyResultApplies a source-bound reviewed plan and returns the rewritten PDF, selected mutation path, and actual-versus-planned evidence from the rewritten artifact.
Parameters
- plan OfficeIMO.Pdf.PdfRedactionPlan
- applyOptions OfficeIMO.Pdf.PdfRedactionApplyOptions = null
- verificationOptions OfficeIMO.Pdf.PdfRedactionVerificationOptions = null
- layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null
- options OfficeIMO.Pdf.PdfLoadOptions = null
public PdfOperationResult<PdfRedactionApplyResult> ApplyWithEvidenceResult(PdfRedactionPlan plan, PdfRedactionApplyOptions applyOptions = null, PdfRedactionVerificationOptions verificationOptions = null, PdfTextLayoutOptions layoutOptions = null, PdfLoadOptions options = null) #PdfOperationResult<PdfRedactionApplyResult>Attempts to apply a reviewed plan and returns diagnostics instead of throwing when the mutation is blocked or fails.
Parameters
- plan OfficeIMO.Pdf.PdfRedactionPlan
- applyOptions OfficeIMO.Pdf.PdfRedactionApplyOptions = null
- verificationOptions OfficeIMO.Pdf.PdfRedactionVerificationOptions = null
- layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null
- options OfficeIMO.Pdf.PdfLoadOptions = null
public PdfRedactionVerificationReport AssertAppliedPlan(PdfRedactionPlan reviewedPlan, PdfRedactionVerificationOptions options) #PdfRedactionVerificationReportVerifies a reviewed plan and throws when planned content remains in its areas.
Parameters
- reviewedPlan OfficeIMO.Pdf.PdfRedactionPlan
- options OfficeIMO.Pdf.PdfRedactionVerificationOptions
public PdfRedactionVerificationReport AssertVerified(PdfRedactionVerificationOptions options) #PdfRedactionVerificationReportVerifies configured markers and throws when redaction proof fails.
Parameters
- options OfficeIMO.Pdf.PdfRedactionVerificationOptions
public PdfRedactionPlan Plan(IEnumerable<PdfRedactionRegion> regions, PdfTextLayoutOptions layoutOptions = null, PdfLoadOptions options = null) #PdfRedactionPlanPlans one or more rich review regions while retaining their exact destructive geometry.
Parameters
- regions System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfRedactionRegion}
- layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null
- options OfficeIMO.Pdf.PdfLoadOptions = null
public PdfRedactionPlan Plan(IEnumerable<PdfRedactionRegion> regions, CancellationToken cancellationToken, PdfTextLayoutOptions layoutOptions = null, PdfLoadOptions options = null) #PdfRedactionPlanPlans rich review regions with cooperative cancellation.
Parameters
- regions System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfRedactionRegion}
- cancellationToken System.Threading.CancellationToken
- layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null
- options OfficeIMO.Pdf.PdfLoadOptions = null
public PdfRedactionPlan Plan(IEnumerable<PdfRedactionArea> areas, PdfTextLayoutOptions layoutOptions = null, PdfLoadOptions options = null) #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.PdfLoadOptions = null
public PdfRedactionPlan Plan(IEnumerable<PdfRedactionArea> areas, CancellationToken cancellationToken, PdfTextLayoutOptions layoutOptions = null, PdfLoadOptions options = null) #PdfRedactionPlanPlans rectangle-based redaction impact with cooperative cancellation.
Parameters
- areas System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfRedactionArea}
- cancellationToken System.Threading.CancellationToken
- layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null
- options OfficeIMO.Pdf.PdfLoadOptions = null
public PdfRedactionPlan PlanAnnotations(PdfTextLayoutOptions layoutOptions = null, PdfLoadOptions options = null) #PdfRedactionPlanBuilds a source-bound plan from standard PDF /Redact annotations already present in the document.
Parameters
- layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null
- options OfficeIMO.Pdf.PdfLoadOptions = null
public PdfRedactionPlan Search(PdfRedactionSearchOptions search, PdfTextLayoutOptions layoutOptions = null, PdfLoadOptions options = null) #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.PdfLoadOptions = null
public PdfRedactionVerificationReport Verify(PdfRedactionVerificationOptions options) #PdfRedactionVerificationReportVerifies configured removed and retained markers in the rewritten PDF.
Parameters
- options OfficeIMO.Pdf.PdfRedactionVerificationOptions
public PdfRedactionVerificationReport VerifyAppliedPlan(PdfRedactionPlan reviewedPlan, PdfRedactionVerificationOptions options) #PdfRedactionVerificationReportVerifies configured markers and reports any content still intersecting the reviewed plan areas.
Parameters
- reviewedPlan OfficeIMO.Pdf.PdfRedactionPlan
- options OfficeIMO.Pdf.PdfRedactionVerificationOptions