OfficeWorkflow
OfficeIMO.Workflows
Creates fluent local document workflows over OfficeWorkflowRunner.
Inheritance
- object
- OfficeWorkflow
Methods
public static OfficeWorkflowBuilder Compare(string inputPath, string comparisonPath) #Creates a PDF comparison workflow.
Parameters
- inputPath string
- comparisonPath string
Returns
OfficeWorkflowBuilderpublic static OfficeWorkflowBuilder ConvertToPdfA(string inputPath, PdfAConversionOptions? options = null) #Creates a PDF/A copy with captured conversion settings, or the library defaults when options is null. Use OfficeWorkflowBuilder.WithPdfPassword with the owner password for an encrypted source.
Parameters
- inputPath string
- options OfficeIMO.Pdf.PdfAConversionOptions? = null
Returns
OfficeWorkflowBuilderpublic static OfficeWorkflowBuilder ExtractPages(string inputPath, params int[] pageNumbers) #Creates a PDF extraction workflow preserving the supplied page order and repeats.
Parameters
- inputPath string
- pageNumbers int[]
Returns
OfficeWorkflowBuilderpublic static OfficeWorkflowBuilder Inspect(string inputPath) #Creates a PDF inspection workflow.
Parameters
- inputPath string
Returns
OfficeWorkflowBuilderpublic static OfficeWorkflowBuilder Optimize(string inputPath) #Creates a lossless PDF optimization workflow.
Parameters
- inputPath string
Returns
OfficeWorkflowBuilderpublic static OfficeWorkflowBuilder PlanRepair(string inputPath) #Creates a report-only PDF repair-planning workflow.
Parameters
- inputPath string
Returns
OfficeWorkflowBuilderpublic static OfficeWorkflowBuilder ProtectPdf(string inputPath, PdfStandardEncryptionOptions encryption) #Creates a password-protected PDF copy using captured output settings.
Parameters
- inputPath string
- encryption OfficeIMO.Pdf.PdfStandardEncryptionOptions
Returns
OfficeWorkflowBuilderpublic static void RegisterConversions() #Registers the additional Workflows conversion engines with OfficeConverter. Repeated calls reuse the same registrations.
public static OfficeWorkflowBuilder RemovePdfProtection(string inputPath, string ownerPassword) #Creates an unencrypted PDF copy with the current owner password.
Parameters
- inputPath string
- ownerPassword string
Returns
OfficeWorkflowBuilderpublic static OfficeWorkflowBuilder Repair(string inputPath) #Creates a verified PDF repair workflow.
Parameters
- inputPath string
Returns
OfficeWorkflowBuilderpublic static Task<OfficeWorkflowResult> RunAsync(OfficeWorkflowRequest request, IProgress<OfficeWorkflowProgress>? progress = null, CancellationToken cancellationToken = default) #Runs an explicitly constructed request through the default local runner.
Parameters
- request OfficeIMO.Workflows.OfficeWorkflowRequest
- progress System.IProgress<OfficeIMO.Workflows.OfficeWorkflowProgress>? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeWorkflowResult>public static OfficeWorkflowBuilder Sanitize(string inputPath) #Creates a verified PDF sanitization workflow.
Parameters
- inputPath string
Returns
OfficeWorkflowBuilderpublic static OfficeWorkflowBuilder SignPdf(string inputPath, IPdfExternalSigner signer, PdfExternalSignatureOptions options, IPdfSignatureCryptographyProvider verifier) #Creates a signed PDF copy with captured appearance settings and a caller-owned signer and verifier.
Parameters
- inputPath string
- signer OfficeIMO.Pdf.IPdfExternalSigner
- options OfficeIMO.Pdf.PdfExternalSignatureOptions
- verifier OfficeIMO.Pdf.IPdfSignatureCryptographyProvider
Returns
OfficeWorkflowBuilder