Neuerungen in Word JavaScript-API 1.1

  • Artikel

WordApi 1.1 ist der erste Anforderungssatz der Word JavaScript-API. Dies ist der einzige Word API-Anforderungssatz, der von Word 2016 unterstützt wird.

API-Liste

In der folgenden Tabelle sind die APIs in Word JavaScript-API-Anforderungssatz 1.1 aufgeführt. Informationen zum Anzeigen der API-Referenzdokumentation für alle APIs, die von Word JavaScript-API-Anforderungssatz 1.1 unterstützt werden, finden Sie unter Word-APIs im Anforderungssatz 1.1.

Klasse Felder Beschreibung
Body clear() Löscht den Inhalt des Body-Objekts.
contentControls Ruft die Auflistung von Rich-Text-Inhaltssteuerelementobjekten im Text ab.
font Ruft das Textformat des Textkörpers ab.
getHtml() Ruft eine HTML-Darstellung des Body-Objekts ab.
getOoxml() Ruft die OOXML (Office Open XML)-Darstellung des Body-Objekts ab.
inlinePictures Ruft die Auflistung von InlinePicture-Objekten im Text ab.
insertBreak(breakType: Word. BreakType | "Seite" | "Weiter" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | "Start" | "Ende") Fügt an der angegebenen Position im Hauptdokument einen Umbruch ein.
insertContentControl() Umschließt das Body-Objekt mit einem Rich-Text-Inhaltssteuerelement.
insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Ersetzen" | "Start" | "Ende") Fügt in den Textkörper an der angegebenen Position ein Dokument ein.
insertHtml(html: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Ersetzen" | "Start" | "Ende") Fügt an der angegebenen Position HTML-Code ein.
insertOoxml(ooxml: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Ersetzen" | "Start" | "Ende") Fügt an der angegebenen Position OOXML-Code ein.
insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | "Start" | "Ende") Fügt an der angegebenen Position einen Absatz ein.
insertText(text: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Ersetzen" | "Start" | "Ende") Fügt in den Textkörper an der angegebenen Position Text ein.
paragraphs Ruft die Auflistung von Absatzobjekten im Text ab.
parentContentControl Ruft das Inhaltssteuerelement ab, das den Textkörper enthält.
search(searchText: string, searchOptions?: Word. SearchOptions | { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) Führt eine Suche mit den angegebenen SearchOptions für den Bereich des Body-Objekts aus.
select(selectionMode?: Word. SelectionMode) Wählt den Textkörper und navigiert die Word-Benutzeroberfläche an diese Position.
style Gibt den Formatvorlagennamen für den Text an.
text Ruft den Textkörper ab.
ContentControl Aussehen Gibt die Darstellung des Inhaltssteuerelements an.
cannotDelete Gibt einen Wert an, der angibt, ob der Benutzer das Inhaltssteuerelement löschen kann.
cannotEdit Gibt einen Wert an, der angibt, ob der Benutzer den Inhalt des Inhaltssteuerelements bearbeiten kann.
clear() Löscht den Inhalt des Inhaltssteuerelements.
color Gibt die Farbe des Inhaltssteuerelements an.
contentControls Ruft die Auflistung von Inhaltssteuerelement-Objekten im Inhaltssteuerelement ab.
delete(keepContent: boolean) Löscht das Inhaltssteuerelement und dessen Inhalt.
font Ruft das Textformat des Inhaltssteuerelements ab.
getHtml() Ruft eine HTML-Darstellung des Inhaltssteuerelementobjekts ab.
getOoxml() Ruft die Office Open XML (OOXML)-Darstellung des Inhaltssteuerelement-Objekts ab.
id Ruft eine Ganzzahl ab, die den Inhaltssteuerelement-Bezeichner darstellt.
inlinePictures Ruft die Auflistung von InlinePicture-Objekten im Inhaltssteuerelement ab.
insertBreak(breakType: Word. BreakType | "Seite" | "Weiter" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | Word. InsertLocation.before | Word. InsertLocation.after | "Start" | "Ende" | "Vor" | "Nach") Fügt an der angegebenen Position im Hauptdokument einen Umbruch ein.
insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Ersetzen" | "Start" | "Ende") Fügt ein Dokument an der angegebenen Position in das Inhaltssteuerelement ein.
insertHtml(html: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Ersetzen" | "Start" | "Ende") Fügt an der angegebenen Position HTML ein.
insertOoxml(ooxml: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Ersetzen" | "Start" | "Ende") Fügt OOXML an der angegebenen Position in das Inhaltssteuerelement ein.
insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | Word. InsertLocation.before | Word. InsertLocation.after | "Start" | "Ende" | "Vor" | "Nach") Fügt an der angegebenen Position einen Absatz ein.
insertText(text: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Ersetzen" | "Start" | "Ende") Fügt an der angegebenen Position Text in das Inhaltssteuerelement ein.
paragraphs Ruft die Auflistung von Absatzobjekten im Inhaltssteuerelement ab.
parentContentControl Ruft das Inhaltssteuerelement ab, das das Inhaltssteuerelement enthält.
placeholderText Gibt den Platzhaltertext des Inhaltssteuerelements an.
removeWhenEdited Gibt einen Wert an, der angibt, ob das Inhaltssteuerelement entfernt wird, nachdem es bearbeitet wurde.
search(searchText: string, searchOptions?: Word. SearchOptions | { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) Führt eine Suche mit den angegebenen SearchOptions für den Bereich des Inhaltssteuerelementobjekts aus.
select(selectionMode?: Word. SelectionMode) Wählt das Inhaltssteuerelement aus.
style Gibt den Formatvorlagennamen für das Inhaltssteuerelement an.
Tag Gibt ein Tag zum Identifizieren eines Inhaltssteuerelements an.
text Ruft den Text des Inhaltssteuerelements ab.
title Gibt den Titel für ein Inhaltssteuerelement an.
type Ruft den Typen des Inhaltssteuerelements ab.
ContentControlCollection getById(id: number) Ruft ein Inhaltssteuerelement mithilfe der ID ab.
getByTag(tag: string) Ruft die Inhaltssteuerelemente ab, die das angegebene Tag enthalten.
getByTitle(title: string) Ruft die Inhaltssteuerelemente ab, die den angegebenen Titel enthalten.
getItem(id: number) Ruft ein Inhaltssteuerelement anhand seiner ID ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
Dokument Text Ruft das Textobjekt des Standard Dokuments ab.
contentControls Ruft die Auflistung von Inhaltssteuerelementobjekten im Dokument ab.
getSelection() Ruft die aktuelle Auswahl des Dokuments ab.
save() Speichert das Dokument.
Gespeichert Gibt an, ob die Änderungen im Dokument gespeichert wurden.
sections Ruft die Auflistung von Abschnittsobjekten im Dokument ab.
Font bold Gibt einen Wert an, der angibt, ob die Schriftart fett formatiert ist.
color Gibt die Farbe für die angegebene Schriftart an.
doubleStrikeThrough Gibt einen Wert an, der angibt, ob die Schriftart doppelt durchgestrichen ist.
highlightColor Gibt die Hervorhebungsfarbe an.
italic Gibt einen Wert an, der angibt, ob die Schriftart kursiv formatiert ist.
name Gibt einen Wert an, der den Namen der Schriftart darstellt.
size Gibt einen Wert an, der den Schriftgrad in Punkt darstellt.
Durchgestrichen Gibt einen Wert an, der angibt, ob die Schriftart durchgestrichen ist.
subscript Gibt einen Wert an, der angibt, ob die Schriftart ein Tiefgestellt ist.
superscript Gibt einen Wert an, der angibt, ob die Schriftart hochgestellt ist.
underline Gibt einen Wert an, der den Unterstreichungstyp der Schriftart angibt.
InlinePicture altTextDescription Gibt eine Zeichenfolge an, die den alternativen Text darstellt, der dem Inlinebild zugeordnet ist.
altTextTitle Gibt eine Zeichenfolge an, die den Titel für das Inlinebild enthält.
getBase64ImageSrc() Ruft die Base64-codierte Zeichenfolgendarstellung des Inlinebilds ab.
height Gibt eine Zahl an, die die Höhe des Inlinebilds beschreibt.
hyperlink Gibt einen Link für das Bild an.
insertContentControl() Umschließt das eingebundene Bild mit einem Rich-Text-Inhaltssteuerelement.
lockAspectRatio Gibt einen Wert an, der angibt, ob das Inlinebild seine ursprünglichen Proportionen beibehält, wenn Sie dessen Größe ändern.
parentContentControl Ruft das Inhaltssteuerelement ab, das das eingebundene Bild enthält.
width Gibt eine Zahl an, die die Breite des Inlinebilds beschreibt.
InlinePictureCollection items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
Paragraph Ausrichtung Gibt die Ausrichtung für einen Absatz an.
clear() Löscht den Inhalt des Abschnittsobjekts.
contentControls Ruft die Auflistung von Inhaltssteuerelementobjekten im Absatz ab.
delete() Löscht den Absatz und seinen Inhalt aus dem Dokument.
firstLineIndent Gibt den Wert für eine erste Zeile oder einen hängenden Einzug in Punkt an.
font Ruft das Textformat des Abschnitts ab.
getHtml() Ruft eine HTML-Darstellung des Absatzobjekts ab.
getOoxml() Ruft die Office Open XML (OOXML)-Darstellung des Abschnittsobjekts ab.
inlinePictures Ruft die Auflistung von InlinePicture-Objekten im Absatz ab.
insertBreak(breakType: Word. BreakType | "Seite" | "Weiter" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Vor" | "Nach") Fügt an der angegebenen Position im Hauptdokument einen Umbruch ein.
insertContentControl() Umschließt das Paragraph-Objekt mit einem Rich-Text-Inhaltssteuerelement.
insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Ersetzen" | "Start" | "Ende") Fügt ein Dokument an der angegebenen Position in den Absatz ein.
insertHtml(html: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Ersetzen" | "Start" | "Ende") Fügt in den aktuellen Abschnitt an der angegebenen Position HTML-Code ein.
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Ersetzen" | "Start" | "Ende") Fügt in den aktuellen Abschnitt an der angegebenen Position ein Bild ein.
insertOoxml(ooxml: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Ersetzen" | "Start" | "Ende") Fügt OOXML an der angegebenen Position in den Absatz ein.
insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Vor" | "Nach") Fügt an der angegebenen Position einen Absatz ein.
insertText(text: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Ersetzen" | "Start" | "Ende") Fügt in den Abschnitt an der angegebenen Position Text ein.
leftIndent Gibt den linken Einzugswert für den Absatz in Punkt an.
lineSpacing Gibt den Zeilenabstand für den angegebenen Absatz in Punkt an.
lineUnitAfter Gibt den Abstand in Rasterlinien nach dem Absatz an.
lineUnitBefore Gibt den Abstand in Rasterlinien vor dem Absatz an.
outlineLevel Gibt die Gliederungsebene für den Absatz an.
parentContentControl Ruft das Inhaltssteuerelement ab, das den Abschnitt enthält.
rightIndent Gibt den rechten Einzugswert für den Absatz in Punkt an.
search(searchText: string, searchOptions?: Word. SearchOptions | { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) Führt eine Suche mit den angegebenen SearchOptions für den Bereich des Absatzobjekts aus.
select(selectionMode?: Word. SelectionMode) Wählt und navigiert die Word-Benutzeroberfläche zu diesem Absatz.
spaceAfter Gibt den Abstand nach dem Absatz in Punkt an.
spaceBefore Gibt den Abstand in Punkt vor dem Absatz an.
style Gibt den Formatvorlagennamen für den Absatz an.
text Ruft den Text des Absatzes ab.
ParagraphCollection items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
Range clear() Löscht den Inhalt des Bereichsobjekts.
contentControls Ruft die Auflistung von Inhaltssteuerelementobjekten im Bereich ab.
delete() Löscht den Bereich und seinen Inhalt aus dem Dokument.
font Ruft das Textformat des Bereichs ab.
getHtml() Ruft eine HTML-Darstellung des Bereichsobjekts ab.
getOoxml() Ruft die OOXML-Darstellung des Bereichsobjekts ab.
insertBreak(breakType: Word. BreakType | "Seite" | "Weiter" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Vor" | "Nach") Fügt an der angegebenen Position im Hauptdokument einen Umbruch ein.
insertContentControl() Umschließt das Range-Objekt mit einem Rich-Text-Inhaltssteuerelement.
insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation | "Ersetzen" | "Start" | "Ende" | "Vor" | "Nach") Fügt an der angegebenen Position ein Dokument ein.
insertHtml(html: string, insertLocation: Word. InsertLocation | "Ersetzen" | "Start" | "Ende" | "Vor" | "Nach") Fügt an der angegebenen Position HTML-Code ein.
insertOoxml(ooxml: string, insertLocation: Word. InsertLocation | "Ersetzen" | "Start" | "Ende" | "Vor" | "Nach") Fügt an der angegebenen Position OOXML-Code ein.
insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Vor" | "Nach") Fügt an der angegebenen Position einen Absatz ein.
insertText(text: string, insertLocation: Word. InsertLocation | "Ersetzen" | "Start" | "Ende" | "Vor" | "Nach") Fügt an der angegebenen Position Text ein.
paragraphs Ruft die Auflistung von Absatzobjekten im Bereich ab.
parentContentControl Ruft das Inhaltssteuerelement ab, das den Bereich enthält.
search(searchText: string, searchOptions?: Word. SearchOptions | { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) Führt eine Suche mit den angegebenen SearchOptions im Bereich des Bereichsobjekts aus.
select(selectionMode?: Word. SelectionMode) Wählt und navigiert die Word-Benutzeroberfläche zu diesem Bereich.
style Gibt den Formatvorlagennamen für den Bereich an.
text Ruft den Text des Bereichs ab.
RangeCollection items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
SearchOptions ignorePunct Gibt einen Wert an, der angibt, ob alle Interpunktionszeichen zwischen Wörtern ignoriert werden sollen.
ignoreSpace Gibt einen Wert an, der angibt, ob alle Leerzeichen zwischen Wörtern ignoriert werden sollen.
matchCase Gibt einen Wert an, der angibt, ob eine Suche zwischen Groß- und Kleinschreibung durchgeführt werden soll.
matchPrefix Gibt einen Wert an, der angibt, ob Wörter, die mit der Suchzeichenfolge beginnen, übereinstimmen sollen.
matchSuffix Gibt einen Wert an, der angibt, ob Wörter, die mit der Suchzeichenfolge enden, übereinstimmen sollen.
matchWholeWord Gibt einen Wert an, der angibt, ob nur ganze Wörter gesucht werden sollen, nicht Text, der Teil eines größeren Worts ist.
matchWildcards Gibt einen Wert an, der angibt, ob die Suche mit speziellen Suchoperatoren ausgeführt wird.
Section Text Ruft das body-Objekt des Abschnitts ab.
getFooter(type: Word. HeaderFooterType) Ruft eine der Fußzeilen des Abschnitts ab.
getHeader(type: Word. HeaderFooterType) Ruft eine der Kopfzeilen des Abschnitts ab.
SectionCollection items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

Siehe auch