WebOffice 开放平台

主题

回到顶部
本页内容

嵌入式图形(InlineShapes)

所选内容中的所有嵌入式对象

属性列表

属性说明
Count
嵌入式对象的个数

方法列表

方法说明
AddPicture()
插入嵌入式图片
Item()
获取单个嵌入式图形，返回 InlineShape 对象
Item().Data
异步返回文档里面的图片的 Base64 数据
Item().Height
单个嵌入式图形对象的高度
Item().OLEFormat
返回一个 OLEFormat 对象，该对象表示指定的内嵌形状的 OLE 特征（而不是链接）。此为只读属性
Item().OriginData
异步返回图片 原图 的 Base64 数据
Item().Width
单个嵌入式图形对象的宽度
Item().ConvertToShape()
将嵌入式图形对象转换为非嵌入式图形对象
Item().Delete()
删除嵌入式图形对象
Item().Select()
选中嵌入式图形对象

Count

嵌入式对象的个数

语法

表达式.ActiveDocument.InlineShapes.Count

表达式：文档类型应用对象

示例

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取图形对象
  const shapes = await app.ActiveDocument.InlineShapes

  // 插入嵌入式图片
  await shapes.AddPicture({
    FileName:
      'https://img.qwps.cn/583546003_25a7bc59d95249c2a3c257fa369ca289?imageMogr2/thumbnail/180x180!', //
    LinkToFile: false,
    SaveWithDocument: false
  })

  // 嵌入式对象的个数
  const count = await shapes.Count
  console.log(count)
}

AddPicture()

仅支持PC端

插入嵌入式图片

语法

表达式.ActiveDocument.InlineShapes.AddPicture({ FileName, LinkToFile, SaveWithDocument, Range })

表达式：文档类型应用对象

参数

属性数据类型默认值必填说明
FileName
String
是
图片的路径和文件名
LinkToFile
String
否
为 true 表示要将图片链接到创建它的文件，false 使图片文件的独立副本。默认值为 false
SaveWithDocument
String
否
为 true 要随文档一起保存的链接的图片。默认值为 false
Range
String
否
图片置于文本中的位置

返回值

返回一个 InlineShape 对象

示例

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取图形对象
  const inlineShapes = await app.ActiveDocument.InlineShapes

  // 插入嵌入式图片
  const inlineShape = await inlineShapes.AddPicture({
    FileName:
      'https://img.qwps.cn/583546003_25a7bc59d95249c2a3c257fa369ca289?imageMogr2/thumbnail/180x180!', // 图片路径
    LinkToFile: false,
    SaveWithDocument: false,
    Range: {
      start: 1,
      end: 2
    }
  })

  // 设置嵌入式图形对象的宽度
  inlineShape.Width = 200
}

Item()

获取单个嵌入式图形，返回 InlineShape 对象

语法

表达式.ActiveDocument.InlineShapes.Item(Index)

表达式：文档类型应用对象

参数

属性数据类型默认值必填说明
Index
Number
是
第 Index 个表格

示例

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取所有嵌入式图形
  const InlineShapes = await app.ActiveDocument.InlineShapes

  // 获取单个嵌入式图形，返回第 1 个 InlineShape 对象
  await InlineShapes.Item(1)
}

Item().Data

异步返回文档里面的图片的 Base64 数据

语法

表达式.ActiveDocument.InlineShapes.Item(Index).Data

表达式：文档类型应用对象

示例

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取图形对象
  const shapes = await app.ActiveDocument.InlineShapes

  // 插入嵌入式图片
  await shapes.AddPicture({
    FileName:
      'https://img.qwps.cn/583546003_25a7bc59d95249c2a3c257fa369ca289?imageMogr2/thumbnail/180x180!', // 图片路径
    LinkToFile: false,
    SaveWithDocument: false
  })

  // 获取第 1 个嵌入式图形对象
  const shape = await shapes.Item(1)

  // 异步返回文档里面的图片的 Base64 数据
  const Data = await shape.Data
  console.log(Data)
}

Item().Height

单个嵌入式图形对象的高度

语法

表达式.ActiveDocument.InlineShapes.Item(Index).Height

表达式：文档类型应用对象

示例

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取图形对象
  const shapes = await app.ActiveDocument.InlineShapes

  // 插入嵌入式图片
  await shapes.AddPicture({
    FileName:
      'https://img.qwps.cn/583546003_25a7bc59d95249c2a3c257fa369ca289?imageMogr2/thumbnail/180x180!', // 图片路径
    LinkToFile: false,
    SaveWithDocument: false
  })

  // 获取第 1 个嵌入式图形对象
  const shape = await shapes.Item(1)

  // 设置嵌入式图形对象的高度
  shape.Height = 200
}

Item().OLEFormat

返回一个 OLEFormat 对象，该对象表示指定的内嵌形状的 OLE 特征（而不是链接）。此为只读属性

语法

表达式.ActiveDocument.InlineShapes.Item(Index).OLEFormat

表达式：文档类型应用对象

示例

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取图形对象
  const shapes = await app.ActiveDocument.InlineShapes

  // 插入嵌入式图片
  await shapes.AddPicture({
    FileName:
      'https://img.qwps.cn/583546003_25a7bc59d95249c2a3c257fa369ca289?imageMogr2/thumbnail/180x180!', // 图片路径
    LinkToFile: false,
    SaveWithDocument: false
  })

  // 获取第 1 个嵌入式图形对象
  const shape = await shapes.Item(1)

  // 返回一个 OLEFormat 对象，该对象表示指定的内嵌形状的 OLE 特征（而不是链接）。此为只读属性
  const OLEFormat = await shape.OLEFormat
}

Item().OriginData

异步返回图片 原图 的 Base64 数据

语法

表达式.ActiveDocument.InlineShapes.Item(Index).OriginData

表达式：文档类型应用对象

示例

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取图形对象
  const shapes = await app.ActiveDocument.InlineShapes

  // 插入嵌入式图片
  await shapes.AddPicture({
    FileName:
      'https://img.qwps.cn/583546003_25a7bc59d95249c2a3c257fa369ca289?imageMogr2/thumbnail/180x180!', // 图片路径
    LinkToFile: false,
    SaveWithDocument: false
  })

  // 获取第 1 个嵌入式图形对象
  const shape = await shapes.Item(1)

  // 异步返回图片 原图 的 Base64 数据
  const OriginData = await shape.OriginData
  console.log(OriginData)
}

Item().Width

单个嵌入式图形对象的宽度

语法

表达式.ActiveDocument.InlineShapes.Item(Index).Width

表达式：文档类型应用对象

示例

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取图形对象
  const shapes = await app.ActiveDocument.InlineShapes

  // 插入嵌入式图片
  await shapes.AddPicture({
    FileName:
      'https://img.qwps.cn/583546003_25a7bc59d95249c2a3c257fa369ca289?imageMogr2/thumbnail/180x180!', // 图片路径
    LinkToFile: false,
    SaveWithDocument: false
  })

  // 获取第 1 个嵌入式图形对象
  const shape = await shapes.Item(1)

  // 设置嵌入式图形对象的宽度
  shape.Width = 200
}

Item().ConvertToShape()

将嵌入式图形对象转换为非嵌入式图形对象

语法

表达式.ActiveDocument.InlineShapes.Item(Index).ConvertToShape()

表达式：文档类型应用对象

示例

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取图形对象
  const shapes = await app.ActiveDocument.InlineShapes

  // 插入嵌入式图片
  await shapes.AddPicture({
    FileName:
      'https://img.qwps.cn/583546003_25a7bc59d95249c2a3c257fa369ca289?imageMogr2/thumbnail/180x180!', // 图片路径
    LinkToFile: false,
    SaveWithDocument: false
  })

  // 获取第 1 个嵌入式图形对象
  const shape = await shapes.Item(1)

  // 将嵌入式图形对象转换为非嵌入式图形对象
  await shape.ConvertToShape()
}

Item().Delete()

删除嵌入式图形对象

语法

表达式.ActiveDocument.InlineShapes.Item(Index).Delete()

表达式：文档类型应用对象

示例

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取图形对象
  const shapes = await app.ActiveDocument.InlineShapes

  // 插入嵌入式图片
  await shapes.AddPicture({
    FileName:
      'https://img.qwps.cn/583546003_25a7bc59d95249c2a3c257fa369ca289?imageMogr2/thumbnail/180x180!', // 图片路径
    LinkToFile: false,
    SaveWithDocument: false
  })

  // 获取第 1 个嵌入式图形对象
  const shape = await shapes.Item(1)

  // 删除嵌入式图形对象
  await shape.Delete()
}

Item().Select()

选中嵌入式图形对象

语法

表达式.ActiveDocument.InlineShapes.Item(Index).Select()

表达式：文档类型应用对象

示例

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取图形对象
  const shapes = await app.ActiveDocument.InlineShapes

  // 插入嵌入式图片
  await shapes.AddPicture({
    FileName:
      'https://img.qwps.cn/583546003_25a7bc59d95249c2a3c257fa369ca289?imageMogr2/thumbnail/180x180!', // 图片路径
    LinkToFile: false,
    SaveWithDocument: false
  })

  // 获取第 1 个嵌入式图形对象
  const shape = await shapes.Item(1)

  // 选中嵌入式图形对象
  await shape.Select()
}