Document Service

Document

Mit diesem Dienst können Scripts 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');

Classes

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 einen erweiterten Text und Elemente wie Tabellen und Listen enthalten.
DocumentAppDer Dokumentdienst erstellt und öffnet Documents, die bearbeitet werden können.
DocumentTabEin Dokumenttab mit umfangreichem 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 einer 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ßnotenabschnitt darstellt.
GlyphTypeEine Aufzählung der unterstützten Schriftzeichentypen.
HeaderSectionEin Element, das einen Abschnitt mit einer Überschrift 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, die einen späteren Abruf ermöglichen.
PageBreakEin Element, das einen Seitenumbruch darstellt.
ParagraphEin Element, das einen Absatz darstellt.
ParagraphHeadingEine Aufzählung der Standardabsatzüberschriften.
PersonEin Element, das einen Link zu einer Person darstellt.
PositionEin Verweis auf eine Position im Dokumenttab, bezogen auf ein bestimmtes Element.
PositionedImageBild mit fester Position, das an einer Paragraph verankert ist.
PositionedLayoutEine Aufzählung, die angibt, wie ein PositionedImage im Verhältnis zum umgebenden Text dargestellt werden soll.
RangeEine Reihe von Elementen in einem Dokument.
RangeBuilderEin Builder, mit dem Range-Objekte aus Dokumentelementen erstellt werden.
RangeElementEin Element-Wrapper mit einem möglichen Start- und Endoffset.
RichLinkEin Element, das einen Link zu einer Google-Ressource darstellt, z. B. zu einer Drive-Datei oder einem YouTube-Video.
TabEin Tab in einem Google Docs-Dokument.
TabTypeEine Aufzählung aller Tabtypen.
TableEin Element, das eine Tabelle darstellt.
TableCellEin Element, das eine Tabellenzelle darstellt.
TableOfContentsEin Element mit einem Inhaltsverzeichnis.
TableRowEin Element, das eine Tabellenzeile darstellt.
TextEin Element, das einen Rich-Text-Bereich darstellt.
TextAlignmentEine Aufzählung der Textausrichtungstypen.
UnsupportedElementEin Element, das eine Region darstellt, die unbekannt ist oder nicht von einem Script 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 Schriftstärke für Rich-Text.
BORDER_COLOREnumDie Rahmenfarbe für Tabellenelemente.
BORDER_WIDTHEnumDie Rahmenbreite in Punkten für Tabellenelemente.
CODEEnumDer Codeinhalt für Gleichungselemente.
FONT_FAMILYEnumDie Einstellung für die Schriftfamilie für Rich Text.
FONT_SIZEEnumDie Schriftgröße in Punkten für Rich-Text.
FOREGROUND_COLOREnumDie Einstellung für die Vordergrundfarbe für Rich Text.
HEADINGEnumDer Überschriftentyp für Absatzelemente (z. B. DocumentApp.ParagraphHeading.HEADING1).
HEIGHTEnumDie Höhe für Bildelemente.
HORIZONTAL_ALIGNMENTEnumDie horizontale Ausrichtung für Absatzelemente (z. B. DocumentApp.HorizontalAlignment.CENTER).
INDENT_ENDEnumDie Einstellung für den Endabstand 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 Anfangseinzug in Punkten für Absatzelemente.
ITALICEnumDie Schriftstileinstellung für Rich-Text.
GLYPH_TYPEEnumDer Schriftbildtyp für Listenelemente.
LEFT_TO_RIGHTEnumDie 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 übergeordneten 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 Artikels für Listenelemente.
MINIMUM_HEIGHTEnumDie minimale Höhe in Punkten für Tabellenzeilenelemente.
PADDING_BOTTOMEnumDie Einstellung für den unteren Abstand in Punkten für Tabellenzellenelemente.
PADDING_LEFTEnumDer linke Abstand in Punkten für Tabellenzellenelemente.
PADDING_RIGHTEnumDie Einstellung für den rechten Abstand in Punkten für Tabellenzellenelemente.
PADDING_TOPEnumDie Einstellung für den oberen Abstand in Punkten für Tabellenzellenelemente.
PAGE_HEIGHTEnumDie Seitenhöhe in Punkten für Dokumente.
PAGE_WIDTHEnumDie Seitenbreite in Punkten für Dokumente.
SPACING_AFTEREnumDer Abstand nach unten in Punkten für Absatzelemente.
SPACING_BEFOREEnumDie Einstellung für den oberen Abstand in Punkten für Absatzelemente.
STRIKETHROUGHEnumDie Einstellung „Durchgestrichen“, für Rich-Text
UNDERLINEEnumDie Unterstreichungseinstellung für Rich Text.
VERTICAL_ALIGNMENTEnumDie Einstellung für die vertikale Ausrichtung von Tabellenzellenelementen.
WIDTHEnumDie Breite für Tabellenzellen und Bildelemente.

Body

Methoden

MethodeRückgabetypKurzbeschreibung
appendHorizontalRule()HorizontalRuleErstellt und hängt einen neuen HorizontalRule an.
appendImage(image)InlineImageErstellt und hängt ein neues InlineImage aus dem angegebenen Bild-Blob an.
appendImage(image)InlineImageHängt die angegebene InlineImage an.
appendListItem(listItem)ListItemHängt die angegebene ListItem an.
appendListItem(text)ListItemErstellt und hängt eine neue ListItem mit dem angegebenen Textinhalt 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 und hängt eine neue Paragraph mit dem angegebenen Textinhalt an.
appendTable()TableErstellt und hängt einen neuen Table an.
appendTable(cells)TableHängt für jeden angegebenen Stringwert eine neue Table mit einer TableCell an.
appendTable(table)TableHängt die angegebene Table an.
clear()BodyDer Inhalt des Elements wird gelöscht.
copy()BodyGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht.
findElement(elementType, from)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen RangeElement.
findText(searchPattern)RangeElementEs wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.
findText(searchPattern, from)RangeElementEs wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.
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 Attribute für die angegebene ParagraphHeading ab.
getImages()InlineImage[]Hiermit werden alle InlineImages im Abschnitt abgerufen.
getListItems()ListItem[]Hiermit werden alle ListItems im Abschnitt abgerufen.
getMarginBottom()NumberRuft den unteren Rand in Punkten ab.
getMarginLeft()NumberRuft den linken Rand in Punkten ab.
getMarginRight()NumberRuft den rechten Rand ab.
getMarginTop()NumberRuft den oberen Rand ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getPageHeight()NumberLiefert die Seitenhöhe in Punkten.
getPageWidth()NumberRuft die Seitenbreite in Punkten ab.
getParagraphs()Paragraph[]Hiermit werden alle Paragraphs im Abschnitt abgerufen, einschließlich ListItems.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getTables()Table[]Hiermit werden alle Tables im Abschnitt abgerufen.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentDie Textausrichtung wird abgerufen.
getType()ElementTypeRuft den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt und fügt eine neue HorizontalRule an der angegebenen Position ein.
insertImage(childIndex, image)InlineImageErstellt und fügt eine InlineImage aus dem angegebenen Bild-Blob an der angegebenen Position ein.
insertImage(childIndex, image)InlineImageFügt das angegebene InlineImage an der angegebenen Position ein.
insertListItem(childIndex, listItem)ListItemFügt das angegebene ListItem an der angegebenen Position ein.
insertListItem(childIndex, text)ListItemErstellt und fügt am angegebenen Index eine neue ListItem mit dem angegebenen Textinhalt ein.
insertPageBreak(childIndex)PageBreakErstellt und fügt eine neue PageBreak an der angegebenen Position ein.
insertPageBreak(childIndex, pageBreak)PageBreakFügt das angegebene PageBreak an der angegebenen Position ein.
insertParagraph(childIndex, paragraph)ParagraphFügt das angegebene Paragraph an der angegebenen Position ein.
insertParagraph(childIndex, text)ParagraphErstellt und fügt am angegebenen Index eine neue Paragraph mit dem angegebenen Textinhalt ein.
insertTable(childIndex)TableErstellt und fügt eine neue Table an der angegebenen Position ein.
insertTable(childIndex, cells)TableErstellt und fügt eine neue Table mit den angegebenen Zellen an der angegebenen Position ein.
insertTable(childIndex, table)TableFügt das angegebene Table an der angegebenen Position ein.
removeChild(child)BodyEntfernt das angegebene untergeordnete Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken.
setAttributes(attributes)BodyHiermit werden die Attribute des Elements festgelegt.
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)BodyDer Inhalt wird als Nur-Text festgelegt.
setTextAlignment(textAlignment)BodyHiermit wird die Textausrichtung festgelegt.

Bookmark

Methoden

MethodeRückgabetypKurzbeschreibung
getId()StringRuft die ID der Bookmark ab.
getPosition()PositionRuft die Position der Bookmark innerhalb der 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()ContainerElementDer Inhalt des Elements wird gelöscht.
copy()ContainerElementGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht.
findElement(elementType, from)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen RangeElement.
findText(searchPattern)RangeElementEs wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.
findText(searchPattern, from)RangeElementEs wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.
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()StringRuft die Link-URL ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentDie Textausrichtung wird abgerufen.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
merge()ContainerElementDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeFromParent()ContainerElementEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken.
setAttributes(attributes)ContainerElementHiermit werden die Attribute des Elements festgelegt.
setLinkUrl(url)ContainerElementLegt die Link-URL fest.
setTextAlignment(textAlignment)ContainerElementHiermit wird die Textausrichtung festgelegt.

Date

Methoden

MethodeRückgabetypKurzbeschreibung
copy()DateGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getDisplayText()StringGibt den Anzeigewert zurück, der im Dokument gerendert wird.
getLocale()StringGibt das Gebietsschema des Datums zurück, das für den Anzeigewert verwendet wird.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getTimestamp()DateGibt den Zeitstempel zurück, der mit dem Datum verknüpft ist.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
merge()DateDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeFromParent()DateEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)DateHiermit werden die Attribute des Elements festgelegt.

Document

Methoden

MethodeRückgabetypKurzbeschreibung
addBookmark(position)BookmarkFügen Sie dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, dem aktiven Tab eine Bookmark an der angegebenen Position hinzu.
addEditor(emailAddress)DocumentDer angegebene Nutzer wird der Liste der Mitbearbeiter für die Document hinzugefügt.
addEditor(user)DocumentDer angegebene Nutzer wird der Liste der Mitbearbeiter für die Document hinzugefügt.
addEditors(emailAddresses)DocumentFügt der Liste der Mitbearbeiter für die Document das angegebene Nutzerarray hinzu.
addFooter()FooterSectionFügen Sie dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, dem aktiven Tab einen Fußzeilenbereich hinzu, falls noch keiner vorhanden ist.
addHeader()HeaderSectionFügen Sie dem ersten Tab einen Headerabschnitt hinzu, falls noch keiner vorhanden ist, oder dem aktiven Tab, wenn das Script an ein Dokument gebunden ist.
addNamedRange(name, range)NamedRangeFügen Sie auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab ein NamedRange hinzu. Das ist ein Range mit einem Namen und einer ID, die für die spätere Abrufung verwendet werden.
addViewer(emailAddress)DocumentDer angegebene Nutzer wird der Liste der Zuschauer für die Document hinzugefügt.
addViewer(user)DocumentDer angegebene Nutzer wird der Liste der Zuschauer für die Document hinzugefügt.
addViewers(emailAddresses)DocumentFügen Sie der Liste der Zuschauer für die Document das angegebene Array von Nutzern hinzu.
getActiveTab()TabRuft die aktuell aktive Tab des Nutzers im Dokument ab.
getAs(contentType)BlobRuft den aktuellen Document-Inhalt als Blob des angegebenen Typs ab.
getBlob()BlobRuft den aktuellen Document-Inhalt 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)BookmarkRuft das Bookmark mit der angegebenen ID auf dem ersten Tab ab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab.
getBookmarks()Bookmark[]Hiermit werden alle Bookmark-Objekte auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab abgerufen.
getCursor()PositionRuft den Cursor des Nutzers auf dem aktiven Tab ab.
getEditors()User[]Ruft die Liste der Mitbearbeiter für diese Document ab.
getFooter()FooterSectionRuft den Abschnitt „Fußzeile“ des ersten Tabs ab oder, bei Scripts, die an ein Dokument gebunden sind, den Abschnitt „Fußzeile“ des aktiven Tabs.
getFootnotes()Footnote[]Ruft alle Footnote-Elemente im Body des ersten Tabs oder, bei Scripts, die an ein Dokument gebunden sind, den Body des aktiven Tabs ab.
getHeader()HeaderSectionRuft den Kopfbereich des ersten Tabs ab oder, bei Scripts, die an ein Dokument gebunden sind, den Kopfbereich des aktiven Tabs.
getId()StringRuft die eindeutige Kennung des Dokuments ab.
getLanguage()StringRuft den Sprachcode des Dokuments ab.
getName()StringRuft den Titel des Dokuments ab.
getNamedRangeById(id)NamedRangeRuft das NamedRange mit der angegebenen ID auf dem ersten Tab ab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab.
getNamedRanges()NamedRange[]Hiermit werden alle NamedRange-Objekte auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab abgerufen.
getNamedRanges(name)NamedRange[]Hiermit werden alle NamedRange-Objekte mit dem angegebenen Namen auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab abgerufen.
getSelection()RangeRuft die Auswahl des Nutzers auf dem aktiven Tab ab.
getSupportedLanguageCodes()String[]Alle Sprachcodes abrufen, die in Google Docs-Dateien unterstützt werden
getTab(tabId)TabRuft den Tab mit der angegebenen ID ab.
getTabs()Tab[]Alle nicht verschachtelten Tabs abrufen, 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 einen Verweis auf eine Position auf dem Tab relativ zu einem bestimmten Element auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf den aktiven Tab darstellt.
newRange()RangeBuilderErstellt einen Builder, mit dem Range-Objekte aus Tabelementen auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab erstellt werden.
removeEditor(emailAddress)DocumentDer angegebene Nutzer wird aus der Liste der Mitbearbeiter der Document entfernt.
removeEditor(user)DocumentDer angegebene Nutzer wird aus der Liste der Mitbearbeiter der Document entfernt.
removeViewer(emailAddress)DocumentDer angegebene Nutzer wird aus der Liste der Zuschauer und Kommentatoren für die Document entfernt.
removeViewer(user)DocumentDer angegebene Nutzer wird aus der Liste der Zuschauer und Kommentatoren für die Document entfernt.
saveAndClose()voidSpeichert die aktuelle Document.
setActiveTab(tabId)voidStellt die ausgewählte Tab des Nutzers im aktuellen Dokument auf den Tab mit der angegebenen ID.
setCursor(position)DocumentLegt den Cursor des Nutzers anhand einer Position fest.
setLanguage(languageCode)DocumentLegt den Sprachcode des Dokuments fest.
setName(name)DocumentHiermit wird der Dokumenttitel festgelegt.
setSelection(range)DocumentLegt die Auswahl des Nutzers auf dem Tab „Aktiv“ fest, wenn 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 Script containergebunden ist.
getUi()UiGibt eine Instanz der Benutzeroberfläche des Dokuments zurück, mit der dem Script 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 an der angegebenen Position ein Bookmark hinzu.
addFooter()FooterSectionFügen Sie einen Tab-Fußbereich hinzu, falls noch keiner vorhanden ist.
addHeader()HeaderSectionFügen Sie einen Tab-Header hinzu, falls noch keiner vorhanden ist.
addNamedRange(name, range)NamedRangeHier wird eine NamedRange hinzugefügt. Das ist eine Range mit einem Namen und einer ID, die für den späteren Abruf verwendet werden.
getBody()BodyRuft die Body des Tabs ab.
getBookmark(id)BookmarkRuft den Bookmark mit der angegebenen ID ab.
getBookmarks()Bookmark[]Ruft alle Bookmark-Objekte auf dem Tab ab.
getFooter()FooterSectionRuft den Fußbereich des Tabs ab, falls vorhanden.
getFootnotes()Footnote[]Ruft alle Footnote-Elemente im Tab-Text ab.
getHeader()HeaderSectionRuft den Kopfbereich des Tabs ab, falls vorhanden.
getNamedRangeById(id)NamedRangeRuft den 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 eine neue Position, die einen Verweis auf eine Position auf dem Tab relativ zu einem bestimmten Element darstellt.
newRange()RangeBuilderErstellt einen Builder, mit dem Range-Objekte aus Tabelementen 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 Tabellen-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 losgelöste, tiefe Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
merge()ElementDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeFromParent()ElementEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)ElementHiermit werden die Attribute des Elements festgelegt.

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()EquationDer Inhalt des Elements wird gelöscht.
copy()EquationGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht.
findElement(elementType, from)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen RangeElement.
findText(searchPattern)RangeElementEs wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.
findText(searchPattern, from)RangeElementEs wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.
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()StringRuft die Link-URL ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentDie Textausrichtung wird abgerufen.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
merge()EquationDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeFromParent()EquationEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken.
setAttributes(attributes)EquationHiermit werden die Attribute des Elements festgelegt.
setLinkUrl(url)EquationLegt die Link-URL fest.
setTextAlignment(textAlignment)EquationHiermit wird die Textausrichtung festgelegt.

EquationFunction

Methoden

MethodeRückgabetypKurzbeschreibung
clear()EquationFunctionDer Inhalt des Elements wird gelöscht.
copy()EquationFunctionGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht.
findElement(elementType, from)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen RangeElement.
findText(searchPattern)RangeElementEs wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.
findText(searchPattern, from)RangeElementEs wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.
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()StringRuft die Link-URL ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentDie Textausrichtung wird abgerufen.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
merge()EquationFunctionDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeFromParent()EquationFunctionEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken.
setAttributes(attributes)EquationFunctionHiermit werden die Attribute des Elements festgelegt.
setLinkUrl(url)EquationFunctionLegt die Link-URL fest.
setTextAlignment(textAlignment)EquationFunctionHiermit wird die Textausrichtung festgelegt.

EquationFunctionArgumentSeparator

Methoden

MethodeRückgabetypKurzbeschreibung
copy()EquationFunctionArgumentSeparatorGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
merge()EquationFunctionArgumentSeparatorDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeFromParent()EquationFunctionArgumentSeparatorEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)EquationFunctionArgumentSeparatorHiermit werden die Attribute des Elements festgelegt.

EquationSymbol

Methoden

MethodeRückgabetypKurzbeschreibung
copy()EquationSymbolGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getCode()StringRuft den Code ab, der dem Gleichungssymbol entspricht.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
merge()EquationSymbolDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeFromParent()EquationSymbolEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)EquationSymbolHiermit werden die Attribute des Elements festgelegt.

FontFamily

FooterSection

Methoden

MethodeRückgabetypKurzbeschreibung
appendHorizontalRule()HorizontalRuleErstellt und hängt einen neuen HorizontalRule an.
appendImage(image)InlineImageErstellt und hängt ein neues InlineImage aus dem angegebenen Bild-Blob an.
appendImage(image)InlineImageHängt die angegebene InlineImage an.
appendListItem(listItem)ListItemHängt die angegebene ListItem an.
appendListItem(text)ListItemErstellt und hängt eine neue ListItem mit dem angegebenen Textinhalt an.
appendParagraph(paragraph)ParagraphHängt die angegebene Paragraph an.
appendParagraph(text)ParagraphErstellt und hängt eine neue Paragraph mit dem angegebenen Textinhalt an.
appendTable()TableErstellt und hängt einen neuen Table an.
appendTable(cells)TableHängt für jeden angegebenen Stringwert eine neue Table mit einer TableCell an.
appendTable(table)TableHängt die angegebene Table an.
clear()FooterSectionDer Inhalt des Elements wird gelöscht.
copy()FooterSectionGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht.
findElement(elementType, from)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen RangeElement.
findText(searchPattern)RangeElementEs wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.
findText(searchPattern, from)RangeElementEs wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.
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[]Hiermit werden alle InlineImages im Abschnitt abgerufen.
getListItems()ListItem[]Hiermit werden alle ListItems im Abschnitt abgerufen.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParagraphs()Paragraph[]Hiermit werden alle Paragraphs im Abschnitt abgerufen, einschließlich ListItems.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getTables()Table[]Hiermit werden alle Tables im Abschnitt abgerufen.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentDie Textausrichtung wird abgerufen.
getType()ElementTypeRuft den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt und fügt eine neue HorizontalRule an der angegebenen Position ein.
insertImage(childIndex, image)InlineImageErstellt und fügt eine InlineImage aus dem angegebenen Bild-Blob an der angegebenen Position ein.
insertImage(childIndex, image)InlineImageFügt das angegebene InlineImage an der angegebenen Position ein.
insertListItem(childIndex, listItem)ListItemFügt das angegebene ListItem an der angegebenen Position ein.
insertListItem(childIndex, text)ListItemErstellt und fügt am angegebenen Index eine neue ListItem mit dem angegebenen Textinhalt ein.
insertParagraph(childIndex, paragraph)ParagraphFügt das angegebene Paragraph an der angegebenen Position ein.
insertParagraph(childIndex, text)ParagraphErstellt und fügt am angegebenen Index eine neue Paragraph mit dem angegebenen Textinhalt ein.
insertTable(childIndex)TableErstellt und fügt eine neue Table an der angegebenen Position ein.
insertTable(childIndex, cells)TableErstellt und fügt eine neue Table mit den angegebenen Zellen an der angegebenen Position ein.
insertTable(childIndex, table)TableFügt das angegebene Table an der angegebenen Position ein.
removeChild(child)FooterSectionEntfernt das angegebene untergeordnete Element.
removeFromParent()FooterSectionEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken.
setAttributes(attributes)FooterSectionHiermit werden die Attribute des Elements festgelegt.
setText(text)FooterSectionDer Inhalt wird als Nur-Text festgelegt.
setTextAlignment(textAlignment)FooterSectionHiermit wird die Textausrichtung festgelegt.

Footnote

Methoden

MethodeRückgabetypKurzbeschreibung
copy()FootnoteGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getFootnoteContents()FootnoteSectionRuft den Inhalt des Fußnotenelements ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
removeFromParent()FootnoteEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)FootnoteHiermit werden die Attribute des Elements festgelegt.

FootnoteSection

Methoden

MethodeRückgabetypKurzbeschreibung
appendParagraph(paragraph)ParagraphHängt die angegebene Paragraph an.
appendParagraph(text)ParagraphErstellt und hängt eine neue Paragraph mit dem angegebenen Textinhalt an.
clear()FootnoteSectionDer Inhalt des Elements wird gelöscht.
copy()FootnoteSectionGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht.
findElement(elementType, from)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen RangeElement.
findText(searchPattern)RangeElementEs wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.
findText(searchPattern, from)RangeElementEs wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.
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()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParagraphs()Paragraph[]Hiermit werden alle Paragraphs im Abschnitt abgerufen, einschließlich ListItems.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentDie Textausrichtung wird abgerufen.
getType()ElementTypeRuft den ElementType des Elements ab.
insertParagraph(childIndex, paragraph)ParagraphFügt das angegebene Paragraph an der angegebenen Position ein.
insertParagraph(childIndex, text)ParagraphErstellt und fügt am angegebenen Index eine neue Paragraph mit dem angegebenen Textinhalt ein.
removeChild(child)FootnoteSectionEntfernt das angegebene untergeordnete Element.
removeFromParent()FootnoteSectionEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken.
setAttributes(attributes)FootnoteSectionHiermit werden die Attribute des Elements festgelegt.
setText(text)FootnoteSectionDer Inhalt wird als Nur-Text festgelegt.
setTextAlignment(textAlignment)FootnoteSectionHiermit wird die Textausrichtung festgelegt.

GlyphType

Attribute

AttributTypBeschreibung
BULLETEnumDie Standard-Aufzählungszeichen, kreisförmig und ausgefüllt.
HOLLOW_BULLETEnumEine hohle Kugel.
SQUARE_BULLETEnumEin quadratisches Aufzählungszeichen.
NUMBEREnumEine nummerierte Aufzählung.
LATIN_UPPEREnumEin lateinischer Aufzählungspunkt in Großbuchstaben.
LATIN_LOWEREnumEin lateinischer Aufzählungspunkt in Kleinbuchstaben.
ROMAN_UPPEREnumEine römische Ziffer, Großbuchstabe.
ROMAN_LOWEREnumEine römische Ziffer, Kleinbuchstabe.

HeaderSection

Methoden

MethodeRückgabetypKurzbeschreibung
appendHorizontalRule()HorizontalRuleErstellt und hängt einen neuen HorizontalRule an.
appendImage(image)InlineImageErstellt und hängt ein neues InlineImage aus dem angegebenen Bild-Blob an.
appendImage(image)InlineImageHängt die angegebene InlineImage an.
appendListItem(listItem)ListItemHängt die angegebene ListItem an.
appendListItem(text)ListItemErstellt und hängt eine neue ListItem mit dem angegebenen Textinhalt an.
appendParagraph(paragraph)ParagraphHängt die angegebene Paragraph an.
appendParagraph(text)ParagraphErstellt und hängt eine neue Paragraph mit dem angegebenen Textinhalt an.
appendTable()TableErstellt und hängt einen neuen Table an.
appendTable(cells)TableHängt für jeden angegebenen Stringwert eine neue Table mit einer TableCell an.
appendTable(table)TableHängt die angegebene Table an.
clear()HeaderSectionDer Inhalt des Elements wird gelöscht.
copy()HeaderSectionGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht.
findElement(elementType, from)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen RangeElement.
findText(searchPattern)RangeElementEs wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.
findText(searchPattern, from)RangeElementEs wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.
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[]Hiermit werden alle InlineImages im Abschnitt abgerufen.
getListItems()ListItem[]Hiermit werden alle ListItems im Abschnitt abgerufen.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParagraphs()Paragraph[]Hiermit werden alle Paragraphs im Abschnitt abgerufen, einschließlich ListItems.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getTables()Table[]Hiermit werden alle Tables im Abschnitt abgerufen.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentDie Textausrichtung wird abgerufen.
getType()ElementTypeRuft den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt und fügt eine neue HorizontalRule an der angegebenen Position ein.
insertImage(childIndex, image)InlineImageErstellt und fügt eine InlineImage aus dem angegebenen Bild-Blob an der angegebenen Position ein.
insertImage(childIndex, image)InlineImageFügt das angegebene InlineImage an der angegebenen Position ein.
insertListItem(childIndex, listItem)ListItemFügt das angegebene ListItem an der angegebenen Position ein.
insertListItem(childIndex, text)ListItemErstellt und fügt am angegebenen Index eine neue ListItem mit dem angegebenen Textinhalt ein.
insertParagraph(childIndex, paragraph)ParagraphFügt das angegebene Paragraph an der angegebenen Position ein.
insertParagraph(childIndex, text)ParagraphErstellt und fügt am angegebenen Index eine neue Paragraph mit dem angegebenen Textinhalt ein.
insertTable(childIndex)TableErstellt und fügt eine neue Table an der angegebenen Position ein.
insertTable(childIndex, cells)TableErstellt und fügt eine neue Table mit den angegebenen Zellen an der angegebenen Position ein.
insertTable(childIndex, table)TableFügt das angegebene Table an der angegebenen Position ein.
removeChild(child)HeaderSectionEntfernt das angegebene untergeordnete Element.
removeFromParent()HeaderSectionEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken.
setAttributes(attributes)HeaderSectionHiermit werden die Attribute des Elements festgelegt.
setText(text)HeaderSectionDer Inhalt wird als Nur-Text festgelegt.
setTextAlignment(textAlignment)HeaderSectionHiermit wird die Textausrichtung festgelegt.

HorizontalAlignment

Attribute

AttributTypBeschreibung
LEFTEnumDie Option „Linksbündig“
CENTEREnumDie Option „Zentriert ausrichten“.
RIGHTEnumDie Option für die Ausrichtung nach rechts.
JUSTIFYEnumDie Option „justify“ (ausrichten).

HorizontalRule

Methoden

MethodeRückgabetypKurzbeschreibung
copy()HorizontalRuleGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
removeFromParent()HorizontalRuleEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)HorizontalRuleHiermit werden die Attribute des Elements festgelegt.

InlineDrawing

Methoden

MethodeRückgabetypKurzbeschreibung
copy()InlineDrawingGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
getAltDescription()StringGibt die alternative Beschreibung der Zeichnung zurück.
getAltTitle()StringGibt den alternativen Titel der Zeichnung zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
merge()InlineDrawingDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeFromParent()InlineDrawingEntfernt das Element aus dem übergeordneten Element.
setAltDescription(description)InlineDrawingHier legen Sie die alternative Beschreibung der Zeichnung fest.
setAltTitle(title)InlineDrawingLegt den alternativen Titel der Zeichnung fest.
setAttributes(attributes)InlineDrawingHiermit werden die Attribute des Elements festgelegt.

InlineImage

Methoden

MethodeRückgabetypKurzbeschreibung
copy()InlineImageGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
getAltDescription()StringDie alternative Beschreibung des Bilds.
getAltTitle()StringGibt den alternativen Titel des Bildes zurück.
getAs(contentType)BlobGibt die Daten in diesem Objekt als Blob zurück, der 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()IntegerDie Höhe des Bildes in Pixeln.
getLinkUrl()StringRuft die Link-URL ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
getWidth()IntegerDie Breite des Bilds in Pixeln.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
merge()InlineImageDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeFromParent()InlineImageEntfernt das Element aus dem übergeordneten Element.
setAltDescription(description)InlineImageHier legen Sie die alternative Beschreibung des Bildes fest.
setAltTitle(title)InlineImageLegt den alternativen Titel des Bildes fest.
setAttributes(attributes)InlineImageHiermit werden die Attribute des Elements festgelegt.
setHeight(height)InlineImageHiermit wird die Höhe des Bildes in Pixeln festgelegt.
setLinkUrl(url)InlineImageLegt die URL des Links fest.
setWidth(width)InlineImageHiermit wird die Breite des Bilds in Pixeln festgelegt.

ListItem

Methoden

MethodeRückgabetypKurzbeschreibung
addPositionedImage(image)PositionedImageErstellt und fügt ein neues PositionedImage aus dem angegebenen Bild-Blob ein.
appendHorizontalRule()HorizontalRuleErstellt und hängt einen neuen HorizontalRule an.
appendInlineImage(image)InlineImageErstellt und hängt ein neues InlineImage aus dem angegebenen Bild-Blob 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()ListItemDer Inhalt des Elements wird gelöscht.
copy()ListItemGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht.
findElement(elementType, from)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen RangeElement.
findText(searchPattern)RangeElementEs wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.
findText(searchPattern, from)RangeElementEs wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.
getAlignment()HorizontalAlignmentRuft 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()GlyphTypeRuft die GlyphType des Listenelements ab.
getHeading()ParagraphHeadingRuft die ParagraphHeading ab.
getIndentEnd()NumberRuft die Einzug am Ende in Punkten ab.
getIndentFirstLine()NumberRuft den Einzug der ersten Zeile in Punkten ab.
getIndentStart()NumberRuft den Anfangseinzug ab.
getLineSpacing()NumberRuft den Zeilenabstand in Punkten ab.
getLinkUrl()StringRuft die Link-URL ab.
getListId()StringRuft die Listen-ID ab.
getNestingLevel()IntegerRuft die Verschachtelungsebene des Listenelements ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPositionedImage(id)PositionedImageRuft einen PositionedImage anhand der ID des Bildes ab.
getPositionedImages()PositionedImage[]Ruft alle PositionedImage-Objekte ab, die am Absatz verankert sind.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getSpacingAfter()NumberDer Abstand nach dem Element in Punkten.
getSpacingBefore()NumberRuft den Abstand vor dem Element in Punkten ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentDie Textausrichtung wird abgerufen.
getType()ElementTypeRuft den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt und fügt eine HorizontalRule an der angegebenen Position ein.
insertInlineImage(childIndex, image)InlineImageErstellt und fügt eine neue InlineImage aus dem angegebenen Bild-Blob an der angegebenen Indexposition ein.
insertInlineImage(childIndex, image)InlineImageFügt das angegebene InlineImage an der angegebenen Position ein.
insertPageBreak(childIndex)PageBreakErstellt und fügt eine neue PageBreak an der angegebenen Position ein.
insertPageBreak(childIndex, pageBreak)PageBreakFügt das angegebene PageBreak an der angegebenen Position ein.
insertText(childIndex, text)TextErstellt ein neues Textelement und fügt es an der angegebenen Position ein.
insertText(childIndex, text)TextFügt das angegebene Text-Element mit dem angegebenen Textinhalt am angegebenen Index ein.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
isLeftToRight()BooleanRuft die Einstellung für die linksläufige Schreibrichtung ab.
merge()ListItemDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeChild(child)ListItemEntfernt das angegebene untergeordnete Element.
removeFromParent()ListItemEntfernt das Element aus dem übergeordneten Element.
removePositionedImage(id)BooleanEntfernt eine PositionedImage anhand der ID des Bilds.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken.
setAlignment(alignment)ListItemLegt HorizontalAlignment fest.
setAttributes(attributes)ListItemHiermit werden die Attribute des Elements festgelegt.
setGlyphType(glyphType)ListItemLegt den 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)ListItemHier wird die Einstellung „Linksläufig“ festgelegt.
setLineSpacing(multiplier)ListItemHiermit wird der Zeilenabstand festgelegt. Dabei wird die Anzahl der Zeilen angegeben, die für den Abstand verwendet werden sollen.
setLinkUrl(url)ListItemLegt die Link-URL fest.
setListId(listItem)ListItemLegt die Listen-ID fest.
setNestingLevel(nestingLevel)ListItemHiermit wird die Verschachtelungsebene des Listenelements festgelegt.
setSpacingAfter(spacingAfter)ListItemLegt den Abstand nach dem Element in Punkten fest.
setSpacingBefore(spacingBefore)ListItemLegt den Abstand vor dem Element in Punkten fest.
setText(text)voidHiermit wird der Inhalt des Listenelements als Text festgelegt.
setTextAlignment(textAlignment)ListItemHiermit wird die Textausrichtung festgelegt.

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 dieser NamedRange verknüpft sind.
remove()voidDadurch wird das NamedRange vom Tab entfernt.

PageBreak

Methoden

MethodeRückgabetypKurzbeschreibung
copy()PageBreakGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
removeFromParent()PageBreakEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)PageBreakHiermit werden die Attribute des Elements festgelegt.

Paragraph

Methoden

MethodeRückgabetypKurzbeschreibung
addPositionedImage(image)PositionedImageErstellt und fügt ein neues PositionedImage aus dem angegebenen Bild-Blob ein.
appendHorizontalRule()HorizontalRuleErstellt und hängt einen neuen HorizontalRule an.
appendInlineImage(image)InlineImageErstellt und hängt ein neues InlineImage aus dem angegebenen Bild-Blob 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()ParagraphDer Inhalt des Elements wird gelöscht.
copy()ParagraphGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht.
findElement(elementType, from)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen RangeElement.
findText(searchPattern)RangeElementEs wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.
findText(searchPattern, from)RangeElementEs wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.
getAlignment()HorizontalAlignmentRuft 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()ParagraphHeadingRuft die ParagraphHeading ab.
getIndentEnd()NumberRuft die Einzug am Ende in Punkten ab.
getIndentFirstLine()NumberRuft den Einzug der ersten Zeile in Punkten ab.
getIndentStart()NumberRuft den Anfangseinzug ab.
getLineSpacing()NumberRuft den Zeilenabstand in Punkten ab.
getLinkUrl()StringRuft die Link-URL ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPositionedImage(id)PositionedImageRuft einen PositionedImage anhand der ID des Bildes ab.
getPositionedImages()PositionedImage[]Ruft alle PositionedImage-Objekte ab, die am Absatz verankert sind.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getSpacingAfter()NumberDer Abstand nach dem Element in Punkten.
getSpacingBefore()NumberRuft den Abstand vor dem Element in Punkten ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentDie Textausrichtung wird abgerufen.
getType()ElementTypeRuft den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt und fügt eine HorizontalRule an der angegebenen Position ein.
insertInlineImage(childIndex, image)InlineImageErstellt und fügt eine neue InlineImage aus dem angegebenen Bild-Blob an der angegebenen Indexposition ein.
insertInlineImage(childIndex, image)InlineImageFügt das angegebene InlineImage an der angegebenen Position ein.
insertPageBreak(childIndex)PageBreakErstellt und fügt eine neue PageBreak an der angegebenen Position ein.
insertPageBreak(childIndex, pageBreak)PageBreakFügt das angegebene PageBreak an der angegebenen Position ein.
insertText(childIndex, text)TextErstellt ein neues Textelement und fügt es an der angegebenen Position ein.
insertText(childIndex, text)TextFügt das angegebene Text-Element mit dem angegebenen Textinhalt am angegebenen Index ein.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
isLeftToRight()BooleanRuft die Einstellung für die linksläufige Schreibrichtung ab.
merge()ParagraphDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeChild(child)ParagraphEntfernt das angegebene untergeordnete Element.
removeFromParent()ParagraphEntfernt das Element aus dem übergeordneten Element.
removePositionedImage(id)BooleanEntfernt eine PositionedImage anhand der ID des Bilds.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken.
setAlignment(alignment)ParagraphLegt HorizontalAlignment fest.
setAttributes(attributes)ParagraphHiermit werden die Attribute des Elements festgelegt.
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)ParagraphHier wird die Einstellung „Linksläufig“ festgelegt.
setLineSpacing(multiplier)ParagraphHiermit wird der Zeilenabstand festgelegt. Dabei wird die Anzahl der Zeilen angegeben, die für den Abstand verwendet werden sollen.
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)voidHiermit wird der Inhalt des Absatzes als Text festgelegt.
setTextAlignment(textAlignment)ParagraphHiermit wird die Textausrichtung festgelegt.

ParagraphHeading

Attribute

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

Person

Methoden

MethodeRückgabetypKurzbeschreibung
copy()PersonGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getEmail()StringGibt die E-Mail-Adresse der Person zurück.
getName()StringGibt den Anzeigenamen der Person zurück, falls festgelegt.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
merge()PersonDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeFromParent()PersonEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)PersonHiermit werden die Attribute des Elements festgelegt.

Position

Methoden

MethodeRückgabetypKurzbeschreibung
getElement()ElementDas Element abrufen, das dieses Position enthält.
getOffset()IntegerDie relative Position dieses Position innerhalb des Elements, das es enthält.
getSurroundingText()TextErstellt ein künstliches Text-Element, das den Text und die Formatierung des Paragraph oder ListItem darstellt, das bzw. die das Position enthält, entweder direkt oder über eine Kette von untergeordneten Elementen.
getSurroundingTextOffset()IntegerErmittelt den Offset dieses Position innerhalb des Text-Elements, das von getSurroundingText() zurückgegeben wird.
insertBookmark()BookmarkErstellt und fügt an dieser Stelle Position eine neue Bookmark ein.
insertInlineImage(image)InlineImageErstellt und fügt an dieser Position eine neue InlineImage aus dem angegebenen Bildblob ein.
insertText(text)TextFügt den angegebenen Text an dieser Position ein.

PositionedImage

Methoden

MethodeRückgabetypKurzbeschreibung
getAs(contentType)BlobGibt die Daten in diesem Objekt als Blob zurück, der in den angegebenen Inhaltstyp konvertiert wurde.
getBlob()BlobGibt die Daten in diesem Objekt als Blob zurück.
getHeight()IntegerDie Höhe des Bildes in Pixeln.
getId()StringRuft die ID des Bilds ab.
getLayout()PositionedLayoutErmittelt einen Enum-Wert, der angibt, wie das Bild angeordnet ist.
getLeftOffset()NumberDer Abstand des Bildes in Punkten vom linken Rand des Absatzes.
getParagraph()ParagraphRuft das Paragraph ab, an dem das Bild verankert ist.
getTopOffset()NumberDer Abstand des Bildes in Punkten vom oberen Rand des Absatzes.
getWidth()IntegerDie Breite des Bilds in Pixeln.
setHeight(height)PositionedImageHiermit wird die Höhe des Bildes in Pixeln festgelegt.
setLayout(layout)PositionedImageHier wird festgelegt, wie das Bild angeordnet wird.
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)PositionedImageHiermit wird die Breite des Bilds in Pixeln festgelegt.

PositionedLayout

Attribute

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

Range

Methoden

MethodeRückgabetypKurzbeschreibung
getRangeElements()RangeElement[]Hiermit werden alle Elemente in dieser Range abgerufen, einschließlich teilweiser Text-Elemente (z. B. bei einer Auswahl, die nur einen Teil eines Text-Elements enthält).

RangeBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
addElement(element)RangeBuilderFügt diesem RangeBuilder eine vollständige Element hinzu.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderFügt diesem RangeBuilder ein teilweises Text-Element hinzu.
addElementsBetween(startElement, endElementInclusive)RangeBuilderFügen Sie diesem RangeBuilder zwei vollständige Elemente und alle Elemente dazwischen hinzu.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderDem RangeBuilder werden zwei teilweise Text-Elemente und alle Elemente dazwischen hinzugefügt.
addRange(range)RangeBuilderFügt diesem RangeBuilder den Inhalt einer anderen Range hinzu.
build()RangeErstellt ein Range aus den auf den Builder angewendeten Einstellungen.
getRangeElements()RangeElement[]Hiermit werden alle Elemente in dieser Range abgerufen, einschließlich teilweiser Text-Elemente (z. B. bei einer Auswahl, die nur einen Teil eines Text-Elements enthält).

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()BooleanBestimmt, ob dieses Bereichselement das gesamte Element oder eine Teilauswahl der Zeichen des Elements abdeckt.

Methoden

MethodeRückgabetypKurzbeschreibung
copy()RichLinkGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getMimeType()StringGibt den MIME-Typ des Links zurück. Dieser ist verfügbar, wenn es sich bei dem Element um einen Link zu einer Drive-Datei handelt, andernfalls wird null zurückgegeben.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getTitle()StringDer angezeigte Titel des Links.
getType()ElementTypeRuft den ElementType des Elements ab.
getUrl()StringGibt die URL der Ressource zurück.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
merge()RichLinkDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeFromParent()RichLinkEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)RichLinkHiermit werden die Attribute des Elements festgelegt.

Tab

Methoden

MethodeRückgabetypKurzbeschreibung
asDocumentTab()DocumentTabRuft den Tab-Inhalt als DocumentTab ab.
getChildTabs()Tab[]Ruft die untergeordneten Tabs auf, 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 Tabtyp 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()TableDer Inhalt des Elements wird gelöscht.
copy()TableGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht.
findElement(elementType, from)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen RangeElement.
findText(searchPattern)RangeElementEs wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.
findText(searchPattern, from)RangeElementEs wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.
getAttributes()ObjectRuft die Attribute des Elements ab.
getBorderColor()StringRuft die Rahmenfarbe ab.
getBorderWidth()NumberRuft die Rahmenbreite in Punkten ab.
getCell(rowIndex, cellIndex)TableCellRuft 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)NumberRuft die Breite der angegebenen Tabellenspalte in Punkten ab.
getLinkUrl()StringRuft die Link-URL ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getNumRows()IntegerRuft die Anzahl der TableRows ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getRow(rowIndex)TableRowRuft die TableRow am angegebenen Zeilenindex ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentDie Textausrichtung wird abgerufen.
getType()ElementTypeRuft den ElementType des Elements ab.
insertTableRow(childIndex)TableRowErstellt und fügt eine neue TableRow an der angegebenen Position ein.
insertTableRow(childIndex, tableRow)TableRowFügt das angegebene TableRow an der angegebenen Position ein.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
removeChild(child)TableEntfernt das angegebene untergeordnete Element.
removeFromParent()TableEntfernt das Element aus dem übergeordneten Element.
removeRow(rowIndex)TableRowEntfernt das TableRow am angegebenen Zeilenindex.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken.
setAttributes(attributes)TableHiermit werden die Attribute des Elements festgelegt.
setBorderColor(color)TableHier legen Sie 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)TableHiermit wird die Textausrichtung festgelegt.

TableCell

Methoden

MethodeRückgabetypKurzbeschreibung
appendHorizontalRule()HorizontalRuleErstellt und hängt einen neuen HorizontalRule an.
appendImage(image)InlineImageErstellt und hängt ein neues InlineImage aus dem angegebenen Bild-Blob 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)TableHiermit wird ein neuer Table mit den angegebenen Zellen angehängt.
appendTable(table)TableHängt die angegebene Table an.
clear()TableCellDer Inhalt des Elements wird gelöscht.
copy()TableCellGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht.
findElement(elementType, from)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen RangeElement.
findText(searchPattern)RangeElementEs wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.
findText(searchPattern, from)RangeElementEs wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.
getAttributes()ObjectRuft die Attribute des Elements ab.
getBackgroundColor()StringRuft 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 Spaltenspanne ab, also die Anzahl der Spalten von Tabellenzellen, die diese Zelle umfasst.
getLinkUrl()StringRuft die Link-URL ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getPaddingBottom()NumberRuft den Abstand unten in Punkten ab.
getPaddingLeft()NumberRuft den linken Abstand in Punkten ab.
getPaddingRight()NumberRuft den rechten Abstand in Punkten ab.
getPaddingTop()NumberDer obere Abstand in Punkten.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getParentRow()TableRowRuft den TableRow mit dem aktuellen TableCell ab.
getParentTable()TableRuft den Table mit dem aktuellen TableCell ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getRowSpan()IntegerRuft die Zeilenspanne ab, also die Anzahl der Tabellenzeilen, die diese Zelle umfasst.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentDie Textausrichtung wird abgerufen.
getType()ElementTypeRuft den ElementType des Elements ab.
getVerticalAlignment()VerticalAlignmentRuft die VerticalAlignment ab.
getWidth()NumberRuft die Breite der Spalte mit der Zelle in Punkten ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt und fügt eine neue HorizontalRule an der angegebenen Position ein.
insertImage(childIndex, image)InlineImageErstellt und fügt eine InlineImage aus dem angegebenen Bild-Blob an der angegebenen Position ein.
insertImage(childIndex, image)InlineImageFügt das angegebene InlineImage an der angegebenen Position ein.
insertListItem(childIndex, listItem)ListItemFügt das angegebene ListItem an der angegebenen Position ein.
insertListItem(childIndex, text)ListItemErstellt und fügt eine neue ListItem an der angegebenen Position ein.
insertParagraph(childIndex, paragraph)ParagraphFügt das angegebene Paragraph an der angegebenen Position ein.
insertParagraph(childIndex, text)ParagraphErstellt und fügt eine neue Paragraph an der angegebenen Position ein.
insertTable(childIndex)TableErstellt und fügt eine neue Table an der angegebenen Position ein.
insertTable(childIndex, cells)TableErstellt und fügt eine neue Table mit den angegebenen Zellen an der angegebenen Position ein.
insertTable(childIndex, table)TableFügt das angegebene Table an der angegebenen Position ein.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
merge()TableCellDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeChild(child)TableCellEntfernt das angegebene untergeordnete Element.
removeFromParent()TableCellEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken.
setAttributes(attributes)TableCellHiermit werden die Attribute des Elements festgelegt.
setBackgroundColor(color)TableCellHier legen Sie die Hintergrundfarbe fest.
setLinkUrl(url)TableCellLegt die Link-URL fest.
setPaddingBottom(paddingBottom)TableCellLegt den Abstand zum unteren Rand 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)TableCellDer Inhalt wird als Nur-Text festgelegt.
setTextAlignment(textAlignment)TableCellHiermit wird die Textausrichtung festgelegt.
setVerticalAlignment(alignment)TableCellHiermit wird die vertikale Ausrichtung festgelegt.
setWidth(width)TableCellLegt die Breite der Spalte mit der aktuellen Zelle in Punkten fest.

TableOfContents

Methoden

MethodeRückgabetypKurzbeschreibung
clear()TableOfContentsDer Inhalt des Elements wird gelöscht.
copy()TableOfContentsGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht.
findElement(elementType, from)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen RangeElement.
findText(searchPattern)RangeElementEs wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.
findText(searchPattern, from)RangeElementEs wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.
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()StringRuft die Link-URL ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentDie Textausrichtung wird abgerufen.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
removeFromParent()TableOfContentsEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken.
setAttributes(attributes)TableOfContentsHiermit werden die Attribute des Elements festgelegt.
setLinkUrl(url)TableOfContentsLegt die Link-URL fest.
setTextAlignment(textAlignment)TableOfContentsHiermit wird die Textausrichtung festgelegt.

TableRow

Methoden

MethodeRückgabetypKurzbeschreibung
appendTableCell()TableCellErstellt und hängt einen neuen TableCell an.
appendTableCell(textContents)TableCellHängt die angegebene TableCell mit dem angegebenen Text an.
appendTableCell(tableCell)TableCellHängt die angegebene TableCell an.
clear()TableRowDer Inhalt des Elements wird gelöscht.
copy()TableRowGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht.
findElement(elementType, from)RangeElementEs wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen RangeElement.
findText(searchPattern)RangeElementEs wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.
findText(searchPattern, from)RangeElementEs wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.
getAttributes()ObjectRuft die Attribute des Elements ab.
getCell(cellIndex)TableCellRuft die TableCell am angegebenen Zellindex 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()StringRuft die Link-URL ab.
getMinimumHeight()NumberDie minimale Höhe in Punkten.
getNextSibling()ElementRuft 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()ContainerElementRuft das übergeordnete Element des Elements ab.
getParentTable()TableRuft die Table ab, die die aktuelle Zeile enthält.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentDie Textausrichtung wird abgerufen.
getType()ElementTypeRuft den ElementType des Elements ab.
insertTableCell(childIndex)TableCellErstellt und fügt eine neue TableCell an der angegebenen Position ein.
insertTableCell(childIndex, textContents)TableCellFügt das angegebene TableCell mit dem angegebenen Text an der angegebenen Position ein.
insertTableCell(childIndex, tableCell)TableCellFügt das angegebene TableCell an der angegebenen Position ein.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
merge()TableRowDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeCell(cellIndex)TableCellEntfernt die TableCell am angegebenen Zellindex.
removeChild(child)TableRowEntfernt das angegebene untergeordnete Element.
removeFromParent()TableRowEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken.
setAttributes(attributes)TableRowHiermit werden die Attribute des Elements festgelegt.
setLinkUrl(url)TableRowLegt die Link-URL fest.
setMinimumHeight(minHeight)TableRowLegt die minimale Höhe in Punkten fest.
setTextAlignment(textAlignment)TableRowHiermit wird die Textausrichtung festgelegt.

Text

Methoden

MethodeRückgabetypKurzbeschreibung
appendText(text)TextFügen Sie den angegebenen Text am Ende dieses Textbereichs ein.
copy()TextGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
deleteText(startOffset, endOffsetInclusive)TextLöscht einen Textabschnitt.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findText(searchPattern)RangeElementEs wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.
findText(searchPattern, from)RangeElementEs wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.
getAttributes()ObjectRuft die Attribute des Elements ab.
getAttributes(offset)ObjectRuft die Attribute am angegebenen Zeichenoffset ab.
getBackgroundColor()StringRuft die Einstellung für die Hintergrundfarbe ab.
getBackgroundColor(offset)StringRuft die Hintergrundfarbe am angegebenen Zeichenoffset ab.
getFontFamily()StringRuft die Einstellung für die Schriftfamilie ab.
getFontFamily(offset)StringRuft die Schriftfamilie am angegebenen Zeichenoffset ab.
getFontSize()NumberRuft die Einstellung für die Schriftgröße ab.
getFontSize(offset)NumberRuft die Schriftgröße am angegebenen Zeichenoffset ab.
getForegroundColor()StringRuft die Einstellung für die Vordergrundfarbe ab.
getForegroundColor(offset)StringRuft die Vordergrundfarbe am angegebenen Zeichenoffset ab.
getLinkUrl()StringRuft die Link-URL ab.
getLinkUrl(offset)StringRuft die Link-URL am angegebenen Zeichenoffset ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentDie Textausrichtung wird abgerufen.
getTextAlignment(offset)TextAlignmentRuft die Textausrichtung für ein einzelnes Zeichen ab.
getTextAttributeIndices()Integer[]Ruft die Textindizes ab, die dem Beginn verschiedener Textformatierungsblöcke entsprechen.
getType()ElementTypeRuft den ElementType des Elements ab.
insertText(offset, text)TextFügt den angegebenen Text am angegebenen Zeichen-Offset ein.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
isBold()BooleanRuft die Fettdruckeinstellung ab.
isBold(offset)BooleanRuft die Fettdruckeinstellung am angegebenen Zeichenoffset ab.
isItalic()BooleanRuft die Einstellung für Kursivschrift ab.
isItalic(offset)BooleanRuft die Einstellung für Kursivschrift am angegebenen Zeichenoffset ab.
isStrikethrough()BooleanRuft die Einstellung für Durchgestrichen zurück.
isStrikethrough(offset)BooleanRuft die Durchstreichungseinstellung am angegebenen Zeichenoffset ab.
isUnderline()BooleanRuft die Unterstreichungseinstellung ab.
isUnderline(offset)BooleanRuft die Unterstreichungseinstellung am angegebenen Zeichenoffset ab.
merge()TextDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeFromParent()TextEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken.
setAttributes(startOffset, endOffsetInclusive, attributes)TextWendet die angegebenen Attribute auf den angegebenen Zeichenbereich an.
setAttributes(attributes)TextHiermit werden die Attribute des Elements festgelegt.
setBackgroundColor(startOffset, endOffsetInclusive, color)TextLegt die Hintergrundfarbe für den angegebenen Zeichenbereich fest.
setBackgroundColor(color)TextHier legen Sie die Hintergrundfarbe fest.
setBold(bold)TextHier legen Sie die Fettdruckeinstellung fest.
setBold(startOffset, endOffsetInclusive, bold)TextLegt die Fettdruckeinstellung für den angegebenen Zeichenbereich fest.
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)TextHiermit wird die Schriftfamilie für den angegebenen Zeichenbereich festgelegt.
setFontFamily(fontFamilyName)TextHiermit wird die Schriftfamilie festgelegt.
setFontSize(startOffset, endOffsetInclusive, size)TextLegt die Schriftgröße für den angegebenen Zeichenbereich fest.
setFontSize(size)TextHiermit wird die Schriftgröße festgelegt.
setForegroundColor(startOffset, endOffsetInclusive, color)TextLegt die Vordergrundfarbe für den angegebenen Zeichenbereich fest.
setForegroundColor(color)TextHiermit wird die Vordergrundfarbe festgelegt.
setItalic(italic)TextHier legen Sie die Einstellung für Kursivschrift fest.
setItalic(startOffset, endOffsetInclusive, italic)TextLegt die Einstellung für Kursivschrift 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 Durchgestrichen-Einstellung fest.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)TextLegt die Durchstreichung für den angegebenen Zeichenbereich fest.
setText(text)TextLegt den Textinhalt fest.
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)TextHiermit wird die Textausrichtung für einen bestimmten Zeichenbereich festgelegt.
setTextAlignment(textAlignment)TextHiermit wird die Textausrichtung festgelegt.
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 Textes.
SUBSCRIPTEnumDie Textausrichtung des Unterscripts.

UnsupportedElement

Methoden

MethodeRückgabetypKurzbeschreibung
copy()UnsupportedElementGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
merge()UnsupportedElementDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeFromParent()UnsupportedElementEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)UnsupportedElementHiermit werden die Attribute des Elements festgelegt.

VerticalAlignment

Attribute

AttributTypBeschreibung
BOTTOMEnumDie Option „Unten ausgerichtet“
CENTEREnumDie Option „Zentriert ausrichten“.
TOPEnumDie Option „Oben ausgerichtet“