Ein Element, das einen Fußnotenabschnitt darstellt. Ein Footnote
enthält den Text, der einem Footnote
entspricht. Das Footnote
-Element kann List
- oder Paragraph
-Elemente enthalten. Weitere Informationen zur Dokumentstruktur finden Sie im Leitfaden zum Erweitern von Google Docs.
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
append | Paragraph | Hängt die angegebene Paragraph an. |
append | Paragraph | Erstellt und hängt eine neue Paragraph mit dem angegebenen Textinhalt an. |
clear() | Footnote | Der Inhalt des Elements wird gelöscht. |
copy() | Footnote | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
edit | Text | Ruft eine Text -Version des aktuellen Elements zur Bearbeitung ab. |
find | Range | Es wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht. |
find | Range | Es wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen Range . |
find | Range | Es wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht. |
find | Range | Es wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis. |
get | Object | Ruft die Attribute des Elements ab. |
get | Element | Ruft das untergeordnete Element am angegebenen untergeordneten Index ab. |
get | Integer | Ruft den untergeordneten Index für das angegebene untergeordnete Element ab. |
get | Element | Ruft das nächste gleichgeordnete Element des Elements ab. |
get | Integer | Ruft die Anzahl der untergeordneten Elemente ab. |
get | Paragraph[] | Hiermit werden alle Paragraphs im Abschnitt abgerufen, einschließlich List . |
get | Container | Ruft das übergeordnete Element des Elements ab. |
get | Element | Ruft das vorherige gleichgeordnete Element des Elements ab. |
get | String | Ruft den Inhalt des Elements als Textstring ab. |
get | Text | Die Textausrichtung wird abgerufen. |
get | Element | Ruft den Element des Elements ab. |
insert | Paragraph | Fügt das angegebene Paragraph an der angegebenen Position ein. |
insert | Paragraph | Erstellt und fügt am angegebenen Index eine neue Paragraph mit dem angegebenen Textinhalt ein. |
remove | Footnote | Entfernt das angegebene untergeordnete Element. |
remove | Footnote | Entfernt das Element aus dem übergeordneten Element. |
replace | Element | Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken. |
set | Footnote | Hiermit werden die Attribute des Elements festgelegt. |
set | Footnote | Der Inhalt wird als Nur-Text festgelegt. |
set | Footnote | Hiermit wird die Textausrichtung festgelegt. |
Detaillierte Dokumentation
append Paragraph(paragraph)
Hängt die angegebene Paragraph
an.
Verwenden Sie diese Version von append
, wenn Sie eine Kopie einer vorhandenen Paragraph
anhängen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
paragraph | Paragraph | Der Absatz, der angehängt werden soll. |
Rückflug
Paragraph
: Der angehängte Absatz.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Paragraph(text)
Erstellt und hängt eine neue Paragraph
mit dem angegebenen Textinhalt an.
Parameter
Name | Typ | Beschreibung |
---|---|---|
text | String | Der Textinhalt des Absatzes. |
Rückflug
Paragraph
– der neue Absatz.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
Alle untergeordneten Elemente im Element werden ebenfalls kopiert. Das neue Element hat kein übergeordnetes Element.
Rückflug
Footnote
– die neue Kopie.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
edit As Text()
Ruft eine Text
-Version des aktuellen Elements zur Bearbeitung ab.
Verwenden Sie edit
, um den Inhalt des Elements als Rich-Text zu bearbeiten. Im edit
-Modus werden nicht textbasierte Elemente wie Inline
und Horizontal
ignoriert.
Untergeordnete Elemente, die vollständig in einem gelöschten Textbereich enthalten sind, werden aus dem Element entfernt.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, 'An editAsText sample.'); body.insertHorizontalRule(0); body.insertParagraph(0, 'An example.'); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
Rückflug
Text
: eine Textversion des aktuellen Elements
find Element(elementType)
Es wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht.
Parameter
Name | Typ | Beschreibung |
---|---|---|
element | Element | Der Elementtyp, nach dem gesucht werden soll. |
Rückflug
Range
: Ein Suchergebnis, das die Position des Suchelements angibt.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Element(elementType, from)
Es wird im Inhalt des Elements nach einem Nachkommen des angegebenen Typs gesucht, beginnend bei der angegebenen Range
.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. let searchResult = null; // Search until the paragraph is found. while ( (searchResult = body.findElement( DocumentApp.ElementType.PARAGRAPH, searchResult, ))) { const par = searchResult.getElement().asParagraph(); if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) { // Found one, update and stop. par.setText('This is the first header.'); break; } }
Parameter
Name | Typ | Beschreibung |
---|---|---|
element | Element | Der Elementtyp, nach dem gesucht werden soll. |
from | Range | Das Suchergebnis, in dem gesucht werden soll. |
Rückflug
Range
: Ein Suchergebnis, das die nächste Position des Suchelements angibt.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Text(searchPattern)
Es wird mit regulären Ausdrücken im Inhalt des Elements nach dem angegebenen Textmuster gesucht.
Einige der Funktionen für reguläre Ausdrücke in JavaScript werden nicht vollständig unterstützt, z. B. Erfassungsgruppen und Modusmodifikatoren.
Das angegebene reguläre Ausdrucksmuster wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
search | String | das zu suchende Muster |
Rückflug
Range
: ein Suchergebnis, das die Position des Suchtexts angibt, oder „null“, wenn keine Übereinstimmung gefunden wurde
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Text(searchPattern, from)
Es wird im Inhalt des Elements nach dem angegebenen Textmuster gesucht, beginnend bei einem bestimmten Suchergebnis.
Einige der Funktionen für reguläre Ausdrücke in JavaScript werden nicht vollständig unterstützt, z. B. Erfassungsgruppen und Modusmodifikatoren.
Das angegebene reguläre Ausdrucksmuster wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
search | String | das zu suchende Muster |
from | Range | das Suchergebnis, in dem gesucht werden soll |
Rückflug
Range
: ein Suchergebnis, das die nächste Position des Suchtexts angibt, oder „null“, wenn keine Übereinstimmung gefunden wurde
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Attributes()
Ruft die Attribute des Elements ab.
Das Ergebnis ist ein Objekt mit einer Property für jedes gültige Elementattribut, wobei jeder Property-Name einem Element in der Document
-Aufzählung entspricht.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. const atts = par.getAttributes(); // Log the paragraph attributes. for (const att in atts) { Logger.log(`${att}:${atts[att]}`); }
Rückflug
Object
: Die Attribute des Elements.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Child(childIndex)
Ruft das untergeordnete Element am angegebenen untergeordneten Index ab.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. const firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText('This is the first paragraph.'); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
child | Integer | Der Index des untergeordneten Elements, das abgerufen werden soll. |
Rückflug
Element
: Das untergeordnete Element am angegebenen Index.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Child Index(child)
Ruft den untergeordneten Index für das angegebene untergeordnete Element ab.
Parameter
Name | Typ | Beschreibung |
---|---|---|
child | Element | Das untergeordnete Element, für das der Index abgerufen werden soll. |
Rückflug
Integer
: Der untergeordnete Index.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Next Sibling()
Ruft das nächste gleichgeordnete Element des Elements ab.
Das nächste gleichgeordnete Element hat dasselbe übergeordnete Element und folgt dem aktuellen Element.
Rückflug
Element
: Das nächste gleichgeordnete Element.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Num Children()
Ruft die Anzahl der untergeordneten Elemente ab.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Log the number of elements in the tab. Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);
Rückflug
Integer
– Die Anzahl der untergeordneten Elemente.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Paragraphs()
Hiermit werden alle Paragraphs
im Abschnitt abgerufen, einschließlich List
.
Rückflug
Paragraph[]
– die Absätze des Abschnitts.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Parent()
Ruft das übergeordnete Element des Elements ab.
Das übergeordnete Element enthält das aktuelle Element.
Rückflug
Container
: Das übergeordnete Element.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Previous Sibling()
Ruft das vorherige gleichgeordnete Element des Elements ab.
Das vorherige gleichgeordnete Element hat dasselbe übergeordnete Element und geht dem aktuellen Element voraus.
Rückflug
Element
: Das vorherige gleichgeordnete Element.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Text()
Ruft den Inhalt des Elements als Textstring ab.
Rückflug
String
: Der Inhalt des Elements als Textstring
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Text Alignment()
Die Textausrichtung wird abgerufen. Verfügbare Ausrichtungstypen sind Document
, Document
und Document
.
Rückflug
Text
– die Art der Textausrichtung oder null
, wenn der Text mehrere Textausrichtungen enthält oder die Textausrichtung noch nie festgelegt wurde
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Type()
Ruft den Element
des Elements ab.
Mit get
können Sie den genauen Typ eines bestimmten Elements ermitteln.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Obtain the first element in the active tab's body. const firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Rückflug
Element
: Der Elementtyp.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Paragraph(childIndex, paragraph)
Fügt das angegebene Paragraph
an der angegebenen Position ein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
child | Integer | Der Index, an dem eingefügt werden soll. |
paragraph | Paragraph | Der einzufügende Absatz. |
Rückflug
Paragraph
: Der eingefügte Absatz.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Paragraph(childIndex, text)
Erstellt und fügt am angegebenen Index eine neue Paragraph
mit dem angegebenen Textinhalt ein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
child | Integer | Der Index, an dem eingefügt werden soll. |
text | String | Der Textinhalt des Absatzes. |
Rückflug
Paragraph
– der neue Absatz.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove Child(child)
Entfernt das angegebene untergeordnete Element.
Parameter
Name | Typ | Beschreibung |
---|---|---|
child | Element | Das untergeordnete Element, das entfernt werden soll. |
Rückflug
Footnote
: Das aktuelle Element.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove From Parent()
Entfernt das Element aus dem übergeordneten Element.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Remove all images in the active tab's body. const imgs = body.getImages(); for (let i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Rückflug
Footnote
: Das entfernte Element.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replace Text(searchPattern, replacement)
Ersetzt alle Vorkommen eines bestimmten Textmusters durch einen bestimmten Ersatzstring mithilfe von regulären Ausdrücken.
Das Suchmuster wird als String übergeben, nicht als JavaScript-Objekt für reguläre Ausdrücke. Aus diesem Grund müssen alle umgekehrten Schrägstriche im Muster maskiert werden.
Bei dieser Methode wird die reguläre Ausdrucksbibliothek RE2 von Google verwendet, was die unterstützte Syntax einschränkt.
Das angegebene reguläre Ausdrucksmuster wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.*Apps ?Script.*$', 'Apps Script');
Parameter
Name | Typ | Beschreibung |
---|---|---|
search | String | das Regex-Muster, nach dem gesucht werden soll |
replacement | String | den zu ersetzenden Text |
Rückflug
Element
– das aktuelle Element
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Attributes(attributes)
Hiermit werden die Attribute des Elements festgelegt.
Der angegebene Attributparameter muss ein Objekt sein, bei dem jeder Attributname ein Element in der Aufzählung Document
ist und jeder Attributwert der neue Wert ist, der angewendet werden soll.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Define a custom paragraph style. const style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. const par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Parameter
Name | Typ | Beschreibung |
---|---|---|
attributes | Object | Die Attribute des Elements. |
Rückflug
Footnote
: Das aktuelle Element.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Text(text)
Der Inhalt wird als Nur-Text festgelegt.
Hinweis: Vorhandene Inhalte werden gelöscht.
Parameter
Name | Typ | Beschreibung |
---|---|---|
text | String | Der neue Textinhalt. |
Rückflug
Footnote
: Das aktuelle Element.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Text Alignment(textAlignment)
Hiermit wird die Textausrichtung festgelegt. Verfügbare Ausrichtungstypen sind Document
, Document
und Document
.
// Make the entire first paragraph in the active tab be superscript. const documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); const text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Parameter
Name | Typ | Beschreibung |
---|---|---|
text | Text | die Art der Textausrichtung |
Rückflug
Footnote
– das aktuelle Element
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents