OfficeWorkflowRequest
OfficeIMO.Workflows
One typed local workflow request.
Inheritance
- object
- OfficeWorkflowRequest
Usage
Explore 6 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
- Method OfficeWorkflowBuilder.Build
Accepted by parameters 5
- Method IOfficeWorkflowRunner.RunAsync
- Method IOfficeWorkflowRunner.RunBatchAsync
- Method OfficeWorkflow.RunAsync
- Method OfficeWorkflowRunner.RunAsync
- Method OfficeWorkflowRunner.RunBatchAsync
Constructors
public OfficeWorkflowRequest() #Obsolete("Constructors of types with required members are not supported in this version of your compiler.", true)Inherited Methods
Properties
public string Id { get; set; } #Caller-provided request identifier used by progress and batch results.
public OfficeWorkflowOperation Operation { get; set; } #Requested operation.
public OfficeWorkflowStreamInput? InputStream { get; set; } #Optional provider access for OfficeWorkflowRequest.InputPath. The path remains the original location or absolute URI.
public OfficeWorkflowDirectoryPackageInput? InputDirectoryPackage { get; set; } #Optional provider directory package for a registered conversion route. Mutually exclusive with InputStream; requires an explicit output.
public int[]? PageNumbers { get; set; } #Ordered one-based pages for ExtractPages, including intentional repeats. Limited to 100,000 entries.
public OfficePageSelector? PageSelector { get; set; } #Document-relative ordered selection for ExtractPages, resolved against the captured input. Cannot be combined with PageNumbers.
public int MaximumExtractedPages { get; set; } #Maximum selected pages for ExtractPages, including repeats. Must be 1 through 100,000.
public string? ComparisonPath { get; set; } #Comparison input used by OfficeWorkflowOperation.Compare.
public OfficeWorkflowStreamInput? ComparisonStream { get; set; } #Optional provider access for OfficeWorkflowRequest.ComparisonPath.
public OfficePageSelector? ComparisonExpectedPages { get; set; } #Ordered expected-page scope for Compare; null selects the whole primary document.
public OfficePageSelector? ComparisonActualPages { get; set; } #Ordered actual-page scope for Compare; null selects the whole comparison document. Pages are paired by selection position.
public string? ConversionRouteId { get; set; } #Conversion route identifier from OfficeWorkflowCatalog.
public OfficeConversionOptions? ConversionOptions { get; set; } #Optional route-specific settings, independently copied and validated before asynchronous execution.
public IOfficeConversionSettings? RegisteredConversionSettings { get; set; } #Adapter-owned conversion settings, validated and independently copied by the selected registration before execution.
public OfficeScanCleanupOptions? ScanCleanup { get; set; } #Explicit scan preparation and raster-output acknowledgement for ScanCleanup.
public WordImageOptimizationOptions? WordImageOptimization { get; set; } #Embedded-media settings for AnalyzeWordImages and OptimizeWordImages.
public string? OutputPath { get; set; } #Requested output file. Inspect does not require one; compare emits HTML when one is supplied.
public OfficeWorkflowStreamOutput? OutputStream { get; set; } #Optional verified direct-write access for the original OfficeWorkflowRequest.OutputPath provider location.
public OfficePublicationPolicy ConflictPolicy { get; set; } #Conflict behavior used when publishing an artifact.
public IOfficePublicationGuard? PublicationGuard { get; set; } #Optional live application ownership check for final publication candidates.
public OfficeConversionProfile OutputProfile { get; set; } #Cross-format output intent.
public string? PdfPassword { get; set; } #Optional PDF password. It is used only while executing and is never copied to results or reports.
public PdfLoadOptions? InputPdfLoadOptions { get; set; } #Optional primary PDF read settings, including resource limits, for PDF conversion. Independently copied before execution.
public string? ComparisonPdfPassword { get; set; } #Optional password for the comparison PDF. When omitted, OfficeWorkflowRequest.PdfPassword is reused. It is used only while executing and is never copied to results or reports.
public PdfStandardEncryptionOptions? OutputEncryption { get; set; } #New password protection for ProtectPdf. Cloned before execution; credentials remain request-only.
public PdfAConversionOptions? PdfAConversion { get; set; } #PDF/A conversion settings for ConvertToPdfA. When omitted, the library defaults apply. Copied before execution. An encrypted source needs its owner password in OfficeWorkflowRequest.PdfPassword; the PDF/A copy is written without encryption.
public string? PdfOwnerPassword { get; set; } #Current owner password for replacing or removing protection. Falls back to PdfPassword when omitted.
public IPdfExternalSigner? OutputSigner { get; set; } #Runtime signer for SignPdf. The caller retains ownership and must keep it alive until execution completes.
public PdfExternalSignatureOptions? OutputSignatureOptions { get; set; } #Signature and appearance settings for SignPdf, copied before asynchronous execution.
public IPdfSignatureCryptographyProvider? OutputSignatureValidator { get; set; } #Required runtime cryptographic verifier for SignPdf. Chain trust is reported independently from signature math.
public OfficeOperationLimits Limits { get; set; } #Shared request resource limits.