Class FootnoteSection

FootnoteSection

Ein Element, das einen Fußnotenabschnitt darstellt. Ein FootnoteSection enthält den Text, der einem Footnote entspricht. FootnoteSection kann ListItem- oder Paragraph-Elemente enthalten. Weitere Informationen zur Dokumentstruktur finden Sie im Leitfaden zum Erweitern von Google Docs.

Methoden

MethodeRückgabetypKurzbeschreibung
appendParagraph(paragraph)ParagraphHängt die angegebene Paragraph an.
appendParagraph(text)ParagraphErstellt und hängt einen neuen Paragraph mit dem angegebenen Textinhalt an.
clear()FootnoteSectionLöscht den Inhalt des Elements.
copy()FootnoteSectionGibt eine getrennte, tiefgehende Kopie des aktuellen Elements zurück.
editAsText()TextRuft eine Text-Version des aktuellen Elements zum Bearbeiten ab.
findElement(elementType)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.
findElement(elementType, from)RangeElementSucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit dem angegebenen RangeElement.
findText(searchPattern)RangeElementSucht den Inhalt des Elements mithilfe regulärer Ausdrücke nach dem angegebenen Textmuster.
findText(searchPattern, from)RangeElementSucht den Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten Suchergebnis.
getAttributes()ObjectRuft die Attribute des Elements ab.
getChild(childIndex)ElementRuft das untergeordnete Element aus dem angegebenen untergeordneten Index ab.
getChildIndex(child)IntegerRuft den untergeordneten Index für das angegebene untergeordnete Element ab
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getNumChildren()IntegerRuft die Anzahl der untergeordneten Elemente ab.
getParagraphs()Paragraph[]Ruft alle im Abschnitt enthaltenen Paragraphs ab (einschließlich ListItems).
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getText()StringRuft den Inhalt des Elements als Textstring ab.
getTextAlignment()TextAlignmentRuft die Textausrichtung ab.
getType()ElementTypeRuft den ElementType des Elements ab.
insertParagraph(childIndex, paragraph)ParagraphFügt den angegebenen Paragraph in den angegebenen Index ein.
insertParagraph(childIndex, text)ParagraphErstellt am angegebenen Index einen neuen Paragraph und fügt ihn ein, der den angegebenen Textinhalt enthält.
removeChild(child)FootnoteSectionEntfernt das angegebene untergeordnete Element.
removeFromParent()FootnoteSectionEntfernt das Element aus seinem übergeordneten Element.
replaceText(searchPattern, replacement)ElementErsetzt alle Vorkommen eines bestimmten Textmusters mithilfe regulärer Ausdrücke durch einen bestimmten Ersatzstring.
setAttributes(attributes)FootnoteSectionLegt die Attribute des Elements fest.
setText(text)FootnoteSectionLegt den Inhalt als Nur-Text fest.
setTextAlignment(textAlignment)FootnoteSectionLegt die Textausrichtung fest.

Detaillierte Dokumentation

appendParagraph(paragraph)

Hängt die angegebene Paragraph an.

Verwenden Sie diese Version von appendParagraph, wenn Sie eine Kopie einer vorhandenen Paragraph anhängen möchten.

Parameter

NameTypBeschreibung
paragraphParagraphden hinzuzufügenden Absatz

Return

Paragraph: der angehängte Absatz

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

appendParagraph(text)

Erstellt und hängt einen neuen Paragraph mit dem angegebenen Textinhalt an.

Parameter

NameTypBeschreibung
textStringTextinhalt des Absatzes

Return

Paragraph – der neue Absatz

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

clear()

Löscht den Inhalt des Elements.

Return

FootnoteSection – das aktuelle Element


copy()

Gibt eine getrennte, tiefgehende Kopie des aktuellen Elements zurück.

Alle untergeordneten Elemente, die im Element vorhanden sind, werden ebenfalls kopiert. Das neue Element hat kein übergeordnetes Element.

Return

FootnoteSection: Die neue Kopie.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

editAsText()

Ruft eine Text-Version des aktuellen Elements zum Bearbeiten ab.

Verwenden Sie editAsText, um den Inhalt der Elemente im RTF-Format zu bearbeiten. Im Modus editAsText werden Nicht-Textelemente wie InlineImage und HorizontalRule ignoriert.

Untergeordnete Elemente, die vollständig in einem gelöschten Textbereich enthalten sind, werden aus dem Element entfernt.

var body = DocumentApp.getActiveDocument().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);

Return

Text: eine Textversion des aktuellen Elements


findElement(elementType)

Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs.

Parameter

NameTypBeschreibung
elementTypeElementTypeElementtyp, nach dem gesucht werden soll

Return

RangeElement: ein Suchergebnis, das die Position des Suchelements angibt

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

findElement(elementType, from)

Sucht im Inhalt des Elements nach einem Nachfolgerelement des angegebenen Typs, beginnend mit dem angegebenen RangeElement.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

Parameter

NameTypBeschreibung
elementTypeElementTypeElementtyp, nach dem gesucht werden soll
fromRangeElementdas Suchergebnis, in dem gesucht werden soll,

Return

RangeElement: ein Suchergebnis, das die nächste Position des Suchelements angibt

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

findText(searchPattern)

Sucht den Inhalt des Elements mithilfe regulärer Ausdrücke nach dem angegebenen Textmuster.

Einige JavaScript-Funktionen für reguläre Ausdrücke werden nicht vollständig unterstützt, z. B. Erfassungsgruppen und Modusmodifikatoren.

Das angegebene Muster für reguläre Ausdrücke wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.

Parameter

NameTypBeschreibung
searchPatternStringdas Muster, nach dem gesucht werden soll

Return

RangeElement: ein Suchergebnis, das die Position des Suchtextes angibt, oder null, wenn es keine Übereinstimmung gibt

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

findText(searchPattern, from)

Sucht den Inhalt des Elements nach dem angegebenen Textmuster, beginnend mit einem bestimmten Suchergebnis.

Einige JavaScript-Funktionen für reguläre Ausdrücke werden nicht vollständig unterstützt, z. B. Erfassungsgruppen und Modusmodifikatoren.

Das angegebene Muster für reguläre Ausdrücke wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.

Parameter

NameTypBeschreibung
searchPatternStringdas Muster, nach dem gesucht werden soll
fromRangeElementdas Suchergebnis, in dem gesucht werden soll,

Return

RangeElement: ein Suchergebnis, das die nächste Position des Suchtexts angibt, oder null, wenn es keine Übereinstimmung gibt

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getAttributes()

Ruft die Attribute des Elements ab.

Das Ergebnis ist ein Objekt, das ein Attribut für jedes gültige Elementattribut enthält, wobei jeder Attributname einem Element in der DocumentApp.Attribute-Aufzählung entspricht.

var body = DocumentApp.getActiveDocument().getBody();

// Append a styled paragraph.
var par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
var atts = par.getAttributes();

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

Return

Object: Die Attribute des Elements.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getChild(childIndex)

Ruft das untergeordnete Element aus dem angegebenen untergeordneten Index ab.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document.
var 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

NameTypBeschreibung
childIndexIntegerIndex des abzurufenden untergeordneten Elements

Return

Element: das untergeordnete Element beim angegebenen Index

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getChildIndex(child)

Ruft den untergeordneten Index für das angegebene untergeordnete Element ab

Parameter

NameTypBeschreibung
childElementDas untergeordnete Element, für das der Index abgerufen werden soll

Return

Integer – der untergeordnete Index

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNextSibling()

Ruft das nächste gleichgeordnete Element des Elements ab.

Das nächste gleichgeordnete Element hat das gleiche übergeordnete Element und folgt dem aktuellen Element.

Return

Element: Das nächste gleichgeordnete Element.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNumChildren()

Ruft die Anzahl der untergeordneten Elemente ab.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Log the number of elements in the document.
Logger.log("There are " + body.getNumChildren() +
    " elements in the document body.");

Return

Integer: die Anzahl der untergeordneten Elemente

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getParagraphs()

Ruft alle im Abschnitt enthaltenen Paragraphs ab (einschließlich ListItems).

Return

Paragraph[]: die Absätze des Abschnitts

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getParent()

Ruft das übergeordnete Element des Elements ab.

Das übergeordnete Element enthält das aktuelle Element.

Return

ContainerElement: Das übergeordnete Element.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getPreviousSibling()

Ruft das vorherige gleichgeordnete Element des Elements ab.

Das vorherige gleichgeordnete Element hat das gleiche übergeordnete Element und steht dem aktuellen Element vor.

Return

Element: Das vorherige gleichgeordnete Element.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getText()

Ruft den Inhalt des Elements als Textstring ab.

Return

String: der Inhalt des Elements als Textstring

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getTextAlignment()

Ruft die Textausrichtung ab. Die verfügbaren Ausrichtungstypen sind DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT und DocumentApp.TextAlignment.SUPERSCRIPT.

Return

TextAlignment: der Typ der Textausrichtung, oder null, wenn der Text mehrere Arten von Textausrichtungen enthält oder wenn die Textausrichtung nie festgelegt wurde

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getType()

Ruft den ElementType des Elements ab.

Verwenden Sie getType(), um den genauen Typ eines bestimmten Elements zu bestimmen.

var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document body.

var 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.');
}

Return

ElementType: Der Elementtyp.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertParagraph(childIndex, paragraph)

Fügt den angegebenen Paragraph in den angegebenen Index ein.

Parameter

NameTypBeschreibung
childIndexIntegerIndex, an dem eingefügt werden soll
paragraphParagraphden einzufügenden Absatz

Return

Paragraph: der eingefügte Absatz

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertParagraph(childIndex, text)

Erstellt am angegebenen Index einen neuen Paragraph und fügt ihn ein, der den angegebenen Textinhalt enthält.

Parameter

NameTypBeschreibung
childIndexIntegerIndex, an dem eingefügt werden soll
textStringTextinhalt des Absatzes

Return

Paragraph – der neue Absatz

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeChild(child)

Entfernt das angegebene untergeordnete Element.

Parameter

NameTypBeschreibung
childElementDas untergeordnete Element, das entfernt werden soll

Return

FootnoteSection – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeFromParent()

Entfernt das Element aus seinem übergeordneten Element.

var body = DocumentApp.getActiveDocument().getBody();

// Remove all images in the document body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Return

FootnoteSection: Das entfernte Element.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

replaceText(searchPattern, replacement)

Ersetzt alle Vorkommen eines bestimmten Textmusters mithilfe regulärer Ausdrücke durch einen bestimmten Ersatzstring.

Das Suchmuster wird als String und nicht als JavaScript-Objekt für reguläre Ausdrücke übergeben. Aus diesem Grund müssen Sie umgekehrte Schrägstriche im Muster mit Escapezeichen versehen.

Bei dieser Methode wird die RE2 von Google für reguläre Ausdrücke verwendet, die die unterstützte Syntax begrenzt.

Das angegebene Muster für reguläre Ausdrücke wird unabhängig mit jedem Textblock im aktuellen Element abgeglichen.

var body = DocumentApp.getActiveDocument().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText("^.*Apps ?Script.*$", "Apps Script");

Parameter

NameTypBeschreibung
searchPatternStringDas Regex-Muster, nach dem gesucht werden soll
replacementStringden als Ersatz zu verwendenden Text

Return

Element – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setAttributes(attributes)

Legt die Attribute des Elements fest.

Der angegebene Attributparameter muss ein Objekt sein, bei dem jeder Attributname ein Element in der DocumentApp.Attribute-Aufzählung und jeder Attributwert der neue Wert ist, der angewendet werden soll.

var body = DocumentApp.getActiveDocument().getBody();

// Define a custom paragraph style.
var 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.
var par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Parameter

NameTypBeschreibung
attributesObjectDie Attribute des Elements.

Return

FootnoteSection: Das aktuelle Element.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setText(text)

Legt den Inhalt als Nur-Text fest.

Hinweis: Vorhandene Inhalte werden gelöscht.

Parameter

NameTypBeschreibung
textStringden neuen Textinhalt

Return

FootnoteSection – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setTextAlignment(textAlignment)

Legt die Textausrichtung fest. Die verfügbaren Ausrichtungstypen sind DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT und DocumentApp.TextAlignment.SUPERSCRIPT.

// Make the entire first paragraph be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parameter

NameTypBeschreibung
textAlignmentTextAlignmentdie Art der anzuwendenden Textausrichtung

Return

FootnoteSection – das aktuelle Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

Verworfene Methoden