Script Lab 09:异步调用函数,PowerPoint基础操作

简介: Script Lab 09:异步调用函数,PowerPoint基础操作


Script Lab 的级初入门教程,到今天就要告一段落了。总结部分,我们来实践一个 PPT 的例子吧。相比 Word 和 Excel 来说,PPT 的 API 的完成度并不高,甚至连启动函数也没有实现(目前有 Excel.run、 Word.run、OneNote.run)。

在 PowerPoint 空间下,仅实现了一个方法,没有像 Excel 或 Word 那样,可以操作的较完整的 API 对象集。


var ppt = PowerPoint.createPresentation();

PPT 目前的主要操作,只能集中在一些 Offie 通用的功能上,依托于 Office 空间下的 context 对象来操作。本次举一个较简单的例子,在 PPT 上插入一个 SVG 的形状,这也是 Script Lab 中自带的一个例子(总共也只有 5个 API 案例)。


【完整代码】

$("#insert").click(newImage);
function newImage() {
  Office.context.document.setSelectedDataAsync(
    getImageAsBase64String(),
    {
      coercionType: Office.CoercionType.XmlSvg,
      imageLeft: 50,
      imageTop: 50,
      imageWidth: 400
    },
    function(asyncResult) {
      if (asyncResult.status === Office.AsyncResultStatus.Failed) {
        console.error(asyncResult.error.message);
      }
    }
  );
}
function getImageAsBase64String() {
  // A production add-in code could get an image from an
  // online source and pass it to a library function that
  // converts to base 64.
  var svg =
'<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="100%" height="100%" viewBox="0 0 100 100">  <title>SVG Logo</title>  <a xlink:href="http://www.w3.org/Graphics/SVG/" target="_parent"     xlink:title="W3C SVG Working Group home page">
...
</g>    </g>  </a></svg>';
  return svg;


image.png


【代码解析】

取得当前页,并插入 SVG 图标(发未选中,则引出发错)

Office.context.document.setSelectedDataAsync(...)

其实这种调用模式,我们在前期的代码中并未出现过,所以借此机会,讨论下这里的要点。Office API 应用程序中异步函数有通用签名格式,Office API 应用程序中的所有异步函数都有相同的命名约定和相同的基本签名。 每个异步函数的名称都以"Async"结尾,以本次调用的函数为例:其实所有的步函数的签名都遵循以下基本模式:

functionNameAsync(
requiredParameters,
[, options], [callback]);


必需参数后面另有两个参数:一个包含可选参数的对象和一个回调函数,两者始终都是可选的。异步函数中的可选参数 异步函数签名中的可选 JavaScript 对象是用分号分隔的键/值对的集合,其中的键是参数名称,值是您想对该参数使用的数据。键/值对的顺序无关紧要,只要参数名称正确即可。

以本次调用为例,setSelectedDataAsync 方法具有 Office 应用程序中所有异步函数通用的相同基本签名:


Office.context.document.setSelectedDataAsync(  data [, options], callback);

Document.set SelectedDataAsync 也有一个选项对象,其中包含可选参数,但其选项对象的参数与该 API 中其他异步函数的参数不同,因为此函数的用途是设置数据。 因此,Document.setSelectedDataAsync 的可选参数与设置数据有关:

  • coercionType:一个指定所插入数据格式(文本、HTML、OOXML、表或矩阵)的 CoercionType 枚举
  • asyncContext:一个用户定义的对象,在作为回调函数唯一参数传递给该函数的 AsyncResult 对象中无变化返回。

AsyncResult 对象在异步函数中的角色 JavaScript API for Office 中异步函数的通用签名中的第三个参数是可选的回调参数。 当运行时调用回调函数时,它会将 Async Result 对象作为回调函数唯一的参数传入。AsyncResult 对象包含有关异步操作的信息,如:操作是否成功;发生了什么错误(如果有);以及异步函数的返回值(如果有)。在返回某种数据或对象的所有异步函数中,AsyncResult 都是可以获得返回值的唯一方式。可以使用 AsyncResult.value 属性实现这一点。



if (asyncResult.status === Office.AsyncResultStatus.Failed) {
        console.error(asyncResult.error.message);

【效果图】image.png

相关文章
|
C++
基于C++的简易计算器设计与实现
基于C++的简易计算器设计与实现
663 3
|
网络协议 网络虚拟化 网络架构
单臂路由实现VLAN间路由
本文介绍了单臂路由实现VLAN间路由的配置方法,包括网络设备的IP配置、交换机的VLAN划分、路由器的子接口配置以及ARP广播的设置,并通过ping测试验证了配置的正确性。
单臂路由实现VLAN间路由
|
SQL 存储 缓存
【MySQL】一文了解MySQL的基础架构及各个组件的作用
不管是开运、运维、测试,都或多或少的要接触MySQL,了解MySQL的基础架构及各个组件之间的关系,有助于我们更加深入的理解MySQL
1121 6
【MySQL】一文了解MySQL的基础架构及各个组件的作用
|
12月前
|
计算机视觉
vs2019_qt6.2.4_dcmtk3.6.7_vtk9.2.2_itk5.3_opencv4.6.0编译记录
这篇文章记录了使用VS2019编译Qt6.2.4、DCMTK3.6.7、VTK9.2.2、ITK5.3和OpenCV4.6.0的过程,包括下载和编译步骤,并提供了遇到编译错误时的解决方案和参考链接。
300 0
vs2019_qt6.2.4_dcmtk3.6.7_vtk9.2.2_itk5.3_opencv4.6.0编译记录
|
11月前
|
机器学习/深度学习 人工智能 自然语言处理
深度学习之生物启发的学习系统
基于深度学习的生物启发学习系统(Biologically Inspired Learning Systems)旨在借鉴生物大脑的结构和学习机制,设计出更高效、更灵活的人工智能系统。
175 0
|
缓存 负载均衡 数据库
优化后端性能:提升Web应用响应速度的关键策略
在当今数字化时代,Web应用的性能对于用户体验至关重要。本文探讨了如何通过优化后端架构和技术手段,提升Web应用的响应速度。从数据库优化、缓存机制到异步处理等多个方面进行了深入分析,并提出了一系列实用的优化策略,以帮助开发者更好地应对日益增长的用户访问量和复杂的业务需求。
758 28
|
存储 JavaScript API
LocalStorage/sessionStorage 封装 - 基于TypeScript
文章主要介绍了如何封装一个自定义 Hooks 形式的存储服务,用于在 localStorage 或者 sessionStorage 中进行持久化存储值。通过封装的方法包括 get、set、remove、clearExcept 和 clearAll,使得操作存储变得更加简单和方便。
351 1
|
算法
MATLAB | 插值算法 | 二维interp2插值法 | 附数据和出图代码 | 直接上手
MATLAB | 插值算法 | 二维interp2插值法 | 附数据和出图代码 | 直接上手
1282 0
|
安全 关系型数据库 MySQL
mysql8和mysql5的安装过程都有!!!超多图超详细保姆级教程最新教程新手小白轻松上手,带你了解清楚你安装过程的每一个术语(二)
mysql8和mysql5的安装过程都有!!!超多图超详细保姆级教程最新教程新手小白轻松上手,带你了解清楚你安装过程的每一个术语
607 0
|
机器学习/深度学习 安全 数据安全/隐私保护
「隐语小课」LDP和CDP在联邦学习中对于隐私性以及鲁棒性的作用
「隐语小课」LDP和CDP在联邦学习中对于隐私性以及鲁棒性的作用
610 0