Word. Document class

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

Eigenschaften

activeTheme	Ruft den Namen des aktiven Designs und der Formatierungsoptionen ab.
activeThemeDisplayName	Ruft den Anzeigenamen des aktiven Designs ab.
activeWindow	Ruft das aktive Fenster für das Dokument ab.
areFilePropertiesPasswordEncrypted	Ruft ab, ob Word Dateieigenschaften für kennwortgeschützte Dokumente verschlüsselt.
areGrammaticalErrorsShown	Gibt an, ob Grammatikfehler im Dokument durch eine wellenförmige grüne Linie gekennzeichnet sind.
areMathDefaultsUsed	Gibt an, ob beim Erstellen neuer Formeln die mathematischen Standardeinstellungen verwendet werden sollen.
areNewerFeaturesDisabled	Gibt an, ob Features deaktiviert werden sollen, die nach einer angegebenen Version eingeführt wurden.
areSpellingErrorsShown	Gibt an, ob Microsoft Word Rechtschreibfehler im Dokument unterstreicht.
areStylesUpdatedOnOpen	Gibt an, ob die Formatvorlagen in diesem Dokument bei jedem Öffnen des Dokuments so aktualisiert werden, dass sie mit den Formatvorlagen in der angefügten Vorlage übereinstimmen.
areTrueTypeFontsEmbedded	Gibt an, ob Microsoft Word TrueType-Schriftarten beim Speichern in das Dokument einbettet.
attachedTemplate	Gibt ein `Template` -Objekt an, das die an das Dokument angefügte Vorlage darstellt.
autoHyphenation	Gibt an, ob die automatische Silbentrennung für das Dokument aktiviert ist.
autoSaveOn	Gibt an, ob die Bearbeitungen im Dokument automatisch gespeichert werden.
background	Ruft ein `Shape` -Objekt ab, das das Hintergrundbild für das Dokument darstellt.
bibliography	Gibt ein `Bibliography` -Objekt zurück, das die im Dokument enthaltenen Literaturverzeichnisverweise darstellt.
body	Ruft das `Body` -Objekt des Hauptdokuments ab. Der Text ist der Text, der Kopfzeilen, Fußzeilen, Fußnoten, Textfelder usw. ausschließt.
bookmarks	Gibt ein `BookmarkCollection` -Objekt zurück, das alle Lesezeichen im Dokument darstellt.
builtInDocumentProperties	Ruft ein `DocumentProperties` -Objekt ab, das alle integrierten Dokumenteigenschaften für das Dokument darstellt.
changeTrackingMode	Gibt den ChangeTracking-Modus an.
characters	Ruft das `RangeScopedCollection` -Objekt ab, das alle Zeichen im Dokument darstellt.
coauthoring	Ruft ein `Coauthoring` -Objekt zum Verwalten der gemeinsamen Dokumenterstellung im Dokument ab.
codeName	Ruft den Codenamen für das Dokument ab.
comments	Ruft ein `CommentCollection` -Objekt ab, das alle Kommentare im Dokument darstellt.
compatibilityMode	Ruft den Kompatibilitätsmodus ab, den Word beim Öffnen des Dokuments verwendet.
consecutiveHyphensLimit	Gibt die maximale Anzahl aufeinanderfolgender Zeilen an, die mit Bindestrichen enden können.
content	Ruft ein `Range` -Objekt ab, das den Hauptdokumentverlauf darstellt.
contentControls	Ruft die Auflistung von `ContentControl` -Objekten 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.
currentRsid	Ruft eine Zufallszahl ab, die Word Änderungen im Dokument zuweist.
customDocumentProperties	Ruft eine `DocumentProperties` Auflistung ab, die alle benutzerdefinierten Dokumenteigenschaften für das Dokument darstellt.
customXmlParts	Ruft die benutzerdefinierten XML-Teile im Dokument ab.
defaultTabStop	Gibt das Intervall (in Punkt) zwischen den Standardregisterstopps im Dokument an.
defaultTargetFrame	Gibt den Browserframe zum Anzeigen einer Webseite per Link an.
documentLibraryVersions	Gibt ein `DocumentLibraryVersionCollection` -Objekt zurück, das die Auflistung von Versionen eines freigegebenen Dokuments darstellt, für das die Versionsverwaltung aktiviert ist und das in einer Dokumentbibliothek auf einem Server gespeichert ist.
doNotEmbedSystemFonts	Gibt an, ob Word allgemeine Systemschriftarten nicht einbetten sollen.
encryptionProvider	Gibt den Namen des Algorithmusverschlüsselungsanbieters an, den Microsoft Word beim Verschlüsseln von Dokumenten verwendet.
farEastLineBreakLanguage	Gibt die für den Zeilenumbruch verwendete ostasiatische Sprache an.
farEastLineBreakLevel	Gibt die Steuerungsebene des Zeilenumbruchs an.
fields	Ruft ein `FieldCollection` -Objekt ab, das alle Felder im Dokument darstellt.
formattingIsNextLevelShown	Gibt an, ob Word die nächste Überschriftenebene anzeigt, wenn die vorherige verwendet wird.
formattingIsUserStyleNameShown	Gibt an, ob benutzerdefinierte Stile angezeigt werden sollen.
frames	Gibt ein `FrameCollection` -Objekt zurück, das alle Frames im Dokument darstellt.
fullName	Ruft den Namen eines Dokuments einschließlich des Pfads ab.
grammaticalErrors	Ruft ein `RangeCollection` -Objekt ab, das die Sätze darstellt, bei denen die Grammatikprüfung im Dokument fehlgeschlagen ist.
gridDistanceHorizontal	Gibt den horizontalen Abstand zwischen unsichtbaren Gitternetzlinien an, den Microsoft Word beim Zeichnen, Verschieben und Ändern der Größe von AutoFormen oder ostasiatischen Zeichen im Dokument verwendet.
gridDistanceVertical	Gibt den vertikalen Abstand zwischen unsichtbaren Gitternetzlinien an, den Microsoft Word beim Zeichnen, Verschieben und Ändern der Größe von AutoFormen oder ostasiatischen Zeichen im Dokument verwendet.
gridIsOriginFromMargin	Gibt an, ob das Zeichenraster in der oberen linken Ecke der Seite beginnt.
gridOriginHorizontal	Gibt den horizontalen Ursprungspunkt für das unsichtbare Raster an.
gridOriginVertical	Gibt den vertikalen Ursprungspunkt für das unsichtbare Raster an.
gridSpaceBetweenHorizontalLines	Gibt das Intervall für horizontale Zeichengitternetzlinien in der Drucklayoutansicht an.
gridSpaceBetweenVerticalLines	Gibt das Intervall für vertikale Zeichengitternetzlinien in der Drucklayoutansicht an.
hasPassword	Ruft ab, ob zum Öffnen des Dokuments ein Kennwort erforderlich ist.
hasVbProject	Ruft ab, ob das Dokument über ein angefügtes Microsoft Visual Basic for Applications-Projekt verfügt.
hyperlinks	Gibt ein `HyperlinkCollection` -Objekt zurück, das alle Links im Dokument darstellt.
hyphenateCaps	Gibt an, ob Wörter in Großbuchstaben mit Trennstrichen versehen werden können.
hyphenationZone	Gibt die Breite der Silbentrennungszone in Punkt an.
indexes	Gibt ein `IndexCollection` -Objekt zurück, das alle Indizes im Dokument darstellt.
isAutoFormatOverrideOn	Gibt an, ob automatische Formatierungsoptionen Formatierungseinschränkungen außer Kraft setzen.
isChartDataPointTracked	Gibt an, ob Diagramme im aktiven Dokument zellverweisbasierte Datenpunktnachverfolgung verwenden.
isCompatible	Gibt an, ob die von der `type` -Eigenschaft angegebene Kompatibilitätsoption aktiviert ist.
isFinal	Gibt an, ob das Dokument endgültig ist.
isFontsSubsetSaved	Gibt an, ob Microsoft Word eine Teilmenge der eingebetteten TrueType-Schriftarten mit dem Dokument speichert.
isFormsDataPrinted	Gibt an, ob Microsoft Word nur die in das entsprechende Onlineformular eingegebenen Daten auf einem vorgedruckten Formular druckt.
isFormsDataSaved	Gibt an, ob Microsoft Word die in ein Formular eingegebenen Daten als durch Tabstopps getrennten Datensatz für die Verwendung in einer Datenbank speichert.
isGrammarChecked	Gibt an, ob eine Grammatikprüfung für das Dokument ausgeführt wurde.
isInAutoSave	Ruft ab, ob das letzte Auslösen des `Application.DocumentBeforeSave` Ereignisses das Ergebnis einer automatischen Speicherung durch das Dokument oder einer manuellen Speicherung durch den Benutzer war.
isInFormsDesign	Ruft ab, ob sich das Dokument im Formularentwurfsmodus befindet.
isKerningByAlgorithm	Gibt an, ob Word lateinische Zeichen und Interpunktionszeichen mit halber Breite enthält.
isLinguisticDataEmbedded	Gibt an, ob Sprach- und Handschriftdaten eingebettet werden sollen.
isMasterDocument	Ruft ab, ob dieses Dokument ein master Dokument ist.
isOptimizedForWord97	Gibt an, ob Word das Dokument für Word 97 optimiert.
isPostScriptPrintedOverText	Gibt an, ob PRINT-Feldanweisungen (z. B. PostScript-Befehle) im Dokument über Text und Grafiken gedruckt werden sollen, wenn ein PostScript-Drucker verwendet wird.
isQuickStyleSetLocked	Gibt an, ob Benutzer den Schnellformatvorlagensatz ändern können.
isReadOnly	Ruft ab, ob Änderungen am Dokument nicht im Originaldokument gespeichert werden können.
isReadOnlyRecommended	Gibt an, ob Microsoft Word ein Meldungsfeld anzeigt, wenn ein Benutzer das Dokument öffnet und vorschlägt, dass es schreibgeschützt geöffnet wird.
isSnappedToGrid	Gibt an, ob AutoFormen oder ostasiatische Zeichen automatisch an einem unsichtbaren Raster ausgerichtet werden.
isSnappedToShapes	Gibt an, ob AutoFormen oder ostasiatische Zeichen an unsichtbaren Gitternetzlinien durch andere Formen ausgerichtet werden.
isSpellingChecked	Gibt an, ob die Rechtschreibung im gesamten Dokument überprüft wurde.
isStyleEnforced	Gibt an, ob Formatierungseinschränkungen in einem geschützten Dokument erzwungen werden.
isSubdocument	Ruft ab, ob dieses Dokument ein Unterdokument eines master Dokuments ist.
isThemeLocked	Gibt an, ob Benutzer das Dokumentdesign ändern können.
isUserControl	Gibt an, ob das Dokument vom Benutzer erstellt oder geöffnet wurde.
isVbaSigned	Ruft ab, ob das VBA-Projekt digital signiert ist.
isWriteReserved	Ruft ab, ob das Dokument mit einem Schreibkennwort geschützt ist.
justificationMode	Gibt die Anpassung des Zeichenabstands an.
kind	Gibt den Formattyp an, den Microsoft Word beim automatischen Formatieren des Dokuments verwendet.
languageDetected	Gibt an, ob Microsoft Word die Sprache des Dokumenttexts erkannt hat.
listParagraphs	Ruft ein `ParagraphCollection` -Objekt ab, das alle nummerierten Absätze im Dokument darstellt.
lists	Ruft ein `ListCollection` -Objekt ab, das alle formatierten Listen im Dokument enthält.
listTemplates	Gibt ein `ListTemplateCollection` -Objekt zurück, das alle Listenvorlagen im Dokument darstellt.
noLineBreakAfter	Gibt die Kinsoku-Zeichen an, nach denen Word keine Zeile durchbricht.
noLineBreakBefore	Gibt die Kinsoku-Zeichen an, vor denen Word keine Zeile umbricht.
openEncoding	Ruft die Codierung ab, die zum Öffnen des Dokuments verwendet wird.
originalDocumentTitle	Ruft den Titel des originalen Dokuments nach dem Vergleich zwischen Legal und Blackline ab.
pageSetup	Gibt ein `PageSetup` -Objekt zurück, das dem Dokument zugeordnet ist.
paragraphs	Ruft ein `ParagraphCollection` -Objekt ab, das alle Absätze im Dokument darstellt.
password	Legt ein Kennwort fest, das zum Öffnen des Dokuments angegeben werden muss.
passwordEncryptionAlgorithm	Ruft den algorithmus ab, der für die Kennwortverschlüsselung verwendet wird.
passwordEncryptionKeyLength	Ruft die Schlüssellänge ab, die für die Kennwortverschlüsselung verwendet wird.
passwordEncryptionProvider	Ruft den Namen des Kennwortverschlüsselungsanbieters ab.
path	Ruft den Datenträger oder den Webpfad zum Dokument ab (schließt den Dokumentnamen aus).
printRevisions	Gibt an, ob Revisionsmarkierungen mit dem Dokument gedruckt werden.
properties	Ruft die Eigenschaften des Dokuments ab.
protectionType	Ruft den Schutztyp für das Dokument ab.
readabilityStatistics	Ruft ein `ReadabilityStatisticCollection` -Objekt ab, das die Lesbarkeitsstatistiken für das Dokument darstellt.
readingLayoutSizeX	Gibt die Breite von Seiten in der Leselayoutansicht an, wenn sie fixiert sind.
readingLayoutSizeY	Gibt die Höhe von Seiten in der Leselayoutansicht an, wenn sie fixiert sind.
readingModeIsLayoutFrozen	Gibt an, ob Seiten in der Leselayoutansicht für handschriftliches Markup fixiert sind.
removePersonalInformationOnSave	Gibt an, ob Word Benutzerinformationen beim Speichern entfernt.
revisedDocumentTitle	Ruft den Titel des überarbeiteten Dokuments nach dem Vergleich zwischen Legal und Blackline ab.
revisions	Ruft die Auflistung von Revisionen ab, die die nachverfolgten Änderungen im Dokument darstellt.
saved	Gibt an, ob die Änderungen im Dokument gespeichert wurden. Der Wert `true` gibt an, dass sich das Dokument seit dem Speichern nicht geändert hat.
saveEncoding	Gibt die Codierung an, die beim Speichern des Dokuments verwendet wird.
saveFormat	Ruft das Dateiformat des Dokuments ab.
sections	Ruft die Auflistung von `Section` -Objekten im Dokument ab.
selection	Gibt ein `Selection` -Objekt zurück, das die aktuelle Auswahl im Dokument darstellt.
sentences	Ruft das `RangeScopedCollection` -Objekt ab, das alle Sätze im Dokument darstellt.
settings	Ruft die Einstellungen des Add-Ins im Dokument ab.
spellingErrors	Ruft ein `RangeCollection` -Objekt ab, das die Wörter darstellt, die im Dokument als Rechtschreibfehler identifiziert wurden.
storyRanges	Ruft ein `RangeCollection` -Objekt ab, das alle Storys im Dokument darstellt.
styles	Ruft eine `StyleCollection` für das Dokument ab.
tableOfAuthoritiesCategories	Gibt ein `TableOfAuthoritiesCategoryCollection` -Objekt zurück, das die verfügbaren Kategorien der Autoritätstabelle im Dokument darstellt.
tables	Ruft ein `TableCollection` -Objekt ab, das alle Tabellen im Dokument darstellt.
tablesOfAuthorities	Gibt ein `TableOfAuthoritiesCollection` -Objekt zurück, das alle Tabellen von Autoritäten im Dokument darstellt.
tablesOfContents	Gibt ein `TableOfContentsCollection` -Objekt zurück, das alle Inhaltsverzeichnisse im Dokument darstellt.
tablesOfFigures	Gibt ein `TableOfFiguresCollection` -Objekt zurück, das alle Abbildungstabellen im Dokument darstellt.
textEncoding	Gibt die Codierung zum Speichern als codierten Text an.
textLineEnding	Gibt an, wie Word Zeilen- und Absatzumbrüche in Textdateien markiert.
trackedChangesAreDateAndTimeRemoved	Gibt an, ob Datums- und Uhrzeitmetadaten für nachverfolgte Änderungen entfernt oder gespeichert werden sollen.
trackFormatting	Gibt an, ob Formatierungsänderungen nachverfolgt werden sollen, wenn die Änderungsnachverfolgung aktiviert ist.
trackMoves	Gibt an, ob verschobener Text markiert werden soll, wenn "Änderungen nachverfolgen" aktiviert ist.
trackRevisions	Gibt an, ob Änderungen im Dokument nachverfolgt werden.
type	Ruft den Dokumenttyp (Vorlage oder Dokument) ab.
webSettings	Ruft das `WebSettings` -Objekt für webseitenbezogene Attribute ab.
windows	Ruft die Auflistung von `Word.Window` -Objekten für das Dokument ab.
words	Ruft das `RangeScopedCollection` -Objekt ab, das jedes Wort im Dokument darstellt.
writePassword	Legt ein Kennwort zum Speichern von Änderungen am Dokument fest.
xmlAreAdvancedErrorsShown	Gibt an, ob Fehlermeldungen aus integrierten Word-Nachrichten oder MSXML (Microsoft XML) generiert werden.
xmlIsXsltUsedWhenSaving	Gibt an, ob ein Dokument über eine XSLT (Extensible Stylesheet Language Transformation) gespeichert werden soll.
xmlSaveThroughXslt	Gibt den Pfad und Dateinamen für die XSLT an, die beim Speichern eines Dokuments angewendet werden sollen.

Methoden

acceptAllRevisions()	Akzeptiert alle nachverfolgten Änderungen im Dokument.
acceptAllRevisionsShown()	Akzeptiert alle Überarbeitungen im Dokument, die auf dem Bildschirm angezeigt werden.
activate()	Aktiviert das Dokument, sodass es zum aktiven Dokument wird.
addStyle(name, type)	Fügt dem Dokument eine Formatvorlage nach Name und Typ hinzu.
addStyle(name, type)	Fügt dem Dokument eine Formatvorlage nach Name und Typ hinzu.
addToFavorites()	Erstellt eine Verknüpfung zum Dokument oder Link und fügt sie dem Ordner Favoriten hinzu.
applyQuickStyleSet(style)	Wendet den angegebenen Schnellformatvorlagen-Satz auf das Dokument an.
applyQuickStyleSet(style)	Wendet den angegebenen Schnellformatvorlagen-Satz auf das Dokument an.
applyTheme(name)	Wendet das angegebene Design auf dieses Dokument an.
autoFormat()	Formatiert das Dokument automatisch.
canCheckin()	Gibt zurück`true`, wenn Microsoft Word das Dokument auf einem Server einchecken kann.
checkConsistencyJapanese()	Durchsucht den gesamten Text in einem japanischen Dokument und zeigt Fälle an, bei denen für dasselbe Wort unterschiedliche Zeichen verwendet wurden.
checkGrammar()	Startet eine Rechtschreib- und Grammatikprüfung für das Dokument.
checkIn(options)	Checkt das Dokument vom lokalen Computer auf einen Server ein und legt das lokale Dokument auf schreibgeschützt fest, sodass es nicht lokal bearbeitet werden kann.
checkInWithVersion(options)	Speichert das Dokument von einem lokalen Computer auf einem Server und legt das lokale Dokument auf schreibgeschützt fest, sodass es nicht lokal bearbeitet werden kann.
checkSpelling(options)	Startet eine Rechtschreibprüfung für das Dokument.
close(closeBehavior)	Schließt das aktuelle Dokument. Hinweis: Diese API wird in Word im Web nicht unterstützt.
close(closeBehavior)	Schließt das aktuelle Dokument. Hinweis: Diese API wird in Word im Web nicht unterstützt.
closePrintPreview()	Wechselt das Dokument von der Druckvorschau zur vorherigen Ansicht.
compare(filePath, documentCompareOptions)	Zeigt Korrekturmarkierungen an, um hervorzuheben, an welchen Stellen das angegebene Dokument von einem anderen abweicht.
compareFromBase64(base64File, documentCompareOptions)	Zeigt Korrekturmarkierungen an, um hervorzuheben, an welchen Stellen das angegebene Dokument von einem anderen abweicht.
computeStatistics(statistic, includeFootnotesAndEndnotes)	Gibt eine Statistik zurück, die auf dem Inhalt des Dokuments basiert.
computeStatistics(statistic, includeFootnotesAndEndnotes)	Gibt eine Statistik zurück, die auf dem Inhalt des Dokuments basiert.
convert()	Konvertiert die Datei in das neueste Format und aktiviert alle Features.
convertAutoHyphens()	Konvertiert automatische Bindestriche in manuelle Bindestriche.
convertNumbersToText(numberType)	Ändert die Listennummern und LISTNUM-Felder im Dokument in Text.
convertNumbersToText(numberType)	Ändert die Listennummern und LISTNUM-Felder im Dokument in Text.
convertVietnameseDocument(codePageOrigin)	Konvertiert ein vietnamesisches Dokument wieder in Unicodetext. Dabei wird nicht der Standardcode, sondern eine andere Codepage verwendet.
copyStylesFromTemplate(StyleTemplate)	Kopiert Formatvorlagen aus der angegebenen Vorlage in das Dokument.
countNumberedItems(options)	Gibt die Anzahl von Aufzählungen oder nummerierten Elementen und LISTNUM-Feldern im Dokument zurück.
deleteAllComments()	Löscht alle Kommentare aus dem Dokument.
deleteAllCommentsShown()	Löscht alle Revisionen im Dokument, die auf dem Bildschirm angezeigt werden.
deleteAllInkAnnotations()	Löscht alle handschriftlichen Freihandanmerkungen im Dokument.
deleteBookmark(name)	Löscht ein Lesezeichen aus dem Dokument, sofern vorhanden.
detectLanguage()	Analysiert den Dokumenttext, um die Sprache zu bestimmen.
endReview(options)	Beendet eine Überprüfung der Datei, die zur Überprüfung gesendet wurde.
exportAsFixedFormat(outputFileName, exportFormat, options)	Speichert das Dokument im PDF- oder XPS-Format.
exportAsFixedFormat(outputFileName, exportFormat, options)	Speichert das Dokument im PDF- oder XPS-Format.
exportAsFixedFormat2(outputFileName, exportFormat, options)	Speichert das Dokument im PDF- oder XPS-Format.
exportAsFixedFormat2(outputFileName, exportFormat, options)	Speichert das Dokument im PDF- oder XPS-Format.
exportAsFixedFormat3(outputFileName, exportFormat, options)	Speichert das Dokument im PDF- oder XPS-Format mit verbesserter Kennzeichnung.
exportAsFixedFormat3(outputFileName, exportFormat, options)	Speichert das Dokument im PDF- oder XPS-Format mit verbesserter Kennzeichnung.
fitToPages()	Verringert den Schriftgrad des Texts gerade so, dass die Anzahl der Dokumentseiten um eins sinkt.
followHyperlink(options)	Zeigt ein Cachespeicher-Dokument an, wenn es bereits heruntergeladen wurde. Andernfalls löst diese Methode den Hyperlink auf, lädt das Zieldokument herunter und zeigt das Dokument in der entsprechenden Anwendung an.
freezeLayout()	Korrigiert das Layout des Dokuments in der Webansicht.
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.
getCrossReferenceItems(referenceType)	Gibt ein Array von Elementen zurück, auf die auf der Basis des angegebenen Querverweistyps verwiesen werden kann.
getCrossReferenceItems(referenceType)	Gibt ein Array von Elementen zurück, auf die auf der Basis des angegebenen Querverweistyps verwiesen werden kann.
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.
getRange(options)	Gibt ein `Range` -Objekt mithilfe der angegebenen Anfangs- und Endzeichenposition zurück.
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.
goTo(options)	Gibt ein `Range` -Objekt zurück, das die Anfangsposition des angegebenen Elements darstellt, z. B. eine Seite, ein Lesezeichen oder ein Feld.
importStylesFromJson(stylesJson, importedStylesConflictBehavior)	Importieren von Formatvorlagen aus einer JSON-formatierten Zeichenfolge.
importStylesFromJson(stylesJson, importedStylesConflictBehavior)	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.
lockServerFile()	Sperrt die Datei auf dem Server, sodass kein anderer Benutzer sie bearbeiten kann.
makeCompatibilityDefault()	Legt die Kompatibilitätsoptionen fest.
manualHyphenation()	Initiiert die manuelle Silbentrennung eines Dokuments für die einzelnen Zeilen.
merge(fileName, options)	Integriert die Änderungen, die in einem Dokument mit Korrekturmarkierungen gekennzeichnet wurden, in ein anderes Dokument.
post()	Stellt das Dokument in einem öffentlichen Ordner in Microsoft Exchange bereit.
presentIt()	Öffnet PowerPoint mit geladenem Word Dokument.
printOut(options)	Druckt das dokument ganz oder teilweise.
printPreview()	Wechselt die Ansicht zur Seitenansicht.
protect(type, options)	Schützt das Dokument vor nicht autorisierten Änderungen.
protect(type, options)	Schützt das Dokument vor nicht autorisierten Änderungen.
redo(times)	Wiederholt die letzte Aktion, die rückgängig gemacht wurde (kehrt die `undo` Methode um).
rejectAllRevisions()	Lehnt alle nachverfolgten Änderungen im Dokument ab.
rejectAllRevisionsShown()	Lehnt alle Überarbeitungen im Dokument ab, die auf dem Bildschirm angezeigt werden.
reload()	Lädt ein Dokument neu, das sich im Cachespeicher befindet, indem der Hyperlink zum ursprünglichen Dokument aufgelöst und dieses heruntergeladen wird.
reloadAs(encoding)	Lädt das Dokument basierend auf einem HTML-Dokument unter Verwendung der Dokumentcodierung neu.
reloadAs(encoding)	Lädt das Dokument basierend auf einem HTML-Dokument unter Verwendung der Dokumentcodierung neu.
removeDocumentInformation(removeDocInfoType)	Entfernt vertrauliche Informationen, Eigenschaften, Kommentare und andere Metadaten aus dem Dokument.
removeDocumentInformation(removeDocInfoType)	Entfernt vertrauliche Informationen, Eigenschaften, Kommentare und andere Metadaten aus dem Dokument.
removeLockedStyles()	Löscht das Dokument von gesperrten Formatvorlagen, wenn Formatierungseinschränkungen im Dokument angewendet wurden.
removeNumbers(numberType)	Entfernt Zahlen oder Aufzählungszeichen aus dem Dokument.
removeNumbers(numberType)	Entfernt Zahlen oder Aufzählungszeichen aus dem Dokument.
removeTheme()	Entfernt das aktive Design aus dem aktuellen Dokument.
repaginate()	Führt einen Seitenumbruch für das gesamte Dokument aus.
replyWithChanges(options)	Sendet eine E-Mail-Nachricht an den Autor des Dokuments, das zur Überprüfung gesendet wurde, und informiert ihn darüber, dass ein Prüfer die Überprüfung des Dokuments abgeschlossen hat.
resetFormFields()	Löscht alle Formularfelder im Dokument und bereitet das Formular vor, das erneut ausgefüllt werden soll.
returnToLastReadPosition()	Gibt das Dokument an die zuletzt gespeicherte Leseposition zurück.
runAutoMacro(autoMacro)	Führt ein automatisches Makro aus, das im Dokument gespeichert ist. Wenn das angegebene Automakro nicht vorhanden ist, passiert nichts.
runAutoMacro(autoMacro)	Führt ein automatisches Makro aus, das im Dokument gespeichert ist. Wenn das angegebene Automakro nicht vorhanden ist, passiert nichts.
save(saveBehavior, fileName)	Speichert das Dokument.
save(saveBehavior, fileName)	Speichert das Dokument.
saveAsQuickStyleSet(fileName)	Speichert den aktuell verwendeten Schnellformatvorlagen-Satz.
search(searchText, searchOptions)	Führt eine Suche mit den angegebenen Suchoptionen für den Bereich des gesamten Dokuments aus. Die Suchergebnisse sind eine Auflistung von `Range` -Objekten.
select()	Wählt den Inhalt des Dokuments aus.
selectContentControlsByTag(tag)	Gibt alle Inhaltssteuerelemente mit dem angegebenen Tag zurück.
selectContentControlsByTitle(title)	Gibt ein `ContentControlCollection` -Objekt zurück, das alle Inhaltssteuerelemente im Dokument mit dem angegebenen Titel darstellt.
selectLinkedControls(node)	Gibt ein `ContentControlCollection` -Objekt zurück, das alle Inhaltssteuerelemente im Dokument darstellt, die mit dem spezifischen benutzerdefinierten XML-Knoten verknüpft sind.
selectNodes(xPath, options)	Gibt ein `XmlNodeCollection` -Objekt zurück, das alle Knoten darstellt, die dem XPath-Parameter in der Reihenfolge entsprechen, in der sie im Dokument angezeigt werden.
selectSingleNode(xPath, options)	Gibt ein `XmlNode` -Objekt zurück, das den ersten Knoten darstellt, der dem XPath-Parameter im Dokument entspricht.
selectUnlinkedControls(stream)	Gibt ein `ContentControlCollection` -Objekt zurück, das alle Inhaltssteuerelemente im Dokument darstellt, die nicht mit einem XML-Knoten verknüpft sind.
sendFax(address, subject)	Sendet das Dokument ohne Benutzerinteraktion als Fax.
sendFaxOverInternet(options)	Sendet das Dokument an einen Faxdienstanbieter, der das Dokument an einen oder mehrere angegebene Empfänger faxt.
sendForReview(options)	Sendet das Dokument in einer E-Mail-Nachricht zur Überprüfung durch die angegebenen Empfänger.
sendMail()	Öffnet ein Nachrichtenfenster zum Senden des Dokuments über Microsoft Exchange.
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.
setDefaultTableStyle(style, setInTemplate)	Gibt die Tabellenformatvorlage an, die für neu erstellte Tabellen im Dokument verwendet werden soll.
setPasswordEncryptionOptions(passwordEncryptionProvider, passwordEncryptionAlgorithm, passwordEncryptionKeyLength, passwordEncryptFileProperties)	Legt die Optionen fest, die in Microsoft Word verwendet werden, um kennwortgeschützte Dokumente zu verschlüsseln.
toggleFormsDesign()	Schaltet den Formularentwurfsmodus ein oder aus.
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.) 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.
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.
transformDocument(path, dataOnly)	Wendet die angegebene XSLT-Datei (Extensible Stylesheet Language Transformation) auf dieses Dokument an und ersetzt das Dokument durch die Ergebnisse.
undo(times)	Macht die letzte Aktion oder eine Folge von Aktionen rückgängig, die in der Undo-Liste angezeigt werden.
undoClear()	Löscht die Liste der Aktionen, die im Dokument rückgängiggemacht werden können.
unprotect(password)	Entfernt den Schutz aus dem Dokument.
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.
updateStyles()	Kopiert alle Formatvorlagen aus der zugeordneten Dokumentvorlage in das Dokument, wobei vorhandene gleichnamige Formatvorlagen überschrieben werden.
viewCode()	Zeigt das Codefenster für das ausgewählte Microsoft ActiveX-Steuerelement im Dokument an.
viewPropertyBrowser()	Zeigt das Eigenschaftenfenster für das ausgewählte Microsoft ActiveX-Steuerelement im Dokument an.
webPagePreview()	Zeigt eine Vorschau des aktuellen Dokuments an, wie es aussehen würde, wenn es als Webseite gespeichert würde.

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.
onAnnotationPopupAction	Tritt auf, wenn der Benutzer eine Aktion in einem Popupmenü für Anmerkungen ausführt.
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

activeTheme

Ruft den Namen des aktiven Designs und der Formatierungsoptionen ab.

readonly activeTheme: string;

Eigenschaftswert

string

Hinweise

activeThemeDisplayName

Ruft den Anzeigenamen des aktiven Designs ab.

readonly activeThemeDisplayName: string;

Eigenschaftswert

string

Hinweise

activeWindow

Ruft das aktive Fenster für das Dokument ab.

readonly activeWindow: Word.Window;

Eigenschaftswert

Word.Window

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml

await Word.run(async (context) => {
  // Gets the first paragraph of each page.
  console.log("Getting first paragraph of each page...");

  // Get the active window.
  const activeWindow: Word.Window = context.document.activeWindow;
  activeWindow.load();

  // Get the active pane.
  const activePane: Word.Pane = activeWindow.activePane;
  activePane.load();

  // Get all pages.
  const pages: Word.PageCollection = activePane.pages;
  pages.load();

  await context.sync();

  // Get page index and paragraphs of each page.
  const pagesIndexes = [];
  const pagesNumberOfParagraphs = [];
  const pagesFirstParagraphText = [];
  for (let i = 0; i < pages.items.length; i++) {
    const page = pages.items[i];
    page.load("index");
    pagesIndexes.push(page);

    const paragraphs = page.getRange().paragraphs;
    paragraphs.load("items/length");
    pagesNumberOfParagraphs.push(paragraphs);

    const firstParagraph = paragraphs.getFirst();
    firstParagraph.load("text");
    pagesFirstParagraphText.push(firstParagraph);
  }

  await context.sync();

  for (let i = 0; i < pagesIndexes.length; i++) {
    console.log(`Page index: ${pagesIndexes[i].index}`);
    console.log(`Number of paragraphs: ${pagesNumberOfParagraphs[i].items.length}`);
    console.log("First paragraph's text:", pagesFirstParagraphText[i].text);
  }
});

areFilePropertiesPasswordEncrypted

Ruft ab, ob Word Dateieigenschaften für kennwortgeschützte Dokumente verschlüsselt.

readonly areFilePropertiesPasswordEncrypted: boolean;

Eigenschaftswert

boolean

Hinweise

areGrammaticalErrorsShown

Gibt an, ob Grammatikfehler im Dokument durch eine wellenförmige grüne Linie gekennzeichnet sind.

areGrammaticalErrorsShown: boolean;

Eigenschaftswert

boolean

Hinweise

areMathDefaultsUsed

Gibt an, ob beim Erstellen neuer Formeln die mathematischen Standardeinstellungen verwendet werden sollen.

areMathDefaultsUsed: boolean;

Eigenschaftswert

boolean

Hinweise

areNewerFeaturesDisabled

Gibt an, ob Features deaktiviert werden sollen, die nach einer angegebenen Version eingeführt wurden.

areNewerFeaturesDisabled: boolean;

Eigenschaftswert

boolean

Hinweise

areSpellingErrorsShown

Gibt an, ob Microsoft Word Rechtschreibfehler im Dokument unterstreicht.

areSpellingErrorsShown: boolean;

Eigenschaftswert

boolean

Hinweise

areStylesUpdatedOnOpen

Gibt an, ob die Formatvorlagen in diesem Dokument bei jedem Öffnen des Dokuments so aktualisiert werden, dass sie mit den Formatvorlagen in der angefügten Vorlage übereinstimmen.

areStylesUpdatedOnOpen: boolean;

Eigenschaftswert

boolean

Hinweise

areTrueTypeFontsEmbedded

Gibt an, ob Microsoft Word TrueType-Schriftarten beim Speichern in das Dokument einbettet.

areTrueTypeFontsEmbedded: boolean;

Eigenschaftswert

boolean

Hinweise

attachedTemplate

Gibt ein Template -Objekt an, das die an das Dokument angefügte Vorlage darstellt.

attachedTemplate: Word.Template;

Eigenschaftswert

Word.Template

Hinweise

autoHyphenation

Gibt an, ob die automatische Silbentrennung für das Dokument aktiviert ist.

autoHyphenation: boolean;

Eigenschaftswert

boolean

Hinweise

autoSaveOn

Gibt an, ob die Bearbeitungen im Dokument automatisch gespeichert werden.

autoSaveOn: boolean;

Eigenschaftswert

boolean

Hinweise

background

Ruft ein Shape -Objekt ab, das das Hintergrundbild für das Dokument darstellt.

readonly background: Word.Shape;

Eigenschaftswert

Word.Shape

Hinweise

bibliography

Gibt ein Bibliography -Objekt zurück, das die im Dokument enthaltenen Literaturverzeichnisverweise darstellt.

readonly bibliography: Word.Bibliography;

Eigenschaftswert

Word.Bibliography

Hinweise

body

Ruft das Body -Objekt des Hauptdokuments ab. Der Text ist der Text, der Kopfzeilen, Fußzeilen, Fußnoten, Textfelder usw. ausschließt.

readonly body: Word.Body;

Eigenschaftswert

Word.Body

Hinweise

bookmarks

Gibt ein BookmarkCollection -Objekt zurück, das alle Lesezeichen im Dokument darstellt.

readonly bookmarks: Word.BookmarkCollection;

Eigenschaftswert

Word.BookmarkCollection

Hinweise

builtInDocumentProperties

Ruft ein DocumentProperties -Objekt ab, das alle integrierten Dokumenteigenschaften für das Dokument darstellt.

readonly builtInDocumentProperties: Word.DocumentProperties;

Eigenschaftswert

Word.DocumentProperties

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

characters

Ruft das RangeScopedCollection -Objekt ab, das alle Zeichen im Dokument darstellt.

readonly characters: Word.RangeScopedCollection;

Eigenschaftswert

Word.RangeScopedCollection

Hinweise

coauthoring

Ruft ein Coauthoring -Objekt zum Verwalten der gemeinsamen Dokumenterstellung im Dokument ab.

readonly coauthoring: Word.Coauthoring;

Eigenschaftswert

Word.Coauthoring

Hinweise

codeName

Ruft den Codenamen für das Dokument ab.

readonly codeName: string;

Eigenschaftswert

string

Hinweise

comments

Ruft ein CommentCollection -Objekt ab, das alle Kommentare im Dokument darstellt.

readonly comments: Word.CommentCollection;

Eigenschaftswert

Word.CommentCollection

Hinweise

compatibilityMode

Ruft den Kompatibilitätsmodus ab, den Word beim Öffnen des Dokuments verwendet.

readonly compatibilityMode: Word.CompatibilityMode | "Word2003" | "Word2007" | "Word2010" | "Word2013" | "Current";

Eigenschaftswert

Hinweise

consecutiveHyphensLimit

Gibt die maximale Anzahl aufeinanderfolgender Zeilen an, die mit Bindestrichen enden können.

consecutiveHyphensLimit: number;

Eigenschaftswert

number

Hinweise

content

Ruft ein Range -Objekt ab, das den Hauptdokumentverlauf darstellt.

readonly content: Word.Range;

Eigenschaftswert

Word.Range

Hinweise

contentControls

Ruft die Auflistung von ContentControl -Objekten 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

currentRsid

Ruft eine Zufallszahl ab, die Word Änderungen im Dokument zuweist.

readonly currentRsid: number;

Eigenschaftswert

number

Hinweise

customDocumentProperties

Ruft eine DocumentProperties Auflistung ab, die alle benutzerdefinierten Dokumenteigenschaften für das Dokument darstellt.

readonly customDocumentProperties: Word.DocumentProperties;

Eigenschaftswert

Word.DocumentProperties

Hinweise

customXmlParts

Ruft die benutzerdefinierten XML-Teile im Dokument ab.

readonly customXmlParts: Word.CustomXmlPartCollection;

Eigenschaftswert

Word.CustomXmlPartCollection

Hinweise

defaultTabStop

Gibt das Intervall (in Punkt) zwischen den Standardregisterstopps im Dokument an.

defaultTabStop: number;

Eigenschaftswert

number

Hinweise

defaultTargetFrame

Gibt den Browserframe zum Anzeigen einer Webseite per Link an.

defaultTargetFrame: string;

Eigenschaftswert

string

Hinweise

documentLibraryVersions

Gibt ein DocumentLibraryVersionCollection -Objekt zurück, das die Auflistung von Versionen eines freigegebenen Dokuments darstellt, für das die Versionsverwaltung aktiviert ist und das in einer Dokumentbibliothek auf einem Server gespeichert ist.

readonly documentLibraryVersions: Word.DocumentLibraryVersionCollection;

Eigenschaftswert

Word.DocumentLibraryVersionCollection

Hinweise

doNotEmbedSystemFonts

Gibt an, ob Word allgemeine Systemschriftarten nicht einbetten sollen.

doNotEmbedSystemFonts: boolean;

Eigenschaftswert

boolean

Hinweise

encryptionProvider

Gibt den Namen des Algorithmusverschlüsselungsanbieters an, den Microsoft Word beim Verschlüsseln von Dokumenten verwendet.

encryptionProvider: string;

Eigenschaftswert

string

Hinweise

farEastLineBreakLanguage

Gibt die für den Zeilenumbruch verwendete ostasiatische Sprache an.

farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese";

Eigenschaftswert

Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"

Hinweise

farEastLineBreakLevel

Gibt die Steuerungsebene des Zeilenumbruchs an.

farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom";

Eigenschaftswert

Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"

Hinweise

fields

Ruft ein FieldCollection -Objekt ab, das alle Felder im Dokument darstellt.

readonly fields: Word.FieldCollection;

Eigenschaftswert

Word.FieldCollection

Hinweise

formattingIsNextLevelShown

Gibt an, ob Word die nächste Überschriftenebene anzeigt, wenn die vorherige verwendet wird.

formattingIsNextLevelShown: boolean;

Eigenschaftswert

boolean

Hinweise

formattingIsUserStyleNameShown

Gibt an, ob benutzerdefinierte Stile angezeigt werden sollen.

formattingIsUserStyleNameShown: boolean;

Eigenschaftswert

boolean

Hinweise

frames

Gibt ein FrameCollection -Objekt zurück, das alle Frames im Dokument darstellt.

readonly frames: Word.FrameCollection;

Eigenschaftswert

Word.FrameCollection

Hinweise

fullName

Ruft den Namen eines Dokuments einschließlich des Pfads ab.

readonly fullName: string;

Eigenschaftswert

string

Hinweise

grammaticalErrors

Ruft ein RangeCollection -Objekt ab, das die Sätze darstellt, bei denen die Grammatikprüfung im Dokument fehlgeschlagen ist.

readonly grammaticalErrors: Word.RangeCollection;

Eigenschaftswert

Word.RangeCollection

Hinweise

gridDistanceHorizontal

Gibt den horizontalen Abstand zwischen unsichtbaren Gitternetzlinien an, den Microsoft Word beim Zeichnen, Verschieben und Ändern der Größe von AutoFormen oder ostasiatischen Zeichen im Dokument verwendet.

gridDistanceHorizontal: number;

Eigenschaftswert

number

Hinweise

gridDistanceVertical

Gibt den vertikalen Abstand zwischen unsichtbaren Gitternetzlinien an, den Microsoft Word beim Zeichnen, Verschieben und Ändern der Größe von AutoFormen oder ostasiatischen Zeichen im Dokument verwendet.

gridDistanceVertical: number;

Eigenschaftswert

number

Hinweise

gridIsOriginFromMargin

Gibt an, ob das Zeichenraster in der oberen linken Ecke der Seite beginnt.

gridIsOriginFromMargin: boolean;

Eigenschaftswert

boolean

Hinweise

gridOriginHorizontal

Gibt den horizontalen Ursprungspunkt für das unsichtbare Raster an.

gridOriginHorizontal: number;

Eigenschaftswert

number

Hinweise

gridOriginVertical

Gibt den vertikalen Ursprungspunkt für das unsichtbare Raster an.

gridOriginVertical: number;

Eigenschaftswert

number

Hinweise

gridSpaceBetweenHorizontalLines

Gibt das Intervall für horizontale Zeichengitternetzlinien in der Drucklayoutansicht an.

gridSpaceBetweenHorizontalLines: number;

Eigenschaftswert

number

Hinweise

gridSpaceBetweenVerticalLines

Gibt das Intervall für vertikale Zeichengitternetzlinien in der Drucklayoutansicht an.

gridSpaceBetweenVerticalLines: number;

Eigenschaftswert

number

Hinweise

hasPassword

Ruft ab, ob zum Öffnen des Dokuments ein Kennwort erforderlich ist.

readonly hasPassword: boolean;

Eigenschaftswert

boolean

Hinweise

hasVbProject

Ruft ab, ob das Dokument über ein angefügtes Microsoft Visual Basic for Applications-Projekt verfügt.

readonly hasVbProject: boolean;

Eigenschaftswert

boolean

Hinweise

hyperlinks

Gibt ein HyperlinkCollection -Objekt zurück, das alle Links im Dokument darstellt.

readonly hyperlinks: Word.HyperlinkCollection;

Eigenschaftswert

Word.HyperlinkCollection

Hinweise

hyphenateCaps

Gibt an, ob Wörter in Großbuchstaben mit Trennstrichen versehen werden können.

hyphenateCaps: boolean;

Eigenschaftswert

boolean

Hinweise

hyphenationZone

Gibt die Breite der Silbentrennungszone in Punkt an.

hyphenationZone: number;

Eigenschaftswert

number

Hinweise

indexes

Gibt ein IndexCollection -Objekt zurück, das alle Indizes im Dokument darstellt.

readonly indexes: Word.IndexCollection;

Eigenschaftswert

Word.IndexCollection

Hinweise

isAutoFormatOverrideOn

Gibt an, ob automatische Formatierungsoptionen Formatierungseinschränkungen außer Kraft setzen.

isAutoFormatOverrideOn: boolean;

Eigenschaftswert

boolean

Hinweise

isChartDataPointTracked

Gibt an, ob Diagramme im aktiven Dokument zellverweisbasierte Datenpunktnachverfolgung verwenden.

isChartDataPointTracked: boolean;

Eigenschaftswert

boolean

Hinweise

isCompatible

Gibt an, ob die von der type -Eigenschaft angegebene Kompatibilitätsoption aktiviert ist.

isCompatible: boolean;

Eigenschaftswert

boolean

Hinweise

isFinal

Gibt an, ob das Dokument endgültig ist.

isFinal: boolean;

Eigenschaftswert

boolean

Hinweise

isFontsSubsetSaved

Gibt an, ob Microsoft Word eine Teilmenge der eingebetteten TrueType-Schriftarten mit dem Dokument speichert.

isFontsSubsetSaved: boolean;

Eigenschaftswert

boolean

Hinweise

isFormsDataPrinted

Gibt an, ob Microsoft Word nur die in das entsprechende Onlineformular eingegebenen Daten auf einem vorgedruckten Formular druckt.

isFormsDataPrinted: boolean;

Eigenschaftswert

boolean

Hinweise

isFormsDataSaved

Gibt an, ob Microsoft Word die in ein Formular eingegebenen Daten als durch Tabstopps getrennten Datensatz für die Verwendung in einer Datenbank speichert.

isFormsDataSaved: boolean;

Eigenschaftswert

boolean

Hinweise

isGrammarChecked

Gibt an, ob eine Grammatikprüfung für das Dokument ausgeführt wurde.

isGrammarChecked: boolean;

Eigenschaftswert

boolean

Hinweise

isInAutoSave

Ruft ab, ob das letzte Auslösen des Application.DocumentBeforeSave Ereignisses das Ergebnis einer automatischen Speicherung durch das Dokument oder einer manuellen Speicherung durch den Benutzer war.

readonly isInAutoSave: boolean;

Eigenschaftswert

boolean

Hinweise

isInFormsDesign

Ruft ab, ob sich das Dokument im Formularentwurfsmodus befindet.

readonly isInFormsDesign: boolean;

Eigenschaftswert

boolean

Hinweise

isKerningByAlgorithm

Gibt an, ob Word lateinische Zeichen und Interpunktionszeichen mit halber Breite enthält.

isKerningByAlgorithm: boolean;

Eigenschaftswert

boolean

Hinweise

isLinguisticDataEmbedded

Gibt an, ob Sprach- und Handschriftdaten eingebettet werden sollen.

isLinguisticDataEmbedded: boolean;

Eigenschaftswert

boolean

Hinweise

isMasterDocument

Ruft ab, ob dieses Dokument ein master Dokument ist.

readonly isMasterDocument: boolean;

Eigenschaftswert

boolean

Hinweise

isOptimizedForWord97

Gibt an, ob Word das Dokument für Word 97 optimiert.

isOptimizedForWord97: boolean;

Eigenschaftswert

boolean

Hinweise

isPostScriptPrintedOverText

Gibt an, ob PRINT-Feldanweisungen (z. B. PostScript-Befehle) im Dokument über Text und Grafiken gedruckt werden sollen, wenn ein PostScript-Drucker verwendet wird.

isPostScriptPrintedOverText: boolean;

Eigenschaftswert

boolean

Hinweise

isQuickStyleSetLocked

Gibt an, ob Benutzer den Schnellformatvorlagensatz ändern können.

isQuickStyleSetLocked: boolean;

Eigenschaftswert

boolean

Hinweise

isReadOnly

Ruft ab, ob Änderungen am Dokument nicht im Originaldokument gespeichert werden können.

readonly isReadOnly: boolean;

Eigenschaftswert

boolean

Hinweise

isReadOnlyRecommended

Gibt an, ob Microsoft Word ein Meldungsfeld anzeigt, wenn ein Benutzer das Dokument öffnet und vorschlägt, dass es schreibgeschützt geöffnet wird.

isReadOnlyRecommended: boolean;

Eigenschaftswert

boolean

Hinweise

isSnappedToGrid

Gibt an, ob AutoFormen oder ostasiatische Zeichen automatisch an einem unsichtbaren Raster ausgerichtet werden.

isSnappedToGrid: boolean;

Eigenschaftswert

boolean

Hinweise

isSnappedToShapes

Gibt an, ob AutoFormen oder ostasiatische Zeichen an unsichtbaren Gitternetzlinien durch andere Formen ausgerichtet werden.

isSnappedToShapes: boolean;

Eigenschaftswert

boolean

Hinweise

isSpellingChecked

Gibt an, ob die Rechtschreibung im gesamten Dokument überprüft wurde.

isSpellingChecked: boolean;

Eigenschaftswert

boolean

Hinweise

isStyleEnforced

Gibt an, ob Formatierungseinschränkungen in einem geschützten Dokument erzwungen werden.

isStyleEnforced: boolean;

Eigenschaftswert

boolean

Hinweise

isSubdocument

Ruft ab, ob dieses Dokument ein Unterdokument eines master Dokuments ist.

readonly isSubdocument: boolean;

Eigenschaftswert

boolean

Hinweise

isThemeLocked

Gibt an, ob Benutzer das Dokumentdesign ändern können.

isThemeLocked: boolean;

Eigenschaftswert

boolean

Hinweise

isUserControl

Gibt an, ob das Dokument vom Benutzer erstellt oder geöffnet wurde.

isUserControl: boolean;

Eigenschaftswert

boolean

Hinweise

isVbaSigned

Ruft ab, ob das VBA-Projekt digital signiert ist.

readonly isVbaSigned: boolean;

Eigenschaftswert

boolean

Hinweise

isWriteReserved

Ruft ab, ob das Dokument mit einem Schreibkennwort geschützt ist.

readonly isWriteReserved: boolean;

Eigenschaftswert

boolean

Hinweise

justificationMode

Gibt die Anpassung des Zeichenabstands an.

justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana";

Eigenschaftswert

Word.JustificationMode | "Expand" | "Compress" | "CompressKana"

Hinweise

kind

Gibt den Formattyp an, den Microsoft Word beim automatischen Formatieren des Dokuments verwendet.

kind: Word.DocumentKind | "NotSpecified" | "Letter" | "Email";

Eigenschaftswert

Word.DocumentKind | "NotSpecified" | "Letter" | "Email"

Hinweise

languageDetected

Gibt an, ob Microsoft Word die Sprache des Dokumenttexts erkannt hat.

languageDetected: boolean;

Eigenschaftswert

boolean

Hinweise

listParagraphs

Ruft ein ParagraphCollection -Objekt ab, das alle nummerierten Absätze im Dokument darstellt.

readonly listParagraphs: Word.ParagraphCollection;

Eigenschaftswert

Word.ParagraphCollection

Hinweise

lists

Ruft ein ListCollection -Objekt ab, das alle formatierten Listen im Dokument enthält.

readonly lists: Word.ListCollection;

Eigenschaftswert

Word.ListCollection

Hinweise

listTemplates

Gibt ein ListTemplateCollection -Objekt zurück, das alle Listenvorlagen im Dokument darstellt.

readonly listTemplates: Word.ListTemplateCollection;

Eigenschaftswert

Word.ListTemplateCollection

Hinweise

noLineBreakAfter

Gibt die Kinsoku-Zeichen an, nach denen Word keine Zeile durchbricht.

noLineBreakAfter: string;

Eigenschaftswert

string

Hinweise

noLineBreakBefore

Gibt die Kinsoku-Zeichen an, vor denen Word keine Zeile umbricht.

noLineBreakBefore: string;

Eigenschaftswert

string

Hinweise

openEncoding

Ruft die Codierung ab, die zum Öffnen des Dokuments verwendet wird.

readonly openEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

Eigenschaftswert

Hinweise

originalDocumentTitle

Ruft den Titel des originalen Dokuments nach dem Vergleich zwischen Legal und Blackline ab.

readonly originalDocumentTitle: string;

Eigenschaftswert

string

Hinweise

pageSetup

Gibt ein PageSetup -Objekt zurück, das dem Dokument zugeordnet ist.

readonly pageSetup: Word.PageSetup;

Eigenschaftswert

Word.PageSetup

Hinweise

paragraphs

Ruft ein ParagraphCollection -Objekt ab, das alle Absätze im Dokument darstellt.

readonly paragraphs: Word.ParagraphCollection;

Eigenschaftswert

Word.ParagraphCollection

Hinweise

password

Legt ein Kennwort fest, das zum Öffnen des Dokuments angegeben werden muss.

password: string;

Eigenschaftswert

string

Hinweise

passwordEncryptionAlgorithm

Ruft den algorithmus ab, der für die Kennwortverschlüsselung verwendet wird.

readonly passwordEncryptionAlgorithm: string;

Eigenschaftswert

string

Hinweise

passwordEncryptionKeyLength

Ruft die Schlüssellänge ab, die für die Kennwortverschlüsselung verwendet wird.

readonly passwordEncryptionKeyLength: number;

Eigenschaftswert

number

Hinweise

passwordEncryptionProvider

Ruft den Namen des Kennwortverschlüsselungsanbieters ab.

readonly passwordEncryptionProvider: string;

Eigenschaftswert

string

Hinweise

path

Ruft den Datenträger oder den Webpfad zum Dokument ab (schließt den Dokumentnamen aus).

readonly path: string;

Eigenschaftswert

string

Hinweise

printRevisions

Gibt an, ob Revisionsmarkierungen mit dem Dokument gedruckt werden.

printRevisions: boolean;

Eigenschaftswert

boolean

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

protectionType

Ruft den Schutztyp für das Dokument ab.

readonly protectionType: Word.ProtectionType | "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading";

Eigenschaftswert

Hinweise

readabilityStatistics

Ruft ein ReadabilityStatisticCollection -Objekt ab, das die Lesbarkeitsstatistiken für das Dokument darstellt.

readonly readabilityStatistics: Word.ReadabilityStatisticCollection;

Eigenschaftswert

Word.ReadabilityStatisticCollection

Hinweise

readingLayoutSizeX

Gibt die Breite von Seiten in der Leselayoutansicht an, wenn sie fixiert sind.

readingLayoutSizeX: number;

Eigenschaftswert

number

Hinweise

readingLayoutSizeY

Gibt die Höhe von Seiten in der Leselayoutansicht an, wenn sie fixiert sind.

readingLayoutSizeY: number;

Eigenschaftswert

number

Hinweise

readingModeIsLayoutFrozen

Gibt an, ob Seiten in der Leselayoutansicht für handschriftliches Markup fixiert sind.

readingModeIsLayoutFrozen: boolean;

Eigenschaftswert

boolean

Hinweise

removePersonalInformationOnSave

Gibt an, ob Word Benutzerinformationen beim Speichern entfernt.

removePersonalInformationOnSave: boolean;

Eigenschaftswert

boolean

Hinweise

revisedDocumentTitle

Ruft den Titel des überarbeiteten Dokuments nach dem Vergleich zwischen Legal und Blackline ab.

readonly revisedDocumentTitle: string;

Eigenschaftswert

string

Hinweise

revisions

Ruft die Auflistung von Revisionen ab, die die nachverfolgten Änderungen im Dokument darstellt.

readonly revisions: Word.RevisionCollection;

Eigenschaftswert

Word.RevisionCollection

Hinweise

saved

Gibt an, ob die Änderungen im Dokument gespeichert wurden. Der Wert true gibt an, dass sich das Dokument seit dem Speichern nicht geändert hat.

readonly saved: boolean;

Eigenschaftswert

boolean

Hinweise

saveEncoding

Gibt die Codierung an, die beim Speichern des Dokuments verwendet wird.

saveEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

Eigenschaftswert

Hinweise

saveFormat

Ruft das Dateiformat des Dokuments ab.

readonly saveFormat: Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument";

Eigenschaftswert

Hinweise

sections

Ruft die Auflistung von Section -Objekten im Dokument ab.

readonly sections: Word.SectionCollection;

Eigenschaftswert

Word.SectionCollection

Hinweise

selection

Gibt ein Selection -Objekt zurück, das die aktuelle Auswahl im Dokument darstellt.

readonly selection: Word.Selection;

Eigenschaftswert

Word.Selection

Hinweise

sentences

Ruft das RangeScopedCollection -Objekt ab, das alle Sätze im Dokument darstellt.

readonly sentences: Word.RangeScopedCollection;

Eigenschaftswert

Word.RangeScopedCollection

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

spellingErrors

Ruft ein RangeCollection -Objekt ab, das die Wörter darstellt, die im Dokument als Rechtschreibfehler identifiziert wurden.

readonly spellingErrors: Word.RangeCollection;

Eigenschaftswert

Word.RangeCollection

Hinweise

storyRanges

Ruft ein RangeCollection -Objekt ab, das alle Storys im Dokument darstellt.

readonly storyRanges: Word.RangeCollection;

Eigenschaftswert

Word.RangeCollection

Hinweise

styles

Ruft eine StyleCollection für das Dokument ab.

readonly styles: Word.StyleCollection;

Eigenschaftswert

Word.StyleCollection

Hinweise

tableOfAuthoritiesCategories

Gibt ein TableOfAuthoritiesCategoryCollection -Objekt zurück, das die verfügbaren Kategorien der Autoritätstabelle im Dokument darstellt.

readonly tableOfAuthoritiesCategories: Word.TableOfAuthoritiesCategoryCollection;

Eigenschaftswert

Word.TableOfAuthoritiesCategoryCollection

Hinweise

tables

Ruft ein TableCollection -Objekt ab, das alle Tabellen im Dokument darstellt.

readonly tables: Word.TableCollection;

Eigenschaftswert

Word.TableCollection

Hinweise

tablesOfAuthorities

Gibt ein TableOfAuthoritiesCollection -Objekt zurück, das alle Tabellen von Autoritäten im Dokument darstellt.

readonly tablesOfAuthorities: Word.TableOfAuthoritiesCollection;

Eigenschaftswert

Word.TableOfAuthoritiesCollection

Hinweise

tablesOfContents

Gibt ein TableOfContentsCollection -Objekt zurück, das alle Inhaltsverzeichnisse im Dokument darstellt.

readonly tablesOfContents: Word.TableOfContentsCollection;

Eigenschaftswert

Word.TableOfContentsCollection

Hinweise

tablesOfFigures

Gibt ein TableOfFiguresCollection -Objekt zurück, das alle Abbildungstabellen im Dokument darstellt.

readonly tablesOfFigures: Word.TableOfFiguresCollection;

Eigenschaftswert

Word.TableOfFiguresCollection

Hinweise

textEncoding

Gibt die Codierung zum Speichern als codierten Text an.

textEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

Eigenschaftswert

Hinweise

textLineEnding

Gibt an, wie Word Zeilen- und Absatzumbrüche in Textdateien markiert.

textLineEnding: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps";

Eigenschaftswert

Hinweise

trackedChangesAreDateAndTimeRemoved

Gibt an, ob Datums- und Uhrzeitmetadaten für nachverfolgte Änderungen entfernt oder gespeichert werden sollen.

trackedChangesAreDateAndTimeRemoved: boolean;

Eigenschaftswert

boolean

Hinweise

trackFormatting

Gibt an, ob Formatierungsänderungen nachverfolgt werden sollen, wenn die Änderungsnachverfolgung aktiviert ist.

trackFormatting: boolean;

Eigenschaftswert

boolean

Hinweise

trackMoves

Gibt an, ob verschobener Text markiert werden soll, wenn "Änderungen nachverfolgen" aktiviert ist.

trackMoves: boolean;

Eigenschaftswert

boolean

Hinweise

trackRevisions

Gibt an, ob Änderungen im Dokument nachverfolgt werden.

trackRevisions: boolean;

Eigenschaftswert

boolean

Hinweise

type

Ruft den Dokumenttyp (Vorlage oder Dokument) ab.

readonly type: Word.DocumentType | "Document" | "Template" | "Frameset";

Eigenschaftswert

Word.DocumentType | "Document" | "Template" | "Frameset"

Hinweise

webSettings

Ruft das WebSettings -Objekt für webseitenbezogene Attribute ab.

readonly webSettings: Word.WebSettings;

Eigenschaftswert

Word.WebSettings

Hinweise

windows

Ruft die Auflistung von Word.Window -Objekten für das Dokument ab.

readonly windows: Word.WindowCollection;

Eigenschaftswert

Word.WindowCollection

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml

await Word.run(async (context) => {
  // Gets the document windows.
  const windows: Word.WindowCollection = context.document.windows;
  windows.load("windows/items/length");

  await context.sync();

  console.log(`Number of windows for this document: ${windows.items.length}`);
});

words

Ruft das RangeScopedCollection -Objekt ab, das jedes Wort im Dokument darstellt.

readonly words: Word.RangeScopedCollection;

Eigenschaftswert

Word.RangeScopedCollection

Hinweise

writePassword

Legt ein Kennwort zum Speichern von Änderungen am Dokument fest.

writePassword: string;

Eigenschaftswert

string

Hinweise

xmlAreAdvancedErrorsShown

Gibt an, ob Fehlermeldungen aus integrierten Word-Nachrichten oder MSXML (Microsoft XML) generiert werden.

xmlAreAdvancedErrorsShown: boolean;

Eigenschaftswert

boolean

Hinweise

xmlIsXsltUsedWhenSaving

Gibt an, ob ein Dokument über eine XSLT (Extensible Stylesheet Language Transformation) gespeichert werden soll.

xmlIsXsltUsedWhenSaving: boolean;

Eigenschaftswert

boolean

Hinweise

xmlSaveThroughXslt

Gibt den Pfad und Dateinamen für die XSLT an, die beim Speichern eines Dokuments angewendet werden sollen.

xmlSaveThroughXslt: string;

Eigenschaftswert

string

Hinweise

Details zur Methode

acceptAllRevisions()

Akzeptiert alle nachverfolgten Änderungen im Dokument.

acceptAllRevisions(): void;

Gibt zurück

void

Hinweise

acceptAllRevisionsShown()

Akzeptiert alle Überarbeitungen im Dokument, die auf dem Bildschirm angezeigt werden.

acceptAllRevisionsShown(): void;

Gibt zurück

void

Hinweise

activate()

Aktiviert das Dokument, sodass es zum aktiven Dokument wird.

activate(): void;

Gibt zurück

void

Hinweise

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 Formatvorlagennamen darstellt.

type: Word.StyleType

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 = (document.getElementById("new-style-name") as HTMLInputElement).value;
  if (newStyleName == "") {
    console.warn("Enter a style name to add.");
    return;
  }

  const style: Word.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 = ((document.getElementById("new-style-type") as HTMLSelectElement).value 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, 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 Formatvorlagennamen darstellt.

type: "Character" | "List" | "Paragraph" | "Table"

Der Formattyp, einschließlich Zeichen, Liste, Absatz oder Tabelle.

Gibt zurück

Word.Style

Hinweise

addToFavorites()

Erstellt eine Verknüpfung zum Dokument oder Link und fügt sie dem Ordner Favoriten hinzu.

addToFavorites(): void;

Gibt zurück

void

Hinweise

applyQuickStyleSet(style)

Wendet den angegebenen Schnellformatvorlagen-Satz auf das Dokument an.

applyQuickStyleSet(style: Word.ApplyQuickStyleSet): void;

Parameter

style: Word.ApplyQuickStyleSet

Der anzuwendende Stilsatz.

Gibt zurück

void

Hinweise

applyQuickStyleSet(style)

Wendet den angegebenen Schnellformatvorlagen-Satz auf das Dokument an.

applyQuickStyleSet(style: "SessionStart" | "Template"): void;

Parameter

style: "SessionStart" | "Template"

Der anzuwendende Stilsatz.

Gibt zurück

void

Hinweise

applyTheme(name)

Wendet das angegebene Design auf dieses Dokument an.

applyTheme(name: string): void;

Parameter

name: string

Der Name des Designs.

Gibt zurück

void

Hinweise

autoFormat()

Formatiert das Dokument automatisch.

autoFormat(): void;

Gibt zurück

void

Hinweise

canCheckin()

Gibt zurücktrue, wenn Microsoft Word das Dokument auf einem Server einchecken kann.

canCheckin(): OfficeExtension.ClientResult<boolean>;

Gibt zurück

OfficeExtension.ClientResult<boolean>

true , wenn das Dokument eingecheckt werden kann; falseandernfalls .

Hinweise

checkConsistencyJapanese()

Durchsucht den gesamten Text in einem japanischen Dokument und zeigt Fälle an, bei denen für dasselbe Wort unterschiedliche Zeichen verwendet wurden.

checkConsistencyJapanese(): void;

Gibt zurück

void

Hinweise

checkGrammar()

Startet eine Rechtschreib- und Grammatikprüfung für das Dokument.

checkGrammar(): void;

Gibt zurück

void

Hinweise

checkIn(options)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Checkt das Dokument vom lokalen Computer auf einen Server ein und legt das lokale Dokument auf schreibgeschützt fest, sodass es nicht lokal bearbeitet werden kann.

checkIn(options?: Word.DocumentCheckInOptions): void;

Parameter

options: Word.DocumentCheckInOptions

Optional. Konfigurationsoptionen für das Einchecken des Dokuments.

Gibt zurück

void

Hinweise

checkInWithVersion(options)

Hinweis

Speichert das Dokument von einem lokalen Computer auf einem Server und legt das lokale Dokument auf schreibgeschützt fest, sodass es nicht lokal bearbeitet werden kann.

checkInWithVersion(options?: Word.DocumentCheckInWithVersionOptions): void;

Parameter

options: Word.DocumentCheckInWithVersionOptions

Optional. Konfigurationsoptionen zum Einchecken des Dokuments mit Versionskontrolle.

Gibt zurück

void

Hinweise

checkSpelling(options)

Hinweis

Startet eine Rechtschreibprüfung für das Dokument.

checkSpelling(options?: Word.DocumentCheckSpellingOptions): void;

Parameter

options: Word.DocumentCheckSpellingOptions

Optional. Konfigurationsoptionen für den Rechtschreibprüfungsvorgang.

Gibt zurück

void

Hinweise

close(closeBehavior)

Schließt das aktuelle Dokument.

Hinweis: Diese API wird in Word im Web nicht unterstützt.

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

Parameter

closeBehavior: Word.CloseBehavior

Optional. Das Close-Verhalten muss oder skipSaveseinsave. Der Standardwert ist save.

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(closeBehavior)

Schließt das aktuelle Dokument.

Hinweis: Diese API wird in Word im Web nicht unterstützt.

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

Parameter

closeBehavior: "Save" | "SkipSave"

Optional. Das Close-Verhalten muss oder skipSaveseinsave. Der Standardwert ist save.

Gibt zurück

void

Hinweise

closePrintPreview()

Wechselt das Dokument von der Druckvorschau zur vorherigen Ansicht.

closePrintPreview(): void;

Gibt zurück

void

Hinweise

compare(filePath, documentCompareOptions)

Zeigt Korrekturmarkierungen an, um hervorzuheben, an welchen Stellen das angegebene Dokument von einem anderen abweicht.

compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void;

Parameter

filePath: string

Der Pfad des Dokuments, mit dem das angegebene Dokument verglichen wird.

documentCompareOptions: Word.DocumentCompareOptions

Optional. Die zusätzlichen Optionen, die das Verhalten des Vergleichsdokuments angeben.

Gibt zurück

void

Hinweise

[ API-Satz: WordApiDesktop 1.1 ]

Beispiele

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

// Compares the current document with a specified external document.
await Word.run(async (context) => {
  // Absolute path of an online or local document.
  const filePath = (document.getElementById("filePath") as HTMLInputElement).value;
  // Options that configure the compare operation.
  const options: Word.DocumentCompareOptions = {
    compareTarget: Word.CompareTarget.compareTargetCurrent,
    detectFormatChanges: false
    // Other options you choose...
    };
  context.document.compare(filePath, options);

  await context.sync();

  console.log("Differences shown in the current document.");
});

compareFromBase64(base64File, documentCompareOptions)

Zeigt Korrekturmarkierungen an, um hervorzuheben, an welchen Stellen das angegebene Dokument von einem anderen abweicht.

compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void;

Parameter

base64File: string

Der Base64-codierte Inhalt des Dokuments, mit dem das angegebene Dokument verglichen wird.

documentCompareOptions: Word.DocumentCompareOptions

Optional. Die zusätzlichen Optionen, die das Verhalten für den Vergleich der Dokumente angeben. Beachten Sie, dass die compareTarget Option in dieser API nicht zulässig compareTargetSelected ist.

Gibt zurück

void

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

computeStatistics(statistic, includeFootnotesAndEndnotes)

Hinweis

Gibt eine Statistik zurück, die auf dem Inhalt des Dokuments basiert.

computeStatistics(statistic: Word.StatisticType, includeFootnotesAndEndnotes?: boolean): OfficeExtension.ClientResult<number>;

Parameter

statistic: Word.StatisticType

Der Typ der zurückzugebenden Statistik.

includeFootnotesAndEndnotes: boolean

Optional. Gibt an, ob Fuß- und Endnoten eingeschlossen werden sollen. Der Standardwert ist false.

Gibt zurück

Hinweise

computeStatistics(statistic, includeFootnotesAndEndnotes)

Hinweis

Gibt eine Statistik zurück, die auf dem Inhalt des Dokuments basiert.

computeStatistics(statistic: "Words" | "Lines" | "Pages" | "Characters" | "Paragraphs" | "CharactersWithSpaces" | "FarEastCharacters", includeFootnotesAndEndnotes?: boolean): OfficeExtension.ClientResult<number>;

Parameter

statistic: "Words" | "Lines" | "Pages" | "Characters" | "Paragraphs" | "CharactersWithSpaces" | "FarEastCharacters"

Der Typ der zurückzugebenden Statistik.

includeFootnotesAndEndnotes: boolean

Optional. Gibt an, ob Fuß- und Endnoten eingeschlossen werden sollen. Der Standardwert ist false.

Gibt zurück

Hinweise

convert()

Konvertiert die Datei in das neueste Format und aktiviert alle Features.

convert(): void;

Gibt zurück

void

Hinweise

convertAutoHyphens()

Konvertiert automatische Bindestriche in manuelle Bindestriche.

convertAutoHyphens(): void;

Gibt zurück

void

Hinweise

convertNumbersToText(numberType)

Ändert die Listennummern und LISTNUM-Felder im Dokument in Text.

convertNumbersToText(numberType?: Word.NumberType): void;

Parameter

numberType: Word.NumberType

Optional. Der Typ der zu konvertierenden Nummerierung.

Gibt zurück

void

Hinweise

convertNumbersToText(numberType)

Ändert die Listennummern und LISTNUM-Felder im Dokument in Text.

convertNumbersToText(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): void;

Parameter

numberType: "Paragraph" | "ListNum" | "AllNumbers"

Optional. Der Typ der zu konvertierenden Nummerierung.

Gibt zurück

void

Hinweise

convertVietnameseDocument(codePageOrigin)

Konvertiert ein vietnamesisches Dokument wieder in Unicodetext. Dabei wird nicht der Standardcode, sondern eine andere Codepage verwendet.

convertVietnameseDocument(codePageOrigin: number): void;

Parameter

codePageOrigin: number

Die zu verwendende Codepage.

Gibt zurück

void

Hinweise

copyStylesFromTemplate(StyleTemplate)

Kopiert Formatvorlagen aus der angegebenen Vorlage in das Dokument.

copyStylesFromTemplate(StyleTemplate: string): void;

Parameter

StyleTemplate: string

Die Vorlage, aus der Stile kopiert werden sollen.

Gibt zurück

void

Hinweise

countNumberedItems(options)

Hinweis

Gibt die Anzahl von Aufzählungen oder nummerierten Elementen und LISTNUM-Feldern im Dokument zurück.

countNumberedItems(options?: Word.DocumentCountNumberedItemsOptions): OfficeExtension.ClientResult<number>;

Parameter

options: Word.DocumentCountNumberedItemsOptions

Optional. Konfigurationsoptionen zum Zählen nummerierter Elemente.

Gibt zurück

Die Anzahl der nummerierten Elemente.

Hinweise

deleteAllComments()

Löscht alle Kommentare aus dem Dokument.

deleteAllComments(): void;

Gibt zurück

void

Hinweise

deleteAllCommentsShown()

Löscht alle Revisionen im Dokument, die auf dem Bildschirm angezeigt werden.

deleteAllCommentsShown(): void;

Gibt zurück

void

Hinweise

deleteAllInkAnnotations()

Löscht alle handschriftlichen Freihandanmerkungen im Dokument.

deleteAllInkAnnotations(): void;

Gibt zurück

void

Hinweise

deleteBookmark(name)

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

deleteBookmark(name: string): void;

Parameter

name: string

Der Name des Lesezeichens, bei dem die Groß-/Kleinschreibung nicht beachtet wird.

Gibt zurück

void

Hinweise

detectLanguage()

Analysiert den Dokumenttext, um die Sprache zu bestimmen.

detectLanguage(): void;

Gibt zurück

void

Hinweise

endReview(options)

Hinweis

Beendet eine Überprüfung der Datei, die zur Überprüfung gesendet wurde.

endReview(options?: Word.DocumentEndReviewOptions): void;

Parameter

options: Word.DocumentEndReviewOptions

Optional. Konfigurationsoptionen zum Beenden des Überprüfungsprozesses.

Gibt zurück

void

Hinweise

exportAsFixedFormat(outputFileName, exportFormat, options)

Hinweis

Speichert das Dokument im PDF- oder XPS-Format.

exportAsFixedFormat(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormatOptions): void;

Parameter

outputFileName: string

Der Name der Ausgabedatei.

exportFormat: Word.ExportFormat

Das Exportformat.

options: Word.DocumentExportAsFixedFormatOptions

Optional. Konfigurationsoptionen für den Exportvorgang.

Gibt zurück

void

Hinweise

exportAsFixedFormat(outputFileName, exportFormat, options)

Hinweis

Speichert das Dokument im PDF- oder XPS-Format.

exportAsFixedFormat(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormatOptions): void;

Parameter

outputFileName: string

Der Name der Ausgabedatei.

exportFormat: "Pdf" | "Xps"

Das Exportformat.

options: Word.DocumentExportAsFixedFormatOptions

Optional. Konfigurationsoptionen für den Exportvorgang.

Gibt zurück

void

Hinweise

exportAsFixedFormat2(outputFileName, exportFormat, options)

Hinweis

Speichert das Dokument im PDF- oder XPS-Format.

exportAsFixedFormat2(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat2Options): void;

Parameter

outputFileName: string

Der Name der Ausgabedatei.

exportFormat: Word.ExportFormat

Das zu exportierende Format (PDF/XPS).

options: Word.DocumentExportAsFixedFormat2Options

Optional. Konfigurationsoptionen für den Exportvorgang.

Gibt zurück

void

Hinweise

exportAsFixedFormat2(outputFileName, exportFormat, options)

Hinweis

Speichert das Dokument im PDF- oder XPS-Format.

exportAsFixedFormat2(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormat2Options): void;

Parameter

outputFileName: string

Der Name der Ausgabedatei.

exportFormat: "Pdf" | "Xps"

Das zu exportierende Format (PDF/XPS).

options: Word.DocumentExportAsFixedFormat2Options

Optional. Konfigurationsoptionen für den Exportvorgang.

Gibt zurück

void

Hinweise

exportAsFixedFormat3(outputFileName, exportFormat, options)

Hinweis

Speichert das Dokument im PDF- oder XPS-Format mit verbesserter Kennzeichnung.

exportAsFixedFormat3(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat3Options): void;

Parameter

outputFileName: string

Der Name der Ausgabedatei.

exportFormat: Word.ExportFormat

Das zu exportierende Format (PDF/XPS).

options: Word.DocumentExportAsFixedFormat3Options

Optional. Konfigurationsoptionen für den Exportvorgang.

Gibt zurück

void

Hinweise

exportAsFixedFormat3(outputFileName, exportFormat, options)

Hinweis

Speichert das Dokument im PDF- oder XPS-Format mit verbesserter Kennzeichnung.

exportAsFixedFormat3(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormat3Options): void;

Parameter

outputFileName: string

Der Name der Ausgabedatei.

exportFormat: "Pdf" | "Xps"

Das zu exportierende Format (PDF/XPS).

options: Word.DocumentExportAsFixedFormat3Options

Optional. Konfigurationsoptionen für den Exportvorgang.

Gibt zurück

void

Hinweise

fitToPages()

Verringert den Schriftgrad des Texts gerade so, dass die Anzahl der Dokumentseiten um eins sinkt.

fitToPages(): void;

Gibt zurück

void

Hinweise

followHyperlink(options)

Hinweis

Zeigt ein Cachespeicher-Dokument an, wenn es bereits heruntergeladen wurde. Andernfalls löst diese Methode den Hyperlink auf, lädt das Zieldokument herunter und zeigt das Dokument in der entsprechenden Anwendung an.

followHyperlink(options?: Word.DocumentFollowHyperlinkOptions): void;

Parameter

options: Word.DocumentFollowHyperlinkOptions

Optional. Konfigurationsoptionen zum Folgen des Links.

Gibt zurück

void

Hinweise

freezeLayout()

Korrigiert das Layout des Dokuments in der Webansicht.

freezeLayout(): void;

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

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

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

getCrossReferenceItems(referenceType)

Gibt ein Array von Elementen zurück, auf die auf der Basis des angegebenen Querverweistyps verwiesen werden kann.

getCrossReferenceItems(referenceType: Word.ReferenceType): OfficeExtension.ClientResult<string[]>;

Parameter

referenceType: Word.ReferenceType

Der Verweistyp.

Gibt zurück

Hinweise

getCrossReferenceItems(referenceType)

Gibt ein Array von Elementen zurück, auf die auf der Basis des angegebenen Querverweistyps verwiesen werden kann.

getCrossReferenceItems(referenceType: "NumberedItem" | "Heading" | "Bookmark" | "Footnote" | "Endnote"): OfficeExtension.ClientResult<string[]>;

Parameter

referenceType: "NumberedItem" | "Heading" | "Bookmark" | "Footnote" | "Endnote"

Der Verweistyp.

Gibt zurück

Hinweise

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

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 = (document.getElementById("paragraph-id") as HTMLInputElement).value;
  const paragraph: Word.Paragraph = context.document.getParagraphByUniqueLocalId(paragraphId);
  paragraph.load();
  await paragraph.context.sync();

  console.log(paragraph);
});

getRange(options)

Hinweis

Gibt ein Range -Objekt mithilfe der angegebenen Anfangs- und Endzeichenposition zurück.

getRange(options?: Word.DocumentRangeOptions): Word.Range;

Parameter

options: Word.DocumentRangeOptions

Optional. Konfigurationsoptionen zum Angeben der Bereichsparameter.

Gibt zurück

Word.Range

Hinweise

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 available styles stored with the document.
await Word.run(async (context) => {
  const styles: Word.StyleCollection = context.document.getStyles();
  const count = styles.getCount();
  await context.sync();

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

goTo(options)

Hinweis

Gibt ein Range -Objekt zurück, das die Anfangsposition des angegebenen Elements darstellt, z. B. eine Seite, ein Lesezeichen oder ein Feld.

goTo(options?: Word.GoToOptions): Word.Range;

Parameter

options: Word.GoToOptions

Optional. Konfigurationsoptionen zum Angeben der goTo Parameter.

Gibt zurück

Word.Range

Hinweise

importStylesFromJson(stylesJson, importedStylesConflictBehavior)

Importieren von Formatvorlagen aus einer JSON-formatierten Zeichenfolge.

importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult<string[]>;

Parameter

stylesJson: string

Eine JSON-formatierte Zeichenfolge, die die Stile darstellt.

importedStylesConflictBehavior: Word.ImportedStylesConflictBehavior

Optional. Gibt an, wie importierte Formatvorlagen mit demselben Namen wie vorhandene Formatvorlagen im aktuellen Dokument behandelt werden. Der Standardwert ist ignore.

Gibt zurück

Hinweise

Hinweis: Der importedStylesConflictBehavior Parameter wurde in WordApiDesktop 1.1 eingeführt.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/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);

  // If you'd like to set how conflicting styles are handled, use the importedStylesConflictBehavior parameter that was introduced in the Desktop 1.1 requirement set. "Ignore" is the default.
  ////const styles = context.document.importStylesFromJson(str, Word.ImportedStylesConflictBehavior.Ignore);

  await context.sync();
  console.log("Styles imported from JSON:", styles);
});

importStylesFromJson(stylesJson, importedStylesConflictBehavior)

Importieren von Formatvorlagen aus einer JSON-formatierten Zeichenfolge.

importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: "Ignore" | "Overwrite" | "CreateNew"): OfficeExtension.ClientResult<string[]>;

Parameter

stylesJson: string

Eine JSON-formatierte Zeichenfolge, die die Stile darstellt.

importedStylesConflictBehavior: "Ignore" | "Overwrite" | "CreateNew"

Optional. Gibt an, wie importierte Formatvorlagen mit demselben Namen wie vorhandene Formatvorlagen im aktuellen Dokument behandelt werden. Der Standardwert ist ignore.

Gibt zurück

Hinweise

Hinweis: Der importedStylesConflictBehavior Parameter wurde in WordApiDesktop 1.1 eingeführt.

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

Der Base64-codierte Inhalt einer .docx Datei.

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

Der Wert muss ,start oderend seinreplace.

insertFileOptions: Word.InsertFileOptions

Optional. Die zusätzlichen Eigenschaften, die in das Zieldokument importiert werden sollen.

Gibt zurück

Word.SectionCollection

Hinweise

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

lockServerFile()

Sperrt die Datei auf dem Server, sodass kein anderer Benutzer sie bearbeiten kann.

lockServerFile(): void;

Gibt zurück

void

Hinweise

makeCompatibilityDefault()

Legt die Kompatibilitätsoptionen fest.

makeCompatibilityDefault(): void;

Gibt zurück

void

Hinweise

manualHyphenation()

Initiiert die manuelle Silbentrennung eines Dokuments für die einzelnen Zeilen.

manualHyphenation(): void;

Gibt zurück

void

Hinweise

merge(fileName, options)

Hinweis

Integriert die Änderungen, die in einem Dokument mit Korrekturmarkierungen gekennzeichnet wurden, in ein anderes Dokument.

merge(fileName: string, options?: Word.DocumentMergeOptions): void;

Parameter

fileName: string

Der Name der datei, die zusammengeführt werden soll.

options: Word.DocumentMergeOptions

Optional. Konfigurationsoptionen für den Zusammenführungsvorgang.

Gibt zurück

void

Hinweise

post()

Stellt das Dokument in einem öffentlichen Ordner in Microsoft Exchange bereit.

post(): void;

Gibt zurück

void

Hinweise

presentIt()

Öffnet PowerPoint mit geladenem Word Dokument.

presentIt(): void;

Gibt zurück

void

Hinweise

printOut(options)

Hinweis

Druckt das dokument ganz oder teilweise.

printOut(options?: Word.DocumentPrintOutOptions): void;

Parameter

options: Word.DocumentPrintOutOptions

Optional. Konfigurationsoptionen für den Druckvorgang.

Gibt zurück

void

Hinweise

printPreview()

Wechselt die Ansicht zur Seitenansicht.

printPreview(): void;

Gibt zurück

void

Hinweise

protect(type, options)

Hinweis

Schützt das Dokument vor nicht autorisierten Änderungen.

protect(type: Word.ProtectionType, options?: Word.DocumentProtectOptions): void;

Parameter

type: Word.ProtectionType

Der Schutztyp.

options: Word.DocumentProtectOptions

Optional. Konfigurationsoptionen für den Dokumentschutz.

Gibt zurück

void

Hinweise

protect(type, options)

Hinweis

Schützt das Dokument vor nicht autorisierten Änderungen.

protect(type: "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading", options?: Word.DocumentProtectOptions): void;

Parameter

type: "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading"

Der Schutztyp.

options: Word.DocumentProtectOptions

Optional. Konfigurationsoptionen für den Dokumentschutz.

Gibt zurück

void

Hinweise

redo(times)

Wiederholt die letzte Aktion, die rückgängig gemacht wurde (kehrt die undo Methode um).

redo(times?: number): OfficeExtension.ClientResult<boolean>;

Parameter

times: number

Optional. Die Anzahl der aktionen, die wiederholt werden sollen.

Gibt zurück

OfficeExtension.ClientResult<boolean>

true , wenn die Aktionen erfolgreich wiederholt wurden; falseandernfalls .

Hinweise

rejectAllRevisions()

Lehnt alle nachverfolgten Änderungen im Dokument ab.

rejectAllRevisions(): void;

Gibt zurück

void

Hinweise

rejectAllRevisionsShown()

Lehnt alle Überarbeitungen im Dokument ab, die auf dem Bildschirm angezeigt werden.

rejectAllRevisionsShown(): void;

Gibt zurück

void

Hinweise

reload()

Lädt ein Dokument neu, das sich im Cachespeicher befindet, indem der Hyperlink zum ursprünglichen Dokument aufgelöst und dieses heruntergeladen wird.

reload(): void;

Gibt zurück

void

Hinweise

reloadAs(encoding)

Lädt das Dokument basierend auf einem HTML-Dokument unter Verwendung der Dokumentcodierung neu.

reloadAs(encoding: Word.DocumentEncoding): void;

Parameter

encoding: Word.DocumentEncoding

Die zu verwendende Codierung.

Gibt zurück

void

Hinweise

reloadAs(encoding)

Lädt das Dokument basierend auf einem HTML-Dokument unter Verwendung der Dokumentcodierung neu.

reloadAs(encoding: "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"): void;

Parameter

encoding: "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"

Die zu verwendende Codierung.

Gibt zurück

void

Hinweise

removeDocumentInformation(removeDocInfoType)

Entfernt vertrauliche Informationen, Eigenschaften, Kommentare und andere Metadaten aus dem Dokument.

removeDocumentInformation(removeDocInfoType: Word.RemoveDocInfoType): void;

Parameter

removeDocInfoType: Word.RemoveDocInfoType

Der Typ der zu entfernenden Dokumentinformationen.

Gibt zurück

void

Hinweise

removeDocumentInformation(removeDocInfoType)

Entfernt vertrauliche Informationen, Eigenschaften, Kommentare und andere Metadaten aus dem Dokument.

removeDocumentInformation(removeDocInfoType: "Comments" | "Revisions" | "Versions" | "RemovePersonalInformation" | "EmailHeader" | "RoutingSlip" | "SendForReview" | "DocumentProperties" | "Template" | "DocumentWorkspace" | "InkAnnotations" | "DocumentServerProperties" | "DocumentManagementPolicy" | "ContentType" | "TaskpaneWebExtensions" | "AtMentions" | "DocumentTasks" | "DocumentIntelligence" | "CommentReactions" | "All"): void;

Parameter

removeDocInfoType: "Comments" | "Revisions" | "Versions" | "RemovePersonalInformation" | "EmailHeader" | "RoutingSlip" | "SendForReview" | "DocumentProperties" | "Template" | "DocumentWorkspace" | "InkAnnotations" | "DocumentServerProperties" | "DocumentManagementPolicy" | "ContentType" | "TaskpaneWebExtensions" | "AtMentions" | "DocumentTasks" | "DocumentIntelligence" | "CommentReactions" | "All"

Der Typ der zu entfernenden Dokumentinformationen.

Gibt zurück

void

Hinweise

removeLockedStyles()

Löscht das Dokument von gesperrten Formatvorlagen, wenn Formatierungseinschränkungen im Dokument angewendet wurden.

removeLockedStyles(): void;

Gibt zurück

void

Hinweise

removeNumbers(numberType)

Entfernt Zahlen oder Aufzählungszeichen aus dem Dokument.

removeNumbers(numberType?: Word.NumberType): void;

Parameter

numberType: Word.NumberType

Optional. Der Typ der zu entfernenden Nummerierung.

Gibt zurück

void

Hinweise

removeNumbers(numberType)

Entfernt Zahlen oder Aufzählungszeichen aus dem Dokument.

removeNumbers(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): void;

Parameter

numberType: "Paragraph" | "ListNum" | "AllNumbers"

Optional. Der Typ der zu entfernenden Nummerierung.

Gibt zurück

void

Hinweise

removeTheme()

Entfernt das aktive Design aus dem aktuellen Dokument.

removeTheme(): void;

Gibt zurück

void

Hinweise

repaginate()

Führt einen Seitenumbruch für das gesamte Dokument aus.

repaginate(): void;

Gibt zurück

void

Hinweise

replyWithChanges(options)

Hinweis

Sendet eine E-Mail-Nachricht an den Autor des Dokuments, das zur Überprüfung gesendet wurde, und informiert ihn darüber, dass ein Prüfer die Überprüfung des Dokuments abgeschlossen hat.

replyWithChanges(options?: Word.DocumentReplyWithChangesOptions): void;

Parameter

options: Word.DocumentReplyWithChangesOptions

Optional. Konfigurationsoptionen für antworten mit Änderungen.

Gibt zurück

void

Hinweise

resetFormFields()

Löscht alle Formularfelder im Dokument und bereitet das Formular vor, das erneut ausgefüllt werden soll.

resetFormFields(): void;

Gibt zurück

void

Hinweise

returnToLastReadPosition()

Gibt das Dokument an die zuletzt gespeicherte Leseposition zurück.

returnToLastReadPosition(): OfficeExtension.ClientResult<number>;

Gibt zurück

Hinweise

runAutoMacro(autoMacro)

Führt ein automatisches Makro aus, das im Dokument gespeichert ist. Wenn das angegebene Automakro nicht vorhanden ist, passiert nichts.

runAutoMacro(autoMacro: Word.AutoMacro): void;

Parameter

autoMacro: Word.AutoMacro

Das Automakro, das ausgeführt werden soll.

Gibt zurück

void

Hinweise

runAutoMacro(autoMacro)

Führt ein automatisches Makro aus, das im Dokument gespeichert ist. Wenn das angegebene Automakro nicht vorhanden ist, passiert nichts.

runAutoMacro(autoMacro: "StartWord" | "New" | "Open" | "Close" | "Exit" | "Sync"): void;

Parameter

autoMacro: "StartWord" | "New" | "Open" | "Close" | "Exit" | "Sync"

Das Automakro, das ausgeführt werden soll.

Gibt zurück

void

Hinweise

save(saveBehavior, fileName)

Speichert das Dokument.

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

Parameter

saveBehavior: Word.SaveBehavior

Optional. Das Speicherverhalten muss oder promptseinsave. Der Standardwert ist save.

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(saveBehavior, fileName)

Speichert das Dokument.

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

Parameter

saveBehavior: "Save" | "Prompt"

Optional. Das Speicherverhalten muss oder promptseinsave. Der Standardwert ist save.

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.

saveAsQuickStyleSet(fileName)

Speichert den aktuell verwendeten Schnellformatvorlagen-Satz.

saveAsQuickStyleSet(fileName: string): void;

Parameter

fileName: string

Der Name der zu speichernden Datei.

Gibt zurück

void

Hinweise

search(searchText, searchOptions)

Führt eine Suche mit den angegebenen Suchoptionen für den Bereich des gesamten Dokuments aus. Die Suchergebnisse sind eine Auflistung von Range -Objekten.

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

Der zu suchende Text.

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

Optional. Optionen, die definieren, wie die Suche ausgeführt wird.

Gibt zurück

Word.RangeCollection

Hinweise

select()

Wählt den Inhalt des Dokuments aus.

select(): void;

Gibt zurück

void

Hinweise

selectContentControlsByTag(tag)

Gibt alle Inhaltssteuerelemente mit dem angegebenen Tag zurück.

selectContentControlsByTag(tag: string): Word.ContentControlCollection;

Parameter

tag: string

Der Tagwert zum Filtern von Inhaltssteuerelementen.

Gibt zurück

Word.ContentControlCollection

Hinweise

selectContentControlsByTitle(title)

Gibt ein ContentControlCollection -Objekt zurück, das alle Inhaltssteuerelemente im Dokument mit dem angegebenen Titel darstellt.

selectContentControlsByTitle(title: string): Word.ContentControlCollection;

Parameter

title: string

Der Titel der Inhaltssteuerelemente.

Gibt zurück

Word.ContentControlCollection

Hinweise

selectLinkedControls(node)

Gibt ein ContentControlCollection -Objekt zurück, das alle Inhaltssteuerelemente im Dokument darstellt, die mit dem spezifischen benutzerdefinierten XML-Knoten verknüpft sind.

selectLinkedControls(node: Word.CustomXmlNode): Word.ContentControlCollection;

Parameter

node: Word.CustomXmlNode

Der benutzerdefinierte XML-Knoten.

Gibt zurück

Word.ContentControlCollection

Hinweise

selectNodes(xPath, options)

Gibt ein XmlNodeCollection -Objekt zurück, das alle Knoten darstellt, die dem XPath-Parameter in der Reihenfolge entsprechen, in der sie im Dokument angezeigt werden.

selectNodes(xPath: string, options?: Word.SelectNodesOptions): Word.XmlNodeCollection;

Parameter

xPath: string

Der XPath-Ausdruck.

options: Word.SelectNodesOptions

Optional. Konfigurationsoptionen für die Knotenauswahl.

Gibt zurück

Word.XmlNodeCollection

Hinweise

selectSingleNode(xPath, options)

Gibt ein XmlNode -Objekt zurück, das den ersten Knoten darstellt, der dem XPath-Parameter im Dokument entspricht.

selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): Word.XmlNode;

Parameter

xPath: string

Der XPath-Ausdruck.

options: Word.SelectSingleNodeOptions

Optional. Konfigurationsoptionen für die Knotenauswahl.

Gibt zurück

Word.XmlNode

Hinweise

selectUnlinkedControls(stream)

Gibt ein ContentControlCollection -Objekt zurück, das alle Inhaltssteuerelemente im Dokument darstellt, die nicht mit einem XML-Knoten verknüpft sind.

selectUnlinkedControls(stream?: Word.CustomXmlPart): Word.ContentControlCollection;

Parameter

stream: Word.CustomXmlPart

Optional. Der benutzerdefinierte XML-Teil.

Gibt zurück

Word.ContentControlCollection

Hinweise

sendFax(address, subject)

Sendet das Dokument ohne Benutzerinteraktion als Fax.

sendFax(address: string, subject?: string): void;

Parameter

address: string

Die Faxadresse.

subject: string

Optional. Der Betreff des Faxes.

Gibt zurück

void

Hinweise

sendFaxOverInternet(options)

Hinweis

Sendet das Dokument an einen Faxdienstanbieter, der das Dokument an einen oder mehrere angegebene Empfänger faxt.

sendFaxOverInternet(options?: Word.DocumentSendFaxOverInternetOptions): void;

Parameter

options: Word.DocumentSendFaxOverInternetOptions

Optional. Konfigurationsoptionen zum Senden des Faxes über das Internet.

Gibt zurück

void

Hinweise

sendForReview(options)

Hinweis

Sendet das Dokument in einer E-Mail-Nachricht zur Überprüfung durch die angegebenen Empfänger.

sendForReview(options?: Word.DocumentSendForReviewOptions): void;

Parameter

options: Word.DocumentSendForReviewOptions

Optional. Konfigurationsoptionen zum Senden des Dokuments zur Überprüfung.

Gibt zurück

void

Hinweise

sendMail()

Öffnet ein Nachrichtenfenster zum Senden des Dokuments über Microsoft Exchange.

sendMail(): void;

Gibt zurück

void

Hinweise

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

setDefaultTableStyle(style, setInTemplate)

Gibt die Tabellenformatvorlage an, die für neu erstellte Tabellen im Dokument verwendet werden soll.

setDefaultTableStyle(style: string, setInTemplate: boolean): void;

Parameter

style: string

Die anzuwendende Formatvorlage.

setInTemplate: boolean

Gibt an, ob der Stil in der Vorlage festgelegt werden soll.

Gibt zurück

void

Hinweise

setPasswordEncryptionOptions(passwordEncryptionProvider, passwordEncryptionAlgorithm, passwordEncryptionKeyLength, passwordEncryptFileProperties)

Legt die Optionen fest, die in Microsoft Word verwendet werden, um kennwortgeschützte Dokumente zu verschlüsseln.

setPasswordEncryptionOptions(passwordEncryptionProvider: string, passwordEncryptionAlgorithm: string, passwordEncryptionKeyLength: number, passwordEncryptFileProperties?: boolean): void;

Parameter

passwordEncryptionProvider: string

Der Verschlüsselungsanbieter.

passwordEncryptionAlgorithm: string

Der Verschlüsselungsalgorithmus.

passwordEncryptionKeyLength: number

Die Schlüssellänge.

passwordEncryptFileProperties: boolean

Optional. Gibt an, ob Dateieigenschaften verschlüsselt werden sollen.

Gibt zurück

void

Hinweise

toggleFormsDesign()

Schaltet den Formularentwurfsmodus ein oder aus.

toggleFormsDesign(): void;

Gibt zurück

void

Hinweise

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

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

transformDocument(path, dataOnly)

Wendet die angegebene XSLT-Datei (Extensible Stylesheet Language Transformation) auf dieses Dokument an und ersetzt das Dokument durch die Ergebnisse.

transformDocument(path: string, dataOnly?: boolean): void;

Parameter

path: string

Der Pfad zur XSLT-Datei.

dataOnly: boolean

Optional. Gibt an, ob nur Daten verwendet werden sollen.

Gibt zurück

void

Hinweise

undo(times)

Macht die letzte Aktion oder eine Folge von Aktionen rückgängig, die in der Undo-Liste angezeigt werden.

undo(times?: number): OfficeExtension.ClientResult<boolean>;

Parameter

times: number

Optional. Die Anzahl der Aktionen, die rückgängig zu machen sind.

Gibt zurück

OfficeExtension.ClientResult<boolean>

true , wenn die Aktionen erfolgreich rückgängig wurden; falseandernfalls .

Hinweise

undoClear()

Löscht die Liste der Aktionen, die im Dokument rückgängiggemacht werden können.

undoClear(): void;

Gibt zurück

void

Hinweise

unprotect(password)

Entfernt den Schutz aus dem Dokument.

unprotect(password?: string): void;

Parameter

password: string

Optional. Das Kennwort zum Aufheben des Schutzes des Dokuments.

Gibt zurück

void

Hinweise

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

updateStyles()

Kopiert alle Formatvorlagen aus der zugeordneten Dokumentvorlage in das Dokument, wobei vorhandene gleichnamige Formatvorlagen überschrieben werden.

updateStyles(): void;

Gibt zurück

void

Hinweise

viewCode()

Zeigt das Codefenster für das ausgewählte Microsoft ActiveX-Steuerelement im Dokument an.

viewCode(): void;

Gibt zurück

void

Hinweise

viewPropertyBrowser()

Zeigt das Eigenschaftenfenster für das ausgewählte Microsoft ActiveX-Steuerelement im Dokument an.

viewPropertyBrowser(): void;

Gibt zurück

void

Hinweise

webPagePreview()

Zeigt eine Vorschau des aktuellen Dokuments an, wie es aussehen würde, wenn es als Webseite gespeichert würde.

webPagePreview(): void;

Gibt zurück

void

Hinweise

OfficeExtension.EventHandlers<Word.AnnotationClickedEventArgs>

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>

Beispiele

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

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onClickedHandler(args: Word.AnnotationClickedEventArgs) {
  await Word.run(async (context) => {
    const annotation: Word.Annotation = context.document.getAnnotationById(args.id);
    annotation.load("critiqueAnnotation");

    await context.sync();

    console.log(`AnnotationClicked: ID ${args.id}:`, annotation.critiqueAnnotation.critique);
  });
}

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>

Beispiele

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

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onHoveredHandler(args: Word.AnnotationHoveredEventArgs) {
  await Word.run(async (context) => {
    const annotation: Word.Annotation = context.document.getAnnotationById(args.id);
    annotation.load("critiqueAnnotation");

    await context.sync();

    console.log(`AnnotationHovered: ID ${args.id}:`, annotation.critiqueAnnotation.critique);
  });
}

onAnnotationInserted

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

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

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Word.AnnotationPopupActionEventArgs>

Beispiele

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

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onInsertedHandler(args: Word.AnnotationInsertedEventArgs) {
  await Word.run(async (context) => {
    const annotations = [];
    for (let i = 0; i < args.ids.length; i++) {
      let annotation: Word.Annotation = context.document.getAnnotationById(args.ids[i]);
      annotation.load("id,critiqueAnnotation");

      annotations.push(annotation);
    }

    await context.sync();

    for (let annotation of annotations) {
      console.log(`AnnotationInserted: ID ${annotation.id}:`, annotation.critiqueAnnotation.critique);
    }
  });
}

onAnnotationPopupAction

Tritt auf, wenn der Benutzer eine Aktion in einem Popupmenü für Anmerkungen ausführt.

readonly onAnnotationPopupAction: OfficeExtension.EventHandlers<Word.AnnotationPopupActionEventArgs>;

Ereignistyp

Hinweise

[ API-Satz: WordApi 1.8 ]

Beispiele

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

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onPopupActionHandler(args: Word.AnnotationPopupActionEventArgs) {
  await Word.run(async (context) => {
    let message = `AnnotationPopupAction: ID ${args.id} = `;
    if (args.action === "Accept") {
      message += `Accepted: ${args.critiqueSuggestion}`;
    } else {
      message += "Rejected";
    }

    console.log(message);
  });
}

onAnnotationRemoved

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

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

Ereignistyp

OfficeExtension.EventHandlers<Word.AnnotationRemovedEventArgs>

Hinweise

OfficeExtension.EventHandlers<Word.ContentControlAddedEventArgs>

Beispiele

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

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onRemovedHandler(args: Word.AnnotationRemovedEventArgs) {
  await Word.run(async (context) => {
    for (let id of args.ids) {
      console.log(`AnnotationRemoved: ID ${id}`);
    }
  });
}

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