OfficeIMO.Workflows.IWork 3.4.5

OfficeIMO.Workflows.IWork

Opt-in Pages-to-Word, Numbers-to-Excel, and Keynote-to-PowerPoint conversion through the shared OfficeIMO workflow runner.

using OfficeIMO.Workflows;
using OfficeIMO.Workflows.IWork;

OfficeWorkflowRunner runner = IWorkWorkflow.CreateRunner();
OfficeWorkflowResult result = await runner.RunAsync(new OfficeWorkflowRequest {
    InputPath = "budget.numbers",
    OutputPath = "budget.xlsx",
    Operation = OfficeWorkflowOperation.Convert,
    ConversionRouteId = "numbers-xlsx"
});

The runner captures the source, bounds input and output, reopens the staged destination through its format owner, verifies the source before publication, and applies the requested conflict policy. The SourceSnapshot diagnostic identifies captured bytes by SHA-256, length, selected filename, and snapshotKind. For a directory package, the checksum describes a deterministic private ZIP transport snapshot of the captured file membership and contents; it is not a checksum of an original ZIP file. Package-root replacement and changes to membership or content prevent publication. ConversionEvidence retains typed fidelity categories and compact producer, projection, and coverage facts. Successful publication does not establish complete source fidelity or visual equivalence.

The default acceptance policy rejects explicitly partial editable reconstruction and previews without known full-document coverage. Pass IWorkConversionOptions to CreateRunner to choose editable or visual output, permit partial reconstruction, or normalize Numbers worksheet names. These options are copied when routes are registered. Each request can instead supply its own IWorkWorkflowSettings; the runner snapshots them before opening the source, so later caller edits cannot change a pending conversion. Destination renames, approximations, omissions, and unassessed source records remain reported.

var settings = new IWorkWorkflowSettings();
settings.ConversionOptions.Mode = OfficeIMO.IWork.IWorkConversionMode.VisualOnly;
// Explicitly accept a preview that may cover only part of the source.
settings.ConversionOptions.RequireCompleteVisualCoverage = false;
var request = new OfficeWorkflowRequest {
    InputPath = "report.pages",
    OutputPath = "report.docx",
    Operation = OfficeWorkflowOperation.Convert,
    ConversionRouteId = "pages-docx",
    RegisteredConversionSettings = settings
};
OfficeWorkflowResult preview = await runner.RunAsync(request);

Routes accept local ZIP files, local directory packages, provider ZIP streams, and provider directory packages. Directory capture uses the bounded iWork container owner, including nested Index.zip packages. Output cannot be placed inside a source package or alias one of its members. For provider directories, set InputDirectoryPackage to an OfficeWorkflowDirectoryPackageInput containing the selected filename, a reopenable OfficeWorkflowDirectoryInput, and a permission-aware root identity/output-separation guard. Set an explicit OutputPath and omit InputStream. The shared runner captures at most MaximumEntries members (10,000 by default) within Limits.MaximumInputBytes, then invokes the format owner on private staging. Before publication it re-enumerates the original provider and verifies member identities and bytes. The provider guard must reject root replacement and destinations inside or containing the source package. Native sandbox/bookmark qualification remains separate from this provider contract. See the iWork support matrix for format limits and the workflow guide for publication and provider contracts.

Retained evidence includes identified source-unit totals and reconstructed, omitted, and unassessed counts. These totals describe units selected by the semantic projection, including explicitly omitted unsupported drawables and Numbers sheet references. Inactive templates, auxiliary table models/tiles, unresolved references, and unassessed content paths remain excluded. A visual preview does not establish individual object coverage. Full per-kind counts and native object identities are available on the owning adapter's IWorkConversionReport.

Conversion evidence includes source formula-expression and cache counts from IWorkConversionReport.FormulaSummary. These include separate unassessed expression and cache counts for supported headers declaring formulas in undecoded cells, independently of editable or preview output. Per-cell identities and assessments remain in the owning adapter report.

Declaration evidence retains sourceDeclarationIssueCount after destination disposal. It counts distinct selected paths with unreadable or rejected declarations, separately from reference occurrences and objects. Owner/path details and known outer field-value counts are available in IWorkConversionReport.SourceDeclarationIssues; unreadable nested content and preview coverage remain unassessed.

Cell evidence retains sourceCellIssueCount after destination disposal. It counts materialized selected cells with decoding failures; native error markers and unmaterialized storage are excluded. Table identities, coordinates and messages are available in IWorkConversionReport.SourceCellIssues.

Reference evidence retains sourceReferenceIssueCount, sourceMissingReferenceTargetCount, sourceMalformedReferenceCount, sourceRejectedReferenceSetCount and sourceUnexpectedReferenceTargetTypeCount after destination disposal. These count failed declared occurrences in the core's assessed content paths, separately from identified objects. Repeated occurrences within a source field remain separate; reuse of a shared text or template archive does not multiply its evidence. Full owner identities, field paths and target identifiers remain in IWorkConversionReport.SourceReferenceIssues. Missing, unreadable or unsupported target-type references have unassessed fidelity; the counts do not establish omitted-object totals or preview coverage.