Document Service

Document

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

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

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

Klassen

NameKurzbeschreibung
AttributeEine Aufzählung der Elementattribute.
BodyDer Inhalt eines Tabs in einem Google Docs-Dokument.
BookmarkEin Objekt, das ein Lesezeichen darstellt.
ContainerElementEin generisches Element, das andere Elemente enthalten kann.
DateEin Element, das ein formatiertes Datum darstellt
DocumentEin Dokument mit einem oder mehreren Tab-Objekten, die jeweils RTF- und wie Tabellen und Listen.
DocumentAppDer Dokumentdienst erstellt und öffnet Documents-Dateien, die bearbeitet werden können.
DocumentTabEin Dokument-Tab, der RTF und Elemente wie Tabellen und Listen enthält.
ElementEin generisches Element.
ElementTypeEine Aufzählung aller Elementtypen.
EquationEin Element, das einen mathematischen Ausdruck darstellt.
EquationFunctionEin Element, das eine Funktion in einem mathematischen Equation darstellt.
EquationFunctionArgumentSeparatorEin Element, das ein Funktionstrennzeichen in einem mathematischen Equation darstellt.
EquationSymbolEin Element, das ein Symbol in einem mathematischen Equation darstellt.
FontFamilyEine Aufzählung der unterstützten Schriftarten.
FooterSectionEin Element, das einen Fußzeilenbereich darstellt.
FootnoteEin Element, das eine Fußnote darstellt.
FootnoteSectionEin -Element, das einen Fußnotenbereich darstellt.
GlyphTypeEine Aufzählung der unterstützten Glyphentypen.
HeaderSectionEin Element, das einen Kopfzeilenbereich darstellt.
HorizontalAlignmentEine Aufzählung der unterstützten Typen für die horizontale Ausrichtung.
HorizontalRuleEin Element, das eine horizontale Regel darstellt.
InlineDrawingEin Element, das eine eingebettete Zeichnung darstellt.
InlineImageEin Element, das ein eingebettetes Bild darstellt.
ListItemEin Element, das ein Listenelement darstellt.
NamedRangeEin 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 auf dem Dokument-Tab, in Bezug auf ein bestimmtes Element.
PositionedImageBild mit fester Position, verankert an Paragraph.
PositionedLayoutEine Aufzählung, die angibt, wie ein PositionedImage im Verhältnis zur umgebenden Umgebung angeordnet wird Text.
RangeEin Bereich von Elementen in einem Dokument.
RangeBuilderEin Builder, der zum Erstellen von Range-Objekten aus Dokumentelementen verwendet wird.
RangeElementEin Wrapper um ein Element mit einem möglichen Start- und Endversatz.
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, das ein Inhaltsverzeichnis enthält.
TableRowEin Element, das eine Tabellenzeile darstellt.
TextEin Element, das einen RTF-Bereich darstellt.
TextAlignmentEine Aufzählung der Art der Textausrichtungen.
UnsupportedElementEin Element, das eine Region darstellt, die unbekannt ist oder nicht von einem Skript beeinflusst werden kann, z. B. ein Seitennummer.
VerticalAlignmentEine Aufzählung der unterstützten vertikalen Ausrichtungstypen.

Attribute

Attribute

AttributTypBeschreibung
BACKGROUND_COLOREnumDie Hintergrundfarbe eines Elements (Absatz, Tabelle usw.) oder Dokument.
BOLDEnumDie Einstellung der Schriftstärke für RTF
BORDER_COLOREnumDie Rahmenfarbe für Tabellenelemente.
BORDER_WIDTHEnumDie Rahmenbreite in Punkten für Tabellenelemente.
CODEEnumDer Codeinhalt für Gleichungselemente.
FONT_FAMILYEnumDie Einstellung der Schriftfamilie für RTF
FONT_SIZEEnumDie Einstellung der Schriftgröße in Punkten, bei RTF.
FOREGROUND_COLOREnumDie Vordergrundfarbe für RTF
HEADINGEnumDer Überschriftentyp für Absatzelemente (z. B. DocumentApp.ParagraphHeading.HEADING1).
HEIGHTEnumDie Höheneinstellung für Bildelemente.
HORIZONTAL_ALIGNMENTEnumDie horizontale Ausrichtung für Absatzelemente (z. B. DocumentApp.HorizontalAlignment.CENTER).
INDENT_ENDEnumDie Einstellung für den Endeinzug in Punkten bei Absatzelementen.
INDENT_FIRST_LINEEnumDie Einstellung für den Einzug der ersten Zeile in Punkten bei Absatzelementen.
INDENT_STARTEnumDie Einstellung für den Einzug am Anfang in Punkten für Absatzelemente.
ITALICEnumDie Schriftstileinstellung für RTF.
GLYPH_TYPEEnumDer Glyphentyp für Listenelementelemente.
LEFT_TO_RIGHTEnumDie Einstellung für die Textrichtung bei RTF.
LINE_SPACINGEnumDie Einstellung des Zeilenabstands als Multiplikator für Absatzelemente.
LINK_URLEnumDie Link-URL für Rich Text.
LIST_IDEnumDie ID der einschließenden Liste für Listenelementelemente.
MARGIN_BOTTOMEnumDie Einstellung für den unteren Rand in Punkten bei Absatzelementen.
MARGIN_LEFTEnumDie Einstellung für den linken Rand in Punkten bei Absatzelementen.
MARGIN_RIGHTEnumDie Einstellung für den rechten Rand in Punkten bei Absatzelementen.
MARGIN_TOPEnumDie Einstellung für den oberen Rand in Punkten bei Absatzelementen.
NESTING_LEVELEnumDie Verschachtelungsebene der Elemente für Listenelementelemente.
MINIMUM_HEIGHTEnumDie Einstellung für die minimale Höhe in Punkten für Tabellenzeilenelemente.
PADDING_BOTTOMEnumDie untere Abstandseinstellung in Punkten für Tabellenzellenelemente.
PADDING_LEFTEnumDie linke Abstandseinstellung in Punkten für Tabellenzellenelemente.
PADDING_RIGHTEnumDie richtige Einstellung für den Abstand in Punkten bei Tabellenzellenelementen.
PADDING_TOPEnumDie obere Abstandseinstellung in Punkten für Tabellenzellenelemente.
PAGE_HEIGHTEnumDie Seitenhöheneinstellung in Punkten für Dokumente.
PAGE_WIDTHEnumDie Einstellung der Seitenbreite in Punkten für Dokumente.
SPACING_AFTEREnumDie Abstandseinstellung unten in Punkten bei Absatzelementen.
SPACING_BEFOREEnumDer obere Abstand in Punkten bei Absatzelementen.
STRIKETHROUGHEnumDurchgestrichen-Einstellung für RTF
UNDERLINEEnumUnterstrichen (RTF)
VERTICAL_ALIGNMENTEnumDie vertikale Ausrichtung für Elemente von Tabellenzellen.
WIDTHEnumDie Breiteneinstellung für Tabellenzellen- und Bildelemente.

Body

Methoden

MethodeRückgabetypKurzbeschreibung
appendHorizontalRule()HorizontalRuleErstellt eine neue HorizontalRule und hängt sie an.
appendImage(image)InlineImageErstellt eine neue InlineImage aus dem angegebenen Bild-Blob und hängt sie an.
appendImage(image)InlineImageHängt die angegebene InlineImage an.
appendListItem(listItem)ListItemHängt die angegebene ListItem an.
appendListItem(text)ListItemErstellt eine neue ListItem und hängt sie an, die den angegebenen Textinhalt enthält.
appendPageBreak()PageBreakErstellt eine neue PageBreak und hängt sie an.
appendPageBreak(pageBreak)PageBreakHängt die angegebene PageBreak an.
appendParagraph(paragraph)ParagraphHängt die angegebene Paragraph an.
appendParagraph(text)ParagraphErstellt eine neue Paragraph und hängt sie an, die den angegebenen Textinhalt enthält.
appendTable()TableErstellt eine neue Table und hängt sie an.
appendTable(cells)TableHängt eine neue Table an, die für jeden angegebenen Stringwert eine TableCell enthält.
appendTable(table)TableHängt die angegebene Table an.
clear()BodyLöscht den Inhalt des Elements.
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)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.
findElement(elementType, from)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit angegeben: RangeElement.
findText(searchPattern)RangeElementSucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElementSucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element im angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab
getHeadingAttributes(paragraphHeading)ObjectRuft den Satz von Attributen für den angegebenen ParagraphHeading ab.
getImages()InlineImage[]Ruft alle im Abschnitt enthaltenen InlineImages ab.
getListItems()ListItem[]Ruft alle im Abschnitt enthaltenen ListItems ab.
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()NumberRuft die Seitenhöhe in Punkten ab.
getPageWidth()NumberRuft die Seitenbreite in Punkten ab.
getParagraphs()Paragraph[]Ruft alle im Abschnitt enthaltenen Paragraphs ab (einschließlich ListItems).
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getTables()Table[]Ruft alle im Abschnitt enthaltenen Tables ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentRuft die Textausrichtung ab.
getType()ElementTypeRuft den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt eine neue HorizontalRule und fügt sie im angegebenen Index ein.
insertImage(childIndex, image)InlineImageErstellt und fügt einen InlineImage aus dem angegebenen Bild-BLOB am angegebenen -Index.
insertImage(childIndex, image)InlineImageFügt den angegebenen InlineImage im angegebenen Index ein.
insertListItem(childIndex, listItem)ListItemFügt den angegebenen ListItem im angegebenen Index ein.
insertListItem(childIndex, text)ListItemErstellt eine neue ListItem und fügt sie im angegebenen Index ein, die den angegebenen Index enthält Textinhalt.
insertPageBreak(childIndex)PageBreakErstellt eine neue PageBreak und fügt sie im angegebenen Index ein.
insertPageBreak(childIndex, pageBreak)PageBreakFügt den angegebenen PageBreak im angegebenen Index ein.
insertParagraph(childIndex, paragraph)ParagraphFügt den angegebenen Paragraph im angegebenen Index ein.
insertParagraph(childIndex, text)ParagraphErstellt eine neue Paragraph und fügt sie im angegebenen Index ein, die den angegebenen Index enthält Textinhalt.
insertTable(childIndex)TableErstellt eine neue Table und fügt sie im angegebenen Index ein.
insertTable(childIndex, cells)TableErstellt eine neue Table und fügt sie ein, die die angegebenen Zellen am angegebenen Index enthält.
insertTable(childIndex, table)TableFügt den angegebenen Table im angegebenen Index ein.
removeChild(child)BodyEntfernt das angegebene untergeordnete Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke.
setAttributes(attributes)BodyLegt die Attribute des Elements fest.
setHeadingAttributes(paragraphHeading, attributes)BodyLegt die Attribute für die angegebenen ParagraphHeading fest.
setMarginBottom(marginBottom)BodyLegt den unteren Rand in Punkten fest.
setMarginLeft(marginLeft)BodyLegt den linken Rand in Punkten fest.
setMarginRight(marginRight)BodyLegt den rechten Rand in Punkten fest.
setMarginTop(marginTop)BodyLegt den oberen Rand fest.
setPageHeight(pageHeight)BodyLegt die Seitenhöhe in Punkten fest.
setPageWidth(pageWidth)BodyLegt die Seitenbreite in Punkten fest.
setText(text)BodyLegt den Inhalt als Nur-Text fest.
setTextAlignment(textAlignment)BodyLegt die Textausrichtung fest.

Bookmark

Methoden

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

ContainerElement

Methoden

MethodeRückgabetypKurzbeschreibung
asBody()BodyGibt das aktuelle Element als Body zurück.
asEquation()EquationGibt das aktuelle Element als Equation zurück.
asFooterSection()FooterSectionGibt das aktuelle Element als FooterSection zurück.
asFootnoteSection()FootnoteSectionGibt das aktuelle Element als FootnoteSection zurück.
asHeaderSection()HeaderSectionGibt das aktuelle Element als HeaderSection zurück.
asListItem()ListItemGibt das aktuelle Element als ListItem zurück.
asParagraph()ParagraphGibt das aktuelle Element als Paragraph zurück.
asTable()TableGibt das aktuelle Element als Table zurück.
asTableCell()TableCellGibt das aktuelle Element als TableCell zurück.
asTableOfContents()TableOfContentsGibt das aktuelle Element als TableOfContents zurück.
asTableRow()TableRowGibt das aktuelle Element als TableRow zurück.
clear()ContainerElementLöscht den Inhalt des Elements.
copy()ContainerElementGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.
findElement(elementType, from)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit angegeben: RangeElement.
findText(searchPattern)RangeElementSucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElementSucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element im 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()TextAlignmentRuft die Textausrichtung ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende von Document befindet.
merge()ContainerElementFührt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
removeFromParent()ContainerElementEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke.
setAttributes(attributes)ContainerElementLegt die Attribute des Elements fest.
setLinkUrl(url)ContainerElementLegt die Link-URL fest.
setTextAlignment(textAlignment)ContainerElementLegt die Textausrichtung fest.

Date

Methoden

MethodeRückgabetypKurzbeschreibung
copy()DateGibt eine 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 die Sprache des Datums zurück, die 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 dem Datum zugeordnet ist.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende von Document befindet.
merge()DateFührt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
removeFromParent()DateEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)DateLegt die Attribute des Elements fest.

Document

Methoden in der Klasse "Document", die direkt auf Textinhalte zugreifen und diese ändern, werden entweder im aktiven Tab (in Skripts, die an ein bestimmtes Dokument gebunden sind) oder im ersten Tab (falls kein aktiver Tab verfügbar ist) ausgeführt. Scripts, die diese Methoden verwenden (z. B. Document.getBody()), können so aktualisiert werden, dass sie Tabs auf einen der folgenden Tabs unterstützen:

  • Ersten Tab verwenden: Document.getTabs()[0].asDocumentTab().getBody()
  • Alle Tabs verwenden: Durchlaufen Sie den Tab-Baum mit Document.getTabs() und Tab.getChildTabs(). Rufen Sie für jeden Tab in der Struktur Tab.asDocumentTab().getBody() auf.
  • Ausgewählten Tab verwenden: Document.getTabs()[Document.getActiveTab().getId()].asDocumentTab().getBody()
  • Einen bestimmten Tab verwenden: Document.getTab(TAB_ID).asDocumentTab().getBody()

Weitere Informationen zur Tab-Funktion finden Sie unter Mit Tabs arbeiten.

Methoden

MethodeRückgabetypKurzbeschreibung
addBookmark(position)BookmarkFügt dem ersten Tab ein Bookmark am angegebenen Position hinzu. Für Skripts, die gebunden an ein Dokument, den aktiven Tab.
addEditor(emailAddress)DocumentFügt den angegebenen Nutzer der Liste der Bearbeiter für Document hinzu.
addEditor(user)DocumentFügt den angegebenen Nutzer der Liste der Bearbeiter für Document hinzu.
addEditors(emailAddresses)DocumentFügt das angegebene Array von Nutzern der Liste der Bearbeiter für Document hinzu.
addFooter()FooterSectionFügt dem ersten Tab einen Fußzeilenbereich hinzu, sofern keiner vorhanden ist. Bei Skripts, die an ein Dokument gebunden sind, wird der aktive Tab hinzugefügt.
addHeader()HeaderSectionFügt dem ersten Tab einen Kopfzeilenabschnitt hinzu, sofern keiner vorhanden ist. Bei Skripts, die an ein Dokument gebunden sind, wird der aktive Tab hinzugefügt.
addNamedRange(name, range)NamedRangeFügt ein NamedRange hinzu. Dabei handelt es sich um eine Range mit einem Namen und einer ID zur Verwendung für spätere Abruf auf dem ersten Tab oder bei Skripts, die an ein Dokument gebunden sind, im aktiven Tab.
addViewer(emailAddress)DocumentFügt den angegebenen Nutzer der Liste der Betrachter für das Document hinzu.
addViewer(user)DocumentFügt den angegebenen Nutzer der Liste der Betrachter für das Document hinzu.
addViewers(emailAddresses)DocumentFügt das angegebene Array von Nutzern der Betrachterliste für Document hinzu.
getActiveTab()TabRuft die derzeit 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 den Body des ersten Tabs oder bei Skripts, die an ein Dokument gebunden sind, den DocumentBodySection des aktiven Tabs ab.
getBookmark(id)BookmarkRuft das Bookmark mit der angegebenen ID im ersten Tab oder, im Fall von Skripts, die an ein Dokument gebunden sind, den aktiven Tab ab.
getBookmarks()Bookmark[]Ruft alle Bookmark-Objekte im ersten Tab oder im Fall von Skripts, die an ein Dokument gebunden sind, im aktiven Tab ab.
getCursor()PositionRuft den Cursor des Nutzers im aktiven Tab ab.
getEditors()User[]Ruft die Liste der Bearbeiter für dieses Document-Element ab.
getFooter()FooterSectionRuft den Fußzeilenbereich des ersten Tabs oder bei Skripts, die an ein Dokument gebunden sind, die Fußzeile des aktiven Tabs ab .
getFootnotes()Footnote[]Ruft alle Footnote-Elemente im Body des ersten Tabs oder im Fall von Skripts, die an ein Dokument gebunden sind, im Body des aktiven Tabs ab.
getHeader()HeaderSectionRuft den Kopfzeilenbereich des ersten Tabs oder, im Fall von Skripts, die an ein Dokument gebunden sind, den Header des aktiven Tabs ab .
getId()StringRuft die eindeutige Kennung des Dokuments ab.
getLanguage()StringRuft den Sprachcode des Dokuments ab.
getName()StringRuft den Titel des Dokuments ab.
getNamedRangeById(id)NamedRangeRuft das NamedRange mit der angegebenen ID im ersten Tab oder, im Fall von Skripts, die an ein Dokument gebunden sind, den aktiven Tab ab.
getNamedRanges()NamedRange[]Ruft alle NamedRange-Objekte im ersten Tab oder im Fall von Skripts, die an ein Dokument gebunden sind, im aktiven Tab ab.
getNamedRanges(name)NamedRange[]Ruft alle NamedRange-Objekte mit dem angegebenen Namen im ersten Tab oder für Skripts ab, die an ein Dokument gebunden sind, den aktiven Tab.
getSelection()RangeRuft die Auswahl des Nutzers auf dem aktiven Tab ab.
getSupportedLanguageCodes()String[]Ruft alle Sprachcodes ab, die in Google Docs-Dateien unterstützt werden.
getTab(tabId)TabRuft die Tab mit der angegebenen ID ab.
getTabs()Tab[]Ruft alle nicht verschachtelten Tabs ab, die Teil des Dokuments sind.
getUrl()StringRuft die URL für den Zugriff auf das aktuelle Dokument ab.
getViewers()User[]Ruft die Liste der Betrachter und Kommentatoren für dieses Document ab.
newPosition(element, offset)PositionErstellt eine neue Position, die ein Verweis auf eine Position auf dem Tab ist, relativ zu einem ein bestimmtes Element auf dem ersten Tab oder bei Skripts, die an ein Dokument gebunden sind, im aktiven Tab.
newRange()RangeBuilderErstellt einen Builder, der zum Erstellen von Range-Objekten aus Tab-Elementen im 1. Tab oder für Skripts, die an ein gebundenes der aktive Registerkarte.
removeEditor(emailAddress)DocumentEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Document.
removeEditor(user)DocumentEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Document.
removeViewer(emailAddress)DocumentEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für das Document.
removeViewer(user)DocumentEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für das Document.
saveAndClose()voidSpeichert den aktuellen Document.
setActiveTab(tabId)voidLegt das vom Nutzer ausgewählte Tab im aktuellen Dokument auf den Tab mit der angegebenen ID fest.
setCursor(position)DocumentLegt den Cursor des Nutzers bei Angabe eines Position fest.
setLanguage(languageCode)DocumentLegt den Sprachcode des Dokuments fest.
setName(name)DocumentLegt den Titel des Dokuments fest.
setSelection(range)DocumentLegt die Auswahl des Nutzers auf dem aktiven Tab fest, wenn eine Range angegeben wird.

DocumentApp

Attribute

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

Methoden

MethodeRückgabetypKurzbeschreibung
create(name)DocumentErstellt ein neues Dokument und gibt es zurück.
getActiveDocument()DocumentGibt das Dokument zurück, an das das Skript containergebunden ist.
getUi()UiGibt eine Instanz der Benutzeroberflächenumgebung des Dokuments zurück, die es dem Skript ermöglicht, wie Menüs, Dialogfelder und Seitenleisten.
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 einen Bookmark am angegebenen Position hinzu.
addFooter()FooterSectionFügt einen Tab-Fußzeilenabschnitt hinzu, falls keiner vorhanden ist.
addHeader()HeaderSectionFügt einen Tab-Header-Abschnitt hinzu, falls keiner vorhanden ist.
addNamedRange(name, range)NamedRangeFügt ein NamedRange hinzu. Dabei handelt es sich um eine Range mit einem Namen und einer ID zur Verwendung für Daten später abgerufen werden.
getBody()BodyRuft den Body des Tabs ab.
getBookmark(id)BookmarkRuft das Bookmark mit der angegebenen ID ab.
getBookmarks()Bookmark[]Ruft alle Bookmark-Objekte im Tab ab.
getFooter()FooterSectionRuft den Fußzeilenbereich des Tabs ab, sofern vorhanden.
getFootnotes()Footnote[]Ruft alle Footnote-Elemente im Textkörper des Tabs ab.
getHeader()HeaderSectionRuft den Headerabschnitt des Tabs ab, sofern vorhanden.
getNamedRangeById(id)NamedRangeRuft das NamedRange mit der angegebenen ID ab.
getNamedRanges()NamedRange[]Ruft alle NamedRange-Objekte im Tab ab.
getNamedRanges(name)NamedRange[]Ruft alle NamedRange-Objekte im Tab mit dem angegebenen Namen ab.
newPosition(element, offset)PositionErstellt eine neue Position, die ein Verweis auf eine Position auf dem Tab ist, relativ zu einem spezifisches Element.
newRange()RangeBuilderErstellt einen Builder, der zum Erstellen von Range-Objekten aus Tab-Elementen verwendet wird.

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 von Document befindet.
merge()ElementFührt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
removeFromParent()ElementEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)ElementLegt die Attribute des Elements fest.

ElementType

Attribute

AttributTypBeschreibung
BODY_SECTIONEnumDer Typ, der dem Body-Element entspricht.
COMMENT_SECTIONEnumDer Typ, der dem CommentSection-Element entspricht.
DATEEnumDer Typ, der Date entspricht -Elements.
EQUATIONEnumDer Typ, der dem Equation-Element entspricht.
EQUATION_FUNCTIONEnumDer Typ, der dem EquationFunction-Element entspricht.
EQUATION_FUNCTION_ARGUMENT_SEPARATOREnumDer Typ, der EquationFunctionArgumentSeparator entspricht -Elements.
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 Text entspricht -Elements.
UNSUPPORTEDEnumDer Typ, der UnsupportedElement entspricht.

Equation

Methoden

MethodeRückgabetypKurzbeschreibung
clear()EquationLöscht den Inhalt des Elements.
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)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.
findElement(elementType, from)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit angegeben: RangeElement.
findText(searchPattern)RangeElementSucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElementSucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element im 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()TextAlignmentRuft die Textausrichtung ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende von Document befindet.
merge()EquationFührt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
removeFromParent()EquationEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke.
setAttributes(attributes)EquationLegt die Attribute des Elements fest.
setLinkUrl(url)EquationLegt die Link-URL fest.
setTextAlignment(textAlignment)EquationLegt die Textausrichtung fest.

EquationFunction

Methoden

MethodeRückgabetypKurzbeschreibung
clear()EquationFunctionLöscht den Inhalt des Elements.
copy()EquationFunctionGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.
findElement(elementType, from)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit angegeben: RangeElement.
findText(searchPattern)RangeElementSucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElementSucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element im 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()TextAlignmentRuft die Textausrichtung ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende von Document befindet.
merge()EquationFunctionFührt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
removeFromParent()EquationFunctionEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke.
setAttributes(attributes)EquationFunctionLegt die Attribute des Elements fest.
setLinkUrl(url)EquationFunctionLegt die Link-URL fest.
setTextAlignment(textAlignment)EquationFunctionLegt die Textausrichtung fest.

EquationFunctionArgumentSeparator

Methoden

MethodeRückgabetypKurzbeschreibung
copy()EquationFunctionArgumentSeparatorGibt eine 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 von Document befindet.
merge()EquationFunctionArgumentSeparatorFührt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
removeFromParent()EquationFunctionArgumentSeparatorEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)EquationFunctionArgumentSeparatorLegt die Attribute des Elements fest.

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 für das Gleichungssymbol 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 von Document befindet.
merge()EquationSymbolFührt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
removeFromParent()EquationSymbolEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)EquationSymbolLegt die Attribute des Elements fest.

FontFamily

FooterSection

Methoden

MethodeRückgabetypKurzbeschreibung
appendHorizontalRule()HorizontalRuleErstellt eine neue HorizontalRule und hängt sie an.
appendImage(image)InlineImageErstellt eine neue InlineImage aus dem angegebenen Bild-Blob und hängt sie an.
appendImage(image)InlineImageHängt die angegebene InlineImage an.
appendListItem(listItem)ListItemHängt die angegebene ListItem an.
appendListItem(text)ListItemErstellt eine neue ListItem und hängt sie an, die den angegebenen Textinhalt enthält.
appendParagraph(paragraph)ParagraphHängt die angegebene Paragraph an.
appendParagraph(text)ParagraphErstellt eine neue Paragraph und hängt sie an, die den angegebenen Textinhalt enthält.
appendTable()TableErstellt eine neue Table und hängt sie an.
appendTable(cells)TableHängt eine neue Table an, die für jeden angegebenen Stringwert eine TableCell enthält.
appendTable(table)TableHängt die angegebene Table an.
clear()FooterSectionLöscht den Inhalt des Elements.
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)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.
findElement(elementType, from)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit angegeben: RangeElement.
findText(searchPattern)RangeElementSucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElementSucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element im angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab
getImages()InlineImage[]Ruft alle im Abschnitt enthaltenen InlineImages ab.
getListItems()ListItem[]Ruft alle im Abschnitt enthaltenen ListItems ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParagraphs()Paragraph[]Ruft alle im Abschnitt enthaltenen Paragraphs ab (einschließlich ListItems).
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getTables()Table[]Ruft alle im Abschnitt enthaltenen Tables ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentRuft die Textausrichtung ab.
getType()ElementTypeRuft den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt eine neue HorizontalRule und fügt sie im angegebenen Index ein.
insertImage(childIndex, image)InlineImageErstellt und fügt einen InlineImage aus dem angegebenen Bild-BLOB am angegebenen -Index.
insertImage(childIndex, image)InlineImageFügt den angegebenen InlineImage im angegebenen Index ein.
insertListItem(childIndex, listItem)ListItemFügt den angegebenen ListItem im angegebenen Index ein.
insertListItem(childIndex, text)ListItemErstellt eine neue ListItem und fügt sie im angegebenen Index ein, die den angegebenen Index enthält Textinhalt.
insertParagraph(childIndex, paragraph)ParagraphFügt den angegebenen Paragraph im angegebenen Index ein.
insertParagraph(childIndex, text)ParagraphErstellt eine neue Paragraph und fügt sie im angegebenen Index ein, die den angegebenen Index enthält Textinhalt.
insertTable(childIndex)TableErstellt eine neue Table und fügt sie im angegebenen Index ein.
insertTable(childIndex, cells)TableErstellt eine neue Table und fügt sie ein, die die angegebenen Zellen am angegebenen Index enthält.
insertTable(childIndex, table)TableFügt den angegebenen Table im angegebenen Index 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, wobei die reguläre Ausdrücke.
setAttributes(attributes)FooterSectionLegt die Attribute des Elements fest.
setText(text)FooterSectionLegt den Inhalt als Nur-Text fest.
setTextAlignment(textAlignment)FooterSectionLegt die Textausrichtung fest.

Footnote

Methoden

MethodeRückgabetypKurzbeschreibung
copy()FootnoteGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getFootnoteContents()FootnoteSectionRuft den Inhalt des Fußnoten-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 von Document befindet.
removeFromParent()FootnoteEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)FootnoteLegt die Attribute des Elements fest.

FootnoteSection

Methoden

MethodeRückgabetypKurzbeschreibung
appendParagraph(paragraph)ParagraphHängt die angegebene Paragraph an.
appendParagraph(text)ParagraphErstellt eine neue Paragraph und hängt sie an, die den angegebenen Textinhalt enthält.
clear()FootnoteSectionLöscht den Inhalt des Elements.
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)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.
findElement(elementType, from)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit angegeben: RangeElement.
findText(searchPattern)RangeElementSucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElementSucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element im 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[]Ruft alle im Abschnitt enthaltenen Paragraphs ab (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()TextAlignmentRuft die Textausrichtung ab.
getType()ElementTypeRuft den ElementType des Elements ab.
insertParagraph(childIndex, paragraph)ParagraphFügt den angegebenen Paragraph im angegebenen Index ein.
insertParagraph(childIndex, text)ParagraphErstellt eine neue Paragraph und fügt sie im angegebenen Index ein, die den angegebenen Index enthält Textinhalt.
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, wobei die reguläre Ausdrücke.
setAttributes(attributes)FootnoteSectionLegt die Attribute des Elements fest.
setText(text)FootnoteSectionLegt den Inhalt als Nur-Text fest.
setTextAlignment(textAlignment)FootnoteSectionLegt die Textausrichtung fest.

GlyphType

Attribute

AttributTypBeschreibung
BULLETEnumStandardmäßiges Aufzählungszeichen, kreisförmig und ausgefüllt.
HOLLOW_BULLETEnumEin Aufzählungszeichen.
SQUARE_BULLETEnumEin quadratisches Aufzählungszeichen.
NUMBEREnumEin nummerbasierter Aufzählungspunkt.
LATIN_UPPEREnumEin Aufzählungszeichen in Großbuchstaben.
LATIN_LOWEREnumEin Aufzählungszeichen in lateinischen Buchstaben.
ROMAN_UPPEREnumEin römisches Aufzählungszeichen in Großbuchstaben.
ROMAN_LOWEREnumEin römisches Aufzählungszeichen in Kleinbuchstaben.

HeaderSection

Methoden

MethodeRückgabetypKurzbeschreibung
appendHorizontalRule()HorizontalRuleErstellt eine neue HorizontalRule und hängt sie an.
appendImage(image)InlineImageErstellt eine neue InlineImage aus dem angegebenen Bild-Blob und hängt sie an.
appendImage(image)InlineImageHängt die angegebene InlineImage an.
appendListItem(listItem)ListItemHängt die angegebene ListItem an.
appendListItem(text)ListItemErstellt eine neue ListItem und hängt sie an, die den angegebenen Textinhalt enthält.
appendParagraph(paragraph)ParagraphHängt die angegebene Paragraph an.
appendParagraph(text)ParagraphErstellt eine neue Paragraph und hängt sie an, die den angegebenen Textinhalt enthält.
appendTable()TableErstellt eine neue Table und hängt sie an.
appendTable(cells)TableHängt eine neue Table an, die für jeden angegebenen Stringwert eine TableCell enthält.
appendTable(table)TableHängt die angegebene Table an.
clear()HeaderSectionLöscht den Inhalt des Elements.
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)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.
findElement(elementType, from)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit angegeben: RangeElement.
findText(searchPattern)RangeElementSucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElementSucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element im angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab
getImages()InlineImage[]Ruft alle im Abschnitt enthaltenen InlineImages ab.
getListItems()ListItem[]Ruft alle im Abschnitt enthaltenen ListItems ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParagraphs()Paragraph[]Ruft alle im Abschnitt enthaltenen Paragraphs ab (einschließlich ListItems).
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getTables()Table[]Ruft alle im Abschnitt enthaltenen Tables ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentRuft die Textausrichtung ab.
getType()ElementTypeRuft den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt eine neue HorizontalRule und fügt sie im angegebenen Index ein.
insertImage(childIndex, image)InlineImageErstellt und fügt einen InlineImage aus dem angegebenen Bild-BLOB am angegebenen -Index.
insertImage(childIndex, image)InlineImageFügt den angegebenen InlineImage im angegebenen Index ein.
insertListItem(childIndex, listItem)ListItemFügt den angegebenen ListItem im angegebenen Index ein.
insertListItem(childIndex, text)ListItemErstellt eine neue ListItem und fügt sie im angegebenen Index ein, die den angegebenen Index enthält Textinhalt.
insertParagraph(childIndex, paragraph)ParagraphFügt den angegebenen Paragraph im angegebenen Index ein.
insertParagraph(childIndex, text)ParagraphErstellt eine neue Paragraph und fügt sie im angegebenen Index ein, die den angegebenen Index enthält Textinhalt.
insertTable(childIndex)TableErstellt eine neue Table und fügt sie im angegebenen Index ein.
insertTable(childIndex, cells)TableErstellt eine neue Table und fügt sie ein, die die angegebenen Zellen am angegebenen Index enthält.
insertTable(childIndex, table)TableFügt den angegebenen Table im angegebenen Index 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, wobei die reguläre Ausdrücke.
setAttributes(attributes)HeaderSectionLegt die Attribute des Elements fest.
setText(text)HeaderSectionLegt den Inhalt als Nur-Text fest.
setTextAlignment(textAlignment)HeaderSectionLegt die Textausrichtung fest.

HorizontalAlignment

Attribute

AttributTypBeschreibung
LEFTEnumDie Option für die linksbündige Ausrichtung.
CENTEREnumDie Option zur zentrierten Ausrichtung.
RIGHTEnumDie Option zur rechten Ausrichtung.
JUSTIFYEnumDie Option „Justify-Alignment“.

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 von Document befindet.
removeFromParent()HorizontalRuleEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)HorizontalRuleLegt die Attribute des Elements fest.

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 von Document befindet.
merge()InlineDrawingFührt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
removeFromParent()InlineDrawingEntfernt das Element aus dem übergeordneten Element.
setAltDescription(description)InlineDrawingLegt die alternative Beschreibung der Zeichnung fest.
setAltTitle(title)InlineDrawingLegt den alternativen Titel der Zeichnung fest.
setAttributes(attributes)InlineDrawingLegt die Attribute des Elements fest.

InlineImage

Methoden

MethodeRückgabetypKurzbeschreibung
copy()InlineImageGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
getAltDescription()StringGibt die alternative Beschreibung des Bilds zurück.
getAltTitle()StringGibt den alternativen Titel des Bilds zurück.
getAs(contentType)BlobGibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde.
getAttributes()ObjectRuft die Attribute des Elements ab.
getBlob()BlobGibt die Daten in diesem Objekt als Blob zurück.
getHeight()IntegerRuft die Höhe des Bildes in Pixeln ab.
getLinkUrl()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()IntegerRuft die Bildbreite in Pixeln ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende von Document befindet.
merge()InlineImageFührt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
removeFromParent()InlineImageEntfernt das Element aus dem übergeordneten Element.
setAltDescription(description)InlineImageLegt die alternative Beschreibung des Bilds fest.
setAltTitle(title)InlineImageLegt den alternativen Titel des Bilds fest.
setAttributes(attributes)InlineImageLegt die Attribute des Elements fest.
setHeight(height)InlineImageLegt die Höhe des Bildes in Pixeln fest.
setLinkUrl(url)InlineImageLegt die Link-URL fest.
setWidth(width)InlineImageLegt die Breite des Bildes in Pixeln fest.

ListItem

Methoden

MethodeRückgabetypKurzbeschreibung
addPositionedImage(image)PositionedImageErstellt einen neuen PositionedImage und fügt ihn aus dem angegebenen Bild-Blob ein.
appendHorizontalRule()HorizontalRuleErstellt eine neue HorizontalRule und hängt sie an.
appendInlineImage(image)InlineImageErstellt eine neue InlineImage aus dem angegebenen Bild-Blob und hängt sie an.
appendInlineImage(image)InlineImageHängt die angegebene InlineImage an.
appendPageBreak()PageBreakErstellt eine neue PageBreak und hängt sie an.
appendPageBreak(pageBreak)PageBreakHängt die angegebene PageBreak an.
appendText(text)TextErstellt ein neues Text-Element mit dem angegebenen Inhalt und hängt es an.
appendText(text)TextHängt das angegebene Text-Element an.
clear()ListItemLöscht den Inhalt des Elements.
copy()ListItemGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.
findElement(elementType, from)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit angegeben: RangeElement.
findText(searchPattern)RangeElementSucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElementSucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen.
getAlignment()HorizontalAlignmentRuft die HorizontalAlignment ab.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element im 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 den Endeinzug in Punkten ab.
getIndentFirstLine()NumberRuft den Einzug der ersten Zeile in Punkten ab.
getIndentStart()NumberRuft den Einzug am Anfang 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 ein PositionedImage-Objekt anhand der Image-ID ab.
getPositionedImages()PositionedImage[]Ruft alle PositionedImage-Objekte ab, die im Absatz verankert sind.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab
getSpacingAfter()NumberRuft den Abstand nach dem Element in Punkten ab.
getSpacingBefore()NumberRuft den Abstand vor dem Element in Punkten ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentRuft die Textausrichtung ab.
getType()ElementTypeRuft den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt einen HorizontalRule und fügt ihn im angegebenen Index ein.
insertInlineImage(childIndex, image)InlineImageErstellt und fügt einen neuen InlineImage aus dem angegebenen Bild-BLOB am angegebenen -Index.
insertInlineImage(childIndex, image)InlineImageFügt den angegebenen InlineImage im angegebenen Index ein.
insertPageBreak(childIndex)PageBreakErstellt eine neue PageBreak und fügt sie im angegebenen Index ein.
insertPageBreak(childIndex, pageBreak)PageBreakFügt den angegebenen PageBreak im angegebenen Index ein.
insertText(childIndex, text)TextErstellt ein neues Textelement und fügt es im angegebenen Index ein.
insertText(childIndex, text)TextFügt das angegebene Text-Element mit dem angegebenen Text am angegebenen Index ein Inhalte.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende von Document befindet.
isLeftToRight()BooleanRuft die Rechtsläufige Einstellung ab.
merge()ListItemFührt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
removeChild(child)ListItemEntfernt das angegebene untergeordnete Element.
removeFromParent()ListItemEntfernt das Element aus dem übergeordneten Element.
removePositionedImage(id)BooleanEntfernt einen PositionedImage anhand der Image-ID.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke.
setAlignment(alignment)ListItemLegt HorizontalAlignment fest.
setAttributes(attributes)ListItemLegt die Attribute des Elements fest.
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)ListItemLegt die Leserichtung von links nach rechts fest.
setLineSpacing(multiplier)ListItemLegt den Zeilenabstand als Wert fest, der die Anzahl der Zeilen angibt, die für den Zeilenabstand verwendet werden sollen.
setLinkUrl(url)ListItemLegt die Link-URL fest.
setListId(listItem)ListItemLegt die Listen-ID fest.
setNestingLevel(nestingLevel)ListItemLegt die Verschachtelungsebene des Listenelements fest.
setSpacingAfter(spacingAfter)ListItemLegt den Abstand nach dem Element in Punkten fest.
setSpacingBefore(spacingBefore)ListItemLegt den Abstand vor dem Element in Punkten fest.
setText(text)voidLegt den Inhalt des Listenelements als Text fest.
setTextAlignment(textAlignment)ListItemLegt die Textausrichtung fest.

NamedRange

Methoden

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

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 von Document befindet.
removeFromParent()PageBreakEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)PageBreakLegt die Attribute des Elements fest.

Paragraph

Methoden

MethodeRückgabetypKurzbeschreibung
addPositionedImage(image)PositionedImageErstellt einen neuen PositionedImage und fügt ihn aus dem angegebenen Bild-Blob ein.
appendHorizontalRule()HorizontalRuleErstellt eine neue HorizontalRule und hängt sie an.
appendInlineImage(image)InlineImageErstellt eine neue InlineImage aus dem angegebenen Bild-Blob und hängt sie an.
appendInlineImage(image)InlineImageHängt die angegebene InlineImage an.
appendPageBreak()PageBreakErstellt eine neue PageBreak und hängt sie an.
appendPageBreak(pageBreak)PageBreakHängt die angegebene PageBreak an.
appendText(text)TextErstellt ein neues Text-Element mit dem angegebenen Inhalt und hängt es an.
appendText(text)TextHängt das angegebene Text-Element an.
clear()ParagraphLöscht den Inhalt des Elements.
copy()ParagraphGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.
findElement(elementType, from)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit angegeben: RangeElement.
findText(searchPattern)RangeElementSucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElementSucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen.
getAlignment()HorizontalAlignmentRuft die HorizontalAlignment ab.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element im angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab
getHeading()ParagraphHeadingRuft die ParagraphHeading ab.
getIndentEnd()NumberRuft den Endeinzug in Punkten ab.
getIndentFirstLine()NumberRuft den Einzug der ersten Zeile in Punkten ab.
getIndentStart()NumberRuft den Einzug am Anfang 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 ein PositionedImage-Objekt anhand der Image-ID ab.
getPositionedImages()PositionedImage[]Ruft alle PositionedImage-Objekte ab, die im Absatz verankert sind.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab
getSpacingAfter()NumberRuft den Abstand nach dem Element in Punkten ab.
getSpacingBefore()NumberRuft den Abstand vor dem Element in Punkten ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentRuft die Textausrichtung ab.
getType()ElementTypeRuft den ElementType des Elements ab.
insertHorizontalRule(childIndex)HorizontalRuleErstellt einen HorizontalRule und fügt ihn im angegebenen Index ein.
insertInlineImage(childIndex, image)InlineImageErstellt und fügt einen neuen InlineImage aus dem angegebenen Bild-BLOB am angegebenen -Index.
insertInlineImage(childIndex, image)InlineImageFügt den angegebenen InlineImage im angegebenen Index ein.
insertPageBreak(childIndex)PageBreakErstellt eine neue PageBreak und fügt sie im angegebenen Index ein.
insertPageBreak(childIndex, pageBreak)PageBreakFügt den angegebenen PageBreak im angegebenen Index ein.
insertText(childIndex, text)TextErstellt ein neues Textelement und fügt es im angegebenen Index ein.
insertText(childIndex, text)TextFügt das angegebene Text-Element mit dem angegebenen Text am angegebenen Index ein Inhalte.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende von Document befindet.
isLeftToRight()BooleanRuft die Rechtsläufige Einstellung ab.
merge()ParagraphFührt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
removeChild(child)ParagraphEntfernt das angegebene untergeordnete Element.
removeFromParent()ParagraphEntfernt das Element aus dem übergeordneten Element.
removePositionedImage(id)BooleanEntfernt einen PositionedImage anhand der Image-ID.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke.
setAlignment(alignment)ParagraphLegt HorizontalAlignment fest.
setAttributes(attributes)ParagraphLegt die Attribute des Elements fest.
setHeading(heading)ParagraphLegt ParagraphHeading fest.
setIndentEnd(indentEnd)ParagraphLegt den Einzug am Ende in Punkten fest.
setIndentFirstLine(indentFirstLine)ParagraphLegt den Einzug der ersten Zeile in Punkten fest.
setIndentStart(indentStart)ParagraphLegt den Einzug am Anfang in Punkten fest.
setLeftToRight(leftToRight)ParagraphLegt die Leserichtung von links nach rechts fest.
setLineSpacing(multiplier)ParagraphLegt den Zeilenabstand als Wert fest, der die Anzahl der Zeilen angibt, die für den Zeilenabstand 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)voidLegt den Inhalt des Absatzes als Text fest.
setTextAlignment(textAlignment)ParagraphLegt die Textausrichtung fest.

ParagraphHeading

Attribute

AttributTypBeschreibung
NORMALEnumDie Überschriftsoption für normalen Text.
HEADING1EnumDie Option für die höchste Überschrift.
HEADING2EnumDie zweite Option für die Überschrift.
HEADING3EnumMit der dritten Option
HEADING4EnumDie vierte Überschrift.
HEADING5EnumDie fünfte Überschriftsoption.
HEADING6EnumDie unterste Überschriftsoption.
TITLEEnumDie Option für die Überschrift.
SUBTITLEEnumDie Option für die Untertitelüberschrift.

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 von Document befindet.
merge()PersonFührt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
removeFromParent()PersonEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)PersonLegt die Attribute des Elements fest.

Position

Methoden

MethodeRückgabetypKurzbeschreibung
getElement()ElementRuft das Element ab, das diese Position enthält.
getOffset()IntegerRuft die relative Position von Position innerhalb des Elements ab, das sie enthält.
getSurroundingText()TextErstellt ein künstliches Text-Element, das den Text und die Formatierung des Paragraph oder ListItem, die das Position enthalten, entweder direkt oder über eine Kette von untergeordneten Elementen.
getSurroundingTextOffset()IntegerRuft den Versatz von Position innerhalb des Text-Elements ab, das von getSurroundingText() zurückgegeben wird.
insertBookmark()BookmarkErstellt eine neue Bookmark und fügt sie an dieser Position ein.
insertInlineImage(image)InlineImageErstellt eine neue InlineImage und fügt sie an dieser Position aus dem angegebenen Bild ein Blob.
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, das in den angegebenen Inhaltstyp konvertiert wurde.
getBlob()BlobGibt die Daten in diesem Objekt als Blob zurück.
getHeight()IntegerRuft die Höhe des Bildes in Pixeln ab.
getId()StringRuft die Image-ID ab.
getLayout()PositionedLayoutRuft einen enum-Wert ab, der das Layout des Bildes darstellt.
getLeftOffset()NumberRuft den Bildversatz in Punkten vom linken Absatzrand ab.
getParagraph()ParagraphRuft den Paragraph ab, an dem das Bild verankert ist.
getTopOffset()NumberRuft den Versatz des Bildes in Punkten vom oberen Absatzrand ab.
getWidth()IntegerRuft die Bildbreite in Pixeln ab.
setHeight(height)PositionedImageLegt die Höhe des Bildes in Pixeln fest.
setLayout(layout)PositionedImageLegt die Definition für das Layout des Bildes fest.
setLeftOffset(offset)PositionedImageLegt den Bildversatz in Punkten vom linken Absatzrand fest
setTopOffset(offset)PositionedImageLegt den Versatz des Bildes in Punkten vom oberen Absatzrand fest.
setWidth(width)PositionedImageLegt die Breite des Bildes in Pixeln fest.

PositionedLayout

Attribute

AttributTypBeschreibung
ABOVE_TEXTEnumDas Bild wird über dem Text positioniert.
BREAK_BOTHEnumDurch das Bild wird der Text links und rechts umgebrochen.
BREAK_LEFTEnumDurch das Bild wird der Text auf der linken Seite unterbrochen.
BREAK_RIGHTEnumDurch das Bild wird der Text auf der rechten Seite unterbrochen.
WRAP_TEXTEnumDas Bild wird von Text umschlossen.

Range

Methoden

MethodeRückgabetypKurzbeschreibung
getRangeElements()RangeElement[]Ruft alle Elemente in dieser Range ab, einschließlich jeglicher Text-Teilelemente (z. B. im Fall von einer Auswahl, die nur einen Teil eines Text-Elements enthält).

RangeBuilder

Methoden

MethodeRückgabetypKurzbeschreibung
addElement(element)RangeBuilderFügt diesem RangeBuilder einen vollständigen Element hinzu.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderFügt dieser RangeBuilder ein unvollständiges Text-Element hinzu.
addElementsBetween(startElement, endElementInclusive)RangeBuilderFügt zwei ganze Elemente und alle Elemente dazwischen zu diesem RangeBuilder hinzu.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderFügt zwei partielle Text-Elemente und alle Elemente dazwischen zum RangeBuilder hinzu.
addRange(range)RangeBuilderFügt den Inhalt eines anderen Range zu diesem RangeBuilder hinzu.
build()RangeErstellt ein Range aus den Einstellungen, die auf den Builder angewendet wurden.
getRangeElements()RangeElement[]Ruft alle Elemente in dieser Range ab, einschließlich jeglicher Text-Teilelemente (z. B. im Fall von einer Auswahl, die nur einen Teil eines Text-Elements enthält).

RangeElement

Methoden

MethodeRückgabetypKurzbeschreibung
getElement()ElementRuft die Element ab, die dieser RangeElement entspricht.
getEndOffsetInclusive()IntegerRuft die Position des Endes eines Teilbereichs innerhalb des Bereichselements ab.
getStartOffset()IntegerRuft die Position des Anfangs eines Teilbereichs innerhalb des Bereichselements ab.
isPartial()BooleanBestimmt, ob dieses Bereichselement das gesamte Element abdeckt oder eine Teilauswahl des Elements Zeichen des Elements enthält.

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 von den Link, der verfügbar ist, wenn das Element ein Link zu einer Drive-Datei und null ist sonst.
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()StringGibt den angezeigten Titel des Links zurück.
getType()ElementTypeRuft den ElementType des Elements ab.
getUrl()StringGibt die URL der Ressource zurück.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende von Document befindet.
merge()RichLinkFührt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
removeFromParent()RichLinkEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)RichLinkLegt die Attribute des Elements fest.

Tab

Methoden

MethodeRückgabetypKurzbeschreibung
asDocumentTab()DocumentTabRuft den Tabinhalt als DocumentTab ab.
getChildTabs()Tab[]Ruft die in diesem Tab verschachtelten untergeordneten Tabs ab.
getId()StringRuft die ID des Tabs ab.
getIndex()IntegerRuft den 0-basierten Index des Tabs innerhalb des übergeordneten Elements ab.
getTitle()StringRuft den Titel des Tabs ab.
getType()TabTypeRuft den Tab-Typ ab.

TabType

Attribute

AttributTypBeschreibung
DOCUMENT_TABEnumDer Typ, der DocumentTab entspricht.

Table

Methoden

MethodeRückgabetypKurzbeschreibung
appendTableRow()TableRowErstellt eine neue TableRow und hängt sie an.
appendTableRow(tableRow)TableRowHängt die angegebene TableRow an.
clear()TableLöscht den Inhalt des Elements.
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)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.
findElement(elementType, from)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit angegeben: RangeElement.
findText(searchPattern)RangeElementSucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElementSucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen.
getAttributes()ObjectRuft die Attribute des Elements ab.
getBorderColor()StringRuft die Rahmenfarbe ab.
getBorderWidth()NumberRuft die Rahmenbreite in Punkten ab.
getCell(rowIndex, cellIndex)TableCellRuft den TableCell an den angegebenen Zeilen- und Zellenindexen ab.
getChild(childIndex)ElementRuft das untergeordnete Element im 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 von 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()TextAlignmentRuft die Textausrichtung ab.
getType()ElementTypeRuft den ElementType des Elements ab.
insertTableRow(childIndex)TableRowErstellt eine neue TableRow und fügt sie im angegebenen Index ein.
insertTableRow(childIndex, tableRow)TableRowFügt den angegebenen TableRow im angegebenen Index ein.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende von Document befindet.
removeChild(child)TableEntfernt das angegebene untergeordnete Element.
removeFromParent()TableEntfernt das Element aus dem übergeordneten Element.
removeRow(rowIndex)TableRowEntfernt die TableRow am angegebenen Zeilenindex.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke.
setAttributes(attributes)TableLegt die Attribute des Elements fest.
setBorderColor(color)TableLegt die Rahmenfarbe fest.
setBorderWidth(width)TableLegt die Rahmenbreite in Punkten fest.
setColumnWidth(columnIndex, width)TableLegt die Breite der angegebenen Spalte in Punkten fest.
setLinkUrl(url)TableLegt die Link-URL fest.
setTextAlignment(textAlignment)TableLegt die Textausrichtung fest.

TableCell

Methoden

MethodeRückgabetypKurzbeschreibung
appendHorizontalRule()HorizontalRuleErstellt eine neue HorizontalRule und hängt sie an.
appendImage(image)InlineImageErstellt eine neue InlineImage aus dem angegebenen Bild-Blob und hängt sie an.
appendImage(image)InlineImageHängt die angegebene InlineImage an.
appendListItem(listItem)ListItemHängt die angegebene ListItem an.
appendListItem(text)ListItemErstellt eine neue ListItem und hängt sie an.
appendParagraph(paragraph)ParagraphHängt die angegebene Paragraph an.
appendParagraph(text)ParagraphErstellt eine neue Paragraph und hängt sie an.
appendTable()TableErstellt eine neue Table und hängt sie an.
appendTable(cells)TableHängt eine neue Table an, die die angegebenen Zellen enthält.
appendTable(table)TableHängt die angegebene Table an.
clear()TableCellLöscht den Inhalt des Elements.
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)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.
findElement(elementType, from)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit angegeben: RangeElement.
findText(searchPattern)RangeElementSucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElementSucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen.
getAttributes()ObjectRuft die Attribute des Elements ab.
getBackgroundColor()StringRuft die Hintergrundfarbe ab.
getChild(childIndex)ElementRuft das untergeordnete Element im angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab
getColSpan()IntegerRuft den Spaltenbereich 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 unteren Abstand in Punkten ab.
getPaddingLeft()NumberRuft den linken Abstand in Punkten ab.
getPaddingRight()NumberRuft den richtigen Abstand in Punkten ab.
getPaddingTop()NumberRuft den oberen Abstand in Punkten ab
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getParentRow()TableRowRuft die TableRow mit dem aktuellen TableCell ab.
getParentTable()TableRuft die Table mit dem aktuellen TableCell ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab
getRowSpan()IntegerRuft den Zeilenbereich ab, also die Anzahl der Zeilen von Tabellenzellen, die diese Zelle umfasst.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentRuft die Textausrichtung ab.
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 eine neue HorizontalRule und fügt sie im angegebenen Index ein.
insertImage(childIndex, image)InlineImageErstellt und fügt einen InlineImage aus dem angegebenen Bild-BLOB am angegebenen -Index.
insertImage(childIndex, image)InlineImageFügt den angegebenen InlineImage im angegebenen Index ein.
insertListItem(childIndex, listItem)ListItemFügt den angegebenen ListItem im angegebenen Index ein.
insertListItem(childIndex, text)ListItemErstellt eine neue ListItem und fügt sie im angegebenen Index ein.
insertParagraph(childIndex, paragraph)ParagraphFügt den angegebenen Paragraph im angegebenen Index ein.
insertParagraph(childIndex, text)ParagraphErstellt eine neue Paragraph und fügt sie im angegebenen Index ein.
insertTable(childIndex)TableErstellt eine neue Table und fügt sie im angegebenen Index ein.
insertTable(childIndex, cells)TableErstellt eine neue Table und fügt sie ein, die die angegebenen Zellen am angegebenen Index enthält.
insertTable(childIndex, table)TableFügt den angegebenen Table im angegebenen Index ein.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende von Document befindet.
merge()TableCellFührt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
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, wobei die reguläre Ausdrücke.
setAttributes(attributes)TableCellLegt die Attribute des Elements fest.
setBackgroundColor(color)TableCellLegt die Hintergrundfarbe fest.
setLinkUrl(url)TableCellLegt die Link-URL fest.
setPaddingBottom(paddingBottom)TableCellLegt den unteren Abstand in Punkten fest.
setPaddingLeft(paddingLeft)TableCellLegt den linken Abstand in Punkten fest.
setPaddingRight(paddingRight)TableCellLegt den richtigen Abstand in Punkten fest.
setPaddingTop(paddingTop)TableCellLegt den oberen Abstand in Punkten fest.
setText(text)TableCellLegt den Inhalt als Nur-Text fest.
setTextAlignment(textAlignment)TableCellLegt die Textausrichtung fest.
setVerticalAlignment(alignment)TableCellLegt die vertikale Ausrichtung fest.
setWidth(width)TableCellLegt die Breite der Spalte mit der aktuellen Zelle in Punkten fest.

TableOfContents

Methoden

MethodeRückgabetypKurzbeschreibung
clear()TableOfContentsLöscht den Inhalt des Elements.
copy()TableOfContentsGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findElement(elementType)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.
findElement(elementType, from)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit angegeben: RangeElement.
findText(searchPattern)RangeElementSucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElementSucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element im 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()TextAlignmentRuft die Textausrichtung ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende von Document befindet.
removeFromParent()TableOfContentsEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke.
setAttributes(attributes)TableOfContentsLegt die Attribute des Elements fest.
setLinkUrl(url)TableOfContentsLegt die Link-URL fest.
setTextAlignment(textAlignment)TableOfContentsLegt die Textausrichtung fest.

TableRow

Methoden

MethodeRückgabetypKurzbeschreibung
appendTableCell()TableCellErstellt eine neue TableCell und hängt sie an.
appendTableCell(textContents)TableCellHängt die angegebene TableCell an, die den angegebenen Text enthält.
appendTableCell(tableCell)TableCellHängt die angegebene TableCell an.
clear()TableRowLöscht den Inhalt des Elements.
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)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.
findElement(elementType, from)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit angegeben: RangeElement.
findText(searchPattern)RangeElementSucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElementSucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen.
getAttributes()ObjectRuft die Attribute des Elements ab.
getCell(cellIndex)TableCellRuft die TableCell am angegebenen Zellenindex ab.
getChild(childIndex)ElementRuft das untergeordnete Element im angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab
getLinkUrl()StringRuft die Link-URL ab.
getMinimumHeight()NumberRuft die Mindesthöhe in Punkten ab.
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()TextAlignmentRuft die Textausrichtung ab.
getType()ElementTypeRuft den ElementType des Elements ab.
insertTableCell(childIndex)TableCellErstellt eine neue TableCell und fügt sie im angegebenen Index ein.
insertTableCell(childIndex, textContents)TableCellFügt den angegebenen TableCell-Wert im angegebenen Index ein, der den angegebenen Text enthält.
insertTableCell(childIndex, tableCell)TableCellFügt den angegebenen TableCell im angegebenen Index ein.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende von Document befindet.
merge()TableRowFührt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
removeCell(cellIndex)TableCellEntfernt die TableCell am angegebenen Zellenindex.
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, wobei die reguläre Ausdrücke.
setAttributes(attributes)TableRowLegt die Attribute des Elements fest.
setLinkUrl(url)TableRowLegt die Link-URL fest.
setMinimumHeight(minHeight)TableRowLegt die Mindesthöhe in Punkten fest.
setTextAlignment(textAlignment)TableRowLegt die Textausrichtung fest.

Text

Methoden

MethodeRückgabetypKurzbeschreibung
appendText(text)TextFügt den angegebenen Text am Ende dieses Textbereichs hinzu.
copy()TextGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
deleteText(startOffset, endOffsetInclusive)TextLöscht einen Textbereich.
editAsText()TextRuft eine Text-Version des aktuellen Elements zur Bearbeitung ab.
findText(searchPattern)RangeElementSucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElementSucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen.
getAttributes()ObjectRuft die Attribute des Elements ab.
getAttributes(offset)ObjectRuft die Attribute beim angegebenen Zeichenoffset ab.
getBackgroundColor()StringRuft die Einstellung für die Hintergrundfarbe ab.
getBackgroundColor(offset)StringRuft die Hintergrundfarbe beim angegebenen Zeichenoffset ab.
getFontFamily()StringRuft die Einstellung der 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 Farbeinstellung im Vordergrund ab.
getForegroundColor(offset)StringRuft die Vordergrundfarbe beim 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()TextAlignmentRuft die Textausrichtung ab.
getTextAlignment(offset)TextAlignmentRuft die Textausrichtung für ein einzelnes Zeichen ab.
getTextAttributeIndices()Integer[]Ruft den Satz von Textindexen ab, die dem Anfang der eindeutigen Textformatierung entsprechen ausgeführt wird.
getType()ElementTypeRuft den ElementType des Elements ab.
insertText(offset, text)TextFügt den angegebenen Text an der angegebenen Zeichenposition ein.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende von Document befindet.
isBold()BooleanRuft die Einstellung für Fettformatierung ab.
isBold(offset)BooleanRuft die Fettdruck-Einstellung beim angegebenen Zeichenoffset ab.
isItalic()BooleanRuft die Einstellung für Kursivschrift ab.
isItalic(offset)BooleanRuft die Kursivformatierung beim angegebenen Zeichenoffset ab.
isStrikethrough()BooleanRuft die Einstellung für das Durchstreichen ab.
isStrikethrough(offset)BooleanRuft die Einstellung für das Durchstreichen beim angegebenen Zeichenoffset ab.
isUnderline()BooleanRuft die Unterstreichungseinstellung ab.
isUnderline(offset)BooleanRuft die Unterstreichungseinstellung am angegebenen Zeichenoffset ab.
merge()TextFührt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
removeFromParent()TextEntfernt das Element aus dem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke.
setAttributes(startOffset, endOffsetInclusive, attributes)TextWendet die angegebenen Attribute auf den angegebenen Zeichenbereich an.
setAttributes(attributes)TextLegt die Attribute des Elements fest.
setBackgroundColor(startOffset, endOffsetInclusive, color)TextLegt die Hintergrundfarbe für den angegebenen Zeichenbereich fest.
setBackgroundColor(color)TextLegt die Hintergrundfarbe fest.
setBold(bold)TextLegt die Fettdruck-Einstellung fest.
setBold(startOffset, endOffsetInclusive, bold)TextLegt die Fettdruck-Einstellung für den angegebenen Zeichenbereich fest.
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)TextLegt die Schriftfamilie für den angegebenen Zeichenbereich fest.
setFontFamily(fontFamilyName)TextHiermit wird die Schriftfamilie festgelegt.
setFontSize(startOffset, endOffsetInclusive, size)TextLegt die Schriftgröße für den angegebenen Zeichenbereich fest.
setFontSize(size)TextLegt die Schriftgröße fest.
setForegroundColor(startOffset, endOffsetInclusive, color)TextLegt die Vordergrundfarbe für den angegebenen Zeichenbereich fest.
setForegroundColor(color)TextLegt die Vordergrundfarbe fest.
setItalic(italic)TextLegt die Kursivformatierung fest.
setItalic(startOffset, endOffsetInclusive, italic)TextLegt die Kursivformatierung für den angegebenen Zeichenbereich fest.
setLinkUrl(startOffset, endOffsetInclusive, url)TextLegt die Link-URL für den angegebenen Zeichenbereich fest.
setLinkUrl(url)TextLegt die Link-URL fest.
setStrikethrough(strikethrough)TextLegt die Einstellung für das Durchstreichen fest.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)TextLegt die durchgestrichene Einstellung für den angegebenen Zeichenbereich fest.
setText(text)TextLegt den Textinhalt fest.
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)TextLegt die Textausrichtung für einen bestimmten Zeichenbereich fest.
setTextAlignment(textAlignment)TextLegt die Textausrichtung fest.
setUnderline(underline)TextLegt die Unterstreichungseinstellung fest.
setUnderline(startOffset, endOffsetInclusive, underline)TextLegt die Unterstreichungseinstellung für den angegebenen Zeichenbereich fest.

TextAlignment

Attribute

AttributTypBeschreibung
NORMALEnumDie normale Textausrichtung.
SUPERSCRIPTEnumAusrichtung des hochgestellten Textes
SUBSCRIPTEnumAusrichtung des tiefgestellten Textes.

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 von Document befindet.
merge()UnsupportedElementFührt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
removeFromParent()UnsupportedElementEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)UnsupportedElementLegt die Attribute des Elements fest.

VerticalAlignment

Attribute

AttributTypBeschreibung
BOTTOMEnumDie Option zur unteren Ausrichtung.
CENTEREnumDie Option zur zentrierten Ausrichtung.
TOPEnumDie Option "Oben ausrichten".