# PdfRedactionRecipe

Versioned, reusable PDF redaction recipe.

Class 

`OfficeIMO.Workflows`

**Namespace**

`OfficeIMO.Workflows`

**Assembly**

`OfficeIMO.Workflows`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[PdfRedactionWorkflowContracts.cs:122](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionWorkflowContracts.cs#L122)

**Modifiers**

sealed

Versioned, reusable PDF redaction recipe.

## Inheritance

- object
- PdfRedactionRecipe

## Usage

Explore 2 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 2

- Property [PdfRedactionBatchRequest.Recipe](/api/workflows/officeimo-workflows-pdfredactionbatchrequest/#property-recipe)
- Property [PdfRedactionWorkflowRequest.Recipe](/api/workflows/officeimo-workflows-pdfredactionworkflowrequest/#property-recipe)

Filter members 

Show inherited

## Constructors

`public PdfRedactionRecipe()` [#](#constructor-ctor)

[PdfRedactionWorkflowContracts.cs:122](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionWorkflowContracts.cs#L122)

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public string Schema { get; set; }` [#](#property-schema)

[PdfRedactionWorkflowContracts.cs:122](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionWorkflowContracts.cs#L122)

Schema identifier.

`public PdfRedactionDetectionMode DetectionMode { get; set; }` [#](#property-detectionmode)

[PdfRedactionWorkflowContracts.cs:124](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionWorkflowContracts.cs#L124)

Native/OCR discovery policy.

`public bool MatchCase { get; set; }` [#](#property-matchcase)

[PdfRedactionWorkflowContracts.cs:126](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionWorkflowContracts.cs#L126)

Case-sensitive literal matching when true.

`public int RegexTimeoutMilliseconds { get; set; }` [#](#property-regextimeoutmilliseconds)

[PdfRedactionWorkflowContracts.cs:128](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionWorkflowContracts.cs#L128)

Per-match regex timeout in milliseconds.

`public IList<PdfRedactionRule> Rules { get; set; }` [#](#property-rules)

[PdfRedactionWorkflowContracts.cs:130](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionWorkflowContracts.cs#L130)

Search rules.

`public IList<PdfRedactionRecipeRegion> Regions { get; set; }` [#](#property-regions)

[PdfRedactionWorkflowContracts.cs:132](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionWorkflowContracts.cs#L132)

Explicit review regions.

`public PdfRedactionCleanupScope CleanupScope { get; set; }` [#](#property-cleanupscope)

[PdfRedactionWorkflowContracts.cs:134](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionWorkflowContracts.cs#L134)

Cleanup policy applied during destructive redaction.

`public bool RemoveIntersectingPaths { get; set; }` [#](#property-removeintersectingpaths)

[PdfRedactionWorkflowContracts.cs:136](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionWorkflowContracts.cs#L136)

Whether intersecting page-level vector paths are removed.

`public PdfRedactionUnsupportedImagePolicy UnsupportedImagePolicy { get; set; }` [#](#property-unsupportedimagepolicy)

[PdfRedactionWorkflowContracts.cs:138](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionWorkflowContracts.cs#L138)

Policy for unsupported image rewrites.

`public PdfRedactionEncryptedDocumentPolicy EncryptedDocumentPolicy { get; set; }` [#](#property-encrypteddocumentpolicy)

[PdfRedactionWorkflowContracts.cs:140](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionWorkflowContracts.cs#L140)

Policy for encrypted input.

`public PdfRedactionSignaturePolicy SignaturePolicy { get; set; }` [#](#property-signaturepolicy)

[PdfRedactionWorkflowContracts.cs:142](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionWorkflowContracts.cs#L142)

Signed-source and output-derivative policy.

## Fields

`public const string CurrentSchema` [#](#field-currentschema)

[PdfRedactionWorkflowContracts.cs:120](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/PdfRedactionWorkflowContracts.cs#L120)

Stable recipe schema.

Value: `officeimo.pdf.redaction.recipe.v1`

<!-- PowerForge markdown artifact sha256:AD74076A603069D7E1FD3DC0FD0B834C6DA2015EE5F8647843AE835EA0286391 -->
