Word.InlinePicture class

表示嵌入式图片。

扩展

注解

[ 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

// Inserts an image anchored to the last paragraph.
await Word.run(async (context) => {
  context.document.body.paragraphs
    .getLast()
    .insertParagraph("", "After")
    .insertInlinePictureFromBase64(base64Image, "End");

  await context.sync();
});

属性

altTextDescription

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

altTextTitle

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

context

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

height

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

hyperlink

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

lockAspectRatio

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

paragraph

获取包含嵌入式图像的父段落。

parentContentControl

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

parentContentControlOrNullObject

获取包含嵌入式图像的内容控件。 如果没有父内容控件,则此方法将返回其属性设置为 true的对象isNullObject。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentTable

获取包含嵌入式图像的 table。 ItemNotFound如果未包含在表中,则引发错误。

parentTableCell

获取包含嵌入式图像的 tableCell。 ItemNotFound如果表单元格中未包含错误,则引发错误。

parentTableCellOrNullObject

获取包含嵌入式图像的 tableCell。 如果它未包含在表单元格中,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentTableOrNullObject

获取包含嵌入式图像的 table。 如果它未包含在表中,则此方法将返回一个 对象,其 isNullObject 属性设置为 true。 有关详细信息,请参阅 *OrNullObject 方法和属性

width

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

方法

delete()

从文档中删除嵌入式图片。

getBase64ImageSrc()

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

getNext()

获取下一个嵌入式图像。 ItemNotFound如果此内联图像是最后一个图像,则引发错误。

getNextOrNullObject()

获取下一个嵌入式图像。 如果此内联图像是最后一个,则此方法将返回一个对象,其 isNullObject 属性设置为 true。 有关详细信息,请参阅 *OrNullObject 方法和属性

getRange(rangeLocation)

获取图片或图片的起点/终点,作为一个范围。

insertBreak(breakType, insertLocation)

在主文档的指定位置插入分隔符。

insertContentControl()

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

insertFileFromBase64(base64File, insertLocation)

在指定位置插入 document。

insertHtml(html, insertLocation)

在指定位置插入 HTML。

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

在指定位置插入 inlinePicture。

insertOoxml(ooxml, insertLocation)

在指定位置插入 OOXML。

insertParagraph(paragraphText, insertLocation)

在指定位置插入段落。

insertText(text, insertLocation)

在指定位置插入文本。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

select(selectionMode)

选择 inlinePicture。 这会导致 Word 滚动到选定内容。

select(selectionModeString)

选择 inlinePicture。 这会导致 Word 滚动到选定内容。

set(properties, options)

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

set(properties)

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

toJSON()

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

track()

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

untrack()

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

属性详细信息

altTextDescription

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

altTextDescription: string;

属性值

string

注解

[ API 集:WordApi 1.1 ]

altTextTitle

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

altTextTitle: string;

属性值

string

注解

[ API 集:WordApi 1.1 ]

context

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

context: RequestContext;

属性值

height

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

height: number;

属性值

number

注解

[ API 集:WordApi 1.1 ]

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

hyperlink: string;

属性值

string

注解

[ API 集:WordApi 1.1 ]

lockAspectRatio

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

lockAspectRatio: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.1 ]

paragraph

获取包含嵌入式图像的父段落。

readonly paragraph: Word.Paragraph;

属性值

注解

[ API 集:WordApi 1.2 ]

parentContentControl

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

readonly parentContentControl: Word.ContentControl;

属性值

注解

[ API 集:WordApi 1.1 ]

parentContentControlOrNullObject

获取包含嵌入式图像的内容控件。 如果没有父内容控件,则此方法将返回其属性设置为 true的对象isNullObject。 有关详细信息,请参阅 *OrNullObject 方法和属性

readonly parentContentControlOrNullObject: Word.ContentControl;

属性值

注解

[ API 集:WordApi 1.3 ]

parentTable

获取包含嵌入式图像的 table。 ItemNotFound如果未包含在表中,则引发错误。

readonly parentTable: Word.Table;

属性值

注解

[ API 集:WordApi 1.3 ]

parentTableCell

获取包含嵌入式图像的 tableCell。 ItemNotFound如果表单元格中未包含错误,则引发错误。

readonly parentTableCell: Word.TableCell;

属性值

注解

[ API 集:WordApi 1.3 ]

parentTableCellOrNullObject

获取包含嵌入式图像的 tableCell。 如果它未包含在表单元格中,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

readonly parentTableCellOrNullObject: Word.TableCell;

属性值

注解

[ API 集:WordApi 1.3 ]

parentTableOrNullObject

获取包含嵌入式图像的 table。 如果它未包含在表中,则此方法将返回一个 对象,其 isNullObject 属性设置为 true。 有关详细信息,请参阅 *OrNullObject 方法和属性

readonly parentTableOrNullObject: Word.Table;

属性值

注解

[ API 集:WordApi 1.3 ]

width

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

width: number;

属性值

number

注解

[ API 集:WordApi 1.1 ]

方法详细信息

delete()

从文档中删除嵌入式图片。

delete(): void;

返回

void

注解

[ API 集:WordApi 1.2 ]

getBase64ImageSrc()

获取内联图像的 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);
});

getNext()

获取下一个嵌入式图像。 ItemNotFound如果此内联图像是最后一个图像,则引发错误。

getNext(): Word.InlinePicture;

返回

注解

[ API 集:WordApi 1.3 ]

示例

// To use this snippet, add an inline picture to the document and assign it an alt text title.
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the first inline picture.
    const firstPicture = context.document.body.inlinePictures.getFirstOrNullObject();

    // Queue a command to load the alternative text title of the picture.
    firstPicture.load('altTextTitle');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    if (firstPicture.isNullObject) {
        console.log('There are no inline pictures in this document.')
    } else {
        console.log(firstPicture.altTextTitle);
    }
}); 

getNextOrNullObject()

获取下一个嵌入式图像。 如果此内联图像是最后一个,则此方法将返回一个对象,其 isNullObject 属性设置为 true。 有关详细信息,请参阅 *OrNullObject 方法和属性

getNextOrNullObject(): Word.InlinePicture;

返回

注解

[ API 集:WordApi 1.3 ]

示例

// To use this snippet, add an inline picture to the document and assign it an alt text title.
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the first inline picture.
    const firstPicture = context.document.body.inlinePictures.getFirstOrNullObject();

    // Queue a command to load the alternative text title of the picture.
    firstPicture.load('altTextTitle');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    if (firstPicture.isNullObject) {
        console.log('There are no inline pictures in this document.')
    } else {
        console.log(firstPicture.altTextTitle);
    }
}); 

getRange(rangeLocation)

获取图片或图片的起点/终点,作为一个范围。

getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;

参数

rangeLocation

whole | start | end | "Whole" | "Start" | "End"

可选。 范围位置必须为“Whole”、“Start”或“End”。

返回

注解

[ API 集:WordApi 1.3 ]

insertBreak(breakType, insertLocation)

在主文档的指定位置插入分隔符。

insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;

参数

breakType

Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line"

必填。 要添加的中断类型。

insertLocation

before | after | "Before" | "After"

必填。 该值必须为“Before”或“After”。

返回

void

注解

[ API 集:WordApi 1.2 ]

insertContentControl()

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

insertContentControl(): Word.ContentControl;

返回

注解

[ API 集:WordApi 1.1 ]

insertFileFromBase64(base64File, insertLocation)

在指定位置插入 document。

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;

参数

base64File

string

必填。 .docx 文件的 Base64 编码内容。

insertLocation

before | after | "Before" | "After"

必填。 该值必须为“Before”或“After”。

返回

注解

[ API 集:WordApi 1.2 ]

注意:如果要插入的文档在窗体字段中) 可能包含 ActiveX 控件 (,则不支持插入。 请考虑将此类窗体字段替换为适合你的方案的内容控件或其他选项。

insertHtml(html, insertLocation)

在指定位置插入 HTML。

insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;

参数

html

string

必填。 要插入的 HTML。

insertLocation

before | after | "Before" | "After"

必填。 该值必须为“Before”或“After”。

返回

注解

[ API 集:WordApi 1.2 ]

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

在指定位置插入 inlinePicture。

insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture;

参数

base64EncodedImage

string

必填。 要插入的 Base64 编码图像。

insertLocation

replace | before | after | "Replace" | "Before" | "After"

必填。 该值必须为“Replace”、“Before”或“After”。

返回

注解

[ API 集:WordApi 1.2 ]

insertOoxml(ooxml, insertLocation)

在指定位置插入 OOXML。

insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;

参数

ooxml

string

必填。 要插入的 OOXML。

insertLocation

before | after | "Before" | "After"

必填。 该值必须为“Before”或“After”。

返回

注解

[ API 集:WordApi 1.2 ]

insertParagraph(paragraphText, insertLocation)

在指定位置插入段落。

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;

参数

paragraphText

string

必填。 要插入的段落文本。

insertLocation

before | after | "Before" | "After"

必填。 该值必须为“Before”或“After”。

返回

注解

[ API 集:WordApi 1.2 ]

insertText(text, insertLocation)

在指定位置插入文本。

insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;

参数

text

string

必填。 要插入的文本。

insertLocation

before | after | "Before" | "After"

必填。 该值必须为“Before”或“After”。

返回

注解

[ API 集:WordApi 1.2 ]

load(options)

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

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

参数

options
Word.Interfaces.InlinePictureLoadOptions

提供要加载对象的属性的选项。

返回

load(propertyNames)

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

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

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是一个逗号分隔的字符串,指定要加载的属性,是 propertyNamesAndPaths.expand 一个逗号分隔的字符串,指定要加载的导航属性。

返回

select(selectionMode)

选择 inlinePicture。 这会导致 Word 滚动到选定内容。

select(selectionMode?: Word.SelectionMode): void;

参数

selectionMode
Word.SelectionMode

可选。 选择模式必须为“Select”、“Start”或“End”。 “Select”为默认值。

返回

void

注解

[ API 集:WordApi 1.2 ]

select(selectionModeString)

选择 inlinePicture。 这会导致 Word 滚动到选定内容。

select(selectionModeString?: "Select" | "Start" | "End"): void;

参数

selectionModeString

"Select" | "Start" | "End"

可选。 选择模式必须为“Select”、“Start”或“End”。 “Select”为默认值。

返回

void

注解

[ API 集:WordApi 1.2 ]

set(properties, options)

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

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

参数

properties
Word.Interfaces.InlinePictureUpdateData

一个 JavaScript 对象,其属性按同构方式构造为调用方法的对象的属性。

options
OfficeExtension.UpdateOptions

提供一个选项,用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

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

set(properties: Word.InlinePicture): void;

参数

properties
Word.InlinePicture

返回

void

toJSON()

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

toJSON(): Word.Interfaces.InlinePictureData;

返回

track()

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

track(): Word.InlinePicture;

返回

untrack()

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

untrack(): Word.InlinePicture;

返回