PdfOptions¶
PdfOptions carries the per-request output-format and cleanup preferences attached to every PdfRequest. Its CleanupInputFile flag (default true when Options is null) determines whether Validate a document deletes the source file from disk before signature validation. (BR-07)
Purpose¶
- Configures the requested output format (
OutputFormat) and whether the on-disk source file should be removed after processing (CleanupInputFile). (BR-07) - Signals whether the output should be prevented from transferring (
PreventOutputFileTransfer).
Context¶
- Namespace:
PdfAPI.Core - Assembly/package:
PdfAPI.Core
Public members¶
| Member | Signature | Purpose |
|---|---|---|
| IsPdfa | bool IsPdfa { get; } |
Indicates whether the configured OutputFormat is PDF/A. |
| OutputFormat | PdfFormat OutputFormat { get; set; } |
The requested output document format. |
| PreventOutputFileTransfer | bool PreventOutputFileTransfer { get; set; } |
Whether the output file should be prevented from being transferred onward. |
| CleanupInputFile | bool CleanupInputFile { get; set; } |
Whether the source file should be deleted from disk after (or before) validation. (BR-07) |
| PdfOptions() (3 overloads) | Three public constructors | Construct options with differing combinations of default and explicit values. |
Behavioral notes¶
IsPdfais computed fromOutputFormatrather than stored independently.*- When
Optionsis null on aDocument/request, Validate a document treats cleanup as enabled by default. (BR-07)
Constraints and usage notes¶
- Set
OutputFormattoPdfAto makeIsPdfareturntrue; there is no independent setter.
Note: Statements marked with
*were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts.
Related documentation¶
- Index
- Overview
- Architecture
- Dependencies
- Operations and processes
- Business rules
- Security and authorization
- API reference
Sources¶
PdfAPI.Core\PdfOptions.cs