ComOfficeKitby KDAN API Reference for Windows
Table of Contents

Namespace ComOfficeKit

Classes

ComOfficeKitException

A failure inside ComOfficeKit or its engine. Arguments are checked before the engine is called, with .NET's own exceptions (ArgumentException and its subclasses, ObjectDisposedException, InvalidOperationException); this type reports what only the engine can find.

CompareResult

What Compare(string, string, string, string?) found.

Document

An open document. Open(string) returns a WordDocument, a Spreadsheet or a Presentation; what only one kind can do is on that type.

Engine

The native engine this package runs on.

License

Activating ComOfficeKit. Until a licence is active, every operation that reads, writes, renders, exports or compares a document throws LicenseException. Every member is safe to call from any thread.

LicenseException

A licence check failed. Kind is License.

PageImage

A page drawn by RenderPage(int, double): BGRA32 pixels, premultiplied, every one opaque, the top row first. That is what WPF's PixelFormats.Pbgra32 and WinUI's WriteableBitmap take. The image holds its own copy of the pixels: it needs no disposal and outlives its document.

Presentation

A PowerPoint deck (.pptx).

Spreadsheet

A workbook: .xlsx, .xlsm, or a .csv or .tsv file read as a workbook of one sheet.

WordDocument

A Word document (.docx).

Enums

DocumentFormat

The file formats ComOfficeKit reads and writes.

DocumentKind

The three kinds of document ComOfficeKit opens.

ErrorKind

What kind of failure a ComOfficeKitException reports.

LicenseError

Why a licence check failed.

LicenseState

Whether a licence is active.

LicenseStorage

Where an activated licence is kept.