Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 565 stars PSWriteOfficePowerShell module 165 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

OfficeWorkflow

Edit on GitHub
Namespace OfficeIMO.Workflows
Assembly OfficeIMO.Workflows
Source ../../../../_/OfficeIMO.Workflows/OfficeWorkflow.cs:7
Modifiers static

Creates fluent local document workflows over OfficeWorkflowRunner.

Inheritance

  • Object
  • OfficeWorkflow

Methods

public static OfficeWorkflowBuilder Compare(String inputPath, String comparisonPath) #
../../../../_/OfficeIMO.Workflows/OfficeWorkflow.cs:15
Returns: OfficeWorkflowBuilder

Creates a PDF comparison workflow.

Parameters

inputPath System.String requiredposition: 0
comparisonPath System.String requiredposition: 1
public static OfficeWorkflowBuilder Convert(String inputPath) #
../../../../_/OfficeIMO.Workflows/OfficeWorkflow.cs:7
Returns: OfficeWorkflowBuilder

Creates a conversion workflow. Supply a route with String) or an output path with String).

Parameters

inputPath System.String requiredposition: 0
public static OfficeWorkflowBuilder ExtractPages(String inputPath, params Int32[] pageNumbers) #
../../../../_/OfficeIMO.Workflows/OfficeWorkflow.cs:35
Returns: OfficeWorkflowBuilder

Creates a PDF extraction workflow preserving the supplied page order and repeats.

Parameters

inputPath System.String requiredposition: 0
pageNumbers System.Int32[] requiredposition: 1
public static OfficeWorkflowBuilder Inspect(String inputPath) #
../../../../_/OfficeIMO.Workflows/OfficeWorkflow.cs:11
Returns: OfficeWorkflowBuilder

Creates a PDF inspection workflow.

Parameters

inputPath System.String requiredposition: 0
public static OfficeWorkflowBuilder Optimize(String inputPath) #
../../../../_/OfficeIMO.Workflows/OfficeWorkflow.cs:19
Returns: OfficeWorkflowBuilder

Creates a lossless PDF optimization workflow.

Parameters

inputPath System.String requiredposition: 0
public static OfficeWorkflowBuilder PlanRepair(String inputPath) #
../../../../_/OfficeIMO.Workflows/OfficeWorkflow.cs:23
Returns: OfficeWorkflowBuilder

Creates a report-only PDF repair-planning workflow.

Parameters

inputPath System.String requiredposition: 0
public static OfficeWorkflowBuilder ProtectPdf(String inputPath, PdfStandardEncryptionOptions encryption) #
../../../../_/OfficeIMO.Workflows/OfficeWorkflow.cs:40
Returns: OfficeWorkflowBuilder

Creates a password-protected PDF copy using captured output settings.

Parameters

inputPath System.String requiredposition: 0
encryption OfficeIMO.Pdf.PdfStandardEncryptionOptions requiredposition: 1
public static OfficeWorkflowBuilder RemovePdfProtection(String inputPath, String ownerPassword) #
../../../../_/OfficeIMO.Workflows/OfficeWorkflow.cs:45
Returns: OfficeWorkflowBuilder

Creates an unencrypted PDF copy with the current owner password.

Parameters

inputPath System.String requiredposition: 0
ownerPassword System.String requiredposition: 1
public static OfficeWorkflowBuilder Repair(String inputPath) #
../../../../_/OfficeIMO.Workflows/OfficeWorkflow.cs:27
Returns: OfficeWorkflowBuilder

Creates a verified PDF repair workflow.

Parameters

inputPath System.String requiredposition: 0
public static Task<OfficeWorkflowResult> RunAsync(OfficeWorkflowRequest request, IProgress<OfficeWorkflowProgress> progress = null, CancellationToken cancellationToken = default) #
../../../../_/OfficeIMO.Workflows/OfficeWorkflow.cs:60
Returns: Task<OfficeWorkflowResult>

Runs an explicitly constructed request through the default local runner.

Parameters

request OfficeIMO.Workflows.OfficeWorkflowRequest requiredposition: 0
progress System.IProgress{OfficeIMO.Workflows.OfficeWorkflowProgress} = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
public static OfficeWorkflowBuilder Sanitize(String inputPath) #
../../../../_/OfficeIMO.Workflows/OfficeWorkflow.cs:31
Returns: OfficeWorkflowBuilder

Creates a verified PDF sanitization workflow.

Parameters

inputPath System.String requiredposition: 0
public static OfficeWorkflowBuilder SignPdf(String inputPath, IPdfExternalSigner signer, PdfExternalSignatureOptions options, IPdfSignatureCryptographyProvider verifier) #
../../../../_/OfficeIMO.Workflows/OfficeWorkflow.cs:50
Returns: OfficeWorkflowBuilder

Creates a signed PDF copy with captured appearance settings and a caller-owned signer and verifier.

Parameters

inputPath System.String requiredposition: 0
signer OfficeIMO.Pdf.IPdfExternalSigner requiredposition: 1
options OfficeIMO.Pdf.PdfExternalSignatureOptions requiredposition: 2
verifier OfficeIMO.Pdf.IPdfSignatureCryptographyProvider requiredposition: 3