Word.DocumentCreated class
Das DocumentCreated-Objekt ist das Objekt der obersten Ebene, das von Application.CreateDocument erstellt wird. Ein DocumentCreated-Objekt ist ein spezielles Document-Objekt.
- 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
| body | Ruft das Textobjekt des Dokuments ab. Der Text ist der Text, der Kopfzeilen, Fußzeilen, Fußnoten, Textfelder usw. ausschließt. |
| content |
Ruft die Auflistung von Inhaltssteuerelementobjekten im Dokument ab. Dies umfasst Inhaltssteuerelemente im Textkörper des Dokuments, Kopfzeilen, Fußzeilen, Textfelder usw. |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| custom |
Ruft die benutzerdefinierten XML-Teile im Dokument ab. |
| properties | Ruft die Eigenschaften des Dokuments ab. |
| saved | Gibt an, ob die Änderungen im Dokument gespeichert wurden. True gibt an, dass seit dem Speichervorgang keine Änderungen an dem Dokument vorgenommen wurden. |
| sections | Ruft die Auflistung von Abschnittsobjekten im Dokument ab. |
| settings | Ruft die Einstellungen des Add-Ins im Dokument ab. |
Methoden
| add |
Fügt dem Dokument eine Formatvorlage nach Name und Typ hinzu. |
| add |
Fügt dem Dokument eine Formatvorlage nach Name und Typ hinzu. |
| delete |
Löscht ein Lesezeichen aus dem Dokument, sofern vorhanden. |
| get |
Ruft den Bereich eines Lesezeichens ab. Löst einen Fehler aus |
| get |
Ruft den Bereich eines Lesezeichens ab. Wenn das Lesezeichen nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen |
| get |
Ruft die derzeit unterstützten Inhaltssteuerelemente im Dokument ab. |
| get |
Ruft ein StyleCollection-Objekt ab, das den gesamten Formatvorlagensatz des Dokuments darstellt. |
| insert |
Fügt ein Dokument an einer bestimmten Stelle mit zusätzlichen Eigenschaften in das Zieldokument ein. Kopf- und Fußzeilen, Wasserzeichen und andere Abschnittseigenschaften werden standardmäßig kopiert. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| open() | Öffnet das Dokument. |
| save(save |
Speichert das Dokument. |
| save(save |
Speichert das Dokument. |
| set(properties, options) | Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben. |
| set(properties) | Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| toJSON() | Überschreibt die JavaScript-Methode |
| track() | Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über |
| untrack() | Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen |
Details zur Eigenschaft
body
Ruft das Textobjekt des Dokuments ab. Der Text ist der Text, der Kopfzeilen, Fußzeilen, Fußnoten, Textfelder usw. ausschließt.
readonly body: Word.Body;Eigenschaftswert
Hinweise
contentControls
Ruft die Auflistung von Inhaltssteuerelementobjekten im Dokument ab. Dies umfasst Inhaltssteuerelemente im Textkörper des Dokuments, Kopfzeilen, Fußzeilen, Textfelder usw.
readonly contentControls: Word.ContentControlCollection;Eigenschaftswert
Hinweise
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
customXmlParts
Ruft die benutzerdefinierten XML-Teile im Dokument ab.
readonly customXmlParts: Word.CustomXmlPartCollection;Eigenschaftswert
Hinweise
properties
Ruft die Eigenschaften des Dokuments ab.
readonly properties: Word.DocumentProperties;Eigenschaftswert
Hinweise
saved
Gibt an, ob die Änderungen im Dokument gespeichert wurden. True gibt an, dass seit dem Speichervorgang keine Änderungen an dem Dokument vorgenommen wurden.
readonly saved: boolean;Eigenschaftswert
boolean
Hinweise
sections
Ruft die Auflistung von Abschnittsobjekten im Dokument ab.
readonly sections: Word.SectionCollection;Eigenschaftswert
Hinweise
settings
Ruft die Einstellungen des Add-Ins im Dokument ab.
readonly settings: Word.SettingCollection;Eigenschaftswert
Hinweise
Details zur Methode
addStyle(name, type)
Fügt dem Dokument eine Formatvorlage nach Name und Typ hinzu.
addStyle(name: string, type: Word.StyleType): Word.Style;Parameter
- name
-
string
Erforderlich. Eine Zeichenfolge, die den Formatvorlagennamen darstellt.
- type
- Word.StyleType
Erforderlich. Der Formattyp, einschließlich Zeichen, Liste, Absatz oder Tabelle.
Gibt zurück
Hinweise
addStyle(name, typeString)
Fügt dem Dokument eine Formatvorlage nach Name und Typ hinzu.
addStyle(name: string, typeString: "Character" | "List" | "Paragraph" | "Table"): Word.Style;Parameter
- name
-
string
Erforderlich. Eine Zeichenfolge, die den Formatvorlagennamen darstellt.
- typeString
-
"Character" | "List" | "Paragraph" | "Table"
Erforderlich. Der Formattyp, einschließlich Zeichen, Liste, Absatz oder Tabelle.
Gibt zurück
Hinweise
deleteBookmark(name)
Löscht ein Lesezeichen aus dem Dokument, sofern vorhanden.
deleteBookmark(name: string): void;Parameter
- name
-
string
Erforderlich. Der Name des Lesezeichens, bei dem die Groß-/Kleinschreibung nicht beachtet wird.
Gibt zurück
void
Hinweise
getBookmarkRange(name)
Ruft den Bereich eines Lesezeichens ab. Löst einen Fehler aus ItemNotFound , wenn das Lesezeichen nicht vorhanden ist.
getBookmarkRange(name: string): Word.Range;Parameter
- name
-
string
Erforderlich. Der Name des Lesezeichens, bei dem die Groß-/Kleinschreibung nicht beachtet wird.
Gibt zurück
Hinweise
getBookmarkRangeOrNullObject(name)
Ruft den Bereich eines Lesezeichens ab. Wenn das Lesezeichen nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getBookmarkRangeOrNullObject(name: string): Word.Range;Parameter
- name
-
string
Erforderlich. Der Name des Lesezeichens, bei dem die Groß-/Kleinschreibung nicht beachtet wird. Es werden nur alphanumerische Zeichen und Unterstriche unterstützt. Sie muss mit einem Buchstaben beginnen, aber wenn Sie das Lesezeichen als ausgeblendet markieren möchten, beginnen Sie den Namen mit einem Unterstrich. Namen dürfen nicht länger als 40 Zeichen sein.
Gibt zurück
Hinweise
getContentControls(options)
Ruft die derzeit unterstützten Inhaltssteuerelemente im Dokument ab.
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;Parameter
- options
- Word.ContentControlOptions
Optional. Optionen, die definieren, welche Inhaltssteuerelemente zurückgegeben werden.
Gibt zurück
Hinweise
[ API-Satz: WordApiHiddenDocument 1.5 ]
Wichtig: Wenn bestimmte Typen im options-Parameter angegeben werden, werden nur Inhaltssteuerelemente unterstützter Typen zurückgegeben. Beachten Sie, dass bei Verwendung von Methoden eines generischen Word eine Ausnahme ausgelöst wird. ContentControl, die für den spezifischen Typ nicht relevant sind. Mit der Zeit können weitere Arten von Inhaltssteuerelementen unterstützt werden. Daher sollte Ihr Add-In bestimmte Arten von Inhaltssteuerelementen anfordern und verarbeiten.
getStyles()
Ruft ein StyleCollection-Objekt ab, das den gesamten Formatvorlagensatz des Dokuments darstellt.
getStyles(): Word.StyleCollection;Gibt zurück
Hinweise
insertFileFromBase64(base64File, insertLocation, insertFileOptions)
Fügt ein Dokument an einer bestimmten Stelle mit zusätzlichen Eigenschaften in das Zieldokument ein. Kopf- und Fußzeilen, Wasserzeichen und andere Abschnittseigenschaften werden standardmäßig kopiert.
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection;Parameter
- base64File
-
string
Erforderlich. Der Base64-codierte Inhalt einer .docx Datei.
Erforderlich. Der Wert muss "Replace", "Start" oder "End" sein.
- insertFileOptions
- Word.InsertFileOptions
Optional. Die zusätzlichen Eigenschaften, die in das Zieldokument importiert werden sollen.
Gibt zurück
Hinweise
[ API-Satz: WordApiHiddenDocument 1.5 ]
Hinweis: Das Einfügen wird nicht unterstützt, wenn das eingefügte Dokument ein ActiveX-Steuerelement (wahrscheinlich in einem Formularfeld) enthält. Erwägen Sie, ein solches Formularfeld durch ein Inhaltssteuerelement oder eine andere für Ihr Szenario geeignete Option zu ersetzen.
load(options)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(options?: Word.Interfaces.DocumentCreatedLoadOptions): Word.DocumentCreated;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
load(propertyNames)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames?: string | string[]): Word.DocumentCreated;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
load(propertyNamesAndPaths)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.DocumentCreated;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
open()
Öffnet das Dokument.
open(): void;Gibt zurück
void
Hinweise
Beispiele
// Create and open a new document in a new tab or window.
await Word.run(async (context) => {
const externalDoc = context.application.createDocument();
await context.sync();
externalDoc.open();
await context.sync();
});
save(saveBehavior, fileName)
Speichert das Dokument.
save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;Parameter
- saveBehavior
- Word.SaveBehavior
Optional. DocumentCreated unterstützt nur "Speichern".
- fileName
-
string
Optional. Der Dateiname (Dateierweiterung ausschließen). Wird nur für ein neues Dokument wirksam.
Gibt zurück
void
Hinweise
[ API-Satz: WordApiHiddenDocument 1.3 ]
Hinweis: Die saveBehavior Parameter und fileName wurden in WordApiHiddenDocument 1.5 eingeführt.
save(saveBehaviorString, fileName)
Speichert das Dokument.
save(saveBehaviorString?: "Save" | "Prompt", fileName?: string): void;Parameter
- saveBehaviorString
-
"Save" | "Prompt"
Optional. DocumentCreated unterstützt nur "Speichern".
- fileName
-
string
Optional. Der Dateiname (Dateierweiterung ausschließen). Wird nur für ein neues Dokument wirksam.
Gibt zurück
void
Hinweise
[ API-Satz: WordApiHiddenDocument 1.3 ]
Hinweis: Die saveBehavior Parameter und fileName wurden in WordApiHiddenDocument 1.5 eingeführt.
set(properties, options)
Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties: Interfaces.DocumentCreatedUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Word.Interfaces.DocumentCreatedUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Word.DocumentCreated): void;Parameter
- properties
- Word.DocumentCreated
Gibt zurück
void
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.DocumentCreated Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.DocumentCreatedData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Word.Interfaces.DocumentCreatedData;Gibt zurück
track()
Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.
track(): Word.DocumentCreated;Gibt zurück
untrack()
Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.DocumentCreated;Gibt zurück
Office Add-ins