OfficeWorkflowBuilder
OfficeIMO.Workflows
Fluent configuration for one local document workflow.
Inheritance
- object
- OfficeWorkflowBuilder
Usage
Explore 21 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 21
- Method OfficeWorkflow.Compare
- Method OfficeWorkflow.ConvertToPdfA
- 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.ComparePages
- Method OfficeWorkflowBuilder.OnConflict
- Method OfficeWorkflowBuilder.To
- Method OfficeWorkflowBuilder.WithComparisonPdfPassword
- Method OfficeWorkflowBuilder.WithId
- Method OfficeWorkflowBuilder.WithLimits
- Method OfficeWorkflowBuilder.WithPdfOwnerPassword
- Method OfficeWorkflowBuilder.WithPdfPassword
- Method OfficeWorkflowBuilder.WithProfile
Methods
public OfficeWorkflowBuilder Against(string comparisonPath) #Sets the comparison input for a compare workflow.
Parameters
- comparisonPath string
Returns
OfficeWorkflowBuilderpublic OfficeWorkflowRequest Build() #Builds an independent request snapshot, inferring a locally executable conversion route from file extensions when possible.
Returns
OfficeWorkflowRequestpublic OfficeWorkflowBuilder ComparePages(OfficePageSelector? expectedPages, OfficePageSelector? actualPages) #Selects independently ordered page scopes for ordinal rendered comparison. Null selects all pages on that side.
Parameters
- expectedPages OfficeIMO.OfficePageSelector?
- actualPages OfficeIMO.OfficePageSelector?
Returns
OfficeWorkflowBuilderpublic OfficeWorkflowBuilder OnConflict(OfficePublicationPolicy policy) #Sets destination conflict behavior.
Parameters
- policy OfficeIMO.OfficePublicationPolicy
Returns
OfficeWorkflowBuilderpublic Task<OfficeWorkflowResult> RunAsync(IOfficeWorkflowRunner? runner = null, IProgress<OfficeWorkflowProgress>? progress = null, CancellationToken cancellationToken = default) #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
Returns
Task<OfficeWorkflowResult>public OfficeWorkflowBuilder To(string outputPath) #Sets the output artifact path.
Parameters
- outputPath string
Returns
OfficeWorkflowBuilderpublic OfficeWorkflowBuilder WithComparisonPdfPassword(string? password) #Sets the PDF password used for the comparison input.
Parameters
- password string?
Returns
OfficeWorkflowBuilderpublic OfficeWorkflowBuilder WithId(string id) #Sets the caller-visible request identifier.
Parameters
- id string
Returns
OfficeWorkflowBuilderpublic OfficeWorkflowBuilder WithLimits(long maximumInputBytes, long maximumOutputBytes) #Sets bounded input and output sizes for the workflow.
Parameters
- maximumInputBytes long
- maximumOutputBytes long
Returns
OfficeWorkflowBuilderpublic OfficeWorkflowBuilder WithPdfOwnerPassword(string? password) #Sets current owner authorization for replacing or removing PDF protection.
Parameters
- password string?
Returns
OfficeWorkflowBuilderpublic OfficeWorkflowBuilder WithPdfPassword(string? password) #Sets the PDF password used for the primary input.
Parameters
- password string?
Returns
OfficeWorkflowBuilderpublic OfficeWorkflowBuilder WithProfile(OfficeConversionProfile profile) #Sets the cross-format output profile.
Parameters
- profile OfficeIMO.OfficeConversionProfile
Returns
OfficeWorkflowBuilder