Neuerungen in Word JavaScript-API 1.5

  • Artikel

WordApi 1.5 hat Unterstützung für Fußnoten, Endnoten, Inhaltssteuerungsereignisse und Stilverwaltung hinzugefügt.

API-Liste

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

Klasse Felder Beschreibung
Anwendung retrieveStylesFromBase64(base64File: string) Analysieren Sie Formatvorlagen aus einer Base64-Vorlagendatei, und geben Sie das JSON-Format der abgerufenen Formatvorlagen als Zeichenfolge zurück.
Body Endnoten Ruft die Auflistung der Endnoten im Text ab.
Fußnoten Ruft die Auflistung der Fußnoten im Text ab.
getContentControls(options?: Word. ContentControlOptions) Ruft die derzeit unterstützten Inhaltssteuerelemente im Text ab.
ContentControl Endnoten Ruft die Auflistung der Endnoten im Inhaltssteuerelement ab.
Fußnoten Ruft die Auflistung der Fußnoten im Inhaltssteuerelement ab.
getContentControls(options?: Word. ContentControlOptions) Ruft die derzeit unterstützten untergeordneten Inhaltssteuerelemente in diesem Inhaltssteuerelement ab.
onDataChanged Tritt auf, wenn Daten innerhalb des Inhaltssteuerelements geändert werden.
onDeleted Tritt auf, wenn das Inhaltssteuerelement gelöscht wird.
onEntered Tritt auf, wenn das Inhaltssteuerelement eingegeben wird.
onExited Tritt auf, wenn das Inhaltssteuerelement beendet wird, z. B. wenn der Cursor das Inhaltssteuerelement verlässt.
onSelectionChanged Tritt auf, wenn die Auswahl innerhalb des Inhaltssteuerelements geändert wird.
ContentControlAddedEventArgs eventType Der Ereignistyp.
Ids Ruft die Inhaltssteuerelement-IDs ab.
source Die Quelle des Ereignisses.
ContentControlCollection getByChangeTrackingStates(changeTrackingStates: Word. ChangeTrackingState[]) Ruft die Inhaltssteuerelemente ab, die über den angegebenen Nachverfolgungszustand verfügen.
ContentControlDataChangedEventArgs eventType Der Ereignistyp.
Ids Ruft die Inhaltssteuerelement-IDs ab.
source Die Quelle des Ereignisses.
ContentControlDeletedEventArgs eventType Der Ereignistyp.
Ids Ruft die Inhaltssteuerelement-IDs ab.
source Die Quelle des Ereignisses.
ContentControlEnteredEventArgs eventType Der Ereignistyp.
Ids Ruft die Inhaltssteuerelement-IDs ab.
source Die Quelle des Ereignisses.
ContentControlExitedEventArgs eventType Der Ereignistyp.
Ids Ruft die Inhaltssteuerelement-IDs ab.
source Die Quelle des Ereignisses.
ContentControlOptions types Ein Array von Inhaltssteuerelementtypen, das Element muss "RichText" oder "PlainText" sein.
ContentControlSelectionChangedEventArgs eventType Der Ereignistyp.
Ids Ruft die Inhaltssteuerelement-IDs ab.
source Die Quelle des Ereignisses.
Dokument addStyle(name: string, type: Word. StyleType) Fügt dem Dokument eine Formatvorlage nach Name und Typ hinzu.
close(closeBehavior?: Word. CloseBehavior) Schließt das aktuelle Dokument.
getContentControls(options?: Word. ContentControlOptions) Ruft die derzeit unterstützten Inhaltssteuerelemente im Dokument ab.
getEndnoteBody() Ruft die Endnoten des Dokuments in einem einzelnen Text ab.
getFootnoteBody() Ruft die Fußnoten des Dokuments in einem einzelnen Text ab.
getStyles() Ruft ein StyleCollection-Objekt ab, das den gesamten Formatvorlagensatz des Dokuments darstellt.
insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Ersetzen" | "Start" | "End", insertFileOptions?: Word. InsertFileOptions) Fügt ein Dokument an einer bestimmten Stelle mit zusätzlichen Eigenschaften in das Zieldokument ein.
onContentControlAdded Tritt auf, wenn ein Inhaltssteuerelement hinzugefügt wird.
save(saveBehavior?: Word. SaveBehavior, fileName?: string) Speichert das Dokument.
Field code Gibt die Codeanweisung des Felds an.
data Gibt Daten in einem Addin-Feld an.
delete() Löscht das Feld.
Art Ruft die Art des Felds ab.
locked Gibt an, ob das Feld gesperrt ist.
select(selectionMode?: Word. SelectionMode) Wählt das Feld aus.
type Ruft den Typ des Felds ab.
updateResult() Updates das Feld.
FieldCollection getByTypes(types: Word. FieldType[]) Ruft die Field-Objektauflistung einschließlich der angegebenen Feldtypen ab.
InsertFileOptions importChangeTrackingMode Gibt an, ob der Änderungsnachverfolgungsmodus status aus dem Quelldokument importiert werden soll.
importPageColor Gibt an, ob die Seitenfarbe und andere Hintergrundinformationen aus dem Quelldokument importiert werden sollen.
importParagraphSpacing Gibt an, ob der Absatzabstand aus dem Quelldokument importiert werden soll.
importStyles Gibt an, ob die Formatvorlagen aus dem Quelldokument importiert werden sollen.
importTheme Gibt an, ob das Design aus dem Quelldokument importiert werden soll.
NoteItem Text Stellt das Textobjekt des Notizelements dar.
delete() Löscht das Notizelement.
getNext() Ruft das nächste Notizelement desselben Typs ab.
getNextOrNullObject() Ruft das nächste Notizelement desselben Typs ab.
reference Stellt einen Fuß- oder Endnotenverweis im Standard Dokument dar.
type Stellt den Notizelementtyp dar: Fuß- oder Endnote.
NoteItemCollection getFirst() Ruft das erste Notizelement in dieser Auflistung ab.
getFirstOrNullObject() Ruft das erste Notizelement in dieser Auflistung ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
Paragraph Endnoten Ruft die Auflistung der Endnoten im Absatz ab.
Fußnoten Ruft die Auflistung der Fußnoten im Absatz ab.
getContentControls(options?: Word. ContentControlOptions) Ruft die derzeit unterstützten Inhaltssteuerelemente im Absatz ab.
ParagraphFormat Ausrichtung Gibt die Ausrichtung für die angegebenen Absätze an.
firstLineIndent Gibt den Wert (in Punkt) für eine erste Zeile oder einen hängenden Einzug an.
Keeptogether Gibt an, ob alle Zeilen in den angegebenen Absätzen auf derselben Seite verbleiben, wenn Microsoft Word das Dokument neu ausgestaltet.
keepWithNext Gibt an, ob der angegebene Absatz auf derselben Seite wie der darauf folgende Absatz verbleibt, wenn Microsoft Word das Dokument neu ausgestaltet.
leftIndent Gibt den linken Einzug an.
lineSpacing Gibt den Zeilenabstand (in Punkt) für die angegebenen Absätze an.
lineUnitAfter Gibt den Abstand (in Gitternetzlinien) nach den angegebenen Absätzen an.
lineUnitBefore Gibt den Abstand (in Gitternetzlinien) vor den angegebenen Absätzen an.
mirrorIndents Gibt an, ob linke und rechte Einzüge die gleiche Breite aufweisen.
outlineLevel Gibt die Gliederungsebene für die angegebenen Absätze an.
rightIndent Gibt den rechten Einzug (in Punkt) für die angegebenen Absätze an.
spaceAfter Gibt den Abstand (in Punkt) nach dem angegebenen Absatz oder der angegebenen Textspalte an.
spaceBefore Gibt den Abstand (in Punkt) vor den angegebenen Absätzen an.
widowControl Gibt an, ob die erste und letzte Zeile im angegebenen Absatz auf derselben Seite wie der Rest des Absatzes verbleiben, wenn Microsoft Word das Dokument neu ausgestaltet.
Range Endnoten Ruft die Auflistung der Endnoten im Bereich ab.
Fußnoten Ruft die Auflistung der Fußnoten im Bereich ab.
getContentControls(options?: Word. ContentControlOptions) Ruft die derzeit unterstützten Inhaltssteuerelemente im Bereich ab.
insertEndnote(insertText?: string) Fügt eine Endnote ein.
insertField(insertLocation: Word. InsertLocation | "Ersetzen" | "Start" | "Ende" | "Vor" | "After", fieldType?: Word. FieldType, text?: string, removeFormatting?: boolean) Fügt ein Feld an der angegebenen Position ein.
insertFootnote(insertText?: string) Fügt eine Fußnote ein.
Style baseStyle Ruft den Namen einer vorhandenen Formatvorlage ab, die als Basisformatierung einer anderen Formatvorlage verwendet werden soll.
Builtin Ruft ab, ob die angegebene Formatvorlage eine integrierte Formatvorlage ist.
delete() Löscht die Formatvorlage.
font Ruft ein Schriftartobjekt ab, das die Zeichenformatierung der angegebenen Formatvorlage darstellt.
inVerwenden Ruft ab, ob es sich bei der angegebenen Formatvorlage um eine integrierte Formatvorlage handelt, die im Dokument geändert oder angewendet wurde, oder um eine neue Formatvorlage, die im Dokument erstellt wurde.
Verknüpft Ruft ab, ob eine Formatvorlage eine verknüpfte Formatvorlage ist, die sowohl für die Absatz- als auch für die Zeichenformatierung verwendet werden kann.
nameLocal Ruft den Namen einer Formatvorlage in der Sprache des Benutzers ab.
nextParagraphStyle Ruft den Namen der Formatvorlage ab, die automatisch auf einen neuen Absatz angewendet werden soll, der nach einem Absatz eingefügt wird, der mit der angegebenen Formatvorlage formatiert ist.
paragraphFormat Ruft ein ParagraphFormat-Objekt ab, das die Absatzeinstellungen für die angegebene Formatvorlage darstellt.
Priorität Gibt die Priorität an.
quickStyle Gibt an, ob die Formatvorlage einer verfügbaren Schnellformatvorlage entspricht.
type Ruft den Stiltyp ab.
Unhidewhenused Gibt an, ob die angegebene Formatvorlage als empfohlene Formatvorlage in den Formatvorlagen und im Aufgabenbereich Formatvorlagen in Microsoft Word sichtbar gemacht wird, nachdem sie im Dokument verwendet wurde.
Sichtbarkeit Gibt an, ob die angegebene Formatvorlage als empfohlene Formatvorlage im Formatvorlagenkatalog und im Aufgabenbereich Formatvorlagen angezeigt wird.
StyleCollection getByName(name: string) Rufen Sie das Stilobjekt anhand seines Namens ab.
getByNameOrNullObject(name: string) Wenn die entsprechende Formatvorlage nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist.
getCount() Ruft die Anzahl der Formatvorlagen in der Auflistung ab.
getItem(index: number) Ruft ein Stilobjekt anhand seines Indexes in der Auflistung ab.
items Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
Table Endnoten Ruft die Auflistung der Endnoten in der Tabelle ab.
Fußnoten Ruft die Auflistung der Fußnoten in der Tabelle ab.
TableRow Endnoten Ruft die Auflistung der Endnoten in der Tabellenzeile ab.
Fußnoten Ruft die Auflistung der Fußnoten in der Tabellenzeile ab.

Siehe auch