Word.Application class
Stellt das Anwendungsobjekt dar.
- Extends
Hinweise
Beispiele
// 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: Word.DocumentCreated = context.application.createDocument(externalDocument);
await context.sync();
const externalDocBody: Word.Body = 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: Word.Body = context.document.body;
currentDocBody.insertText(externalDocBodyText, Word.InsertLocation.start);
await context.sync();
});
Eigenschaften
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
Methoden
| create |
Erstellt ein neues Dokument mithilfe einer optionalen Base64-codierten .docx Datei. |
| new |
Erstellen Sie eine neue instance des |
| open |
Öffnet ein Dokument und zeigt es auf einer neuen Registerkarte oder in einem neuen Fenster an. Im Folgenden sind Beispiele für die verschiedenen unterstützten Clients und Plattformen aufgeführt.
|
| retrieve |
Analysieren Sie Formatvorlagen aus einer Base64-Vorlagendatei, und geben Sie das JSON-Format der abgerufenen Formatvorlagen als Zeichenfolge zurück. |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
Details zur Methode
createDocument(base64File)
Erstellt ein neues Dokument mithilfe einer optionalen Base64-codierten .docx Datei.
createDocument(base64File?: string): Word.DocumentCreated;Parameter
- base64File
-
string
Optional. Die Base64-codierte .docx-Datei. Der Standardwert ist null.
Gibt zurück
Hinweise
Beispiele
// 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: Word.DocumentCreated = context.application.createDocument(externalDocument);
await context.sync();
const externalDocBody: Word.Body = 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: Word.Body = context.document.body;
currentDocBody.insertText(externalDocBodyText, Word.InsertLocation.start);
await context.sync();
});
newObject(context)
Erstellen Sie eine neue instance des Word.Application Objekts.
static newObject(context: OfficeExtension.ClientRequestContext): Word.Application;Parameter
Gibt zurück
openDocument(filePath)
Öffnet ein Dokument und zeigt es auf einer neuen Registerkarte oder in einem neuen Fenster an. Im Folgenden sind Beispiele für die verschiedenen unterstützten Clients und Plattformen aufgeführt.
Beispiel für Remote- oder Cloudstandort:
https://microsoft.sharepoint.com/some/path/Document.docxBeispiele für den lokalen Standort für Windows:
C:\\Users\\Someone\\Documents\\Document.docx(enthält erforderliche umgekehrte Schrägstriche mit Escapezeichen),file://mycomputer/myfolder/Document.docxBeispiel für den lokalen Standort für Mac und iOS:
/User/someone/document.docx
openDocument(filePath: string): void;Parameter
- filePath
-
string
Erforderlich. Der absolute Pfad der .docx Datei. Word im Web unterstützt nur Remotespeicherorte (Cloud), während Word unter Windows, Mac und iOS lokale und Remotestandorte unterstützen.
Gibt zurück
void
Hinweise
retrieveStylesFromBase64(base64File)
Analysieren Sie Formatvorlagen aus einer Base64-Vorlagendatei, und geben Sie das JSON-Format der abgerufenen Formatvorlagen als Zeichenfolge zurück.
retrieveStylesFromBase64(base64File: string): OfficeExtension.ClientResult<string>;Parameter
- base64File
-
string
Erforderlich. Die Vorlagendatei.
Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
Beispiele
// 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()
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Word.Application Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.ApplicationData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): {
[key: string]: string;
};Gibt zurück
{ [key: string]: string; }
Office Add-ins