ComOfficeKit SDK · iOS 和 macOS

在你的 iPhone、iPad 和 Mac 应用中使用 Office 文档

ComOfficeKit 是 LynxOffice 背后的文档引擎,以两个 Swift 框架的形式提供给你自己的应用使用。读取、编辑和保存 Word、Excel 和 PowerPoint 文件,并将其页面渲染为图像或 PDF,全程在设备上完成。

iOS 16+macOS 13+Swift支持离线使用

可免费评估约 60 天。

Swift

import DocumentCore
import AppleRender

// verified on the device; no network
try SDKLicense.activate(key: licence)

let scene = try DocumentParser.parse(docxAt: url)
let doc = ParsedDocument.word(scene)

let n = try DocumentRenderer.pageCount(of: doc)
let image = try DocumentRenderer.image(
    of: doc, page: 0, scale: 2)
let pdf = try DocumentRenderer.pdfData(of: doc)

SDK 包含什么

两个 Swift 框架。DocumentCore 负责读写文件;AppleRender 负责绘制文件的页面。

DocumentCore:读取、编辑和保存

将 .docx、.xlsx 和 .pptx 解析为结构化的不可变场景:段落、文本块(run)、表格和节;工作表、单元格和公式;幻灯片和形状。基于原场景派生出编辑后的场景并保存:只会重新生成你改动过的部分,文件中的其余内容原样沿用。

AppleRender:页面、图像和 PDF

使用 Core Text 和 Core Graphics 排版文档,并把任意一页渲染为图像或 PDF。Word 文档会自动分页,电子表格按打印方式逐个工作表分页,每张幻灯片就是一页。

公式引擎

计算电子表格公式。#DIV/0! 和 #REF! 等 Excel 风格的错误值会作为单元格值返回,而不会抛出异常。

内置字体

SDK 随附与 Calibri 和 Cambria 度量兼容的字体,因此使用这两种字体的文档能按正确的尺寸排版。其他字体取自系统,并配有可处理中文、日文和韩文文本的逐级回退机制。

专为正式上线的应用打造

在把文档引擎交到客户面前之前,你本来需要自行核实的那些事项。

  • 永远无需联网。你的许可证是一行带签名的文本,在设备上完成校验,因此文档绝不会离开你的应用,沙盒应用也无需为授权申请网络权限。
  • 类型化错误。引擎无法读取的文件会产生一个指明出错部分及原因的错误;文档输入绝不会使你的应用崩溃。
  • 可安全并行运行。场景是 Sendable 值类型,解析器、写入器和渲染器都是无状态的,因此可以同时处理不同的文档。
  • 两种添加方式。从 GitHub 添加软件包后,Swift Package Manager 会从其版本下载这两个 framework 并核对校验和;或者使用每个版本附带的 zip,它是一个包含 framework、文档和示例的文件夹,再将它作为本地包添加。

平台

iOS 16 和 iPadOS 16 或更高版本,以及 macOS 13 或更高版本。

格式

输入 .docx、.xlsx、.xlsm 和 .pptx;输出相同的格式、页面图像和 PDF。.xlsm 工作簿中的宏会逐字节保留,且绝不会运行。

开发文档

涵盖两个框架的 API 参考文档,附有入门、授权、错误与线程、渲染,以及处理 Word、电子表格和演示文稿文件的指南。在线阅读(英文)。

它不能做什么

让你尽早判断它是否适合你。

不支持 PDF 编辑

ComOfficeKit 可以把文档渲染为 PDF,但不能打开、注释或编辑 PDF 文件。

没有用户界面

它没有编辑器或查看器界面。界面由你来构建;SDK 提供文档模型并绘制页面。

仅支持 Apple 平台

此 SDK 可在 iOS、iPadOS 和 macOS 上运行。Windows 有自己的 SDK:ComOfficeKit for Windows;请告诉我们你还需要哪个平台。

常见问题

如何获取 ComOfficeKit?

通过 Swift Package Manager 从 GitHub 添加。它的 README 公布了一个免费评估密钥,有效期约 60 天,无需注册即可试用完整的 SDK。如需许可证,请通过联系表单向我们的销售团队介绍你的项目,或写信至 support@comofficekit.com。

需要网络连接吗?

不需要。许可证在设备上完成校验,SDK 在任何时候都不会发起网络调用,因此文档始终留在你的应用内。

支持哪些版本的 iOS 和 macOS?

iOS 和 iPadOS 16 或更高版本,以及 macOS 13 或更高版本。

可以打开 PDF 文件吗?

不能。ComOfficeKit 处理 .docx、.xlsx、.xlsm 和 .pptx 文件,并将它们渲染为 PDF,但不能打开或编辑 PDF 文档。

它和 LynxOffice 是同一个引擎吗?

是的。LynxOffice 构建在同一个文档引擎之上,因此 SDK 读取和渲染文件的方式与该应用一致。

和我们聊聊 ComOfficeKit

告诉我们你在构建什么、需要哪些平台,我们的销售团队会与你联系。你也可以写信至 support@comofficekit.com。