API Reference
OfficeWorkflowBuilder
Fluent configuration for one local document workflow.
Inheritance
- Object
- OfficeWorkflowBuilder
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method OfficeWorkflow.Compare
- Method OfficeWorkflow.Convert
- Method OfficeWorkflow.ExtractPages
- Method OfficeWorkflow.Inspect
- Method OfficeWorkflow.Optimize
- Method OfficeWorkflow.PlanRepair
- Method OfficeWorkflow.ProtectPdf
- Method OfficeWorkflow.RemovePdfProtection
- Method OfficeWorkflow.Repair
- Method OfficeWorkflow.Sanitize
- Method OfficeWorkflow.SignPdf
- Method OfficeWorkflowBuilder.Against
- Method OfficeWorkflowBuilder.OnConflict
- Method OfficeWorkflowBuilder.To
- Method OfficeWorkflowBuilder.Via
- Method OfficeWorkflowBuilder.WithComparisonPdfPassword
- Method OfficeWorkflowBuilder.WithConversionOptions
- Method OfficeWorkflowBuilder.WithId
- Method OfficeWorkflowBuilder.WithLimits
- Method OfficeWorkflowBuilder.WithPdfOwnerPassword
- Method OfficeWorkflowBuilder.WithPdfPassword
- Method OfficeWorkflowBuilder.WithProfile
Methods
public OfficeWorkflowBuilder Against(String comparisonPath) #OfficeWorkflowBuilderSets the comparison input for a compare workflow.
Parameters
- comparisonPath System.String
public OfficeWorkflowRequest Build() #OfficeWorkflowRequestBuilds an independent request snapshot, inferring a locally executable conversion route from file extensions when possible.
public OfficeWorkflowBuilder OnConflict(OfficeWorkflowConflictPolicy policy) #OfficeWorkflowBuilderSets destination conflict behavior.
Parameters
- policy OfficeIMO.Workflows.OfficeWorkflowConflictPolicy
public Task<OfficeWorkflowResult> RunAsync(IOfficeWorkflowRunner runner = null, IProgress<OfficeWorkflowProgress> progress = null, CancellationToken cancellationToken = default) #Task<OfficeWorkflowResult>Runs this workflow through the supplied runner or the default local runner.
Parameters
- runner OfficeIMO.Workflows.IOfficeWorkflowRunner = null
- progress System.IProgress{OfficeIMO.Workflows.OfficeWorkflowProgress} = null
- cancellationToken System.Threading.CancellationToken = default
public OfficeWorkflowBuilder To(String outputPath) #OfficeWorkflowBuilderSets the output artifact path.
Parameters
- outputPath System.String
public OfficeWorkflowBuilder Via(String routeId) #OfficeWorkflowBuilderSets the conversion route identifier from OfficeWorkflowCatalog.
Parameters
- routeId System.String
public OfficeWorkflowBuilder WithComparisonPdfPassword(String password) #OfficeWorkflowBuilderSets the PDF password used for the comparison input.
Parameters
- password System.String
public OfficeWorkflowBuilder WithConversionOptions(OfficeWorkflowConversionOptions options) #OfficeWorkflowBuilderSets independently copied route-specific conversion settings.
Parameters
- options OfficeIMO.Workflows.OfficeWorkflowConversionOptions
public OfficeWorkflowBuilder WithId(String id) #OfficeWorkflowBuilderSets the caller-visible request identifier.
Parameters
- id System.String
public OfficeWorkflowBuilder WithLimits(Int64 maximumInputBytes, Int64 maximumOutputBytes) #OfficeWorkflowBuilderSets bounded input and output sizes for the workflow.
Parameters
- maximumInputBytes System.Int64
- maximumOutputBytes System.Int64
public OfficeWorkflowBuilder WithPdfOwnerPassword(String password) #OfficeWorkflowBuilderSets current owner authorization for replacing or removing PDF protection.
Parameters
- password System.String
public OfficeWorkflowBuilder WithPdfPassword(String password) #OfficeWorkflowBuilderSets the PDF password used for the primary input.
Parameters
- password System.String
public OfficeWorkflowBuilder WithProfile(OfficeWorkflowOutputProfile profile) #OfficeWorkflowBuilderSets the cross-format output profile.
Parameters
- profile OfficeIMO.Workflows.OfficeWorkflowOutputProfile
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object