API Reference
IWorkSourceDocument
Bounded, read-only representation of a modern Pages, Numbers, or Keynote source package.
Inheritance
- Object
- IWorkSourceDocument
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 IWorkSourceDocument.Open
- Method IWorkSourceDocument.Open
- Method IWorkSourceDocument.Open
- Method IWorkSourceDocument.Open
- Method IWorkSourceDocument.Open
- Method IWorkSourceDocument.Open
Methods
public static IWorkSourceDocument Open(String path, IWorkReadOptions options = null) #IWorkSourceDocumentOpens an iWork file or directory bundle and detects its application kind.
Parameters
- path System.String
- options OfficeIMO.IWork.IWorkReadOptions = null
public static IWorkSourceDocument Open(String path, IWorkDocumentKind expectedKind, IWorkReadOptions options = null) #IWorkSourceDocumentOpens an iWork file or directory bundle and verifies the expected application kind.
Parameters
- path System.String
- expectedKind OfficeIMO.IWork.IWorkDocumentKind
- options OfficeIMO.IWork.IWorkReadOptions = null
public static IWorkSourceDocument Open(Stream stream, IWorkDocumentKind expectedKind, IWorkReadOptions options = null) #IWorkSourceDocumentOpens a ZIP-based iWork stream using the supplied application kind.
Parameters
- stream System.IO.Stream
- expectedKind OfficeIMO.IWork.IWorkDocumentKind
- options OfficeIMO.IWork.IWorkReadOptions = null
public static IWorkSourceDocument Open(Stream stream, IWorkReadOptions options = null) #IWorkSourceDocumentOpens a ZIP-based iWork stream and detects its application kind.
Parameters
- stream System.IO.Stream
- options OfficeIMO.IWork.IWorkReadOptions = null
public static IWorkSourceDocument Open(Byte[] data, IWorkReadOptions options = null) #IWorkSourceDocumentOpens iWork package bytes and detects the application kind.
Parameters
- data System.Byte[]
- options OfficeIMO.IWork.IWorkReadOptions = null
public static IWorkSourceDocument Open(Byte[] data, IWorkDocumentKind expectedKind, IWorkReadOptions options = null) #IWorkSourceDocumentOpens iWork package bytes and verifies the expected application kind.
Parameters
- data System.Byte[]
- expectedKind OfficeIMO.IWork.IWorkDocumentKind
- options OfficeIMO.IWork.IWorkReadOptions = null
public IWorkKeynoteProjection ReadKeynote() #IWorkKeynoteProjectionReads a Keynote package into a bounded semantic source projection.
public IWorkNumbersProjection ReadNumbers() #IWorkNumbersProjectionReads a Numbers package into a bounded semantic source projection.
public IWorkPagesProjection ReadPages() #IWorkPagesProjectionReads a Pages package into a bounded semantic source projection.
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public IWorkDocumentKind Kind { get; } #Gets the source application.
public IWorkContainerKind ContainerKind { get; } #Gets the physical source layout.
public IReadOnlyList<IWorkPackageEntry> Entries { get; } #Gets preserved package entries, including resources and metadata.
public IReadOnlyList<IWorkArchiveRecord> Records { get; } #Gets every preserved IWA payload record, including auxiliary payloads.
public IReadOnlyList<String> BuildVersions { get; } #Gets build-history strings recorded by the producer.
public IReadOnlyList<IWorkPreviewAsset> Previews { get; } #Gets embedded raster or PDF previews ordered from most useful to least useful.
public IReadOnlyList<IWorkDiagnostic> Diagnostics { get; } #Gets package-level diagnostics.
public IWorkPreviewAsset PreferredRasterPreview { get; } #Gets the preferred raster asset for a visual fallback.