# IWorkSourceDocument

Bounded, read-only representation of a Pages, Numbers, or Keynote source package.

Class 

`OfficeIMO.IWork`

**Namespace**

`OfficeIMO.IWork`

**Assembly**

`OfficeIMO.IWork`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[IWorkSourceDocument.cs:62](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L62)

**Implements**

`IDisposable`

**Modifiers**

sealed

Bounded, read-only representation of a Pages, Numbers, or Keynote source package.

## Inheritance

- object
- IWorkSourceDocument

## Usage

Explore 3 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 3

- Property [IWorkNativeEditSession.Source](/api/iwork/officeimo-iwork-iworknativeeditsession/#property-source)
- Method [IWorkSourceDocument.Load](/api/iwork/officeimo-iwork-iworksourcedocument/#method-load-string-officeimo-iwork-iworkloadoptions)
- Method [IWorkSourceDocument.WithCancellation](/api/iwork/officeimo-iwork-iworksourcedocument/#method-withcancellation-threading-cancellationtoken)

Filter members 

Show inherited

## Methods

`public IWorkNativeEditSession BeginEdit()` [#](#method-beginedit)

[IWorkNativeEditSession.cs:67](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/Editing/IWorkNativeEditSession.cs#L67)

Starts a separate preservation-aware native edit session over this captured snapshot.

Returns

`IWorkNativeEditSession`

`public string ComputePackageContentHash()` [#](#method-computepackagecontenthash)

[IWorkSourceDocument.Hashing.cs:11](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.Hashing.cs#L11)

Computes a deterministic SHA-256 hash of the captured normalized package entries.

Returns

`string`

`public void Dispose()` [#](#method-dispose)

[IWorkSourceDocument.Lifecycle.cs:8](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.Lifecycle.cs#L8)

Completes this captured snapshot's lifetime. Captured data and views do not own input streams.

Load 12 overloads

`public static IWorkSourceDocument Load(string path, IWorkLoadOptions? options = null)` [#](#method-load-string-officeimo-iwork-iworkloadoptions)

[IWorkSourceDocument.cs:90](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L90)

Opens an iWork file or directory bundle and detects its application kind.

Parameters

**path string required**

**options OfficeIMO.IWork.IWorkLoadOptions? = null optional**

Returns

`IWorkSourceDocument`

`public static IWorkSourceDocument Load(string path, IWorkDocumentKind expectedKind, IWorkLoadOptions? options = null)` [#](#method-load-string-officeimo-iwork-iworkdocumentkind-officeimo-iwork-iworkloadoptions)

[IWorkSourceDocument.cs:95](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L95)

Opens an iWork file or directory bundle and verifies the expected application kind.

Parameters

**path string required**

**expectedKind OfficeIMO.IWork.IWorkDocumentKind required**

**options OfficeIMO.IWork.IWorkLoadOptions? = null optional**

Returns

`IWorkSourceDocument`

`public static IWorkSourceDocument Load(Stream stream, IWorkDocumentKind expectedKind, IWorkLoadOptions? options = null)` [#](#method-load-io-stream-officeimo-iwork-iworkdocumentkind-officeimo-iwork-iworkloadoptions)

[IWorkSourceDocument.cs:102](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L102)

Opens a ZIP-based iWork stream using the supplied application kind.

Parameters

**stream System.IO.Stream required**

**expectedKind OfficeIMO.IWork.IWorkDocumentKind required**

**options OfficeIMO.IWork.IWorkLoadOptions? = null optional**

Returns

`IWorkSourceDocument`

`public static IWorkSourceDocument Load(string path, IWorkDocumentKind expectedKind, IWorkLoadOptions? options, CancellationToken cancellationToken)` [#](#method-load-string-officeimo-iwork-iworkdocumentkind-officeimo-iwork-iworkloadoptions-threading-cancellationtoken)

[IWorkSourceDocument.cs:112](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L112)

Opens a file or directory bundle with cancellation and verifies its application kind.

Parameters

**path string required**

**expectedKind OfficeIMO.IWork.IWorkDocumentKind required**

**options OfficeIMO.IWork.IWorkLoadOptions? required**

**cancellationToken System.Threading.CancellationToken required**

Returns

`IWorkSourceDocument`

`public static IWorkSourceDocument Load(string path, IWorkLoadOptions? options, CancellationToken cancellationToken)` [#](#method-load-string-officeimo-iwork-iworkloadoptions-threading-cancellationtoken)

[IWorkSourceDocument.cs:119](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L119)

Opens a file or directory bundle with cancellation and detects its application kind.

Parameters

**path string required**

**options OfficeIMO.IWork.IWorkLoadOptions? required**

**cancellationToken System.Threading.CancellationToken required**

Returns

`IWorkSourceDocument`

`public static IWorkSourceDocument Load(Stream stream, IWorkDocumentKind expectedKind, IWorkLoadOptions? options, CancellationToken cancellationToken)` [#](#method-load-io-stream-officeimo-iwork-iworkdocumentkind-officeimo-iwork-iworkloadoptions-threading-cancellationtoken)

[IWorkSourceDocument.cs:126](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L126)

Opens a caller-owned ZIP stream with cancellation and verifies its application kind.

Parameters

**stream System.IO.Stream required**

**expectedKind OfficeIMO.IWork.IWorkDocumentKind required**

**options OfficeIMO.IWork.IWorkLoadOptions? required**

**cancellationToken System.Threading.CancellationToken required**

Returns

`IWorkSourceDocument`

`public static IWorkSourceDocument Load(Stream stream, IWorkLoadOptions? options, CancellationToken cancellationToken)` [#](#method-load-io-stream-officeimo-iwork-iworkloadoptions-threading-cancellationtoken)

[IWorkSourceDocument.cs:136](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L136)

Opens a caller-owned ZIP stream with cancellation and detects its application kind.

Parameters

**stream System.IO.Stream required**

**options OfficeIMO.IWork.IWorkLoadOptions? required**

**cancellationToken System.Threading.CancellationToken required**

Returns

`IWorkSourceDocument`

`public static IWorkSourceDocument Load(Stream stream, IWorkLoadOptions? options = null)` [#](#method-load-io-stream-officeimo-iwork-iworkloadoptions)

[IWorkSourceDocument.cs:143](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L143)

Opens a ZIP-based iWork stream and detects its application kind.

Parameters

**stream System.IO.Stream required**

**options OfficeIMO.IWork.IWorkLoadOptions? = null optional**

Returns

`IWorkSourceDocument`

`public static IWorkSourceDocument Load(byte[] data, IWorkLoadOptions? options = null)` [#](#method-load-byte-officeimo-iwork-iworkloadoptions)

[IWorkSourceDocument.cs:150](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L150)

Opens iWork package bytes and detects the application kind.

Parameters

**data byte[] required**

**options OfficeIMO.IWork.IWorkLoadOptions? = null optional**

Returns

`IWorkSourceDocument`

`public static IWorkSourceDocument Load(byte[] data, IWorkDocumentKind expectedKind, IWorkLoadOptions? options = null)` [#](#method-load-byte-officeimo-iwork-iworkdocumentkind-officeimo-iwork-iworkloadoptions)

[IWorkSourceDocument.cs:158](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L158)

Opens iWork package bytes and verifies the expected application kind.

Parameters

**data byte[] required**

**expectedKind OfficeIMO.IWork.IWorkDocumentKind required**

**options OfficeIMO.IWork.IWorkLoadOptions? = null optional**

Returns

`IWorkSourceDocument`

`public static IWorkSourceDocument Load(byte[] data, IWorkLoadOptions? options, CancellationToken cancellationToken)` [#](#method-load-byte-officeimo-iwork-iworkloadoptions-threading-cancellationtoken)

[IWorkSourceDocument.cs:167](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L167)

Opens package bytes with cancellation and detects the application kind.

Parameters

**data byte[] required**

**options OfficeIMO.IWork.IWorkLoadOptions? required**

**cancellationToken System.Threading.CancellationToken required**

Returns

`IWorkSourceDocument`

`public static IWorkSourceDocument Load(byte[] data, IWorkDocumentKind expectedKind, IWorkLoadOptions? options, CancellationToken cancellationToken)` [#](#method-load-byte-officeimo-iwork-iworkdocumentkind-officeimo-iwork-iworkloadoptions-threading-cancellationtoken)

[IWorkSourceDocument.cs:176](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L176)

Opens package bytes with cancellation and verifies the application kind.

Parameters

**data byte[] required**

**expectedKind OfficeIMO.IWork.IWorkDocumentKind required**

**options OfficeIMO.IWork.IWorkLoadOptions? required**

**cancellationToken System.Threading.CancellationToken required**

Returns

`IWorkSourceDocument`

`public IWorkKeynoteProjection ReadKeynote()` [#](#method-readkeynote)

[IWorkKeynoteProjection.cs:172](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/Projections/IWorkKeynoteProjection.cs#L172)

Reads a Keynote package into a bounded semantic source projection.

Returns

`IWorkKeynoteProjection`

`public IWorkNumbersProjection ReadNumbers()` [#](#method-readnumbers)

[IWorkNumbersProjection.cs:76](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/Projections/IWorkNumbersProjection.cs#L76)

Reads a Numbers package into a bounded semantic source projection.

Returns

`IWorkNumbersProjection`

`public IWorkPagesProjection ReadPages()` [#](#method-readpages)

[IWorkPagesProjection.cs:152](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/Projections/IWorkPagesProjection.cs#L152)

Reads a Pages package into a bounded semantic source projection.

Returns

`IWorkPagesProjection`

`public IWorkSourceDocument WithCancellation(CancellationToken cancellationToken)` [#](#method-withcancellation-threading-cancellationtoken)

[IWorkSourceDocument.cs:62](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L62)

Creates a source view whose subsequent projections and conversions use the supplied cancellation token.

Parameters

**cancellationToken System.Threading.CancellationToken required**

Returns

`IWorkSourceDocument`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public IWorkDocumentKind Kind { get; }` [#](#property-kind)

[IWorkSourceDocument.cs:67](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L67)

Gets the source application.

`public IWorkContainerKind ContainerKind { get; }` [#](#property-containerkind)

[IWorkSourceDocument.cs:69](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L69)

Gets the physical source layout.

`public long ContainerLengthBytes { get; }` [#](#property-containerlengthbytes)

[IWorkSourceDocument.cs:71](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L71)

Gets the ZIP byte length, or aggregate physical file bytes captured from a directory bundle before nested expansion.

`public IReadOnlyList<IWorkPackageEntry> Entries { get; }` [#](#property-entries)

[IWorkSourceDocument.cs:73](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L73)

Gets preserved package entries, including resources and metadata.

`public IReadOnlyList<IWorkArchiveRecord> Records { get; }` [#](#property-records)

[IWorkSourceDocument.cs:77](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L77)

Gets every preserved IWA payload record, including auxiliary payloads.

`public IReadOnlyList<string> BuildVersions { get; }` [#](#property-buildversions)

[IWorkSourceDocument.cs:79](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L79)

Gets build-history strings recorded by the producer.

`public IReadOnlyList<IWorkPreviewAsset> Previews { get; }` [#](#property-previews)

[IWorkSourceDocument.cs:81](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L81)

Gets embedded raster or PDF previews ordered from most useful to least useful.

`public IReadOnlyList<IWorkDiagnostic> Diagnostics { get; }` [#](#property-diagnostics)

[IWorkSourceDocument.cs:83](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L83)

Gets package-level diagnostics.

`public IWorkPreviewAsset? PreferredRasterPreview { get; }` [#](#property-preferredrasterpreview)

[IWorkSourceDocument.cs:85](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.cs#L85)

Gets the preferred raster asset for a visual fallback.

`public string? FilePath { get; private set; }` [#](#property-filepath)

[IWorkSourceDocument.Lifecycle.cs:5](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.IWork/IWorkSourceDocument.Lifecycle.cs#L5)

Gets the captured source file path; directory bundles and byte/stream loads have no file association.

<!-- PowerForge markdown artifact sha256:BDA26D60223949DFEB4D20E317A5DE04363ED2E826270A48A1191D08745BE9F3 -->
