Class Footnote

Fußnote

Ein Element, das eine Fußnote darstellt. Jede Footnote befindet sich in einem ListItem oder Paragraph und hat ein entsprechendes FootnoteSection Element für den Inhalt der Fußnote. Die Footnote selbst kann keine anderen Elemente enthalten. Weitere Informationen zur Dokumentstruktur finden Sie im Leitfaden zum Erweitern von Google Docs.

Methoden

MethodeRückgabetypKurzbeschreibung
copy()FootnoteGibt eine getrennte, tiefe Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getFootnoteContents()FootnoteSection|nullRuft den Inhalt des Fußnotenelements ab.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft das Element ElementType ab.
isAtDocumentEnd()BooleanErmittelt, ob sich das Element am Ende des Document befindet.
removeFromParent()Footnote|nullEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)FootnoteLegt die Attribute des Elements fest.

Detaillierte Dokumentation

copy()

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

Alle im Element vorhandenen untergeordneten Elemente werden ebenfalls kopiert. Das neue Element hat kein übergeordnetes Element.

Rückgabe

Footnote : Die neue Kopie.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 mit einer Property für jedes gültige Elementattribut. Jeder Propertyname entspricht einem Element in der DocumentApp.Attribute-Enumeration. 

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ückgabe

Object : Die Attribute des Elements.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getFootnoteContents()

Ruft den Inhalt des Fußnotenelements ab.

Rückgabe

FootnoteSection|null : Der Fußnotenbereich

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 dasselbe übergeordnete Element und folgt auf das aktuelle Element.

Rückgabe

Element|null : Das nächste gleichgeordnete Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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.

Rückgabe

ContainerElement|null : Das übergeordnete Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 dasselbe übergeordnete Element und geht dem aktuellen Element voraus.

Rückgabe

Element|null : Das vorherige gleichgeordnete Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getType()

Ruft den ElementType des Elements ab.

Mit getType() 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ückgabe

ElementType : Der Elementtyp.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

isAtDocumentEnd()

Ermittelt, ob sich das Element am Ende des Document befindet.

Rückgabe

Boolean : Gibt an, ob sich das Element am Ende des Tabs befindet.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

removeFromParent()

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ückgabe

Footnote|null : Das entfernte Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setAttributes(attributes)

Legt die Attribute des Elements fest.

Der angegebene Parameter für die Attribute muss ein Objekt sein, bei dem jeder Propertyname ein Element in der DocumentApp.Attribute-Enumeration ist und jeder Propertywert der neue anzuwendende Wert ist. 

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

NameTypBeschreibung
attributesObjectDie Attribute des Elements.

Rückgabe

Footnote : Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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