Word.InlinePicture class

指定表示与内联图像关联的可选文本的字符串。

altTextDescription: string;

属性值

注解

[ API 集：WordApi 1.1 ]

指定包含内联图像标题的字符串。

altTextTitle: string;

属性值

注解

[ API 集：WordApi 1.1 ]

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

指定描述内联图像高度的数字。

height: number;

属性值

注解

[ API 集：WordApi 1.1 ]

指定图像上的超链接。 使用“#”将地址部分与可选位置部件分开。

hyperlink: string;

属性值

注解

[ API 集：WordApi 1.1 ]

指定一个值，该值指示内联图像在调整大小时是否保留其原始比例。

lockAspectRatio: boolean;

属性值

注解

[ API 集：WordApi 1.1 ]

获取包含嵌入式图像的内容控件。 ItemNotFound如果没有父内容控件，则引发错误。

readonly parentContentControl: Word.ContentControl;

属性值

注解

[ API 集：WordApi 1.1 ]

指定描述内联图像宽度的数字。

width: number;

属性值

注解

[ API 集：WordApi 1.1 ]

获取内联图像的 Base64 编码字符串表示形式。

getBase64ImageSrc(): OfficeExtension.ClientResult<string>;

返回

注解

[ API 集：WordApi 1.1 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/15-images/insert-and-get-pictures.yaml

// Gets the first image in the document.
await Word.run(async (context) => {
  const firstPicture: Word.InlinePicture = context.document.body.inlinePictures.getFirst();
  firstPicture.load("width, height, imageFormat");

  await context.sync();
  console.log(`Image dimensions: ${firstPicture.width} x ${firstPicture.height}`, `Image format: ${firstPicture.imageFormat}`);
  // Get the image encoded as Base64.
  const base64 = firstPicture.getBase64ImageSrc();

  await context.sync();
  console.log(base64.value);
});

使用富文本内容控件封装嵌入式图像。

insertContentControl(): Word.ContentControl;

返回

注解

[ API 集：WordApi 1.1 ]

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Word.Interfaces.InlinePictureLoadOptions): Word.InlinePicture;

参数

返回

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Word.InlinePicture;

参数

返回

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.InlinePicture;

参数

返回

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

set(properties: Interfaces.InlinePictureUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

返回

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Word.InlinePicture): void;

参数

返回

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始Word.InlinePicture对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.InlinePictureData) ，其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Word.Interfaces.InlinePictureData;

返回

根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。

track(): Word.InlinePicture;

返回

释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

untrack(): Word.InlinePicture;

返回