Word.InlinePicture class
Представляет встроенный рисунок.
- Extends
Комментарии
Примеры
// 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();
});
Свойства
| alt |
Указывает строку, представляющую альтернативный текст, связанный со встроенным изображением. |
| alt |
Указывает строку, содержащую заголовок встроенного изображения. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| height | Задает число, описывающее высоту встроенного изображения. |
| hyperlink | Указывает гиперссылку на изображение. Используйте "#", чтобы отделить адресную часть от необязательной части расположения. |
| image |
Возвращает формат встроенного изображения. |
| lock |
Указывает значение, указывающее, сохраняет ли встроенное изображение исходные пропорции при изменении размера. |
| paragraph | Возвращает родительский абзац, который содержит встроенный рисунок. |
| parent |
Возвращает элемент управления содержимым, который содержит встроенный рисунок. Выдает ошибку |
| parent |
Возвращает элемент управления содержимым, который содержит встроенный рисунок. Если родительского элемента управления содержимым нет, этот метод вернет объект со свойством |
| parent |
Возвращает таблицу, содержащую встроенный рисунок. Выдает ошибку |
| parent |
Возвращает ячейку таблицы, содержащую встроенный рисунок. Выдает ошибку |
| parent |
Возвращает ячейку таблицы, содержащую встроенный рисунок. Если он не содержится в ячейке таблицы, этот метод вернет объект со свойством , для него |
| parent |
Возвращает таблицу, содержащую встроенный рисунок. Если он не содержится в таблице, то этот метод вернет объект со свойством |
| width | Задает число, описывающее ширину встроенного изображения. |
Методы
| delete() | Удаляет встроенный рисунок из документа. |
| get |
Возвращает строковое представление встроенного изображения в кодировке Base64. |
| get |
Возвращает следующий встроенный рисунок. Выдает ошибку, |
| get |
Возвращает следующий встроенный рисунок. Если это встроенное изображение является последним, этот метод вернет объект со свойством |
| get |
Возвращает рисунок (либо его начальную или конечную точку) в виде диапазона. |
| insert |
Вставляет разрыв в указанном расположении в основном документе. |
| insert |
Включает встроенный рисунок в элемент управления содержимым форматированного текста. |
| insert |
Вставляет документ в указанном расположении. |
| insert |
Вставляет HTML-код в указанном расположении. |
| insert |
Вставляет встроенный рисунок в указанном расположении. |
| insert |
Вставляет OOXML-код в указанном расположении. |
| insert |
Вставляет абзац в указанном расположении. |
| insert |
Вставляет текст в заданном расположении. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| select(selection |
Выбирает встроенный рисунок. При этом Word переходит к выделенному объекту. |
| select(selection |
Выбирает встроенный рисунок. При этом Word переходит к выделенному объекту. |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить |
Сведения о свойстве
altTextDescription
Указывает строку, представляющую альтернативный текст, связанный со встроенным изображением.
altTextDescription: string;Значение свойства
string
Комментарии
altTextTitle
Указывает строку, содержащую заголовок встроенного изображения.
altTextTitle: string;Значение свойства
string
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
height
Задает число, описывающее высоту встроенного изображения.
height: number;Значение свойства
number
Комментарии
hyperlink
Указывает гиперссылку на изображение. Используйте "#", чтобы отделить адресную часть от необязательной части расположения.
hyperlink: string;Значение свойства
string
Комментарии
imageFormat
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает формат встроенного изображения.
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: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/insert-and-get-pictures.yaml
// Gets the first image in the document.
await Word.run(async (context) => {
const firstPicture = context.document.body.inlinePictures.getFirst();
firstPicture.load("width, height, imageFormat");
await context.sync();
console.log(`Image dimensions: ${firstPicture.width} x ${firstPicture.height}`);
console.log(`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;Значение свойства
Комментарии
parentContentControl
Возвращает элемент управления содержимым, который содержит встроенный рисунок. Выдает ошибку ItemNotFound , если родительского элемента управления содержимым нет.
readonly parentContentControl: Word.ContentControl;Значение свойства
Комментарии
parentContentControlOrNullObject
Возвращает элемент управления содержимым, который содержит встроенный рисунок. Если родительского элемента управления содержимым нет, этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
readonly parentContentControlOrNullObject: Word.ContentControl;Значение свойства
Комментарии
parentTable
Возвращает таблицу, содержащую встроенный рисунок. Выдает ошибку ItemNotFound , если она не содержится в таблице.
readonly parentTable: Word.Table;Значение свойства
Комментарии
parentTableCell
Возвращает ячейку таблицы, содержащую встроенный рисунок. Выдает ошибку ItemNotFound , если она не содержится в ячейке таблицы.
readonly parentTableCell: Word.TableCell;Значение свойства
Комментарии
parentTableCellOrNullObject
Возвращает ячейку таблицы, содержащую встроенный рисунок. Если он не содержится в ячейке таблицы, этот метод вернет объект со свойством , для него isNullObject задано значение true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
readonly parentTableCellOrNullObject: Word.TableCell;Значение свойства
Комментарии
parentTableOrNullObject
Возвращает таблицу, содержащую встроенный рисунок. Если он не содержится в таблице, то этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
readonly parentTableOrNullObject: 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 = context.document.body.inlinePictures.getFirst();
firstPicture.load("width, height");
await context.sync();
console.log(`Image dimensions: ${firstPicture.width} x ${firstPicture.height}`);
// Get the image encoded as Base64.
const base64 = firstPicture.getBase64ImageSrc();
await context.sync();
console.log(base64.value);
});
getNext()
Возвращает следующий встроенный рисунок. Выдает ошибку, ItemNotFound если это встроенное изображение является последним.
getNext(): 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()
Возвращает следующий встроенный рисунок. Если это встроенное изображение является последним, этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getNextOrNullObject(): 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;Параметры
Необязательный параметр. Диапазон должен находиться в диапазоне "Whole", "Start" или "End".
Возвращаемое значение
Комментарии
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"
Обязательно. Добавляемый тип разрыва.
Обязательно. Значение должно быть "До" или "После".
Возвращаемое значение
void
Комментарии
insertContentControl()
Включает встроенный рисунок в элемент управления содержимым форматированного текста.
insertContentControl(): Word.ContentControl;Возвращаемое значение
Комментарии
insertFileFromBase64(base64File, insertLocation)
Вставляет документ в указанном расположении.
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;Параметры
- base64File
-
string
Обязательно. Содержимое файла .docx в кодировке Base64.
Обязательно. Значение должно быть "До" или "После".
Возвращаемое значение
Комментарии
Примечание. Вставка не поддерживается, если вставляемый документ содержит элемент ActiveX (вероятно, в поле формы). Рассмотрите возможность замены такого поля формы элементом управления содержимым или другим вариантом, подходящим для вашего сценария.
insertHtml(html, insertLocation)
Вставляет HTML-код в указанном расположении.
insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;Параметры
- html
-
string
Обязательно. Вставляемый HTML-код.
Обязательно. Значение должно быть "До" или "После".
Возвращаемое значение
Комментарии
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)
Вставляет встроенный рисунок в указанном расположении.
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture;Параметры
- base64EncodedImage
-
string
Обязательно. Вставляемый образ в кодировке Base64.
Обязательно. Значение должно быть "Заменить", "До" или "После".
Возвращаемое значение
Комментарии
insertOoxml(ooxml, insertLocation)
Вставляет OOXML-код в указанном расположении.
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;Параметры
- ooxml
-
string
Обязательно. Вставляемый OOXML-код.
Обязательно. Значение должно быть "До" или "После".
Возвращаемое значение
Комментарии
insertParagraph(paragraphText, insertLocation)
Вставляет абзац в указанном расположении.
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;Параметры
- paragraphText
-
string
Обязательно. Текст абзаца, который необходимо вставить.
Обязательно. Значение должно быть "До" или "После".
Возвращаемое значение
Комментарии
insertText(text, insertLocation)
Вставляет текст в заданном расположении.
insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;Параметры
- text
-
string
Обязательно. Текст, который необходимо вставить.
Обязательно. Значение должно быть "До" или "После".
Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.InlinePictureLoadOptions): Word.InlinePicture;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
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)
Выбирает встроенный рисунок. При этом Word переходит к выделенному объекту.
select(selectionMode?: Word.SelectionMode): void;Параметры
- selectionMode
- Word.SelectionMode
Необязательный параметр. Режим выбора должен быть "Select", "Start" или "End". Значение по умолчанию — Select.
Возвращаемое значение
void
Комментарии
select(selectionModeString)
Выбирает встроенный рисунок. При этом Word переходит к выделенному объекту.
select(selectionModeString?: "Select" | "Start" | "End"): void;Параметры
- selectionModeString
-
"Select" | "Start" | "End"
Необязательный параметр. Режим выбора должен быть "Select", "Start" или "End". Значение по умолчанию — Select.
Возвращаемое значение
void
Комментарии
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.InlinePictureUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Word.Interfaces.InlinePictureUpdateData
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
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;Возвращаемое значение
Office Add-ins
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по