Word.Range class
Stellt einen zusammenhängenden Bereich in einem Dokument dar.
- Extends
Hinweise
Verwendet von
- Word. Text: getRange, insertFileFromBase64, insertHtml, insertOoxml, insertText
- Word. Lesezeichen: Bereich
- Word. BookmarkCollection: hinzufügen
- Word. Pause: Bereich
- Word. BuildingBlock: Einfügen
- Word. BuildingBlockCollection: hinzufügen
- Word. BuildingBlockEntryCollection: hinzufügen
- Word. BuildingBlockGalleryContentControl: Bereich
- Word. CoauthoringLock: Bereich
- Word. CoauthoringLockAddOptions: Bereich
- Word. Co-AuthoringUpdate: Bereich
- Word. Kommentar: getRange
- Word. Konflikt: Bereich
- Word. ContentControl: getRange, insertFileFromBase64, insertHtml, insertOoxml, insertText
- Word. ContentControlPlaceholderOptions: Bereich
- Word. CritiqueAnnotation: range
- Word. DatePickerContentControl: Bereich
- Word. Dokument: content, getBookmarkRange, getBookmarkRangeOrNullObject, getRange, getSelection, goTo
- Word. DocumentCreated: getBookmarkRange, getBookmarkRangeOrNullObject
- Word. Editor: nextRange, range
- Word. Feld: Ergebnis
- Word. Rahmen: Bereich
- Word. FrameCollection: hinzufügen
- Word. GroupContentControl: Bereich
- Word. HtmlDivision: range
- Word. Link: Bereich
- Word. HyperlinkCollection: hinzufügen
- Word. Index: Bereich
- Word. IndexCollection: hinzufügen, markAllEntries
- Word. InlinePicture: getRange, insertFileFromBase64, insertHtml, insertOoxml, insertText
- Word. NoteItem: reference
- Word. Seite: getRange
- Word. Absatz: getRange, insertFileFromBase64, insertHtml, insertOoxml, insertText
- Word. ParagraphCollection: hinzufügen
- Word. PictureContentControl: range
- Word. RangeCollection: getFirst, getFirstOrNullObject, Elemente
- Word. RangeScopedCollection: getItem, Elemente
- Word. RepeatingSectionContentControl: Bereich
- Word. RepeatingSectionItem: Bereich
- Word. Revision: movedRange, Bereich
- Word. Auswahl: formattedText, getNextRange, getPreviousRange, goTo, goToNext, goToPrevious, isEqual, isInRange, isInStory, range
- Word. Tabelle: convertToText, getRange
- Word. TableOfAuthorities: Bereich
- Word. TableOfAuthoritiesCollection: hinzufügen, markCitation
- Word. TableOfContents: Bereich
- Word. TableOfContentsCollection: hinzufügen, markTocEntry
- Word. TableOfFigures: Bereich
- Word. TableOfFiguresCollection: hinzufügen, markTocEntry
- Word. TableRow: convertToText, Bereich
- Word. TableRowCollection: convertToText
- Word. TrackedChange: getRange
- Word. Ansicht: collapseOutline, expandOutline
- Word. XmlNode: Bereich
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml
// Gets the range of the first comment in the selected content.
await Word.run(async (context) => {
const comment: Word.Comment = context.document.getSelection().getComments().getFirstOrNullObject();
comment.load("contentRange");
const range: Word.Range = comment.getRange();
range.load("text");
await context.sync();
if (comment.isNullObject) {
console.warn("No comments in the selection, so no range to get.");
return;
}
console.log(`Comment location: ${range.text}`);
const contentRange: Word.CommentContentRange = comment.contentRange;
console.log("Comment content range:", contentRange);
});
Eigenschaften
| bold | Gibt an, ob der Bereich fett formatiert ist. |
| bold |
Gibt an, ob der Bereich in einem Dokument mit Lese-/Schreibrichtung von rechts nach links fett formatiert ist. |
| bookmarks | Gibt ein |
| borders | Gibt ein |
| case | Gibt einen |
| character |
Gibt die Zeichenbreite des Bereichs an. |
| combine |
Gibt an, ob der Bereich kombinierte Zeichen enthält. |
| conflicts | Gibt ein |
| content |
Ruft die Sammlung der |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| disable |
Gibt an, ob Microsoft Word die Anzahl der Zeichen pro Zeile für das entsprechende |
| editors | Gibt ein |
| emphasis |
Gibt das Hervorhebungszeichen für ein Zeichen oder eine festgelegte Zeichenfolge an. |
| end | Gibt die Position des Bereichs am Ende des Bereichs an. |
| endnotes | Ruft die Sammlung der Endnoten im Bereich ab. |
| fields | Ruft die Sammlung der |
| fit |
Gibt die Breite (in den aktuellen Maßeinheiten) an, in die Microsoft Word den Text in der aktuellen Auswahl oder im aktuellen Bereich einpasst. |
| font | Ruft das Textformat des Bereichs ab. Verwenden Sie diese Option zum Abrufen und Festlegen des Schriftartnamens, der Größe, Farbe und anderer Eigenschaften. |
| footnotes | Ruft die Sammlung der Fußnoten im Bereich ab. |
| frames | Ruft ein |
| grammar |
Gibt an, ob für den Bereich oder das Dokument eine Grammatikprüfung durchgeführt wurde. |
| has |
Gibt den Status der Korrekturhilfen (Rechtschreib- und Grammatikprüfung) des Bereichs an. |
| highlight |
Gibt die Hervorhebungsfarbe für den Bereich an. |
| horizontal |
Gibt die Formatierung für horizontalen Text an, der in vertikalem Text festgelegt ist. |
| hyperlink | Ruft den ersten Link in dem Bereich ab oder legt einen Link für den Bereich fest. Wenn Sie einen neuen Link für den Bereich festlegen, werden alle Links im Bereich gelöscht. Verwenden Sie ein '#', um den Adressteil vom optionalen Speicherortteil zu trennen. |
| hyperlinks | Gibt ein |
| id | Gibt die ID für den Bereich an. |
| inline |
Ruft die Sammlung der |
| is |
Überprüft, ob die Länge des Bereichs 0 ist. |
| is |
Wird abgerufen, wenn der Bereich reduziert ist und sich am Zeilenende in einer Tabelle befindet. |
| is |
Ruft ab, ob der Text in dem Bereich auf dem Bildschirm sichtbar ist. |
| italic | Gibt an, ob die Schriftart oder der Bereich kursiv formatiert ist. |
| italic |
Gibt an, ob die Schriftart oder der Bereich kursiv formatiert ist (Sprachen mit Lese-/Schreibrichtung von rechts nach links). |
| kana | Gibt an, ob der Textbereich in japanischer Sprache Hiragana oder Katakana ist. |
| language |
Gibt an, ob Microsoft Word die Sprache des Texts im Bereich erkannt hat. |
| language |
Gibt einen |
| language |
Gibt eine ostasiatische Sprache für den Bereich an. |
| language |
Gibt eine Sprache für den Bereich an, die nicht als ostasiatische Sprache klassifiziert ist. |
| list |
Gibt ein |
| lists | Ruft die Sammlung der |
| pages | Ruft die Sammlung der Seiten im Bereich ab. |
| paragraphs | Ruft die Sammlung der |
| parent |
Ruft den übergeordneten Text des Bereichs ab. |
| parent |
Ruft das aktuell unterstützte Inhaltssteuerelement ab, das den Bereich enthält. Gibt einen |
| parent |
Ruft das aktuell unterstützte Inhaltssteuerelement ab, das den Bereich enthält. Wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist, gibt diese Methode ein Objekt zurück, dessen |
| parent |
Ruft die Tabelle ab, die den Bereich enthält. Gibt einen |
| parent |
Ruft die Tabellenzelle ab, die den Bereich enthält. Gibt einen |
| parent |
Ruft die Tabellenzelle ab, die den Bereich enthält. Wenn sie nicht in einer Tabellenzelle enthalten ist, gibt diese Methode ein Objekt zurück, dessen |
| parent |
Ruft die Tabelle ab, die den Bereich enthält. Wenn sie nicht in einer Tabelle enthalten ist, gibt diese Methode ein Objekt zurück, dessen |
| revisions | Ruft die Auflistung der Revisionen ab, die die nachverfolgten Änderungen im Bereich darstellen. |
| sections | Ruft die Auflistung der Abschnitte im Bereich ab. |
| shading | Gibt ein |
| shapes | Ruft die Sammlung der |
| show |
Gibt an, ob alle nicht druckbaren Zeichen (z. B. ausgeblendeter Text, Tabstopp-, Leerzeichen- und Absatzmarken) angezeigt werden. |
| spelling |
Gibt an, ob die Rechtschreibung im gesamten Bereich oder Dokument überprüft wurde. |
| start | Gibt die Position des Anfangszeichens des Bereichs an. |
| story |
Ruft die Anzahl der Zeichen in der Geschichte ab, die den Bereich enthalten. |
| story |
Ruft den Story-Typ für den Bereich ab. |
| style | Gibt den Formatvorlagennamen für den Bereich an. Verwenden Sie diese Eigenschaft für benutzerdefinierte Formatvorlagen und lokalisierte Formatvorlagennamen. Informationen zur Verwendung der integrierten Formatvorlagen, die zwischen Gebietsschemas portabel sind, finden Sie unter der Eigenschaft "styleBuiltIn". |
| style |
Gibt den Namen der integrierten Formatvorlage für den Bereich an. Verwenden Sie diese Eigenschaft für integrierte Formatvorlagen, die zwischen Gebietsschemas portabel sind. Informationen zum Verwenden benutzerdefinierter Formatvorlagen oder lokalisierter Namen finden Sie unter der Eigenschaft "style". |
| table |
Ruft ein |
| tables | Ruft die Sammlung der |
| text | Ruft den Text des Bereichs ab. |
| two |
Gibt an, ob Microsoft Word zwei Textzeilen in einer Zeile festlegt, und gibt die Zeichen an, die den Text umschließen, falls vorhanden. |
| underline | Gibt den Typ der Unterstreichung an, die auf den Bereich angewendet wird. |
Methoden
| clear() | Löscht den Inhalt des |
| compare |
Vergleicht die Position dieses Bereichs mit der eines anderen Bereichs. |
| delete() | Löscht den Bereich und seinen Inhalt aus dem Dokument. |
| detect |
Analysiert den Bereichstext, um die Sprache zu bestimmen, in der er geschrieben ist. |
| expand |
Gibt einen neuen Bereich zurück, der diesen Bereich in beide Richtungen erweitert, um einen anderen Bereich zu überdecken. Dieser Bereich wird nicht geändert. Löst einen |
| expand |
Gibt einen neuen Bereich zurück, der diesen Bereich in beide Richtungen erweitert, um einen anderen Bereich zu überdecken. Dieser Bereich wird nicht geändert. Wenn die beiden Bereiche keine Union haben, dann gibt diese Methode ein Objekt zurück, dessen |
| get |
Ruft die Namen, alle Lesezeichen im oder überlappenden Bereich ab. Eine Textmarke ist ausgeblendet, wenn ihr Name mit einem Unterstrich beginnt. |
| get |
Ruft Kommentare ab, die dem Bereich zugeordnet sind. |
| get |
Ruft die derzeit unterstützten Inhaltssteuerelemente im Bereich ab. |
| get |
Ruft eine HTML-Darstellung des |
| get |
Ruft untergeordnete Linkbereiche innerhalb des Bereichs ab. |
| get |
Ruft den nächsten Textbereich mithilfe von Satzzeichen und anderen Endzeichen ab. Gibt einen |
| get |
Ruft den nächsten Textbereich mithilfe von Satzzeichen und anderen Endzeichen ab. Wenn dieser Textbereich der letzte ist, gibt diese Methode ein Objekt zurück, dessen |
| get |
Ruft die OOXML-Darstellung des |
| get |
Klont das |
| get |
Ruft den überprüften Text basierend auf der ChangeTrackingVersion-Auswahl ab. |
| get |
Ruft den überprüften Text basierend auf der ChangeTrackingVersion-Auswahl ab. |
| get |
Ruft die untergeordneten Textbereiche im Bereich mithilfe von Satzzeichen und anderen Endzeichen ab. |
| get |
Ruft die Sammlung der |
| highlight() | Hebt den Bereich vorübergehend hervor, ohne den Dokumentinhalt zu ändern. Um den Text dauerhaft hervorzuheben, legen Sie den Wert des Bereichs . |
| insert |
Fügt eine Textmarke in den Bereich ein. Wenn irgendwo ein gleichnamiges Lesezeichen vorhanden ist, wird es zuerst gelöscht. |
| insert |
Fügt an der angegebenen Position im Hauptdokument einen Umbruch ein. |
| insert |
Fügt einen unverankerten Zeichenbereich vor dem Text mit seinem Anker am Anfang des Bereichs ein. |
| insert |
Fügen Sie einen Kommentar in den Bereich ein. |
| insert |
Umschließt das |
| insert |
Fügt eine Endnote ein. Der Endnotenverweis wird nach dem Bereich platziert. |
| insert |
Fügt ein Feld an der angegebenen Position ein. |
| insert |
Fügt ein Feld an der angegebenen Position ein. |
| insert |
Fügt an der angegebenen Position ein Dokument ein. |
| insert |
Fügt eine Fußnote ein. Der Fußnotenverweis wird nach dem Bereich platziert. |
| insert |
Fügt eine geometrische Form vor dem Text mit seinem Anker am Anfang des Bereichs ein. |
| insert |
Fügt eine geometrische Form vor dem Text mit seinem Anker am Anfang des Bereichs ein. |
| insert |
Fügt an der angegebenen Position HTML-Code ein. |
| insert |
Fügt an der angegebenen Position ein Bild ein. |
| insert |
Fügt an der angegebenen Position OOXML-Code ein. |
| insert |
Fügt an der angegebenen Position einen Absatz ein. |
| insert |
Fügt ein unverankertes Bild vor dem Text mit seinem Anker am Anfang des Bereichs ein. |
| insert |
Fügt eine Tabelle mit der angegebenen Anzahl von Zeilen und Spalten ein. |
| insert |
Fügt an der angegebenen Position Text ein. |
| insert |
Fügt ein unverankertes Textfeld vor dem Text mit seinem Anker am Anfang des Bereichs ein. |
| intersect |
Gibt einen neuen Bereich als Schnittmenge dieses Bereichs mit einem anderen Bereich zurück. Dieser Bereich wird nicht geändert. Gibt einen |
| intersect |
Gibt einen neuen Bereich als Schnittmenge dieses Bereichs mit einem anderen Bereich zurück. Dieser Bereich wird nicht geändert. Wenn sich die beiden Bereiche nicht überlappen oder angrenzen, gibt diese Methode ein Objekt zurück, dessen |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| remove |
Entfernt die von der Methode hinzugefügte |
| search(search |
Führt eine Suche mit den angegebenen Suchoptionen für den Bereich des Objekts |
| select(selection |
Wählt und navigiert die Word-Benutzeroberfläche zu diesem Bereich. |
| select(selection |
Wählt und navigiert die Word-Benutzeroberfläche zu diesem Bereich. |
| 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. |
| split(delimiters, multi |
Teilt den Bereich mithilfe von Trennzeichen in untergeordnete Bereiche. |
| toJSON() | Überschreibt die JavaScript-Methode |
| 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 aufrufübergreifend |
| 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 einen Aufruf durchführen |
Ereignisse
| on |
Tritt auf, wenn neue Kommentare hinzugefügt werden. |
| on |
Tritt auf, wenn ein Kommentar oder dessen Antwort geändert wird. |
| on |
Tritt auf, wenn die Auswahl eines Kommentars aufgehoben wird. |
| on |
Tritt auf, wenn ein Kommentar ausgewählt ist. |
Details zur Eigenschaft
bold
Gibt an, ob der Bereich fett formatiert ist.
readonly bold: boolean;Eigenschaftswert
boolean
Hinweise
boldBidirectional
Gibt an, ob der Bereich in einem Dokument mit Lese-/Schreibrichtung von rechts nach links fett formatiert ist.
readonly boldBidirectional: boolean;Eigenschaftswert
boolean
Hinweise
bookmarks
Gibt ein BookmarkCollection Objekt zurück, das alle Textmarken im Bereich darstellt.
readonly bookmarks: Word.BookmarkCollection;Eigenschaftswert
Hinweise
borders
Gibt ein BorderUniversalCollection Objekt zurück, das alle Rahmen für den Bereich darstellt.
readonly borders: Word.BorderUniversalCollection;Eigenschaftswert
Hinweise
case
Gibt einen CharacterCase Wert an, der die Groß- oder Kleinschreibung des Texts im Bereich angibt.
case: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana";Eigenschaftswert
Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"
Hinweise
characterWidth
Gibt die Zeichenbreite des Bereichs an.
characterWidth: Word.CharacterWidth | "Half" | "Full";Eigenschaftswert
Word.CharacterWidth | "Half" | "Full"
Hinweise
combineCharacters
Gibt an, ob der Bereich kombinierte Zeichen enthält.
combineCharacters: boolean;Eigenschaftswert
boolean
Hinweise
conflicts
Gibt ein ConflictCollection Objekt zurück, das das gesamte Word enthält. Konfliktobjekte im Bereich.
readonly conflicts: Word.ConflictCollection;Eigenschaftswert
Hinweise
contentControls
Ruft die Sammlung der ContentControl Objekte im Bereich ab.
readonly contentControls: Word.ContentControlCollection;Eigenschaftswert
Hinweise
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
disableCharacterSpaceGrid
Gibt an, ob Microsoft Word die Anzahl der Zeichen pro Zeile für das entsprechende Range Objekt ignoriert.
readonly disableCharacterSpaceGrid: boolean;Eigenschaftswert
boolean
Hinweise
editors
Gibt ein EditorCollection Objekt zurück, das alle Benutzer repräsentiert, die berechtigt sind, den Bereich zu ändern, wenn sich das Dokument im geschützten (schreibgeschützten) Modus befindet.
readonly editors: Word.EditorCollection;Eigenschaftswert
Hinweise
emphasisMark
Gibt das Hervorhebungszeichen für ein Zeichen oder eine festgelegte Zeichenfolge an.
readonly emphasisMark: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle";Eigenschaftswert
Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"
Hinweise
end
Gibt die Position des Bereichs am Ende des Bereichs an.
end: number;Eigenschaftswert
number
Hinweise
endnotes
Ruft die Sammlung der Endnoten im Bereich ab.
readonly endnotes: Word.NoteItemCollection;Eigenschaftswert
Hinweise
fields
Ruft die Sammlung der Field Objekte im Bereich ab.
readonly fields: Word.FieldCollection;Eigenschaftswert
Hinweise
fitTextWidth
Gibt die Breite (in den aktuellen Maßeinheiten) an, in die Microsoft Word den Text in der aktuellen Auswahl oder im aktuellen Bereich einpasst.
fitTextWidth: number;Eigenschaftswert
number
Hinweise
font
Ruft das Textformat des Bereichs ab. Verwenden Sie diese Option zum Abrufen und Festlegen des Schriftartnamens, der Größe, Farbe und anderer Eigenschaften.
readonly font: Word.Font;Eigenschaftswert
Hinweise
footnotes
Ruft die Sammlung der Fußnoten im Bereich ab.
readonly footnotes: Word.NoteItemCollection;Eigenschaftswert
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-footnotes.yaml
// Gets the footnotes in the selected document range.
await Word.run(async (context) => {
const footnotes: Word.NoteItemCollection = context.document.getSelection().footnotes;
footnotes.load("length");
await context.sync();
console.log("Number of footnotes in the selected range: " + footnotes.items.length);
});
frames
Ruft ein FrameCollection Objekt ab, das alle Frames im Bereich darstellt.
readonly frames: Word.FrameCollection;Eigenschaftswert
Hinweise
grammarChecked
Gibt an, ob für den Bereich oder das Dokument eine Grammatikprüfung durchgeführt wurde.
grammarChecked: boolean;Eigenschaftswert
boolean
Hinweise
hasNoProofing
Gibt den Status der Korrekturhilfen (Rechtschreib- und Grammatikprüfung) des Bereichs an.
hasNoProofing: boolean;Eigenschaftswert
boolean
Hinweise
highlightColorIndex
Gibt die Hervorhebungsfarbe für den Bereich an.
readonly highlightColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor";Eigenschaftswert
Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"
Hinweise
horizontalInVertical
Gibt die Formatierung für horizontalen Text an, der in vertikalem Text festgelegt ist.
horizontalInVertical: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine";Eigenschaftswert
Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"
Hinweise
hyperlink
Ruft den ersten Link in dem Bereich ab oder legt einen Link für den Bereich fest. Wenn Sie einen neuen Link für den Bereich festlegen, werden alle Links im Bereich gelöscht. Verwenden Sie ein '#', um den Adressteil vom optionalen Speicherortteil zu trennen.
hyperlink: string;Eigenschaftswert
string
Hinweise
hyperlinks
Gibt ein HyperlinkCollection Objekt zurück, das alle Links im Bereich darstellt.
readonly hyperlinks: Word.HyperlinkCollection;Eigenschaftswert
Hinweise
id
Gibt die ID für den Bereich an.
id: string;Eigenschaftswert
string
Hinweise
inlinePictures
Ruft die Sammlung der InlinePicture Objekte im Bereich ab.
readonly inlinePictures: Word.InlinePictureCollection;Eigenschaftswert
Hinweise
isEmpty
Überprüft, ob die Länge des Bereichs 0 ist.
readonly isEmpty: boolean;Eigenschaftswert
boolean
Hinweise
isEndOfRowMark
Wird abgerufen, wenn der Bereich reduziert ist und sich am Zeilenende in einer Tabelle befindet.
readonly isEndOfRowMark: boolean;Eigenschaftswert
boolean
Hinweise
isTextVisibleOnScreen
Ruft ab, ob der Text in dem Bereich auf dem Bildschirm sichtbar ist.
readonly isTextVisibleOnScreen: boolean;Eigenschaftswert
boolean
Hinweise
italic
Gibt an, ob die Schriftart oder der Bereich kursiv formatiert ist.
readonly italic: boolean;Eigenschaftswert
boolean
Hinweise
italicBidirectional
Gibt an, ob die Schriftart oder der Bereich kursiv formatiert ist (Sprachen mit Lese-/Schreibrichtung von rechts nach links).
readonly italicBidirectional: boolean;Eigenschaftswert
boolean
Hinweise
kana
Gibt an, ob der Textbereich in japanischer Sprache Hiragana oder Katakana ist.
kana: Word.Kana | "Katakana" | "Hiragana";Eigenschaftswert
Word.Kana | "Katakana" | "Hiragana"
Hinweise
languageDetected
Gibt an, ob Microsoft Word die Sprache des Texts im Bereich erkannt hat.
languageDetected: boolean;Eigenschaftswert
boolean
Hinweise
languageId
Gibt einen LanguageId Wert an, der die Sprache für den Bereich darstellt.
languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu";Eigenschaftswert
Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"
Hinweise
languageIdFarEast
Gibt eine ostasiatische Sprache für den Bereich an.
languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu";Eigenschaftswert
Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"
Hinweise
languageIdOther
Gibt eine Sprache für den Bereich an, die nicht als ostasiatische Sprache klassifiziert ist.
languageIdOther: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu";Eigenschaftswert
Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"
Hinweise
listFormat
Gibt ein ListFormat Objekt zurück, das alle Listenformatierungsmerkmale des Bereichs darstellt.
readonly listFormat: Word.ListFormat;Eigenschaftswert
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/format-list-range.yaml
// Gets the range covering the entire body and reads list formatting properties.
await Word.run(async (context) => {
const bodyRange: Word.Range = context.document.body.getRange();
const listFormat: Word.ListFormat = bodyRange.listFormat;
listFormat.load("isSingleList, listType, listLevelNumber, listString, listValue");
await context.sync();
console.log("List format info for the body range:");
console.log(`- Is single list: ${listFormat.isSingleList}`);
console.log(`- List type: ${listFormat.listType}`);
console.log(`- List level number (first paragraph): ${listFormat.listLevelNumber}`);
console.log(`- List string (first paragraph): "${listFormat.listString}"`);
console.log(`- List value (first paragraph): ${listFormat.listValue}`);
});
lists
Ruft die Sammlung der List Objekte im Bereich ab.
readonly lists: Word.ListCollection;Eigenschaftswert
Hinweise
pages
Ruft die Sammlung der Seiten im Bereich ab.
readonly pages: Word.PageCollection;Eigenschaftswert
Hinweise
paragraphs
Ruft die Sammlung der Paragraph Objekte im Bereich ab.
readonly paragraphs: Word.ParagraphCollection;Eigenschaftswert
Hinweise
Wichtig: Für die Anforderungssätze 1.1 und 1.2 werden Absätze in Tabellen, die vollständig in diesem Bereich liegen, nicht zurückgegeben. Aus Anforderungssatz 1.3 werden auch Absätze in solchen Tabellen zurückgegeben.
parentBody
Ruft den übergeordneten Text des Bereichs ab.
readonly parentBody: Word.Body;Eigenschaftswert
Hinweise
parentContentControl
Ruft das aktuell unterstützte Inhaltssteuerelement ab, das den Bereich enthält. Gibt einen ItemNotFound Fehler aus, wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist.
readonly parentContentControl: Word.ContentControl;Eigenschaftswert
Hinweise
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 of the first checkbox content control found in the selection.
await Word.run(async (context) => {
const selectedRange: Word.Range = context.document.getSelection();
let selectedContentControl = selectedRange
.getContentControls({
types: [Word.ContentControlType.checkBox]
})
.getFirstOrNullObject();
selectedContentControl.load("id,checkboxContentControl/isChecked");
await context.sync();
if (selectedContentControl.isNullObject) {
const parentContentControl: Word.ContentControl = selectedRange.parentContentControl;
parentContentControl.load("id,type,checkboxContentControl/isChecked");
await context.sync();
if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.checkBox) {
console.warn("No checkbox content control is currently selected.");
return;
} else {
selectedContentControl = parentContentControl;
}
}
const isCheckedBefore = selectedContentControl.checkboxContentControl.isChecked;
console.log("isChecked state before:", `id: ${selectedContentControl.id} ... isChecked: ${isCheckedBefore}`);
selectedContentControl.checkboxContentControl.isChecked = !isCheckedBefore;
selectedContentControl.load("id,checkboxContentControl/isChecked");
await context.sync();
console.log(
"isChecked state after:",
`id: ${selectedContentControl.id} ... isChecked: ${selectedContentControl.checkboxContentControl.isChecked}`
);
});
parentContentControlOrNullObject
Ruft das aktuell unterstützte Inhaltssteuerelement ab, das den Bereich enthält. Wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
readonly parentContentControlOrNullObject: Word.ContentControl;Eigenschaftswert
Hinweise
parentTable
Ruft die Tabelle ab, die den Bereich enthält. Gibt einen ItemNotFound Fehler aus, wenn er nicht in einer Tabelle enthalten ist.
readonly parentTable: Word.Table;Eigenschaftswert
Hinweise
parentTableCell
Ruft die Tabellenzelle ab, die den Bereich enthält. Gibt einen ItemNotFound Fehler aus, wenn er nicht in einer Tabellenzelle enthalten ist.
readonly parentTableCell: Word.TableCell;Eigenschaftswert
Hinweise
parentTableCellOrNullObject
Ruft die Tabellenzelle ab, die den Bereich enthält. Wenn sie nicht in einer Tabellenzelle enthalten ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
readonly parentTableCellOrNullObject: Word.TableCell;Eigenschaftswert
Hinweise
parentTableOrNullObject
Ruft die Tabelle ab, die den Bereich enthält. Wenn sie nicht in einer Tabelle enthalten ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
readonly parentTableOrNullObject: Word.Table;Eigenschaftswert
Hinweise
revisions
Ruft die Auflistung der Revisionen ab, die die nachverfolgten Änderungen im Bereich darstellen.
readonly revisions: Word.RevisionCollection;Eigenschaftswert
Hinweise
sections
Ruft die Auflistung der Abschnitte im Bereich ab.
readonly sections: Word.SectionCollection;Eigenschaftswert
Hinweise
shading
Gibt ein ShadingUniversal Objekt zurück, das auf die Schattierungsformatierung für den Bereich verweist.
readonly shading: Word.ShadingUniversal;Eigenschaftswert
Hinweise
shapes
Ruft die Sammlung der Shape Objekte ab, die im Bereich verankert sind, einschließlich Inline- und unverankerter Formen. Derzeit werden nur die folgenden Formen unterstützt: Textfelder, geometrische Formen, Gruppen, Bilder und Leinwände.
readonly shapes: Word.ShapeCollection;Eigenschaftswert
Hinweise
Wichtig: Beachten Sie, dass mit der Zeit weitere Arten von Formen unterstützt werden können. Daher sollte Ihr Add-In bestimmte Arten von Formen anfordern und verarbeiten.
showAll
Gibt an, ob alle nicht druckbaren Zeichen (z. B. ausgeblendeter Text, Tabstopp-, Leerzeichen- und Absatzmarken) angezeigt werden.
showAll: boolean;Eigenschaftswert
boolean
Hinweise
spellingChecked
Gibt an, ob die Rechtschreibung im gesamten Bereich oder Dokument überprüft wurde.
spellingChecked: boolean;Eigenschaftswert
boolean
Hinweise
start
Gibt die Position des Anfangszeichens des Bereichs an.
start: number;Eigenschaftswert
number
Hinweise
storyLength
Ruft die Anzahl der Zeichen in der Geschichte ab, die den Bereich enthalten.
readonly storyLength: number;Eigenschaftswert
number
Hinweise
storyType
Ruft den Story-Typ für den Bereich ab.
readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice";Eigenschaftswert
Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"
Hinweise
style
Gibt den Formatvorlagennamen für den Bereich an. Verwenden Sie diese Eigenschaft für benutzerdefinierte Formatvorlagen und lokalisierte Formatvorlagennamen. Informationen zur Verwendung der integrierten Formatvorlagen, die zwischen Gebietsschemas portabel sind, finden Sie unter der Eigenschaft "styleBuiltIn".
style: string;Eigenschaftswert
string
Hinweise
styleBuiltIn
Gibt den Namen der integrierten Formatvorlage für den Bereich an. Verwenden Sie diese Eigenschaft für integrierte Formatvorlagen, die zwischen Gebietsschemas portabel sind. Informationen zum Verwenden benutzerdefinierter Formatvorlagen oder lokalisierter Namen finden Sie unter der Eigenschaft "style".
styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";Eigenschaftswert
Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/90-scenarios/doc-assembly.yaml
await Word.run(async (context) => {
const header: Word.Range = context.document.body.insertText("This is a sample Heading 1 Title!!\n",
"Start" /*this means at the beginning of the body */);
header.styleBuiltIn = Word.BuiltInStyleName.heading1;
await context.sync();
});
tableColumns
Ruft ein TableColumnCollection Objekt ab, das alle Tabellenspalten im Bereich darstellt.
readonly tableColumns: Word.TableColumnCollection;Eigenschaftswert
Hinweise
tables
Ruft die Sammlung der Table Objekte im Bereich ab.
readonly tables: Word.TableCollection;Eigenschaftswert
Hinweise
text
Ruft den Text des Bereichs ab.
readonly text: string;Eigenschaftswert
string
Hinweise
twoLinesInOne
Gibt an, ob Microsoft Word zwei Textzeilen in einer Zeile festlegt, und gibt die Zeichen an, die den Text umschließen, falls vorhanden.
twoLinesInOne: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets";Eigenschaftswert
Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"
Hinweise
underline
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.
Gibt den Typ der Unterstreichung an, die auf den Bereich angewendet wird.
readonly underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";Eigenschaftswert
Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"
Hinweise
Details zur Methode
clear()
Löscht den Inhalt des Range Objekts. Der Benutzer kann den Rückgängig-Vorgang auf den gelöschten Inhalt durchführen.
clear(): void;Gibt zurück
void
Hinweise
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue a command to get the current selection and then
// create a proxy range object with the results.
const range = context.document.getSelection();
// Queue a command to clear the contents of the proxy range object.
range.clear();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Cleared the selection (range object)');
});
compareLocationWith(range)
Vergleicht die Position dieses Bereichs mit der eines anderen Bereichs.
compareLocationWith(range: Word.Range): OfficeExtension.ClientResult<Word.LocationRelation>;Parameter
- range
- Word.Range
Der Bereich, der mit diesem Bereich verglichen werden soll.
Gibt zurück
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/compare-location.yaml
// Compares the location of one paragraph in relation to another paragraph.
await Word.run(async (context) => {
const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
paragraphs.load("items");
await context.sync();
const firstParagraphAsRange: Word.Range = paragraphs.items[0].getRange();
const secondParagraphAsRange: Word.Range = paragraphs.items[1].getRange();
const comparedLocation = firstParagraphAsRange.compareLocationWith(secondParagraphAsRange);
await context.sync();
const locationValue: Word.LocationRelation = comparedLocation.value;
console.log(`Location of the first paragraph in relation to the second paragraph: ${locationValue}`);
});
delete()
Löscht den Bereich und seinen Inhalt aus dem Dokument.
delete(): void;Gibt zurück
void
Hinweise
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue a command to get the current selection and then
// create a proxy range object with the results.
const range = context.document.getSelection();
// Queue a command to delete the range object.
range.delete();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Deleted the selection (range object)');
});
detectLanguage()
Analysiert den Bereichstext, um die Sprache zu bestimmen, in der er geschrieben ist.
detectLanguage(): OfficeExtension.ClientResult<boolean>;Gibt zurück
OfficeExtension.ClientResult<boolean>
Hinweise
expandTo(range)
Gibt einen neuen Bereich zurück, der diesen Bereich in beide Richtungen erweitert, um einen anderen Bereich zu überdecken. Dieser Bereich wird nicht geändert. Löst einen ItemNotFound Fehler aus, wenn die beiden Bereiche keine Vereinigung haben.
expandTo(range: Word.Range): Word.Range;Parameter
- range
- Word.Range
Ein weiterer Bereich.
Gibt zurück
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/get-paragraph-on-insertion-point.yaml
await Word.run(async (context) => {
// Get the complete sentence (as range) associated with the insertion point.
const sentences: Word.RangeCollection = context.document
.getSelection()
.getTextRanges(["."] /* Using the "." as delimiter */, false /*means without trimming spaces*/);
sentences.load("$none");
await context.sync();
// Expand the range to the end of the paragraph to get all the complete sentences.
const sentencesToTheEndOfParagraph: Word.RangeCollection = sentences.items[0]
.getRange()
.expandTo(
context.document
.getSelection()
.paragraphs.getFirst()
.getRange(Word.RangeLocation.end)
)
.getTextRanges(["."], false /* Don't trim spaces*/);
sentencesToTheEndOfParagraph.load("text");
await context.sync();
for (let i = 0; i < sentencesToTheEndOfParagraph.items.length; i++) {
console.log(sentencesToTheEndOfParagraph.items[i].text);
}
});
expandToOrNullObject(range)
Gibt einen neuen Bereich zurück, der diesen Bereich in beide Richtungen erweitert, um einen anderen Bereich zu überdecken. Dieser Bereich wird nicht geändert. Wenn die beiden Bereiche keine Union haben, dann gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
expandToOrNullObject(range: Word.Range): Word.Range;Parameter
- range
- Word.Range
Ein weiterer Bereich.
Gibt zurück
Hinweise
getBookmarks(includeHidden, includeAdjacent)
Ruft die Namen, alle Lesezeichen im oder überlappenden Bereich ab. Eine Textmarke ist ausgeblendet, wenn ihr Name mit einem Unterstrich beginnt.
getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean): OfficeExtension.ClientResult<string[]>;Parameter
- includeHidden
-
boolean
Optional. Gibt an, ob ausgeblendete Lesezeichen eingeschlossen werden sollen. Der Standardwert gibt false an, dass die ausgeblendeten Lesezeichen ausgeschlossen werden.
- includeAdjacent
-
boolean
Optional. Gibt an, ob Textmarken einbezogen werden sollen, die an den Bereich angrenzen. Der Standardwert gibt false an, dass die angrenzenden Lesezeichen ausgeschlossen werden.
Gibt zurück
OfficeExtension.ClientResult<string[]>
Hinweise
getComments()
Ruft Kommentare ab, die dem Bereich zugeordnet sind.
getComments(): Word.CommentCollection;Gibt zurück
Ein CommentCollection Objekt, das alle Kommentare enthält, die mit dem Bereich verknüpft sind.
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml
// Gets the comments in the selected content.
await Word.run(async (context) => {
const comments: Word.CommentCollection = context.document.getSelection().getComments();
// Load objects to log in the console.
comments.load();
await context.sync();
console.log("Comments:", comments);
});
getContentControls(options)
Ruft die derzeit unterstützten Inhaltssteuerelemente im Bereich ab.
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;Parameter
- options
- Word.ContentControlOptions
Optional. Optionen, die definieren, welche Inhaltssteuerelemente zurückgegeben werden.
Gibt zurück
Hinweise
Wichtig: Wenn bestimmte Typen im options-Parameter angegeben werden, werden nur Inhaltssteuerelemente unterstützter Typen zurückgegeben. Beachten Sie, dass bei Verwendung der Methoden eines generischen Word eine Ausnahme ausgelöst wird. ContentControl, die für den spezifischen Typ nicht relevant sind. Mit der Zeit werden u. U. weitere Arten von Inhaltssteuerelementen unterstützt. Deshalb 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
// Deletes the first checkbox content control found in the selection.
await Word.run(async (context) => {
const selectedRange: Word.Range = context.document.getSelection();
let selectedContentControl = selectedRange
.getContentControls({
types: [Word.ContentControlType.checkBox]
})
.getFirstOrNullObject();
selectedContentControl.load("id");
await context.sync();
if (selectedContentControl.isNullObject) {
const parentContentControl: Word.ContentControl = selectedRange.parentContentControl;
parentContentControl.load("id,type");
await context.sync();
if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.checkBox) {
console.warn("No checkbox content control is currently selected.");
return;
} else {
selectedContentControl = parentContentControl;
}
}
console.log(`About to delete checkbox content control with id: ${selectedContentControl.id}`);
selectedContentControl.delete(false);
await context.sync();
console.log("Deleted checkbox content control.");
});
getHtml()
Ruft eine HTML-Darstellung des Range Objekts ab. Beim Rendern in einer Webseite oder einem HTML-Viewer entspricht die Formatierung der Formatierung des Dokuments nahe, aber nicht exakt. Diese Methode gibt nicht genau denselben HTML-Code für dasselbe Dokument auf verschiedenen Plattformen (Windows, Mac, Word im Web usw.) zurück. Wenn Sie exakte Genauigkeit oder plattformübergreifende Konsistenz benötigen, verwenden Range.getOoxml() und konvertieren Sie den zurückgegebenen XML-Code in HTML.
getHtml(): OfficeExtension.ClientResult<string>;Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue a command to get the current selection and then
// create a proxy range object with the results.
const range = context.document.getSelection();
// Queue a command to get the HTML of the current selection.
const html = range.getHtml();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('The HTML read from the document was: ' + html.value);
});
getHyperlinkRanges()
Ruft untergeordnete Linkbereiche innerhalb des Bereichs ab.
getHyperlinkRanges(): Word.RangeCollection;Gibt zurück
Hinweise
Beispiele
await Word.run(async (context) => {
// Get the entire document body.
const bodyRange = context.document.body.getRange(Word.RangeLocation.whole);
// Get all the ranges that only consist of hyperlinks.
const hyperLinks = bodyRange.getHyperlinkRanges();
hyperLinks.load("hyperlink");
await context.sync();
// Log each hyperlink.
hyperLinks.items.forEach((linkRange) => {
console.log(linkRange.hyperlink);
});
});
getNextTextRange(endingMarks, trimSpacing)
Ruft den nächsten Textbereich mithilfe von Satzzeichen und anderen Endzeichen ab. Gibt einen ItemNotFound Fehler aus, wenn dieser Textbereich der letzte ist.
getNextTextRange(endingMarks: string[], trimSpacing?: boolean): Word.Range;Parameter
- endingMarks
-
string[]
Die Satzzeichen und andere Endzeichen als Array von Zeichenfolgen.
- trimSpacing
-
boolean
Optional. Gibt an, ob Abstandszeichen (Leerzeichen, Tabulatoren, Spaltenumbrüche und Absatzendmarken) vom Anfang und Ende des zurückgegebenen Bereichs entfernt werden sollen. "Standard" gibt false an, dass Abstandszeichen am Anfang und Ende des Bereichs einbezogen werden.
Gibt zurück
Hinweise
getNextTextRangeOrNullObject(endingMarks, trimSpacing)
Ruft den nächsten Textbereich mithilfe von Satzzeichen und anderen Endzeichen ab. Wenn dieser Textbereich der letzte ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean): Word.Range;Parameter
- endingMarks
-
string[]
Die Satzzeichen und andere Endzeichen als Array von Zeichenfolgen.
- trimSpacing
-
boolean
Optional. Gibt an, ob Abstandszeichen (Leerzeichen, Tabulatoren, Spaltenumbrüche und Absatzendmarken) vom Anfang und Ende des zurückgegebenen Bereichs entfernt werden sollen. "Standard" gibt false an, dass Abstandszeichen am Anfang und Ende des Bereichs einbezogen werden.
Gibt zurück
Hinweise
getOoxml()
Ruft die OOXML-Darstellung des Range Objekts ab.
getOoxml(): OfficeExtension.ClientResult<string>;Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue a command to get the current selection and then
// create a proxy range object with the results.
const range = context.document.getSelection();
// Queue a command to get the OOXML of the current selection.
const ooxml = range.getOoxml();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('The OOXML read from the document was: ' + ooxml.value);
});
getRange(rangeLocation)
Klont das Range Objekt oder ruft den Anfangs- oder Endpunkt des Bereichs als neuen Bereich ab.
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range;Parameter
- rangeLocation
-
whole | start | end | after | content | "Whole" | "Start" | "End" | "After" | "Content"
Optional. Die Bereichsposition muss , start,endafter , oder sein.contentwhole
Gibt zurück
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-dropdown-list-content-control.yaml
// Places a dropdown list content control at the end of the selection.
await Word.run(async (context) => {
let selection = context.document.getSelection();
selection.getRange(Word.RangeLocation.end).insertContentControl(Word.ContentControlType.dropDownList);
await context.sync();
console.log("Dropdown list content control inserted at the end of the selection.");
});
getReviewedText(changeTrackingVersion)
Ruft den überprüften Text basierend auf der ChangeTrackingVersion-Auswahl ab.
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;Parameter
- changeTrackingVersion
- Word.ChangeTrackingVersion
Optional. Der Wert muss OR currentseinoriginal. Der Standardwert ist current.
Gibt zurück
OfficeExtension.ClientResult<string>
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 reviewed text.
await Word.run(async (context) => {
const range: Word.Range = context.document.getSelection();
const before = range.getReviewedText(Word.ChangeTrackingVersion.original);
const after = range.getReviewedText(Word.ChangeTrackingVersion.current);
await context.sync();
console.log("Reviewed text (before):", before.value, "Reviewed text (after):", after.value);
});
getReviewedText(changeTrackingVersion)
Ruft den überprüften Text basierend auf der ChangeTrackingVersion-Auswahl ab.
getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;Parameter
- changeTrackingVersion
-
"Original" | "Current"
Optional. Der Wert muss OR currentseinoriginal. Der Standardwert ist current.
Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
getTextRanges(endingMarks, trimSpacing)
Ruft die untergeordneten Textbereiche im Bereich mithilfe von Satzzeichen und anderen Endzeichen ab.
getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection;Parameter
- endingMarks
-
string[]
Die Satzzeichen und andere Endzeichen als Array von Zeichenfolgen.
- trimSpacing
-
boolean
Optional. Gibt an, ob Abstandszeichen (Leerzeichen, Tabstopps, Spaltenumbrüche und Absatzendmarken) vom Anfang und Ende der in der Bereichssammlung zurückgegebenen Bereiche entfernt werden sollen. "Standard" gibt false an, dass Abstandszeichen am Anfang und Ende der Bereiche in die Bereichssammlung eingeschlossen werden.
Gibt zurück
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/get-paragraph-on-insertion-point.yaml
await Word.run(async (context) => {
// Get the complete sentence (as range) associated with the insertion point.
const sentences: Word.RangeCollection = context.document
.getSelection()
.getTextRanges(["."] /* Using the "." as delimiter */, false /*means without trimming spaces*/);
sentences.load("$none");
await context.sync();
// Expand the range to the end of the paragraph to get all the complete sentences.
const sentencesToTheEndOfParagraph: Word.RangeCollection = sentences.items[0]
.getRange()
.expandTo(
context.document
.getSelection()
.paragraphs.getFirst()
.getRange(Word.RangeLocation.end)
)
.getTextRanges(["."], false /* Don't trim spaces*/);
sentencesToTheEndOfParagraph.load("text");
await context.sync();
for (let i = 0; i < sentencesToTheEndOfParagraph.items.length; i++) {
console.log(sentencesToTheEndOfParagraph.items[i].text);
}
});
getTrackedChanges()
Ruft die Sammlung der TrackedChange Objekte im Bereich ab.
getTrackedChanges(): Word.TrackedChangeCollection;Gibt zurück
Hinweise
highlight()
Hebt den Bereich vorübergehend hervor, ohne den Dokumentinhalt zu ändern. Um den Text dauerhaft hervorzuheben, legen Sie den Wert des Bereichs .font.highlightColor
highlight(): void;Gibt zurück
void
Hinweise
insertBookmark(name)
Fügt eine Textmarke in den Bereich ein. Wenn irgendwo ein gleichnamiges Lesezeichen vorhanden ist, wird es zuerst gelöscht.
insertBookmark(name: string): void;Parameter
- name
-
string
Der Name des Lesezeichens ohne Berücksichtigung der Groß-/Kleinschreibung. Es werden nur alphanumerische Zeichen und Unterstriche unterstützt. Es muss mit einem Buchstaben beginnen. Wenn Sie die Textmarke jedoch als ausgeblendet kennzeichnen möchten, beginnen Sie den Namen mit einem Unterstrich. Namen dürfen maximal 40 Zeichen lang sein.
Gibt zurück
void
Hinweise
Hinweis: Die Bedingungen für das Einfügen einer Textmarke ähneln denen in der Word-Benutzeroberfläche. Weitere Informationen zum Verwalten von Lesezeichen in der Word-Benutzeroberfläche finden Sie unter Hinzufügen oder Löschen von Lesezeichen in einem Word-Dokument oder einer Outlook-Nachricht.
insertBreak(breakType, insertLocation)
Fügt an der angegebenen Position im Hauptdokument einen Umbruch ein.
insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;Parameter
- breakType
-
Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line"
Der hinzuzufügende Umbruchtyp.
Gibt zurück
void
Hinweise
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue a command to get the current selection and then
// create a proxy range object with the results.
const range = context.document.getSelection();
// Queue a command to insert a page break after the selected text.
range.insertBreak(Word.BreakType.page, Word.InsertLocation.after);
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Inserted a page break after the selected text.');
});
insertCanvas(insertShapeOptions)
Fügt einen unverankerten Zeichenbereich vor dem Text mit seinem Anker am Anfang des Bereichs ein.
insertCanvas(insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;Parameter
- insertShapeOptions
- Word.InsertShapeOptions
Optional. Die Position und Größe des Canvas. Der Standardspeicherort und die Standardgröße sind (0, 0, 300, 200).
Gibt zurück
Hinweise
insertComment(commentText)
Fügen Sie einen Kommentar in den Bereich ein.
insertComment(commentText: string): Word.Comment;Parameter
- commentText
-
string
Der einzufügende Kommentartext.
Gibt zurück
Das Comment eingefügte Objekt.
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml
// Sets a comment on the selected content.
await Word.run(async (context) => {
const text = (document.getElementById("comment-text") as HTMLInputElement).value;
const comment: Word.Comment = context.document.getSelection().insertComment(text);
// Load object to log in the console.
comment.load();
await context.sync();
console.log("Comment inserted:", comment);
});
insertContentControl(contentControlType)
Umschließt das Range Objekt mit einem Inhaltssteuerelement.
insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | Word.ContentControlType.buildingBlockGallery | Word.ContentControlType.datePicker | Word.ContentControlType.repeatingSection | Word.ContentControlType.picture | Word.ContentControlType.group | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox" | "BuildingBlockGallery" | "DatePicker" | "RepeatingSection" | "Picture" | "Group"): Word.ContentControl;Parameter
- contentControlType
-
richText | plainText | checkBox | dropDownList | comboBox | buildingBlockGallery | datePicker | repeatingSection | picture | group | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox" | "BuildingBlockGallery" | "DatePicker" | "RepeatingSection" | "Picture" | "Group"
Optional. Einfügender Inhaltssteuerelementtyp. Muss , richTextplainText, ,checkBox , comboBoxdropDownListbuildingBlockGallerypicturerepeatingSectiondatePickeroder sein.group Der Standardwert ist richText.
Gibt zurück
Hinweise
Hinweis: Der contentControlType Parameter wurde in WordApi 1.5 eingeführt.
plainText Unterstützung wurde in WordApi 1.5 hinzugefügt.
checkBox Unterstützung wurde in WordApi 1.7 hinzugefügt.
dropDownList und comboBox Unterstützung wurde in WordApi 1.9 hinzugefügt. Unterstützung für buildingBlockGallery, datePicker, grouppicture, und repeatingSection wurde in WordApiDesktop 1.3 hinzugefügt.
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/90-scenarios/doc-assembly.yaml
// Simulates creation of a template. First searches the document for instances of the string "Contractor",
// then changes the format of each search result,
// then wraps each search result within a content control,
// finally sets a tag and title property on each content control.
await Word.run(async (context) => {
const results: Word.RangeCollection = context.document.body.search("Contractor");
results.load("font/bold");
// Check to make sure these content controls haven't been added yet.
const customerContentControls: Word.ContentControlCollection = context.document.contentControls.getByTag("customer");
customerContentControls.load("text");
await context.sync();
if (customerContentControls.items.length === 0) {
for (let i = 0; i < results.items.length; i++) {
results.items[i].font.bold = true;
let cc: Word.ContentControl = results.items[i].insertContentControl();
cc.tag = "customer"; // This value is used in the next step of this sample.
cc.title = "Customer Name " + i;
}
}
await context.sync();
});
insertEndnote(insertText)
Fügt eine Endnote ein. Der Endnotenverweis wird nach dem Bereich platziert.
insertEndnote(insertText?: string): Word.NoteItem;Parameter
- insertText
-
string
Optional. Text, der in den Text der Endnote eingefügt werden soll. Der Standardwert ist "".
Gibt zurück
Hinweise
insertField(insertLocation, fieldType, text, removeFormatting)
Fügt ein Feld an der angegebenen Position ein.
insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: Word.FieldType, text?: string, removeFormatting?: boolean): Word.Field;Parameter
- insertLocation
-
Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"
Die Position relativ zum Bereich, in den das Feld eingefügt wird. Der Wert muss ,start ,end , beforeoder sein.afterreplace
- fieldType
- Word.FieldType
Optional. Kann ein beliebiger FieldType Wert sein. Der Standardwert ist empty.
- text
-
string
Optional. Zusätzliche Eigenschaften oder Optionen bei Bedarf für den angegebenen Feldtyp.
- removeFormatting
-
boolean
Optional.
trueum andernfalls die Formatierung zu entfernen, die bei Aktualisierungen auf das Feld angewendet wurde. false Der Standardwert ist false.
Gibt zurück
Hinweise
Wichtig: In Word unter Windows und Mac unterstützt die API das Einfügen und Verwalten aller in Word aufgeführten Typen. FieldType außer Word.FieldType.others. In Word im Web sind die Felder hauptsächlich schreibgeschützt. Weitere Informationen finden Sie unter Verwenden von Feldern in Ihrem Word-Add-In.
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-fields.yaml
// Inserts a Date field before selection.
await Word.run(async (context) => {
const range: Word.Range = context.document.getSelection().getRange();
const field: Word.Field = range.insertField(Word.InsertLocation.before, Word.FieldType.date, '\\@ "M/d/yyyy h:mm am/pm"', true);
field.load("result,code");
await context.sync();
if (field.isNullObject) {
console.log("There are no fields in this document.");
} else {
console.log("Code of the field: " + field.code, "Result of the field: " + JSON.stringify(field.result));
}
});
insertField(insertLocation, fieldType, text, removeFormatting)
Fügt ein Feld an der angegebenen Position ein.
insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined", text?: string, removeFormatting?: boolean): Word.Field;Parameter
- insertLocation
-
Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"
Die Position relativ zum Bereich, in den das Feld eingefügt wird. Der Wert muss ,start ,end , beforeoder sein.afterreplace
- fieldType
-
"Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"
Optional. Kann ein beliebiger FieldType Wert sein. Der Standardwert ist empty.
- text
-
string
Optional. Zusätzliche Eigenschaften oder Optionen bei Bedarf für den angegebenen Feldtyp.
- removeFormatting
-
boolean
Optional.
trueum andernfalls die Formatierung zu entfernen, die bei Aktualisierungen auf das Feld angewendet wurde. false Der Standardwert ist false.
Gibt zurück
Hinweise
Wichtig: In Word unter Windows und Mac unterstützt die API das Einfügen und Verwalten aller in Word aufgeführten Typen. FieldType außer Word.FieldType.others. In Word im Web sind die Felder hauptsächlich schreibgeschützt. Weitere Informationen finden Sie unter Verwenden von Feldern in Ihrem Word-Add-In.
insertFileFromBase64(base64File, insertLocation)
Fügt an der angegebenen Position ein Dokument ein.
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;Parameter
- base64File
-
string
Der Base64-codierte Inhalt einer .docx Datei.
- insertLocation
-
Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"
Der Wert muss ,start ,end , beforeoder sein.afterreplace
Gibt zurück
Hinweise
Das Einfügen wird nicht unterstützt, wenn das einzufügende Dokument ein ActiveX-Steuerelement enthält (wahrscheinlich in einem Formularfeld). Erwägen Sie, ein solches Formularfeld durch ein Inhaltssteuerelement oder eine andere Option zu ersetzen, die für Ihr Szenario geeignet ist.
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue a command to get the current selection and then
// create a proxy range object with the results.
const range = context.document.getSelection();
// Queue a command to insert base64 encoded .docx at the beginning of the range.
// You'll need to implement getBase64() to make this work.
range.insertFileFromBase64(getBase64(), Word.InsertLocation.start);
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Added base64 encoded text to the beginning of the range.');
});
insertFootnote(insertText)
Fügt eine Fußnote ein. Der Fußnotenverweis wird nach dem Bereich platziert.
insertFootnote(insertText?: string): Word.NoteItem;Parameter
- insertText
-
string
Optional. Text, der in den Fußnotentext eingefügt werden soll. Der Standardwert ist "".
Gibt zurück
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-footnotes.yaml
// Sets a footnote on the selected content.
await Word.run(async (context) => {
const text = (document.getElementById("input-footnote") as HTMLInputElement).value;
const footnote: Word.NoteItem = context.document.getSelection().insertFootnote(text);
await context.sync();
console.log("Inserted footnote.");
});
insertGeometricShape(geometricShapeType, insertShapeOptions)
Fügt eine geometrische Form vor dem Text mit seinem Anker am Anfang des Bereichs ein.
insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;Parameter
- geometricShapeType
- Word.GeometricShapeType
Der geometrische Typ der einzufügenden Form.
- insertShapeOptions
- Word.InsertShapeOptions
Optional. Die Position und Größe der geometrischen Form. Der Standardspeicherort und die Standardgröße sind (0, 0, 100, 100).
Gibt zurück
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-geometric-shapes.yaml
await Word.run(async (context) => {
// Inserts a moon geometric shape at the beginning of the selection.
const selection: Word.Range = context.document.getSelection();
const shapeOptions: Word.InsertShapeOptions = {
height: 120,
width: 120,
left: 120,
};
selection.insertGeometricShape(Word.GeometricShapeType.moon, shapeOptions);
await context.sync();
console.log("Inserted a moon.");
});
insertGeometricShape(geometricShapeType, insertShapeOptions)
Fügt eine geometrische Form vor dem Text mit seinem Anker am Anfang des Bereichs ein.
insertGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;Parameter
- geometricShapeType
-
"LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"
Der geometrische Typ der einzufügenden Form.
- insertShapeOptions
- Word.InsertShapeOptions
Optional. Die Position und Größe der geometrischen Form. Der Standardspeicherort und die Standardgröße sind (0, 0, 100, 100).
Gibt zurück
Hinweise
insertHtml(html, insertLocation)
Fügt an der angegebenen Position HTML-Code ein.
insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;Parameter
- html
-
string
Der einzufügende HTML-Code.
- insertLocation
-
Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"
Der Wert muss ,start ,end , beforeoder sein.afterreplace
Gibt zurück
Hinweise
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue a command to get the current selection and then
// create a proxy range object with the results.
const range = context.document.getSelection();
// Queue a command to insert HTML in to the beginning of the range.
range.insertHtml('<strong>This is text inserted with range.insertHtml()</strong>', Word.InsertLocation.start);
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('HTML added to the beginning of the range.');
});
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)
Fügt an der angegebenen Position ein Bild ein.
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture;Parameter
- base64EncodedImage
-
string
Das einzufügende Base64-codierte Bild.
- insertLocation
-
Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"
Der Wert muss ,start ,end , beforeoder sein.afterreplace
Gibt zurück
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-shapes-text-boxes.yaml
await Word.run(async (context) => {
// Inserts a picture at the start of the first text box.
const firstShapeWithTextBox: Word.Shape = context.document.body.shapes
.getByTypes([Word.ShapeType.textBox])
.getFirst();
firstShapeWithTextBox.load("type/body");
await context.sync();
const startRange: Word.Range = firstShapeWithTextBox.body.getRange(Word.RangeLocation.start);
const newPic: Word.InlinePicture = startRange.insertInlinePictureFromBase64(
getPictureBase64(),
Word.InsertLocation.start
);
newPic.load();
await context.sync();
console.log("New inline picture properties:", newPic);
});
...
// Returns Base64-encoded image data for a sample picture.
const pictureBase64 =
"iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAABblBMVEX+7tEYMFlyg5v8zHXVgof///+hrL77qRnIWmBEWXq6MDgAF0/i1b//8dP+79QKJ1MAIFL8yWpugZz/+O/VzLwzTXR+jaP/z3PHzdjNaWvuxrLFT1n8znmMj5fFTFP25OHlsa2wqqJGW3z7pgCbqsH936oAJlWnssRzdoLTd1HTfINbY3a7tar90IxJVG0AH1ecmJH//90gN14AFU/nxInHVFL80YQAD03qv3LUrm7cwJLWjoLenpPRdXTQgoj15sz+57/7szr93KPbiWjUvZj95LnwzLmMX3L8wmz7rib8xnP8vVz91JT8ukvTz8i8vsORkJKvsLIAD1YwPViWnKZVYHbKuqHjwo3ur2/Pa2O+OTvHVETfj1tybm9qdYlsYlnkmmC0DSPirpvAq4bj5uuono7tu5vgpannnX3ksbSKg5bv0tTclJNFSlyZgpPqwsW4go2giWdbWV+3mmuWgpRcbolURmReS2embHkiRHBcZ6c8AAALcElEQVR4nO3di1cTVx4H8AyThmC484ghFzSxEDRhIRBIMEFQA1qoVhAqYBVd3UXcri1dd7fLdv3vdybJZF73zr2TufPyzPccew49hc6H331nZkylkiRJkiRJkiRJkiRJkiRJkiRJkiRJkiQJ6wj2hH1JLKNo9p/sPB3X8rRUau/f2f56kML2k/n5+XFDSjzPQ7l95+swCqkfzDy1hnwvsLT9FRCF1I7Fpwt5Xt6PfRmF1LgNaBAqZdyNOVGwV9AkVMq4HOshR3iCAJqFalONr1HYRQGtQsXYvrONmjKj7xae0QnVuaO0/OiOlv3lfqI/1G4jgShhnzkIfzA/SNgAUoR9d0I9g/9wfjtsAiHocWZ8fIckLA1ad/SFB0jg+AGxhgNi9FvpU7TwGVHIl+QdtR9GfaTBCOdlIlA18vIzPqZC8kCjZT+mQnI31HInpkKqRqpGDhtADFpInCuGaUe9hBghrY+Xo7+xQgnn6Xth9EuIFNIPpDDsy6cISvg1tVGkkB4Y+ZlCjU34lBrIx6GCitAyyOzQ8mA7+nvfXixCigV33xf9tYwWg3B+/ICnAsbrKFwY8nae0figwnsUq3M34aCXZ3KphPa12+2SWjYZ8v0Pa1Jx4ikRSv1ga2Y8MIzH6aElAqFlRn/vQApRuB32FXoNSRiTad0hgkxI5E8piLlOStgX6DnfkBL7GhKFsS8iUfhN2FfoNWRh3ItIFsa9iBTCmBeRQhjz4ZRGGG8ilfB6jInEVVs/MTj5xUWwbSbUQNs2sZ2Kq9EilNup60qj3LUReT4mR2u2mIXyrtbx2nbjI/P+HpgTFoAYAQlU0rYJYXt3aASg+/zw8HBlkKWFuW5UkSbhsnH4RHxIKmtG8Lx2O5PJ1DhxkKqUW+hGk2gUyoJxhniE6Ivq3W0pAXQPVZ8ibHJ6qrl6JImmGppnecwn3XK7kBnEJOS4zlEUiUZh2zzLI4UQrv94GyPkOnMRJBqFyzghHKa0qfvsQk6KYF90bqUb93pZ72fz5Y+3DT6EsFqOtlC+bh1pXjSUtCq3tWTMsQm5VrSF/L6lkW7k1KsWM7jUjq3CXCFyRPOMb9hpLCtfb7TUvlWsYYUrVqG0Gm2hgbjfG2c61erxCRaYqS2J1o4YvQnDuvJeFtSV9zbfm+7hSTGD9ykpVq3ChagL1d1T/09PWLeOLdZYW2kchKbpfZMgrJ2K8RbyPKGEmRMp5kL40mURYyckFzHTjLkQrpPGmhMx3kIe/kRqp0Ux3kKlihlnY+2EE6MuhIYgiPxL25LbTMysSFEWQvjq8evs3Wu9nL15+4MdCdsvM47IWvG42q9j9c+RE4JXr29ms5pQzVtkHX9S94aG2JrquxVRqlZz7yN2Og5SW6rPJLz2BtkdlbTXN797qeS7zXX7YqdWq2VOTk7monTzBgDgPNsHmoTX3qBO2TRmP9hJpA7lRyESzafUe/c1n0V47S/EARa3YL1dh2He/Q26W2ruq9l6kL059FmFZ7giDoW41Zwq5PmwgClw/lf1+hWaEYcQXntFEMrPpzEpqBuv0EabvjCLikX4liA0n6zazpFhWLdIK8KzW0hgNmsW/sm5mcrbzsLQnjQBXWvj1HPmRshjgdpnAaFNGVhg9pYLofFDOIxQDunzVHAfX0QXwhIeOPw8J6TBBnRx3dAy1jgKzUfjGGEUi3hGKZSBA1D/TC6sngjSVEQHIfxQdMqq9p2hPbgHtvAN9YxCCD/mxwzJ54tF5R/617owtOUpuDGDLeMZSQhLRybg2LTaMi/G8nYhXwpvdQpupO3LtsFwc+YkhHBzzAzUel8RIQzzOQYAUnvnWw9mZlTUayvy7q2zM5QQ8ptlsy9/oQkv8nZhyE+3DW/zAfAtopaPrUJlR/jRUr+xsaI+hBYRwohshQX4mCyEGx+KeatvLF/ThYd5uzC8jmiKAO/esscoVMq3auepmkNdOI0QRuSRKaH0LSJd/TrhehnpUzQZXVhDCGFEHijadVyZwPUjjE/l6N+AGEvD2yVaglxkDoRww8FnLGINNZaGN+ebIqCAg506/9HJZ+iJ06gZPyqDKRLYE9qmdxSxOH1xMV1ErdqULEdAiNsmCDLkV4m+HilvqrNJGIHjbzD76dMsKn+D6+QCIsGREgJwf1HPw59/1r/4+4eRfBETgu7lYlrL4rdq4/yk/YtfRgSahaEuagDozuq+AVAjPhyRFyEhAHuzi0bgJ22IWfQGtAoBMv7zurNpo08R/qoJL70BLUJQL6Pi72226kdOZp5F6AloERZazQlbpqqnPgoV36XNZ26lnoAWIcdxUxWrsMk1/LuBUfXZeL0MgJ8Xf2Eo/E20EyvqHUadgj+9EqTuY3zp9GUP+OuDf4w6TdiF8H3/Dg0TsTK4hao+TIGdEewh2qehoX7+fLn4T49A42nivxqDO1AmKjYgJw2TqzJ6EMWpgH2i4vc2ypiE8J4GNBArtjvfuX6bZQF0LKAWj53QKNxoGAwTlUpF+TOBBHLiCgMhuEHhS3tuowbhsemGvuaUOk0gfeptRl3vQEILZVZCTQj/bb0B3CmSZyElkEEJB0J9lKHKsddWCnCTIPsS9oXw95YboOe7/SgrmH7IoIR94T1XFeQ6k96EYJYOmPY62Q+FJVc+ruPxMRtlmqADMmmkPeFv1gdpHJuo5PmZRUpfOs2ihKrwvUR2aRE7np8epu2EbEZSVfh7jt7XWimseQVSt1FGwrF3tBNhVWotMVh1g0vqRvofJsA8uQ9WG51WQ1wp11k8we+ihGwGmjH0ytPYMnPlgrqEYbQxpO+FaY97+0GwS88h8HiS7UkUPZCJcILYRptsT6HcNFIWwisisMX4MWHq5QwbIRnI/HkTFyMpCyHJx2QjaBG6KKH3AwziMMrlmL9UohukcIrYRpmcVpjiaqDxKqyQp3rWw0ywQvIo48djbQEKKRZrnMTa51boZeGdJ48yXMOHd9eMKLyqTDVFlyEDOebDzIjCqymqy3UfyY+XSNEdAxuFFc4fnpIOe59bIdWAP3o8n4l6F141/QSKvjwB7Ur4vZ8+LgI1/K/PQC4XstB3INfw4wVS9EL/gf50RGrhH/4DlWbq8dMJL0K/B5l+/HifBKXwf4EAlTmf9QafWkixamYSH17lRicMpo1yfmzxKYVBAZWxhnkzpRIGVkI/3qlIJQzMp3RE5ntgGmFQA6ka9u9UpBH+ERzQh9e3gm52BpMh3c2NPZ6FPhy2YZ9pzmYfBN5IfRGe4x9Nz84EPJL69B4whyL2iEF2Q39Wpnv4h+97RNt7gOMmVIZTh3aaDW5N2k9zjb1QqSL+/QLZmYeBApVlmy9HGeD8wU1MsotBDjT+vShafb/ADXT2XNygxSKiL8A+Ep1uwMLqgh890SlBC7ncasDErqt7eVmkVQ70L2sBddc11J8EaeRGWtNKTfVvpAnqmT3gfsJfG6ZbKEujGTunC6tz1tQ93g2G/qUtub/CJS0LR3WQKo/WysWqZE/reG5Uo4qZLNh+aXNlcYQS6B/7VhvS0Vqd/nZZchrHIx0aK7q5dxNThoiDX5r3raF0nKqzHKtEyf1JDgD1d1+m7A8Asrqk47VyR29o3n9nbtd1im/CzMMLR1u/SUdAb/ar5aa7By0QV+HuTBVMXtl8GGGzezraxXXMQ3+96bGOru6bAnNf7D608EUBgNXWKGW0nJ8BsOCtY4or1Ise5f+FKCBa2HtqBUwujWK0LqbBXMfThqVFO56CbgUNtAulwa0uYK2wkHM9WtiOecHkqRcj7UEAqH+ZwkVq5fS0ctzRcPxSNhtzC5yUc5NO03pFABQWRFc/w5jWC7oSpgr4TJoDLB0JdCfdBfH7VSbh0UPbSqnj5XvxK2aXP4P485IkSZIkSZIkSZIkSZIkSZIkSZIk8Tv/B3bBREdOWYS3AAAAAElFTkSuQmCC";
return pictureBase64;
insertOoxml(ooxml, insertLocation)
Fügt an der angegebenen Position OOXML-Code ein.
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;Parameter
- ooxml
-
string
Der einzufügende OOXML-Code.
- insertLocation
-
Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"
Der Wert muss ,start ,end , beforeoder sein.afterreplace
Gibt zurück
Hinweise
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue a command to get the current selection and then
// create a proxy range object with the results.
const range = context.document.getSelection();
// Queue a command to insert OOXML in to the beginning of the range.
range.insertOoxml("<pkg:package xmlns:pkg='http://schemas.microsoft.com/office/2006/xmlPackage'><pkg:part pkg:name='/_rels/.rels' pkg:contentType='application/vnd.openxmlformats-package.relationships+xml' pkg:padding='512'><pkg:xmlData><Relationships xmlns='http://schemas.openxmlformats.org/package/2006/relationships'><Relationship Id='rId1' Type='http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument' Target='word/document.xml'/></Relationships></pkg:xmlData></pkg:part><pkg:part pkg:name='/word/document.xml' pkg:contentType='application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml'><pkg:xmlData><w:document xmlns:w='http://schemas.openxmlformats.org/wordprocessingml/2006/main' ><w:body><w:p><w:pPr><w:spacing w:before='360' w:after='0' w:line='480' w:lineRule='auto'/><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr></w:pPr><w:r><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr><w:t>This text has formatting directly applied to achieve its font size, color, line spacing, and paragraph spacing.</w:t></w:r></w:p></w:body></w:document></pkg:xmlData></pkg:part></pkg:package>", Word.InsertLocation.start);
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('OOXML added to the beginning of the range.');
});
// Read "Create better add-ins for Word with Office Open XML" for guidance on working with OOXML.
// https://learn.microsoft.com/office/dev/add-ins/word/create-better-add-ins-for-word-with-office-open-xml
insertParagraph(paragraphText, insertLocation)
Fügt an der angegebenen Position einen Absatz ein.
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;Parameter
- paragraphText
-
string
Der einzufügende Absatztext.
Gibt zurück
Hinweise
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue a command to get the current selection and then
// create a proxy range object with the results.
const range = context.document.getSelection();
// Queue a command to insert the paragraph after the range.
range.insertParagraph('Content of a new paragraph', Word.InsertLocation.after);
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Paragraph added to the end of the range.');
});
insertPictureFromBase64(base64EncodedImage, insertShapeOptions)
Fügt ein unverankertes Bild vor dem Text mit seinem Anker am Anfang des Bereichs ein.
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;Parameter
- base64EncodedImage
-
string
Das einzufügende Base64-codierte Bild.
- insertShapeOptions
- Word.InsertShapeOptions
Optional. Der Standort und die Größe des Bilds. Der Standardspeicherort ist (0, 0), und die Standardgröße entspricht der Originalgröße des Bilds.
Gibt zurück
Hinweise
insertTable(rowCount, columnCount, insertLocation, values)
Fügt eine Tabelle mit der angegebenen Anzahl von Zeilen und Spalten ein.
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;Parameter
- rowCount
-
number
Die Anzahl der Zeilen in der Tabelle.
- columnCount
-
number
Die Anzahl der Spalten in der Tabelle.
- values
-
string[][]
Optionales 2D-Array. Wenn die entsprechenden Zeichenfolgen im Array angegeben sind, werden die Zellen gefüllt.
Gibt zurück
Hinweise
insertText(text, insertLocation)
Fügt an der angegebenen Position Text ein.
insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;Parameter
- text
-
string
Der einzufügende Text.
- insertLocation
-
Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"
Der Wert muss ,start ,end , beforeoder sein.afterreplace
Gibt zurück
Hinweise
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue a command to get the current selection and then
// create a proxy range object with the results.
const range = context.document.getSelection();
// Queue a command to insert the paragraph at the end of the range.
range.insertText('New text inserted into the range.', 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('Text added to the end of the range.');
});
insertTextBox(text, insertShapeOptions)
Fügt ein unverankertes Textfeld vor dem Text mit seinem Anker am Anfang des Bereichs ein.
insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;Parameter
- text
-
string
Optional. Der in das Textfeld einzufügende Text.
- insertShapeOptions
- Word.InsertShapeOptions
Optional. Die Position und Größe des Textfelds. Der Standardspeicherort und die Standardgröße sind (0, 0, 100, 100).
Gibt zurück
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-shapes-text-boxes.yaml
await Word.run(async (context) => {
// Inserts a text box at the beginning of the selection.
const range: Word.Range = context.document.getSelection();
const insertShapeOptions: Word.InsertShapeOptions = {
top: 0,
left: 0,
height: 100,
width: 100
};
const newTextBox: Word.Shape = range.insertTextBox("placeholder text", insertShapeOptions);
await context.sync();
console.log("Inserted a text box at the beginning of the current selection.");
});
intersectWith(range)
Gibt einen neuen Bereich als Schnittmenge dieses Bereichs mit einem anderen Bereich zurück. Dieser Bereich wird nicht geändert. Gibt einen ItemNotFound Fehler aus, wenn sich die beiden Bereiche nicht überlappen oder angrenzen.
intersectWith(range: Word.Range): Word.Range;Parameter
- range
- Word.Range
Ein weiterer Bereich.
Gibt zurück
Hinweise
intersectWithOrNullObject(range)
Gibt einen neuen Bereich als Schnittmenge dieses Bereichs mit einem anderen Bereich zurück. Dieser Bereich wird nicht geändert. Wenn sich die beiden Bereiche nicht überlappen oder angrenzen, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
intersectWithOrNullObject(range: Word.Range): Word.Range;Parameter
- range
- Word.Range
Ein weiterer Bereich.
Gibt zurück
Hinweise
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.RangeLoadOptions): Word.Range;Parameter
- options
- Word.Interfaces.RangeLoadOptions
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
Gibt zurück
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.Range;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
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.Range;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
removeHighlight()
Entfernt die von der Methode hinzugefügte highlight Hervorhebung, falls vorhanden.
removeHighlight(): void;Gibt zurück
void
Hinweise
search(searchText, searchOptions)
Führt eine Suche mit den angegebenen Suchoptionen für den Bereich des Objekts Range aus. Die Suchergebnisse sind eine Sammlung 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 Suchtext.
- searchOptions
-
Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }
Optional. Optionen für die Suche.
Gibt zurück
Hinweise
select(selectionMode)
Wählt und navigiert die Word-Benutzeroberfläche zu diesem Bereich.
select(selectionMode?: Word.SelectionMode): void;Parameter
- selectionMode
- Word.SelectionMode
Optional. Der Auswahlmodus muss , oder seinendselect. start
select ist die Standardeinstellung.
Gibt zurück
void
Hinweise
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue a command to get the current selection and then
// create a proxy range object with the results.
const range = context.document.getSelection();
// Queue a command to insert HTML in to the beginning of the range.
range.insertHtml('<strong>This is text inserted with range.insertHtml()</strong>', Word.InsertLocation.start);
// Queue a command to select the HTML that was inserted.
range.select();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Selected the range.');
});
select(selectionMode)
Wählt und navigiert die Word-Benutzeroberfläche zu diesem Bereich.
select(selectionMode?: "Select" | "Start" | "End"): void;Parameter
- selectionMode
-
"Select" | "Start" | "End"
Optional. Der Auswahlmodus muss , oder seinendselect. start
select ist die Standardeinstellung.
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.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Word.Interfaces.RangeUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt 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.Range): void;Parameter
- properties
- Word.Range
Gibt zurück
void
split(delimiters, multiParagraphs, trimDelimiters, trimSpacing)
Teilt den Bereich mithilfe von Trennzeichen in untergeordnete Bereiche.
split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection;Parameter
- delimiters
-
string[]
Die Trennzeichen als Array von Zeichenfolgen.
- multiParagraphs
-
boolean
Optional. Gibt an, ob ein zurückgegebener untergeordneter Bereich mehrere Absätze umfassen kann. Der Standardwert gibt false an, dass die Absatzbegrenzungen auch als Trennzeichen verwendet werden.
- trimDelimiters
-
boolean
Optional. Gibt an, ob Trennzeichen aus den Bereichen in der Bereichssammlung entfernt werden sollen. Der Standardwert gibt false an, dass die Trennzeichen in den Bereichen enthalten sind, die in der Bereichsauflistung zurückgegeben werden.
- trimSpacing
-
boolean
Optional. Gibt an, ob Abstandszeichen (Leerzeichen, Tabstopps, Spaltenumbrüche und Absatzendmarken) vom Anfang und Ende der in der Bereichssammlung zurückgegebenen Bereiche entfernt werden sollen. "Standard" gibt false an, dass Abstandszeichen am Anfang und Ende der Bereiche in die Bereichssammlung eingeschlossen werden.
Gibt zurück
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 sie übergeben wird.) Während das ursprüngliche Word.Range Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.RangeData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Word.Interfaces.RangeData;Gibt zurück
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 aufrufübergreifend .sync 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 ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Sammlung ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.
track(): Word.Range;Gibt zurück
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 einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.Range;Gibt zurück
Details zum Ereignis
onCommentAdded
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.
Tritt auf, wenn neue Kommentare hinzugefügt werden.
readonly onCommentAdded: OfficeExtension.EventHandlers<Word.CommentEventArgs>;Ereignistyp
Hinweise
onCommentChanged
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.
Tritt auf, wenn ein Kommentar oder dessen Antwort geändert wird.
readonly onCommentChanged: OfficeExtension.EventHandlers<Word.CommentEventArgs>;Ereignistyp
Hinweise
onCommentDeselected
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.
Tritt auf, wenn die Auswahl eines Kommentars aufgehoben wird.
readonly onCommentDeselected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;Ereignistyp
Hinweise
onCommentSelected
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.
Tritt auf, wenn ein Kommentar ausgewählt ist.
readonly onCommentSelected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;