Class HorizontalRule Stay organized with collections Save and categorize content based on your preferences.
Page Summary
A
HorizontalRuleis an element representing a horizontal rule in a document.A
HorizontalRulecan be contained within aListItemorParagraphbut cannot contain other elements.Key methods for a
HorizontalRuleinclude copying, retrieving attributes, getting sibling and parent elements, getting its type, checking if it's at the document end, removing it, and setting its attributes.
An element representing an horizontal rule. AHorizontal can be contained within aList orParagraph, but cannot itself contain any other element. For moreinformation on document structure, see theguide to extending Google Docs.
Methods
| Method | Return type | Brief description |
|---|---|---|
copy() | Horizontal | Returns a detached, deep copy of the current element. |
get | Object | Retrieves the element's attributes. |
get | Element|null | Retrieves the element's next sibling element. |
get | Container | Retrieves the element's parent element. |
get | Element|null | Retrieves the element's previous sibling element. |
get | Element | Retrieves the element'sElement. |
is | Boolean | Determines whether the element is at the end of theDocument. |
remove | Horizontal | Removes the element from its parent. |
set | Horizontal | Sets the element's attributes. |
Detailed documentation
copy()
Returns a detached, deep copy of the current element.
Any child elements present in the element are also copied. The new element doesn't have aparent.
Return
Horizontal — The new copy.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documents
getAttributes()
Retrieves the element's attributes.
The result is an object containing a property for each valid element attribute where eachproperty name corresponds to an item in theDocument enumeration.
constdoc=DocumentApp.getActiveDocument();constdocumentTab=doc.getActiveTab().asDocumentTab();constbody=documentTab.getBody();// Append a styled paragraph.constpar=body.appendParagraph('A bold, italicized paragraph.');par.setBold(true);par.setItalic(true);// Retrieve the paragraph's attributes.constatts=par.getAttributes();// Log the paragraph attributes.for(constattinatts){Logger.log(`${att}:${atts[att]}`);}
Return
Object — The element's attributes.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documents
getNextSibling()
Retrieves the element's next sibling element.
The next sibling has the same parent and follows the current element.
Return
Element|null — The next sibling element.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documents
getParent()
Retrieves the element's parent element.
The parent element contains the current element.
Return
Container — The parent element.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documents
getPreviousSibling()
Retrieves the element's previous sibling element.
The previous sibling has the same parent and precedes the current element.
Return
Element|null — The previous sibling element.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documents
getType()
Retrieves the element'sElement.
Useget to determine the exact type of a given element.
constdoc=DocumentApp.getActiveDocument();constdocumentTab=doc.getActiveTab().asDocumentTab();constbody=documentTab.getBody();// Obtain the first element in the active tab's body.constfirstChild=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
Element — The element type.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documents
isAtDocumentEnd()
Determines whether the element is at the end of theDocument.
Return
Boolean — Whether the element is at the end of the tab.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documents
removeFromParent()
Removes the element from its parent.
constdoc=DocumentApp.getActiveDocument();constdocumentTab=doc.getActiveTab().asDocumentTab();constbody=documentTab.getBody();// Remove all images in the active tab's body.constimgs=body.getImages();for(leti=0;i <imgs.length;i++){imgs[i].removeFromParent();}
Return
Horizontal — The removed element.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documents
setAttributes(attributes)
Sets the element's attributes.
The specified attributes parameter must be an object where each property name is an item intheDocument enumeration and each property value is the new value to beapplied.
constdoc=DocumentApp.getActiveDocument();constdocumentTab=doc.getActiveTab().asDocumentTab();constbody=documentTab.getBody();// Define a custom paragraph style.conststyle={};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.constpar=body.appendParagraph('A paragraph with custom style.');// Apply the custom style.par.setAttributes(style);
Parameters
| Name | Type | Description |
|---|---|---|
attributes | Object | The element's attributes. |
Return
Horizontal — The current element.
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
https://www.googleapis.com/auth/documents.currentonlyhttps://www.googleapis.com/auth/documents
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-11 UTC.