Word.DocumentCreated class
Das DocumentCreated Objekt ist das Objekt der obersten Ebene, das von erstellt wurde Application.createDocument. Ein DocumentCreated Objekt ist ein besonderes Document Objekt.
- Extends
Hinweise
Verwendet von
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();
if (!Office.context.requirements.isSetSupported("WordApiHiddenDocument", "1.3")) {
console.warn("The WordApiHiddenDocument 1.3 requirement set isn't supported on this client so can't proceed. Try this action on a platform that supports this requirement set.");
return;
}
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 |
| content |
Ruft die Sammlung von |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| custom |
Ruft die benutzerdefinierten XML-Komponenten im Dokument ab. |
| properties | Ruft die Eigenschaften des Dokuments ab. |
| saved | Gibt an, ob die Änderungen im Dokument gespeichert wurden. Der Wert gibt |
| sections | Ruft die Sammlung von |
| 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 eine Textmarke, falls vorhanden, aus dem Dokument. |
| get |
Ruft den Bereich einer Textmarke ab. Gibt einen |
| get |
Ruft den Bereich einer Textmarke ab. Wenn das Lesezeichen nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen |
| get |
Ruft die aktuell unterstützten Inhaltssteuerelemente im Dokument ab. |
| get |
Ruft ein |
| insert |
Fügt ein Dokument an einer bestimmten Position 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 aufrufübergreifend |
| 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 einen Aufruf durchführen |
Details zur Eigenschaft
body
Ruft das Body Objekt des Dokuments ab. Der Textkörper ist der Text, der Kopfzeilen, Fußzeilen, Fußnoten, Textfelder usw. ausschließt.
readonly body: Word.Body;Eigenschaftswert
Hinweise
contentControls
Ruft die Sammlung von ContentControl Objekten im Dokument ab. Dazu gehören Inhaltssteuerelemente im Textkörper des Dokuments, Kopfzeilen, Fußzeilen, Textfelder usw.
readonly contentControls: Word.ContentControlCollection;Eigenschaftswert
Hinweise
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
customXmlParts
Ruft die benutzerdefinierten XML-Komponenten 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. Der Wert gibt true an, dass das Dokument seit dem Speichern nicht geändert wurde.
readonly saved: boolean;Eigenschaftswert
boolean
Hinweise
sections
Ruft die Sammlung von Section Objekten 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
Eine Zeichenfolge, die den Namen der Formatvorlage darstellt.
- type
- Word.StyleType
Der Formatvorlagentyp, einschließlich Zeichen, Liste, Absatz oder Tabelle.
Gibt zurück
Hinweise
addStyle(name, type)
Fügt dem Dokument eine Formatvorlage nach Name und Typ hinzu.
addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style;Parameter
- name
-
string
Eine Zeichenfolge, die den Namen der Formatvorlage darstellt.
- type
-
"Character" | "List" | "Paragraph" | "Table"
Der Formatvorlagentyp, einschließlich Zeichen, Liste, Absatz oder Tabelle.
Gibt zurück
Hinweise
deleteBookmark(name)
Löscht eine Textmarke, falls vorhanden, aus dem Dokument.
deleteBookmark(name: string): void;Parameter
- name
-
string
Der Name des Lesezeichens ohne Berücksichtigung der Groß-/Kleinschreibung.
Gibt zurück
void
Hinweise
getBookmarkRange(name)
Ruft den Bereich einer Textmarke ab. Gibt einen ItemNotFound Fehler aus, wenn die Textmarke nicht vorhanden ist.
getBookmarkRange(name: string): Word.Range;Parameter
- name
-
string
Der Name des Lesezeichens ohne Berücksichtigung der Groß-/Kleinschreibung.
Gibt zurück
Hinweise
getBookmarkRangeOrNullObject(name)
Ruft den Bereich einer Textmarke ab. Wenn das Lesezeichen nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getBookmarkRangeOrNullObject(name: string): Word.Range;Parameter
- name
-
string
Der Name des Lesezeichens ohne Berücksichtigung der Groß-/Kleinschreibung. Es werden nur alphanumerische Zeichen und Unterstriche unterstützt. Es muss mit einem Buchstaben beginnen. Wenn Sie die Textmarke jedoch als ausgeblendet kennzeichnen möchten, beginnen Sie den Namen mit einem Unterstrich. Namen dürfen maximal 40 Zeichen lang sein.
Gibt zurück
Hinweise
getContentControls(options)
Ruft die aktuell 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 der Methoden eines generischen Word eine Ausnahme ausgelöst wird. ContentControl, die für den spezifischen Typ nicht relevant sind. Mit der Zeit werden u. U. weitere Arten von Inhaltssteuerelementen unterstützt. Deshalb sollte Ihr Add-In bestimmte Arten von Inhaltssteuerelementen anfordern und verarbeiten.
getStyles()
Ruft ein StyleCollection Objekt ab, das den gesamten Stilsatz des Dokuments darstellt.
getStyles(): Word.StyleCollection;Gibt zurück
Hinweise
insertFileFromBase64(base64File, insertLocation, insertFileOptions)
Fügt ein Dokument an einer bestimmten Position 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
Der Base64-codierte Inhalt einer .docx Datei.
Der Wert muss ,start oderend seinreplace.
- insertFileOptions
- Word.InsertFileOptions
Optional. Die zusätzlichen Eigenschaften, die in das Zieldokument importiert werden sollen.
Gibt zurück
Hinweise
API-Satz: WordApiHiddenDocument 1.5
Das Einfügen wird nicht unterstützt, wenn das einzufügende Dokument ein ActiveX-Steuerelement enthält (wahrscheinlich in einem Formularfeld). Erwägen Sie, ein solches Formularfeld durch ein Inhaltssteuerelement oder eine andere Option zu ersetzen, die für Ihr Szenario geeignet ist.
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 für die zu ladenden Eigenschaften des Objekts bereit.
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 Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas 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
save
Unterstützt nur
- 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 and-Parameter fileName wurden in WordApiHiddenDocument 1.5 eingeführt.
save(saveBehavior, fileName)
Speichert das Dokument.
save(saveBehavior?: "Save" | "Prompt", fileName?: string): void;Parameter
- saveBehavior
-
"Save" | "Prompt"
Optional.
DocumentCreated
save
Unterstützt nur
- 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 and-Parameter 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
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt 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 sie übergeben wird.) Während das ursprüngliche Word.DocumentCreated Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.DocumentCreatedData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts 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 aufrufübergreifend .sync 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 ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Sammlung ist, sollten Sie auch die übergeordnete Sammlung 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 einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.DocumentCreated;