Word. Inline Picture class

altTextTitle

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

altTextTitle: string;

属性值

string

注解

context

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

context: RequestContext;

属性值

Word.RequestContext

height

指定一个数字，用于描述内联图像的高度。

height: number;

属性值

number

注解

hyperlink

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

hyperlink: string;

属性值

string

注解

imageFormat

获取内联图像的格式。

readonly imageFormat: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg";

属性值

Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"

注解

API 集：WordApiDesktop 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);
});

lockAspectRatio

指定调整内联图像大小时是否保留其原始比例。

lockAspectRatio: boolean;

属性值

boolean

注解

paragraph

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

readonly paragraph: Word.Paragraph;

属性值

Word.Paragraph

注解

parentContentControl

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

readonly parentContentControl: Word.ContentControl;

属性值

Word.ContentControl

注解

parentContentControlOrNullObject

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

readonly parentContentControlOrNullObject: Word.ContentControl;

属性值

Word.ContentControl

注解

parentTable

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

readonly parentTable: Word.Table;

属性值

Word.Table

注解

parentTableCell

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

readonly parentTableCell: Word.TableCell;

属性值

Word.TableCell

注解

parentTableCellOrNullObject

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

readonly parentTableCellOrNullObject: Word.TableCell;

属性值

Word.TableCell

注解

parentTableOrNullObject

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

readonly parentTableOrNullObject: Word.Table;

属性值

Word.Table

注解

width

指定一个数字，用于描述内联图像的宽度。

width: number;

属性值

number

注解

delete()

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

delete(): void;

返回

void

注解

getBase64ImageSrc()

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

getBase64ImageSrc(): OfficeExtension.ClientResult<string>;

返回

OfficeExtension.ClientResult<string>

注解

示例

// 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;

返回

Word.InlinePicture

注解

示例

// 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;

返回

Word.InlinePicture

注解

示例

// 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、或 endstart。

返回

Word.Range

注解

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"

值必须为 OR 。beforeafter

返回

void

注解

insertContentControl()

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

insertContentControl(): Word.ContentControl;

返回

Word.ContentControl

注解

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"

值必须为 OR 。beforeafter

返回

Word.Range

注解

如果要插入的文档包含 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"

值必须为 OR 。beforeafter

返回

Word.Range

注解

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。

返回

Word.InlinePicture

注解

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"

值必须为 OR 。beforeafter

返回

Word.Range

注解

insertParagraph(paragraphText, insertLocation)

在指定位置插入段落。

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

参数

paragraphText: string

要插入的段落文本。

insertLocation: before | after | "Before" | "After"

值必须为 OR 。beforeafter

返回

Word.Paragraph

注解

insertText(text, insertLocation)

在指定位置插入文本。

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

参数

text: string

要插入的文本。

insertLocation: before | after | "Before" | "After"

值必须为 OR 。beforeafter

返回

Word.Range

注解

load(options)

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

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

参数

options: Word.Interfaces.InlinePictureLoadOptions

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

返回

Word.InlinePicture

load(propertyNames)

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

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

参数

propertyNames: string | string[]

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

返回

Word.InlinePicture

load(propertyNamesAndPaths)

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

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

参数

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

propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。

返回

Word.InlinePicture

select(selectionMode)

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

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

参数

selectionMode: Word.SelectionMode

可选。选择模式必须为 select、、start 或 end。 select 为默认值。

返回

void

注解

select(selectionMode)

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

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

参数

selectionMode: "Select" | "Start" | "End"

可选。选择模式必须为 select、、start 或 end。 select 为默认值。

返回

void

注解