PdfDocumentRedactions
OfficeIMO.Pdf
Permanent redaction operations for one PDF document.
Inheritance
- object
- PdfDocumentRedactions
Usage
Explore 1 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 1
- Property PdfDocument.Redactions
Methods
public PdfDocument AddAnnotation(PdfRedactionAnnotationOptions options, CancellationToken cancellationToken = default) #Adds standard PDF /Redact review annotations for every canonical area in a region.
Parameters
- options OfficeIMO.Pdf.PdfRedactionAnnotationOptions
- cancellationToken System.Threading.CancellationToken = default
Returns
PdfDocumentpublic PdfDocument Apply(IEnumerable<PdfRedactionArea> areas, PdfRedactionApplyOptions? applyOptions = null, PdfTextLayoutOptions? layoutOptions = null, PdfLoadOptions? options = null, CancellationToken cancellationToken = default) #Creates 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
- cancellationToken System.Threading.CancellationToken = default
Returns
PdfDocumentpublic PdfDocument Apply(PdfRedactionPlan plan, PdfRedactionApplyOptions? applyOptions = null, PdfTextLayoutOptions? layoutOptions = null, PdfLoadOptions? options = null, CancellationToken cancellationToken = default) #Applies 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
- cancellationToken System.Threading.CancellationToken = default
Returns
PdfDocumentpublic PdfRedactionApplyResult ApplyWithEvidence(PdfRedactionPlan plan, PdfRedactionApplyOptions? applyOptions = null, PdfRedactionVerificationOptions? verificationOptions = null, PdfTextLayoutOptions? layoutOptions = null, PdfLoadOptions? options = null, CancellationToken cancellationToken = default) #Applies 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
- cancellationToken System.Threading.CancellationToken = default
Returns
PdfRedactionApplyResultpublic PdfRedactionVerificationReport AssertAppliedPlan(PdfRedactionPlan reviewedPlan, PdfRedactionVerificationOptions options, CancellationToken cancellationToken = default) #Verifies a reviewed plan and throws when planned content remains in its areas.
Parameters
- reviewedPlan OfficeIMO.Pdf.PdfRedactionPlan
- options OfficeIMO.Pdf.PdfRedactionVerificationOptions
- cancellationToken System.Threading.CancellationToken = default
public PdfRedactionVerificationReport AssertVerified(PdfRedactionVerificationOptions options, CancellationToken cancellationToken = default) #Verifies configured markers and throws when redaction proof fails.
Parameters
- options OfficeIMO.Pdf.PdfRedactionVerificationOptions
- cancellationToken System.Threading.CancellationToken = default
public PdfRedactionPlan Plan(IEnumerable<PdfRedactionRegion> regions, PdfTextLayoutOptions? layoutOptions = null, PdfLoadOptions? options = null, CancellationToken cancellationToken = default) #Plans rich review regions with cooperative cancellation.
Parameters
- regions System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfRedactionRegion>
- layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions? = null
- options OfficeIMO.Pdf.PdfLoadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
PdfRedactionPlanpublic PdfRedactionPlan Plan(IEnumerable<PdfRedactionArea> areas, PdfTextLayoutOptions? layoutOptions = null, PdfLoadOptions? options = null, CancellationToken cancellationToken = default) #Plans rectangle-based redaction impact with cooperative cancellation.
Parameters
- areas System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfRedactionArea>
- layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions? = null
- options OfficeIMO.Pdf.PdfLoadOptions? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
PdfRedactionPlanpublic PdfRedactionPlan PlanAnnotations(PdfTextLayoutOptions? layoutOptions = null, PdfLoadOptions? options = null) #Builds 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
Returns
PdfRedactionPlanpublic PdfRedactionPlan Search(PdfRedactionSearchOptions search, PdfTextLayoutOptions? layoutOptions = null, PdfLoadOptions? options = null, CancellationToken cancellationToken = default) #Searches 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
- cancellationToken System.Threading.CancellationToken = default
Returns
PdfRedactionPlanpublic PdfRedactionVerificationReport Verify(PdfRedactionVerificationOptions options, CancellationToken cancellationToken = default) #Verifies configured removed and retained markers in the rewritten PDF.
Parameters
- options OfficeIMO.Pdf.PdfRedactionVerificationOptions
- cancellationToken System.Threading.CancellationToken = default
public PdfRedactionVerificationReport VerifyAppliedPlan(PdfRedactionPlan reviewedPlan, PdfRedactionVerificationOptions options, CancellationToken cancellationToken = default) #Verifies configured markers and reports any content still intersecting the reviewed plan areas.
Parameters
- reviewedPlan OfficeIMO.Pdf.PdfRedactionPlan
- options OfficeIMO.Pdf.PdfRedactionVerificationOptions
- cancellationToken System.Threading.CancellationToken = default