Word.InlinePicture class

Пакет:

word

Представляет встроенный рисунок.

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: WordApi 1.1

Используется

• Word. Текст: insertInlinePictureFromBase64
• Word. ContentControl: insertInlinePictureFromBase64
• Word. InlinePictureCollection: getFirst, getFirstOrNullObject, items
• Word. Абзац: insertInlinePictureFromBase64
• Word. Диапазон: insertInlinePictureFromBase64

Примеры

// 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	Указывает гиперссылку на изображение. Используйте '#', чтобы отделить часть адреса от необязательной части расположения.
imageFormat	Получает формат встроенного изображения.
lockAspectRatio	Указывает, сохраняют ли встроенное изображение исходные пропорции при изменении размера.
paragraph	Возвращает родительский абзац, который содержит встроенный рисунок.
parentContentControl	Возвращает элемент управления содержимым, который содержит встроенный рисунок. Выдает ошибку, ItemNotFound если родительский элемент управления содержимым отсутствует.
parentContentControlOrNullObject	Возвращает элемент управления содержимым, который содержит встроенный рисунок. Если родительский элемент управления содержимым отсутствует, этот метод возвращает объект со isNullObject свойством true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
parentTable	Возвращает таблицу, содержащую встроенный рисунок. Выдает ItemNotFound ошибку, если она не содержится в таблице.
parentTableCell	Возвращает ячейку таблицы, содержащую встроенный рисунок. Выдает ошибку, ItemNotFound если она не содержится в ячейке таблицы.
parentTableCellOrNullObject	Возвращает ячейку таблицы, содержащую встроенный рисунок. Если он не содержится в ячейке таблицы, этот метод вернет объект со свойством isNullObject , установленным в true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
parentTableOrNullObject	Возвращает таблицу, содержащую встроенный рисунок. Если его нет в таблице, этот метод вернет объект со свойством isNullObject , установленным в true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
width	Число, описывающее ширину встроенного изображения.

Методы

delete()	Удаляет встроенный рисунок из документа.
getBase64ImageSrc()	Получает строковое представление встроенного изображения в кодировке Base64.
getNext()	Возвращает следующий встроенный рисунок. Выдает ошибку, ItemNotFound если это встроенное изображение является последним.
getNextOrNullObject()	Возвращает следующий встроенный рисунок. Если это встроенное изображение является последним, то этот метод вернет объект со свойством isNullObject , установленным в trueзначение . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getRange(rangeLocation)	Возвращает рисунок (либо его начальную или конечную точку) в виде диапазона.
insertBreak(breakType, insertLocation)	Вставляет разрыв в указанном расположении в основном документе.
insertContentControl()	Включает встроенный рисунок в элемент управления содержимым форматированного текста.
insertFileFromBase64(base64File, insertLocation)	Вставляет документ в указанном расположении.
insertHtml(html, insertLocation)	Вставляет HTML-код в указанном расположении.
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)	Вставляет встроенный рисунок в указанном расположении.
insertOoxml(ooxml, insertLocation)	Вставляет OOXML-код в указанном расположении.
insertParagraph(paragraphText, insertLocation)	Вставляет абзац в указанном расположении.
insertText(text, insertLocation)	Вставляет текст в заданном расположении.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
select(selectionMode)	Выбирает встроенный рисунок. При этом Word переходит к выделенному объекту.
select(selectionMode)	Выбирает встроенный рисунок. При этом 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;

Значение свойства

Word.RequestContext

height

Число, описывающее высоту встроенного изображения.

height: number;

Значение свойства

number

Комментарии

Набор API: WordApi 1.1

hyperlink

Указывает гиперссылку на изображение. Используйте '#', чтобы отделить часть адреса от необязательной части расположения.

hyperlink: string;

Значение свойства

string

Комментарии

Набор API: WordApi 1.1

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

Комментарии

Набор API: WordApi 1.1

paragraph

Возвращает родительский абзац, который содержит встроенный рисунок.

readonly paragraph: Word.Paragraph;

Значение свойства

Word.Paragraph

Комментарии

Набор API: WordApi 1.2

parentContentControl

Возвращает элемент управления содержимым, который содержит встроенный рисунок. Выдает ошибку, ItemNotFound если родительский элемент управления содержимым отсутствует.

readonly parentContentControl: Word.ContentControl;

Значение свойства

Word.ContentControl

Комментарии

Набор API: WordApi 1.1

parentContentControlOrNullObject

Возвращает элемент управления содержимым, который содержит встроенный рисунок. Если родительский элемент управления содержимым отсутствует, этот метод возвращает объект со isNullObject свойством true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

readonly parentContentControlOrNullObject: Word.ContentControl;

Значение свойства

Word.ContentControl

Комментарии

Набор API: WordApi 1.3

parentTable

Возвращает таблицу, содержащую встроенный рисунок. Выдает ItemNotFound ошибку, если она не содержится в таблице.

readonly parentTable: Word.Table;

Значение свойства

Word.Table

Комментарии

Набор API: WordApi 1.3

parentTableCell

Возвращает ячейку таблицы, содержащую встроенный рисунок. Выдает ошибку, ItemNotFound если она не содержится в ячейке таблицы.

readonly parentTableCell: Word.TableCell;

Значение свойства

Word.TableCell

Комментарии

Набор API: WordApi 1.3

parentTableCellOrNullObject

Возвращает ячейку таблицы, содержащую встроенный рисунок. Если он не содержится в ячейке таблицы, этот метод вернет объект со свойством isNullObject , установленным в true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

readonly parentTableCellOrNullObject: Word.TableCell;

Значение свойства

Word.TableCell

Комментарии

Набор API: WordApi 1.3

parentTableOrNullObject

Возвращает таблицу, содержащую встроенный рисунок. Если его нет в таблице, этот метод вернет объект со свойством isNullObject , установленным в true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

readonly parentTableOrNullObject: Word.Table;

Значение свойства

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

Возвращаемое значение

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;

Возвращаемое значение

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;

Возвращаемое значение

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.

Возвращаемое значение

Word.Range

Комментарии

Набор 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"

Значение должно быть или beforeafter.

Возвращаемое значение

void

Комментарии

Набор API: WordApi 1.2

insertContentControl()

Включает встроенный рисунок в элемент управления содержимым форматированного текста.

insertContentControl(): Word.ContentControl;

Возвращаемое значение

Word.ContentControl

Комментарии

Набор API: WordApi 1.1

insertFileFromBase64(base64File, insertLocation)

Вставляет документ в указанном расположении.

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

Параметры

base64File

string

Содержимое файла .docx в кодировке Base64.

insertLocation

before | after | "Before" | "After"

Значение должно быть или beforeafter.

Возвращаемое значение

Word.Range

Комментарии

Набор 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"

Значение должно быть или beforeafter.

Возвращаемое значение

Word.Range

Комментарии

Набор API: WordApi 1.2

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

Вставляет встроенный рисунок в указанном расположении.

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

Комментарии

Набор 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"

Значение должно быть или beforeafter.

Возвращаемое значение

Word.Range

Комментарии

Набор 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"

Значение должно быть или beforeafter.

Возвращаемое значение

Word.Paragraph

Комментарии

Набор 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"

Значение должно быть или beforeafter.

Возвращаемое значение

Word.Range

Комментарии

Набор API: WordApi 1.2

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)

Выбирает встроенный рисунок. При этом Word переходит к выделенному объекту.

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

Параметры

selectionMode

Word.SelectionMode

Необязательный параметр. Режим выделения должен быть , selectstartили .end select используется по умолчанию.

Возвращаемое значение

void

Комментарии

Набор API: WordApi 1.2

select(selectionMode)

Выбирает встроенный рисунок. При этом Word переходит к выделенному объекту.

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

Параметры

selectionMode

"Select" | "Start" | "End"

Необязательный параметр. Режим выделения должен быть , selectstartили .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;

Возвращаемое значение

Word.Interfaces.InlinePictureData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.

track(): Word.InlinePicture;

Возвращаемое значение

Word.InlinePicture

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

untrack(): Word.InlinePicture;

Возвращаемое значение

Word.InlinePicture