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
Name | Kurzbeschreibung |
---|---|
Attribute | Eine Aufzählung der Elementattribute. |
Body | Der Inhalt eines Tabs in einem Google Docs-Dokument. |
Bookmark | Ein Objekt, das ein Lesezeichen darstellt. |
ContainerElement | Ein generisches Element, das andere Elemente enthalten kann. |
Date | Ein Element, das ein formatiertes Datum darstellt |
Document | Ein Dokument mit einem oder mehreren Tab -Objekten, die jeweils RTF- und
wie Tabellen und Listen. |
DocumentApp | Der Dokumentdienst erstellt und öffnet Documents -Dateien, die bearbeitet werden können. |
DocumentTab | Ein Dokument-Tab, der RTF und Elemente wie Tabellen und Listen enthält. |
Element | Ein generisches Element. |
ElementType | Eine Aufzählung aller Elementtypen. |
Equation | Ein Element, das einen mathematischen Ausdruck darstellt. |
EquationFunction | Ein Element, das eine Funktion in einem mathematischen Equation darstellt. |
EquationFunctionArgumentSeparator | Ein Element, das ein Funktionstrennzeichen in einem mathematischen Equation darstellt. |
EquationSymbol | Ein Element, das ein Symbol in einem mathematischen Equation darstellt. |
| Eine Aufzählung der unterstützten Schriftarten. |
FooterSection | Ein Element, das einen Fußzeilenbereich darstellt. |
Footnote | Ein Element, das eine Fußnote darstellt. |
FootnoteSection | Ein -Element, das einen Fußnotenbereich darstellt. |
GlyphType | Eine Aufzählung der unterstützten Glyphentypen. |
HeaderSection | Ein Element, das einen Kopfzeilenbereich darstellt. |
HorizontalAlignment | Eine Aufzählung der unterstützten Typen für die horizontale Ausrichtung. |
HorizontalRule | Ein Element, das eine horizontale Regel darstellt. |
InlineDrawing | Ein Element, das eine eingebettete Zeichnung darstellt. |
InlineImage | Ein Element, das ein eingebettetes Bild darstellt. |
ListItem | Ein Element, das ein Listenelement darstellt. |
NamedRange | Ein Range mit einem Namen und einer ID, die einen späteren Abruf ermöglichen. |
PageBreak | Ein Element, das einen Seitenumbruch darstellt. |
Paragraph | Ein Element, das einen Absatz darstellt. |
ParagraphHeading | Eine Aufzählung der Standardabsatzüberschriften. |
Person | Ein Element, das einen Link zu einer Person darstellt. |
Position | Ein Verweis auf eine Position auf dem Dokument-Tab, in Bezug auf ein bestimmtes Element. |
PositionedImage | Bild mit fester Position, verankert an Paragraph . |
PositionedLayout | Eine Aufzählung, die angibt, wie ein PositionedImage im Verhältnis zur umgebenden Umgebung angeordnet wird
Text. |
Range | Ein Bereich von Elementen in einem Dokument. |
RangeBuilder | Ein Builder, der zum Erstellen von Range -Objekten aus Dokumentelementen verwendet wird. |
RangeElement | Ein Wrapper um ein Element mit einem möglichen Start- und Endversatz. |
RichLink | Ein Element, das einen Link zu einer Google-Ressource darstellt, z. B. zu einer Drive-Datei oder einem YouTube-Video. |
Tab | Ein Tab in einem Google Docs-Dokument. |
TabType | Eine Aufzählung aller Tabtypen. |
Table | Ein Element, das eine Tabelle darstellt. |
TableCell | Ein Element, das eine Tabellenzelle darstellt. |
TableOfContents | Ein Element, das ein Inhaltsverzeichnis enthält. |
TableRow | Ein Element, das eine Tabellenzeile darstellt. |
Text | Ein Element, das einen RTF-Bereich darstellt. |
TextAlignment | Eine Aufzählung der Art der Textausrichtungen. |
UnsupportedElement | Ein Element, das eine Region darstellt, die unbekannt ist oder nicht von einem Skript beeinflusst werden kann, z. B. ein Seitennummer. |
VerticalAlignment | Eine Aufzählung der unterstützten vertikalen Ausrichtungstypen. |
Attribute
Attribute
Attribut | Typ | Beschreibung |
---|---|---|
BACKGROUND_COLOR | Enum | Die Hintergrundfarbe eines Elements (Absatz, Tabelle usw.) oder Dokument. |
BOLD | Enum | Die Einstellung der Schriftstärke für RTF |
BORDER_COLOR | Enum | Die Rahmenfarbe für Tabellenelemente. |
BORDER_WIDTH | Enum | Die Rahmenbreite in Punkten für Tabellenelemente. |
CODE | Enum | Der Codeinhalt für Gleichungselemente. |
FONT_FAMILY | Enum | Die Einstellung der Schriftfamilie für RTF |
FONT_SIZE | Enum | Die Einstellung der Schriftgröße in Punkten, bei RTF. |
FOREGROUND_COLOR | Enum | Die Vordergrundfarbe für RTF |
HEADING | Enum | Der Überschriftentyp für Absatzelemente (z. B. DocumentApp.ParagraphHeading.HEADING1 ). |
HEIGHT | Enum | Die Höheneinstellung für Bildelemente. |
HORIZONTAL_ALIGNMENT | Enum | Die horizontale Ausrichtung für Absatzelemente (z. B. DocumentApp.HorizontalAlignment.CENTER ). |
INDENT_END | Enum | Die Einstellung für den Endeinzug in Punkten bei Absatzelementen. |
INDENT_FIRST_LINE | Enum | Die Einstellung für den Einzug der ersten Zeile in Punkten bei Absatzelementen. |
INDENT_START | Enum | Die Einstellung für den Einzug am Anfang in Punkten für Absatzelemente. |
ITALIC | Enum | Die Schriftstileinstellung für RTF. |
GLYPH_TYPE | Enum | Der Glyphentyp für Listenelementelemente. |
LEFT_TO_RIGHT | Enum | Die Einstellung für die Textrichtung bei RTF. |
LINE_SPACING | Enum | Die Einstellung des Zeilenabstands als Multiplikator für Absatzelemente. |
LINK_URL | Enum | Die Link-URL für Rich Text. |
LIST_ID | Enum | Die ID der einschließenden Liste für Listenelementelemente. |
MARGIN_BOTTOM | Enum | Die Einstellung für den unteren Rand in Punkten bei Absatzelementen. |
MARGIN_LEFT | Enum | Die Einstellung für den linken Rand in Punkten bei Absatzelementen. |
MARGIN_RIGHT | Enum | Die Einstellung für den rechten Rand in Punkten bei Absatzelementen. |
MARGIN_TOP | Enum | Die Einstellung für den oberen Rand in Punkten bei Absatzelementen. |
NESTING_LEVEL | Enum | Die Verschachtelungsebene der Elemente für Listenelementelemente. |
MINIMUM_HEIGHT | Enum | Die Einstellung für die minimale Höhe in Punkten für Tabellenzeilenelemente. |
PADDING_BOTTOM | Enum | Die untere Abstandseinstellung in Punkten für Tabellenzellenelemente. |
PADDING_LEFT | Enum | Die linke Abstandseinstellung in Punkten für Tabellenzellenelemente. |
PADDING_RIGHT | Enum | Die richtige Einstellung für den Abstand in Punkten bei Tabellenzellenelementen. |
PADDING_TOP | Enum | Die obere Abstandseinstellung in Punkten für Tabellenzellenelemente. |
PAGE_HEIGHT | Enum | Die Seitenhöheneinstellung in Punkten für Dokumente. |
PAGE_WIDTH | Enum | Die Einstellung der Seitenbreite in Punkten für Dokumente. |
SPACING_AFTER | Enum | Die Abstandseinstellung unten in Punkten bei Absatzelementen. |
SPACING_BEFORE | Enum | Der obere Abstand in Punkten bei Absatzelementen. |
STRIKETHROUGH | Enum | Durchgestrichen-Einstellung für RTF |
UNDERLINE | Enum | Unterstrichen (RTF) |
VERTICAL_ALIGNMENT | Enum | Die vertikale Ausrichtung für Elemente von Tabellenzellen. |
WIDTH | Enum | Die Breiteneinstellung für Tabellenzellen- und Bildelemente. |
Body
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
appendHorizontalRule() | HorizontalRule | Erstellt eine neue HorizontalRule und hängt sie an. |
appendImage(image) | InlineImage | Erstellt eine neue InlineImage aus dem angegebenen Bild-Blob und hängt sie an. |
appendImage(image) | InlineImage | Hängt die angegebene InlineImage an. |
appendListItem(listItem) | ListItem | Hängt die angegebene ListItem an. |
appendListItem(text) | ListItem | Erstellt eine neue ListItem und hängt sie an, die den angegebenen Textinhalt enthält. |
appendPageBreak() | PageBreak | Erstellt eine neue PageBreak und hängt sie an. |
appendPageBreak(pageBreak) | PageBreak | Hängt die angegebene PageBreak an. |
appendParagraph(paragraph) | Paragraph | Hängt die angegebene Paragraph an. |
appendParagraph(text) | Paragraph | Erstellt eine neue Paragraph und hängt sie an, die den angegebenen Textinhalt enthält. |
appendTable() | Table | Erstellt eine neue Table und hängt sie an. |
appendTable(cells) | Table | Hängt eine neue Table an, die für jeden angegebenen Stringwert eine TableCell enthält. |
appendTable(table) | Table | Hängt die angegebene Table an. |
clear() | Body | Löscht den Inhalt des Elements. |
copy() | Body | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
editAsText() | Text | Ruft eine Text -Version des aktuellen Elements zur Bearbeitung ab. |
findElement(elementType) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs. |
findElement(elementType, from) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit
angegeben: RangeElement . |
findText(searchPattern) | RangeElement | Sucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster. |
findText(searchPattern, from) | RangeElement | Sucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getChild(childIndex) | Element | Ruft das untergeordnete Element im angegebenen untergeordneten Index ab. |
getChildIndex(child) | Integer | Ruft den untergeordneten Index für das angegebene untergeordnete Element ab |
getHeadingAttributes(paragraphHeading) | Object | Ruft 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() | Number | Ruft den unteren Rand in Punkten ab. |
getMarginLeft() | Number | Ruft den linken Rand in Punkten ab. |
getMarginRight() | Number | Ruft den rechten Rand ab. |
getMarginTop() | Number | Ruft den oberen Rand ab. |
getNumChildren() | Integer | Ruft die Anzahl der untergeordneten Elemente ab. |
getPageHeight() | Number | Ruft die Seitenhöhe in Punkten ab. |
getPageWidth() | Number | Ruft die Seitenbreite in Punkten ab. |
getParagraphs() | Paragraph[] | Ruft alle im Abschnitt enthaltenen Paragraphs ab (einschließlich ListItems ). |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getTables() | Table[] | Ruft alle im Abschnitt enthaltenen Tables ab. |
getText() | String | Ruft den Inhalt des Elements als Textstring ab. |
getTextAlignment() | TextAlignment | Ruft die Textausrichtung ab. |
getType() | ElementType | Ruft den ElementType des Elements ab. |
insertHorizontalRule(childIndex) | HorizontalRule | Erstellt eine neue HorizontalRule und fügt sie im angegebenen Index ein. |
insertImage(childIndex, image) | InlineImage | Erstellt und fügt einen InlineImage aus dem angegebenen Bild-BLOB am angegebenen
-Index. |
insertImage(childIndex, image) | InlineImage | Fügt den angegebenen InlineImage im angegebenen Index ein. |
insertListItem(childIndex, listItem) | ListItem | Fügt den angegebenen ListItem im angegebenen Index ein. |
insertListItem(childIndex, text) | ListItem | Erstellt eine neue ListItem und fügt sie im angegebenen Index ein, die den angegebenen Index enthält
Textinhalt. |
insertPageBreak(childIndex) | PageBreak | Erstellt eine neue PageBreak und fügt sie im angegebenen Index ein. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Fügt den angegebenen PageBreak im angegebenen Index ein. |
insertParagraph(childIndex, paragraph) | Paragraph | Fügt den angegebenen Paragraph im angegebenen Index ein. |
insertParagraph(childIndex, text) | Paragraph | Erstellt eine neue Paragraph und fügt sie im angegebenen Index ein, die den angegebenen Index enthält
Textinhalt. |
insertTable(childIndex) | Table | Erstellt eine neue Table und fügt sie im angegebenen Index ein. |
insertTable(childIndex, cells) | Table | Erstellt eine neue Table und fügt sie ein, die die angegebenen Zellen am angegebenen Index enthält. |
insertTable(childIndex, table) | Table | Fügt den angegebenen Table im angegebenen Index ein. |
removeChild(child) | Body | Entfernt das angegebene untergeordnete Element. |
replaceText(searchPattern, replacement) | Element | Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke. |
setAttributes(attributes) | Body | Legt die Attribute des Elements fest. |
setHeadingAttributes(paragraphHeading, attributes) | Body | Legt die Attribute für die angegebenen ParagraphHeading fest. |
setMarginBottom(marginBottom) | Body | Legt den unteren Rand in Punkten fest. |
setMarginLeft(marginLeft) | Body | Legt den linken Rand in Punkten fest. |
setMarginRight(marginRight) | Body | Legt den rechten Rand in Punkten fest. |
setMarginTop(marginTop) | Body | Legt den oberen Rand fest. |
setPageHeight(pageHeight) | Body | Legt die Seitenhöhe in Punkten fest. |
setPageWidth(pageWidth) | Body | Legt die Seitenbreite in Punkten fest. |
setText(text) | Body | Legt den Inhalt als Nur-Text fest. |
setTextAlignment(textAlignment) | Body | Legt die Textausrichtung fest. |
Bookmark
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
getId() | String | Ruft die ID von Bookmark ab. |
getPosition() | Position | Ruft den Position von Bookmark innerhalb von DocumentTab ab. |
remove() | void | Löscht Bookmark . |
ContainerElement
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
asBody() | Body | Gibt das aktuelle Element als Body zurück. |
asEquation() | Equation | Gibt das aktuelle Element als Equation zurück. |
asFooterSection() | FooterSection | Gibt das aktuelle Element als FooterSection zurück. |
asFootnoteSection() | FootnoteSection | Gibt das aktuelle Element als FootnoteSection zurück. |
asHeaderSection() | HeaderSection | Gibt das aktuelle Element als HeaderSection zurück. |
asListItem() | ListItem | Gibt das aktuelle Element als ListItem zurück. |
asParagraph() | Paragraph | Gibt das aktuelle Element als Paragraph zurück. |
asTable() | Table | Gibt das aktuelle Element als Table zurück. |
asTableCell() | TableCell | Gibt das aktuelle Element als TableCell zurück. |
asTableOfContents() | TableOfContents | Gibt das aktuelle Element als TableOfContents zurück. |
asTableRow() | TableRow | Gibt das aktuelle Element als TableRow zurück. |
clear() | ContainerElement | Löscht den Inhalt des Elements. |
copy() | ContainerElement | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
editAsText() | Text | Ruft eine Text -Version des aktuellen Elements zur Bearbeitung ab. |
findElement(elementType) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs. |
findElement(elementType, from) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit
angegeben: RangeElement . |
findText(searchPattern) | RangeElement | Sucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster. |
findText(searchPattern, from) | RangeElement | Sucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getChild(childIndex) | Element | Ruft das untergeordnete Element im angegebenen untergeordneten Index ab. |
getChildIndex(child) | Integer | Ruft den untergeordneten Index für das angegebene untergeordnete Element ab |
getLinkUrl() | String | Ruft die Link-URL ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getNumChildren() | Integer | Ruft die Anzahl der untergeordneten Elemente ab. |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getText() | String | Ruft den Inhalt des Elements als Textstring ab. |
getTextAlignment() | TextAlignment | Ruft die Textausrichtung ab. |
getType() | ElementType | Ruft den ElementType des Elements ab. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
merge() | ContainerElement | Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen. |
removeFromParent() | ContainerElement | Entfernt das Element aus dem übergeordneten Element. |
replaceText(searchPattern, replacement) | Element | Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke. |
setAttributes(attributes) | ContainerElement | Legt die Attribute des Elements fest. |
setLinkUrl(url) | ContainerElement | Legt die Link-URL fest. |
setTextAlignment(textAlignment) | ContainerElement | Legt die Textausrichtung fest. |
Date
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
copy() | Date | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getDisplayText() | String | Gibt den Anzeigewert zurück, der im Dokument gerendert wird. |
getLocale() | String | Gibt die Sprache des Datums zurück, die für den Anzeigewert verwendet wird. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getTimestamp() | Date | Gibt den Zeitstempel zurück, der dem Datum zugeordnet ist. |
getType() | ElementType | Ruft den ElementType des Elements ab. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
merge() | Date | Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen. |
removeFromParent() | Date | Entfernt das Element aus dem übergeordneten Element. |
setAttributes(attributes) | Date | Legt 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()
undTab.getChildTabs()
. Rufen Sie für jeden Tab in der StrukturTab.asDocumentTab().getBody()
auf. - Ausgewählten Tab verwenden:
Document.getTabs()[Document.getActiveTab().getId()].asDocumentTab().getBody()
- Hinweis: Es wird ein Fehler ausgegeben, wenn der aktive Tab nicht vom Skript mit
Document.setActiveTab(tabId)
festgelegt wurde. - Einen bestimmten Tab verwenden:
Document.getTab(TAB_ID).asDocumentTab().getBody()
Weitere Informationen zur Tab-Funktion finden Sie unter Mit Tabs arbeiten.
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addBookmark(position) | Bookmark | Fügt dem ersten Tab ein Bookmark am angegebenen Position hinzu. Für Skripts, die
gebunden an ein Dokument, den aktiven Tab. |
addEditor(emailAddress) | Document | Fügt den angegebenen Nutzer der Liste der Bearbeiter für Document hinzu. |
addEditor(user) | Document | Fügt den angegebenen Nutzer der Liste der Bearbeiter für Document hinzu. |
addEditors(emailAddresses) | Document | Fügt das angegebene Array von Nutzern der Liste der Bearbeiter für Document hinzu. |
addFooter() | FooterSection | Fü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() | HeaderSection | Fü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) | NamedRange | Fü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) | Document | Fügt den angegebenen Nutzer der Liste der Betrachter für das Document hinzu. |
addViewer(user) | Document | Fügt den angegebenen Nutzer der Liste der Betrachter für das Document hinzu. |
addViewers(emailAddresses) | Document | Fügt das angegebene Array von Nutzern der Betrachterliste für Document hinzu. |
getActiveTab() | Tab | Ruft die derzeit aktive Tab des Nutzers im Dokument ab. |
getAs(contentType) | Blob | Ruft den aktuellen Document -Inhalt als Blob des angegebenen Typs ab. |
getBlob() | Blob | Ruft den aktuellen Document -Inhalt als Blob ab. |
getBody() | Body | Ruft den Body des ersten Tabs oder bei Skripts, die an ein Dokument gebunden sind, den DocumentBodySection des aktiven Tabs ab. |
getBookmark(id) | Bookmark | Ruft 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() | Position | Ruft den Cursor des Nutzers im aktiven Tab ab. |
getEditors() | User[] | Ruft die Liste der Bearbeiter für dieses Document -Element ab. |
getFooter() | FooterSection | Ruft 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() | HeaderSection | Ruft den Kopfzeilenbereich des ersten Tabs oder, im Fall von Skripts, die an ein Dokument gebunden sind, den Header des aktiven Tabs ab . |
getId() | String | Ruft die eindeutige Kennung des Dokuments ab. |
getLanguage() | String | Ruft den Sprachcode des Dokuments ab. |
getName() | String | Ruft den Titel des Dokuments ab. |
getNamedRangeById(id) | NamedRange | Ruft 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() | Range | Ruft 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) | Tab | Ruft die Tab mit der angegebenen ID ab. |
getTabs() | Tab[] | Ruft alle nicht verschachtelten Tab s ab, die Teil des Dokuments sind. |
getUrl() | String | Ruft 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) | Position | Erstellt 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() | RangeBuilder | Erstellt 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) | Document | Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Document . |
removeEditor(user) | Document | Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Document . |
removeViewer(emailAddress) | Document | Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für das Document . |
removeViewer(user) | Document | Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für das Document . |
saveAndClose() | void | Speichert den aktuellen Document . |
setActiveTab(tabId) | void | Legt das vom Nutzer ausgewählte Tab im aktuellen Dokument auf den Tab mit der angegebenen ID fest. |
setCursor(position) | Document | Legt den Cursor des Nutzers bei Angabe eines Position fest. |
setLanguage(languageCode) | Document | Legt den Sprachcode des Dokuments fest. |
setName(name) | Document | Legt den Titel des Dokuments fest. |
setSelection(range) | Document | Legt die Auswahl des Nutzers auf dem aktiven Tab fest, wenn eine Range angegeben wird. |
DocumentApp
Attribute
Attribut | Typ | Beschreibung |
---|---|---|
Attribute | Attribute | Die Aufzählung Attribute . |
ElementType | ElementType | Die Aufzählung ElementType . |
FontFamily |
| Die Aufzählung . |
GlyphType | GlyphType | Die Aufzählung GlyphType . |
HorizontalAlignment | HorizontalAlignment | Die Aufzählung HorizontalAlignment . |
ParagraphHeading | ParagraphHeading | Die Aufzählung ParagraphHeading . |
PositionedLayout | PositionedLayout | Die Aufzählung PositionedLayout . |
TextAlignment | TextAlignment | Die Aufzählung TextAlignment . |
VerticalAlignment | VerticalAlignment | Die Aufzählung VerticalAlignment . |
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
create(name) | Document | Erstellt ein neues Dokument und gibt es zurück. |
getActiveDocument() | Document | Gibt das Dokument zurück, an das das Skript containergebunden ist. |
getUi() | Ui | Gibt eine Instanz der Benutzeroberflächenumgebung des Dokuments zurück, die es dem Skript ermöglicht, wie Menüs, Dialogfelder und Seitenleisten. |
openById(id) | Document | Gibt 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
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addBookmark(position) | Bookmark | Fügt einen Bookmark am angegebenen Position hinzu. |
addFooter() | FooterSection | Fügt einen Tab-Fußzeilenabschnitt hinzu, falls keiner vorhanden ist. |
addHeader() | HeaderSection | Fügt einen Tab-Header-Abschnitt hinzu, falls keiner vorhanden ist. |
addNamedRange(name, range) | NamedRange | Fü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() | Body | Ruft den Body des Tabs ab. |
getBookmark(id) | Bookmark | Ruft das Bookmark mit der angegebenen ID ab. |
getBookmarks() | Bookmark[] | Ruft alle Bookmark -Objekte im Tab ab. |
getFooter() | FooterSection | Ruft den Fußzeilenbereich des Tabs ab, sofern vorhanden. |
getFootnotes() | Footnote[] | Ruft alle Footnote -Elemente im Textkörper des Tabs ab. |
getHeader() | HeaderSection | Ruft den Headerabschnitt des Tabs ab, sofern vorhanden. |
getNamedRangeById(id) | NamedRange | Ruft 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) | Position | Erstellt eine neue Position , die ein Verweis auf eine Position auf dem Tab ist, relativ zu einem
spezifisches Element. |
newRange() | RangeBuilder | Erstellt einen Builder, der zum Erstellen von Range -Objekten aus Tab-Elementen verwendet wird. |
Element
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
asBody() | Body | Gibt das aktuelle Element als Body zurück. |
asDate() | Date | Gibt das aktuelle Element als Date zurück. |
asEquation() | Equation | Gibt das aktuelle Element als Equation zurück. |
asEquationFunction() | EquationFunction | Gibt das aktuelle Element als EquationFunction zurück. |
asEquationFunctionArgumentSeparator() | EquationFunctionArgumentSeparator | Gibt das aktuelle Element als EquationFunctionArgumentSeparator zurück. |
asEquationSymbol() | EquationSymbol | Gibt das aktuelle Element als EquationSymbol zurück. |
asFooterSection() | FooterSection | Gibt das aktuelle Element als FooterSection zurück. |
asFootnote() | Footnote | Gibt das aktuelle Element als Footnote zurück. |
asFootnoteSection() | FootnoteSection | Gibt das aktuelle Element als FootnoteSection zurück. |
asHeaderSection() | HeaderSection | Gibt das aktuelle Element als HeaderSection zurück. |
asHorizontalRule() | HorizontalRule | Gibt das aktuelle Element als HorizontalRule zurück. |
asInlineDrawing() | InlineDrawing | Gibt das aktuelle Element als InlineDrawing zurück. |
asInlineImage() | InlineImage | Gibt das aktuelle Element als InlineImage zurück. |
asListItem() | ListItem | Gibt das aktuelle Element als ListItem zurück. |
asPageBreak() | PageBreak | Gibt das aktuelle Element als PageBreak zurück. |
asParagraph() | Paragraph | Gibt das aktuelle Element als Paragraph zurück. |
asPerson() | Person | Gibt das aktuelle Element als Person zurück. |
asRichLink() | RichLink | Gibt das aktuelle Element als RichLink zurück, z. B. einen Link zu einer Google Tabellen-Datei. |
asTable() | Table | Gibt das aktuelle Element als Table zurück. |
asTableCell() | TableCell | Gibt das aktuelle Element als TableCell zurück. |
asTableOfContents() | TableOfContents | Gibt das aktuelle Element als TableOfContents zurück. |
asTableRow() | TableRow | Gibt das aktuelle Element als TableRow zurück. |
asText() | Text | Gibt das aktuelle Element als Text zurück. |
copy() | Element | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getType() | ElementType | Ruft den ElementType des Elements ab. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
merge() | Element | Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen. |
removeFromParent() | Element | Entfernt das Element aus dem übergeordneten Element. |
setAttributes(attributes) | Element | Legt die Attribute des Elements fest. |
ElementType
Attribute
Attribut | Typ | Beschreibung |
---|---|---|
BODY_SECTION | Enum | Der Typ, der dem Body -Element entspricht. |
COMMENT_SECTION | Enum | Der Typ, der dem -Element entspricht. |
DATE | Enum | Der Typ, der Date entspricht
-Elements. |
EQUATION | Enum | Der Typ, der dem Equation -Element entspricht. |
EQUATION_FUNCTION | Enum | Der Typ, der dem EquationFunction -Element entspricht. |
EQUATION_FUNCTION_ARGUMENT_SEPARATOR | Enum | Der Typ, der EquationFunctionArgumentSeparator entspricht
-Elements. |
EQUATION_SYMBOL | Enum | Der Typ, der dem EquationSymbol -Element entspricht. |
RICH_LINK | Enum | Der Typ, der dem RichLink -Element entspricht. |
FOOTER_SECTION | Enum | Der Typ, der dem FooterSection -Element entspricht. |
FOOTNOTE | Enum | Der Typ, der dem Footnote -Element entspricht. |
FOOTNOTE_SECTION | Enum | Der Typ, der dem FootnoteSection -Element entspricht. |
HEADER_SECTION | Enum | Der Typ, der dem HeaderSection -Element entspricht. |
HORIZONTAL_RULE | Enum | Der Typ, der dem HorizontalRule -Element entspricht. |
INLINE_DRAWING | Enum | Der Typ, der dem InlineDrawing -Element entspricht. |
INLINE_IMAGE | Enum | Der Typ, der dem InlineImage -Element entspricht. |
LIST_ITEM | Enum | Der Typ, der dem ListItem -Element entspricht. |
PAGE_BREAK | Enum | Der Typ, der dem PageBreak -Element entspricht. |
PARAGRAPH | Enum | Der Typ, der dem Paragraph -Element entspricht. |
PERSON | Enum | Der Typ, der dem Person -Element entspricht. |
TABLE | Enum | Der Typ, der dem Table -Element entspricht. |
TABLE_CELL | Enum | Der Typ, der dem TableCell -Element entspricht. |
TABLE_OF_CONTENTS | Enum | Der Typ, der dem TableOfContents -Element entspricht. |
TABLE_ROW | Enum | Der Typ, der dem TableRow -Element entspricht. |
TEXT | Enum | Der Typ, der Text entspricht
-Elements. |
UNSUPPORTED | Enum | Der Typ, der UnsupportedElement entspricht. |
Equation
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
clear() | Equation | Löscht den Inhalt des Elements. |
copy() | Equation | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
editAsText() | Text | Ruft eine Text -Version des aktuellen Elements zur Bearbeitung ab. |
findElement(elementType) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs. |
findElement(elementType, from) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit
angegeben: RangeElement . |
findText(searchPattern) | RangeElement | Sucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster. |
findText(searchPattern, from) | RangeElement | Sucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getChild(childIndex) | Element | Ruft das untergeordnete Element im angegebenen untergeordneten Index ab. |
getChildIndex(child) | Integer | Ruft den untergeordneten Index für das angegebene untergeordnete Element ab |
getLinkUrl() | String | Ruft die Link-URL ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getNumChildren() | Integer | Ruft die Anzahl der untergeordneten Elemente ab. |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getText() | String | Ruft den Inhalt des Elements als Textstring ab. |
getTextAlignment() | TextAlignment | Ruft die Textausrichtung ab. |
getType() | ElementType | Ruft den ElementType des Elements ab. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
merge() | Equation | Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen. |
removeFromParent() | Equation | Entfernt das Element aus dem übergeordneten Element. |
replaceText(searchPattern, replacement) | Element | Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke. |
setAttributes(attributes) | Equation | Legt die Attribute des Elements fest. |
setLinkUrl(url) | Equation | Legt die Link-URL fest. |
setTextAlignment(textAlignment) | Equation | Legt die Textausrichtung fest. |
EquationFunction
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
clear() | EquationFunction | Löscht den Inhalt des Elements. |
copy() | EquationFunction | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
editAsText() | Text | Ruft eine Text -Version des aktuellen Elements zur Bearbeitung ab. |
findElement(elementType) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs. |
findElement(elementType, from) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit
angegeben: RangeElement . |
findText(searchPattern) | RangeElement | Sucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster. |
findText(searchPattern, from) | RangeElement | Sucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getChild(childIndex) | Element | Ruft das untergeordnete Element im angegebenen untergeordneten Index ab. |
getChildIndex(child) | Integer | Ruft den untergeordneten Index für das angegebene untergeordnete Element ab |
getCode() | String | Ruft den Code ab, der der Gleichungsfunktion entspricht. |
getLinkUrl() | String | Ruft die Link-URL ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getNumChildren() | Integer | Ruft die Anzahl der untergeordneten Elemente ab. |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getText() | String | Ruft den Inhalt des Elements als Textstring ab. |
getTextAlignment() | TextAlignment | Ruft die Textausrichtung ab. |
getType() | ElementType | Ruft den ElementType des Elements ab. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
merge() | EquationFunction | Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen. |
removeFromParent() | EquationFunction | Entfernt das Element aus dem übergeordneten Element. |
replaceText(searchPattern, replacement) | Element | Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke. |
setAttributes(attributes) | EquationFunction | Legt die Attribute des Elements fest. |
setLinkUrl(url) | EquationFunction | Legt die Link-URL fest. |
setTextAlignment(textAlignment) | EquationFunction | Legt die Textausrichtung fest. |
EquationFunctionArgumentSeparator
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
copy() | EquationFunctionArgumentSeparator | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getType() | ElementType | Ruft den ElementType des Elements ab. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
merge() | EquationFunctionArgumentSeparator | Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen. |
removeFromParent() | EquationFunctionArgumentSeparator | Entfernt das Element aus dem übergeordneten Element. |
setAttributes(attributes) | EquationFunctionArgumentSeparator | Legt die Attribute des Elements fest. |
EquationSymbol
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
copy() | EquationSymbol | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getCode() | String | Ruft den Code für das Gleichungssymbol ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getType() | ElementType | Ruft den ElementType des Elements ab. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
merge() | EquationSymbol | Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen. |
removeFromParent() | EquationSymbol | Entfernt das Element aus dem übergeordneten Element. |
setAttributes(attributes) | EquationSymbol | Legt die Attribute des Elements fest. |
FontFamily
FooterSection
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
appendHorizontalRule() | HorizontalRule | Erstellt eine neue HorizontalRule und hängt sie an. |
appendImage(image) | InlineImage | Erstellt eine neue InlineImage aus dem angegebenen Bild-Blob und hängt sie an. |
appendImage(image) | InlineImage | Hängt die angegebene InlineImage an. |
appendListItem(listItem) | ListItem | Hängt die angegebene ListItem an. |
appendListItem(text) | ListItem | Erstellt eine neue ListItem und hängt sie an, die den angegebenen Textinhalt enthält. |
appendParagraph(paragraph) | Paragraph | Hängt die angegebene Paragraph an. |
appendParagraph(text) | Paragraph | Erstellt eine neue Paragraph und hängt sie an, die den angegebenen Textinhalt enthält. |
appendTable() | Table | Erstellt eine neue Table und hängt sie an. |
appendTable(cells) | Table | Hängt eine neue Table an, die für jeden angegebenen Stringwert eine TableCell enthält. |
appendTable(table) | Table | Hängt die angegebene Table an. |
clear() | FooterSection | Löscht den Inhalt des Elements. |
copy() | FooterSection | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
editAsText() | Text | Ruft eine Text -Version des aktuellen Elements zur Bearbeitung ab. |
findElement(elementType) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs. |
findElement(elementType, from) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit
angegeben: RangeElement . |
findText(searchPattern) | RangeElement | Sucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster. |
findText(searchPattern, from) | RangeElement | Sucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getChild(childIndex) | Element | Ruft das untergeordnete Element im angegebenen untergeordneten Index ab. |
getChildIndex(child) | Integer | Ruft 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() | Integer | Ruft die Anzahl der untergeordneten Elemente ab. |
getParagraphs() | Paragraph[] | Ruft alle im Abschnitt enthaltenen Paragraphs ab (einschließlich ListItems ). |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getTables() | Table[] | Ruft alle im Abschnitt enthaltenen Tables ab. |
getText() | String | Ruft den Inhalt des Elements als Textstring ab. |
getTextAlignment() | TextAlignment | Ruft die Textausrichtung ab. |
getType() | ElementType | Ruft den ElementType des Elements ab. |
insertHorizontalRule(childIndex) | HorizontalRule | Erstellt eine neue HorizontalRule und fügt sie im angegebenen Index ein. |
insertImage(childIndex, image) | InlineImage | Erstellt und fügt einen InlineImage aus dem angegebenen Bild-BLOB am angegebenen
-Index. |
insertImage(childIndex, image) | InlineImage | Fügt den angegebenen InlineImage im angegebenen Index ein. |
insertListItem(childIndex, listItem) | ListItem | Fügt den angegebenen ListItem im angegebenen Index ein. |
insertListItem(childIndex, text) | ListItem | Erstellt eine neue ListItem und fügt sie im angegebenen Index ein, die den angegebenen Index enthält
Textinhalt. |
insertParagraph(childIndex, paragraph) | Paragraph | Fügt den angegebenen Paragraph im angegebenen Index ein. |
insertParagraph(childIndex, text) | Paragraph | Erstellt eine neue Paragraph und fügt sie im angegebenen Index ein, die den angegebenen Index enthält
Textinhalt. |
insertTable(childIndex) | Table | Erstellt eine neue Table und fügt sie im angegebenen Index ein. |
insertTable(childIndex, cells) | Table | Erstellt eine neue Table und fügt sie ein, die die angegebenen Zellen am angegebenen Index enthält. |
insertTable(childIndex, table) | Table | Fügt den angegebenen Table im angegebenen Index ein. |
removeChild(child) | FooterSection | Entfernt das angegebene untergeordnete Element. |
removeFromParent() | FooterSection | Entfernt das Element aus dem übergeordneten Element. |
replaceText(searchPattern, replacement) | Element | Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke. |
setAttributes(attributes) | FooterSection | Legt die Attribute des Elements fest. |
setText(text) | FooterSection | Legt den Inhalt als Nur-Text fest. |
setTextAlignment(textAlignment) | FooterSection | Legt die Textausrichtung fest. |
Footnote
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
copy() | Footnote | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getFootnoteContents() | FootnoteSection | Ruft den Inhalt des Fußnoten-Elements ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getType() | ElementType | Ruft den ElementType des Elements ab. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
removeFromParent() | Footnote | Entfernt das Element aus dem übergeordneten Element. |
setAttributes(attributes) | Footnote | Legt die Attribute des Elements fest. |
FootnoteSection
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
appendParagraph(paragraph) | Paragraph | Hängt die angegebene Paragraph an. |
appendParagraph(text) | Paragraph | Erstellt eine neue Paragraph und hängt sie an, die den angegebenen Textinhalt enthält. |
clear() | FootnoteSection | Löscht den Inhalt des Elements. |
copy() | FootnoteSection | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
editAsText() | Text | Ruft eine Text -Version des aktuellen Elements zur Bearbeitung ab. |
findElement(elementType) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs. |
findElement(elementType, from) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit
angegeben: RangeElement . |
findText(searchPattern) | RangeElement | Sucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster. |
findText(searchPattern, from) | RangeElement | Sucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getChild(childIndex) | Element | Ruft das untergeordnete Element im angegebenen untergeordneten Index ab. |
getChildIndex(child) | Integer | Ruft den untergeordneten Index für das angegebene untergeordnete Element ab |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getNumChildren() | Integer | Ruft die Anzahl der untergeordneten Elemente ab. |
getParagraphs() | Paragraph[] | Ruft alle im Abschnitt enthaltenen Paragraphs ab (einschließlich ListItems ). |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getText() | String | Ruft den Inhalt des Elements als Textstring ab. |
getTextAlignment() | TextAlignment | Ruft die Textausrichtung ab. |
getType() | ElementType | Ruft den ElementType des Elements ab. |
insertParagraph(childIndex, paragraph) | Paragraph | Fügt den angegebenen Paragraph im angegebenen Index ein. |
insertParagraph(childIndex, text) | Paragraph | Erstellt eine neue Paragraph und fügt sie im angegebenen Index ein, die den angegebenen Index enthält
Textinhalt. |
removeChild(child) | FootnoteSection | Entfernt das angegebene untergeordnete Element. |
removeFromParent() | FootnoteSection | Entfernt das Element aus dem übergeordneten Element. |
replaceText(searchPattern, replacement) | Element | Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke. |
setAttributes(attributes) | FootnoteSection | Legt die Attribute des Elements fest. |
setText(text) | FootnoteSection | Legt den Inhalt als Nur-Text fest. |
setTextAlignment(textAlignment) | FootnoteSection | Legt die Textausrichtung fest. |
GlyphType
Attribute
Attribut | Typ | Beschreibung |
---|---|---|
BULLET | Enum | Standardmäßiges Aufzählungszeichen, kreisförmig und ausgefüllt. |
HOLLOW_BULLET | Enum | Ein Aufzählungszeichen. |
SQUARE_BULLET | Enum | Ein quadratisches Aufzählungszeichen. |
NUMBER | Enum | Ein nummerbasierter Aufzählungspunkt. |
LATIN_UPPER | Enum | Ein Aufzählungszeichen in Großbuchstaben. |
LATIN_LOWER | Enum | Ein Aufzählungszeichen in lateinischen Buchstaben. |
ROMAN_UPPER | Enum | Ein römisches Aufzählungszeichen in Großbuchstaben. |
ROMAN_LOWER | Enum | Ein römisches Aufzählungszeichen in Kleinbuchstaben. |
HeaderSection
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
appendHorizontalRule() | HorizontalRule | Erstellt eine neue HorizontalRule und hängt sie an. |
appendImage(image) | InlineImage | Erstellt eine neue InlineImage aus dem angegebenen Bild-Blob und hängt sie an. |
appendImage(image) | InlineImage | Hängt die angegebene InlineImage an. |
appendListItem(listItem) | ListItem | Hängt die angegebene ListItem an. |
appendListItem(text) | ListItem | Erstellt eine neue ListItem und hängt sie an, die den angegebenen Textinhalt enthält. |
appendParagraph(paragraph) | Paragraph | Hängt die angegebene Paragraph an. |
appendParagraph(text) | Paragraph | Erstellt eine neue Paragraph und hängt sie an, die den angegebenen Textinhalt enthält. |
appendTable() | Table | Erstellt eine neue Table und hängt sie an. |
appendTable(cells) | Table | Hängt eine neue Table an, die für jeden angegebenen Stringwert eine TableCell enthält. |
appendTable(table) | Table | Hängt die angegebene Table an. |
clear() | HeaderSection | Löscht den Inhalt des Elements. |
copy() | HeaderSection | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
editAsText() | Text | Ruft eine Text -Version des aktuellen Elements zur Bearbeitung ab. |
findElement(elementType) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs. |
findElement(elementType, from) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit
angegeben: RangeElement . |
findText(searchPattern) | RangeElement | Sucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster. |
findText(searchPattern, from) | RangeElement | Sucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getChild(childIndex) | Element | Ruft das untergeordnete Element im angegebenen untergeordneten Index ab. |
getChildIndex(child) | Integer | Ruft 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() | Integer | Ruft die Anzahl der untergeordneten Elemente ab. |
getParagraphs() | Paragraph[] | Ruft alle im Abschnitt enthaltenen Paragraphs ab (einschließlich ListItems ). |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getTables() | Table[] | Ruft alle im Abschnitt enthaltenen Tables ab. |
getText() | String | Ruft den Inhalt des Elements als Textstring ab. |
getTextAlignment() | TextAlignment | Ruft die Textausrichtung ab. |
getType() | ElementType | Ruft den ElementType des Elements ab. |
insertHorizontalRule(childIndex) | HorizontalRule | Erstellt eine neue HorizontalRule und fügt sie im angegebenen Index ein. |
insertImage(childIndex, image) | InlineImage | Erstellt und fügt einen InlineImage aus dem angegebenen Bild-BLOB am angegebenen
-Index. |
insertImage(childIndex, image) | InlineImage | Fügt den angegebenen InlineImage im angegebenen Index ein. |
insertListItem(childIndex, listItem) | ListItem | Fügt den angegebenen ListItem im angegebenen Index ein. |
insertListItem(childIndex, text) | ListItem | Erstellt eine neue ListItem und fügt sie im angegebenen Index ein, die den angegebenen Index enthält
Textinhalt. |
insertParagraph(childIndex, paragraph) | Paragraph | Fügt den angegebenen Paragraph im angegebenen Index ein. |
insertParagraph(childIndex, text) | Paragraph | Erstellt eine neue Paragraph und fügt sie im angegebenen Index ein, die den angegebenen Index enthält
Textinhalt. |
insertTable(childIndex) | Table | Erstellt eine neue Table und fügt sie im angegebenen Index ein. |
insertTable(childIndex, cells) | Table | Erstellt eine neue Table und fügt sie ein, die die angegebenen Zellen am angegebenen Index enthält. |
insertTable(childIndex, table) | Table | Fügt den angegebenen Table im angegebenen Index ein. |
removeChild(child) | HeaderSection | Entfernt das angegebene untergeordnete Element. |
removeFromParent() | HeaderSection | Entfernt das Element aus dem übergeordneten Element. |
replaceText(searchPattern, replacement) | Element | Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke. |
setAttributes(attributes) | HeaderSection | Legt die Attribute des Elements fest. |
setText(text) | HeaderSection | Legt den Inhalt als Nur-Text fest. |
setTextAlignment(textAlignment) | HeaderSection | Legt die Textausrichtung fest. |
HorizontalAlignment
Attribute
Attribut | Typ | Beschreibung |
---|---|---|
LEFT | Enum | Die Option für die linksbündige Ausrichtung. |
CENTER | Enum | Die Option zur zentrierten Ausrichtung. |
RIGHT | Enum | Die Option zur rechten Ausrichtung. |
JUSTIFY | Enum | Die Option „Justify-Alignment“. |
HorizontalRule
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
copy() | HorizontalRule | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getType() | ElementType | Ruft den ElementType des Elements ab. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
removeFromParent() | HorizontalRule | Entfernt das Element aus dem übergeordneten Element. |
setAttributes(attributes) | HorizontalRule | Legt die Attribute des Elements fest. |
InlineDrawing
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
copy() | InlineDrawing | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
getAltDescription() | String | Gibt die alternative Beschreibung der Zeichnung zurück. |
getAltTitle() | String | Gibt den alternativen Titel der Zeichnung zurück. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getType() | ElementType | Ruft den ElementType des Elements ab. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
merge() | InlineDrawing | Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen. |
removeFromParent() | InlineDrawing | Entfernt das Element aus dem übergeordneten Element. |
setAltDescription(description) | InlineDrawing | Legt die alternative Beschreibung der Zeichnung fest. |
setAltTitle(title) | InlineDrawing | Legt den alternativen Titel der Zeichnung fest. |
setAttributes(attributes) | InlineDrawing | Legt die Attribute des Elements fest. |
InlineImage
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
copy() | InlineImage | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
getAltDescription() | String | Gibt die alternative Beschreibung des Bilds zurück. |
getAltTitle() | String | Gibt den alternativen Titel des Bilds zurück. |
getAs(contentType) | Blob | Gibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getBlob() | Blob | Gibt die Daten in diesem Objekt als Blob zurück. |
getHeight() | Integer | Ruft die Höhe des Bildes in Pixeln ab. |
getLinkUrl() | String | Ruft die Link-URL ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getType() | ElementType | Ruft den ElementType des Elements ab. |
getWidth() | Integer | Ruft die Bildbreite in Pixeln ab. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
merge() | InlineImage | Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen. |
removeFromParent() | InlineImage | Entfernt das Element aus dem übergeordneten Element. |
setAltDescription(description) | InlineImage | Legt die alternative Beschreibung des Bilds fest. |
setAltTitle(title) | InlineImage | Legt den alternativen Titel des Bilds fest. |
setAttributes(attributes) | InlineImage | Legt die Attribute des Elements fest. |
setHeight(height) | InlineImage | Legt die Höhe des Bildes in Pixeln fest. |
setLinkUrl(url) | InlineImage | Legt die Link-URL fest. |
setWidth(width) | InlineImage | Legt die Breite des Bildes in Pixeln fest. |
ListItem
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addPositionedImage(image) | PositionedImage | Erstellt einen neuen PositionedImage und fügt ihn aus dem angegebenen Bild-Blob ein. |
appendHorizontalRule() | HorizontalRule | Erstellt eine neue HorizontalRule und hängt sie an. |
appendInlineImage(image) | InlineImage | Erstellt eine neue InlineImage aus dem angegebenen Bild-Blob und hängt sie an. |
appendInlineImage(image) | InlineImage | Hängt die angegebene InlineImage an. |
appendPageBreak() | PageBreak | Erstellt eine neue PageBreak und hängt sie an. |
appendPageBreak(pageBreak) | PageBreak | Hängt die angegebene PageBreak an. |
appendText(text) | Text | Erstellt ein neues Text -Element mit dem angegebenen Inhalt und hängt es an. |
appendText(text) | Text | Hängt das angegebene Text -Element an. |
clear() | ListItem | Löscht den Inhalt des Elements. |
copy() | ListItem | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
editAsText() | Text | Ruft eine Text -Version des aktuellen Elements zur Bearbeitung ab. |
findElement(elementType) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs. |
findElement(elementType, from) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit
angegeben: RangeElement . |
findText(searchPattern) | RangeElement | Sucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster. |
findText(searchPattern, from) | RangeElement | Sucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen. |
getAlignment() | HorizontalAlignment | Ruft die HorizontalAlignment ab. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getChild(childIndex) | Element | Ruft das untergeordnete Element im angegebenen untergeordneten Index ab. |
getChildIndex(child) | Integer | Ruft den untergeordneten Index für das angegebene untergeordnete Element ab |
getGlyphType() | GlyphType | Ruft die GlyphType des Listenelements ab. |
getHeading() | ParagraphHeading | Ruft die ParagraphHeading ab. |
getIndentEnd() | Number | Ruft den Endeinzug in Punkten ab. |
getIndentFirstLine() | Number | Ruft den Einzug der ersten Zeile in Punkten ab. |
getIndentStart() | Number | Ruft den Einzug am Anfang ab. |
getLineSpacing() | Number | Ruft den Zeilenabstand in Punkten ab. |
getLinkUrl() | String | Ruft die Link-URL ab. |
getListId() | String | Ruft die Listen-ID ab. |
getNestingLevel() | Integer | Ruft die Verschachtelungsebene des Listenelements ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getNumChildren() | Integer | Ruft die Anzahl der untergeordneten Elemente ab. |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPositionedImage(id) | PositionedImage | Ruft ein PositionedImage -Objekt anhand der Image-ID ab. |
getPositionedImages() | PositionedImage[] | Ruft alle PositionedImage -Objekte ab, die im Absatz verankert sind. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getSpacingAfter() | Number | Ruft den Abstand nach dem Element in Punkten ab. |
getSpacingBefore() | Number | Ruft den Abstand vor dem Element in Punkten ab. |
getText() | String | Ruft den Inhalt des Elements als Textstring ab. |
getTextAlignment() | TextAlignment | Ruft die Textausrichtung ab. |
getType() | ElementType | Ruft den ElementType des Elements ab. |
insertHorizontalRule(childIndex) | HorizontalRule | Erstellt einen HorizontalRule und fügt ihn im angegebenen Index ein. |
insertInlineImage(childIndex, image) | InlineImage | Erstellt und fügt einen neuen InlineImage aus dem angegebenen Bild-BLOB am angegebenen
-Index. |
insertInlineImage(childIndex, image) | InlineImage | Fügt den angegebenen InlineImage im angegebenen Index ein. |
insertPageBreak(childIndex) | PageBreak | Erstellt eine neue PageBreak und fügt sie im angegebenen Index ein. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Fügt den angegebenen PageBreak im angegebenen Index ein. |
insertText(childIndex, text) | Text | Erstellt ein neues Textelement und fügt es im angegebenen Index ein. |
insertText(childIndex, text) | Text | Fügt das angegebene Text -Element mit dem angegebenen Text am angegebenen Index ein
Inhalte. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
isLeftToRight() | Boolean | Ruft die Rechtsläufige Einstellung ab. |
merge() | ListItem | Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen. |
removeChild(child) | ListItem | Entfernt das angegebene untergeordnete Element. |
removeFromParent() | ListItem | Entfernt das Element aus dem übergeordneten Element. |
removePositionedImage(id) | Boolean | Entfernt einen PositionedImage anhand der Image-ID. |
replaceText(searchPattern, replacement) | Element | Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke. |
setAlignment(alignment) | ListItem | Legt HorizontalAlignment fest. |
setAttributes(attributes) | ListItem | Legt die Attribute des Elements fest. |
setGlyphType(glyphType) | ListItem | Legt den GlyphType des Listenelements fest. |
setHeading(heading) | ListItem | Legt ParagraphHeading fest. |
setIndentEnd(indentEnd) | ListItem | Legt den Einzug am Ende in Punkten fest. |
setIndentFirstLine(indentFirstLine) | ListItem | Legt den Einzug der ersten Zeile in Punkten fest. |
setIndentStart(indentStart) | ListItem | Legt den Einzug am Anfang in Punkten fest. |
setLeftToRight(leftToRight) | ListItem | Legt die Leserichtung von links nach rechts fest. |
setLineSpacing(multiplier) | ListItem | Legt den Zeilenabstand als Wert fest, der die Anzahl der Zeilen angibt, die für den Zeilenabstand verwendet werden sollen. |
setLinkUrl(url) | ListItem | Legt die Link-URL fest. |
setListId(listItem) | ListItem | Legt die Listen-ID fest. |
setNestingLevel(nestingLevel) | ListItem | Legt die Verschachtelungsebene des Listenelements fest. |
setSpacingAfter(spacingAfter) | ListItem | Legt den Abstand nach dem Element in Punkten fest. |
setSpacingBefore(spacingBefore) | ListItem | Legt den Abstand vor dem Element in Punkten fest. |
setText(text) | void | Legt den Inhalt des Listenelements als Text fest. |
setTextAlignment(textAlignment) | ListItem | Legt die Textausrichtung fest. |
NamedRange
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
getId() | String | Ruft die ID von diesem NamedRange ab. |
getName() | String | Ruft den Namen dieses NamedRange ab. |
getRange() | Range | Ruft den Bereich der Elemente ab, die mit NamedRange verknüpft sind. |
remove() | void | Entfernt dieses NamedRange vom Tab. |
PageBreak
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
copy() | PageBreak | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getType() | ElementType | Ruft den ElementType des Elements ab. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
removeFromParent() | PageBreak | Entfernt das Element aus dem übergeordneten Element. |
setAttributes(attributes) | PageBreak | Legt die Attribute des Elements fest. |
Paragraph
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addPositionedImage(image) | PositionedImage | Erstellt einen neuen PositionedImage und fügt ihn aus dem angegebenen Bild-Blob ein. |
appendHorizontalRule() | HorizontalRule | Erstellt eine neue HorizontalRule und hängt sie an. |
appendInlineImage(image) | InlineImage | Erstellt eine neue InlineImage aus dem angegebenen Bild-Blob und hängt sie an. |
appendInlineImage(image) | InlineImage | Hängt die angegebene InlineImage an. |
appendPageBreak() | PageBreak | Erstellt eine neue PageBreak und hängt sie an. |
appendPageBreak(pageBreak) | PageBreak | Hängt die angegebene PageBreak an. |
appendText(text) | Text | Erstellt ein neues Text -Element mit dem angegebenen Inhalt und hängt es an. |
appendText(text) | Text | Hängt das angegebene Text -Element an. |
clear() | Paragraph | Löscht den Inhalt des Elements. |
copy() | Paragraph | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
editAsText() | Text | Ruft eine Text -Version des aktuellen Elements zur Bearbeitung ab. |
findElement(elementType) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs. |
findElement(elementType, from) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit
angegeben: RangeElement . |
findText(searchPattern) | RangeElement | Sucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster. |
findText(searchPattern, from) | RangeElement | Sucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen. |
getAlignment() | HorizontalAlignment | Ruft die HorizontalAlignment ab. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getChild(childIndex) | Element | Ruft das untergeordnete Element im angegebenen untergeordneten Index ab. |
getChildIndex(child) | Integer | Ruft den untergeordneten Index für das angegebene untergeordnete Element ab |
getHeading() | ParagraphHeading | Ruft die ParagraphHeading ab. |
getIndentEnd() | Number | Ruft den Endeinzug in Punkten ab. |
getIndentFirstLine() | Number | Ruft den Einzug der ersten Zeile in Punkten ab. |
getIndentStart() | Number | Ruft den Einzug am Anfang ab. |
getLineSpacing() | Number | Ruft den Zeilenabstand in Punkten ab. |
getLinkUrl() | String | Ruft die Link-URL ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getNumChildren() | Integer | Ruft die Anzahl der untergeordneten Elemente ab. |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPositionedImage(id) | PositionedImage | Ruft ein PositionedImage -Objekt anhand der Image-ID ab. |
getPositionedImages() | PositionedImage[] | Ruft alle PositionedImage -Objekte ab, die im Absatz verankert sind. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getSpacingAfter() | Number | Ruft den Abstand nach dem Element in Punkten ab. |
getSpacingBefore() | Number | Ruft den Abstand vor dem Element in Punkten ab. |
getText() | String | Ruft den Inhalt des Elements als Textstring ab. |
getTextAlignment() | TextAlignment | Ruft die Textausrichtung ab. |
getType() | ElementType | Ruft den ElementType des Elements ab. |
insertHorizontalRule(childIndex) | HorizontalRule | Erstellt einen HorizontalRule und fügt ihn im angegebenen Index ein. |
insertInlineImage(childIndex, image) | InlineImage | Erstellt und fügt einen neuen InlineImage aus dem angegebenen Bild-BLOB am angegebenen
-Index. |
insertInlineImage(childIndex, image) | InlineImage | Fügt den angegebenen InlineImage im angegebenen Index ein. |
insertPageBreak(childIndex) | PageBreak | Erstellt eine neue PageBreak und fügt sie im angegebenen Index ein. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Fügt den angegebenen PageBreak im angegebenen Index ein. |
insertText(childIndex, text) | Text | Erstellt ein neues Textelement und fügt es im angegebenen Index ein. |
insertText(childIndex, text) | Text | Fügt das angegebene Text -Element mit dem angegebenen Text am angegebenen Index ein
Inhalte. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
isLeftToRight() | Boolean | Ruft die Rechtsläufige Einstellung ab. |
merge() | Paragraph | Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen. |
removeChild(child) | Paragraph | Entfernt das angegebene untergeordnete Element. |
removeFromParent() | Paragraph | Entfernt das Element aus dem übergeordneten Element. |
removePositionedImage(id) | Boolean | Entfernt einen PositionedImage anhand der Image-ID. |
replaceText(searchPattern, replacement) | Element | Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke. |
setAlignment(alignment) | Paragraph | Legt HorizontalAlignment fest. |
setAttributes(attributes) | Paragraph | Legt die Attribute des Elements fest. |
setHeading(heading) | Paragraph | Legt ParagraphHeading fest. |
setIndentEnd(indentEnd) | Paragraph | Legt den Einzug am Ende in Punkten fest. |
setIndentFirstLine(indentFirstLine) | Paragraph | Legt den Einzug der ersten Zeile in Punkten fest. |
setIndentStart(indentStart) | Paragraph | Legt den Einzug am Anfang in Punkten fest. |
setLeftToRight(leftToRight) | Paragraph | Legt die Leserichtung von links nach rechts fest. |
setLineSpacing(multiplier) | Paragraph | Legt den Zeilenabstand als Wert fest, der die Anzahl der Zeilen angibt, die für den Zeilenabstand verwendet werden sollen. |
setLinkUrl(url) | Paragraph | Legt die Link-URL fest. |
setSpacingAfter(spacingAfter) | Paragraph | Legt den Abstand nach dem Element in Punkten fest. |
setSpacingBefore(spacingBefore) | Paragraph | Legt den Abstand vor dem Element in Punkten fest. |
setText(text) | void | Legt den Inhalt des Absatzes als Text fest. |
setTextAlignment(textAlignment) | Paragraph | Legt die Textausrichtung fest. |
ParagraphHeading
Attribute
Attribut | Typ | Beschreibung |
---|---|---|
NORMAL | Enum | Die Überschriftsoption für normalen Text. |
HEADING1 | Enum | Die Option für die höchste Überschrift. |
HEADING2 | Enum | Die zweite Option für die Überschrift. |
HEADING3 | Enum | Mit der dritten Option |
HEADING4 | Enum | Die vierte Überschrift. |
HEADING5 | Enum | Die fünfte Überschriftsoption. |
HEADING6 | Enum | Die unterste Überschriftsoption. |
TITLE | Enum | Die Option für die Überschrift. |
SUBTITLE | Enum | Die Option für die Untertitelüberschrift. |
Person
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
copy() | Person | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getEmail() | String | Gibt die E-Mail-Adresse der Person zurück. |
getName() | String | Gibt den Anzeigenamen der Person zurück, falls festgelegt |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getType() | ElementType | Ruft den ElementType des Elements ab. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
merge() | Person | Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen. |
removeFromParent() | Person | Entfernt das Element aus dem übergeordneten Element. |
setAttributes(attributes) | Person | Legt die Attribute des Elements fest. |
Position
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
getElement() | Element | Ruft das Element ab, das diese Position enthält. |
getOffset() | Integer | Ruft die relative Position von Position innerhalb des Elements ab, das sie enthält. |
getSurroundingText() | Text | Erstellt 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() | Integer | Ruft den Versatz von Position innerhalb des Text -Elements ab, das von getSurroundingText() zurückgegeben wird. |
insertBookmark() | Bookmark | Erstellt eine neue Bookmark und fügt sie an dieser Position ein. |
insertInlineImage(image) | InlineImage | Erstellt eine neue InlineImage und fügt sie an dieser Position aus dem angegebenen Bild ein
Blob. |
insertText(text) | Text | Fügt den angegebenen Text an dieser Position ein. |
PositionedImage
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
getAs(contentType) | Blob | Gibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde. |
getBlob() | Blob | Gibt die Daten in diesem Objekt als Blob zurück. |
getHeight() | Integer | Ruft die Höhe des Bildes in Pixeln ab. |
getId() | String | Ruft die Image-ID ab. |
getLayout() | PositionedLayout | Ruft einen enum-Wert ab, der das Layout des Bildes darstellt. |
getLeftOffset() | Number | Ruft den Bildversatz in Punkten vom linken Absatzrand ab. |
getParagraph() | Paragraph | Ruft den Paragraph ab, an dem das Bild verankert ist. |
getTopOffset() | Number | Ruft den Versatz des Bildes in Punkten vom oberen Absatzrand ab. |
getWidth() | Integer | Ruft die Bildbreite in Pixeln ab. |
setHeight(height) | PositionedImage | Legt die Höhe des Bildes in Pixeln fest. |
setLayout(layout) | PositionedImage | Legt die Definition für das Layout des Bildes fest. |
setLeftOffset(offset) | PositionedImage | Legt den Bildversatz in Punkten vom linken Absatzrand fest |
setTopOffset(offset) | PositionedImage | Legt den Versatz des Bildes in Punkten vom oberen Absatzrand fest. |
setWidth(width) | PositionedImage | Legt die Breite des Bildes in Pixeln fest. |
PositionedLayout
Attribute
Attribut | Typ | Beschreibung |
---|---|---|
ABOVE_TEXT | Enum | Das Bild wird über dem Text positioniert. |
BREAK_BOTH | Enum | Durch das Bild wird der Text links und rechts umgebrochen. |
BREAK_LEFT | Enum | Durch das Bild wird der Text auf der linken Seite unterbrochen. |
BREAK_RIGHT | Enum | Durch das Bild wird der Text auf der rechten Seite unterbrochen. |
WRAP_TEXT | Enum | Das Bild wird von Text umschlossen. |
Range
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
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
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addElement(element) | RangeBuilder | Fügt diesem RangeBuilder einen vollständigen Element hinzu. |
addElement(textElement, startOffset, endOffsetInclusive) | RangeBuilder | Fügt dieser RangeBuilder ein unvollständiges Text -Element hinzu. |
addElementsBetween(startElement, endElementInclusive) | RangeBuilder | Fügt zwei ganze Elemente und alle Elemente dazwischen zu diesem RangeBuilder hinzu. |
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) | RangeBuilder | Fügt zwei partielle Text -Elemente und alle Elemente dazwischen zum RangeBuilder hinzu. |
addRange(range) | RangeBuilder | Fügt den Inhalt eines anderen Range zu diesem RangeBuilder hinzu. |
build() | Range | Erstellt 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
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
getElement() | Element | Ruft die Element ab, die dieser RangeElement entspricht. |
getEndOffsetInclusive() | Integer | Ruft die Position des Endes eines Teilbereichs innerhalb des Bereichselements ab. |
getStartOffset() | Integer | Ruft die Position des Anfangs eines Teilbereichs innerhalb des Bereichselements ab. |
isPartial() | Boolean | Bestimmt, ob dieses Bereichselement das gesamte Element abdeckt oder eine Teilauswahl des Elements Zeichen des Elements enthält. |
RichLink
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
copy() | RichLink | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getMimeType() | String | Gibt den MIME-Typ von
den Link, der verfügbar ist, wenn das Element ein Link zu einer Drive-Datei und null ist
sonst. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getTitle() | String | Gibt den angezeigten Titel des Links zurück. |
getType() | ElementType | Ruft den ElementType des Elements ab. |
getUrl() | String | Gibt die URL der Ressource zurück. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
merge() | RichLink | Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen. |
removeFromParent() | RichLink | Entfernt das Element aus dem übergeordneten Element. |
setAttributes(attributes) | RichLink | Legt die Attribute des Elements fest. |
Tab
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
asDocumentTab() | DocumentTab | Ruft den Tabinhalt als DocumentTab ab. |
getChildTabs() | Tab[] | Ruft die in diesem Tab verschachtelten untergeordneten Tabs ab. |
getId() | String | Ruft die ID des Tabs ab. |
getIndex() | Integer | Ruft den 0-basierten Index des Tabs innerhalb des übergeordneten Elements ab. |
getTitle() | String | Ruft den Titel des Tabs ab. |
getType() | TabType | Ruft den Tab-Typ ab. |
TabType
Attribute
Attribut | Typ | Beschreibung |
---|---|---|
DOCUMENT_TAB | Enum | Der Typ, der DocumentTab entspricht. |
Table
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
appendTableRow() | TableRow | Erstellt eine neue TableRow und hängt sie an. |
appendTableRow(tableRow) | TableRow | Hängt die angegebene TableRow an. |
clear() | Table | Löscht den Inhalt des Elements. |
copy() | Table | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
editAsText() | Text | Ruft eine Text -Version des aktuellen Elements zur Bearbeitung ab. |
findElement(elementType) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs. |
findElement(elementType, from) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit
angegeben: RangeElement . |
findText(searchPattern) | RangeElement | Sucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster. |
findText(searchPattern, from) | RangeElement | Sucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getBorderColor() | String | Ruft die Rahmenfarbe ab. |
getBorderWidth() | Number | Ruft die Rahmenbreite in Punkten ab. |
getCell(rowIndex, cellIndex) | TableCell | Ruft den TableCell an den angegebenen Zeilen- und Zellenindexen ab. |
getChild(childIndex) | Element | Ruft das untergeordnete Element im angegebenen untergeordneten Index ab. |
getChildIndex(child) | Integer | Ruft den untergeordneten Index für das angegebene untergeordnete Element ab |
getColumnWidth(columnIndex) | Number | Ruft die Breite der angegebenen Tabellenspalte in Punkten ab. |
getLinkUrl() | String | Ruft die Link-URL ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getNumChildren() | Integer | Ruft die Anzahl der untergeordneten Elemente ab. |
getNumRows() | Integer | Ruft die Anzahl von TableRows ab. |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getRow(rowIndex) | TableRow | Ruft die TableRow am angegebenen Zeilenindex ab. |
getText() | String | Ruft den Inhalt des Elements als Textstring ab. |
getTextAlignment() | TextAlignment | Ruft die Textausrichtung ab. |
getType() | ElementType | Ruft den ElementType des Elements ab. |
insertTableRow(childIndex) | TableRow | Erstellt eine neue TableRow und fügt sie im angegebenen Index ein. |
insertTableRow(childIndex, tableRow) | TableRow | Fügt den angegebenen TableRow im angegebenen Index ein. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
removeChild(child) | Table | Entfernt das angegebene untergeordnete Element. |
removeFromParent() | Table | Entfernt das Element aus dem übergeordneten Element. |
removeRow(rowIndex) | TableRow | Entfernt die TableRow am angegebenen Zeilenindex. |
replaceText(searchPattern, replacement) | Element | Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke. |
setAttributes(attributes) | Table | Legt die Attribute des Elements fest. |
setBorderColor(color) | Table | Legt die Rahmenfarbe fest. |
setBorderWidth(width) | Table | Legt die Rahmenbreite in Punkten fest. |
setColumnWidth(columnIndex, width) | Table | Legt die Breite der angegebenen Spalte in Punkten fest. |
setLinkUrl(url) | Table | Legt die Link-URL fest. |
setTextAlignment(textAlignment) | Table | Legt die Textausrichtung fest. |
TableCell
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
appendHorizontalRule() | HorizontalRule | Erstellt eine neue HorizontalRule und hängt sie an. |
appendImage(image) | InlineImage | Erstellt eine neue InlineImage aus dem angegebenen Bild-Blob und hängt sie an. |
appendImage(image) | InlineImage | Hängt die angegebene InlineImage an. |
appendListItem(listItem) | ListItem | Hängt die angegebene ListItem an. |
appendListItem(text) | ListItem | Erstellt eine neue ListItem und hängt sie an. |
appendParagraph(paragraph) | Paragraph | Hängt die angegebene Paragraph an. |
appendParagraph(text) | Paragraph | Erstellt eine neue Paragraph und hängt sie an. |
appendTable() | Table | Erstellt eine neue Table und hängt sie an. |
appendTable(cells) | Table | Hängt eine neue Table an, die die angegebenen Zellen enthält. |
appendTable(table) | Table | Hängt die angegebene Table an. |
clear() | TableCell | Löscht den Inhalt des Elements. |
copy() | TableCell | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
editAsText() | Text | Ruft eine Text -Version des aktuellen Elements zur Bearbeitung ab. |
findElement(elementType) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs. |
findElement(elementType, from) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit
angegeben: RangeElement . |
findText(searchPattern) | RangeElement | Sucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster. |
findText(searchPattern, from) | RangeElement | Sucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getBackgroundColor() | String | Ruft die Hintergrundfarbe ab. |
getChild(childIndex) | Element | Ruft das untergeordnete Element im angegebenen untergeordneten Index ab. |
getChildIndex(child) | Integer | Ruft den untergeordneten Index für das angegebene untergeordnete Element ab |
getColSpan() | Integer | Ruft den Spaltenbereich ab, also die Anzahl der Spalten von Tabellenzellen, die diese Zelle umfasst. |
getLinkUrl() | String | Ruft die Link-URL ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getNumChildren() | Integer | Ruft die Anzahl der untergeordneten Elemente ab. |
getPaddingBottom() | Number | Ruft den unteren Abstand in Punkten ab. |
getPaddingLeft() | Number | Ruft den linken Abstand in Punkten ab. |
getPaddingRight() | Number | Ruft den richtigen Abstand in Punkten ab. |
getPaddingTop() | Number | Ruft den oberen Abstand in Punkten ab |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getParentRow() | TableRow | Ruft die TableRow mit dem aktuellen TableCell ab. |
getParentTable() | Table | Ruft die Table mit dem aktuellen TableCell ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getRowSpan() | Integer | Ruft den Zeilenbereich ab, also die Anzahl der Zeilen von Tabellenzellen, die diese Zelle umfasst. |
getText() | String | Ruft den Inhalt des Elements als Textstring ab. |
getTextAlignment() | TextAlignment | Ruft die Textausrichtung ab. |
getType() | ElementType | Ruft den ElementType des Elements ab. |
getVerticalAlignment() | VerticalAlignment | Ruft die VerticalAlignment ab. |
getWidth() | Number | Ruft die Breite der Spalte mit der Zelle in Punkten ab. |
insertHorizontalRule(childIndex) | HorizontalRule | Erstellt eine neue HorizontalRule und fügt sie im angegebenen Index ein. |
insertImage(childIndex, image) | InlineImage | Erstellt und fügt einen InlineImage aus dem angegebenen Bild-BLOB am angegebenen
-Index. |
insertImage(childIndex, image) | InlineImage | Fügt den angegebenen InlineImage im angegebenen Index ein. |
insertListItem(childIndex, listItem) | ListItem | Fügt den angegebenen ListItem im angegebenen Index ein. |
insertListItem(childIndex, text) | ListItem | Erstellt eine neue ListItem und fügt sie im angegebenen Index ein. |
insertParagraph(childIndex, paragraph) | Paragraph | Fügt den angegebenen Paragraph im angegebenen Index ein. |
insertParagraph(childIndex, text) | Paragraph | Erstellt eine neue Paragraph und fügt sie im angegebenen Index ein. |
insertTable(childIndex) | Table | Erstellt eine neue Table und fügt sie im angegebenen Index ein. |
insertTable(childIndex, cells) | Table | Erstellt eine neue Table und fügt sie ein, die die angegebenen Zellen am angegebenen Index enthält. |
insertTable(childIndex, table) | Table | Fügt den angegebenen Table im angegebenen Index ein. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
merge() | TableCell | Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen. |
removeChild(child) | TableCell | Entfernt das angegebene untergeordnete Element. |
removeFromParent() | TableCell | Entfernt das Element aus dem übergeordneten Element. |
replaceText(searchPattern, replacement) | Element | Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke. |
setAttributes(attributes) | TableCell | Legt die Attribute des Elements fest. |
setBackgroundColor(color) | TableCell | Legt die Hintergrundfarbe fest. |
setLinkUrl(url) | TableCell | Legt die Link-URL fest. |
setPaddingBottom(paddingBottom) | TableCell | Legt den unteren Abstand in Punkten fest. |
setPaddingLeft(paddingLeft) | TableCell | Legt den linken Abstand in Punkten fest. |
setPaddingRight(paddingRight) | TableCell | Legt den richtigen Abstand in Punkten fest. |
setPaddingTop(paddingTop) | TableCell | Legt den oberen Abstand in Punkten fest. |
setText(text) | TableCell | Legt den Inhalt als Nur-Text fest. |
setTextAlignment(textAlignment) | TableCell | Legt die Textausrichtung fest. |
setVerticalAlignment(alignment) | TableCell | Legt die vertikale Ausrichtung fest. |
setWidth(width) | TableCell | Legt die Breite der Spalte mit der aktuellen Zelle in Punkten fest. |
TableOfContents
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
clear() | TableOfContents | Löscht den Inhalt des Elements. |
copy() | TableOfContents | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
editAsText() | Text | Ruft eine Text -Version des aktuellen Elements zur Bearbeitung ab. |
findElement(elementType) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs. |
findElement(elementType, from) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit
angegeben: RangeElement . |
findText(searchPattern) | RangeElement | Sucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster. |
findText(searchPattern, from) | RangeElement | Sucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getChild(childIndex) | Element | Ruft das untergeordnete Element im angegebenen untergeordneten Index ab. |
getChildIndex(child) | Integer | Ruft den untergeordneten Index für das angegebene untergeordnete Element ab |
getLinkUrl() | String | Ruft die Link-URL ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getNumChildren() | Integer | Ruft die Anzahl der untergeordneten Elemente ab. |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getText() | String | Ruft den Inhalt des Elements als Textstring ab. |
getTextAlignment() | TextAlignment | Ruft die Textausrichtung ab. |
getType() | ElementType | Ruft den ElementType des Elements ab. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
removeFromParent() | TableOfContents | Entfernt das Element aus dem übergeordneten Element. |
replaceText(searchPattern, replacement) | Element | Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke. |
setAttributes(attributes) | TableOfContents | Legt die Attribute des Elements fest. |
setLinkUrl(url) | TableOfContents | Legt die Link-URL fest. |
setTextAlignment(textAlignment) | TableOfContents | Legt die Textausrichtung fest. |
TableRow
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
appendTableCell() | TableCell | Erstellt eine neue TableCell und hängt sie an. |
appendTableCell(textContents) | TableCell | Hängt die angegebene TableCell an, die den angegebenen Text enthält. |
appendTableCell(tableCell) | TableCell | Hängt die angegebene TableCell an. |
clear() | TableRow | Löscht den Inhalt des Elements. |
copy() | TableRow | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
editAsText() | Text | Ruft eine Text -Version des aktuellen Elements zur Bearbeitung ab. |
findElement(elementType) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs. |
findElement(elementType, from) | RangeElement | Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit
angegeben: RangeElement . |
findText(searchPattern) | RangeElement | Sucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster. |
findText(searchPattern, from) | RangeElement | Sucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getCell(cellIndex) | TableCell | Ruft die TableCell am angegebenen Zellenindex ab. |
getChild(childIndex) | Element | Ruft das untergeordnete Element im angegebenen untergeordneten Index ab. |
getChildIndex(child) | Integer | Ruft den untergeordneten Index für das angegebene untergeordnete Element ab |
getLinkUrl() | String | Ruft die Link-URL ab. |
getMinimumHeight() | Number | Ruft die Mindesthöhe in Punkten ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getNumCells() | Integer | Ruft die Anzahl der Zellen in der Zeile ab. |
getNumChildren() | Integer | Ruft die Anzahl der untergeordneten Elemente ab. |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getParentTable() | Table | Ruft die Table ab, die die aktuelle Zeile enthält. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getText() | String | Ruft den Inhalt des Elements als Textstring ab. |
getTextAlignment() | TextAlignment | Ruft die Textausrichtung ab. |
getType() | ElementType | Ruft den ElementType des Elements ab. |
insertTableCell(childIndex) | TableCell | Erstellt eine neue TableCell und fügt sie im angegebenen Index ein. |
insertTableCell(childIndex, textContents) | TableCell | Fügt den angegebenen TableCell -Wert im angegebenen Index ein, der den angegebenen Text enthält. |
insertTableCell(childIndex, tableCell) | TableCell | Fügt den angegebenen TableCell im angegebenen Index ein. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
merge() | TableRow | Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen. |
removeCell(cellIndex) | TableCell | Entfernt die TableCell am angegebenen Zellenindex. |
removeChild(child) | TableRow | Entfernt das angegebene untergeordnete Element. |
removeFromParent() | TableRow | Entfernt das Element aus dem übergeordneten Element. |
replaceText(searchPattern, replacement) | Element | Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke. |
setAttributes(attributes) | TableRow | Legt die Attribute des Elements fest. |
setLinkUrl(url) | TableRow | Legt die Link-URL fest. |
setMinimumHeight(minHeight) | TableRow | Legt die Mindesthöhe in Punkten fest. |
setTextAlignment(textAlignment) | TableRow | Legt die Textausrichtung fest. |
Text
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
appendText(text) | Text | Fügt den angegebenen Text am Ende dieses Textbereichs hinzu. |
copy() | Text | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
deleteText(startOffset, endOffsetInclusive) | Text | Löscht einen Textbereich. |
editAsText() | Text | Ruft eine Text -Version des aktuellen Elements zur Bearbeitung ab. |
findText(searchPattern) | RangeElement | Sucht mithilfe regulärer Ausdrücke im Inhalt des Elements nach dem angegebenen Textmuster. |
findText(searchPattern, from) | RangeElement | Sucht im Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten in den Suchergebnissen. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getAttributes(offset) | Object | Ruft die Attribute beim angegebenen Zeichenoffset ab. |
getBackgroundColor() | String | Ruft die Einstellung für die Hintergrundfarbe ab. |
getBackgroundColor(offset) | String | Ruft die Hintergrundfarbe beim angegebenen Zeichenoffset ab. |
getFontFamily() | String | Ruft die Einstellung der Schriftfamilie ab. |
getFontFamily(offset) | String | Ruft die Schriftfamilie am angegebenen Zeichenoffset ab. |
getFontSize() | Number | Ruft die Einstellung für die Schriftgröße ab. |
getFontSize(offset) | Number | Ruft die Schriftgröße am angegebenen Zeichenoffset ab. |
getForegroundColor() | String | Ruft die Farbeinstellung im Vordergrund ab. |
getForegroundColor(offset) | String | Ruft die Vordergrundfarbe beim angegebenen Zeichenoffset ab. |
getLinkUrl() | String | Ruft die Link-URL ab. |
getLinkUrl(offset) | String | Ruft die Link-URL am angegebenen Zeichenoffset ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getText() | String | Ruft den Inhalt des Elements als Textstring ab. |
getTextAlignment() | TextAlignment | Ruft die Textausrichtung ab. |
getTextAlignment(offset) | TextAlignment | Ruft 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() | ElementType | Ruft den ElementType des Elements ab. |
insertText(offset, text) | Text | Fügt den angegebenen Text an der angegebenen Zeichenposition ein. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
isBold() | Boolean | Ruft die Einstellung für Fettformatierung ab. |
isBold(offset) | Boolean | Ruft die Fettdruck-Einstellung beim angegebenen Zeichenoffset ab. |
isItalic() | Boolean | Ruft die Einstellung für Kursivschrift ab. |
isItalic(offset) | Boolean | Ruft die Kursivformatierung beim angegebenen Zeichenoffset ab. |
isStrikethrough() | Boolean | Ruft die Einstellung für das Durchstreichen ab. |
isStrikethrough(offset) | Boolean | Ruft die Einstellung für das Durchstreichen beim angegebenen Zeichenoffset ab. |
isUnderline() | Boolean | Ruft die Unterstreichungseinstellung ab. |
isUnderline(offset) | Boolean | Ruft die Unterstreichungseinstellung am angegebenen Zeichenoffset ab. |
merge() | Text | Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen. |
removeFromParent() | Text | Entfernt das Element aus dem übergeordneten Element. |
replaceText(searchPattern, replacement) | Element | Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring, wobei die reguläre Ausdrücke. |
setAttributes(startOffset, endOffsetInclusive, attributes) | Text | Wendet die angegebenen Attribute auf den angegebenen Zeichenbereich an. |
setAttributes(attributes) | Text | Legt die Attribute des Elements fest. |
setBackgroundColor(startOffset, endOffsetInclusive, color) | Text | Legt die Hintergrundfarbe für den angegebenen Zeichenbereich fest. |
setBackgroundColor(color) | Text | Legt die Hintergrundfarbe fest. |
setBold(bold) | Text | Legt die Fettdruck-Einstellung fest. |
setBold(startOffset, endOffsetInclusive, bold) | Text | Legt die Fettdruck-Einstellung für den angegebenen Zeichenbereich fest. |
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName) | Text | Legt die Schriftfamilie für den angegebenen Zeichenbereich fest. |
setFontFamily(fontFamilyName) | Text | Hiermit wird die Schriftfamilie festgelegt. |
setFontSize(startOffset, endOffsetInclusive, size) | Text | Legt die Schriftgröße für den angegebenen Zeichenbereich fest. |
setFontSize(size) | Text | Legt die Schriftgröße fest. |
setForegroundColor(startOffset, endOffsetInclusive, color) | Text | Legt die Vordergrundfarbe für den angegebenen Zeichenbereich fest. |
setForegroundColor(color) | Text | Legt die Vordergrundfarbe fest. |
setItalic(italic) | Text | Legt die Kursivformatierung fest. |
setItalic(startOffset, endOffsetInclusive, italic) | Text | Legt die Kursivformatierung für den angegebenen Zeichenbereich fest. |
setLinkUrl(startOffset, endOffsetInclusive, url) | Text | Legt die Link-URL für den angegebenen Zeichenbereich fest. |
setLinkUrl(url) | Text | Legt die Link-URL fest. |
setStrikethrough(strikethrough) | Text | Legt die Einstellung für das Durchstreichen fest. |
setStrikethrough(startOffset, endOffsetInclusive, strikethrough) | Text | Legt die durchgestrichene Einstellung für den angegebenen Zeichenbereich fest. |
setText(text) | Text | Legt den Textinhalt fest. |
setTextAlignment(startOffset, endOffsetInclusive, textAlignment) | Text | Legt die Textausrichtung für einen bestimmten Zeichenbereich fest. |
setTextAlignment(textAlignment) | Text | Legt die Textausrichtung fest. |
setUnderline(underline) | Text | Legt die Unterstreichungseinstellung fest. |
setUnderline(startOffset, endOffsetInclusive, underline) | Text | Legt die Unterstreichungseinstellung für den angegebenen Zeichenbereich fest. |
TextAlignment
Attribute
Attribut | Typ | Beschreibung |
---|---|---|
NORMAL | Enum | Die normale Textausrichtung. |
SUPERSCRIPT | Enum | Ausrichtung des hochgestellten Textes |
SUBSCRIPT | Enum | Ausrichtung des tiefgestellten Textes. |
UnsupportedElement
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
copy() | UnsupportedElement | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getType() | ElementType | Ruft den ElementType des Elements ab. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
merge() | UnsupportedElement | Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen. |
removeFromParent() | UnsupportedElement | Entfernt das Element aus dem übergeordneten Element. |
setAttributes(attributes) | UnsupportedElement | Legt die Attribute des Elements fest. |
VerticalAlignment
Attribute
Attribut | Typ | Beschreibung |
---|---|---|
BOTTOM | Enum | Die Option zur unteren Ausrichtung. |
CENTER | Enum | Die Option zur zentrierten Ausrichtung. |
TOP | Enum | Die Option "Oben ausrichten". |