Word.Document class

Ruft das Textobjekt des Standard Dokuments ab. Der Text ist der Text, der Kopfzeilen, Fußzeilen, Fußnoten, Textfelder usw. ausschließt.

readonly body: Word.Body;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.1 ]

Gibt den ChangeTracking-Modus an.

changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.4 ]

Beispiele

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

// Gets the current change tracking mode.
await Word.run(async (context) => {
  const document: Word.Document = context.document;
  document.load("changeTrackingMode");
  await context.sync();

  if (document.changeTrackingMode === Word.ChangeTrackingMode.trackMineOnly) {
    console.log("Only my changes are being tracked.");
  } else if (document.changeTrackingMode === Word.ChangeTrackingMode.trackAll) {
    console.log("Everyone's changes are being tracked.");
  } else {
    console.log("No changes are being tracked.");
  }
});

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

[ API-Satz: WordApi 1.1 ]

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Ruft die benutzerdefinierten XML-Teile im Dokument ab.

readonly customXmlParts: Word.CustomXmlPartCollection;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.4 ]

Ruft die Eigenschaften des Dokuments ab.

readonly properties: Word.DocumentProperties;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.3 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/get-built-in-properties.yaml

await Word.run(async (context) => {
    const builtInProperties: Word.DocumentProperties = context.document.properties;
    builtInProperties.load("*"); // Let's get all!

    await context.sync();
    console.log(JSON.stringify(builtInProperties, null, 4));
});

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

Hinweise

[ API-Satz: WordApi 1.1 ]

Ruft die Auflistung von Abschnittsobjekten im Dokument ab.

readonly sections: Word.SectionCollection;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.1 ]

Ruft die Einstellungen des Add-Ins im Dokument ab.

readonly settings: Word.SettingCollection;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.4 ]

Beispiele

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

// Gets all custom settings this add-in set on this document.
await Word.run(async (context) => {
  const settings: Word.SettingCollection = context.document.settings;
  settings.load("items");
  await context.sync();

  if (settings.items.length == 0) {
    console.log("There are no settings.");
  } else {
    console.log("All settings:");
    for (let i = 0; i < settings.items.length; i++) {
      console.log(settings.items[i]);
    }
  }
});

Löscht ein Lesezeichen aus dem Dokument, sofern vorhanden.

deleteBookmark(name: string): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.4 ]

Ruft den Bereich eines Lesezeichens ab. Löst einen Fehler aus ItemNotFound , wenn das Lesezeichen nicht vorhanden ist.

getBookmarkRange(name: string): Word.Range;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.4 ]

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

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.4 ]

Ruft die aktuelle Auswahl des Dokuments ab. Mehrfachauswahl wird nicht unterstützt.

getSelection(): Word.Range;

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.1 ]

Beispiele

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    const textSample = 'This is an example of the insert text method. This is a method ' + 
        'which allows users to insert text into a selection. It can insert text into a ' +
        'relative location or it can overwrite the current selection. Since the ' +
        'getSelection method returns a range object, look up the range object documentation ' +
        'for everything you can do with a selection.';
    
    // Create a range proxy object for the current selection.
    const range = context.document.getSelection();
    
    // Queue a command to insert text at the end of the selection.
    range.insertText(textSample, Word.InsertLocation.end);
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Inserted the text at the end of the selection.');
});  

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.DocumentLoadOptions): Word.Document;

Parameter

Gibt zurück

Beispiele

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the document.
    const thisDocument = context.document;
    
    // Queue a command to load content control properties.
    thisDocument.load('contentControls/id, contentControls/text, contentControls/tag');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (thisDocument.contentControls.items.length !== 0) {
        for (let i = 0; i < thisDocument.contentControls.items.length; i++) {
            console.log(thisDocument.contentControls.items[i].id);
            console.log(thisDocument.contentControls.items[i].text);
            console.log(thisDocument.contentControls.items[i].tag);
        }
    } else {
        console.log('No content controls in this document.');
    }
});

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.Document;

Parameter

Gibt zurück

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.Document;

Parameter

Gibt zurück

Speichert das Dokument.

save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.1 ]

Hinweis: Die saveBehavior Parameter und fileName wurden in WordApi 1.5 eingeführt.

Beispiele

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the document.
    const thisDocument = context.document;

    // Queue a command to load the document save state (on the saved property).
    thisDocument.load('saved');    
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
        
    if (thisDocument.saved === false) {
        // Queue a command to save this document.
        thisDocument.save();
        
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Saved the document');
    } else {
        console.log('The document has not changed since the last save.');
    }
});

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

// Saves the document with default behavior
// for current state of the document.
await Word.run(async (context) => {
  context.document.save();
  await context.sync();
});

Speichert das Dokument.

save(saveBehaviorString?: "Save" | "Prompt", fileName?: string): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.1 ]

Hinweis: Die saveBehavior Parameter und fileName wurden in WordApi 1.5 eingeführt.

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.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

Gibt zurück

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Word.Document): void;

Parameter

Gibt zurück

Ü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.Document Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.DocumentData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Word.Interfaces.DocumentData;

Gibt zurück

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.Document;

Gibt zurück

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.Document;

Gibt zurück