Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

PdfSearchableWorkflowRequest

OfficeIMO.Workflows

Namespace
OfficeIMO.Workflows
Assembly
OfficeIMO.Workflows
Source revision
ba882f6b0d07 with working tree changes
Modifiers
sealed

Creates a searchable PDF through a caller-owned OCR engine and guarded artifact publication.

Inheritance

  • object
  • PdfSearchableWorkflowRequest

Usage

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

Accepted by parameters 2

Constructors

public PdfSearchableWorkflowRequest() #

Properties

public string Id { get; set; } #

Caller-provided identifier.

public string InputPath { get; set; } #

Source filesystem path or provider location.

public OfficeWorkflowStreamInput? InputStream { get; set; } #

Optional reopenable provider input.

public string OutputPath { get; set; } #

Explicit output filesystem path or provider location.

public OfficeWorkflowStreamOutput? OutputStream { get; set; } #

Optional provider output, requiring confirmed direct-write consent and Replace policy.

public OfficePublicationPolicy ConflictPolicy { get; set; } #

Existing destination policy.

public IOfficePublicationGuard? PublicationGuard { get; set; } #

Host authorization checked immediately before publication.

public OfficeOperationLimits Limits { get; set; } #

Input and output byte limits.

public string? PdfPassword { get; set; } #

Password used to open an encrypted source.

public PdfOcrMergeOptions Ocr { get; set; } #

Recognition, page selection, rendering, and confidence options captured before asynchronous work.

public OfficePageSelector? PageSelector { get; set; } #

Optional document-relative recognition pages, resolved against the captured source. Cannot be combined with Ocr.ReadOptions.PageSelection.

public Func<PdfSearchableOcrReview, CancellationToken, Task<IReadOnlyList<PdfRecognizedWord>>>? ReviewAsync { get; set; } #

Optional review before mutation. Return eligible word instances from the supplied review. The runner validates the selection and rechecks source identity before publication.

public Func<PdfSearchableOcrReview, CancellationToken, Task<IReadOnlyDictionary<PdfRecognizedWord, string>>>? ReviewCorrectionsAsync { get; set; } #

Optional correction review. Return eligible original word instances mapped to nonempty reviewed text. Only returned entries are published. Cannot be combined with PdfSearchableWorkflowRequest.ReviewAsync.