Class ListItem

    • A ListItem in Google Docs is a Paragraph linked by a list ID that maintains consecutive numbering within its list.

    • ListItem elements can contain various document elements like images, text, equations, and page breaks.

    • Numerous methods are available to manipulate ListItem elements, including adding, getting information about, modifying, removing, and searching within them.

    • Many ListItem methods require specific authorization scopes like https://www.googleapis.com/auth/documents.currentonly or https://www.googleapis.com/auth/documents .
    List Item

    An element representing a list item. A List Item is a Paragraph that is associated with a list ID. A List Item may contain Equation , Footnote , Horizontal Rule , Inline Drawing , Inline Image , Page Break , and Text elements. For more information on document structure, see the guide to extending Google Docs .

    List Items may not contain new-line characters. New-line characters ("\n") are converted to line-break characters ("\r").

    List Items with the same list ID belong to the same list and are numbered accordingly. The List Items for a given list are not required to be adjacent in the tab or even have the same parent element. Two items belonging to the same list may exist anywhere in the tab while maintaining consecutive numbering, as the following example illustrates:

     const 
  
 body 
  
 = 
  
 DocumentApp 
 . 
 getActiveDocument 
 (). 
 getActiveTab 
 (). 
 asDocumentTab 
 (). 
 getBody 
 (); 
 // Append a new list item to the body. 
 const 
  
 item1 
  
 = 
  
 body 
 . 
 appendListItem 
 ( 
 'Item 1' 
 ); 
 // Log the new list item's list ID. 
 Logger 
 . 
 log 
 ( 
 item1 
 . 
 getListId 
 ()); 
 // Append a table after the list item. 
 body 
 . 
 appendTable 
 ([[ 
 'Cell 1' 
 , 
  
 'Cell 2' 
 ]]); 
 // Append a second list item with the same list ID. The two items are treated as 
 // the same list, despite not being consecutive. 
 const 
  
 item2 
  
 = 
  
 body 
 . 
 appendListItem 
 ( 
 'Item 2' 
 ); 
 item2 
 . 
 setListId 
 ( 
 item1 
 );

    Methods

    Method Return type Brief description
    add Positioned Image(image)
    		Positioned Image Creates and inserts a new Positioned Image from the specified image blob.
    append Horizontal Rule()
    		Horizontal Rule Creates and appends a new Horizontal Rule .
    append Inline Image(image)
    		Inline Image Creates and appends a new Inline Image from the specified image blob.
    append Inline Image(image)
    		Inline Image Appends the given Inline Image .
    append Page Break()
    		Page Break Creates and appends a new Page Break .
    append Page Break(pageBreak)
    		Page Break Appends the given Page Break .
    append Text(text)
    		Text Creates and appends a new Text element with the specified contents.
    append Text(text)
    		Text Appends the given Text element.
    clear()
    		List Item Clears the contents of the element.
    copy()
    		List Item Returns a detached, deep copy of the current element.
    edit As Text()
    		Text Obtains a Text version of the current element, for editing.
    find Element(elementType)
    		Range Element Searches the contents of the element for a descendant of the specified type.
    find Element(elementType, from)
    		Range Element Searches the contents of the element for a descendant of the specified type, starting from the specified Range Element .
    find Text(searchPattern)
    		Range Element Searches the contents of the element for the specified text pattern using regular expressions.
    find Text(searchPattern, from)
    		Range Element Searches the contents of the element for the specified text pattern, starting from a given search result.
    get Alignment()
    		Horizontal Alignment Retrieves the Horizontal Alignment .
    get Attributes()
    		Object Retrieves the element's attributes.
    get Child(childIndex)
    		Element Retrieves the child element at the specified child index.
    get Child Index(child)
    		Integer Retrieves the child index for the specified child element.
    get Glyph Type()
    		Glyph Type Retrieves the list item's Glyph Type .
    get Heading()
    		Paragraph Heading Retrieves the Paragraph Heading .
    get Indent End()
    		Number Retrieves the end indentation, in points.
    get Indent First Line()
    		Number Retrieves the first line indentation, in points.
    get Indent Start()
    		Number Retrieves the start indentation.
    get Line Spacing()
    		Number Retrieves the line spacing, in points.
    get Link Url()
    		String Retrieves the link url.
    get List Id()
    		String Retrieves the list ID.
    get Nesting Level()
    		Integer Retrieves the list item's nesting level.
    get Next Sibling()
    		Element Retrieves the element's next sibling element.
    get Num Children()
    		Integer Retrieves the number of children.
    get Parent()
    		Container Element Retrieves the element's parent element.
    get Positioned Image(id)
    		Positioned Image Gets a Positioned Image by the image's ID.
    get Positioned Images()
    		Positioned Image[] Gets all Positioned Image objects anchored to the paragraph.
    get Previous Sibling()
    		Element Retrieves the element's previous sibling element.
    get Spacing After()
    		Number Retrieves the spacing after the element, in points.
    get Spacing Before()
    		Number Retrieves the spacing before the element, in points.
    get Text()
    		String Retrieves the contents of the element as a text string.
    get Text Alignment()
    		Text Alignment Gets the text alignment.
    get Type()
    		Element Type Retrieves the element's Element Type .
    insert Horizontal Rule(childIndex)
    		Horizontal Rule Creates and inserts a Horizontal Rule at the specified index.
    insert Inline Image(childIndex, image)
    		Inline Image Creates and inserts a new Inline Image from the specified image blob, at the specified index.
    insert Inline Image(childIndex, image)
    		Inline Image Inserts the given Inline Image at the specified index.
    insert Page Break(childIndex)
    		Page Break Creates and inserts a new Page Break at the specified index.
    insert Page Break(childIndex, pageBreak)
    		Page Break Inserts the given Page Break at the specified index.
    insert Text(childIndex, text)
    		Text Creates and inserts a new text element at the specified index.
    insert Text(childIndex, text)
    		Text Inserts the given Text element at the specified index, with the specified text contents.
    is At Document End()
    		Boolean Determines whether the element is at the end of the Document .
    is Left To Right()
    		Boolean Retrieves the left-to-right setting.
    merge()
    		List Item Merges the element with the preceding sibling of the same type.
    remove Child(child)
    		List Item Removes the specified child element.
    remove From Parent()
    		List Item Removes the element from its parent.
    remove Positioned Image(id)
    		Boolean Removes a Positioned Image by the image's ID.
    replace Text(searchPattern, replacement)
    		Element Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions.
    set Alignment(alignment)
    		List Item Sets the Horizontal Alignment .
    set Attributes(attributes)
    		List Item Sets the element's attributes.
    set Glyph Type(glyphType)
    		List Item Sets the list item's Glyph Type .
    set Heading(heading)
    		List Item Sets the Paragraph Heading .
    set Indent End(indentEnd)
    		List Item Sets the end indentation, in points.
    set Indent First Line(indentFirstLine)
    		List Item Sets the first line indentation, in points.
    set Indent Start(indentStart)
    		List Item Sets the start indentation, in points.
    set Left To Right(leftToRight)
    		List Item Sets the left-to-right setting.
    set Line Spacing(multiplier)
    		List Item Sets the line spacing, as a quantity indicating the number of lines to use for spacing.
    set Link Url(url)
    		List Item Sets the link url.
    set List Id(listItem)
    		List Item Sets the list ID.
    set Nesting Level(nestingLevel)
    		List Item Sets the list item's nesting level.
    set Spacing After(spacingAfter)
    		List Item Sets the spacing after the element, in points.
    set Spacing Before(spacingBefore)
    		List Item Sets the spacing before the element, in points.
    set Text(text)
    		void Sets the contents of the list item as text.
    set Text Alignment(textAlignment)
    		List Item Sets the text alignment.

    Detailed documentation

    add Positioned Image(image)

    Creates and inserts a new Positioned Image from the specified image blob.

    Parameters

    Name Type Description
    image
    		Blob Source the image data

    Return

    Positioned Image — the new positioned image

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    append Horizontal Rule()

    Creates and appends a new Horizontal Rule .

    Return

    Horizontal Rule — the new horizontal rule

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    append Inline Image(image)

    Creates and appends a new Inline Image from the specified image blob.

    Parameters

    Name Type Description
    image
    		Blob Source the image data

    Return

    Inline Image — the appended image

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    append Inline Image(image)

    Appends the given Inline Image .

    Parameters

    Name Type Description
    image
    		Inline Image the image data

    Return

    Inline Image — the appended image

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    append Page Break()

    Creates and appends a new Page Break .

    Note: Page Breaks may not be contained within Table Cells . If the current element is contained in a table cell, an exception will be thrown.

    Return

    Page Break — the new page break element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    append Page Break(pageBreak)

    Appends the given Page Break .

    Note: Page Breaks may not be contained within Table Cells . If the current element is contained in a table cell, an exception will be thrown.

    Parameters

    Name Type Description
    page Break
    		Page Break the page break to append

    Return

    Page Break — the appended page break element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    append Text(text)

    Creates and appends a new Text element with the specified contents.

    Parameters

    Name Type Description
    text
    		String the text contents

    Return

    Text — the new text element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    append Text(text)

    Appends the given Text element.

    Parameters

    Name Type Description
    text
    		Text the text element to append

    Return

    Text — the appended text element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    clear()

    Clears the contents of the element.

    Return

    List Item — The current element.

    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 a parent.

    Return

    List Item — The new copy.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    edit As Text()

    Obtains a Text version of the current element, for editing.

    Use edit As Text for manipulating the elements contents as rich text. The edit As Text mode ignores non-text elements (such as Inline Image and Horizontal Rule ).

    Child elements fully contained within a deleted text range are removed from the element.

     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 
 );

    Return

    Text — a text version of the current element

    find Element(elementType)

    Searches the contents of the element for a descendant of the specified type.

    Parameters

    Name Type Description
    element Type
    		Element Type The type of element to search for.

    Return

    Range Element — A search result indicating the position of the search element.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    find Element(elementType, from)

    Searches the contents of the element for a descendant of the specified type, starting from the specified Range Element .

     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 
 ; 
  
 } 
 }

    Parameters

    Name Type Description
    element Type
    		Element Type The type of element to search for.
    from
    		Range Element The search result to search from.

    Return

    Range Element — A search result indicating the next position of the search element.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    find Text(searchPattern)

    Searches the contents of the element for the specified text pattern using regular expressions.

    A subset of the JavaScript regular expression features are not fully supported, such as capture groups and mode modifiers.

    The provided regular expression pattern is independently matched against each text block contained in the current element.

    Parameters

    Name Type Description
    search Pattern
    		String the pattern to search for

    Return

    Range Element — a search result indicating the position of the search text, or null if there is no match

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    find Text(searchPattern, from)

    Searches the contents of the element for the specified text pattern, starting from a given search result.

    A subset of the JavaScript regular expression features are not fully supported, such as capture groups and mode modifiers.

    The provided regular expression pattern is independently matched against each text block contained in the current element.

    Parameters

    Name Type Description
    search Pattern
    		String the pattern to search for
    from
    		Range Element the search result to search from

    Return

    Range Element — a search result indicating the next position of the search text, or null if there is no match

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Alignment()

    Retrieves the Horizontal Alignment .

    Return

    Horizontal Alignment — the alignment

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Attributes()

    Retrieves the element's attributes.

    The result is an object containing a property for each valid element attribute where each property name corresponds to an item in the Document App.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 
 ] 
 } 
 ` 
 ); 
 }

    Return

    Object — The element's attributes.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Child(childIndex)

    Retrieves the child element at the specified child index.

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

    Parameters

    Name Type Description
    child Index
    		Integer The index of the child element to retrieve.

    Return

    Element — The child element at the specified index.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Child Index(child)

    Retrieves the child index for the specified child element.

    Parameters

    Name Type Description
    child
    		Element The child element for which to retrieve the index.

    Return

    Integer — The child index.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Glyph Type()

    Retrieves the list item's Glyph Type .

    Return

    Glyph Type — the glyph type

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Heading()

    Retrieves the Paragraph Heading .

    Return

    Paragraph Heading — the heading

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Indent End()

    Retrieves the end indentation, in points.

    Return

    Number — the end indentation, in points

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Indent First Line()

    Retrieves the first line indentation, in points.

    Return

    Number — the first line indentation, in points

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Indent Start()

    Retrieves the start indentation.

    Return

    Number — the start indentation

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Line Spacing()

    Retrieves the line spacing, in points.

    Return

    Number — the line spacing, in points

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Link Url()

    Retrieves the link url.

    Return

    String — the link url, or null if the element contains multiple values for this attribute

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get List Id()

    Retrieves the list ID.

    Return

    String — the list ID

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Nesting Level()

    Retrieves the list item's nesting level.

    By default, list items have a nesting level of zero. The nesting level determines the glyph that is used by the list item.

    Return

    Integer — the nesting level

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Next Sibling()

    Retrieves the element's next sibling element.

    The next sibling has the same parent and follows the current element.

    Return

    Element — The next sibling element.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Num Children()

    Retrieves the number of children.

     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.` 
 );

    Return

    Integer — The number of children.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Parent()

    Retrieves the element's parent element.

    The parent element contains the current element.

    Return

    Container Element — The parent element.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Positioned Image(id)

    Gets a Positioned Image by the image's ID.

    Parameters

    Name Type Description
    id
    		String the image id

    Return

    Positioned Image — the positioned image

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Positioned Images()

    Gets all Positioned Image objects anchored to the paragraph.

    Return

    Positioned Image[] — a list of positioned images

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Previous Sibling()

    Retrieves the element's previous sibling element.

    The previous sibling has the same parent and precedes the current element.

    Return

    Element — The previous sibling element.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Spacing After()

    Retrieves the spacing after the element, in points.

    Return

    Number — the spacing after the element, in points

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Spacing Before()

    Retrieves the spacing before the element, in points.

    Return

    Number — the spacing before the element, in points

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Text()

    Retrieves the contents of the element as a text string.

    Return

    String — the contents of the element as text string

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Text Alignment()

    Gets the text alignment. The available types of alignment are Document App.TextAlignment.NORMAL , Document App.TextAlignment.SUBSCRIPT , and Document App.TextAlignment.SUPERSCRIPT .

    Return

    Text Alignment — the type of text alignment, or null if the text contains multiple types of text alignments or if the text alignment has never been set

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    get Type()

    Retrieves the element's Element Type .

    Use get Type() to determine the exact type of a given element.

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

    Return

    Element Type — The element type.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    insert Horizontal Rule(childIndex)

    Creates and inserts a Horizontal Rule at the specified index.

    Parameters

    Name Type Description
    child Index
    		Integer the index at which to insert the element

    Return

    Horizontal Rule — the new horizontal rule element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    insert Inline Image(childIndex, image)

    Creates and inserts a new Inline Image from the specified image blob, at the specified index.

    Parameters

    Name Type Description
    child Index
    		Integer the index at which to insert the element
    image
    		Blob Source the image data

    Return

    Inline Image — the inserted inline image element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    insert Inline Image(childIndex, image)

    Inserts the given Inline Image at the specified index.

    Parameters

    Name Type Description
    child Index
    		Integer the index at which to insert the element
    image
    		Inline Image the image data

    Return

    Inline Image — the inserted inline image element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    insert Page Break(childIndex)

    Creates and inserts a new Page Break at the specified index.

    Note: Page Breaks may not be contained within Table Cells . If the current element is contained in a table cell, an exception will be thrown.

    Parameters

    Name Type Description
    child Index
    		Integer the index at which to insert the element

    Return

    Page Break — the new page break element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    insert Page Break(childIndex, pageBreak)

    Inserts the given Page Break at the specified index.

    Note: Page Breaks may not be contained within Table Cells . If the current element is contained in a table cell, an exception will be thrown.

    Parameters

    Name Type Description
    child Index
    		Integer the index at which to insert the element
    page Break
    		Page Break the p[age break to insert

    Return

    Page Break — the inserted page break element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    insert Text(childIndex, text)

    Creates and inserts a new text element at the specified index.

    Parameters

    Name Type Description
    child Index
    		Integer the index at which to insert the element
    text
    		String the text contents

    Return

    Text — the new text element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    insert Text(childIndex, text)

    Inserts the given Text element at the specified index, with the specified text contents.

    Parameters

    Name Type Description
    child Index
    		Integer the index at which to insert the element
    text
    		Text the text element to insert

    Return

    Text — the inserted text element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    is At Document End()

    Determines whether the element is at the end of the Document .

    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 following scopes :

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

    is Left To Right()

    Retrieves the left-to-right setting.

    Return

    Boolean — the left-to-right setting

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    merge()

    Merges the element with the preceding sibling of the same type.

    Only elements of the same Element Type can be merged. Any child elements contained in the current element are moved to the preceding sibling element.

    The current element is removed from the document.

     const 
  
 doc 
  
 = 
  
 DocumentApp 
 . 
 getActiveDocument 
 (); 
 const 
  
 documentTab 
  
 = 
  
 doc 
 . 
 getActiveTab 
 (). 
 asDocumentTab 
 (); 
 const 
  
 body 
  
 = 
  
 documentTab 
 . 
 getBody 
 (); 
 // Example 1: Merge paragraphs 
 // Append two paragraphs to the document's active tab. 
 const 
  
 par1 
  
 = 
  
 body 
 . 
 appendParagraph 
 ( 
 'Paragraph 1.' 
 ); 
 const 
  
 par2 
  
 = 
  
 body 
 . 
 appendParagraph 
 ( 
 'Paragraph 2.' 
 ); 
 // Merge the newly added paragraphs into a single paragraph. 
 par2 
 . 
 merge 
 (); 
 // Example 2: Merge table cells 
 // Create a two-dimensional array containing the table's cell contents. 
 const 
  
 cells 
  
 = 
  
 [ 
  
 [ 
 'Row 1, Cell 1' 
 , 
  
 'Row 1, Cell 2' 
 ], 
  
 [ 
 'Row 2, Cell 1' 
 , 
  
 'Row 2, Cell 2' 
 ], 
 ]; 
 // Build a table from the array. 
 const 
  
 table 
  
 = 
  
 body 
 . 
 appendTable 
 ( 
 cells 
 ); 
 // Get the first row in the table. 
 const 
  
 row 
  
 = 
  
 table 
 . 
 getRow 
 ( 
 0 
 ); 
 // Get the two cells in this row. 
 const 
  
 cell1 
  
 = 
  
 row 
 . 
 getCell 
 ( 
 0 
 ); 
 const 
  
 cell2 
  
 = 
  
 row 
 . 
 getCell 
 ( 
 1 
 ); 
 // Merge the current cell into its preceding sibling element. 
 const 
  
 merged 
  
 = 
  
 cell2 
 . 
 merge 
 ();

    Return

    List Item — The merged element.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    remove Child(child)

    Removes the specified child element.

    Parameters

    Name Type Description
    child
    		Element the child element to remove

    Return

    List Item — the current element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    remove From Parent()

    Removes the element from its parent.

     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 
 (); 
 }

    Return

    List Item — The removed element.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    remove Positioned Image(id)

    Removes a Positioned Image by the image's ID.

    Parameters

    Name Type Description
    id
    		String

    Return

    Boolean — whether or not the specified image was removed

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    replace Text(searchPattern, replacement)

    Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions.

    The search pattern is passed as a string, not a JavaScript regular expression object. Because of this you'll need to escape any backslashes in the pattern.

    This methods uses Google's RE2 regular expression library, which limits the supported syntax .

    The provided regular expression pattern is independently matched against each text block contained in the current element.

     const 
  
 body 
  
 = 
  
 DocumentApp 
 . 
 getActiveDocument 
 (). 
 getActiveTab 
 (). 
 asDocumentTab 
 (). 
 getBody 
 (); 
 // Clear the text surrounding "Apps Script", with or without text. 
 body 
 . 
 replaceText 
 ( 
 '^.*Apps ?Script.*$' 
 , 
  
 'Apps Script' 
 );

    Parameters

    Name Type Description
    search Pattern
    		String the regex pattern to search for
    replacement
    		String the text to use as replacement

    Return

    Element — the current element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    set Alignment(alignment)

    Sets the Horizontal Alignment .

    Parameters

    Name Type Description
    alignment
    		Horizontal Alignment the horizontal alignment

    Return

    List Item — the current element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    set Attributes(attributes)

    Sets the element's attributes.

    The specified attributes parameter must be an object where each property name is an item in the Document App.Attribute enumeration and each property value is the new value to be applied.

     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 
 );

    Parameters

    Name Type Description
    attributes
    		Object The element's attributes.

    Return

    List Item — The current element.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    set Glyph Type(glyphType)

    Sets the list item's Glyph Type .

    Parameters

    Name Type Description
    glyph Type
    		Glyph Type the glyph type

    Return

    List Item — the current element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    set Heading(heading)

    Sets the Paragraph Heading .

    Parameters

    Name Type Description
    heading
    		Paragraph Heading the heading

    Return

    List Item — the current element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    set Indent End(indentEnd)

    Sets the end indentation, in points.

    Parameters

    Name Type Description
    indent End
    		Number the end indentation, in points

    Return

    List Item — the current element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    set Indent First Line(indentFirstLine)

    Sets the first line indentation, in points.

    Parameters

    Name Type Description
    indent First Line
    		Number the first line indentation, in points

    Return

    List Item — the current element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    set Indent Start(indentStart)

    Sets the start indentation, in points.

    Parameters

    Name Type Description
    indent Start
    		Number the start indentation, in points

    Return

    List Item — the current element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    set Left To Right(leftToRight)

    Sets the left-to-right setting.

    Parameters

    Name Type Description
    left To Right
    		Boolean the left-to-right setting

    Return

    List Item — the current element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    set Line Spacing(multiplier)

    Sets the line spacing, as a quantity indicating the number of lines to use for spacing.

    Parameters

    Name Type Description
    multiplier
    		Number the number of lines

    Return

    List Item — the current element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    set Link Url(url)

    Sets the link url.

    Parameters

    Name Type Description
    url
    		String the link url

    Return

    List Item — the current element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    set List Id(listItem)

    Sets the list ID.

    The list ID is set to the same value for the specified List Item . The two List Items will be treated as members of the same list.

    Parameters

    Name Type Description
    list Item
    		List Item the list item whose list ID to use

    Return

    List Item — the current element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    set Nesting Level(nestingLevel)

    Sets the list item's nesting level.

    By default, list items have a nesting level of zero. The nesting level determines the glyph that is used by the list item.

    Parameters

    Name Type Description
    nesting Level
    		Integer the nesting level

    Return

    List Item — the current element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    set Spacing After(spacingAfter)

    Sets the spacing after the element, in points.

    Parameters

    Name Type Description
    spacing After
    		Number the spacing after the element, in points

    Return

    List Item — the current element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    set Spacing Before(spacingBefore)

    Sets the spacing before the element, in points.

    Parameters

    Name Type Description
    spacing Before
    		Number the spacing before the element, in points

    Return

    List Item — the current element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    set Text(text)

    Sets the contents of the list item as text.

    Note: existing contents are cleared.

    Parameters

    Name Type Description
    text
    		String the new text contents

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    set Text Alignment(textAlignment)

    Sets the text alignment. The available types of alignment are Document App.TextAlignment.NORMAL , Document App.TextAlignment.SUBSCRIPT , and Document App.TextAlignment.SUPERSCRIPT .

     // 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 
 );

    Parameters

    Name Type Description
    text Alignment
    		Text Alignment the type of text alignment to apply

    Return

    List Item — the current element

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

    • https://www.googleapis.com/auth/documents.currentonly
    • https://www.googleapis.com/auth/documents
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: