Document Service

Dokument

Mit diesem Dienst können Skripts Google Docs-Dateien erstellen, darauf zugreifen und sie ändern.

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID');

// Create and open a document.
doc = DocumentApp.create('Document Name');

Klassen

NameKurzbeschreibung
AttributeEine Aufzählung der Elementattribute.
BodyDer Inhalt eines Tabs in einem Google Docs-Dokument.
BookmarkEin Objekt, das ein Lesezeichen darstellt.
ContainerElementEin allgemeines Element, das andere Elemente enthalten kann.
DateEin Element, das ein formatiertes Datum darstellt
DocumentEin Dokument mit einem oder mehreren Tab-Objekten, die jeweils Rich-Text und Elemente wie Tabellen und Listen enthalten.
DocumentAppDer Dokumentdienst erstellt und öffnet Documents, die bearbeitet werden können.
DocumentTabEin Dokumenttab mit Rich-Text und Elementen wie Tabellen und Listen.
ElementEin generisches Element.
ElementTypeEine Aufzählung aller Elementtypen.
EquationEin Element, das einen mathematischen Ausdruck darstellt.
EquationFunctionEin Element, das eine Funktion in einem mathematischen Equation darstellt.
EquationFunctionArgumentSeparatorEin Element, das ein Funktionstrennzeichen in einer mathematischen Equation darstellt.
EquationSymbolEin Element, das ein Symbol in einer mathematischen Equation darstellt.
FontFamilyEine Aufzählung der unterstützten Schriftarten.
FooterSectionEin Element, das einen Fußzeilenbereich darstellt.
FootnoteEin Element, das eine Fußnote darstellt.
FootnoteSectionEin Element, das einen Fußnotenbereich darstellt.
GlyphTypeEine Aufzählung der unterstützten Glyphentypen.
HeaderSectionEin Element, das einen Header-Abschnitt darstellt.
HorizontalAlignmentEine Aufzählung der unterstützten horizontalen Ausrichtungstypen.
HorizontalRuleEin Element, das eine horizontale Linie darstellt.
InlineDrawingEin Element, das eine eingebettete Zeichnung darstellt.
InlineImageEin Element, das ein eingebettetes Bild darstellt.
ListItemEin Element, das ein Listenelement darstellt.
NamedRangeEine Range mit einem Namen und einer ID, damit sie später abgerufen werden kann.
PageBreakEin Element, das einen Seitenumbruch darstellt.
ParagraphEin Element, das einen Absatz darstellt.
ParagraphHeadingEine Aufzählung der Standardüberschriften für Absätze.
PersonEin Element, das einen Link zu einer Person darstellt.
PositionEin Verweis auf eine Position auf dem Dokument-Tab relativ zu einem bestimmten Element.
PositionedImageBild mit fester Position, das an einem Paragraph verankert ist.
PositionedLayoutEine Enumeration, die angibt, wie ein PositionedImage im Verhältnis zum umgebenden Text angeordnet werden soll.
RangeEin Bereich von Elementen in einem Dokument.
RangeBuilderEin Builder, mit dem Range-Objekte aus Dokumentelementen erstellt werden.
RangeElementEin Wrapper um ein Element mit einem möglichen Start- und End-Offset.
RichLinkEin Element, das einen Link zu einer Google-Ressource wie einer Drive-Datei oder einem YouTube-Video darstellt.
TabEin Tab in einem Google Docs-Dokument.
TabTypeEine Aufzählung aller Tab-Typen.
TableEin Element, das eine Tabelle darstellt.
TableCellEin Element, das eine Tabellenzelle darstellt.
TableOfContentsEin Element, das ein Inhaltsverzeichnis enthält.
TableRowEin Element, das eine Tabellenzeile darstellt.
TextEin Element, das einen Rich-Text-Bereich darstellt.
TextAlignmentEine Aufzählung der Arten von Textausrichtungen.
UnsupportedElementEin Element, das eine Region darstellt, die unbekannt ist oder nicht von einem Skript beeinflusst werden kann, z. B. eine Seitenzahl.
VerticalAlignmentEine Aufzählung der unterstützten vertikalen Ausrichtungstypen.

Attribute

Attribute

AttributTypBeschreibung
BACKGROUND_COLOREnumDie Hintergrundfarbe eines Elements (Absatz, Tabelle usw.) oder Dokuments.
BOLDEnumDie Einstellung für die Schriftstärke für Rich-Text.
BORDER_COLOREnumDie Rahmenfarbe für Tabellenelemente.
BORDER_WIDTHEnumDie Rahmenbreite in Punkten für Tabellenelemente.
CODEEnumDer Code-Inhalt für Gleichungselemente.
FONT_FAMILYEnumDie Einstellung für die Schriftfamilie für Rich-Text.
FONT_SIZEEnumDie Schriftgröße für Rich-Text in Punkten.
FOREGROUND_COLOREnumDie Einstellung für die Vordergrundfarbe für Rich-Text.
HEADINGEnumDer Überschriftstyp für Absatzelemente (z. B. DocumentApp.ParagraphHeading.HEADING1).
HEIGHTEnumDie Höheneinstellung für Bildelemente.
HORIZONTAL_ALIGNMENTEnumDie horizontale Ausrichtung für Absatzelemente (z. B. DocumentApp.HorizontalAlignment.CENTER).
INDENT_ENDEnumDie Einstellung für den Einzug am Ende in Punkten für Absatzelemente.
INDENT_FIRST_LINEEnumDie Einstellung für den Einzug der ersten Zeile in Punkten für Absatzelemente.
INDENT_STARTEnumDie Einstellung für den Einzug am Anfang in Punkten für Absatzelemente.
ITALICEnumDie Einstellung für den Schriftstil für Rich-Text.
GLYPH_TYPEEnumDer Glyphentyp für Listenelemente.
LEFT_TO_RIGHTEnumDie Einstellung für die Textrichtung für Rich-Text.
LINE_SPACINGEnumDie Einstellung für den Zeilenabstand als Multiplikator für Absatzelemente.
LINK_URLEnumDie Link-URL für Rich-Text.
LIST_IDEnumDie ID der umfassenden Liste für Listenelemente.
MARGIN_BOTTOMEnumDie Einstellung für den unteren Rand in Punkten für Absatzelemente.
MARGIN_LEFTEnumDie Einstellung für den linken Rand in Punkten für Absatzelemente.
MARGIN_RIGHTEnumDie Einstellung für den rechten Rand in Punkten für Absatzelemente.
MARGIN_TOPEnumDie Einstellung für den oberen Rand in Punkten für Absatzelemente.
NESTING_LEVELEnumDie Verschachtelungsebene des Elements für Listenelemente.
MINIMUM_HEIGHTEnumDie Einstellung für die Mindesthöhe in Punkten für Tabellenzeilenelemente.
PADDING_BOTTOMEnumDie Einstellung für den unteren Abstand in Punkten für Tabellenzellenelemente.
PADDING_LEFTEnumDie Einstellung für den linken Innenabstand in Punkten für Tabellenzellenelemente.
PADDING_RIGHTEnumDie Einstellung für den rechten Innenabstand in Punkten für Tabellenzellenelemente.
PADDING_TOPEnumDie Einstellung für den oberen Innenabstand in Punkten für Tabellenzellenelemente.
PAGE_HEIGHTEnumDie Einstellung für die Seitenhöhe in Punkten für Dokumente.
PAGE_WIDTHEnumDie Einstellung für die Seitenbreite in Punkten für Dokumente.
SPACING_AFTEREnumDie Einstellung für den unteren Abstand in Punkten für Absatzelemente.
SPACING_BEFOREEnumDie Einstellung für den oberen Abstand in Punkten für Absatzelemente.
STRIKETHROUGHEnumDie Einstellung für durchgestrichenen Text für Rich-Text.
UNDERLINEEnumDie Unterstreichungseinstellung für Rich-Text.
VERTICAL_ALIGNMENTEnumDie Einstellung für die vertikale Ausrichtung für Tabellenzellenelemente.
WIDTHEnumDie Breitenangabe für Tabellenzellen und Bildelemente.

Body

Methoden

MethodeRückgabetypKurzbeschreibung
appendHorizontalRule()HorizontalRuleErstellt und hängt einen neuen HorizontalRule an.
appendImage(image)InlineImageErstellt ein neues InlineImage aus dem angegebenen Bild-Blob und hängt es an.
appendImage(image)InlineImageHängt die angegebene InlineImage an.
appendListItem(listItem)ListItemHängt die angegebene ListItem an.
appendListItem(text)ListItemErstellt ein neues ListItem mit dem angegebenen Textinhalt und hängt es an.
appendPageBreak()PageBreakErstellt und hängt einen neuen PageBreak an.
appendPageBreak(pageBreak)PageBreakHängt die angegebene PageBreak an.
appendParagraph(paragraph)ParagraphHängt die angegebene Paragraph an.
appendParagraph(text)ParagraphErstellt ein neues Paragraph mit dem angegebenen Textinhalt und hängt es an.
appendTable()TableErstellt und hängt einen neuen Table an.
appendTable(cells)TableHängt ein neues Table mit einem TableCell für jeden angegebenen String-Wert an.
appendTable(table)TableHängt die angegebene Table an.
clear()BodyLöscht den Inhalt des Elements.
copy()BodyGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElement|nullDurchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs.
findElement(elementType, from)RangeElement|nullDurchsucht den Inhalt des Elements nach einem untergeordneten Element des angegebenen Typs, beginnend mit dem angegebenen RangeElement.
findText(searchPattern)RangeElement|nullSucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElement|nullDurchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element am angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab.
getHeadingAttributes(paragraphHeading)ObjectRuft die Attributgruppe für die angegebene ParagraphHeading ab.
getImages()InlineImage[]|nullRuft alle InlineImages ab, die im Abschnitt enthalten sind.
getListItems()ListItem[]|nullRuft alle ListItems ab, die im Abschnitt enthalten sind.
getMarginBottom()Number|nullRuft den unteren Rand in Punkten ab.
getMarginLeft()Number|nullRuft den linken Rand in Punkten ab.
getMarginRight()Number|nullRuft den rechten Rand ab.
getMarginTop()Number|nullRuft den oberen Rand ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getPageHeight()Number|nullRuft die Seitenhöhe in Punkten ab.
getPageWidth()Number|nullRuft die Seitenbreite in Punkten ab.
getParagraphs()Paragraph[]|nullRuft alle Paragraphs ab, die im Abschnitt enthalten sind (einschließlich ListItems).
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getTables()Table[]|nullRuft alle Tables ab, die im Abschnitt enthalten sind.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignment|nullGibt die Textausrichtung zurück.
getType()ElementTypeRuft den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt und fügt ein neues HorizontalRule am angegebenen Index ein.
insertImage(childIndex, image)InlineImageErstellt und fügt ein InlineImage aus dem angegebenen Bild-Blob am angegebenen Index ein.
insertImage(childIndex, image)InlineImageFügt das angegebene InlineImage am angegebenen Index ein.
insertListItem(childIndex, listItem)ListItemFügt das angegebene ListItem am angegebenen Index ein.
insertListItem(childIndex, text)ListItemErstellt und fügt ein neues ListItem am angegebenen Index ein, das den angegebenen Textinhalt enthält.
insertPageBreak(childIndex)PageBreakErstellt und fügt ein neues PageBreak am angegebenen Index ein.
insertPageBreak(childIndex, pageBreak)PageBreakFügt das angegebene PageBreak am angegebenen Index ein.
insertParagraph(childIndex, paragraph)ParagraphFügt das angegebene Paragraph am angegebenen Index ein.
insertParagraph(childIndex, text)ParagraphErstellt und fügt ein neues Paragraph am angegebenen Index ein, das den angegebenen Textinhalt enthält.
insertTable(childIndex)TableErstellt und fügt ein neues Table am angegebenen Index ein.
insertTable(childIndex, cells)TableErstellt und fügt ein neues Table mit den angegebenen Zellen am angegebenen Index ein.
insertTable(childIndex, table)TableFügt das angegebene Table am angegebenen Index ein.
removeChild(child)BodyEntfernt das angegebene untergeordnete Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet.
setAttributes(attributes)BodyLegt die Attribute des Elements fest.
setHeadingAttributes(paragraphHeading, attributes)BodyLegt die Attribute für die angegebene ParagraphHeading fest.
setMarginBottom(marginBottom)BodyLegt den unteren Rand in Punkten fest.
setMarginLeft(marginLeft)BodyLegt den linken Rand in Punkten fest.
setMarginRight(marginRight)BodyLegt den rechten Rand in Punkten fest.
setMarginTop(marginTop)BodyLegt den oberen Rand fest.
setPageHeight(pageHeight)BodyLegt die Seitenhöhe in Punkten fest.
setPageWidth(pageWidth)BodyLegt die Seitenbreite in Punkten fest.
setText(text)BodyLegt den Inhalt als Nur-Text fest.
setTextAlignment(textAlignment)BodyLegt die Textausrichtung fest.

Bookmark

Methoden

MethodeRückgabetypKurzbeschreibung
getId()StringRuft die ID des Bookmark ab.
getPosition()PositionRuft die Position des Bookmark im DocumentTab ab.
remove()voidLöscht die Bookmark.

ContainerElement

Methoden

MethodeRückgabetypKurzbeschreibung
asBody()BodyGibt das aktuelle Element als Body zurück.
asEquation()EquationGibt das aktuelle Element als Equation zurück.
asFooterSection()FooterSectionGibt das aktuelle Element als FooterSection zurück.
asFootnoteSection()FootnoteSectionGibt das aktuelle Element als FootnoteSection zurück.
asHeaderSection()HeaderSectionGibt das aktuelle Element als HeaderSection zurück.
asListItem()ListItemGibt das aktuelle Element als ListItem zurück.
asParagraph()ParagraphGibt das aktuelle Element als Paragraph zurück.
asTable()TableGibt das aktuelle Element als Table zurück.
asTableCell()TableCellGibt das aktuelle Element als TableCell zurück.
asTableOfContents()TableOfContentsGibt das aktuelle Element als TableOfContents zurück.
asTableRow()TableRowGibt das aktuelle Element als TableRow zurück.
clear()ContainerElementLöscht den Inhalt des Elements.
copy()ContainerElementGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElement|nullDurchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs.
findElement(elementType, from)RangeElement|nullDurchsucht den Inhalt des Elements nach einem untergeordneten Element des angegebenen Typs, beginnend mit dem angegebenen RangeElement.
findText(searchPattern)RangeElement|nullSucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElement|nullDurchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element am angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab.
getLinkUrl()String|nullRuft die Link-URL ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignment|nullGibt die Textausrichtung zurück.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
merge()ContainerElement|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeFromParent()ContainerElement|nullEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet.
setAttributes(attributes)ContainerElementLegt die Attribute des Elements fest.
setLinkUrl(url)ContainerElementLegt die Link-URL fest.
setTextAlignment(textAlignment)ContainerElementLegt die Textausrichtung fest.

Date

Methoden

MethodeRückgabetypKurzbeschreibung
copy()DateGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getDisplayText()StringGibt den im Dokument gerenderten Anzeigewert zurück.
getLocale()StringGibt das Gebietsschema des Datums zurück, das für den angezeigten Wert verwendet wird.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getTimestamp()DateGibt den Zeitstempel zurück, der dem Datum zugeordnet ist.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
merge()Date|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeFromParent()Date|nullEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)DateLegt die Attribute des Elements fest.

Document

Methoden

MethodeRückgabetypKurzbeschreibung
addBookmark(position)BookmarkFügt dem ersten Tab oder, bei Skripts, die an ein Dokument gebunden sind, dem aktiven Tab ein Bookmark an der angegebenen Position hinzu.
addEditor(emailAddress)DocumentFügt den angegebenen Nutzer der Liste der Bearbeiter für Document hinzu.
addEditor(user)DocumentFügt den angegebenen Nutzer der Liste der Bearbeiter für Document hinzu.
addEditors(emailAddresses)DocumentFügt das angegebene Nutzer-Array der Liste der Bearbeiter für Document hinzu.
addFooter()FooterSectionFügt dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, dem aktiven Tab einen Fußzeilenbereich hinzu, sofern noch keiner vorhanden ist.
addHeader()HeaderSectionFügt dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, dem aktiven Tab einen Headerbereich hinzu, sofern noch keiner vorhanden ist.
addNamedRange(name, range)NamedRangeFügt auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab ein NamedRange ein, das ein Range mit einem Namen und einer ID ist, die für den späteren Abruf verwendet werden können.
addViewer(emailAddress)DocumentFügt den angegebenen Nutzer der Liste der Zuschauer für Document hinzu.
addViewer(user)DocumentFügt den angegebenen Nutzer der Liste der Zuschauer für Document hinzu.
addViewers(emailAddresses)DocumentFügt das angegebene Nutzer-Array der Liste der Betrachter für Document hinzu.
getActiveTab()TabRuft die aktuell aktive Tab des Nutzers im Dokument ab.
getAs(contentType)BlobRuft den aktuellen Inhalt von Document als Blob des angegebenen Typs ab.
getBlob()BlobRuft den aktuellen Inhalt von Document als Blob ab.
getBody()BodyRuft die Body des ersten Tabs oder, bei Scripts, die an ein Dokument gebunden sind, die DocumentBodySection des aktiven Tabs ab.
getBookmark(id)Bookmark|nullRuft das Bookmark mit der angegebenen ID auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab ab.
getBookmarks()Bookmark[]Ruft alle Bookmark-Objekte auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab ab.
getCursor()Position|nullRuft den Cursor des Nutzers auf dem aktiven Tab ab.
getEditors()User[]Ruft die Liste der Mitbearbeiter für diese Document ab.
getFooter()FooterSection|nullRuft den Fußzeilenbereich des ersten Tabs oder, bei Scripts, die an ein Dokument gebunden sind, den Fußzeilenbereich des aktiven Tabs ab.
getFootnotes()Footnote[]|nullRuft alle Footnote-Elemente im Textkörper des ersten Tabs oder, bei Scripts, die an ein Dokument gebunden sind, im Textkörper des aktiven Tabs ab.
getHeader()HeaderSection|nullRuft den Header-Abschnitt des ersten Tabs oder, bei Scripts, die an ein Dokument gebunden sind, den Header-Abschnitt des aktiven Tabs ab.
getId()StringRuft die eindeutige Kennung des Dokuments ab.
getLanguage()StringRuft den Sprachcode des Dokuments ab.
getName()StringRuft den Titel des Dokuments ab.
getNamedRangeById(id)NamedRange|nullRuft das NamedRange mit der angegebenen ID auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab ab.
getNamedRanges()NamedRange[]Ruft alle NamedRange-Objekte auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab ab.
getNamedRanges(name)NamedRange[]Ruft alle NamedRange-Objekte mit dem angegebenen Namen auf dem ersten Tab oder, bei Skripts, die an ein Dokument gebunden sind, auf dem aktiven Tab ab.
getSelection()Range|nullRuft die Auswahl des Nutzers auf dem aktiven Tab ab.
getSupportedLanguageCodes()String[]Ruft alle Sprachcodes ab, die in Google Docs-Dateien unterstützt werden.
getTab(tabId)TabRuft das Tab mit der angegebenen ID ab.
getTabs()Tab[]Ruft alle nicht verschachtelten Tab-Elemente ab, die Teil des Dokuments sind.
getUrl()StringRuft die URL für den Zugriff auf das aktuelle Dokument ab.
getViewers()User[]Ruft die Liste der Betrachter und Kommentatoren für diese Document ab.
newPosition(element, offset)PositionErstellt eine neue Position, die sich auf eine Position auf dem Tab bezieht, relativ zu einem bestimmten Element auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab.
newRange()RangeBuilderErstellt einen Builder, mit dem Range-Objekte aus Tab-Elementen auf dem ersten Tab oder, bei Skripts, die an ein Dokument gebunden sind, auf dem aktiven Tab erstellt werden.
removeEditor(emailAddress)DocumentEntfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für die Document.
removeEditor(user)DocumentEntfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für die Document.
removeViewer(emailAddress)DocumentEntfernt den angegebenen Nutzer aus der Liste der Zuschauer und Kommentatoren für die Document.
removeViewer(user)DocumentEntfernt den angegebenen Nutzer aus der Liste der Zuschauer und Kommentatoren für die Document.
saveAndClose()voidSpeichert die aktuelle Document.
setActiveTab(tabId)voidLegt die ausgewählte Tab des Nutzers im aktuellen Dokument auf den Tab mit der angegebenen ID fest.
setCursor(position)DocumentLegt den Cursor des Nutzers anhand eines Position fest.
setLanguage(languageCode)DocumentLegt den Sprachcode des Dokuments fest.
setName(name)DocumentLegt den Dokumenttitel fest.
setSelection(range)DocumentLegt die Auswahl des Nutzers auf dem aktiven Tab fest, wenn ein Range angegeben ist.

DocumentApp

Attribute

AttributTypBeschreibung
AttributeAttributeDie Aufzählung Attribute.
ElementTypeElementTypeDie Aufzählung ElementType.
FontFamilyFontFamilyDie Aufzählung FontFamily.
GlyphTypeGlyphTypeDie Aufzählung GlyphType.
HorizontalAlignmentHorizontalAlignmentDie Aufzählung HorizontalAlignment.
ParagraphHeadingParagraphHeadingDie Aufzählung ParagraphHeading.
PositionedLayoutPositionedLayoutDie Aufzählung PositionedLayout.
TextAlignmentTextAlignmentDie Aufzählung TextAlignment.
VerticalAlignmentVerticalAlignmentDie Aufzählung VerticalAlignment.

Methoden

MethodeRückgabetypKurzbeschreibung
create(name)DocumentErstellt ein neues Dokument und gibt es zurück.
getActiveDocument()DocumentGibt das Dokument zurück, an das das Skript containergebunden ist.
getUi()UiGibt eine Instanz der Benutzeroberflächenumgebung des Dokuments zurück, mit der dem Skript Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzugefügt werden können.
openById(id)DocumentGibt das Dokument mit der angegebenen ID zurück.
openByUrl(url)DocumentÖffnet das Dokument mit der angegebenen URL und gibt es zurück.

DocumentTab

Methoden

MethodeRückgabetypKurzbeschreibung
addBookmark(position)BookmarkFügt am angegebenen Position ein Bookmark hinzu.
addFooter()FooterSectionFügt einen Tab-Footerbereich hinzu, falls noch keiner vorhanden ist.
addHeader()HeaderSectionFügt einen Tab-Header-Abschnitt hinzu, falls noch keiner vorhanden ist.
addNamedRange(name, range)NamedRangeFügt ein NamedRange hinzu, das ein Range mit einem Namen und einer ID ist, die für den späteren Abruf verwendet werden können.
getBody()BodyRuft die Body des Tabs ab.
getBookmark(id)Bookmark|nullRuft das Bookmark mit der angegebenen ID ab.
getBookmarks()Bookmark[]Ruft alle Bookmark-Objekte auf dem Tab ab.
getFooter()FooterSection|nullRuft den Fußzeilenbereich des Tabs ab, falls vorhanden.
getFootnotes()Footnote[]|nullRuft alle Footnote-Elemente im Tab-Body ab.
getHeader()HeaderSection|nullRuft den Headerbereich des Tabs ab, falls er vorhanden ist.
getNamedRangeById(id)NamedRange|nullRuft das NamedRange mit der angegebenen ID ab.
getNamedRanges()NamedRange[]Ruft alle NamedRange-Objekte auf dem Tab ab.
getNamedRanges(name)NamedRange[]Ruft alle NamedRange-Objekte auf dem Tab mit dem angegebenen Namen ab.
newPosition(element, offset)PositionErstellt ein neues Position, das eine Referenz auf eine Position auf dem Tab relativ zu einem bestimmten Element ist.
newRange()RangeBuilderErstellt einen Builder, mit dem Range-Objekte aus Tab-Elementen erstellt werden.

Element

Methoden

MethodeRückgabetypKurzbeschreibung
asBody()BodyGibt das aktuelle Element als Body zurück.
asDate()DateGibt das aktuelle Element als Date zurück.
asEquation()EquationGibt das aktuelle Element als Equation zurück.
asEquationFunction()EquationFunctionGibt das aktuelle Element als EquationFunction zurück.
asEquationFunctionArgumentSeparator()EquationFunctionArgumentSeparatorGibt das aktuelle Element als EquationFunctionArgumentSeparator zurück.
asEquationSymbol()EquationSymbolGibt das aktuelle Element als EquationSymbol zurück.
asFooterSection()FooterSectionGibt das aktuelle Element als FooterSection zurück.
asFootnote()FootnoteGibt das aktuelle Element als Footnote zurück.
asFootnoteSection()FootnoteSectionGibt das aktuelle Element als FootnoteSection zurück.
asHeaderSection()HeaderSectionGibt das aktuelle Element als HeaderSection zurück.
asHorizontalRule()HorizontalRuleGibt das aktuelle Element als HorizontalRule zurück.
asInlineDrawing()InlineDrawingGibt das aktuelle Element als InlineDrawing zurück.
asInlineImage()InlineImageGibt das aktuelle Element als InlineImage zurück.
asListItem()ListItemGibt das aktuelle Element als ListItem zurück.
asPageBreak()PageBreakGibt das aktuelle Element als PageBreak zurück.
asParagraph()ParagraphGibt das aktuelle Element als Paragraph zurück.
asPerson()PersonGibt das aktuelle Element als Person zurück.
asRichLink()RichLinkGibt das aktuelle Element als RichLink zurück, z. B. einen Link zu einer Google Sheets-Datei.
asTable()TableGibt das aktuelle Element als Table zurück.
asTableCell()TableCellGibt das aktuelle Element als TableCell zurück.
asTableOfContents()TableOfContentsGibt das aktuelle Element als TableOfContents zurück.
asTableRow()TableRowGibt das aktuelle Element als TableRow zurück.
asText()TextGibt das aktuelle Element als Text zurück.
copy()ElementGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
merge()Element|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeFromParent()Element|nullEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)ElementLegt die Attribute des Elements fest.

ElementType

Attribute

AttributTypBeschreibung
BODY_SECTIONEnumDer Typ, der dem Body-Element entspricht.
COMMENT_SECTIONEnumDer Typ, der dem CommentSection-Element entspricht.
DATEEnumDer Typ, der dem Date-Element entspricht.
EQUATIONEnumDer Typ, der dem Equation-Element entspricht.
EQUATION_FUNCTIONEnumDer Typ, der dem EquationFunction-Element entspricht.
EQUATION_FUNCTION_ARGUMENT_SEPARATOREnumDer Typ, der dem EquationFunctionArgumentSeparator-Element entspricht.
EQUATION_SYMBOLEnumDer Typ, der dem EquationSymbol-Element entspricht.
RICH_LINKEnumDer Typ, der dem RichLink-Element entspricht.
FOOTER_SECTIONEnumDer Typ, der dem FooterSection-Element entspricht.
FOOTNOTEEnumDer Typ, der dem Footnote-Element entspricht.
FOOTNOTE_SECTIONEnumDer Typ, der dem FootnoteSection-Element entspricht.
HEADER_SECTIONEnumDer Typ, der dem HeaderSection-Element entspricht.
HORIZONTAL_RULEEnumDer Typ, der dem HorizontalRule-Element entspricht.
INLINE_DRAWINGEnumDer Typ, der dem InlineDrawing-Element entspricht.
INLINE_IMAGEEnumDer Typ, der dem InlineImage-Element entspricht.
LIST_ITEMEnumDer Typ, der dem ListItem-Element entspricht.
PAGE_BREAKEnumDer Typ, der dem PageBreak-Element entspricht.
PARAGRAPHEnumDer Typ, der dem Paragraph-Element entspricht.
PERSONEnumDer Typ, der dem Person-Element entspricht.
TABLEEnumDer Typ, der dem Table-Element entspricht.
TABLE_CELLEnumDer Typ, der dem TableCell-Element entspricht.
TABLE_OF_CONTENTSEnumDer Typ, der dem TableOfContents-Element entspricht.
TABLE_ROWEnumDer Typ, der dem TableRow-Element entspricht.
TEXTEnumDer Typ, der dem Text-Element entspricht.
UNSUPPORTEDEnumDer Typ, der UnsupportedElement entspricht.

Equation

Methoden

MethodeRückgabetypKurzbeschreibung
clear()EquationLöscht den Inhalt des Elements.
copy()EquationGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElement|nullDurchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs.
findElement(elementType, from)RangeElement|nullDurchsucht den Inhalt des Elements nach einem untergeordneten Element des angegebenen Typs, beginnend mit dem angegebenen RangeElement.
findText(searchPattern)RangeElement|nullSucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElement|nullDurchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element am angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab.
getLinkUrl()String|nullRuft die Link-URL ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignment|nullGibt die Textausrichtung zurück.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
merge()Equation|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeFromParent()Equation|nullEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet.
setAttributes(attributes)EquationLegt die Attribute des Elements fest.
setLinkUrl(url)EquationLegt die Link-URL fest.
setTextAlignment(textAlignment)EquationLegt die Textausrichtung fest.

EquationFunction

Methoden

MethodeRückgabetypKurzbeschreibung
clear()EquationFunctionLöscht den Inhalt des Elements.
copy()EquationFunctionGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElement|nullDurchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs.
findElement(elementType, from)RangeElement|nullDurchsucht den Inhalt des Elements nach einem untergeordneten Element des angegebenen Typs, beginnend mit dem angegebenen RangeElement.
findText(searchPattern)RangeElement|nullSucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElement|nullDurchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element am angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab.
getCode()StringRuft den Code ab, der der Gleichungsfunktion entspricht.
getLinkUrl()String|nullRuft die Link-URL ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignment|nullGibt die Textausrichtung zurück.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
merge()EquationFunction|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeFromParent()EquationFunction|nullEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet.
setAttributes(attributes)EquationFunctionLegt die Attribute des Elements fest.
setLinkUrl(url)EquationFunctionLegt die Link-URL fest.
setTextAlignment(textAlignment)EquationFunctionLegt die Textausrichtung fest.

EquationFunctionArgumentSeparator

Methoden

MethodeRückgabetypKurzbeschreibung
copy()EquationFunctionArgumentSeparatorGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
merge()EquationFunctionArgumentSeparator|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeFromParent()EquationFunctionArgumentSeparator|nullEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)EquationFunctionArgumentSeparatorLegt die Attribute des Elements fest.

EquationSymbol

Methoden

MethodeRückgabetypKurzbeschreibung
copy()EquationSymbolGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getCode()StringRuft den Code ab, der dem Gleichungssymbol entspricht.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
merge()EquationSymbol|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeFromParent()EquationSymbol|nullEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)EquationSymbolLegt die Attribute des Elements fest.

FontFamily

FooterSection

Methoden

MethodeRückgabetypKurzbeschreibung
appendHorizontalRule()HorizontalRuleErstellt und hängt einen neuen HorizontalRule an.
appendImage(image)InlineImageErstellt ein neues InlineImage aus dem angegebenen Bild-Blob und hängt es an.
appendImage(image)InlineImageHängt die angegebene InlineImage an.
appendListItem(listItem)ListItemHängt die angegebene ListItem an.
appendListItem(text)ListItemErstellt ein neues ListItem mit dem angegebenen Textinhalt und hängt es an.
appendParagraph(paragraph)ParagraphHängt die angegebene Paragraph an.
appendParagraph(text)ParagraphErstellt ein neues Paragraph mit dem angegebenen Textinhalt und hängt es an.
appendTable()TableErstellt und hängt einen neuen Table an.
appendTable(cells)TableHängt ein neues Table mit einem TableCell für jeden angegebenen String-Wert an.
appendTable(table)TableHängt die angegebene Table an.
clear()FooterSectionLöscht den Inhalt des Elements.
copy()FooterSectionGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElement|nullDurchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs.
findElement(elementType, from)RangeElement|nullDurchsucht den Inhalt des Elements nach einem untergeordneten Element des angegebenen Typs, beginnend mit dem angegebenen RangeElement.
findText(searchPattern)RangeElement|nullSucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElement|nullDurchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element am angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab.
getImages()InlineImage[]|nullRuft alle InlineImages ab, die im Abschnitt enthalten sind.
getListItems()ListItem[]|nullRuft alle ListItems ab, die im Abschnitt enthalten sind.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParagraphs()Paragraph[]|nullRuft alle Paragraphs ab, die im Abschnitt enthalten sind (einschließlich ListItems).
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getTables()Table[]|nullRuft alle Tables ab, die im Abschnitt enthalten sind.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignment|nullGibt die Textausrichtung zurück.
getType()ElementTypeRuft den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt und fügt ein neues HorizontalRule am angegebenen Index ein.
insertImage(childIndex, image)InlineImageErstellt und fügt ein InlineImage aus dem angegebenen Bild-Blob am angegebenen Index ein.
insertImage(childIndex, image)InlineImageFügt das angegebene InlineImage am angegebenen Index ein.
insertListItem(childIndex, listItem)ListItemFügt das angegebene ListItem am angegebenen Index ein.
insertListItem(childIndex, text)ListItemErstellt und fügt ein neues ListItem am angegebenen Index ein, das den angegebenen Textinhalt enthält.
insertParagraph(childIndex, paragraph)ParagraphFügt das angegebene Paragraph am angegebenen Index ein.
insertParagraph(childIndex, text)ParagraphErstellt und fügt ein neues Paragraph am angegebenen Index ein, das den angegebenen Textinhalt enthält.
insertTable(childIndex)TableErstellt und fügt ein neues Table am angegebenen Index ein.
insertTable(childIndex, cells)TableErstellt und fügt ein neues Table mit den angegebenen Zellen am angegebenen Index ein.
insertTable(childIndex, table)TableFügt das angegebene Table am angegebenen Index ein.
removeChild(child)FooterSectionEntfernt das angegebene untergeordnete Element.
removeFromParent()FooterSection|nullEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet.
setAttributes(attributes)FooterSectionLegt die Attribute des Elements fest.
setText(text)FooterSectionLegt den Inhalt als Nur-Text fest.
setTextAlignment(textAlignment)FooterSectionLegt die Textausrichtung fest.

Footnote

Methoden

MethodeRückgabetypKurzbeschreibung
copy()FootnoteGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getFootnoteContents()FootnoteSection|nullRuft den Inhalt des Fußnotenelements ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
removeFromParent()Footnote|nullEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)FootnoteLegt die Attribute des Elements fest.

FootnoteSection

Methoden

MethodeRückgabetypKurzbeschreibung
appendParagraph(paragraph)ParagraphHängt die angegebene Paragraph an.
appendParagraph(text)ParagraphErstellt ein neues Paragraph mit dem angegebenen Textinhalt und hängt es an.
clear()FootnoteSectionLöscht den Inhalt des Elements.
copy()FootnoteSectionGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElement|nullDurchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs.
findElement(elementType, from)RangeElement|nullDurchsucht den Inhalt des Elements nach einem untergeordneten Element des angegebenen Typs, beginnend mit dem angegebenen RangeElement.
findText(searchPattern)RangeElement|nullSucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElement|nullDurchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element am angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParagraphs()Paragraph[]|nullRuft alle Paragraphs ab, die im Abschnitt enthalten sind (einschließlich ListItems).
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignment|nullGibt die Textausrichtung zurück.
getType()ElementTypeRuft den ElementType des Elements ab.
insertParagraph(childIndex, paragraph)ParagraphFügt das angegebene Paragraph am angegebenen Index ein.
insertParagraph(childIndex, text)ParagraphErstellt und fügt ein neues Paragraph am angegebenen Index ein, das den angegebenen Textinhalt enthält.
removeChild(child)FootnoteSectionEntfernt das angegebene untergeordnete Element.
removeFromParent()FootnoteSection|nullEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet.
setAttributes(attributes)FootnoteSectionLegt die Attribute des Elements fest.
setText(text)FootnoteSectionLegt den Inhalt als Nur-Text fest.
setTextAlignment(textAlignment)FootnoteSectionLegt die Textausrichtung fest.

GlyphType

Attribute

AttributTypBeschreibung
BULLETEnumDas Standard-Aufzählungszeichen ist kreisförmig und gefüllt.
HOLLOW_BULLETEnumEin nicht gefülltes Aufzählungszeichen.
SQUARE_BULLETEnumEin quadratisches Aufzählungszeichen.
NUMBEREnumEine nummerierte Aufzählung.
LATIN_UPPEREnumEin lateinisches, in Großbuchstaben geschriebenes Aufzählungszeichen.
LATIN_LOWEREnumEin lateinisches Aufzählungszeichen in Kleinbuchstaben.
ROMAN_UPPEREnumEine römische Ziffer, gefolgt von einem Aufzählungszeichen in Großbuchstaben.
ROMAN_LOWEREnumEine römische Ziffer, ein Aufzählungszeichen in Kleinbuchstaben.

HeaderSection

Methoden

MethodeRückgabetypKurzbeschreibung
appendHorizontalRule()HorizontalRuleErstellt und hängt einen neuen HorizontalRule an.
appendImage(image)InlineImageErstellt ein neues InlineImage aus dem angegebenen Bild-Blob und hängt es an.
appendImage(image)InlineImageHängt die angegebene InlineImage an.
appendListItem(listItem)ListItemHängt die angegebene ListItem an.
appendListItem(text)ListItemErstellt ein neues ListItem mit dem angegebenen Textinhalt und hängt es an.
appendParagraph(paragraph)ParagraphHängt die angegebene Paragraph an.
appendParagraph(text)ParagraphErstellt ein neues Paragraph mit dem angegebenen Textinhalt und hängt es an.
appendTable()TableErstellt und hängt einen neuen Table an.
appendTable(cells)TableHängt ein neues Table mit einem TableCell für jeden angegebenen String-Wert an.
appendTable(table)TableHängt die angegebene Table an.
clear()HeaderSectionLöscht den Inhalt des Elements.
copy()HeaderSectionGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElement|nullDurchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs.
findElement(elementType, from)RangeElement|nullDurchsucht den Inhalt des Elements nach einem untergeordneten Element des angegebenen Typs, beginnend mit dem angegebenen RangeElement.
findText(searchPattern)RangeElement|nullSucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElement|nullDurchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element am angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab.
getImages()InlineImage[]|nullRuft alle InlineImages ab, die im Abschnitt enthalten sind.
getListItems()ListItem[]|nullRuft alle ListItems ab, die im Abschnitt enthalten sind.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParagraphs()Paragraph[]|nullRuft alle Paragraphs ab, die im Abschnitt enthalten sind (einschließlich ListItems).
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getTables()Table[]|nullRuft alle Tables ab, die im Abschnitt enthalten sind.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignment|nullGibt die Textausrichtung zurück.
getType()ElementTypeRuft den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt und fügt ein neues HorizontalRule am angegebenen Index ein.
insertImage(childIndex, image)InlineImageErstellt und fügt ein InlineImage aus dem angegebenen Bild-Blob am angegebenen Index ein.
insertImage(childIndex, image)InlineImageFügt das angegebene InlineImage am angegebenen Index ein.
insertListItem(childIndex, listItem)ListItemFügt das angegebene ListItem am angegebenen Index ein.
insertListItem(childIndex, text)ListItemErstellt und fügt ein neues ListItem am angegebenen Index ein, das den angegebenen Textinhalt enthält.
insertParagraph(childIndex, paragraph)ParagraphFügt das angegebene Paragraph am angegebenen Index ein.
insertParagraph(childIndex, text)ParagraphErstellt und fügt ein neues Paragraph am angegebenen Index ein, das den angegebenen Textinhalt enthält.
insertTable(childIndex)TableErstellt und fügt ein neues Table am angegebenen Index ein.
insertTable(childIndex, cells)TableErstellt und fügt ein neues Table mit den angegebenen Zellen am angegebenen Index ein.
insertTable(childIndex, table)TableFügt das angegebene Table am angegebenen Index ein.
removeChild(child)HeaderSectionEntfernt das angegebene untergeordnete Element.
removeFromParent()HeaderSection|nullEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet.
setAttributes(attributes)HeaderSectionLegt die Attribute des Elements fest.
setText(text)HeaderSectionLegt den Inhalt als Nur-Text fest.
setTextAlignment(textAlignment)HeaderSectionLegt die Textausrichtung fest.

HorizontalAlignment

Attribute

AttributTypBeschreibung
LEFTEnumDie Option für die Linksausrichtung.
CENTEREnumDie Option für die zentrierte Ausrichtung.
RIGHTEnumDie Option für die Rechtsausrichtung.
JUSTIFYEnumDie Option für den Blocksatz.

HorizontalRule

Methoden

MethodeRückgabetypKurzbeschreibung
copy()HorizontalRuleGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
removeFromParent()HorizontalRule|nullEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)HorizontalRuleLegt die Attribute des Elements fest.

InlineDrawing

Methoden

MethodeRückgabetypKurzbeschreibung
copy()InlineDrawingGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
getAltDescription()String|nullGibt die alternative Beschreibung der Zeichnung zurück.
getAltTitle()String|nullGibt den alternativen Titel der Zeichnung zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
merge()InlineDrawing|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeFromParent()InlineDrawing|nullEntfernt das Element aus dem übergeordneten Element.
setAltDescription(description)InlineDrawingLegt die alternative Beschreibung der Zeichnung fest.
setAltTitle(title)InlineDrawingLegt den alternativen Titel der Zeichnung fest.
setAttributes(attributes)InlineDrawingLegt die Attribute des Elements fest.

InlineImage

Methoden

MethodeRückgabetypKurzbeschreibung
copy()InlineImageGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
getAltDescription()String|nullGibt die alternative Beschreibung des Bildes zurück.
getAltTitle()String|nullGibt den alternativen Titel des Bildes zurück.
getAs(contentType)BlobGibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde.
getAttributes()ObjectRuft die Attribute des Elements ab.
getBlob()BlobGibt die Daten in diesem Objekt als Blob zurück.
getHeight()IntegerRuft die Höhe des Bildes in Pixeln ab.
getLinkUrl()String|nullRuft die Link-URL ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
getWidth()IntegerRuft die Breite des Bildes in Pixeln ab.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
merge()InlineImage|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeFromParent()InlineImage|nullEntfernt das Element aus dem übergeordneten Element.
setAltDescription(description)InlineImageLegt die alternative Beschreibung des Bildes fest.
setAltTitle(title)InlineImageLegt den alternativen Titel des Bildes fest.
setAttributes(attributes)InlineImageLegt die Attribute des Elements fest.
setHeight(height)InlineImageLegt die Höhe des Bildes in Pixeln fest.
setLinkUrl(url)InlineImageLegt die Link-URL fest.
setWidth(width)InlineImageLegt die Breite des Bildes in Pixeln fest.

ListItem

Methoden

MethodeRückgabetypKurzbeschreibung
addPositionedImage(image)PositionedImageErstellt und fügt ein neues PositionedImage aus dem angegebenen Image-Blob ein.
appendHorizontalRule()HorizontalRuleErstellt und hängt einen neuen HorizontalRule an.
appendInlineImage(image)InlineImageErstellt ein neues InlineImage aus dem angegebenen Bild-Blob und hängt es an.
appendInlineImage(image)InlineImageHängt die angegebene InlineImage an.
appendPageBreak()PageBreakErstellt und hängt einen neuen PageBreak an.
appendPageBreak(pageBreak)PageBreakHängt die angegebene PageBreak an.
appendText(text)TextErstellt ein neues Text-Element mit dem angegebenen Inhalt und hängt es an.
appendText(text)TextHängt das angegebene Text-Element an.
clear()ListItemLöscht den Inhalt des Elements.
copy()ListItemGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElement|nullDurchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs.
findElement(elementType, from)RangeElement|nullDurchsucht den Inhalt des Elements nach einem untergeordneten Element des angegebenen Typs, beginnend mit dem angegebenen RangeElement.
findText(searchPattern)RangeElement|nullSucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElement|nullDurchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster.
getAlignment()HorizontalAlignment|nullRuft die HorizontalAlignment ab.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element am angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab.
getGlyphType()GlyphType|nullRuft die GlyphType des Listeneintrags ab.
getHeading()ParagraphHeading|nullRuft die ParagraphHeading ab.
getIndentEnd()Number|nullRuft den Einzug am Ende in Punkten ab.
getIndentFirstLine()Number|nullRuft den Einzug der ersten Zeile in Punkten ab.
getIndentStart()Number|nullRuft die Start-Einrückung ab.
getLineSpacing()Number|nullRuft den Zeilenabstand in Punkten ab.
getLinkUrl()String|nullRuft die Link-URL ab.
getListId()String|nullRuft die Listen-ID ab.
getNestingLevel()IntegerRuft die Verschachtelungsebene des Listeneintrags ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPositionedImage(id)PositionedImageRuft ein PositionedImage anhand der Bild-ID ab.
getPositionedImages()PositionedImage[]Ruft alle PositionedImage-Objekte ab, die im Absatz verankert sind.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getSpacingAfter()Number|nullRuft den Abstand nach dem Element in Punkten ab.
getSpacingBefore()Number|nullRuft den Abstand vor dem Element in Punkten ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignment|nullGibt die Textausrichtung zurück.
getType()ElementTypeRuft den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt und fügt eine HorizontalRule am angegebenen Index ein.
insertInlineImage(childIndex, image)InlineImageErstellt und fügt ein neues InlineImage aus dem angegebenen Bild-Blob am angegebenen Index ein.
insertInlineImage(childIndex, image)InlineImageFügt das angegebene InlineImage am angegebenen Index ein.
insertPageBreak(childIndex)PageBreakErstellt und fügt ein neues PageBreak am angegebenen Index ein.
insertPageBreak(childIndex, pageBreak)PageBreakFügt das angegebene PageBreak am angegebenen Index ein.
insertText(childIndex, text)TextErstellt ein neues Textelement und fügt es am angegebenen Index ein.
insertText(childIndex, text)TextFügt das angegebene Text-Element am angegebenen Index mit dem angegebenen Textinhalt ein.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
isLeftToRight()Boolean|nullRuft die Einstellung für die Schreibrichtung von links nach rechts ab.
merge()ListItem|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeChild(child)ListItemEntfernt das angegebene untergeordnete Element.
removeFromParent()ListItem|nullEntfernt das Element aus dem übergeordneten Element.
removePositionedImage(id)BooleanEntfernt ein PositionedImage anhand der Bild-ID.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet.
setAlignment(alignment)ListItemLegt HorizontalAlignment fest.
setAttributes(attributes)ListItemLegt die Attribute des Elements fest.
setGlyphType(glyphType)ListItemLegt die GlyphType des Listenelements fest.
setHeading(heading)ListItemLegt ParagraphHeading fest.
setIndentEnd(indentEnd)ListItemLegt den Einzug am Ende in Punkten fest.
setIndentFirstLine(indentFirstLine)ListItemLegt den Einzug der ersten Zeile in Punkten fest.
setIndentStart(indentStart)ListItemLegt den Einzug am Anfang in Punkten fest.
setLeftToRight(leftToRight)ListItemLegt die Einstellung für die Leserichtung von links nach rechts fest.
setLineSpacing(multiplier)ListItemLegt den Zeilenabstand als Menge fest, die die Anzahl der für den Abstand zu verwendenden Zeilen angibt.
setLinkUrl(url)ListItemLegt die Link-URL fest.
setListId(listItem)ListItemLegt die Listen-ID fest.
setNestingLevel(nestingLevel)ListItemLegt die Verschachtelungsebene des Listeneintrags fest.
setSpacingAfter(spacingAfter)ListItemLegt den Abstand nach dem Element in Punkten fest.
setSpacingBefore(spacingBefore)ListItemLegt den Abstand vor dem Element in Punkten fest.
setText(text)voidLegt den Inhalt des Listenelements als Text fest.
setTextAlignment(textAlignment)ListItemLegt die Textausrichtung fest.

NamedRange

Methoden

MethodeRückgabetypKurzbeschreibung
getId()StringRuft die ID dieses NamedRange ab.
getName()StringRuft den Namen dieser NamedRange ab.
getRange()RangeRuft den Bereich der Elemente ab, die mit diesem NamedRange verknüpft sind.
remove()voidEntfernt dieses NamedRange aus dem Tab.

PageBreak

Methoden

MethodeRückgabetypKurzbeschreibung
copy()PageBreakGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
removeFromParent()PageBreak|nullEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)PageBreakLegt die Attribute des Elements fest.

Paragraph

Methoden

MethodeRückgabetypKurzbeschreibung
addPositionedImage(image)PositionedImageErstellt und fügt ein neues PositionedImage aus dem angegebenen Image-Blob ein.
appendHorizontalRule()HorizontalRuleErstellt und hängt einen neuen HorizontalRule an.
appendInlineImage(image)InlineImageErstellt ein neues InlineImage aus dem angegebenen Bild-Blob und hängt es an.
appendInlineImage(image)InlineImageHängt die angegebene InlineImage an.
appendPageBreak()PageBreakErstellt und hängt einen neuen PageBreak an.
appendPageBreak(pageBreak)PageBreakHängt die angegebene PageBreak an.
appendText(text)TextErstellt ein neues Text-Element mit dem angegebenen Inhalt und hängt es an.
appendText(text)TextHängt das angegebene Text-Element an.
clear()ParagraphLöscht den Inhalt des Elements.
copy()ParagraphGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElement|nullDurchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs.
findElement(elementType, from)RangeElement|nullDurchsucht den Inhalt des Elements nach einem untergeordneten Element des angegebenen Typs, beginnend mit dem angegebenen RangeElement.
findText(searchPattern)RangeElement|nullSucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElement|nullDurchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster.
getAlignment()HorizontalAlignment|nullRuft die HorizontalAlignment ab.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element am angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab.
getHeading()ParagraphHeading|nullRuft die ParagraphHeading ab.
getIndentEnd()Number|nullRuft den Einzug am Ende in Punkten ab.
getIndentFirstLine()Number|nullRuft den Einzug der ersten Zeile in Punkten ab.
getIndentStart()Number|nullRuft die Start-Einrückung ab.
getLineSpacing()Number|nullRuft den Zeilenabstand in Punkten ab.
getLinkUrl()String|nullRuft die Link-URL ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPositionedImage(id)PositionedImageRuft ein PositionedImage anhand der Bild-ID ab.
getPositionedImages()PositionedImage[]Ruft alle PositionedImage-Objekte ab, die im Absatz verankert sind.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getSpacingAfter()Number|nullRuft den Abstand nach dem Element in Punkten ab.
getSpacingBefore()Number|nullRuft den Abstand vor dem Element in Punkten ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignment|nullGibt die Textausrichtung zurück.
getType()ElementTypeRuft den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt und fügt eine HorizontalRule am angegebenen Index ein.
insertInlineImage(childIndex, image)InlineImageErstellt und fügt ein neues InlineImage aus dem angegebenen Bild-Blob am angegebenen Index ein.
insertInlineImage(childIndex, image)InlineImageFügt das angegebene InlineImage am angegebenen Index ein.
insertPageBreak(childIndex)PageBreakErstellt und fügt ein neues PageBreak am angegebenen Index ein.
insertPageBreak(childIndex, pageBreak)PageBreakFügt das angegebene PageBreak am angegebenen Index ein.
insertText(childIndex, text)TextErstellt ein neues Textelement und fügt es am angegebenen Index ein.
insertText(childIndex, text)TextFügt das angegebene Text-Element am angegebenen Index mit dem angegebenen Textinhalt ein.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
isLeftToRight()Boolean|nullRuft die Einstellung für die Schreibrichtung von links nach rechts ab.
merge()Paragraph|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeChild(child)ParagraphEntfernt das angegebene untergeordnete Element.
removeFromParent()Paragraph|nullEntfernt das Element aus dem übergeordneten Element.
removePositionedImage(id)BooleanEntfernt ein PositionedImage anhand der Bild-ID.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet.
setAlignment(alignment)ParagraphLegt HorizontalAlignment fest.
setAttributes(attributes)ParagraphLegt die Attribute des Elements fest.
setHeading(heading)ParagraphLegt ParagraphHeading fest.
setIndentEnd(indentEnd)ParagraphLegt den Einzug am Ende in Punkten fest.
setIndentFirstLine(indentFirstLine)ParagraphLegt den Einzug der ersten Zeile in Punkten fest.
setIndentStart(indentStart)ParagraphLegt den Einzug am Anfang in Punkten fest.
setLeftToRight(leftToRight)ParagraphLegt die Einstellung für die Leserichtung von links nach rechts fest.
setLineSpacing(multiplier)ParagraphLegt den Zeilenabstand als Menge fest, die die Anzahl der für den Abstand zu verwendenden Zeilen angibt.
setLinkUrl(url)ParagraphLegt die Link-URL fest.
setSpacingAfter(spacingAfter)ParagraphLegt den Abstand nach dem Element in Punkten fest.
setSpacingBefore(spacingBefore)ParagraphLegt den Abstand vor dem Element in Punkten fest.
setText(text)voidLegt den Inhalt des Absatzes als Text fest.
setTextAlignment(textAlignment)ParagraphLegt die Textausrichtung fest.

ParagraphHeading

Attribute

AttributTypBeschreibung
NORMALEnumDie Überschriftenoption für normalen Text.
HEADING1EnumDie höchste Überschriftenoption.
HEADING2EnumDie zweite Überschriftenoption.
HEADING3EnumDie dritte Überschriftenoption
HEADING4EnumDie vierte Überschriftenoption.
HEADING5EnumDie fünfte Überschriftenoption.
HEADING6EnumDie niedrigste Überschriftenoption.
TITLEEnumDie Option für die Titelüberschrift.
SUBTITLEEnumDie Option für die Untertitelüberschrift.

Person

Methoden

MethodeRückgabetypKurzbeschreibung
copy()PersonGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getEmail()StringGibt die E‑Mail-Adresse der Person zurück.
getName()String|nullGibt den Anzeigenamen der Person zurück, falls er festgelegt ist.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
merge()Person|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeFromParent()Person|nullEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)PersonLegt die Attribute des Elements fest.

Position

Methoden

MethodeRückgabetypKurzbeschreibung
getElement()ElementRuft das Element ab, das diese Position enthält.
getOffset()IntegerGibt die relative Position dieses Position-Elements innerhalb des Elements zurück, das es enthält.
getSurroundingText()TextErstellt ein künstliches Text-Element, das den Text und die Formatierung des Paragraph- oder ListItem-Elements darstellt, das das Position-Element direkt oder über eine Kette untergeordneter Elemente enthält.
getSurroundingTextOffset()IntegerRuft den Offset dieses Position innerhalb des Text-Elements ab, das von getSurroundingText() zurückgegeben wird.
insertBookmark()BookmarkErstellt und fügt an dieser Position eine neue Bookmark ein.
insertInlineImage(image)InlineImage|nullErstellt und fügt an dieser Position ein neues InlineImage aus dem angegebenen Bild-Blob ein.
insertText(text)Text|nullFügt den angegebenen Text an dieser Position ein.

PositionedImage

Methoden

MethodeRückgabetypKurzbeschreibung
getAs(contentType)BlobGibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde.
getBlob()BlobGibt die Daten in diesem Objekt als Blob zurück.
getHeight()IntegerRuft die Höhe des Bildes in Pixeln ab.
getId()StringRuft die ID des Bildes ab.
getLayout()PositionedLayoutRuft einen Enumerationswert ab, der angibt, wie das Bild angeordnet ist.
getLeftOffset()NumberRuft den Abstand des Bildes vom linken Rand des Absatzes in Punkten ab.
getParagraph()ParagraphRuft das Paragraph ab, an dem das Bild verankert ist.
getTopOffset()NumberRuft den Abstand des Bildes vom oberen Rand des Absatzes in Punkten ab.
getWidth()IntegerRuft die Breite des Bildes in Pixeln ab.
setHeight(height)PositionedImageLegt die Höhe des Bildes in Pixeln fest.
setLayout(layout)PositionedImageLegt die Definition für die Anordnung des Bildes fest.
setLeftOffset(offset)PositionedImageLegt den Abstand des Bildes in Punkten vom linken Rand des Absatzes fest.
setTopOffset(offset)PositionedImageLegt den Abstand des Bildes in Punkten vom oberen Rand des Absatzes fest.
setWidth(width)PositionedImageLegt die Breite des Bildes in Pixeln fest.

PositionedLayout

Attribute

AttributTypBeschreibung
ABOVE_TEXTEnumDas Bild wird über dem Text platziert.
BREAK_BOTHEnumDas Bild unterbricht den Text auf der linken und rechten Seite.
BREAK_LEFTEnumDas Bild unterbricht den Text auf der linken Seite.
BREAK_RIGHTEnumDas Bild unterbricht den Text auf der rechten Seite.
WRAP_TEXTEnumDas Bild ist von Text umgeben.

Range

Methoden

MethodeRückgabetypKurzbeschreibung
getRangeElements()RangeElement[]Ruft alle Elemente in diesem Range ab, einschließlich aller partiellen Text-Elemente (z. B. bei einer Auswahl, die nur einen Teil eines Text-Elements umfasst).

RangeBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
addElement(element)RangeBuilderFügt diesem RangeBuilder ein ganzes Element hinzu.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderFügt diesem RangeBuilder ein partielles Text-Element hinzu.
addElementsBetween(startElement, endElementInclusive)RangeBuilderFügt dieser RangeBuilder zwei vollständige Elemente und alle Elemente dazwischen hinzu.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderFügt dem RangeBuilder zwei partielle Text-Elemente und alle Elemente dazwischen hinzu.
addRange(range)RangeBuilderFügt die Inhalte eines anderen Range zu diesem RangeBuilder hinzu.
build()RangeErstellt ein Range aus den auf den Builder angewendeten Einstellungen.
getRangeElements()RangeElement[]Ruft alle Elemente in diesem Range ab, einschließlich aller partiellen Text-Elemente (z. B. bei einer Auswahl, die nur einen Teil eines Text-Elements umfasst).

RangeElement

Methoden

MethodeRückgabetypKurzbeschreibung
getElement()ElementRuft die Element ab, die diesem RangeElement entspricht.
getEndOffsetInclusive()IntegerRuft die Position des Endes eines Teilbereichs innerhalb des Bereichselements ab.
getStartOffset()IntegerRuft die Position des Beginns eines Teilbereichs innerhalb des Bereichselements ab.
isPartial()BooleanGibt an, ob dieses Bereichselement das gesamte Element oder eine teilweise Auswahl der Zeichen des Elements abdeckt.

Methoden

MethodeRückgabetypKurzbeschreibung
copy()RichLinkGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getMimeType()String|nullGibt den MIME-Typ des Links zurück, der verfügbar ist, wenn das Element ein Link zu einer Drive-Datei ist, und null, wenn nicht.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getTitle()StringGibt den angezeigten Titel des Links zurück.
getType()ElementTypeRuft den ElementType des Elements ab.
getUrl()StringGibt die URL der Ressource zurück.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
merge()RichLink|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeFromParent()RichLink|nullEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)RichLinkLegt die Attribute des Elements fest.

Tab

Methoden

MethodeRückgabetypKurzbeschreibung
asDocumentTab()DocumentTabRuft den Tabinhalt als DocumentTab ab.
getChildTabs()Tab[]Ruft die untergeordneten Tabs ab, die in diesem Tab verschachtelt sind.
getId()StringRuft die ID des Tabs ab.
getIndex()IntegerRuft den nullbasierten Index des Tabs im übergeordneten Element ab.
getTitle()StringRuft den Titel des Tabs ab.
getType()TabTypeRuft den Typ des Tabs ab.

TabType

Attribute

AttributTypBeschreibung
DOCUMENT_TABEnumDer Typ, der DocumentTab entspricht.

Table

Methoden

MethodeRückgabetypKurzbeschreibung
appendTableRow()TableRowErstellt und hängt einen neuen TableRow an.
appendTableRow(tableRow)TableRowHängt die angegebene TableRow an.
clear()TableLöscht den Inhalt des Elements.
copy()TableGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElement|nullDurchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs.
findElement(elementType, from)RangeElement|nullDurchsucht den Inhalt des Elements nach einem untergeordneten Element des angegebenen Typs, beginnend mit dem angegebenen RangeElement.
findText(searchPattern)RangeElement|nullSucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElement|nullDurchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster.
getAttributes()ObjectRuft die Attribute des Elements ab.
getBorderColor()String|nullRuft die Rahmenfarbe ab.
getBorderWidth()Number|nullRuft die Rahmenbreite in Punkten ab.
getCell(rowIndex, cellIndex)TableCell|nullRuft die TableCell an den angegebenen Zeilen- und Zellenindexen ab.
getChild(childIndex)ElementRuft das untergeordnete Element am angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab.
getColumnWidth(columnIndex)Number|nullRuft die Breite der angegebenen Tabellenspalte in Punkten ab.
getLinkUrl()String|nullRuft die Link-URL ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getNumRows()IntegerRuft die Anzahl der TableRows ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getRow(rowIndex)TableRow|nullRuft die TableRow am angegebenen Zeilenindex ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignment|nullGibt die Textausrichtung zurück.
getType()ElementTypeRuft den ElementType des Elements ab.
insertTableRow(childIndex)TableRowErstellt und fügt ein neues TableRow am angegebenen Index ein.
insertTableRow(childIndex, tableRow)TableRowFügt das angegebene TableRow am angegebenen Index ein.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
removeChild(child)TableEntfernt das angegebene untergeordnete Element.
removeFromParent()Table|nullEntfernt das Element aus dem übergeordneten Element.
removeRow(rowIndex)TableRowEntfernt die TableRow am angegebenen Zeilenindex.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet.
setAttributes(attributes)TableLegt die Attribute des Elements fest.
setBorderColor(color)TableLegt die Rahmenfarbe fest.
setBorderWidth(width)TableLegt die Rahmenbreite in Punkten fest.
setColumnWidth(columnIndex, width)TableLegt die Breite der angegebenen Spalte in Punkten fest.
setLinkUrl(url)TableLegt die Link-URL fest.
setTextAlignment(textAlignment)TableLegt die Textausrichtung fest.

TableCell

Methoden

MethodeRückgabetypKurzbeschreibung
appendHorizontalRule()HorizontalRuleErstellt und hängt einen neuen HorizontalRule an.
appendImage(image)InlineImageErstellt ein neues InlineImage aus dem angegebenen Bild-Blob und hängt es an.
appendImage(image)InlineImageHängt die angegebene InlineImage an.
appendListItem(listItem)ListItemHängt die angegebene ListItem an.
appendListItem(text)ListItemErstellt und hängt einen neuen ListItem an.
appendParagraph(paragraph)ParagraphHängt die angegebene Paragraph an.
appendParagraph(text)ParagraphErstellt und hängt einen neuen Paragraph an.
appendTable()TableErstellt und hängt einen neuen Table an.
appendTable(cells)TableFügt ein neues Table mit den angegebenen Zellen an.
appendTable(table)TableHängt die angegebene Table an.
clear()TableCellLöscht den Inhalt des Elements.
copy()TableCellGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElement|nullDurchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs.
findElement(elementType, from)RangeElement|nullDurchsucht den Inhalt des Elements nach einem untergeordneten Element des angegebenen Typs, beginnend mit dem angegebenen RangeElement.
findText(searchPattern)RangeElement|nullSucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElement|nullDurchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster.
getAttributes()ObjectRuft die Attribute des Elements ab.
getBackgroundColor()String|nullRuft die Hintergrundfarbe ab.
getChild(childIndex)ElementRuft das untergeordnete Element am angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab.
getColSpan()IntegerRuft die Spaltenbreite ab, d. h. die Anzahl der Spalten von Tabellenzellen, die diese Zelle umfasst.
getLinkUrl()String|nullRuft die Link-URL ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getPaddingBottom()Number|nullRuft den unteren Abstand in Punkten ab.
getPaddingLeft()Number|nullRuft den linken Abstand in Punkten ab.
getPaddingRight()Number|nullRuft den rechten Abstand in Punkten ab.
getPaddingTop()Number|nullRuft den oberen Innenabstand in Punkten ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getParentRow()TableRow|nullRuft das TableRow ab, das das aktuelle TableCell enthält.
getParentTable()Table|nullRuft das Table ab, das das aktuelle TableCell enthält.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getRowSpan()IntegerRuft den Zeilenbereich ab, d. h. die Anzahl der Zeilen mit Tabellenzellen, die diese Zelle umfasst.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignment|nullGibt die Textausrichtung zurück.
getType()ElementTypeRuft den ElementType des Elements ab.
getVerticalAlignment()VerticalAlignment|nullRuft die VerticalAlignment ab.
getWidth()Number|nullRuft die Breite der Spalte mit der Zelle in Punkten ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt und fügt ein neues HorizontalRule am angegebenen Index ein.
insertImage(childIndex, image)InlineImageErstellt und fügt ein InlineImage aus dem angegebenen Bild-Blob am angegebenen Index ein.
insertImage(childIndex, image)InlineImageFügt das angegebene InlineImage am angegebenen Index ein.
insertListItem(childIndex, listItem)ListItemFügt das angegebene ListItem am angegebenen Index ein.
insertListItem(childIndex, text)ListItemErstellt und fügt ein neues ListItem am angegebenen Index ein.
insertParagraph(childIndex, paragraph)ParagraphFügt das angegebene Paragraph am angegebenen Index ein.
insertParagraph(childIndex, text)ParagraphErstellt und fügt ein neues Paragraph am angegebenen Index ein.
insertTable(childIndex)TableErstellt und fügt ein neues Table am angegebenen Index ein.
insertTable(childIndex, cells)TableErstellt und fügt ein neues Table mit den angegebenen Zellen am angegebenen Index ein.
insertTable(childIndex, table)TableFügt das angegebene Table am angegebenen Index ein.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
merge()TableCell|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeChild(child)TableCellEntfernt das angegebene untergeordnete Element.
removeFromParent()TableCell|nullEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet.
setAttributes(attributes)TableCellLegt die Attribute des Elements fest.
setBackgroundColor(color)TableCellLegt die Hintergrundfarbe fest.
setLinkUrl(url)TableCellLegt die Link-URL fest.
setPaddingBottom(paddingBottom)TableCellLegt den unteren Abstand in Punkten fest.
setPaddingLeft(paddingLeft)TableCellLegt den linken Abstand in Punkten fest.
setPaddingRight(paddingRight)TableCellLegt den rechten Abstand in Punkten fest.
setPaddingTop(paddingTop)TableCellLegt den oberen Abstand in Punkten fest.
setText(text)TableCellLegt den Inhalt als Nur-Text fest.
setTextAlignment(textAlignment)TableCellLegt die Textausrichtung fest.
setVerticalAlignment(alignment)TableCellLegt die vertikale Ausrichtung fest.
setWidth(width)TableCellLegt die Breite der Spalte mit der aktuellen Zelle in Punkten fest.

TableOfContents

Methoden

MethodeRückgabetypKurzbeschreibung
clear()TableOfContentsLöscht den Inhalt des Elements.
copy()TableOfContentsGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElement|nullDurchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs.
findElement(elementType, from)RangeElement|nullDurchsucht den Inhalt des Elements nach einem untergeordneten Element des angegebenen Typs, beginnend mit dem angegebenen RangeElement.
findText(searchPattern)RangeElement|nullSucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElement|nullDurchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element am angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab.
getLinkUrl()String|nullRuft die Link-URL ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignment|nullGibt die Textausrichtung zurück.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
removeFromParent()TableOfContents|nullEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet.
setAttributes(attributes)TableOfContentsLegt die Attribute des Elements fest.
setLinkUrl(url)TableOfContentsLegt die Link-URL fest.
setTextAlignment(textAlignment)TableOfContentsLegt die Textausrichtung fest.

TableRow

Methoden

MethodeRückgabetypKurzbeschreibung
appendTableCell()TableCellErstellt und hängt einen neuen TableCell an.
appendTableCell(textContents)TableCellHängt das angegebene TableCell mit dem angegebenen Text an.
appendTableCell(tableCell)TableCellHängt die angegebene TableCell an.
clear()TableRowLöscht den Inhalt des Elements.
copy()TableRowGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElement|nullDurchsucht den Inhalt des Elements nach einem Nachfolger des angegebenen Typs.
findElement(elementType, from)RangeElement|nullDurchsucht den Inhalt des Elements nach einem untergeordneten Element des angegebenen Typs, beginnend mit dem angegebenen RangeElement.
findText(searchPattern)RangeElement|nullSucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElement|nullDurchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster.
getAttributes()ObjectRuft die Attribute des Elements ab.
getCell(cellIndex)TableCell|nullRuft die TableCell am angegebenen Zellenindex ab.
getChild(childIndex)ElementRuft das untergeordnete Element am angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab.
getLinkUrl()String|nullRuft die Link-URL ab.
getMinimumHeight()Number|nullRuft die Mindesthöhe in Punkten ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getNumCells()IntegerRuft die Anzahl der Zellen in der Zeile ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getParentTable()Table|nullRuft die Table ab, die die aktuelle Zeile enthält.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignment|nullGibt die Textausrichtung zurück.
getType()ElementTypeRuft den ElementType des Elements ab.
insertTableCell(childIndex)TableCellErstellt und fügt ein neues TableCell am angegebenen Index ein.
insertTableCell(childIndex, textContents)TableCellFügt das angegebene TableCell mit dem angegebenen Text am angegebenen Index ein.
insertTableCell(childIndex, tableCell)TableCellFügt das angegebene TableCell am angegebenen Index ein.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
merge()TableRow|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeCell(cellIndex)TableCellEntfernt die TableCell am angegebenen Zellenindex.
removeChild(child)TableRowEntfernt das angegebene untergeordnete Element.
removeFromParent()TableRow|nullEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet.
setAttributes(attributes)TableRowLegt die Attribute des Elements fest.
setLinkUrl(url)TableRowLegt die Link-URL fest.
setMinimumHeight(minHeight)TableRowLegt die Mindesthöhe in Punkten fest.
setTextAlignment(textAlignment)TableRowLegt die Textausrichtung fest.

Text

Methoden

MethodeRückgabetypKurzbeschreibung
appendText(text)TextFügt den angegebenen Text am Ende dieser Textregion ein.
copy()TextGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
deleteText(startOffset, endOffsetInclusive)TextLöscht einen Textbereich.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findText(searchPattern)RangeElement|nullSucht im Inhalt des Elements mithilfe von regulären Ausdrücken nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElement|nullDurchsucht den Inhalt des Elements ab einem bestimmten Suchergebnis nach dem angegebenen Textmuster.
getAttributes()ObjectRuft die Attribute des Elements ab.
getAttributes(offset)ObjectRuft die Attribute am angegebenen Zeichen-Offset ab.
getBackgroundColor()String|nullRuft die Einstellung für die Hintergrundfarbe ab.
getBackgroundColor(offset)String|nullRuft die Hintergrundfarbe am angegebenen Zeichen-Offset ab.
getFontFamily()String|nullRuft die Einstellung für die Schriftfamilie ab.
getFontFamily(offset)String|nullRuft die Schriftfamilie am angegebenen Zeichen-Offset ab.
getFontSize()Number|nullRuft die Einstellung für die Schriftgröße ab.
getFontSize(offset)Number|nullRuft die Schriftgröße am angegebenen Zeichen-Offset ab.
getForegroundColor()String|nullRuft die Einstellung für die Vordergrundfarbe ab.
getForegroundColor(offset)String|nullRuft die Vordergrundfarbe am angegebenen Zeichen-Offset ab.
getLinkUrl()String|nullRuft die Link-URL ab.
getLinkUrl(offset)String|nullRuft die Link-URL am angegebenen Zeichen-Offset ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignment|nullGibt die Textausrichtung zurück.
getTextAlignment(offset)TextAlignment|nullRuft die Textausrichtung für ein einzelnes Zeichen ab.
getTextAttributeIndices()Integer[]Ruft die Gruppe von Textindizes ab, die dem Beginn der einzelnen Textformatierungsläufe entsprechen.
getType()ElementTypeRuft den ElementType des Elements ab.
insertText(offset, text)TextFügt den angegebenen Text am angegebenen Zeichen-Offset ein.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
isBold()Boolean|nullRuft die Einstellung für Fettdruck ab.
isBold(offset)Boolean|nullRuft die Einstellung für Fettdruck am angegebenen Zeichen-Offset ab.
isItalic()Boolean|nullRuft die Kursiveinstellung ab.
isItalic(offset)Boolean|nullRuft die Kursiveinstellung am angegebenen Zeichen-Offset ab.
isStrikethrough()Boolean|nullRuft die Einstellung für das Durchstreichen ab.
isStrikethrough(offset)Boolean|nullRuft die Einstellung für das Durchstreichen am angegebenen Zeichen-Offset ab.
isUnderline()Boolean|nullRuft die Unterstreichungseinstellung ab.
isUnderline(offset)Boolean|nullRuft die Unterstreichungseinstellung am angegebenen Zeichen-Offset ab.
merge()Text|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeFromParent()Text|nullEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring. Dabei werden reguläre Ausdrücke verwendet.
setAttributes(startOffset, endOffsetInclusive, attributes)TextWendet die angegebenen Attribute auf den angegebenen Zeichenbereich an.
setAttributes(attributes)TextLegt die Attribute des Elements fest.
setBackgroundColor(startOffset, endOffsetInclusive, color)TextLegt die Hintergrundfarbe für den angegebenen Zeichenbereich fest.
setBackgroundColor(color)TextLegt die Hintergrundfarbe fest.
setBold(bold)TextLegt die Einstellung für „Fett“ fest.
setBold(startOffset, endOffsetInclusive, bold)TextLegt die Einstellung für Fettdruck für den angegebenen Zeichenbereich fest.
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)TextLegt die Schriftfamilie für den angegebenen Zeichenbereich fest.
setFontFamily(fontFamilyName)TextLegt die Schriftfamilie fest.
setFontSize(startOffset, endOffsetInclusive, size)TextLegt die Schriftgröße für den angegebenen Zeichenbereich fest.
setFontSize(size)TextLegt die Schriftgröße fest.
setForegroundColor(startOffset, endOffsetInclusive, color)TextLegt die Vordergrundfarbe für den angegebenen Zeichenbereich fest.
setForegroundColor(color)TextLegt die Vordergrundfarbe fest.
setItalic(italic)TextLegt die Kursiveinstellung fest.
setItalic(startOffset, endOffsetInclusive, italic)TextLegt die Kursivformatierung für den angegebenen Zeichenbereich fest.
setLinkUrl(startOffset, endOffsetInclusive, url)TextLegt die Link-URL für den angegebenen Zeichenbereich fest.
setLinkUrl(url)TextLegt die Link-URL fest.
setStrikethrough(strikethrough)TextLegt die Einstellung für den durchgestrichenen Text fest.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)TextLegt die Einstellung für das Durchstreichen für den angegebenen Zeichenbereich fest.
setText(text)TextLegt den Textinhalt fest.
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)TextLegt die Textausrichtung für einen bestimmten Zeichenbereich fest.
setTextAlignment(textAlignment)TextLegt die Textausrichtung fest.
setUnderline(underline)TextLegt die Unterstreichungseinstellung fest.
setUnderline(startOffset, endOffsetInclusive, underline)TextLegt die Unterstreichungseinstellung für den angegebenen Zeichenbereich fest.

TextAlignment

Attribute

AttributTypBeschreibung
NORMALEnumDie normale Textausrichtung.
SUPERSCRIPTEnumDie Ausrichtung des hochgestellten Texts.
SUBSCRIPTEnumDie Ausrichtung des tiefgestellten Texts.

UnsupportedElement

Methoden

MethodeRückgabetypKurzbeschreibung
copy()UnsupportedElementGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
merge()UnsupportedElement|nullFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeFromParent()UnsupportedElement|nullEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)UnsupportedElementLegt die Attribute des Elements fest.

VerticalAlignment

Attribute

AttributTypBeschreibung
BOTTOMEnumDie Option zur Ausrichtung unten.
CENTEREnumDie Option für die zentrierte Ausrichtung.
TOPEnumDie Option für die Ausrichtung oben.