Word. Document class

Eigenschaften

body	Ruft das Textobjekt des Standard Dokuments ab. Der Text ist der Text, der Kopfzeilen, Fußzeilen, Fußnoten, Textfelder usw. ausschließt.
changeTrackingMode	Gibt den ChangeTracking-Modus an.
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.
customXmlParts	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

addStyle(name, type)	Fügt dem Dokument eine Formatvorlage nach Name und Typ hinzu.
addStyle(name, typeString)	Fügt dem Dokument eine Formatvorlage nach Name und Typ hinzu.
close(closeBehavior)	Schließt das aktuelle Dokument.
close(closeBehaviorString)	Schließt das aktuelle Dokument.
deleteBookmark(name)	Löscht ein Lesezeichen aus dem Dokument, sofern vorhanden.
getAnnotationById(id)	Ruft die Anmerkung nach ID ab. Löst einen Fehler aus `ItemNotFound` , wenn die Anmerkung nicht gefunden wird.
getBookmarkRange(name)	Ruft den Bereich eines Lesezeichens ab. Löst einen Fehler aus `ItemNotFound` , wenn das Lesezeichen nicht vorhanden ist.
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 `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getContentControls(options)	Ruft die derzeit unterstützten Inhaltssteuerelemente im Dokument ab.
getEndnoteBody()	Ruft die Endnoten des Dokuments in einem einzelnen Text ab.
getFootnoteBody()	Ruft die Fußnoten des Dokuments in einem einzelnen Text ab.
getParagraphByUniqueLocalId(id)	Ruft den Absatz anhand seiner eindeutigen lokalen ID ab. Löst einen Fehler aus `ItemNotFound` , wenn die Auflistung leer ist.
getSelection()	Ruft die aktuelle Auswahl des Dokuments ab. Mehrfachauswahl wird nicht unterstützt.
getStyles()	Ruft ein StyleCollection-Objekt ab, das den gesamten Formatvorlagensatz des Dokuments darstellt.
importStylesFromJson(stylesJson)	Importieren von Formatvorlagen aus einer JSON-formatierten Zeichenfolge.
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.
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.
save(saveBehavior, fileName)	Speichert das Dokument.
save(saveBehaviorString, fileName)	Speichert das Dokument.
search(searchText, searchOptions)	Führt eine Suche mit den angegebenen Suchoptionen für den Bereich des gesamten Dokuments aus. Die Suchergebnisse sind eine Sammlung von Bereichsobjekten.
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.stringify`ruft wiederum die `toJSON` -Methode des Objekts auf, das an das Objekt übergeben wird.) Die ursprüngliche Word. Document-Objekt ist ein API-Objekt, die `toJSON` Methode gibt 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.
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.

Ereignisse

onAnnotationClicked	Tritt auf, wenn der Benutzer auf eine Anmerkung klickt (oder sie mit ALT+NACH-UNTEN auswählt).
onAnnotationHovered	Tritt auf, wenn der Benutzer mit dem Mauszeiger auf eine Anmerkung zeigt.
onAnnotationInserted	Tritt auf, wenn der Benutzer eine oder mehrere Anmerkungen hinzufügt.
onAnnotationRemoved	Tritt auf, wenn der Benutzer eine oder mehrere Anmerkungen löscht.
onContentControlAdded	Tritt auf, wenn ein Inhaltssteuerelement hinzugefügt wird. Führen Sie context.sync() im Handler aus, um die Eigenschaften des neuen Inhaltssteuerelements abzurufen.
onParagraphAdded	Tritt ein, wenn der Benutzer neue Absätze hinzufügt.
onParagraphChanged	Tritt auf, wenn der Benutzer Absätze ändert.
onParagraphDeleted	Tritt auf, wenn der Benutzer Absätze löscht.

Details zur Eigenschaft

body

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

Word.Body

Hinweise

changeTrackingMode

Gibt den ChangeTracking-Modus an.

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

Eigenschaftswert

Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"

Hinweise

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

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

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

customXmlParts

Ruft die benutzerdefinierten XML-Teile im Dokument ab.

readonly customXmlParts: Word.CustomXmlPartCollection;

Eigenschaftswert

Word.CustomXmlPartCollection

Hinweise

properties

Ruft die Eigenschaften des Dokuments ab.

readonly properties: Word.DocumentProperties;

Eigenschaftswert

Word.DocumentProperties

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

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

Word.SectionCollection

Hinweise

settings

Ruft die Einstellungen des Add-Ins im Dokument ab.

readonly settings: Word.SettingCollection;

Eigenschaftswert

Word.SettingCollection

Hinweise

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

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

Word.Style

Hinweise

Beispiele

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

// Adds a new style.
await Word.run(async (context) => {
  const newStyleName = $("#new-style-name").val() as string;
  if (newStyleName == "") {
    console.warn("Enter a style name to add.");
    return;
  }

  const style = context.document.getStyles().getByNameOrNullObject(newStyleName);
  style.load();
  await context.sync();

  if (!style.isNullObject) {
    console.warn(
      `There's an existing style with the same name '${newStyleName}'! Please provide another style name.`
    );
    return;
  }

  const newStyleType = ($("#new-style-type").val() as unknown) as Word.StyleType;
  context.document.addStyle(newStyleName, newStyleType);
  await context.sync();
  
  console.log(newStyleName + " has been added to the style list.");
});

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

Word.Style

Hinweise

close(closeBehavior)

Schließt das aktuelle Dokument.

close(closeBehavior?: Word.CloseBehavior): void;

Parameter

closeBehavior: Word.CloseBehavior

Optional. Das Schließverhalten muss "Speichern" oder "SkipSave" sein. Der Standardwert ist "Speichern".

Gibt zurück

void

Hinweise

Beispiele

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

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

close(closeBehaviorString)

Schließt das aktuelle Dokument.

close(closeBehaviorString?: "Save" | "SkipSave"): void;

Parameter

closeBehaviorString: "Save" | "SkipSave"

Optional. Das Schließverhalten muss "Speichern" oder "SkipSave" sein. Der Standardwert ist "Speichern".

Gibt zurück

void

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

getAnnotationById(id)

Ruft die Anmerkung nach ID ab. Löst einen Fehler aus ItemNotFound , wenn die Anmerkung nicht gefunden wird.

getAnnotationById(id: string): Word.Annotation;

Parameter

id: string

Die ID der abzurufenden Anmerkung.

Gibt zurück

Word.Annotation

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

Word.Range

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.

Gibt zurück

Word.Range

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

Word.ContentControlCollection

Hinweise

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.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-checkbox-content-control.yaml

// Toggles the isChecked property on all checkbox content controls.
await Word.run(async (context) => {
  let contentControls = context.document.getContentControls({
    types: [Word.ContentControlType.checkBox]
  });
  contentControls.load("items");

  await context.sync();

  const length = contentControls.items.length;
  console.log(`Number of checkbox content controls: ${length}`);

  if (length <= 0) {
    return;
  }

  const checkboxContentControls = [];
  for (let i = 0; i < length; i++) {
    let contentControl = contentControls.items[i];
    contentControl.load("id,checkboxContentControl/isChecked");
    checkboxContentControls.push(contentControl);
  }

  await context.sync();

  console.log("isChecked state before:");
  const updatedCheckboxContentControls = [];
  for (let i = 0; i < checkboxContentControls.length; i++) {
    const currentCheckboxContentControl = checkboxContentControls[i];
    const isCheckedBefore = currentCheckboxContentControl.checkboxContentControl.isChecked;
    console.log(`id: ${currentCheckboxContentControl.id} ... isChecked: ${isCheckedBefore}`);

    currentCheckboxContentControl.checkboxContentControl.isChecked = !isCheckedBefore;
    currentCheckboxContentControl.load("id,checkboxContentControl/isChecked");
    updatedCheckboxContentControls.push(currentCheckboxContentControl);
  }

  await context.sync();

  console.log("isChecked state after:");
  for (let i = 0; i < updatedCheckboxContentControls.length; i++) {
    const currentCheckboxContentControl = updatedCheckboxContentControls[i];
    console.log(
      `id: ${currentCheckboxContentControl.id} ... isChecked: ${currentCheckboxContentControl.checkboxContentControl.isChecked}`
    );
  }
});

getEndnoteBody()

Ruft die Endnoten des Dokuments in einem einzelnen Text ab.

getEndnoteBody(): Word.Body;

Gibt zurück

Word.Body

Hinweise

getFootnoteBody()

Ruft die Fußnoten des Dokuments in einem einzelnen Text ab.

getFootnoteBody(): Word.Body;

Gibt zurück

Word.Body

Hinweise

getParagraphByUniqueLocalId(id)

Ruft den Absatz anhand seiner eindeutigen lokalen ID ab. Löst einen Fehler aus ItemNotFound , wenn die Auflistung leer ist.

getParagraphByUniqueLocalId(id: string): Word.Paragraph;

Parameter

id: string

Erforderlich. Eindeutige lokale ID im STANDARD-GUID-Format 8-4-4-4-12 ohne geschweifte Klammern. Beachten Sie, dass sich die ID zwischen Sitzungen und Mitautoren unterscheidet.

Gibt zurück

Word.Paragraph

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onadded-event.yaml

await Word.run(async (context) => {
  const paragraphId = $("#paragraph-id").val() as string;
  const paragraph = context.document.getParagraphByUniqueLocalId(paragraphId);
  paragraph.load();
  await paragraph.context.sync();

  console.log(paragraph);
});

getSelection()

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

getSelection(): Word.Range;

Gibt zurück

Word.Range

Hinweise

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.');
});

getStyles()

Ruft ein StyleCollection-Objekt ab, das den gesamten Formatvorlagensatz des Dokuments darstellt.

getStyles(): Word.StyleCollection;

Gibt zurück

Word.StyleCollection

Hinweise

Beispiele

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

// Gets the number of styles.
await Word.run(async (context) => {
  const styles = context.document.getStyles();
  const count = styles.getCount();
  await context.sync();

  console.log(`Number of styles: ${count.value}`);
});

importStylesFromJson(stylesJson)

Importieren von Formatvorlagen aus einer JSON-formatierten Zeichenfolge.

importStylesFromJson(stylesJson: string): OfficeExtension.ClientResult<string[]>;

Parameter

stylesJson: string

Erforderlich. Eine JSON-formatierte Zeichenfolge, die die Stile darstellt.

Gibt zurück

OfficeExtension.ClientResult<string[]>

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/manage-custom-style.yaml

// Imports styles from JSON.
await Word.run(async (context) => {
  const str =
    '{"styles":[{"baseStyle":"Default Paragraph Font","builtIn":false,"inUse":true,"linked":false,"nameLocal":"NewCharStyle","priority":2,"quickStyle":true,"type":"Character","unhideWhenUsed":false,"visibility":false,"paragraphFormat":null,"font":{"name":"DengXian Light","size":16.0,"bold":true,"italic":false,"color":"#F1A983","underline":"None","subscript":false,"superscript":true,"strikeThrough":true,"doubleStrikeThrough":false,"highlightColor":null,"hidden":false},"shading":{"backgroundPatternColor":"#FF0000"}},{"baseStyle":"Normal","builtIn":false,"inUse":true,"linked":false,"nextParagraphStyle":"NewParaStyle","nameLocal":"NewParaStyle","priority":1,"quickStyle":true,"type":"Paragraph","unhideWhenUsed":false,"visibility":false,"paragraphFormat":{"alignment":"Centered","firstLineIndent":0.0,"keepTogether":false,"keepWithNext":false,"leftIndent":72.0,"lineSpacing":18.0,"lineUnitAfter":0.0,"lineUnitBefore":0.0,"mirrorIndents":false,"outlineLevel":"OutlineLevelBodyText","rightIndent":72.0,"spaceAfter":30.0,"spaceBefore":30.0,"widowControl":true},"font":{"name":"DengXian","size":14.0,"bold":true,"italic":true,"color":"#8DD873","underline":"Single","subscript":false,"superscript":false,"strikeThrough":false,"doubleStrikeThrough":true,"highlightColor":null,"hidden":false},"shading":{"backgroundPatternColor":"#00FF00"}},{"baseStyle":"Table Normal","builtIn":false,"inUse":true,"linked":false,"nextParagraphStyle":"NewTableStyle","nameLocal":"NewTableStyle","priority":100,"type":"Table","unhideWhenUsed":false,"visibility":false,"paragraphFormat":{"alignment":"Left","firstLineIndent":0.0,"keepTogether":false,"keepWithNext":false,"leftIndent":0.0,"lineSpacing":12.0,"lineUnitAfter":0.0,"lineUnitBefore":0.0,"mirrorIndents":false,"outlineLevel":"OutlineLevelBodyText","rightIndent":0.0,"spaceAfter":0.0,"spaceBefore":0.0,"widowControl":true},"font":{"name":"DengXian","size":20.0,"bold":false,"italic":true,"color":"#D86DCB","underline":"None","subscript":false,"superscript":false,"strikeThrough":false,"doubleStrikeThrough":false,"highlightColor":null,"hidden":false},"tableStyle":{"allowBreakAcrossPage":true,"alignment":"Left","bottomCellMargin":0.0,"leftCellMargin":0.08,"rightCellMargin":0.08,"topCellMargin":0.0,"cellSpacing":0.0},"shading":{"backgroundPatternColor":"#60CAF3"}}]}';
  const styles = context.document.importStylesFromJson(str);
  await context.sync();
  console.log("Styles imported from JSON:", styles);
});

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.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

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

Word.SectionCollection

Hinweise

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.

Beispiele

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

// Inserts content (applying selected settings) 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.
  context.document.insertFileFromBase64(externalDocument, "Replace", {
    importTheme: true,
    importStyles: true,
    importParagraphSpacing: true,
    importPageColor: true,
    importChangeTrackingMode: true,
    importCustomProperties: true,
    importCustomXmlParts: true,
    importDifferentOddEvenPages: true
  });
  await context.sync();
});

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

Parameter

options: Word.Interfaces.DocumentLoadOptions

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

Gibt zurück

Word.Document

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.');
    }
});

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

Parameter

propertyNames: string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Word.Document

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

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

save(saveBehavior, fileName)

Speichert das Dokument.

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

Parameter

saveBehavior: Word.SaveBehavior

Optional. Das Speicherverhalten muss "Speichern" oder "Eingabeaufforderung" sein. Der Standardwert ist "Speichern".

fileName: string

Optional. Der Dateiname (Dateierweiterung ausschließen). Wird nur für ein neues Dokument wirksam.

Gibt zurück

void

Hinweise

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

save(saveBehaviorString, fileName)

Speichert das Dokument.

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

Parameter

saveBehaviorString: "Save" | "Prompt"

Optional. Das Speicherverhalten muss "Speichern" oder "Eingabeaufforderung" sein. Der Standardwert ist "Speichern".

fileName: string

Optional. Der Dateiname (Dateierweiterung ausschließen). Wird nur für ein neues Dokument wirksam.

Gibt zurück

void

Hinweise

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

search(searchText, searchOptions)

Führt eine Suche mit den angegebenen Suchoptionen für den Bereich des gesamten Dokuments aus. Die Suchergebnisse sind eine Sammlung von Bereichsobjekten.

search(searchText: string, searchOptions?: Word.SearchOptions | {
            ignorePunct?: boolean;
            ignoreSpace?: boolean;
            matchCase?: boolean;
            matchPrefix?: boolean;
            matchSuffix?: boolean;
            matchWholeWord?: boolean;
            matchWildcards?: boolean;
        }): Word.RangeCollection;

Parameter

searchText: string

searchOptions: Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }

Gibt zurück

Word.RangeCollection

Hinweise

OfficeExtension.EventHandlers<Word.AnnotationClickedEventArgs>

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

Parameter

properties: Word.Interfaces.DocumentUpdateData

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

Parameter

properties: Word.Document

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. Document-Objekt ist ein API-Objekt, die toJSON Methode gibt 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

Word.Interfaces.DocumentData

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

Gibt zurück

Word.Document

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

Gibt zurück

Word.Document

Details zum Ereignis

onAnnotationClicked

Tritt auf, wenn der Benutzer auf eine Anmerkung klickt (oder sie mit ALT+NACH-UNTEN auswählt).

readonly onAnnotationClicked: OfficeExtension.EventHandlers<Word.AnnotationClickedEventArgs>;

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Word.AnnotationHoveredEventArgs>

onAnnotationHovered

Tritt auf, wenn der Benutzer mit dem Mauszeiger auf eine Anmerkung zeigt.

readonly onAnnotationHovered: OfficeExtension.EventHandlers<Word.AnnotationHoveredEventArgs>;

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Word.AnnotationInsertedEventArgs>

onAnnotationInserted

Tritt auf, wenn der Benutzer eine oder mehrere Anmerkungen hinzufügt.

readonly onAnnotationInserted: OfficeExtension.EventHandlers<Word.AnnotationInsertedEventArgs>;

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Word.AnnotationRemovedEventArgs>

onAnnotationRemoved

Tritt auf, wenn der Benutzer eine oder mehrere Anmerkungen löscht.

readonly onAnnotationRemoved: OfficeExtension.EventHandlers<Word.AnnotationRemovedEventArgs>;

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Word.ContentControlAddedEventArgs>

onContentControlAdded

Tritt auf, wenn ein Inhaltssteuerelement hinzugefügt wird. Führen Sie context.sync() im Handler aus, um die Eigenschaften des neuen Inhaltssteuerelements abzurufen.

readonly onContentControlAdded: OfficeExtension.EventHandlers<Word.ContentControlAddedEventArgs>;

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Word.ParagraphAddedEventArgs>

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/content-control-onadded-event.yaml

// Registers the onAdded event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onContentControlAdded.add(contentControlAdded);
  await context.sync();

  console.log("Added event handler for when content controls are added.");
});

...

async function contentControlAdded(event: Word.ContentControlAddedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.eventType} event detected. IDs of content controls that were added:`, event.ids);
  });
}

onParagraphAdded

Tritt ein, wenn der Benutzer neue Absätze hinzufügt.

readonly onParagraphAdded: OfficeExtension.EventHandlers<Word.ParagraphAddedEventArgs>;

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Word.ParagraphChangedEventArgs>

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onadded-event.yaml

// Registers the onParagraphAdded event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onParagraphAdded.add(paragraphAdded);
  await context.sync();

  console.log("Added event handler for when paragraphs are added.");
});

...

async function paragraphAdded(event: Word.ParagraphAddedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.type} event detected. IDs of paragraphs that were added:`, event.uniqueLocalIds);
  });
}

onParagraphChanged

Tritt auf, wenn der Benutzer Absätze ändert.

readonly onParagraphChanged: OfficeExtension.EventHandlers<Word.ParagraphChangedEventArgs>;

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Word.ParagraphDeletedEventArgs>

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onchanged-event.yaml

// Registers the onParagraphChanged event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onParagraphChanged.add(paragraphChanged);
  await context.sync();

  console.log("Added event handler for when content is changed in paragraphs.");
});

...

async function paragraphChanged(event: Word.ParagraphChangedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.type} event detected. IDs of paragraphs where content was changed:`, event.uniqueLocalIds);
  });
}

onParagraphDeleted

Tritt auf, wenn der Benutzer Absätze löscht.

readonly onParagraphDeleted: OfficeExtension.EventHandlers<Word.ParagraphDeletedEventArgs>;

Ereignistyp

Hinweise