ONLYOFFICE 插件样式和颜色 API 开发指南

开发 ONLYOFFICE 插件通常意味着改进用户与文档的交互方式，例如添加高亮显示、格式清理或主题 UI 元素。

为了帮助您更高效地工作，我们整理了关键的样式和颜色 API 方法，方便开发者轻松控制插件的外观和风格。

本文将提供清晰的解释、实用的示例和技巧，助您获得更流畅的开发体验。

了解样式上下文

ONLYOFFICE 插件 API 提供了灵活的方式来自定义文档外观，例如通过 ApiRange、ApiParagraph 和 ApiTextPr 等对象。

这些接口允许开发人员直接从插件脚本修改字体属性、段落对齐方式、颜色和其他视觉属性。

应用文本样式的简单示例：

const oDocument = Api.GetDocument();

const oRange = oDocument.GetRangeBySelect();

const oTextPr = oRange.GetTextPr();

oTextPr.Bold(true);

oTextPr.Italic(true);

oTextPr.SetColor(255, 0, 0); // RGB red

这段代码演示了如何组合多种样式以实现动态格式。

常用样式和颜色方法

在开发 ONLYOFFICE 插件时，如果插件涉及文档样式（例如高亮显示、格式清理或基于主题的 UI 元素），开发人员通常需要清晰易用的方法来处理颜色、字体和文本属性。

为了简化此过程，我们在此汇总了最实用的样式和颜色 API，以及一些技巧和示例，以帮助您顺利集成。

方法	描述	示例
SetColor(r, g, b)	使用 RGB 值设置文本颜颜色	oTextPr.SetColor(0, 102, 204)
SetHighlight(sColor)	为文本添加高亮或背景色	oRange.SetHighlight("lightGray")
SetBackgroundColor(r, g, b)	设置段落的背景色	oParagraph.SetBackColor(230, 230, 230)
SetBold(true/false)	切换粗体样式	oTextPr.SetBold(true)
SetItalic(true/false)	切换斜体样式	oTextPr.SetItalic(true)
SetUnderline(true/false)	添加或移除下划线	oTextPr.SetUnderline(true)
SetFontSize(nSize)	按照磅值调整字体的大小	oTextPr.SetFontSize(14)
SetFontName(name)	更改字体类型	oTextPr.SetFontName("Calibri")
ApiCell	用于样式设置的电子表格单元格	const cell = sheet.GetRange("A1");
SetCellColor(r, g, b)	设置电子表格单元格的背景色	cell.SetCellColor(255, 230, 191)

对于段落样式设置，您可以通过 ApiParagraph 接口使用类似的方法：

const oParagraph = oRange.GetParagraph(0);

oParagraph.SetBackColor(230, 230, 230); // Light gray background

oParagraph.SetAlign("center");

这些方法构成了 ONLYOFFICE 插件中文本和段落格式设置的基础。电子表格单元格使用概念上类似的 API，例如 ApiCell 和 SetCellColor，遵循相同的样式逻辑。

处理颜色对象

ONLYOFFICE 的样式方法使用基于 RGB 的颜色定义。如果您的项目使用 HEX 颜色代码（常见于设计系统或品牌主题），您可以使用一个简单的辅助函数进行转换：

function hexToRGB(hex) {

const bigint = parseInt(hex.replace("#", ""), 16);

const r = (bigint >> 16) & 255;

const g = (bigint >> 8) & 255;

const b = bigint & 255;

return [r, g, b];

}

// Example use:

const [r, g, b] = hexToRGB("#3498db");

oTextPr.SetColor(r, g, b);
This allows seamless integration between design resources and plugin functionality.

可靠样式设置的小技巧与实用建议

• 在应用更改之前，请重新选择文档范围，以确保 UI 操作后的准确性。
• 为每个样式操作使用单独的函数调用，而不是一次性调用过多方法。
• 始终执行验证检查，例如，确认 `GetRangeBySelect()` 返回有效对象。
• 通过 `Asc.plugin.getTheme()` 动态调整颜色值，以支持主题模式。

这些细微的调整有助于让插件运行更稳定，同时更好地契合整体主题风格。

结语

ONLYOFFICE 的样式 API 在各类编辑器（无论是文字文档、演示文稿还是电子表格）中都保持一致。

开发者只需掌握一套通用的概念，比如设置颜色、调整字体、对齐段落，就能在不同类型的文档中复用相同的代码逻辑，轻松实现样式统一和跨编辑器兼容。

我们把这些信息集中整理在一起，就是为了帮助所有使用 ONLYOFFICE 开发插件的伙伴们更快速、顺畅、直观地完成开发工作。

如果您在使用过程中有任何疑问或建议，欢迎随时联系我们，让我们携手改进 ONLYOFFICE 文档。