Поделиться через

Word.Application class

  • Ссылка
Пакет:
word

Представляет объект приложения.

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApi 1.3 ]

Свойства

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

Методы

createDocument(base64File)

Создает документ с помощью дополнительного файла .docx в кодировке Base64.
newObject(context)

Создайте новый экземпляр Word. Объект Application
openDocument(filePath)

Открывает документ и отображает его на новой вкладке или окне. Ниже приведены примеры для различных поддерживаемых клиентов и платформ.

  • Пример удаленного или облачного расположения: https://microsoft.sharepoint.com/some/path/Document.docx

  • Примеры локального расположения для Windows: C:\\Users\\Someone\\Documents\\Document.docx (включает в себя обязательные экранированные обратные косые косые косые стекли); file://mycomputer/myfolder/Document.docx

  • Пример локального расположения для Mac и iOS: /User/someone/document.docx
retrieveStylesFromBase64(base64File)

Выполните синтаксический анализ стилей из файла Base64 шаблона и верните формат JSON полученных стилей в виде строки.
toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word. Объект приложения — это объект API. toJSON Метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.ApplicationData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

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

Word.RequestContext

Сведения о методе

createDocument(base64File)

Создает документ с помощью дополнительного файла .docx в кодировке Base64.

createDocument(base64File?: string): Word.DocumentCreated;

Параметры

base64File

string

Необязательный параметр. Файл .docx в кодировке Base64. По умолчанию используется значение NULL.

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

Word.DocumentCreated

Комментарии

[ Набор API: WordApi 1.3 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/insert-external-document.yaml

// Updates the text of the current document with the text from another document passed in as a Base64-encoded string.
await Word.run(async (context) => {
  // Use the Base64-encoded string representation of the selected .docx file.
  const externalDoc = context.application.createDocument(externalDocument);
  await context.sync();

  const externalDocBody = externalDoc.body;
  externalDocBody.load("text");
  await context.sync();

  // Insert the external document's text at the beginning of the current document's body.
  const externalDocBodyText = externalDocBody.text;
  const currentDocBody = context.document.body;
  currentDocBody.insertText(externalDocBodyText, Word.InsertLocation.start);
  await context.sync();
});

newObject(context)

Создайте новый экземпляр Word. Объект Application

static newObject(context: OfficeExtension.ClientRequestContext): Word.Application;

Параметры

context
OfficeExtension.ClientRequestContext

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

Word.Application

openDocument(filePath)

Открывает документ и отображает его на новой вкладке или окне. Ниже приведены примеры для различных поддерживаемых клиентов и платформ.

  • Пример удаленного или облачного расположения: https://microsoft.sharepoint.com/some/path/Document.docx

  • Примеры локального расположения для Windows: C:\\Users\\Someone\\Documents\\Document.docx (включает в себя обязательные экранированные обратные косые косые косые стекли); file://mycomputer/myfolder/Document.docx

  • Пример локального расположения для Mac и iOS: /User/someone/document.docx

openDocument(filePath: string): void;

Параметры

filePath

string

Обязательно. Абсолютный путь к файлу .docx. Word в Интернете поддерживает только удаленные (облачные) расположения, а Word в Windows, Mac и iOS — локальные и удаленные расположения.

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

void

Комментарии

[ Набор API: WordApi 1.6 ]

retrieveStylesFromBase64(base64File)

Выполните синтаксический анализ стилей из файла Base64 шаблона и верните формат JSON полученных стилей в виде строки.

retrieveStylesFromBase64(base64File: string): OfficeExtension.ClientResult<string>;

Параметры

base64File

string

Обязательно. Файл шаблона.

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

OfficeExtension.ClientResult<string>

Комментарии

[ Набор API: WordApi 1.5 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/get-external-styles.yaml

// Gets style info from another document passed in as a Base64-encoded string.
await Word.run(async (context) => {
  const retrievedStyles = context.application.retrieveStylesFromBase64(externalDocument);
  await context.sync();

  console.log("Styles from the other document:", retrievedStyles.value);
});

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word. Объект приложения — это объект API. toJSON Метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.ApplicationData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): {
            [key: string]: string;
        };

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

{ [key: string]: string; }