Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

IWorkKeynoteDocument

OfficeIMO.IWork

Namespace
OfficeIMO.IWork
Assembly
OfficeIMO.IWork
Source revision
5e5a2dda74b3 with working tree changes
Implements
IDisposable
Modifiers
sealed

Creates native Keynote presentations containing positioned text, PNG/JPEG images and scalar tables.

Inheritance

  • object
  • IWorkKeynoteDocument

Remarks

This creation model does not modify loaded iWork packages. Instances are not thread safe.

Usage

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

Methods

public IWorkKeynoteSlideBuilder AddSlide(string backgroundColor = "FFFFFF") #

Adds a blank slide with an opaque six-digit sRGB background color.

Parameters

backgroundColor string = "FFFFFF" optional
Create 2 overloads
public static IWorkKeynoteDocument Create(float widthPoints = 960, float heightPoints = 540) #

Creates an empty presentation with a 960 by 540 point canvas by default.

Parameters

widthPoints float = 960 optional
heightPoints float = 540 optional
public static IWorkKeynoteDocument Create(string path) #

Creates a native authoring model associated with a path, without writing a file.

Parameters

path string required
public void Dispose() #

Completes this managed authoring model's lifetime. No native application, file or caller stream is retained.

Save 3 overloads
public void Save(Stream destination, IWorkKeynoteSaveOptions? options = null, CancellationToken cancellationToken = default) #

Writes a completed package at the stream's current position and leaves the stream open.

Parameters

destination System.IO.Stream required
options OfficeIMO.IWork.IWorkKeynoteSaveOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public void Save(string path, bool overwrite = false, IWorkKeynoteSaveOptions? options = null, CancellationToken cancellationToken = default) #

Atomically saves a native Keynote package, rejecting an existing path unless overwrite is enabled.

Parameters

path string required
overwrite bool = false optional
options OfficeIMO.IWork.IWorkKeynoteSaveOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public void Save(bool overwrite = false, IWorkKeynoteSaveOptions? options = null, CancellationToken cancellationToken = default) #

Saves to the associated path; replacing an existing file still requires explicit overwrite.

Parameters

overwrite bool = false optional
options OfficeIMO.IWork.IWorkKeynoteSaveOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public byte[] ToBytes(IWorkKeynoteSaveOptions? options = null, CancellationToken cancellationToken = default) #

Encodes a deterministic native single-file Keynote package without a template or native application.

Parameters

options OfficeIMO.IWork.IWorkKeynoteSaveOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

byte[]

Properties

public IWorkCanvasSize SlideSize { get; } #

Gets the presentation canvas size in points.

public IReadOnlyList<IWorkKeynoteSlideBuilder> Slides { get; } #

Gets the slides in presentation order.

public string? FilePath { get; private set; } #

Gets the associated output path; stream saves do not change it.