Word.DocumentCreated class

Paket:

word

Das DocumentCreated-Objekt ist das Objekt der obersten Ebene, das von Application.CreateDocument erstellt wird. Ein DocumentCreated-Objekt ist ein spezielles Document-Objekt.

Extends

OfficeExtension.ClientObject

Hinweise

[ API-Satz: WordApi 1.3 ]

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 = 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();
});

Eigenschaften

body	Ruft das Textobjekt des Dokuments ab. Der Text ist der Text, der Kopfzeilen, Fußzeilen, Fußnoten, Textfelder usw. ausschließt.
contentControls	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.
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.

Methoden

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(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(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.
open()	Öffnet das Dokument.
save(saveBehavior, fileName)	Speichert das Dokument.
save(saveBehaviorString, fileName)	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 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.) Die ursprüngliche Word. DocumentCreated-Objekt ist ein API-Objekt. Die toJSON Methode gibt 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.
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.
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.

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

Word.Body

Hinweise

[ API-Satz: WordApiHiddenDocument 1.3 ]

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

Word.ContentControlCollection

Hinweise

[ API-Satz: WordApiHiddenDocument 1.3 ]

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

Word.RequestContext

properties

Ruft die Eigenschaften des Dokuments ab.

readonly properties: Word.DocumentProperties;

Eigenschaftswert

Word.DocumentProperties

Hinweise

[ API-Satz: WordApiHiddenDocument 1.3 ]

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

[ API-Satz: WordApiHiddenDocument 1.3 ]

sections

Ruft die Auflistung von Abschnittsobjekten im Dokument ab.

readonly sections: Word.SectionCollection;

Eigenschaftswert

Word.SectionCollection

Hinweise

[ API-Satz: WordApiHiddenDocument 1.3 ]

Details zur Methode

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

options

Word.Interfaces.DocumentCreatedLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Word.DocumentCreated

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

Word.DocumentCreated

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

Word.DocumentCreated

open()

Öffnet das Dokument.

open(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

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.) Die ursprüngliche Word. DocumentCreated-Objekt ist ein API-Objekt. Die toJSON Methode gibt 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

Word.Interfaces.DocumentCreatedData

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

Word.DocumentCreated

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

Word.DocumentCreated