API Reference
OfficeConversionBatchRequest
Incremental file conversion through the existing workflow routes. Checkpoints are optional.
Inheritance
- Object
- OfficeConversionBatchRequest
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
Accepted by parameters
- Method IOfficeWorkflowRunner.RunBatchAsync
- Method OfficeConversionBatchRequest.Equals
- Method OfficeConversionBatchRequest.op_Equality
- Method OfficeConversionBatchRequest.op_Equality
- Method OfficeConversionBatchRequest.op_Inequality
- Method OfficeConversionBatchRequest.op_Inequality
- Method OfficeWorkflowRunner.RunBatchAsync
Constructors
public OfficeConversionBatchRequest() #Obsolete("Constructors of types with required members are not supported in this version of your compiler.", true)Methods
public OfficeConversionBatchRequest <Clone>$() #OfficeConversionBatchRequestpublic override Int32 GetHashCode() #Int32public static Boolean op_Equality(OfficeConversionBatchRequest left, OfficeConversionBatchRequest right) #BooleanParameters
- left OfficeConversionBatchRequest
- right OfficeConversionBatchRequest
public static Boolean op_Inequality(OfficeConversionBatchRequest left, OfficeConversionBatchRequest right) #BooleanParameters
- left OfficeConversionBatchRequest
- right OfficeConversionBatchRequest
public override String ToString() #StringInherited Methods
Properties
public String InputDirectory { get; set; } #Source directory; descendants are discovered incrementally without following links.
public String[] InputPaths { get; set; } #Explicit local files. When InputDirectory is set, files must be inside that root and retain relative paths.
public String TargetExtension { get; set; } #Destination extension from the executable conversion catalog, including its leading dot.
public String ConversionRouteId { get; set; } #Optional explicit route for ambiguous inputs; otherwise the catalog selects the route.
public String PdfPassword { get; set; } #Runtime PDF source password, equivalent to OfficeWorkflowRequest.PdfPassword. Not stored in checkpoints.
public OfficeWorkflowConversionOptions ConversionOptions { get; set; } #Existing typed settings. Each selected route receives only its applicable settings.
public OfficeWorkflowOutputProfile OutputProfile { get; set; } #Cross-format output intent; format-specific settings take precedence when supplied.
public OfficeWorkflowConflictPolicy ConflictPolicy { get; set; } #Existing publication conflict policy. Durable checkpoint jobs require Fail.
public Boolean Recursive { get; set; } #Discover descendants when selecting a directory.
public String[] SourceExtensions { get; set; } #Optional source extensions to select during directory discovery. Unselected files are reported as skipped.
public String OutputDirectory { get; set; } #Separate destination directory. Relative paths retain the full source name plus the target extension.
public String CheckpointDirectory { get; set; } #Private durable state directory, outside both source and output trees.
public Int32 MaximumConcurrency { get; set; } #Maximum simultaneously executing files, from 1 through 32.
public Int32 MaximumFiles { get; set; } #Maximum discovered files in one run, including skipped files. Folder discovery is incremental.
public Int64 MaximumInputBytes { get; set; } #Maximum input bytes per document.
public Int64 MaximumOutputBytes { get; set; } #Maximum output bytes per document.
public Boolean RetryFailed { get; set; } #Retry recorded failures. Completed files still require source and output hash verification.