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 ]

Возвращает формат встроенного изображения.

readonly imageFormat: 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: boolean;

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

Комментарии

[ Набор API: WordApi 1.1 ]

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

readonly paragraph: Word.Paragraph;

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

Комментарии

[ Набор API: WordApi 1.2 ]

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

readonly parentContentControl: Word.ContentControl;

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

Комментарии

[ Набор API: WordApi 1.1 ]

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

readonly parentContentControlOrNullObject: Word.ContentControl;

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

Комментарии

[ Набор API: WordApi 1.3 ]

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

readonly parentTable: Word.Table;

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

Комментарии

[ Набор API: WordApi 1.3 ]

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

readonly parentTableCell: Word.TableCell;

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

Комментарии

[ Набор API: WordApi 1.3 ]

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

readonly parentTableCellOrNullObject: Word.TableCell;

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

Комментарии

[ Набор API: WordApi 1.3 ]

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

readonly parentTableOrNullObject: Word.Table;

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

Комментарии

[ Набор API: WordApi 1.3 ]

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

width: number;

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

Комментарии

[ Набор API: WordApi 1.1 ]

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

delete(): void;

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

Комментарии

[ Набор API: WordApi 1.2 ]

Возвращает строковое представление встроенного изображения в кодировке 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);
});

Возвращает следующий встроенный рисунок. Выдает ошибку, 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);
    }
}); 

Возвращает следующий встроенный рисунок. Если это встроенное изображение является последним, этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *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?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;

Параметры

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

Комментарии

[ Набор API: WordApi 1.3 ]

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

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

Параметры

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

Комментарии

[ Набор API: WordApi 1.2 ]

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

insertContentControl(): Word.ContentControl;

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

Комментарии

[ Набор API: WordApi 1.1 ]

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

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

Параметры

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

Комментарии

[ Набор API: WordApi 1.2 ]

Примечание. Вставка не поддерживается, если вставляемый документ содержит элемент ActiveX (вероятно, в поле формы). Рассмотрите возможность замены такого поля формы элементом управления содержимым или другим вариантом, подходящим для вашего сценария.

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

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

Параметры

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

Комментарии

[ Набор API: WordApi 1.2 ]

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

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

Параметры

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

Комментарии

[ Набор API: WordApi 1.2 ]

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

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

Параметры

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

Комментарии

[ Набор API: WordApi 1.2 ]

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

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

Параметры

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

Комментарии

[ Набор API: WordApi 1.2 ]

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

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

Параметры

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

Комментарии

[ Набор API: WordApi 1.2 ]

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод 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;

Параметры

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

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

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

Параметры

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

Комментарии

[ Набор API: WordApi 1.2 ]

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

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

Параметры

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

Комментарии

[ Набор API: WordApi 1.2 ]

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект 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;

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