Cloudmersive 文档转换(预览版)

通过转换 API,可以毫不费力地转换文件格式和类型。

此连接器在以下产品和区域中可用:

服务 Class 区域
Copilot Studio 高级 除以下各项外的所有 Power Automate 区域
     - 美国政府 (GCC)
     - 美国政府 (GCC High)
     - 由世纪互联运营的中国云
     - 美国国防部(DoD)
逻辑应用程序 标准 除以下各项外的所有 逻辑应用区域
     - Azure 政府区域
     - Azure 中国区域
     - 美国国防部(DoD)
Power Apps 高级 除以下各项外的所有 Power Apps 区域
     - 美国政府 (GCC)
     - 美国政府 (GCC High)
     - 由世纪互联运营的中国云
     - 美国国防部(DoD)
Power Automate 高级 除以下各项外的所有 Power Automate 区域
     - 美国政府 (GCC)
     - 美国政府 (GCC High)
     - 由世纪互联运营的中国云
     - 美国国防部(DoD)
联系人​​
URL https://account.cloudmersive.com/contact-support
连接器元数据
发布者 Cloudmersive、LLC
网站 https://cloudmersive.com/convert-api
隐私策略 https://cloudmersive.com/privacy-policy

此连接器对于任何文档转换和处理应用程序而言都至关重要,用于以非常高保真度转换文档和文件格式之间的文件。 Cloudmersive 文档转换涵盖各种常见文件格式,包括 Word(DOCX)、Excel(XLSX)、PowerPoint(PPTX)、PDF、PNG 和超过 100 种其他文件格式。 无状态高安全性处理可确保快速性能和强大的安全性。 可以在 “文档转换 API ”页中了解详细信息。

若要使用此连接器,需要一个 Cloudmersive 帐户。 可以使用 Microsoft 帐户注册或创建 Cloudmersive 帐户。 按照以下步骤获取 API 密钥。

获取 API 密钥和机密

  • 注册 Cloudmersive 帐户
  • 使用 Cloudmersive 帐户登录并单击 API 密钥

在这里,可以创建并查看 API 密钥页中列出的 API 密钥。 只需将此 API 密钥复制并粘贴到 Cloudmersive 文档转换连接器中。

现在,你已准备好开始使用 Cloudmersive 文档转换连接器。

创建连接

连接器支持以下身份验证类型:

默认 用于创建连接的参数。 所有区域 不可共享

违约

适用:所有区域

用于创建连接的参数。

这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。

Name 类型 Description 必选
API 密钥(来自 https://cloudmersive.com securestring 此 API 的 API 密钥 True

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

HTML 文档文件到文本 (txt)

HTML 文档到文本

从 Excel XLSX 电子表格、工作表获取图像

返回 Excel 电子表格工作表中定义的图像

从 Excel XLSX 电子表格、工作表获取样式

返回 Excel 电子表格中定义的样式

从 Excel XLSX 电子表格、工作表获取行和单元格

返回在 Excel 电子表格工作表中定义的行和单元格

从 Excel XLSX 电子表格、工作表获取行和单元格

返回在 Excel 电子表格工作表中定义的行和单元格

从 Excel XLSX 电子表格文档中删除工作表

编辑输入 Excel XLSX 电子表格文档以删除指定的工作表(选项卡)。 使用“获取工作表”API 枚举电子表格中的可用工作表。

从 Excel XLSX 电子表格获取工作表

返回在 Excel 电子表格(XLSX)格式化文件中定义的工作表(选项卡)

从 PowerPoint PPTX 演示文稿文档中删除、删除幻灯片

编辑输入 PowerPoint PPTX 演示文稿文档以删除指定的幻灯片

从 Word DOCX 文档中删除页眉和页脚

从 Word 文档(DOCX)中删除所有页眉或页脚或两者。 调用输出 URL 上的“完成编辑”以完成作。

从 Word DOCX 文档分层获取注释

返回 Word 文档(DOCX)格式文件中存储的批注和审阅批注,其中答复批注嵌套为返回结果中顶级批注下的子级。

从 Word DOCX 文档获取图像

返回 Word 文档(DOCX)格式化文件中定义的图像

从 Word DOCX 文档获取样式

返回 Word 文档(DOCX)格式化文件中定义的样式

从 Word DOCX 文档获取正文

返回 Word 文档(DOCX)格式化文件中定义的正文;这是 DOCX 文档的主要内容部分

从 Word DOCX 文档获取节

返回 Word 文档(DOCX)格式化文件中定义的节

从 Word DOCX 文档获取页脚的内容

从 Word 文档(DOCX)格式化文件中返回页脚内容

从 Word DOCX 文档获取页面和内容

返回 Word 文档(DOCX)格式化文件中定义的每页的页面和内容

从列和行数据创建新的 Excel XLSX 电子表格

返回一个新的 Excel XLSX 电子表格 (XLSX) 格式化文件,该文件使用指定为输入的列和行数据填充

使用 XQuery 查询查询 XML 文件,获取结果

返回使用 XQuery 表达式查询单个 XML 文档的重新筛选。 支持 XQuery 3.1 及更早版本。 此 API 针对单个 XML 文档进行优化作为输入。 提供的 XML 文档作为默认上下文自动加载;若要访问文档中的元素,只需引用它们而不引用文档,例如 bookstore/book

使用 XQuery 查询查询查询多个 XML 文件,获取结果

返回使用 XQuery 表达式查询 XML 文档的重新筛选。 支持 XQuery 3.1 及更早版本。 此 API 已针对多个 XML 文档进行优化作为输入。 如果包含两个名为 books.xml 和 restaurants.xml的输入文件,则可以按名称引用给定文档的内容,例如 doc(“books.xml”) 或 doc(“restaurants.xml”)。 如果输入文件不包含文件名,则它们默认为文件名 input1.xml、input2.xml 等。

使用 XSLT 将 XML 文档文件转换为新的 XML 文档

将 XML 字符串或文件转换为 JSON

创建空白 Excel XLSX 电子表格

返回空白的 Excel XLSX 电子表格 (XLSX) 格式化文件

创建空白 Word DOCX 文档

返回空白的 Word DOCX 文档格式文件。 该文件为空,没有内容。 使用其他编辑命令(如“插入段落”或“插入表格”或“插入图像”)填充文档。

删除 Word DOCX 文档中现有表中的表格行

删除 Word DOCX 文档中的现有表格行并返回结果。

删除 Word DOCX 文档中的任何对象

从 Word 文档(DOCX)中删除任何对象,如段落、表格、图像等。 传入要删除的对象的路径。 可以调用其他函数,例如 Get-Tables、Get-Images、Get-Body 等来获取文档中对象的路径。 调用输出 URL 上的“完成编辑”以完成作。

删除 Word 中现有表中多个表行的范围

删除 Word DOCX 文档中的 1 个或多个现有表行的范围,并返回结果。

删除、删除 Word DOCX 文档中的页面

返回 Word 文档(DOCX)格式化文件中编辑的 Word 文档,其中删除了指定的页面

删除、删除与 XPath 表达式匹配的 XML 节点和项

通过删除与输入 XPath 表达式匹配的所有节点,返回编辑 XML 文档的重新筛选

删除、删除与 XPath 表达式匹配的节点的所有子级,但

通过删除与输入 XPath 表达式匹配的节点的所有子节点,返回编辑 XML 文档的重新筛选。

图像格式转换

在 100 多种文件格式之间转换,包括 Photoshop(PSD)、PNG、JPG、GIF、NEF 和 BMP 等关键格式。

在 Excel XLSX 电子表格中按索引设置、更新单元格内容

设置、更新 Excel XLSX 电子表格、工作表中特定单元格的内容

在 Excel XLSX 电子表格中插入新工作表

将新工作表插入 Excel 电子表格

在 Word DOCX 文档中向页脚添加页码

设置 Word 文档(DOCX)中的页脚以包含页码。 调用输出 URL 上的“完成编辑”以完成作。

在 Word DOCX 文档中插入图像

在 Word 文档(DOCX)中设置页脚。 调用输出 URL 上的“完成编辑”以完成作。

在 Word DOCX 文档中插入新段落

将新段落添加到 DOCX 中并返回结果。 可以使用文档的 Path(文档内的位置)在文档的开头/结尾或现有对象之前/之后插入。 调用输出 URL 上的“完成编辑”以完成作。

在 Word DOCX 文档中设置标题

在 Word 文档(DOCX)中设置标题。 调用输出 URL 上的“完成编辑”以完成作。

在 Word DOCX 文档中设置页脚

在 Word 文档(DOCX)中设置页脚。 调用输出 URL 上的“完成编辑”以完成作。

在附加到段落的 Word DOCX 文档中插入新批注

将新注释添加到附加到段落的 Word DOCX 文档中,并返回结果。 调用输出 URL 上的“完成编辑”以完成作。

基于 PDF 光栅化版本将 PDF 转换为 Word DOCX 文档

将标准 PDF 转换为 Office Word 文档(docx),但首先将 PDF 光栅化。 将高保真度的 PDF 转换为 Word 格式。

多页图像格式转换

在超过 100 种文件格式之间进行转换,包括对 Multiple-Page 格式的支持(例如 PDF、TIFF 等)和多个页面)。

完成编辑文档,并从文档编辑下载结果

编辑完文档后,下载结果。 通过调用开始编辑开始编辑开始编辑文档,然后执行作,然后调用完成编辑来获取结果。

将 CSV 转换为 Excel XLSX 电子表格

将 CSV 文件转换为 Office Excel XLSX 工作簿文件格式。

将 CSV 转换为 JSON 转换

将 CSV 文件转换为 JSON 对象数组

将 Excel XLS (97-03) 电子表格转换为 CSV

将 Office Excel (97-2003) 工作簿 (xls) 转换为标准 CSV 格式。

将 Excel XLS (97-03) 电子表格转换为 PDF

将 Office Excel (97-2003) 工作簿 (xls) 转换为标准 PDF。 将工作簿中的所有工作表转换为 PDF。

将 Excel XLS (97-03) 电子表格转换为 XLSX

将 Office Excel(97-2003)工作簿(xls)转换为新式 XLSX 格式。

将 Excel XLSX 电子表格转换为 CSV

将 Office Excel 工作簿(XLSX)转换为标准 Comma-Separated 值(CSV)格式。 支持 XLSX 和 XLSB 文件格式。

将 Excel XLSX 电子表格转换为 PDF

将 Office Excel 工作簿(XLSX)转换为标准 PDF。 将工作簿中的所有工作表转换为 PDF。 支持 XLSX 和 XLSB Excel 文件格式。

将 Excel XLSX 电子表格转换为文本(txt)

将 Office Excel 工作簿(XLSX)转换为标准文本。 将工作簿中的所有工作表转换为文本。 支持 XLSX 和 XLSB 文件格式。 当电子表格包含多个工作表时,将导出所有工作表中的所有文本。 如果要仅从一个工作表导出文本,请尝试使用拆分 XLSX API 将电子表格拆分为多个工作表文件,然后在需要从中提取文本的单个工作表文件上运行 XLSX 到文本。

将 Excel XLSX 转换为 JSON 转换

将 Excel XLSX 文件转换为 JSON 对象数组

将 Excel (97-2003) XLS 转换为 JSON 转换

将 Excel (97-2003) XLS 文件转换为 JSON 对象数组

将 HTML 字符串转换为 PDF

完全呈现网站并返回 HTML 的 PDF。 Javascript、HTML5、CSS 和其他高级功能均受支持。

将 HTML 字符串转换为 PNG 屏幕截图

完全呈现网站并返回 HTML 的 PNG(屏幕截图)。 Javascript、HTML5、CSS 和其他高级功能均受支持。

将 HTML 字符串转换为文本(txt)

将 HTML 字符串输入转换为文本(txt):从 HTML 中提取文本

将 HTML 文档文件转换为 PDF 文档

将标准 HTML 转换为 PDF,完全支持 CSS、JavaScript、图像和其他复杂行为。 若要使用外部文件(如图像),请使用文件的绝对 URL。

将 HTML 文档文件转换为 PNG 图像数组

将标准 HTML 转换为对 CSS、JavaScript、Images 和其他复杂行为的完全支持,并为每个页面转换一个。 若要在 HTML 中使用外部文件(如图像),请使用文件的绝对 URL。

将 HTML 转换为 Word DOCX 文档

将 HTML 转换为 Office Word 文档 (DOCX) 格式

将 JSON 转换为 XML 转换

将 JSON 对象转换为 XML

将 Markdown 转换为 HTML

将 markdown 文件 (.md) 转换为 HTML

将 Multple Excel XLSX 合并在一起

将多个 Office Excel 电子表格(xlsx)合并到单个 Office Excel 电子表格中

将 Multple PDF 文件合并在一起

将多个 PDF 文件 (pdf) 合并到单个 PDF 文档中,保留合并文档中输入文档的顺序

将 Multple PNG 文件合并在一起

将多个 PNG 文件合并到单个 PNG 文档中,通过垂直堆叠它们来保留合并文档中输入文档的顺序

将 Multple PowerPoint PPTX 合并在一起

将多个 Office PowerPoint 演示文稿(pptx)合并为一个 Office PowerPoint 演示文稿

将 Multple Word DOCX 合并在一起

将多个 Office Word 文档(docx)合并为一个 Office Word 文档

将 Multple 文本 (TXT) 文件合并在一起

将多个文本(.TXT)文件合并为单个文本文档,通过垂直堆叠它们来保留组合文档中输入文档的顺序。

将 PDF 文件拆分为单独的 PDF 文件,每页一个

将输入 PDF 文件拆分为单独的页面,每个页面由一个 PDF 文件组成。

将 PDF 文档转换为文本(txt)

PDF 文档到文本

将 PDF 转换为 PNG 图像数组

将 PDF 文档转换为 PNG 数组,每页一张图像。

将 PDF 转换为 PowerPoint PPTX 演示文稿

将标准 PDF 转换为 Office PowerPoint 演示文稿(pptx)。 以高保真度将 PDF 文件转换为 PowerPoint 格式,可在其中轻松编辑和处理该文件。

将 PDF 转换为 Word DOCX 文档

将标准 PDF 转换为 Office Word 文档(docx)。 以高保真度将 PDF 转换为 Word 格式,可在其中轻松编辑和处理 PDF。

将 PDF 转换为单个 PNG 图像

通过将图像垂直堆叠/连接成单个“高”图像,将 PDF 文档转换为单个高 PNG 图像

将 PNG 数组转换为 PDF

将 PNG 图像数组(每页一张图像)转换为新创建的 PDF。 支持不同大小的图像作为输入。

将 PowerPoint PPT (97-03) 演示文稿转换为 PDF

将 Office PowerPoint (97-2003) 文档 (ppt) 转换为标准 PDF

将 PowerPoint PPT (97-03) 演示文稿转换为 PPTX

将 Office PowerPoint (97-2003) 文档 (ppt) 转换为新式 PPTX

将 PowerPoint PPTX 演示文稿转换为 PDF

将 Office PowerPoint 文档(pptx)转换为标准 PDF

将 PowerPoint PPTX 演示文稿转换为文本(txt)

将 Office PowerPoint 文档 (pptx) 转换为标准文本

将 URL 转换为 PDF

完全呈现网站并返回整页的 PDF。 Javascript、HTML5、CSS 和其他高级功能均受支持。

将 Word DOC (97-03) 文档转换为 DOCX

将 Office Word(97-2003 格式)文档(doc)转换为新式 DOCX 格式

将 Word DOC (97-03) 文档转换为 PDF

将 Office Word(97-2003 格式)文档(doc)转换为标准 PDF

将 Word DOC (97-03) 文档转换为文本 (txt)

将 Office Word DOC (97-03) 文档 (doc) 转换为文本

将 Word DOCX 文档转换为 PDF

将 Office Word 文档(docx)转换为标准 PDF

将 Word DOCX 文档转换为文本(txt)

将 Office Word 文档 (docx) 转换为文本

将 XML 节点作为子节点添加到与 XPath 表达式匹配的 XML 节点

通过将 XML 节点添加为与输入 XPath 表达式匹配的所有节点的子节点来返回编辑 XML 文档的重新筛选。

将 XML 转换为 JSON 转换

将 XML 字符串或文件转换为 JSON

将两个 Excel XLSX 合并在一起

将两个 Office Excel 电子表格(xlsx)合并到单个 Office Excel 电子表格中

将两个 PDF 文件合并在一起

将两个 PDF 文件 (pdf) 合并到单个 PDF 文档中,保留合并文档中输入文档的顺序

将两个 PowerPoint PPTX 合并在一起

将两个 Office PowerPoint 演示文稿(pptx)合并为一个 Office PowerPoint 演示文稿

将两个 Word DOCX 合并在一起

将两个 Office Word 文档(docx)合并为一个 Office Word 文档

将两个文本(TXT)文件合并在一起

将两个文本(.TXT)文件合并为单个文本文档,通过垂直堆叠文档来保留合并文档中输入文档的顺序。

将匹配 XPath 表达式的 XML 节点替换为新节点

通过将与输入 XPath 表达式匹配的所有节点替换为新的 XML 节点表达式,返回编辑 XML 文档的重新筛选。

将单个 Excel XLSX 拆分为单独的工作表

将包含多个工作表(或选项卡)的 Excel XLSX 电子表格拆分为单独的 Excel XLSX 电子表格文件,每个电子表格都包含一个工作表。

将单个 PowerPoint 演示文稿 PPTX 拆分为单独的幻灯片

将一个由多个幻灯片组成的 PowerPoint PPTX 演示文稿拆分为单独的 PowerPoint PPTX 演示文稿文件,每个演示文稿都包含一张幻灯片。

将单个文本文件(txt)拆分为行

按行拆分文本(txt)文档,按顺序分别返回每行。 支持多种类型的换行符。

将属性添加到与 XPath 表达式匹配的所有 XML 节点

通过将属性添加到与输入 XPath 表达式匹配的所有节点,返回编辑 XML 文档的重新筛选。

将文档转换为 PDF

自动检测文件类型并将其转换为 PDF。 支持所有主要 Office 文档文件格式,包括 Word(DOCX、DOC)、Excel(XLSX、XLS)、PowerPoint(PPTX、PPT)、超过 100 种图像格式、HTML 文件,甚至多页 TIFF 文件。

将文档转换为 PNG 数组

自动检测文件类型并将其转换为 PNG 图像数组。 支持所有主要 Office 文档文件格式、超过 100 种图像格式,甚至支持多页 TIFF 文件。

将文档转换为文本(txt)

自动检测文件类型并将其转换为文本。 支持所有主要 Office 文档文件格式,包括 Word(DOCX、DOC)、Excel(XLSX、XLS)、PowerPoint(PPTX、PPT)和 PDF 文件。 对于电子表格,将包括所有工作表。 如果要排除某些页面、工作表、幻灯片等。 先使用拆分文档 API,或者先删除页面/幻灯片/工作表 API,在转换为文本之前将文档调整为目标状态。

将新行插入 Word DOCX 文档中的现有表中

将新表行添加到 DOCX 文档并返回结果。 调用输出 URL 上的“完成编辑”以完成作。

将新表格插入 Word DOCX 文档

将新表添加到 DOCX 中并返回结果。 调用输出 URL 上的“完成编辑”以完成作。

将网站 URL 页面转换为文本(txt)

将网站 URL 页面转换为文本(txt):从 HTML 中提取文本

应用 HTML 模板

应用作以填充 HTML 模板,生成最终 HTML 结果

开始编辑文档

将文档上传到 Cloudmersive 以开始一系列或多项编辑作。 若要编辑文档,请先调用“开始编辑”文档。 然后使用从 BeginEditing 返回的安全 URL(如 Word DOCX 删除页和插入表格)对文档执行作。 最后,对 URL 执行完成编辑以返回生成的已编辑文档。 编辑 URL 是临时的,仅存储在内存中缓存中,并且会在 30 分钟后自动从缓存过期,并且无法直接访问。

按单元格标识符从 Excel XLSX 电子表格获取单元格

根据 Excel 电子表格工作表中的标识符(例如 A1、B22、C33 等)返回特定单元格的值

按字符串分隔符拆分单个文本文件(txt)

按字符串分隔符拆分文本(txt)文档,将字符串的每个组件作为字符串数组返回。

按索引从 Excel XLSX 电子表格获取单元格

返回 Excel 电子表格工作表中特定行中特定单元格的值和定义

按索引清除 Excel XLSX 电子表格中的单元格内容

清除、设置为空白、Excel XLSX 电子表格中特定单元格的内容、工作表

按索引获取 Word DOCX 文档中的特定表

按 Office Word 文档 (DOCX) 中的基于 0 的索引返回特定表对象

按页面将单个 Word 文档 DOCX 拆分为单独的文档

将一个由多个页面组成的 Word DOCX 文档拆分为单独的 Word DOCX 文档文件,每个文档都包含一个页面。

更改图像 DPI

调整图像的大小以具有不同的 DPI

更新、设置 Word DO 中现有表中表格单元格的内容

将表格单元格的内容设置为 DOCX 文档并返回结果。 调用输出 URL 上的“完成编辑”以完成作。

更新、设置 Word DOCX 文档中现有表中表格行的内容

将表格行的内容设置为 DOCX 文档并返回结果。 调用输出 URL 上的“完成编辑”以完成作。

替换 PowerPoint PPTX 演示文稿中的字符串

替换 Office PowerPoint 文档(pptx) 中字符串的所有实例

替换 Word DOCX 文档中的字符串

替换 Office Word 文档(docx)中字符串的所有实例

比较两个 Word DOCX

比较两个 Office Word 文档(docx)文件并突出显示差异

筛选,使用 XPath 表达式选择 XML 节点,获取结果

返回筛选的重新筛选,选择具有 XPath 表达式的 XML 文档

自动检测内容类型并验证

自动检测内容类型,验证并验证内容是否确实在深度完全有效,然后报告验证结果。

获取 URL 的屏幕截图

完全呈现网站并返回整页图像的 PNG 屏幕截图。 Javascript、HTML5、CSS 和其他高级功能均受支持。

获取 W 中现有表行中现有表行的内容

获取 Word DOCX 文档中现有表格行的内容并返回结果。

获取 Word DOCX 文档中的所有表

返回 Office Word 文档中的所有表对象(docx)

获取文档类型信息

自动检测文档的类型信息;不需要文件扩展名。 分析文件内容以确认文件类型。 即使不存在文件扩展名,自动检测系统也会可靠地分析文件的内容并识别其文件类型。 支持 100 多种图像文件格式、Office 文档文件格式、PDF 等。

获取有关映像的信息

从图像(如大小、格式和 MIME 类型、压缩、EXIF 数据(如位置、DPI、唯一颜色、透明度信息等)获取详细信息

设置、更新 Excel XLSX 电子表格中的单元格内容,按 c

设置,使用工作表中的单元格标识符(例如 A1、B22、C33)更新 Excel XLSX 电子表格中特定单元格的内容

设置与 XPath 表达式匹配的 XML 节点的值内容

通过设置与输入 XPath 表达式匹配的所有节点的内容,返回编辑 XML 文档的重新筛选。 支持元素和属性。

验证 Excel 文档 (XLSX)

验证 Excel 文档(XLSX):如果文档无效,则标识文档中的错误

验证 JSON 文件

验证 JSON(JavaScript 对象表示法)文档文件;如果文档无效,则标识文档中的错误

验证 PDF 文档文件

验证 PDF 文档;如果文档无效,则标识文档中的错误

验证 PowerPoint 演示文稿(PPTX)

验证 PowerPoint 演示文稿(PPTX):如果文档无效,则标识文档中的错误

验证 Word 文档 (DOCX)

验证 Word 文档(DOCX):如果文档无效,则标识文档中的错误

验证 XML 文件

验证 XML 文档文件;如果文档无效,则标识文档中的错误

HTML 文档文件到文本 (txt)

HTML 文档到文本

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

将文档转换为纯文本格式的文本转换结果

从 Excel XLSX 电子表格、工作表获取图像

返回 Excel 电子表格工作表中定义的图像

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

路径
Path string

此对象的位置的路径;为新工作表留空

WorksheetName
WorksheetName string

工作表选项卡的面向用户的名称

返回

运行 Get-Images 命令的结果

从 Excel XLSX 电子表格、工作表获取样式

返回 Excel 电子表格中定义的样式

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

返回

运行 Get-Worksheets 命令的结果

从 Excel XLSX 电子表格、工作表获取行和单元格

返回在 Excel 电子表格工作表中定义的行和单元格

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

路径
Path string

此对象的位置的路径;为新工作表留空

WorksheetName
WorksheetName string

工作表选项卡的面向用户的名称

返回

运行 Get-Columns 命令的结果

从 Excel XLSX 电子表格、工作表获取行和单元格

返回在 Excel 电子表格工作表中定义的行和单元格

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

路径
Path string

此对象的位置的路径;为新工作表留空

WorksheetName
WorksheetName string

工作表选项卡的面向用户的名称

返回

运行 Get-Worksheets 命令的结果

从 Excel XLSX 电子表格文档中删除工作表

编辑输入 Excel XLSX 电子表格文档以删除指定的工作表(选项卡)。 使用“获取工作表”API 枚举电子表格中的可用工作表。

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

路径
Path string

此对象的位置的路径;为新工作表留空

WorksheetName
WorksheetName string

工作表选项卡的面向用户的名称

返回

response
object

从 Excel XLSX 电子表格获取工作表

返回在 Excel 电子表格(XLSX)格式化文件中定义的工作表(选项卡)

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

返回

运行 Get-Worksheets 命令的结果

从 PowerPoint PPTX 演示文稿文档中删除、删除幻灯片

编辑输入 PowerPoint PPTX 演示文稿文档以删除指定的幻灯片

参数

名称 密钥 必需 类型 说明
EndDeleteSlideNumber
EndDeleteSlideNumber integer

用于停止删除幻灯片的幻灯片编号(基于 1):包容

InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

StartDeleteSlideNumber
StartDeleteSlideNumber integer

开始删除幻灯片的幻灯片编号(基于 1):包容

返回

从作输出文件内容

OutputContent
binary

从 Word DOCX 文档中删除页眉和页脚

从 Word 文档(DOCX)中删除所有页眉或页脚或两者。 调用输出 URL 上的“完成编辑”以完成作。

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

RemoveFooters
RemoveFooters boolean

如果想要从输入文档中删除所有页脚,则为 true;否则为 false

RemoveHeaders
RemoveHeaders boolean

如果想要从输入文档中删除所有标头,则为 true;否则为 false

返回

运行 Remove Headers 和 Footers 命令的结果

从 Word DOCX 文档分层获取注释

返回 Word 文档(DOCX)格式文件中存储的批注和审阅批注,其中答复批注嵌套为返回结果中顶级批注下的子级。

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

返回

从 Word 文档 DOCX 分层获取注释的结果

从 Word DOCX 文档获取图像

返回 Word 文档(DOCX)格式化文件中定义的图像

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

返回

运行 Get-Images 命令的结果

从 Word DOCX 文档获取样式

返回 Word 文档(DOCX)格式化文件中定义的样式

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

返回

运行 Get-Tables 命令的结果

从 Word DOCX 文档获取正文

返回 Word 文档(DOCX)格式化文件中定义的正文;这是 DOCX 文档的主要内容部分

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

返回

运行 Get-Body 命令的结果

从 Word DOCX 文档获取节

返回 Word 文档(DOCX)格式化文件中定义的节

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

返回

运行 Get-Sections 命令的结果

从 Word DOCX 文档获取页脚的内容

从 Word 文档(DOCX)格式化文件中返回页脚内容

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

返回

运行 Get-Tables 命令的结果

从 Word DOCX 文档获取页面和内容

返回 Word 文档(DOCX)格式化文件中定义的每页的页面和内容

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

返回

从 Word 文档 DOCX 获取页面的结果

从列和行数据创建新的 Excel XLSX 电子表格

返回一个新的 Excel XLSX 电子表格 (XLSX) 格式化文件,该文件使用指定为输入的列和行数据填充

参数

名称 密钥 必需 类型 说明
CellIdentifier
CellIdentifier string

单元格的单元格引用,例如 A1、Z22 等。

Formula
Formula string
路径
Path string

此对象的位置的路径;为新行留空

StyleIndex
StyleIndex integer

要应用于此样式的样式的标识符

TextValue
TextValue string

单元格的文本值

路径
Path string

此对象的位置的路径;为新行留空

WorksheetName
WorksheetName string

自选;新电子表格中将有一个默认工作表;提供名称,或者如果留空,则默认为 Worksheet1

返回

从行和单元格创建新工作表的结果

使用 XQuery 查询查询 XML 文件,获取结果

返回使用 XQuery 表达式查询单个 XML 文档的重新筛选。 支持 XQuery 3.1 及更早版本。 此 API 针对单个 XML 文档进行优化作为输入。 提供的 XML 文档作为默认上下文自动加载;若要访问文档中的元素,只需引用它们而不引用文档,例如 bookstore/book

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入 XML 文件。
inputFile True file

要针对其执行作的输入 XML 文件。

有效的 XML XQuery 3.1 或更早的查询表达式;多行 expressio
XQuery True string

有效的 XML XQuery 3.1 或更早的查询表达式;多行 expressio

返回

对 XML 文档执行 XQuery作的结果。

使用 XQuery 查询查询查询多个 XML 文件,获取结果

返回使用 XQuery 表达式查询 XML 文档的重新筛选。 支持 XQuery 3.1 及更早版本。 此 API 已针对多个 XML 文档进行优化作为输入。 如果包含两个名为 books.xml 和 restaurants.xml的输入文件,则可以按名称引用给定文档的内容,例如 doc(“books.xml”) 或 doc(“restaurants.xml”)。 如果输入文件不包含文件名,则它们默认为文件名 input1.xml、input2.xml 等。

参数

名称 密钥 必需 类型 说明
要对该作执行作的第一个输入 XML 文件。
inputFile1 True file

要对该作执行作的第一个输入 XML 文件。

要对该作执行作的第二个输入 XML 文件。
inputFile2 file

要对该作执行作的第二个输入 XML 文件。

要对该作执行作的第三个输入 XML 文件。
inputFile3 file

要对该作执行作的第三个输入 XML 文件。

要对该作执行作的第四个输入 XML 文件。
inputFile4 file

要对该作执行作的第四个输入 XML 文件。

要对该作执行作的第五个输入 XML 文件。
inputFile5 file

要对该作执行作的第五个输入 XML 文件。

要对该作执行作的第六个输入 XML 文件。
inputFile6 file

要对该作执行作的第六个输入 XML 文件。

要对该作执行作的第七个输入 XML 文件。
inputFile7 file

要对该作执行作的第七个输入 XML 文件。

要对该作执行作的第八个输入 XML 文件。
inputFile8 file

要对该作执行作的第八个输入 XML 文件。

要对该作执行作的第九个输入 XML 文件。
inputFile9 file

要对该作执行作的第九个输入 XML 文件。

要对该作执行作的十个输入 XML 文件。
inputFile10 file

要对该作执行作的十个输入 XML 文件。

有效的 XML XQuery 3.1 或更早的查询表达式;多行 expressio
XQuery True string

有效的 XML XQuery 3.1 或更早的查询表达式;多行 expressio

返回

对多个 XML 文档执行 XQuery作的结果。

使用 XSLT 将 XML 文档文件转换为新的 XML 文档

将 XML 字符串或文件转换为 JSON

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入 XML 文件。
inputFile True file

要针对其执行作的输入 XML 文件。

用于转换输入 XML 文件的输入 XSLT 文件。
transformFile True file

用于转换输入 XML 文件的输入 XSLT 文件。

返回

从作输出文件内容

OutputContent
byte

创建空白 Excel XLSX 电子表格

返回空白的 Excel XLSX 电子表格 (XLSX) 格式化文件

参数

名称 密钥 必需 类型 说明
WorksheetName
WorksheetName string

空白电子表格中将有一个默认工作表;提供名称,或者如果留空,则默认为 Worksheet1

返回

创建空白工作表的结果

创建空白 Word DOCX 文档

返回空白的 Word DOCX 文档格式文件。 该文件为空,没有内容。 使用其他编辑命令(如“插入段落”或“插入表格”或“插入图像”)填充文档。

参数

名称 密钥 必需 类型 说明
InitialText
InitialText string

自选;要包含在文档中的初始文本

返回

创建空白 Word 文档的结果

删除 Word DOCX 文档中现有表中的表格行

删除 Word DOCX 文档中的现有表格行并返回结果。

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

TablePath
TablePath string

要从中删除行的表的路径

TableRowRowIndex
TableRowRowIndex integer

要删除的行的基于 0 的索引(例如 0、1、2、...)表中

返回

运行“删除表行”命令的结果

删除 Word DOCX 文档中的任何对象

从 Word 文档(DOCX)中删除任何对象,如段落、表格、图像等。 传入要删除的对象的路径。 可以调用其他函数,例如 Get-Tables、Get-Images、Get-Body 等来获取文档中对象的路径。 调用输出 URL 上的“完成编辑”以完成作。

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

PathToObjectToRemove
PathToObjectToRemove string

要删除的对象文档中的路径;使用现有对象的 Path 值填充 PathToObjectToRemove 字段。

返回

运行 Remove-Object 命令的结果

删除 Word 中现有表中多个表行的范围

删除 Word DOCX 文档中的 1 个或多个现有表行的范围,并返回结果。

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

TablePath
TablePath string

要从中删除行的表的路径

TableRowRowIndexEnd
TableRowRowIndexEnd integer

要停止删除表中的行的基于 0 的索引(例如 0、1、2...)

TableRowRowIndexStart
TableRowRowIndexStart integer

要开始删除表中的行(例如 0、1、2、...)的行的从 0 开始的索引

返回

运行“删除表行范围”命令的结果

删除、删除 Word DOCX 文档中的页面

返回 Word 文档(DOCX)格式化文件中编辑的 Word 文档,其中删除了指定的页面

参数

名称 密钥 必需 类型 说明
EndDeletePageNumber
EndDeletePageNumber integer

用于停止删除页面的页码(基于 1):包容

InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

StartDeletePageNumber
StartDeletePageNumber integer

开始删除页面的页码(基于 1):包容

返回

从作输出文件内容

OutputContent
binary

删除、删除与 XPath 表达式匹配的 XML 节点和项

通过删除与输入 XPath 表达式匹配的所有节点,返回编辑 XML 文档的重新筛选

参数

名称 密钥 必需 类型 说明
有效的 XML XPath 查询表达式
XPathExpression True string

有效的 XML XPath 查询表达式

要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

使用 XPath 对 XML 输入执行筛选器作的结果

删除、删除与 XPath 表达式匹配的节点的所有子级,但

通过删除与输入 XPath 表达式匹配的节点的所有子节点,返回编辑 XML 文档的重新筛选。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入 XML 文件。
inputFile True file

要针对其执行作的输入 XML 文件。

有效的 XML XPath 查询表达式
XPathExpression True string

有效的 XML XPath 查询表达式

返回

使用 XPath 对 XML 输入执行删除所有子节点作的结果

图像格式转换

在 100 多种文件格式之间转换,包括 Photoshop(PSD)、PNG、JPG、GIF、NEF 和 BMP 等关键格式。

参数

名称 密钥 必需 类型 说明
输入文件格式为 3 个以上的字母文件扩展名。 还可以提供
format1 True string

输入文件格式为 3 个以上的字母文件扩展名。 还可以提供

输出(转换为此格式)文件格式作为 3+ 字母文件外展
format2 True string

输出(转换为此格式)文件格式作为 3+ 字母文件外展

要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

在 Excel XLSX 电子表格中按索引设置、更新单元格内容

设置、更新 Excel XLSX 电子表格、工作表中特定单元格的内容

参数

名称 密钥 必需 类型 说明
CellIndex
CellIndex integer

单元格的 0、1、2、...要设置的行中的

CellIdentifier
CellIdentifier string

单元格的单元格引用,例如 A1、Z22 等。

Formula
Formula string
路径
Path string

此对象的位置的路径;为新行留空

StyleIndex
StyleIndex integer

要应用于此样式的样式的标识符

TextValue
TextValue string

单元格的文本值

InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

RowIndex
RowIndex integer

行的 0、0、1、2、...设置为

路径
Path string

此对象的位置的路径;为新工作表留空

WorksheetName
WorksheetName string

工作表选项卡的面向用户的名称

返回

在 XLSX Worksheets 命令中运行 Set Cell 的结果

在 Excel XLSX 电子表格中插入新工作表

将新工作表插入 Excel 电子表格

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

路径
Path string

此对象的位置的路径;为新工作表留空

WorksheetName
WorksheetName string

工作表选项卡的面向用户的名称

返回

运行 Get-Worksheets 命令的结果

在 Word DOCX 文档中向页脚添加页码

设置 Word 文档(DOCX)中的页脚以包含页码。 调用输出 URL 上的“完成编辑”以完成作。

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

PrependText
PrependText string

可选:在页码之前添加的额外文本,例如,如果要显示“第 1 页”,则可以将 PrependText 设置为“Page”

返回

运行 set-footer 命令的结果

在 Word DOCX 文档中插入图像

在 Word 文档(DOCX)中设置页脚。 调用输出 URL 上的“完成编辑”以完成作。

参数

名称 密钥 必需 类型 说明
HeightInEMUs
HeightInEMUs integer

可选:EMU 中图像的高度

ImageContentsURL
ImageContentsURL string

图像内容的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取内容。

ImageDataContentType
ImageDataContentType string

只读;图像数据 MIME 内容类型

ImageDataEmbedId
ImageDataEmbedId string

只读;图像内容的内部 ID

ImageDescription
ImageDescription string

图像的说明

ImageHeight
ImageHeight integer

EMU 中图像的高度(英语指标单位):设置为 0,默认为页面宽度和基于纵横比的高度

ImageId
ImageId integer

图像的 ID

ImageInternalFileName
ImageInternalFileName string

只读;映像的内部文件名/路径

图像名称
ImageName string

图像的名称

ImageWidth
ImageWidth integer

EMU 中图像的宽度(英语指标单位):设置为 0,默认为页面宽度和基于纵横比的高度

InlineWithText
InlineWithText boolean

如果图像与文本内联,则为 True;如果它浮动,则为 false

路径
Path string

此对象的位置的路径;为新表留空

XOffset
XOffset integer

图像的 X(水平)偏移量

YOffset
YOffset integer

图像的 Y(垂直)偏移量

InputDocumentFileBytes
InputDocumentFileBytes byte

可选:要作的输入文件的字节数

InputDocumentFileUrl
InputDocumentFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

InputImageFileBytes
InputImageFileBytes byte

可选:要作的输入图像文件的字节数;如果提供此值不提供 InputImageFileUrl 或 ImageToAdd,

InputImageFileUrl
InputImageFileUrl string

可选:要作为输入作的图像文件的 URL;如果提供此值不提供 InputImageFileBytes 或 ImageToAdd, 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

InsertPath
InsertPath string

自选;要插入对象的文档内的位置;使用现有对象的 Path 值填充 InsertPath 字段。 与 BeforeExistingObject 或 AfterExistingObject 的 InsertPlacement 一起使用

InsertPlacement
InsertPlacement string

自选;默认值为 DocumentEnd。 插入的位置类型;可能的值包括:DocumentStart(文档开头)、DocumentEnd(文档的结尾)、BeforeExistingObject(在现有对象前 - 使用现有对象的 Path 值填充 InsertPath 字段)、AfterExistingObject(就在现有对象之后- 使用现有对象的 Path 值填充 InsertPath 字段)

WidthInEMU
WidthInEMUs integer

可选:EMU 中图像的宽度

返回

运行 set-footer 命令的结果

在 Word DOCX 文档中插入新段落

将新段落添加到 DOCX 中并返回结果。 可以使用文档的 Path(文档内的位置)在文档的开头/结尾或现有对象之前/之后插入。 调用输出 URL 上的“完成编辑”以完成作。

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

InsertPath
InsertPath string

自选;要插入对象的文档内的位置;使用现有对象的 Path 值填充 InsertPath 字段。 与 BeforeExistingObject 或 AfterExistingObject 的 InsertPlacement 一起使用

InsertPlacement
InsertPlacement string

自选;默认值为 DocumentEnd。 插入的位置类型;可能的值包括:DocumentStart(文档开头)、DocumentEnd(文档的结尾)、BeforeExistingObject(在现有对象前 - 使用现有对象的 Path 值填充 InsertPath 字段)、AfterExistingObject(就在现有对象之后- 使用现有对象的 Path 值填充 InsertPath 字段)

Bold
Bold boolean

如此 使文本加粗,否则为 false

FontFamily
FontFamily string

文本的字体系列名称,例如“Arial”或“Times New Roman”

FontSize
FontSize string

字号(例如“24”)

斜体
Italic boolean

如此 使文本斜体,否则为 false

路径
Path string

此对象的位置的路径;为新表留空

RunIndex
RunIndex integer

基于 0 的运行索引

路径
Path string

此对象的位置的路径;为新表留空

TextContent
TextContent string

包含此文本内容项的文本内容的文本字符串

TextIndex
TextIndex integer

运行中文本内容的索引;基于 0

下划线
Underline string

文本的下划线模式;可能的值包括:Words、Double、Thick、Dotted、DottedHeavy、Dash、Dash、DashedHeavy、DashLong、DashLongHeavy、DotDash、DashDotHeavy、DotDotDash、DashDotDotHeavy、Wave、WavyHeavy、WavyDouble、None

ParagraphIndex
ParagraphIndex integer

段落的索引;基于 0

路径
Path string

此对象的位置的路径;为新表留空

StyleID
StyleID string

应用于段落的样式的样式 ID;如果未应用任何样式,则为 null

返回

运行 Insert-Paragraph 命令的结果

在 Word DOCX 文档中设置标题

在 Word 文档(DOCX)中设置标题。 调用输出 URL 上的“完成编辑”以完成作。

参数

名称 密钥 必需 类型 说明
Bold
Bold boolean

如此 使文本加粗,否则为 false

FontFamily
FontFamily string

文本的字体系列名称,例如“Arial”或“Times New Roman”

FontSize
FontSize string

字号(例如“24”)

斜体
Italic boolean

如此 使文本斜体,否则为 false

路径
Path string

此对象的位置的路径;为新表留空

RunIndex
RunIndex integer

基于 0 的运行索引

路径
Path string

此对象的位置的路径;为新表留空

TextContent
TextContent string

包含此文本内容项的文本内容的文本字符串

TextIndex
TextIndex integer

运行中文本内容的索引;基于 0

下划线
Underline string

文本的下划线模式;可能的值包括:Words、Double、Thick、Dotted、DottedHeavy、Dash、Dash、DashedHeavy、DashLong、DashLongHeavy、DotDash、DashDotHeavy、DotDotDash、DashDotDotHeavy、Wave、WavyHeavy、WavyDouble、None

ParagraphIndex
ParagraphIndex integer

段落的索引;基于 0

路径
Path string

此对象的位置的路径;为新表留空

StyleID
StyleID string

应用于段落的样式的样式 ID;如果未应用任何样式,则为 null

路径
Path string

此对象的位置的路径;为新表留空

路径
Path string

此对象的位置的路径;为新表留空

StartingPageNumbers
StartingPageNumbers array of integer

节开头的页码,通常只有一个

InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

返回

运行 set-header 命令的结果

在 Word DOCX 文档中设置页脚

在 Word 文档(DOCX)中设置页脚。 调用输出 URL 上的“完成编辑”以完成作。

参数

名称 密钥 必需 类型 说明
Bold
Bold boolean

如此 使文本加粗,否则为 false

FontFamily
FontFamily string

文本的字体系列名称,例如“Arial”或“Times New Roman”

FontSize
FontSize string

字号(例如“24”)

斜体
Italic boolean

如此 使文本斜体,否则为 false

路径
Path string

此对象的位置的路径;为新表留空

RunIndex
RunIndex integer

基于 0 的运行索引

路径
Path string

此对象的位置的路径;为新表留空

TextContent
TextContent string

包含此文本内容项的文本内容的文本字符串

TextIndex
TextIndex integer

运行中文本内容的索引;基于 0

下划线
Underline string

文本的下划线模式;可能的值包括:Words、Double、Thick、Dotted、DottedHeavy、Dash、Dash、DashedHeavy、DashLong、DashLongHeavy、DotDash、DashDotHeavy、DotDotDash、DashDotDotHeavy、Wave、WavyHeavy、WavyDouble、None

ParagraphIndex
ParagraphIndex integer

段落的索引;基于 0

路径
Path string

此对象的位置的路径;为新表留空

StyleID
StyleID string

应用于段落的样式的样式 ID;如果未应用任何样式,则为 null

路径
Path string

此对象的位置的路径;为新表留空

路径
Path string

此对象的位置的路径;为新表留空

StartingPageNumbers
StartingPageNumbers array of integer

节开头的页码,通常只有一个

InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

返回

运行 set-footer 命令的结果

在附加到段落的 Word DOCX 文档中插入新批注

将新注释添加到附加到段落的 Word DOCX 文档中,并返回结果。 调用输出 URL 上的“完成编辑”以完成作。

参数

名称 密钥 必需 类型 说明
作者
Author string

批注的作者名称

AuthorInitials
AuthorInitials string

批注作者的缩写

CommentDate
CommentDate date-time

批注的日期时间戳

CommentText
CommentText string

批注的文本内容

完成
Done boolean

如此 如果此注释在 Word 中标记为“完成”,否则为 false

IsReply
IsReply boolean

如此 如果此批注是另一个批注的回复,则为 false;否则为 false

IsTopLevel
IsTopLevel boolean

如此 如果批注位于顶层,则为 false(如果此批注是另一个批注的子答复)

ParentCommentPath
ParentCommentPath string

此批注的父级路径(如果此批注是答复),否则此值将为 null

路径
Path string

文档中批注的路径

InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

ParagraphPath
ParagraphPath string

要向其附加批注的段落的路径。 可以通过调用 Get Body 并获取所需段落的 Path 属性,以检索文档中的所有段落来获取路径,以便向其添加注释。

返回

运行 Insert-Comment-on-Paragraph 命令的结果

基于 PDF 光栅化版本将 PDF 转换为 Word DOCX 文档

将标准 PDF 转换为 Office Word 文档(docx),但首先将 PDF 光栅化。 将高保真度的 PDF 转换为 Word 格式。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

多页图像格式转换

在超过 100 种文件格式之间进行转换,包括对 Multiple-Page 格式的支持(例如 PDF、TIFF 等)和多个页面)。

参数

名称 密钥 必需 类型 说明
输入文件格式为 3 个以上的字母文件扩展名。 还可以提供
format1 True string

输入文件格式为 3 个以上的字母文件扩展名。 还可以提供

输出(转换为此格式)文件格式作为 3+ 字母文件外展
format2 True string

输出(转换为此格式)文件格式作为 3+ 字母文件外展

要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

将多页图像转换为具有不同格式的单个页面的结果

完成编辑文档,并从文档编辑下载结果

编辑完文档后,下载结果。 通过调用开始编辑开始编辑开始编辑文档,然后执行作,然后调用完成编辑来获取结果。

参数

名称 密钥 必需 类型 说明
InputFileUrl
InputFileUrl string

正在编辑的文档的 URL 以获取其内容。

返回

从作输出文件内容

OutputContent
binary

将 CSV 转换为 Excel XLSX 电子表格

将 CSV 文件转换为 Office Excel XLSX 工作簿文件格式。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

将 CSV 转换为 JSON 转换

将 CSV 文件转换为 JSON 对象数组

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

名称 路径 类型 说明
array of object
items
object

将 Excel XLS (97-03) 电子表格转换为 CSV

将 Office Excel (97-2003) 工作簿 (xls) 转换为标准 CSV 格式。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

将 Excel XLS (97-03) 电子表格转换为 PDF

将 Office Excel (97-2003) 工作簿 (xls) 转换为标准 PDF。 将工作簿中的所有工作表转换为 PDF。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

将 Excel XLS (97-03) 电子表格转换为 XLSX

将 Office Excel(97-2003)工作簿(xls)转换为新式 XLSX 格式。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

将 Excel XLSX 电子表格转换为 CSV

将 Office Excel 工作簿(XLSX)转换为标准 Comma-Separated 值(CSV)格式。 支持 XLSX 和 XLSB 文件格式。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

(可选)设置结果的输出文本编码;可能的值
outputEncoding string

(可选)设置结果的输出文本编码;可能的值

返回

从作输出文件内容

OutputContent
binary

将 Excel XLSX 电子表格转换为 PDF

将 Office Excel 工作簿(XLSX)转换为标准 PDF。 将工作簿中的所有工作表转换为 PDF。 支持 XLSX 和 XLSB Excel 文件格式。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

将 Excel XLSX 电子表格转换为文本(txt)

将 Office Excel 工作簿(XLSX)转换为标准文本。 将工作簿中的所有工作表转换为文本。 支持 XLSX 和 XLSB 文件格式。 当电子表格包含多个工作表时,将导出所有工作表中的所有文本。 如果要仅从一个工作表导出文本,请尝试使用拆分 XLSX API 将电子表格拆分为多个工作表文件,然后在需要从中提取文本的单个工作表文件上运行 XLSX 到文本。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

将文档转换为纯文本格式的文本转换结果

将 Excel XLSX 转换为 JSON 转换

将 Excel XLSX 文件转换为 JSON 对象数组

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

名称 路径 类型 说明
array of object
items
object

将 Excel (97-2003) XLS 转换为 JSON 转换

将 Excel (97-2003) XLS 文件转换为 JSON 对象数组

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

名称 路径 类型 说明
array of object
items
object

将 HTML 字符串转换为 PDF

完全呈现网站并返回 HTML 的 PDF。 Javascript、HTML5、CSS 和其他高级功能均受支持。

参数

名称 密钥 必需 类型 说明
ExtraLoadingWait
ExtraLoadingWait integer

可选:在网页完成加载后等待的更多毫秒数,然后再获取屏幕截图。 对于高度异步的网站,非常有用。

Html
Html string

要呈现为 PDF 的 HTML

返回

从作输出文件内容

OutputContent
binary

将 HTML 字符串转换为 PNG 屏幕截图

完全呈现网站并返回 HTML 的 PNG(屏幕截图)。 Javascript、HTML5、CSS 和其他高级功能均受支持。

参数

名称 密钥 必需 类型 说明
ExtraLoadingWait
ExtraLoadingWait integer

可选:在网页完成加载后等待的更多毫秒数,然后再获取屏幕截图。 对于高度异步的网站,非常有用。

Html
Html string

要呈现到 PNG 的 HTML(屏幕截图)

屏幕截图
ScreenshotHeight integer

可选:屏幕截图的高度(以像素为单位);提供 0 默认为 1280 x 1024,提供 -1 以测量页面的全屏高度,并尝试获取屏幕高度屏幕截图

ScreenshotWidth
ScreenshotWidth integer

可选:屏幕截图的宽度(以像素为单位);提供 0 默认为 1280 x 1024,提供 -1 以测量页面的全屏高度,并尝试获取屏幕高度屏幕截图

返回

response
object

将 HTML 字符串转换为文本(txt)

将 HTML 字符串输入转换为文本(txt):从 HTML 中提取文本

参数

名称 密钥 必需 类型 说明
Html
Html string

要从中提取文本的 HTML

返回

运行 HTML 到文本作的结果

将 HTML 文档文件转换为 PDF 文档

将标准 HTML 转换为 PDF,完全支持 CSS、JavaScript、图像和其他复杂行为。 若要使用外部文件(如图像),请使用文件的绝对 URL。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

将 HTML 文档文件转换为 PNG 图像数组

将标准 HTML 转换为对 CSS、JavaScript、Images 和其他复杂行为的完全支持,并为每个页面转换一个。 若要在 HTML 中使用外部文件(如图像),请使用文件的绝对 URL。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

将 PDF 转换为 PNG 数组的结果

将 HTML 转换为 Word DOCX 文档

将 HTML 转换为 Office Word 文档 (DOCX) 格式

参数

名称 密钥 必需 类型 说明
Html
Html string

要呈现为 Office 格式的 HTML

返回

从作输出文件内容

OutputContent
binary

将 JSON 转换为 XML 转换

将 JSON 对象转换为 XML

参数

名称 密钥 必需 类型 说明
object

返回

从作输出文件内容

OutputContent
byte

将 Markdown 转换为 HTML

将 markdown 文件 (.md) 转换为 HTML

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

将 Markdown 文件转换为 HTML 的结果

将 Multple Excel XLSX 合并在一起

将多个 Office Excel 电子表格(xlsx)合并到单个 Office Excel 电子表格中

参数

名称 密钥 必需 类型 说明
要对该作执行作的第一个输入文件。
inputFile1 True file

要对该作执行作的第一个输入文件。

要对该作执行作的第二个输入文件。
inputFile2 True file

要对该作执行作的第二个输入文件。

要对该作执行作的第三个输入文件。
inputFile3 file

要对该作执行作的第三个输入文件。

要对该作执行作的第四个输入文件。
inputFile4 file

要对该作执行作的第四个输入文件。

要对该作执行作的第五个输入文件。
inputFile5 file

要对该作执行作的第五个输入文件。

要对该作执行作的第六个输入文件。
inputFile6 file

要对该作执行作的第六个输入文件。

要对该作执行作的第七个输入文件。
inputFile7 file

要对该作执行作的第七个输入文件。

要对该作执行作的第八个输入文件。
inputFile8 file

要对该作执行作的第八个输入文件。

要对该作执行作的第九个输入文件。
inputFile9 file

要对该作执行作的第九个输入文件。

要对该作执行作的十个输入文件。
inputFile10 file

要对该作执行作的十个输入文件。

返回

从作输出文件内容

OutputContent
binary

将 Multple PDF 文件合并在一起

将多个 PDF 文件 (pdf) 合并到单个 PDF 文档中,保留合并文档中输入文档的顺序

参数

名称 密钥 必需 类型 说明
要对该作执行作的第一个输入文件。
inputFile1 True file

要对该作执行作的第一个输入文件。

要对该作执行作的第二个输入文件。
inputFile2 True file

要对该作执行作的第二个输入文件。

要对该作执行作的第三个输入文件。
inputFile3 file

要对该作执行作的第三个输入文件。

要对该作执行作的第四个输入文件。
inputFile4 file

要对该作执行作的第四个输入文件。

要对该作执行作的第五个输入文件。
inputFile5 file

要对该作执行作的第五个输入文件。

要对该作执行作的第六个输入文件。
inputFile6 file

要对该作执行作的第六个输入文件。

要对该作执行作的第七个输入文件。
inputFile7 file

要对该作执行作的第七个输入文件。

要对该作执行作的第八个输入文件。
inputFile8 file

要对该作执行作的第八个输入文件。

要对该作执行作的第九个输入文件。
inputFile9 file

要对该作执行作的第九个输入文件。

要对该作执行作的十个输入文件。
inputFile10 file

要对该作执行作的十个输入文件。

返回

从作输出文件内容

OutputContent
binary

将 Multple PNG 文件合并在一起

将多个 PNG 文件合并到单个 PNG 文档中,通过垂直堆叠它们来保留合并文档中输入文档的顺序

参数

名称 密钥 必需 类型 说明
要对该作执行作的第一个输入文件。
inputFile1 True file

要对该作执行作的第一个输入文件。

要执行作的第二个输入文件(可以提供超过 2 个)。
inputFile2 True file

要执行作的第二个输入文件(可以提供超过 2 个)。

返回

从作输出文件内容

OutputContent
binary

将 Multple PowerPoint PPTX 合并在一起

将多个 Office PowerPoint 演示文稿(pptx)合并为一个 Office PowerPoint 演示文稿

参数

名称 密钥 必需 类型 说明
要对该作执行作的第一个输入文件。
inputFile1 True file

要对该作执行作的第一个输入文件。

要对该作执行作的第二个输入文件。
inputFile2 True file

要对该作执行作的第二个输入文件。

要对该作执行作的第三个输入文件。
inputFile3 file

要对该作执行作的第三个输入文件。

要对该作执行作的第四个输入文件。
inputFile4 file

要对该作执行作的第四个输入文件。

要对该作执行作的第五个输入文件。
inputFile5 file

要对该作执行作的第五个输入文件。

要对该作执行作的第六个输入文件。
inputFile6 file

要对该作执行作的第六个输入文件。

要对该作执行作的第七个输入文件。
inputFile7 file

要对该作执行作的第七个输入文件。

要对该作执行作的第八个输入文件。
inputFile8 file

要对该作执行作的第八个输入文件。

要对该作执行作的第九个输入文件。
inputFile9 file

要对该作执行作的第九个输入文件。

要对该作执行作的十个输入文件。
inputFile10 file

要对该作执行作的十个输入文件。

返回

从作输出文件内容

OutputContent
binary

将 Multple Word DOCX 合并在一起

将多个 Office Word 文档(docx)合并为一个 Office Word 文档

参数

名称 密钥 必需 类型 说明
要对该作执行作的第一个输入文件。
inputFile1 True file

要对该作执行作的第一个输入文件。

要对该作执行作的第二个输入文件。
inputFile2 True file

要对该作执行作的第二个输入文件。

要对该作执行作的第三个输入文件。
inputFile3 file

要对该作执行作的第三个输入文件。

要对该作执行作的第四个输入文件。
inputFile4 file

要对该作执行作的第四个输入文件。

要对该作执行作的第五个输入文件。
inputFile5 file

要对该作执行作的第五个输入文件。

要对该作执行作的第六个输入文件。
inputFile6 file

要对该作执行作的第六个输入文件。

要对该作执行作的第七个输入文件。
inputFile7 file

要对该作执行作的第七个输入文件。

要对该作执行作的第八个输入文件。
inputFile8 file

要对该作执行作的第八个输入文件。

要对该作执行作的第九个输入文件。
inputFile9 file

要对该作执行作的第九个输入文件。

要对该作执行作的十个输入文件。
inputFile10 file

要对该作执行作的十个输入文件。

返回

从作输出文件内容

OutputContent
binary

将 Multple 文本 (TXT) 文件合并在一起

将多个文本(.TXT)文件合并为单个文本文档,通过垂直堆叠它们来保留组合文档中输入文档的顺序。

参数

名称 密钥 必需 类型 说明
要对该作执行作的第一个输入文件。
inputFile1 True file

要对该作执行作的第一个输入文件。

要对该作执行作的第二个输入文件。
inputFile2 True file

要对该作执行作的第二个输入文件。

要对该作执行作的第三个输入文件。
inputFile3 file

要对该作执行作的第三个输入文件。

要对该作执行作的第四个输入文件。
inputFile4 file

要对该作执行作的第四个输入文件。

要对该作执行作的第五个输入文件。
inputFile5 file

要对该作执行作的第五个输入文件。

要对该作执行作的第六个输入文件。
inputFile6 file

要对该作执行作的第六个输入文件。

要对该作执行作的第七个输入文件。
inputFile7 file

要对该作执行作的第七个输入文件。

要对该作执行作的第八个输入文件。
inputFile8 file

要对该作执行作的第八个输入文件。

要对该作执行作的第九个输入文件。
inputFile9 file

要对该作执行作的第九个输入文件。

要对该作执行作的十个输入文件。
inputFile10 file

要对该作执行作的十个输入文件。

返回

从作输出文件内容

OutputContent
binary

将 PDF 文件拆分为单独的 PDF 文件,每页一个

将输入 PDF 文件拆分为单独的页面,每个页面由一个 PDF 文件组成。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

设置为 true 以直接返回 Doc 中的所有文档内容
returnDocumentContents boolean

设置为 true 以直接返回 Doc 中的所有文档内容

返回

执行 PDF 文件拆分作的结果

将 PDF 文档转换为文本(txt)

PDF 文档到文本

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

自选;指定转换 PDF 时应如何处理空格
textFormattingMode string

自选;指定转换 PDF 时应如何处理空格

返回

将文档转换为纯文本格式的文本转换结果

将 PDF 转换为 PNG 图像数组

将 PDF 文档转换为 PNG 数组,每页一张图像。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

将 PDF 转换为 PNG 数组的结果

将 PDF 转换为 PowerPoint PPTX 演示文稿

将标准 PDF 转换为 Office PowerPoint 演示文稿(pptx)。 以高保真度将 PDF 文件转换为 PowerPoint 格式,可在其中轻松编辑和处理该文件。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

将 PDF 转换为 Word DOCX 文档

将标准 PDF 转换为 Office Word 文档(docx)。 以高保真度将 PDF 转换为 Word 格式,可在其中轻松编辑和处理 PDF。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

将 PDF 转换为单个 PNG 图像

通过将图像垂直堆叠/连接成单个“高”图像,将 PDF 文档转换为单个高 PNG 图像

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

将 PNG 数组转换为 PDF

将 PNG 图像数组(每页一张图像)转换为新创建的 PDF。 支持不同大小的图像作为输入。

参数

名称 密钥 必需 类型 说明
要对该作执行作的第一个输入文件。
inputFile1 True file

要对该作执行作的第一个输入文件。

要对该作执行作的第二个输入文件。
inputFile2 True file

要对该作执行作的第二个输入文件。

要对该作执行作的第三个输入文件。
inputFile3 file

要对该作执行作的第三个输入文件。

要对该作执行作的第四个输入文件。
inputFile4 file

要对该作执行作的第四个输入文件。

要对该作执行作的第五个输入文件。
inputFile5 file

要对该作执行作的第五个输入文件。

要对该作执行作的第六个输入文件。
inputFile6 file

要对该作执行作的第六个输入文件。

要对该作执行作的第七个输入文件。
inputFile7 file

要对该作执行作的第七个输入文件。

要对该作执行作的第八个输入文件。
inputFile8 file

要对该作执行作的第八个输入文件。

要对该作执行作的第九个输入文件。
inputFile9 file

要对该作执行作的第九个输入文件。

要对该作执行作的十个输入文件。
inputFile10 file

要对该作执行作的十个输入文件。

返回

从作输出文件内容

OutputContent
binary

将 PowerPoint PPT (97-03) 演示文稿转换为 PDF

将 Office PowerPoint (97-2003) 文档 (ppt) 转换为标准 PDF

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

将 PowerPoint PPT (97-03) 演示文稿转换为 PPTX

将 Office PowerPoint (97-2003) 文档 (ppt) 转换为新式 PPTX

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

将 PowerPoint PPTX 演示文稿转换为 PDF

将 Office PowerPoint 文档(pptx)转换为标准 PDF

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

将 PowerPoint PPTX 演示文稿转换为文本(txt)

将 Office PowerPoint 文档 (pptx) 转换为标准文本

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

将文档转换为纯文本格式的文本转换结果

将 URL 转换为 PDF

完全呈现网站并返回整页的 PDF。 Javascript、HTML5、CSS 和其他高级功能均受支持。

参数

名称 密钥 必需 类型 说明
ExtraLoadingWait
ExtraLoadingWait integer

可选:在网页完成加载后等待的更多毫秒数,然后再获取屏幕截图。 对于高度异步的网站,非常有用。 为默认值 5000 毫秒(5 秒)提供值 0

屏幕截图
ScreenshotHeight integer

可选:屏幕截图的高度(以像素为单位);提供 0 默认为 1280 x 1024,提供 -1 以测量页面的全屏高度,并尝试获取屏幕高度屏幕截图

ScreenshotWidth
ScreenshotWidth integer

可选:屏幕截图的宽度(以像素为单位);提供 0 默认为 1280 x 1024

网址
Url string

要屏幕截图的网站 URL 地址。 支持 HTTP 和 HTTPS,自定义端口也受支持。

返回

从作输出文件内容

OutputContent
binary

将 Word DOC (97-03) 文档转换为 DOCX

将 Office Word(97-2003 格式)文档(doc)转换为新式 DOCX 格式

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

将 Word DOC (97-03) 文档转换为 PDF

将 Office Word(97-2003 格式)文档(doc)转换为标准 PDF

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

将 Word DOC (97-03) 文档转换为文本 (txt)

将 Office Word DOC (97-03) 文档 (doc) 转换为文本

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

将文档转换为纯文本格式的文本转换结果

将 Word DOCX 文档转换为 PDF

将 Office Word 文档(docx)转换为标准 PDF

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

将 Word DOCX 文档转换为文本(txt)

将 Office Word 文档 (docx) 转换为文本

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

自选;指定转换时应如何处理空格
textFormattingMode string

自选;指定转换时应如何处理空格

返回

将文档转换为纯文本格式的文本转换结果

将 XML 节点作为子节点添加到与 XPath 表达式匹配的 XML 节点

通过将 XML 节点添加为与输入 XPath 表达式匹配的所有节点的子节点来返回编辑 XML 文档的重新筛选。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入 XML 文件。
inputFile True file

要针对其执行作的输入 XML 文件。

有效的 XML XPath 查询表达式
XPathExpression True string

有效的 XML XPath 查询表达式

要添加为子项的 XML 节点
XmlNodeToAdd True string

要添加为子项的 XML 节点

返回

使用 XPath 对 XML 输入执行添加子节点作的结果

将 XML 转换为 JSON 转换

将 XML 字符串或文件转换为 JSON

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

response
object

将两个 Excel XLSX 合并在一起

将两个 Office Excel 电子表格(xlsx)合并到单个 Office Excel 电子表格中

参数

名称 密钥 必需 类型 说明
要对该作执行作的第一个输入文件。
inputFile1 True file

要对该作执行作的第一个输入文件。

要执行作的第二个输入文件(可以提供超过 2 个)。
inputFile2 True file

要执行作的第二个输入文件(可以提供超过 2 个)。

返回

从作输出文件内容

OutputContent
binary

将两个 PDF 文件合并在一起

将两个 PDF 文件 (pdf) 合并到单个 PDF 文档中,保留合并文档中输入文档的顺序

参数

名称 密钥 必需 类型 说明
要对该作执行作的第一个输入文件。
inputFile1 True file

要对该作执行作的第一个输入文件。

要执行作的第二个输入文件(可以提供超过 2 个)。
inputFile2 True file

要执行作的第二个输入文件(可以提供超过 2 个)。

返回

从作输出文件内容

OutputContent
binary

将两个 PowerPoint PPTX 合并在一起

将两个 Office PowerPoint 演示文稿(pptx)合并为一个 Office PowerPoint 演示文稿

参数

名称 密钥 必需 类型 说明
要对该作执行作的第一个输入文件。
inputFile1 True file

要对该作执行作的第一个输入文件。

要执行作的第二个输入文件(可以提供超过 2 个)。
inputFile2 True file

要执行作的第二个输入文件(可以提供超过 2 个)。

返回

从作输出文件内容

OutputContent
binary

将两个 Word DOCX 合并在一起

将两个 Office Word 文档(docx)合并为一个 Office Word 文档

参数

名称 密钥 必需 类型 说明
要对该作执行作的第一个输入文件。
inputFile1 True file

要对该作执行作的第一个输入文件。

要执行作的第二个输入文件(可以提供超过 2 个)。
inputFile2 True file

要执行作的第二个输入文件(可以提供超过 2 个)。

返回

从作输出文件内容

OutputContent
binary

将两个文本(TXT)文件合并在一起

将两个文本(.TXT)文件合并为单个文本文档,通过垂直堆叠文档来保留合并文档中输入文档的顺序。

参数

名称 密钥 必需 类型 说明
要对该作执行作的第一个输入文件。
inputFile1 True file

要对该作执行作的第一个输入文件。

要执行作的第二个输入文件(可以提供超过 2 个)。
inputFile2 True file

要执行作的第二个输入文件(可以提供超过 2 个)。

返回

response
object

将匹配 XPath 表达式的 XML 节点替换为新节点

通过将与输入 XPath 表达式匹配的所有节点替换为新的 XML 节点表达式,返回编辑 XML 文档的重新筛选。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入 XML 文件。
inputFile True file

要针对其执行作的输入 XML 文件。

有效的 XML XPath 查询表达式
XPathExpression True string

有效的 XML XPath 查询表达式

XML 节点替换内容
XmlNodeReplacement True string

XML 节点替换内容

返回

使用 XPath 对 XML 输入执行替换节点作的结果

将单个 Excel XLSX 拆分为单独的工作表

将包含多个工作表(或选项卡)的 Excel XLSX 电子表格拆分为单独的 Excel XLSX 电子表格文件,每个电子表格都包含一个工作表。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

设置为 true 以直接返回每个工作表的内容,设置为
returnDocumentContents boolean

设置为 true 以直接返回每个工作表的内容,设置为

返回

将电子表格拆分为单个 Excel XLSX 工作表的结果

将单个 PowerPoint 演示文稿 PPTX 拆分为单独的幻灯片

将一个由多个幻灯片组成的 PowerPoint PPTX 演示文稿拆分为单独的 PowerPoint PPTX 演示文稿文件,每个演示文稿都包含一张幻灯片。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

设置为 true 以直接返回每个演示文稿的内容,设置
returnDocumentContents boolean

设置为 true 以直接返回每个演示文稿的内容,设置

返回

将演示文稿拆分为单个 PowerPoint PPTX 幻灯片的结果

将单个文本文件(txt)拆分为行

按行拆分文本(txt)文档,按顺序分别返回每行。 支持多种类型的换行符。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

将文本文档拆分为单独的行的结果

将属性添加到与 XPath 表达式匹配的所有 XML 节点

通过将属性添加到与输入 XPath 表达式匹配的所有节点,返回编辑 XML 文档的重新筛选。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入 XML 文件。
inputFile True file

要针对其执行作的输入 XML 文件。

有效的 XML XPath 查询表达式
XPathExpression True string

有效的 XML XPath 查询表达式

要添加的 XML 属性的名称
XmlAttributeName True string

要添加的 XML 属性的名称

要添加的 XML 属性的值
XmlAttributeValue True string

要添加的 XML 属性的值

返回

使用 XPath 对 XML 输入执行添加属性节点作的结果

将文档转换为 PDF

自动检测文件类型并将其转换为 PDF。 支持所有主要 Office 文档文件格式,包括 Word(DOCX、DOC)、Excel(XLSX、XLS)、PowerPoint(PPTX、PPT)、超过 100 种图像格式、HTML 文件,甚至多页 TIFF 文件。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

将文档转换为 PNG 数组

自动检测文件类型并将其转换为 PNG 图像数组。 支持所有主要 Office 文档文件格式、超过 100 种图像格式,甚至支持多页 TIFF 文件。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

将自动检测到的输入转换为 PNG 数组的结果

将文档转换为文本(txt)

自动检测文件类型并将其转换为文本。 支持所有主要 Office 文档文件格式,包括 Word(DOCX、DOC)、Excel(XLSX、XLS)、PowerPoint(PPTX、PPT)和 PDF 文件。 对于电子表格,将包括所有工作表。 如果要排除某些页面、工作表、幻灯片等。 先使用拆分文档 API,或者先删除页面/幻灯片/工作表 API,在转换为文本之前将文档调整为目标状态。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

自选;指定转换时应如何处理空格
textFormattingMode string

自选;指定转换时应如何处理空格

返回

将文档转换为纯文本格式的文本转换结果

将新行插入 Word DOCX 文档中的现有表中

将新表行添加到 DOCX 文档并返回结果。 调用输出 URL 上的“完成编辑”以完成作。

参数

名称 密钥 必需 类型 说明
ExistingTablePath
ExistingTablePath string

必填;要修改的现有表的路径

InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

InsertPlacement
InsertPlacement string

自选;默认值为 TableEnd。 插入的位置类型;可能的值包括:TableStart(表的开头)、TableEnd(文档的末尾)或基于 0 的行索引号作为整数,0 是表中的第一行,1 是表中的第二行,2 是表中的第三行,等等。

路径
Path string

此表行对象的位置的路径;为新表留空

CellIndex
CellIndex integer

基于 0 的单元格的索引

CellShadingColor
CellShadingColor string

单元格底纹的颜色

CellShadingFill
CellShadingFill string

单元格底纹填充

CellShadingPattern
CellShadingPattern string

单元格底纹的图案

CellWidth
CellWidth string

单元格的宽度

CellWidthMode
CellWidthMode string

单元格的宽度模式;可以是自动(自动)或手动

Bold
Bold boolean

如此 使文本加粗,否则为 false

FontFamily
FontFamily string

文本的字体系列名称,例如“Arial”或“Times New Roman”

FontSize
FontSize string

字号(例如“24”)

斜体
Italic boolean

如此 使文本斜体,否则为 false

路径
Path string

此对象的位置的路径;为新表留空

RunIndex
RunIndex integer

基于 0 的运行索引

路径
Path string

此对象的位置的路径;为新表留空

TextContent
TextContent string

包含此文本内容项的文本内容的文本字符串

TextIndex
TextIndex integer

运行中文本内容的索引;基于 0

下划线
Underline string

文本的下划线模式;可能的值包括:Words、Double、Thick、Dotted、DottedHeavy、Dash、Dash、DashedHeavy、DashLong、DashLongHeavy、DotDash、DashDotHeavy、DotDotDash、DashDotDotHeavy、Wave、WavyHeavy、WavyDouble、None

ParagraphIndex
ParagraphIndex integer

段落的索引;基于 0

路径
Path string

此对象的位置的路径;为新表留空

StyleID
StyleID string

应用于段落的样式的样式 ID;如果未应用任何样式,则为 null

路径
Path string

此对象的位置的路径;为新表留空

RowIndex
RowIndex integer

基于 0 的行的索引

返回

运行 Insert-Table Row 命令的结果

将新表格插入 Word DOCX 文档

将新表添加到 DOCX 中并返回结果。 调用输出 URL 上的“完成编辑”以完成作。

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

InsertPath
InsertPath string

自选;要插入对象的文档内的位置;使用现有对象的 Path 值填充 InsertPath 字段。 与 BeforeExistingObject 或 AfterExistingObject 的 InsertPlacement 一起使用

InsertPlacement
InsertPlacement string

自选;默认值为 DocumentEnd。 插入的位置类型;可能的值包括:DocumentStart(文档开头)、DocumentEnd(文档的结尾)、BeforeExistingObject(在现有对象前 - 使用现有对象的 Path 值填充 InsertPath 字段)、AfterExistingObject(就在现有对象之后- 使用现有对象的 Path 值填充 InsertPath 字段)

BottomBorderColor
BottomBorderColor string

HTML 样式的颜色十六进制值(不包括 #)

BottomBorderSize
BottomBorderSize integer

边框宽度(1/72 英寸)

BottomBorderSpace
BottomBorderSpace integer

边框周围间距(1/72 英寸)

BottomBorderType
BottomBorderType string

底部边框的类型 - 可以是 Single、DashDotStroked、Dashed、DashSmallGap、DotDash、DotDotDash、Dotted、Double、DoubleWave、Inset、 Nil、None、Outset、Thick、ThickThinLargeGap、ThickThinMediumGap、ThickThinSmallGap、ThinThickLargeGap、ThinThickMediumGap、ThinThickSmallGap、ThinThickThinMediumGap、ThinThickThinMediumGap、ThreeDEmboss、ThreeDEngrave、Triple、Wave

CellHorizontalBorderColor
CellHorizontalBorderColor string

HTML 样式的颜色十六进制值(不包括 #)

CellHorizontalBorderSize
CellHorizontalBorderSize integer

边框宽度(1/72 英寸)

CellHorizontalBorderSpace
CellHorizontalBorderSpace integer

边框周围间距(1/72 英寸)

CellHorizontalBorderType
CellHorizontalBorderType string

单元格水平边框的类型 - 可以是单个、DashDotStroked、Dashed、DashSmallGap、DotDash、DotDotDash、DotDotDash、Dotted、Double、DoubleWave、Inset、 Nil、None、Outset、Thick、ThickThinLargeGap、ThickThinMediumGap、ThickThinSmallGap、ThinThickLargeGap、ThinThickMediumGap、ThinThickSmallGap、ThinThickThinMediumGap、ThinThickThinMediumGap、ThreeDEmboss、ThreeDEngrave、Triple、Wave

CellVerticalBorderColor
CellVerticalBorderColor string

HTML 样式的颜色十六进制值(不包括 #)

CellVerticalBorderSize
CellVerticalBorderSize integer

边框宽度(1/72 英寸)

CellVerticalBorderSpace
CellVerticalBorderSpace integer

边框周围间距(1/72 英寸)

CellVerticalBorderType
CellVerticalBorderType string

单元格垂直边框的类型 - 可以是 Single、DashDotStroked、Dashed、DashSmallGap、DotDash、DotDotDash、Dotted、Double、DoubleWave、Inset、 Nil、None、Outset、Thick、ThickThinLargeGap、ThickThinMediumGap、ThickThinSmallGap、ThinThickLargeGap、ThinThickMediumGap、ThinThickSmallGap、ThinThickThinMediumGap、ThinThickThinMediumGap、ThreeDEmboss、ThreeDEngrave、Triple、Wave

EndBorderColor
EndBorderColor string

HTML 样式的颜色十六进制值(不包括 #)

EndBorderSize
EndBorderSize integer

边框宽度(1/72 英寸)

EndBorderSpace
EndBorderSpace integer

边框周围间距(1/72 英寸)

EndBorderType
EndBorderType string

结束边框的类型 - 可以是 Single、DashDotStroked、Dashed、DashSmallGap、DotDash、DotDotDash、Dotted、Double、DoubleWave、Inset、 Nil、None、Outset、Thick、ThickThinLargeGap、ThickThinMediumGap、ThickThinSmallGap、ThinThickLargeGap、ThinThickMediumGap、ThinThickSmallGap、ThinThickThinMediumGap、ThinThickThinMediumGap、ThreeDEmboss、ThreeDEngrave、Triple、Wave

LeftBorderColor
LeftBorderColor string

HTML 样式的颜色十六进制值(不包括 #)

LeftBorderSize
LeftBorderSize integer

边框宽度(1/72 英寸)

LeftBorderSpace
LeftBorderSpace integer

边框周围间距(1/72 英寸)

LeftBorderType
LeftBorderType string

左边框的类型 - 可以是 Single、DashDotStroked、Dashed、DashSmallGap、DotDash、DotDotDash、Dotted、Double、DoubleWave、Inset、 Nil、None、Outset、Thick、ThickThinLargeGap、ThickThinMediumGap、ThickThinSmallGap、ThinThickLargeGap、ThinThickMediumGap、ThinThickSmallGap、ThinThickThinMediumGap、ThinThickThinMediumGap、ThreeDEmboss、ThreeDEngrave、Triple、Wave

路径
Path string

此表对象的位置的路径;为新表留空

RightBorderColor
RightBorderColor string

HTML 样式的颜色十六进制值(不包括 #)

RightBorderSize
RightBorderSize integer

边框宽度(1/72 英寸)

RightBorderSpace
RightBorderSpace integer

边框周围间距(1/72 英寸)

RightBorderType
RightBorderType string

右边框的类型 - 可以是 Single、DashDotStroked、Dashed、DashSmallGap、DotDash、DotDotDash、Dotted、Double、DoubleWave、Inset、 Nil、None、Outset、Thick、ThickThinLargeGap、ThickThinMediumGap、ThickThinSmallGap、ThinThickLargeGap、ThinThickMediumGap、ThinThickSmallGap、ThinThickThinMediumGap、ThinThickThinMediumGap、ThreeDEmboss、ThreeDEngrave、Triple、Wave

StartBorderColor
StartBorderColor string

HTML 样式的颜色十六进制值(不包括 #)

StartBorderSize
StartBorderSize integer

边框宽度(1/72 英寸)

StartBorderSpace
StartBorderSpace integer

边框周围间距(1/72 英寸)

StartBorderType
StartBorderType string

开始边框的类型 - 可以是 Single、DashDotStroked、Dashed、DashSmallGap、DotDash、DotDotDash、Dotted、Double、DoubleWave、Inset、 Nil、None、Outset、Thick、ThickThinLargeGap、ThickThinMediumGap、ThickThinSmallGap、ThinThickLargeGap、ThinThickMediumGap、ThinThickSmallGap、ThinThickThinMediumGap、ThinThickThinMediumGap、ThreeDEmboss、ThreeDEngrave、Triple、Wave

TableID
TableID string

表的 ID;为新表留空

TableIndentationMode
TableIndentationMode string

表缩进类型

TableIndentationWidth
TableIndentationWidth integer

表格缩进宽度

路径
Path string

此表行对象的位置的路径;为新表留空

CellIndex
CellIndex integer

基于 0 的单元格的索引

CellShadingColor
CellShadingColor string

单元格底纹的颜色

CellShadingFill
CellShadingFill string

单元格底纹填充

CellShadingPattern
CellShadingPattern string

单元格底纹的图案

CellWidth
CellWidth string

单元格的宽度

CellWidthMode
CellWidthMode string

单元格的宽度模式;可以是自动(自动)或手动

Bold
Bold boolean

如此 使文本加粗,否则为 false

FontFamily
FontFamily string

文本的字体系列名称,例如“Arial”或“Times New Roman”

FontSize
FontSize string

字号(例如“24”)

斜体
Italic boolean

如此 使文本斜体,否则为 false

路径
Path string

此对象的位置的路径;为新表留空

RunIndex
RunIndex integer

基于 0 的运行索引

路径
Path string

此对象的位置的路径;为新表留空

TextContent
TextContent string

包含此文本内容项的文本内容的文本字符串

TextIndex
TextIndex integer

运行中文本内容的索引;基于 0

下划线
Underline string

文本的下划线模式;可能的值包括:Words、Double、Thick、Dotted、DottedHeavy、Dash、Dash、DashedHeavy、DashLong、DashLongHeavy、DotDash、DashDotHeavy、DotDotDash、DashDotDotHeavy、Wave、WavyHeavy、WavyDouble、None

ParagraphIndex
ParagraphIndex integer

段落的索引;基于 0

路径
Path string

此对象的位置的路径;为新表留空

StyleID
StyleID string

应用于段落的样式的样式 ID;如果未应用任何样式,则为 null

路径
Path string

此对象的位置的路径;为新表留空

RowIndex
RowIndex integer

基于 0 的行的索引

TopBorderColor
TopBorderColor string

HTML 样式的颜色十六进制值(不包括 #)

TopBorderSize
TopBorderSize integer

边框宽度(1/72 英寸)

TopBorderSpace
TopBorderSpace integer

边框周围间距(1/72 英寸)

TopBorderType
TopBorderType string

上边框的类型 - 可以是 Single、DashDotStroked、Dashed、DashSmallGap、DotDash、DotDotDash、Dotted、Double、DoubleWave、Inset、 Nil、None、Outset、Thick、ThickThinLargeGap、ThickThinMediumGap、ThickThinSmallGap、ThinThickLargeGap、ThinThickMediumGap、ThinThickSmallGap、ThinThickThinMediumGap、ThinThickThinMediumGap、ThreeDEmboss、ThreeDEngrave、Triple、Wave

宽度
Width string

表的宽度,如果未指定,则为 0

WidthType
WidthType string

表的 Width 配置类型

返回

运行 Insert-Tables 命令的结果

将网站 URL 页面转换为文本(txt)

将网站 URL 页面转换为文本(txt):从 HTML 中提取文本

参数

名称 密钥 必需 类型 说明
网址
Url string

要从中提取文本的网站 URL

返回

运行 URL 网站到文本作的结果

应用 HTML 模板

应用作以填充 HTML 模板,生成最终 HTML 结果

参数

名称 密钥 必需 类型 说明
HtmlTemplate
HtmlTemplate string

HTML 模板输入作为字符串

HtmlTemplateUrl
HtmlTemplateUrl string

HTML 模板输入的 URL

Action
Action integer

要执行的作;可能的值为“Replace”

MatchAgsint
MatchAgsint string

对于 Replace作,要匹配的字符串(要替换为 ReplaceWith 字符串)

ReplaceWith
ReplaceWith string

对于 Replace作,要替换为原始字符串的字符串

返回

来自 HTML 模板应用程序的响应

开始编辑文档

将文档上传到 Cloudmersive 以开始一系列或多项编辑作。 若要编辑文档,请先调用“开始编辑”文档。 然后使用从 BeginEditing 返回的安全 URL(如 Word DOCX 删除页和插入表格)对文档执行作。 最后,对 URL 执行完成编辑以返回生成的已编辑文档。 编辑 URL 是临时的,仅存储在内存中缓存中,并且会在 30 分钟后自动从缓存过期,并且无法直接访问。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

response
string

按单元格标识符从 Excel XLSX 电子表格获取单元格

根据 Excel 电子表格工作表中的标识符(例如 A1、B22、C33 等)返回特定单元格的值

参数

名称 密钥 必需 类型 说明
CellIdentifier
CellIdentifier string

必填;Excel 单元格标识符,例如 A1、B22、C33 等。

InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

路径
Path string

此对象的位置的路径;为新工作表留空

WorksheetName
WorksheetName string

工作表选项卡的面向用户的名称

返回

运行 Get-Cell 命令的结果

按字符串分隔符拆分单个文本文件(txt)

按字符串分隔符拆分文本(txt)文档,将字符串的每个组件作为字符串数组返回。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

必填;用于拆分输入文件的字符串
splitDelimiter True string

必填;用于拆分输入文件的字符串

自选;如果为 true,则会在输出中跳过空元素
skipEmptyElements boolean

自选;如果为 true,则会在输出中跳过空元素

返回

将文本文档拆分为单独的元素的结果

按索引从 Excel XLSX 电子表格获取单元格

返回 Excel 电子表格工作表中特定行中特定单元格的值和定义

参数

名称 密钥 必需 类型 说明
CellIndex
CellIndex integer

单元格的 0、1、2、...要检索的行中的

InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

RowIndex
RowIndex integer

行的 0、0、1、2、...要检索

路径
Path string

此对象的位置的路径;为新工作表留空

WorksheetName
WorksheetName string

工作表选项卡的面向用户的名称

返回

运行 Get-Cell 命令的结果

按索引清除 Excel XLSX 电子表格中的单元格内容

清除、设置为空白、Excel XLSX 电子表格中特定单元格的内容、工作表

参数

名称 密钥 必需 类型 说明
CellIndex
CellIndex integer

单元格的 0、1、2、...要清除的行

InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

RowIndex
RowIndex integer

行的 0、0、1、2、...以清除

路径
Path string

此对象的位置的路径;为新工作表留空

WorksheetName
WorksheetName string

工作表选项卡的面向用户的名称

返回

运行 Clear XLSX Cell 命令的结果

按索引获取 Word DOCX 文档中的特定表

按 Office Word 文档 (DOCX) 中的基于 0 的索引返回特定表对象

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

TableIndex
TableIndex integer

要从 Word 文档检索的表的基于 0 的索引

返回

按 Index 命令运行 Get-Tables 的结果

按页面将单个 Word 文档 DOCX 拆分为单独的文档

将一个由多个页面组成的 Word DOCX 文档拆分为单独的 Word DOCX 文档文件,每个文档都包含一个页面。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

设置为 true 以直接返回每个工作表的内容,设置为
returnDocumentContents boolean

设置为 true 以直接返回每个工作表的内容,设置为

返回

将 Word 文档拆分为单个 Word DOCX 页面的结果

更改图像 DPI

调整图像的大小以具有不同的 DPI

参数

名称 密钥 必需 类型 说明
以每英寸像素为单位的新 DPI,例如 300 DPI 或 600 DPI
dpi True integer

以每英寸像素为单位的新 DPI,例如 300 DPI 或 600 DPI

要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

从作输出文件内容

OutputContent
binary

更新、设置 Word DO 中现有表中表格单元格的内容

将表格单元格的内容设置为 DOCX 文档并返回结果。 调用输出 URL 上的“完成编辑”以完成作。

参数

名称 密钥 必需 类型 说明
CellIndex
CellIndex integer

基于 0 的单元格的索引

CellShadingColor
CellShadingColor string

单元格底纹的颜色

CellShadingFill
CellShadingFill string

单元格底纹填充

CellShadingPattern
CellShadingPattern string

单元格底纹的图案

CellWidth
CellWidth string

单元格的宽度

CellWidthMode
CellWidthMode string

单元格的宽度模式;可以是自动(自动)或手动

Bold
Bold boolean

如此 使文本加粗,否则为 false

FontFamily
FontFamily string

文本的字体系列名称,例如“Arial”或“Times New Roman”

FontSize
FontSize string

字号(例如“24”)

斜体
Italic boolean

如此 使文本斜体,否则为 false

路径
Path string

此对象的位置的路径;为新表留空

RunIndex
RunIndex integer

基于 0 的运行索引

路径
Path string

此对象的位置的路径;为新表留空

TextContent
TextContent string

包含此文本内容项的文本内容的文本字符串

TextIndex
TextIndex integer

运行中文本内容的索引;基于 0

下划线
Underline string

文本的下划线模式;可能的值包括:Words、Double、Thick、Dotted、DottedHeavy、Dash、Dash、DashedHeavy、DashLong、DashLongHeavy、DotDash、DashDotHeavy、DotDotDash、DashDotDotHeavy、Wave、WavyHeavy、WavyDouble、None

ParagraphIndex
ParagraphIndex integer

段落的索引;基于 0

路径
Path string

此对象的位置的路径;为新表留空

StyleID
StyleID string

应用于段落的样式的样式 ID;如果未应用任何样式,则为 null

路径
Path string

此对象的位置的路径;为新表留空

ExistingTablePath
ExistingTablePath string

必填;要修改的现有表的路径

InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

TableCellIndex
TableCellIndex integer

要更新的表单元格(行内)的基于 0 的索引

TableRowIndex
TableRowIndex integer

要更新的表行的基于 0 的索引

返回

运行 Update Table Cell 命令的结果

更新、设置 Word DOCX 文档中现有表中表格行的内容

将表格行的内容设置为 DOCX 文档并返回结果。 调用输出 URL 上的“完成编辑”以完成作。

参数

名称 密钥 必需 类型 说明
ExistingTablePath
ExistingTablePath string

必填;要修改的现有表的路径

InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

路径
Path string

此表行对象的位置的路径;为新表留空

CellIndex
CellIndex integer

基于 0 的单元格的索引

CellShadingColor
CellShadingColor string

单元格底纹的颜色

CellShadingFill
CellShadingFill string

单元格底纹填充

CellShadingPattern
CellShadingPattern string

单元格底纹的图案

CellWidth
CellWidth string

单元格的宽度

CellWidthMode
CellWidthMode string

单元格的宽度模式;可以是自动(自动)或手动

Bold
Bold boolean

如此 使文本加粗,否则为 false

FontFamily
FontFamily string

文本的字体系列名称,例如“Arial”或“Times New Roman”

FontSize
FontSize string

字号(例如“24”)

斜体
Italic boolean

如此 使文本斜体,否则为 false

路径
Path string

此对象的位置的路径;为新表留空

RunIndex
RunIndex integer

基于 0 的运行索引

路径
Path string

此对象的位置的路径;为新表留空

TextContent
TextContent string

包含此文本内容项的文本内容的文本字符串

TextIndex
TextIndex integer

运行中文本内容的索引;基于 0

下划线
Underline string

文本的下划线模式;可能的值包括:Words、Double、Thick、Dotted、DottedHeavy、Dash、Dash、DashedHeavy、DashLong、DashLongHeavy、DotDash、DashDotHeavy、DotDotDash、DashDotDotHeavy、Wave、WavyHeavy、WavyDouble、None

ParagraphIndex
ParagraphIndex integer

段落的索引;基于 0

路径
Path string

此对象的位置的路径;为新表留空

StyleID
StyleID string

应用于段落的样式的样式 ID;如果未应用任何样式,则为 null

路径
Path string

此对象的位置的路径;为新表留空

RowIndex
RowIndex integer

基于 0 的行的索引

TableRowIndex
TableRowIndex integer

要更新的表行的基于 0 的索引

返回

运行“更新表行”命令的结果

替换 PowerPoint PPTX 演示文稿中的字符串

替换 Office PowerPoint 文档(pptx) 中字符串的所有实例

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

MatchCase
MatchCase boolean

如果应匹配大小写,则为 true;对于不区分大小写的匹配,则为 false

MatchString
MatchString string

要替换的要搜索和匹配的字符串

ReplaceString
ReplaceString string

用于将匹配值替换为的字符串

返回

从作输出文件内容

OutputContent
binary

替换 Word DOCX 文档中的字符串

替换 Office Word 文档(docx)中字符串的所有实例

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

MatchCase
MatchCase boolean

如果应匹配大小写,则为 true;对于不区分大小写的匹配,则为 false

MatchString
MatchString string

要替换的要搜索和匹配的字符串

ReplaceString
ReplaceString string

用于将匹配值替换为的字符串

返回

从作输出文件内容

OutputContent
binary

比较两个 Word DOCX

比较两个 Office Word 文档(docx)文件并突出显示差异

参数

名称 密钥 必需 类型 说明
要对该作执行作的第一个输入文件。
inputFile1 True file

要对该作执行作的第一个输入文件。

要执行作的第二个输入文件(可以提供超过 2 个)。
inputFile2 True file

要执行作的第二个输入文件(可以提供超过 2 个)。

返回

从作输出文件内容

OutputContent
binary

筛选,使用 XPath 表达式选择 XML 节点,获取结果

返回筛选的重新筛选,选择具有 XPath 表达式的 XML 文档

参数

名称 密钥 必需 类型 说明
有效的 XML XPath 查询表达式
XPathExpression True string

有效的 XML XPath 查询表达式

要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

使用 XPath 对 XML 输入执行筛选器作的结果

自动检测内容类型并验证

自动检测内容类型,验证并验证内容是否确实在深度完全有效,然后报告验证结果。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

文档验证结果

获取 URL 的屏幕截图

完全呈现网站并返回整页图像的 PNG 屏幕截图。 Javascript、HTML5、CSS 和其他高级功能均受支持。

参数

名称 密钥 必需 类型 说明
ExtraLoadingWait
ExtraLoadingWait integer

可选:在网页完成加载后等待的更多毫秒数,然后再获取屏幕截图。 对于高度异步的网站,非常有用。 为默认值 5000 毫秒(5 秒)提供值 0

屏幕截图
ScreenshotHeight integer

可选:屏幕截图的高度(以像素为单位);提供 0 默认为 1280 x 1024,提供 -1 以测量页面的全屏高度,并尝试获取屏幕高度屏幕截图

ScreenshotWidth
ScreenshotWidth integer

可选:屏幕截图的宽度(以像素为单位);提供 0 默认为 1280 x 1024

网址
Url string

要屏幕截图的网站 URL 地址。 支持 HTTP 和 HTTPS,自定义端口也受支持。

返回

从作输出文件内容

OutputContent
binary

获取 W 中现有表行中现有表行的内容

获取 Word DOCX 文档中现有表格行的内容并返回结果。

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

TablePath
TablePath string

要从中检索行的表的路径

TableRowRowIndex
TableRowRowIndex integer

要检索的行的基于 0 的索引(例如 0、1、2、...)表中

返回

运行“获取表行”命令的结果

获取 Word DOCX 文档中的所有表

返回 Office Word 文档中的所有表对象(docx)

参数

名称 密钥 必需 类型 说明
InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

返回

运行 Get-Tables 命令的结果

获取文档类型信息

自动检测文档的类型信息;不需要文件扩展名。 分析文件内容以确认文件类型。 即使不存在文件扩展名,自动检测系统也会可靠地分析文件的内容并识别其文件类型。 支持 100 多种图像文件格式、Office 文档文件格式、PDF 等。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

自动检测/get-info作的结果

获取有关映像的信息

从图像(如大小、格式和 MIME 类型、压缩、EXIF 数据(如位置、DPI、唯一颜色、透明度信息等)获取详细信息

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

对映像运行 get-info作的结果

设置、更新 Excel XLSX 电子表格中的单元格内容,按 c

设置,使用工作表中的单元格标识符(例如 A1、B22、C33)更新 Excel XLSX 电子表格中特定单元格的内容

参数

名称 密钥 必需 类型 说明
CellIdentifier
CellIdentifier string

要更新的单元格的 Excel 单元格标识符(例如 A1、B2、C33 等)

CellIdentifier
CellIdentifier string

单元格的单元格引用,例如 A1、Z22 等。

Formula
Formula string
路径
Path string

此对象的位置的路径;为新行留空

StyleIndex
StyleIndex integer

要应用于此样式的样式的标识符

TextValue
TextValue string

单元格的文本值

InputFileBytes
InputFileBytes byte

可选:要作的输入文件的字节数

InputFileUrl
InputFileUrl string

可选:要作为输入作的文件的 URL。 这可以是公共 URL,也可以使用开始编辑 API 上传文档,并将该作的安全 URL 结果作为此处的 URL 传递(此 URL 不是公共 URL)。

路径
Path string

此对象的位置的路径;为新工作表留空

WorksheetName
WorksheetName string

工作表选项卡的面向用户的名称

返回

在 XLSX Worksheets 命令中按标识符运行 Set Cell 的结果

设置与 XPath 表达式匹配的 XML 节点的值内容

通过设置与输入 XPath 表达式匹配的所有节点的内容,返回编辑 XML 文档的重新筛选。 支持元素和属性。

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入 XML 文件。
inputFile True file

要针对其执行作的输入 XML 文件。

有效的 XML XPath 查询表达式
XPathExpression True string

有效的 XML XPath 查询表达式

要设置为匹配的 XML 节点的 XML 值
XmlValue True string

要设置为匹配的 XML 节点的 XML 值

返回

使用 XPath 对 XML 输入执行设置值作的结果

验证 Excel 文档 (XLSX)

验证 Excel 文档(XLSX):如果文档无效,则标识文档中的错误

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

文档验证结果

验证 JSON 文件

验证 JSON(JavaScript 对象表示法)文档文件;如果文档无效,则标识文档中的错误

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

文档验证结果

验证 PDF 文档文件

验证 PDF 文档;如果文档无效,则标识文档中的错误

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

文档验证结果

验证 PowerPoint 演示文稿(PPTX)

验证 PowerPoint 演示文稿(PPTX):如果文档无效,则标识文档中的错误

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

文档验证结果

验证 Word 文档 (DOCX)

验证 Word 文档(DOCX):如果文档无效,则标识文档中的错误

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

文档验证结果

验证 XML 文件

验证 XML 文档文件;如果文档无效,则标识文档中的错误

参数

名称 密钥 必需 类型 说明
要针对其执行作的输入文件。
inputFile True file

要针对其执行作的输入文件。

返回

文档验证结果

定义

AlternateFileFormatCandidate

备用文件格式的可能性

名称 路径 类型 说明
DetectedFileExtension
DetectedFileExtension string

检测到文件格式的文件扩展名,前导期

DetectedMimeType
DetectedMimeType string

此文件扩展名的 MIME 类型

概率
Probability double

此扩展是正确的概率;可能的值介于 0.0(最低置信度)和 1.0 之间(最高置信度)

AutodetectDocumentValidationResult

文档验证结果

名称 路径 类型 说明
DocumentIsValid
DocumentIsValid boolean

如此 如果文档有效且没有错误,则为 false;否则为 false

ErrorCount
ErrorCount integer

文档中发现的验证错误数

ErrorsAndWarnings
ErrorsAndWarnings array of DocumentValidationError

找到的错误和警告的详细信息

FileFormatExtension
FileFormatExtension string
WarningCount
WarningCount integer

文档中找到的验证警告数

AutodetectGetInfoResult

自动检测/get-info作的结果

名称 路径 类型 说明
AlternateFileTypeCandidates
AlternateFileTypeCandidates array of AlternateFileFormatCandidate

备用文件类型选项及其概率

作者
Author string

文档创建者/作者的用户名(如果可用),如果不可用,则为 null

DateModified
DateModified date-time

上次修改文档的时间戳(如果可用),如果不可用,则为 null

DetectedFileExtension
DetectedFileExtension string

检测到文件格式的文件扩展名,前导期

DetectedMimeType
DetectedMimeType string

此文件扩展名的 MIME 类型

PageCount
PageCount integer

基于页面的文档中的页数;对于演示文稿,这是幻灯片数,对于电子表格,这是工作表数。 如果无法确定页面计数,或者页面计数的概念不适用(例如图像),则包含 0

成功
Successful boolean

如果作成功,则为 True;否则为 false

AutodetectToPngResult

将自动检测到的输入转换为 PNG 数组的结果

名称 路径 类型 说明
PngResultPages
PngResultPages array of ConvertedPngPage

已转换页的数组

成功
Successful boolean

如果作成功,则为 True;否则为 false

ClearXlsxCellResponse

运行 Clear XLSX Cell 命令的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

已编辑的 XLSX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

ConvertedPngPage

单个转换的页面

名称 路径 类型 说明
PageNumber
PageNumber integer

已转换页的页码,从 1 开始

URL
URL string

指向此页面的 PNG 文件的 URL;文件存储在内存中缓存中,将被删除

CreateBlankDocxResponse

创建空白 Word 文档的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

已编辑的 XLSX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

CreateBlankSpreadsheetResponse

创建空白工作表的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

已编辑的 XLSX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

CreateSpreadsheetFromDataResponse

从行和单元格创建新工作表的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

已编辑的 XLSX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

DeleteDocxTableRowRangeResponse

运行“删除表行范围”命令的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

编辑的 DOCX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

DeleteDocxTableRowResponse

运行“删除表行”命令的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

编辑的 DOCX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

DocumentValidationError

文档中发现的验证错误

名称 路径 类型 说明
Description
Description string

错误说明

IsError
IsError boolean

如果这是错误,则为 True;否则为 false

路径
Path string

XPath 到错误

Uri
Uri string

有关部件的 URI

DocumentValidationResult

文档验证结果

名称 路径 类型 说明
DocumentIsValid
DocumentIsValid boolean

如此 如果文档有效且没有错误,则为 false;否则为 false

ErrorCount
ErrorCount integer

文档中发现的验证错误数

ErrorsAndWarnings
ErrorsAndWarnings array of DocumentValidationError

找到的错误和警告的详细信息

WarningCount
WarningCount integer

文档中找到的验证警告数

DocxBody

名称 路径 类型 说明
AllParagraphs
AllParagraphs array of DocxParagraph

文档的任意位置的所有段落;这些对象不是按顺序放置的,而是跨文档进行划定

AllTables
AllTables array of DocxTable

文档中的任何位置的所有表;这些对象不是按顺序放置的,而是在文档中被划定

路径
Path string

此对象的位置的路径;为新表留空

DocxCellStyle

Excel 电子表格中的样式

名称 路径 类型 说明
BuiltInID
BuiltInID integer

单元格样式的 Built=in ID

FormatID
FormatID integer

单元格样式的格式 ID

Name
Name string

样式的名称

路径
Path string

此对象的位置的路径;为新行留空

DocxComment

Word 文档中的批注

名称 路径 类型 说明
作者
Author string

批注的作者名称

AuthorInitials
AuthorInitials string

批注作者的缩写

CommentDate
CommentDate date-time

批注的日期时间戳

CommentText
CommentText string

批注的文本内容

完成
Done boolean

如此 如果此注释在 Word 中标记为“完成”,否则为 false

IsReply
IsReply boolean

如此 如果此批注是另一个批注的回复,则为 false;否则为 false

IsTopLevel
IsTopLevel boolean

如此 如果批注位于顶层,则为 false(如果此批注是另一个批注的子答复)

ParentCommentPath
ParentCommentPath string

此批注的父级路径(如果此批注是答复),否则此值将为 null

路径
Path string

文档中批注的路径

DocxFooter

Word 文档中的页脚 (DOCX)

名称 路径 类型 说明
Paragraphs
Paragraphs array of DocxParagraph

此页脚中的段落

路径
Path string

此对象的位置的路径;为新表留空

SectionsWithFooter
SectionsWithFooter array of DocxSection

页脚应用于的分区

DocxHeader

Word 文档的标题(DOCX)

名称 路径 类型 说明
Paragraphs
Paragraphs array of DocxParagraph

此标头中的段落

路径
Path string

此对象的位置的路径;为新表留空

SectionsWithHeader
SectionsWithHeader array of DocxSection

标头应用于的节

DocxImage

名称 路径 类型 说明
ImageContentsURL
ImageContentsURL string

图像内容的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取内容。

ImageDataContentType
ImageDataContentType string

只读;图像数据 MIME 内容类型

ImageDataEmbedId
ImageDataEmbedId string

只读;图像内容的内部 ID

ImageDescription
ImageDescription string

图像的说明

ImageHeight
ImageHeight integer

EMU 中图像的高度(英语指标单位):设置为 0,默认为页面宽度和基于纵横比的高度

ImageId
ImageId integer

图像的 ID

ImageInternalFileName
ImageInternalFileName string

只读;映像的内部文件名/路径

图像名称
ImageName string

图像的名称

ImageWidth
ImageWidth integer

EMU 中图像的宽度(英语指标单位):设置为 0,默认为页面宽度和基于纵横比的高度

InlineWithText
InlineWithText boolean

如果图像与文本内联,则为 True;如果它浮动,则为 false

路径
Path string

此对象的位置的路径;为新表留空

XOffset
XOffset integer

图像的 X(水平)偏移量

YOffset
YOffset integer

图像的 Y(垂直)偏移量

DocxInsertImageResponse

运行 set-footer 命令的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

编辑的 DOCX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

DocxPage

Word 文档 DOCX 中的一页

名称 路径 类型 说明
PageNumber
PageNumber integer

此页面的页码(基于 1)

Paragraphs
Paragraphs array of DocxParagraph

文档的任意位置的所有段落;这些对象不是按顺序放置的,而是跨文档进行划定

DocxParagraph

Word 文档 (DOCX) 文件中的段落;存在文本、内容和格式存储的位置 - 类似于 HTML 中的段落标记

名称 路径 类型 说明
ContentRuns
ContentRuns array of DocxRun

内容在段落中运行 - 这是存储文本的位置;类似于 HTML 中的范围

ParagraphIndex
ParagraphIndex integer

段落的索引;基于 0

路径
Path string

此对象的位置的路径;为新表留空

StyleID
StyleID string

应用于段落的样式的样式 ID;如果未应用任何样式,则为 null

DocxRemoveObjectResponse

运行 Remove-Object 命令的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

编辑的 DOCX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

DocxRun

在 Word 文档 (DOCX) 文件中运行的内容

名称 路径 类型 说明
Bold
Bold boolean

如此 使文本加粗,否则为 false

FontFamily
FontFamily string

文本的字体系列名称,例如“Arial”或“Times New Roman”

FontSize
FontSize string

字号(例如“24”)

斜体
Italic boolean

如此 使文本斜体,否则为 false

路径
Path string

此对象的位置的路径;为新表留空

RunIndex
RunIndex integer

基于 0 的运行索引

TextItems
TextItems array of DocxText

运行中的文本项;这是存储实际文本内容的位置

下划线
Underline string

文本的下划线模式;可能的值包括:Words、Double、Thick、Dotted、DottedHeavy、Dash、Dash、DashedHeavy、DashLong、DashLongHeavy、DotDash、DashDotHeavy、DotDotDash、DashDotDotHeavy、Wave、WavyHeavy、WavyDouble、None

DocxSection

Word 文档(DOCX)的一部分

名称 路径 类型 说明
路径
Path string

此对象的位置的路径;为新表留空

StartingPageNumbers
StartingPageNumbers array of integer

节开头的页码,通常只有一个

DocxSetFooterResponse

运行 set-footer 命令的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

编辑的 DOCX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

DocxSetHeaderResponse

运行 set-header 命令的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

编辑的 DOCX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

DocxStyle

DOCX Word 文档中的样式

名称 路径 类型 说明
Bold
Bold boolean

样式应用粗体格式

FontFamily
FontFamily string

字体系列

FontSize
FontSize string

字号

斜体
Italic boolean

样式应用斜体格式

路径
Path string

此对象的位置的路径;为新表留空

StyleID
StyleID string

样式的 ID

下划线
Underline boolean

样式应用下划线格式

DocxTable

Word 文档 (DOCX) 文件中的表格

名称 路径 类型 说明
BottomBorderColor
BottomBorderColor string

HTML 样式的颜色十六进制值(不包括 #)

BottomBorderSize
BottomBorderSize integer

边框宽度(1/72 英寸)

BottomBorderSpace
BottomBorderSpace integer

边框周围间距(1/72 英寸)

BottomBorderType
BottomBorderType string

底部边框的类型 - 可以是 Single、DashDotStroked、Dashed、DashSmallGap、DotDash、DotDotDash、Dotted、Double、DoubleWave、Inset、 Nil、None、Outset、Thick、ThickThinLargeGap、ThickThinMediumGap、ThickThinSmallGap、ThinThickLargeGap、ThinThickMediumGap、ThinThickSmallGap、ThinThickThinMediumGap、ThinThickThinMediumGap、ThreeDEmboss、ThreeDEngrave、Triple、Wave

CellHorizontalBorderColor
CellHorizontalBorderColor string

HTML 样式的颜色十六进制值(不包括 #)

CellHorizontalBorderSize
CellHorizontalBorderSize integer

边框宽度(1/72 英寸)

CellHorizontalBorderSpace
CellHorizontalBorderSpace integer

边框周围间距(1/72 英寸)

CellHorizontalBorderType
CellHorizontalBorderType string

单元格水平边框的类型 - 可以是单个、DashDotStroked、Dashed、DashSmallGap、DotDash、DotDotDash、DotDotDash、Dotted、Double、DoubleWave、Inset、 Nil、None、Outset、Thick、ThickThinLargeGap、ThickThinMediumGap、ThickThinSmallGap、ThinThickLargeGap、ThinThickMediumGap、ThinThickSmallGap、ThinThickThinMediumGap、ThinThickThinMediumGap、ThreeDEmboss、ThreeDEngrave、Triple、Wave

CellVerticalBorderColor
CellVerticalBorderColor string

HTML 样式的颜色十六进制值(不包括 #)

CellVerticalBorderSize
CellVerticalBorderSize integer

边框宽度(1/72 英寸)

CellVerticalBorderSpace
CellVerticalBorderSpace integer

边框周围间距(1/72 英寸)

CellVerticalBorderType
CellVerticalBorderType string

单元格垂直边框的类型 - 可以是 Single、DashDotStroked、Dashed、DashSmallGap、DotDash、DotDotDash、Dotted、Double、DoubleWave、Inset、 Nil、None、Outset、Thick、ThickThinLargeGap、ThickThinMediumGap、ThickThinSmallGap、ThinThickLargeGap、ThinThickMediumGap、ThinThickSmallGap、ThinThickThinMediumGap、ThinThickThinMediumGap、ThreeDEmboss、ThreeDEngrave、Triple、Wave

EndBorderColor
EndBorderColor string

HTML 样式的颜色十六进制值(不包括 #)

EndBorderSize
EndBorderSize integer

边框宽度(1/72 英寸)

EndBorderSpace
EndBorderSpace integer

边框周围间距(1/72 英寸)

EndBorderType
EndBorderType string

结束边框的类型 - 可以是 Single、DashDotStroked、Dashed、DashSmallGap、DotDash、DotDotDash、Dotted、Double、DoubleWave、Inset、 Nil、None、Outset、Thick、ThickThinLargeGap、ThickThinMediumGap、ThickThinSmallGap、ThinThickLargeGap、ThinThickMediumGap、ThinThickSmallGap、ThinThickThinMediumGap、ThinThickThinMediumGap、ThreeDEmboss、ThreeDEngrave、Triple、Wave

LeftBorderColor
LeftBorderColor string

HTML 样式的颜色十六进制值(不包括 #)

LeftBorderSize
LeftBorderSize integer

边框宽度(1/72 英寸)

LeftBorderSpace
LeftBorderSpace integer

边框周围间距(1/72 英寸)

LeftBorderType
LeftBorderType string

左边框的类型 - 可以是 Single、DashDotStroked、Dashed、DashSmallGap、DotDash、DotDotDash、Dotted、Double、DoubleWave、Inset、 Nil、None、Outset、Thick、ThickThinLargeGap、ThickThinMediumGap、ThickThinSmallGap、ThinThickLargeGap、ThinThickMediumGap、ThinThickSmallGap、ThinThickThinMediumGap、ThinThickThinMediumGap、ThreeDEmboss、ThreeDEngrave、Triple、Wave

路径
Path string

此表对象的位置的路径;为新表留空

RightBorderColor
RightBorderColor string

HTML 样式的颜色十六进制值(不包括 #)

RightBorderSize
RightBorderSize integer

边框宽度(1/72 英寸)

RightBorderSpace
RightBorderSpace integer

边框周围间距(1/72 英寸)

RightBorderType
RightBorderType string

右边框的类型 - 可以是 Single、DashDotStroked、Dashed、DashSmallGap、DotDash、DotDotDash、Dotted、Double、DoubleWave、Inset、 Nil、None、Outset、Thick、ThickThinLargeGap、ThickThinMediumGap、ThickThinSmallGap、ThinThickLargeGap、ThinThickMediumGap、ThinThickSmallGap、ThinThickThinMediumGap、ThinThickThinMediumGap、ThreeDEmboss、ThreeDEngrave、Triple、Wave

StartBorderColor
StartBorderColor string

HTML 样式的颜色十六进制值(不包括 #)

StartBorderSize
StartBorderSize integer

边框宽度(1/72 英寸)

StartBorderSpace
StartBorderSpace integer

边框周围间距(1/72 英寸)

StartBorderType
StartBorderType string

开始边框的类型 - 可以是 Single、DashDotStroked、Dashed、DashSmallGap、DotDash、DotDotDash、Dotted、Double、DoubleWave、Inset、 Nil、None、Outset、Thick、ThickThinLargeGap、ThickThinMediumGap、ThickThinSmallGap、ThinThickLargeGap、ThinThickMediumGap、ThinThickSmallGap、ThinThickThinMediumGap、ThinThickThinMediumGap、ThreeDEmboss、ThreeDEngrave、Triple、Wave

TableID
TableID string

表的 ID;为新表留空

TableIndentationMode
TableIndentationMode string

表缩进类型

TableIndentationWidth
TableIndentationWidth integer

表格缩进宽度

TableRows
TableRows array of DocxTableRow

表中的行;这是内容所在的位置

TopBorderColor
TopBorderColor string

HTML 样式的颜色十六进制值(不包括 #)

TopBorderSize
TopBorderSize integer

边框宽度(1/72 英寸)

TopBorderSpace
TopBorderSpace integer

边框周围间距(1/72 英寸)

TopBorderType
TopBorderType string

上边框的类型 - 可以是 Single、DashDotStroked、Dashed、DashSmallGap、DotDash、DotDotDash、Dotted、Double、DoubleWave、Inset、 Nil、None、Outset、Thick、ThickThinLargeGap、ThickThinMediumGap、ThickThinSmallGap、ThinThickLargeGap、ThinThickMediumGap、ThinThickSmallGap、ThinThickThinMediumGap、ThinThickThinMediumGap、ThreeDEmboss、ThreeDEngrave、Triple、Wave

宽度
Width string

表的宽度,如果未指定,则为 0

WidthType
WidthType string

表的 Width 配置类型

DocxTableCell

Word 文档 (DOCX) 文件中的单元格

名称 路径 类型 说明
CellIndex
CellIndex integer

基于 0 的单元格的索引

CellShadingColor
CellShadingColor string

单元格底纹的颜色

CellShadingFill
CellShadingFill string

单元格底纹填充

CellShadingPattern
CellShadingPattern string

单元格底纹的图案

CellWidth
CellWidth string

单元格的宽度

CellWidthMode
CellWidthMode string

单元格的宽度模式;可以是自动(自动)或手动

Paragraphs
Paragraphs array of DocxParagraph

单元格内的段落;这是存储单元格内容的位置

路径
Path string

此对象的位置的路径;为新表留空

DocxTableRow

Word 文档 (DOCX) 文件中的行

名称 路径 类型 说明
路径
Path string

此表行对象的位置的路径;为新表留空

RowCells
RowCells array of DocxTableCell

行中的单元格;这是存储行内容的位置

RowIndex
RowIndex integer

基于 0 的行的索引

DocxText

Word 文档 (DOCX) 文件中的文本内容的单位

名称 路径 类型 说明
路径
Path string

此对象的位置的路径;为新表留空

TextContent
TextContent string

包含此文本内容项的文本内容的文本字符串

TextIndex
TextIndex integer

运行中文本内容的索引;基于 0

DocxTopLevelComment

Word 文档中的顶级批注

名称 路径 类型 说明
作者
Author string

批注的作者名称

AuthorInitials
AuthorInitials string

批注作者的缩写

CommentDate
CommentDate date-time

批注的日期时间戳

CommentText
CommentText string

批注的文本内容

完成
Done boolean

如此 如果此注释在 Word 中标记为“完成”,否则为 false

路径
Path string

文档中批注的路径

ReplyChildComments
ReplyChildComments array of DocxComment

子批注,即对此批注进行答复

ExifValue

EXIF 标记和值

名称 路径 类型 说明
数据类型
DataType string

EXIF 值的日期类型

DataValue
DataValue string

值,格式为 EXIF 值的字符串

标记
Tag string

EXIF 值的标记名称

GetDocxBodyResponse

运行 Get-Body 命令的结果

名称 路径 类型 说明
Body
Body DocxBody
成功
Successful boolean

如果成功,则为 True;否则为 false

GetDocxCommentsHierarchicalResponse

从 Word 文档 DOCX 分层获取注释的结果

名称 路径 类型 说明
注释
Comments array of DocxTopLevelComment

文档中的注释

成功
Successful boolean

如果成功,则为 True;否则为 false

TopLevelCommentCount
TopLevelCommentCount integer

文档中的批注数

GetDocxHeadersAndFootersResponse

运行 Get-Tables 命令的结果

名称 路径 类型 说明
页脚
Footers array of DocxFooter
Headers
Headers array of DocxHeader
成功
Successful boolean

如果成功,则为 True;否则为 false

GetDocxImagesResponse

运行 Get-Images 命令的结果

名称 路径 类型 说明
映像
Images array of DocxImage

DOCX 文档中的图像

成功
Successful boolean

如果成功,则为 True;否则为 false

GetDocxPagesResponse

从 Word 文档 DOCX 获取页面的结果

名称 路径 类型 说明
PageCount
PageCount integer

页计数

页面
Pages array of DocxPage

文档中的页面

成功
Successful boolean

如果成功,则为 True;否则为 false

GetDocxSectionsResponse

运行 Get-Sections 命令的结果

名称 路径 类型 说明
章节
Sections array of DocxSection

DOCX 文档中的节

成功
Successful boolean

如果成功,则为 True;否则为 false

GetDocxStylesResponse

运行 Get-Tables 命令的结果

名称 路径 类型 说明
风格
Styles array of DocxStyle

DOCX 文档中的样式

成功
Successful boolean

如果成功,则为 True;否则为 false

GetDocxTableByIndexResponse

按 Index 命令运行 Get-Tables 的结果

名称 路径 类型 说明
成功
Successful boolean

如果成功,则为 True;否则为 false

Table
Table DocxTable

Word 文档 (DOCX) 文件中的表格

GetDocxTableRowResponse

运行“获取表行”命令的结果

名称 路径 类型 说明
RowResult
RowResult DocxTableRow

Word 文档 (DOCX) 文件中的行

成功
Successful boolean

如果成功,则为 True;否则为 false

GetDocxTablesResponse

运行 Get-Tables 命令的结果

名称 路径 类型 说明
成功
Successful boolean

如果成功,则为 True;否则为 false

Tables
Tables array of DocxTable

DOCX 文件中的表

GetImageInfoResult

对映像运行 get-info作的结果

名称 路径 类型 说明
BitDepth
BitDepth integer

图像的位深度

ColorCount
ColorCount integer

图像中的唯一颜色

ColorSpace
ColorSpace string

图像的颜色空间

ColorType
ColorType string

图像的颜色类型

注释
Comment string

图像中的注释字符串

CompressionLevel
CompressionLevel integer

压缩级别值从 0(最低质量)到 100(最高质量)

DPI
DPI double

DPI(单位像素,例如每英寸像素)的图像

DPIUnit
DPIUnit string

DPI 度量单位;可以是英寸或厘米

ExifProfileName
ExifProfileName string

使用的 EXIF 配置文件的名称

ExifValues
ExifValues array of ExifValue

图像中嵌入的 EXIF 标记和值

HasTransparency
HasTransparency boolean

如果图像包含透明度,则为 True,否则为 false

高度
Height integer

图像的高度(以像素为单位)

ImageFormat
ImageFormat string

图像格式

ImageHashSignature
ImageHashSignature string

映像的 SHA256 哈希签名

哑剧类型
MimeType string

图像格式的 MIME 类型

成功
Successful boolean
宽度
Width integer

图像的宽度(以像素为单位)

GetXlsxCellByIdentifierResponse

运行 Get-Cell 命令的结果

名称 路径 类型 说明
Cell
Cell XlsxSpreadsheetCell

Excel 电子表格工作表中的单元格

成功
Successful boolean

如果成功,则为 True;否则为 false

GetXlsxCellResponse

运行 Get-Cell 命令的结果

名称 路径 类型 说明
Cell
Cell XlsxSpreadsheetCell

Excel 电子表格工作表中的单元格

成功
Successful boolean

如果成功,则为 True;否则为 false

GetXlsxColumnsResponse

运行 Get-Columns 命令的结果

名称 路径 类型 说明
Columns array of XlsxSpreadsheetColumn

XLSX 文档中的电子表格列

成功
Successful boolean

如果成功,则为 True;否则为 false

GetXlsxImagesResponse

运行 Get-Images 命令的结果

名称 路径 类型 说明
映像
Images array of XlsxImage

XLSX 文档中的电子表格图像

成功
Successful boolean

如果成功,则为 True;否则为 false

GetXlsxRowsAndCellsResponse

运行 Get-Worksheets 命令的结果

名称 路径 类型 说明
Rows
Rows array of XlsxSpreadsheetRow

Excel XLSX 文档中的电子表格行

成功
Successful boolean

如果成功,则为 True;否则为 false

GetXlsxStylesResponse

运行 Get-Worksheets 命令的结果

名称 路径 类型 说明
CellStyles
CellStyles array of DocxCellStyle

单元格样式

成功
Successful boolean

如果成功,则为 True;否则为 false

GetXlsxWorksheetsResponse

运行 Get-Worksheets 命令的结果

名称 路径 类型 说明
成功
Successful boolean

如果成功,则为 True;否则为 false

工作表
Worksheets array of XlsxWorksheet

Excel XLSX 电子表格中的工作表

HtmlMdResult

将 Markdown 文件转换为 HTML 的结果

名称 路径 类型 说明
Html
Html string

转换生成的 HTML

成功
Successful boolean

如果作成功,则为 True;否则为 false

HtmlTemplateApplicationResponse

来自 HTML 模板应用程序的响应

名称 路径 类型 说明
FinalHtml
FinalHtml string

输入上所有作的最终 HTML 结果

成功
Successful boolean

如果作成功,则为 True;否则为 false

HtmlToTextResponse

运行 HTML 到文本作的结果

名称 路径 类型 说明
成功
Successful boolean

如果成功,则为 True;否则为 false

TextContentResult
TextContentResult string

HTML 输入中的文本内容结果

InsertDocxCommentOnParagraphResponse

运行 Insert-Comment-on-Paragraph 命令的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

编辑的 DOCX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

InsertDocxInsertParagraphResponse

运行 Insert-Paragraph 命令的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

编辑的 DOCX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

InsertDocxTableRowResponse

运行 Insert-Table Row 命令的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

编辑的 DOCX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

InsertDocxTablesResponse

运行 Insert-Tables 命令的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

编辑的 DOCX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

InsertXlsxWorksheetResponse

运行 Get-Worksheets 命令的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

已编辑的 XLSX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

MultipageImageFormatConversionResult

将多页图像转换为具有不同格式的单个页面的结果

名称 路径 类型 说明
PageCount
PageCount integer

转换后的输出中的页数

页面
Pages array of PageConversionResult

已转换的页面结果

成功
Successful boolean

如果成功,则为 True;否则为 false

PageConversionResult

已转换为图像的页面

名称 路径 类型 说明
FileBytes
FileBytes byte

已转换文件格式的图像的文件字节(内容)

Filename
Filename string

转换后的文件格式的图像的文件名

PdfDocument

与原始文档中的一页对应的单个 PDF 文件

名称 路径 类型 说明
DocumentContents
DocumentContents byte

如果 returnDocumentContents 设置为 true,则包含文档的内容;否则将设置为 null,并且文档内容将通过 URL 参数提供

PageNumber
PageNumber integer

已转换页的页码,从第一页的 1 开始

URL
URL string

此工作表的 PDF 文件的 URL;文件存储在内存中缓存中,将被删除

PdfToPngResult

将 PDF 转换为 PNG 数组的结果

名称 路径 类型 说明
PngResultPages
PngResultPages array of ConvertedPngPage

已转换页的数组

成功
Successful boolean

如果作成功,则为 True;否则为 false

PresentationResult

与原始电子表格中的一个工作表(选项卡)对应的单个 Excel XLSX 文件

名称 路径 类型 说明
PresentationContents
PresentationContents byte

演示文稿的内容(以字节为单位)

SlideNumber
SlideNumber integer

已转换页的工作表编号,从最左侧工作表的 1 开始

URL
URL string

此幻灯片的 PPTX 文件的 URL;文件存储在内存中缓存中,将被删除

RemoveDocxHeadersAndFootersResponse

运行 Remove Headers 和 Footers 命令的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

生成的已编辑文档的 URL;这是一个安全的 URL,如果不添加 Apikey 标头,则无法下载;它也是临时的,存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

SetXlsxCellByIdentifierResponse

在 XLSX Worksheets 命令中按标识符运行 Set Cell 的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

已编辑的 XLSX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

SetXlsxCellResponse

在 XLSX Worksheets 命令中运行 Set Cell 的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

已编辑的 XLSX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

SplitDocumentResult

与原始文档中的一页对应的单个 Word DOCX 文件

名称 路径 类型 说明
DocumentContents
DocumentContents byte

文档的内容(以字节为单位)

PageNumber
PageNumber integer

已转换页的页码,从第一页的 1 开始

URL
URL string

此幻灯片的 DOCX 文件的 URL;文件存储在内存中缓存中,将被删除

SplitDocxDocumentResult

将 Word 文档拆分为单个 Word DOCX 页面的结果

名称 路径 类型 说明
ResultDocuments
ResultDocuments array of SplitDocumentResult
成功
Successful boolean

如果作成功,则为 True;否则为 false

SplitPdfResult

执行 PDF 文件拆分作的结果

名称 路径 类型 说明
文档
Documents array of PdfDocument

PDF 文档作为输出

成功
Successful boolean

如果作成功,则为 True;否则为 false

SplitPptxPresentationResult

将演示文稿拆分为单个 PowerPoint PPTX 幻灯片的结果

名称 路径 类型 说明
ResultPresentations
ResultPresentations array of PresentationResult
成功
Successful boolean

如果作成功,则为 True;否则为 false

SplitTextDocumentByLinesResult

将文本文档拆分为单独的行的结果

名称 路径 类型 说明
LineCount
LineCount integer

文本文件中的行计数

ResultLines
ResultLines array of TextDocumentLine
成功
Successful boolean

如果作成功,则为 True;否则为 false

SplitTextDocumentByStringResult

将文本文档拆分为单独的元素的结果

名称 路径 类型 说明
ElementCount
ElementCount integer

文本文件中的元素计数

ResultElements
ResultElements array of TextDocumentElement
成功
Successful boolean

如果作成功,则为 True;否则为 false

SplitXlsxWorksheetResult

将电子表格拆分为单个 Excel XLSX 工作表的结果

名称 路径 类型 说明
ResultWorksheets
ResultWorksheets array of WorksheetResult
成功
Successful boolean

如果作成功,则为 True;否则为 false

TextConversionResult

将文档转换为纯文本格式的文本转换结果

名称 路径 类型 说明
成功
Successful boolean

如果作成功,则为 True;否则为 false

TextResult
TextResult string

输入文档的纯文本(TXT)格式转换结果。 文本结果以字符串的形式返回。

TextDocumentElement

文本文档的单个元素

名称 路径 类型 说明
ElementContents
ElementContents string

文本文件的单个元素的文本内容

ElementNumber
ElementNumber integer

元素的基于 1 的行索引

TextDocumentLine

文本文档的单个行

名称 路径 类型 说明
LineContents
LineContents string

文本文件的单个行的文本内容

LineNumber
LineNumber integer

行的基于 1 的行索引

UpdateDocxTableCellResponse

运行 Update Table Cell 命令的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

编辑的 DOCX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

UpdateDocxTableRowResponse

运行“更新表行”命令的结果

名称 路径 类型 说明
EditedDocumentURL
EditedDocumentURL string

编辑的 DOCX 文件的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取结果文档内容。

成功
Successful boolean

如果成功,则为 True;否则为 false

UrlToTextResponse

运行 URL 网站到文本作的结果

名称 路径 类型 说明
成功
Successful boolean

如果成功,则为 True;否则为 false

TextContentResult
TextContentResult string

URL 网站输入中的文本内容结果

WorksheetResult

与原始电子表格中的一个工作表(选项卡)对应的单个 Excel XLSX 文件

名称 路径 类型 说明
URL
URL string

此工作表的 XLSX 文件的 URL;文件存储在内存中缓存中,将被删除

WorksheetContents
WorksheetContents byte

工作表的内容(以字节为单位)

WorksheetName
WorksheetName string

工作表的名称

WorksheetNumber
WorksheetNumber integer

已转换页的工作表编号,从最左侧工作表的 1 开始

XlsxImage

名称 路径 类型 说明
ImageContentsURL
ImageContentsURL string

图像内容的 URL;文件存储在内存中缓存中,将被删除。 调用 Finish-Editing 以获取内容。

ImageDataContentType
ImageDataContentType string

只读;图像数据 MIME 内容类型

ImageDataEmbedId
ImageDataEmbedId string

只读;图像内容的内部 ID

ImageInternalFileName
ImageInternalFileName string

只读;映像的内部文件名/路径

路径
Path string

此对象的位置的路径;为新行留空

XlsxSpreadsheetCell

Excel 电子表格工作表中的单元格

名称 路径 类型 说明
CellIdentifier
CellIdentifier string

单元格的单元格引用,例如 A1、Z22 等。

Formula
Formula string
路径
Path string

此对象的位置的路径;为新行留空

StyleIndex
StyleIndex integer

要应用于此样式的样式的标识符

TextValue
TextValue string

单元格的文本值

XlsxSpreadsheetColumn

Excel 电子表格工作表中的列

名称 路径 类型 说明
HeadingCell
HeadingCell XlsxSpreadsheetCell

Excel 电子表格工作表中的单元格

路径
Path string

此对象的位置的路径;为新行留空

XlsxSpreadsheetRow

Excel 电子表格工作表中的行

名称 路径 类型 说明
细胞
Cells array of XlsxSpreadsheetCell

电子表格行中的电子表格单元格

路径
Path string

此对象的位置的路径;为新行留空

XlsxWorksheet

Excel (XLSX) 电子表格中的工作表(选项卡)

名称 路径 类型 说明
路径
Path string

此对象的位置的路径;为新工作表留空

WorksheetName
WorksheetName string

工作表选项卡的面向用户的名称

XmlAddAttributeWithXPathResult

使用 XPath 对 XML 输入执行添加属性节点作的结果

名称 路径 类型 说明
NodesEditedCount
NodesEditedCount integer

匹配结果的计数

ResultingXmlDocument
ResultingXmlDocument string

生成的已修改 XML 文档

成功
Successful boolean

如果作成功,则为 True;否则为 false

XmlAddChildWithXPathResult

使用 XPath 对 XML 输入执行添加子节点作的结果

名称 路径 类型 说明
NodesEditedCount
NodesEditedCount integer

匹配结果的计数

ResultingXmlDocument
ResultingXmlDocument string

生成的已修改 XML 文档

成功
Successful boolean

如果作成功,则为 True;否则为 false

XmlFilterWithXPathResult

使用 XPath 对 XML 输入执行筛选器作的结果

名称 路径 类型 说明
ResultCount
ResultCount integer

匹配结果的计数

成功
Successful boolean

如果作成功,则为 True;否则为 false

XmlNodes
XmlNodes array of string

匹配所选 XML 节点作为字符串

XmlQueryWithXQueryMultiResult

对多个 XML 文档执行 XQuery作的结果。

名称 路径 类型 说明
错误消息
ErrorMessage string

如果发生错误,则错误的其他详细信息

ResultingXml
ResultingXml string

生成的 XML 结果输出

成功
Successful boolean

如果作成功,则为 True;否则为 false

XmlQueryWithXQueryResult

对 XML 文档执行 XQuery作的结果。

名称 路径 类型 说明
错误消息
ErrorMessage string

如果发生错误,则错误的其他详细信息

ResultingXml
ResultingXml string

生成的 XML 结果输出

成功
Successful boolean

如果作成功,则为 True;否则为 false

XmlRemoveAllChildrenWithXPathResult

使用 XPath 对 XML 输入执行删除所有子节点作的结果

名称 路径 类型 说明
NodesEditedCount
NodesEditedCount integer

匹配结果的计数

ResultingXmlDocument
ResultingXmlDocument string

生成的已修改 XML 文档

成功
Successful boolean

如果作成功,则为 True;否则为 false

XmlRemoveWithXPathResult

使用 XPath 对 XML 输入执行筛选器作的结果

名称 路径 类型 说明
NodesRemovedCount
NodesRemovedCount integer

匹配结果的计数

ResultingXmlDocument
ResultingXmlDocument string

生成的已修改 XML 文档,其中删除了匹配的节点作为字符串

成功
Successful boolean

如果作成功,则为 True;否则为 false

XmlNodesRemoved
XmlNodesRemoved array of string

匹配所选 XML 节点作为字符串

XmlReplaceWithXPathResult

使用 XPath 对 XML 输入执行替换节点作的结果

名称 路径 类型 说明
NodesEditedCount
NodesEditedCount integer

匹配结果的计数

ResultingXmlDocument
ResultingXmlDocument string

生成的已修改 XML 文档

成功
Successful boolean

如果作成功,则为 True;否则为 false

XmlSetValueWithXPathResult

使用 XPath 对 XML 输入执行设置值作的结果

名称 路径 类型 说明
NodesEditedCount
NodesEditedCount integer

匹配结果的计数

ResultingXmlDocument
ResultingXmlDocument string

生成的已修改 XML 文档

成功
Successful boolean

如果作成功,则为 True;否则为 false

字符串

这是基本数据类型“string”。

二进制

这是基本数据类型“binary”。

对象

这是类型“object”。

字节

这是基本数据类型“字节”。