Ein Element, das eine horizontale Linie darstellt. Ein Horizontal
kann in einem List
oder Paragraph
enthalten sein, aber selbst kein anderes Element enthalten. Weitere Informationen zur Dokumentstruktur finden Sie im Leitfaden zum Erweitern von Google Docs.
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
copy() | Horizontal | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
get | Object | Ruft die Attribute des Elements ab. |
get | Element | Ruft das nächste gleichgeordnete Element des Elements ab. |
get | Container | Ruft das übergeordnete Element des Elements ab. |
get | Element | Ruft das vorherige gleichgeordnete Element des Elements ab. |
get | Element | Ruft den Element des Elements ab. |
is | Boolean | Bestimmt, ob sich das Element am Ende des Document befindet. |
remove | Horizontal | Entfernt das Element aus dem übergeordneten Element. |
set | Horizontal | Hiermit werden die Attribute des Elements festgelegt. |
Detaillierte Dokumentation
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
Horizontal
– 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
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 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 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 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
is At Document End()
Bestimmt, ob sich das Element am Ende des Document
befindet.
Rückflug
Boolean
: Gibt an, ob sich das Element am Ende des Tabs befindet.
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
Horizontal
: 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
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
Horizontal
: 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