InlineShapes

InlineShapes

JSSDK: 1.3.1、zOffice V6.0 FP1 支持

InlineShape 对象的集合，这些对象代表文档的文字层中的对象。内嵌形状只能是图片、OLE 对象或 ActiveX 控件。（目前仅支持嵌入式图片）

属性

count

返回一个 Long ，该值表示集合中的内嵌图形的数目。 此为只读属性。

语法

Application.ActiveDocument.InlineShapes.count

Application: 文档类型应用对象

返回值

Promise<number>

示例

async function example() {
  const count = await Application.ActiveDocument.InlineShapes.count;
}

方法

addPicture

在文档中添加一幅图片。 返回一个代表该图片的 InlineShape 对象。（默认在当前光标位置添加）

语法

Application.ActiveDocument.InlineShapes.addPicture(file, range, bReplace)

Application: 文档类型应用对象

参数

属性	数据类型	必填	说明
file	File	是	图片的文件对象（限10MB）
range	Word.Range	否	区域位置（默认在当前选区插入）
bReplace	boolean	否	是否替换区域内容（默认false，将图片插入在区域开始位置，不删除区域内容，true表示删除区域内容后插入图片）

返回值

Promise<Word.InlineShape>

示例

<input type="file" name="插入嵌入式图片" id="imageInput"/>

const inputElement = document.getElementById('imageInput');


// sample1，在当前选区插入图片，不替换区域内容
inputElement.onchange = async function() {
  const InlineShapes = await Application.ActiveDocument.InlineShapes;
  const inlineShape = await InlineShapes.addPicture(inputElement.files[0]);
}

// sample2，在当前选区插入图片，替换区域内容
inputElement.onchange = async function() {
  const InlineShapes = await Application.ActiveDocument.InlineShapes;
  const pm = await Application.ActiveDocument.PermMarks.item(1);
  const pmRange = await pm.range;
  const inlineShape = await InlineShapes.addPicture(inputElement.files[0], undefined, true);
}

// sample3，在指定选区插入图片，不替换区域内容
inputElement.onchange = async function() {
  const InlineShapes = await Application.ActiveDocument.InlineShapes;
  const pm = await Application.ActiveDocument.PermMarks.item(1);
  const pmRange = await pm.range;
  const inlineShape = await InlineShapes.addPicture(inputElement.files[0], range);
}

// sample4，在指定区域插入图片，替换区域内容
inputElement.onchange = async function() {
  const InlineShapes = await Application.ActiveDocument.InlineShapes;
  const pm = await Application.ActiveDocument.PermMarks.item(1);
  const pmRange = await pm.range;
  const inlineShape = await InlineShapes.addPicture(inputElement.files[0], range, true);
}

item

返回集合中的单个对象， InlineShape 。

语法

Application.ActiveDocument.InlineShapes.item(key)

Application: 文档类型应用对象

参数

属性	数据类型	必填	说明
key	number	是	InlineShape 在文档中的序号位置（从1开始）

返回值

Promise<Word.InlineShape>

示例

async function example() {
  const InlineShapes = await Application.ActiveDocument.InlineShapes;
  const inlineShape = await InlineShapes.item(1);
}