Class TableCell

    Table Cell

    An element representing a table cell. A Table Cell is always contained within a Table Row and may contain List Item , Paragraph , or Table elements. For more information on document structure, see the guide to extending Google Docs .

    Methods

    Method Return type Brief description
    append Horizontal Rule()
    		Horizontal Rule Creates and appends a new Horizontal Rule .
    append Image(image)
    		Inline Image Creates and appends a new Inline Image from the specified image blob.
    append Image(image)
    		Inline Image Appends the given Inline Image .
    append List Item(listItem)
    		List Item Appends the given List Item .
    append List Item(text)
    		List Item Creates and appends a new List Item .
    append Paragraph(paragraph)
    		Paragraph Appends the given Paragraph .
    append Paragraph(text)
    		Paragraph Creates and appends a new Paragraph .
    append Table()
    		Table Creates and appends a new Table .
    append Table(cells)
    		Table Appends a new Table containing the specified cells.
    append Table(table)
    		Table Appends the given Table .
    clear()
    		Table Cell Clears the contents of the element.
    copy()
    		Table Cell 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 Attributes()
    		Object Retrieves the element's attributes.
    get Background Color()
    		String Retrieves the background color.
    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 Col Span()
    		Integer Retrieves the column span, which is the number of columns of table cells this cell spans.
    get Link Url()
    		String Retrieves the link url.
    get Next Sibling()
    		Element Retrieves the element's next sibling element.
    get Num Children()
    		Integer Retrieves the number of children.
    get Padding Bottom()
    		Number Retrieves the bottom padding, in points.
    get Padding Left()
    		Number Retrieves the left padding, in points.
    get Padding Right()
    		Number Retrieves the right padding, in points.
    get Padding Top()
    		Number Retrieves the top padding, in points.
    get Parent()
    		Container Element Retrieves the element's parent element.
    get Parent Row()
    		Table Row Retrieves the Table Row containing the current Table Cell .
    get Parent Table()
    		Table Retrieves the Table containing the current Table Cell .
    get Previous Sibling()
    		Element Retrieves the element's previous sibling element.
    get Row Span()
    		Integer Retrieves the row span, which is the number of rows of table cells this cell spans.
    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 .
    get Vertical Alignment()
    		Vertical Alignment Retrieves the Vertical Alignment .
    get Width()
    		Number Retrieves the width of the column containing the cell, in points.
    insert Horizontal Rule(childIndex)
    		Horizontal Rule Creates and inserts a new Horizontal Rule at the specified index.
    insert Image(childIndex, image)
    		Inline Image Creates and inserts an Inline Image from the specified image blob, at the specified index.
    insert Image(childIndex, image)
    		Inline Image Inserts the given Inline Image at the specified index.
    insert List Item(childIndex, listItem)
    		List Item Inserts the given List Item at the specified index.
    insert List Item(childIndex, text)
    		List Item Creates and inserts a new List Item at the specified index.
    insert Paragraph(childIndex, paragraph)
    		Paragraph Inserts the given Paragraph at the specified index.
    insert Paragraph(childIndex, text)
    		Paragraph Creates and inserts a new Paragraph at the specified index.
    insert Table(childIndex)
    		Table Creates and inserts a new Table at the specified index.
    insert Table(childIndex, cells)
    		Table Creates and inserts a new Table containing the specified cells, at the specified index.
    insert Table(childIndex, table)
    		Table Inserts the given Table at the specified index.
    is At Document End()
    		Boolean Determines whether the element is at the end of the Document .
    merge()
    		Table Cell Merges the element with the preceding sibling of the same type.
    remove Child(child)
    		Table Cell Removes the specified child element.
    remove From Parent()
    		Table Cell Removes the element from its parent.
    replace Text(searchPattern, replacement)
    		Element Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions.
    set Attributes(attributes)
    		Table Cell Sets the element's attributes.
    set Background Color(color)
    		Table Cell Sets the background color.
    set Link Url(url)
    		Table Cell Sets the link url.
    set Padding Bottom(paddingBottom)
    		Table Cell Sets the bottom padding, in points.
    set Padding Left(paddingLeft)
    		Table Cell Sets the left padding, in points.
    set Padding Right(paddingRight)
    		Table Cell Sets the right padding, in points.
    set Padding Top(paddingTop)
    		Table Cell Sets the top padding, in points.
    set Text(text)
    		Table Cell Sets the contents as plain text.
    set Text Alignment(textAlignment)
    		Table Cell Sets the text alignment.
    set Vertical Alignment(alignment)
    		Table Cell Sets the vertical alignment.
    set Width(width)
    		Table Cell Sets the width of the column containing the current cell, in points.

    Detailed documentation

    append Horizontal Rule()

    Creates and appends a new Horizontal Rule .

    The Horizontal Rule will be contained in a new Paragraph .

    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 Image(image)

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

    The Inline Image will be contained in a new Paragraph .

    Parameters

    Name Type Description
    image
    		Blob Source the image data

    Return

    Inline Image — the new 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 Image(image)

    Appends the given Inline Image .

    The Inline Image will be contained in a new Paragraph .

    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 List Item(listItem)

    Appends the given List Item .

    Parameters

    Name Type Description
    list Item
    		List Item the list item to append

    Return

    List Item — the appended list item

    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 List Item(text)

    Creates and appends a new List Item .

    Parameters

    Name Type Description
    text
    		String the text contents

    Return

    List Item — the new list item

    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 Paragraph(paragraph)

    Appends the given Paragraph .

    Parameters

    Name Type Description
    paragraph
    		Paragraph the paragraph to append

    Return

    Paragraph — the appended paragraph

    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 Paragraph(text)

    Creates and appends a new Paragraph .

    Parameters

    Name Type Description
    text
    		String the text contents

    Return

    Paragraph — the new paragraph

    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 Table()

    Creates and appends a new Table .

    Return

    Table — the new table

    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 Table(cells)

    Appends a new Table containing the specified cells.

    Parameters

    Name Type Description
    cells
    		String[][] the text contents of the table cells to add to the new table

    Return

    Table — the appended table

    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 Table(table)

    Appends the given Table .

    Parameters

    Name Type Description
    table
    		Table the table to append

    Return

    Table — the appended table

    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

    Table Cell — 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

    Table Cell — 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 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 Background Color()

    Retrieves the background color.

    Return

    String — the background color, formatted in CSS notation (like '#ffffff' )

    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 Col Span()

    Retrieves the column span, which is the number of columns of table cells this cell spans. Non-merged cells have a col span of 1.

    Return

    Integer — the column span or 0 for a cell which is merged over by another cell

    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 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 Padding Bottom()

    Retrieves the bottom padding, in points.

    Return

    Number — the bottom padding, 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 Padding Left()

    Retrieves the left padding, in points.

    Return

    Number — the left padding, 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 Padding Right()

    Retrieves the right padding, in points.

    Return

    Number — the right padding, 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 Padding Top()

    Retrieves the top padding, in points.

    Return

    Number — the top padding, 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 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 Parent Row()

    Retrieves the Table Row containing the current Table Cell .

    Return

    Table Row — the table row containing the current cell

    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 Table()

    Retrieves the Table containing the current Table Cell .

    Return

    Table — the table containing the current cell

    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 Row Span()

    Retrieves the row span, which is the number of rows of table cells this cell spans. Non-merged cells have a row span of 1.

    Return

    Integer — the row span or 0 for a cell which is merged over by another cell

    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

    get Vertical Alignment()

    Retrieves the Vertical Alignment .

    Return

    Vertical Alignment — the vertical 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 Width()

    Retrieves the width of the column containing the cell, in points.

    Return

    Number — the column width, 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

    insert Horizontal Rule(childIndex)

    Creates and inserts a new Horizontal Rule at the specified index.

    The horizontal rule will be contained in a new Paragraph .

    Parameters

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

    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

    insert Image(childIndex, image)

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

    The image will be contained in a new Paragraph .

    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

    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 Image(childIndex, image)

    Inserts the given Inline Image at the specified index.

    The image will be contained in a new Paragraph .

    Parameters

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

    Return

    Inline Image — the inserted inline 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

    insert List Item(childIndex, listItem)

    Inserts the given List Item at the specified index.

    Parameters

    Name Type Description
    child Index
    		Integer the index at which to insert the element
    list Item
    		List Item the list item to insert

    Return

    List Item — inserted new list item

    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 List Item(childIndex, text)

    Creates and inserts a new List Item 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

    List Item — the new list item

    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 Paragraph(childIndex, paragraph)

    Inserts the given Paragraph at the specified index.

    Parameters

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

    Return

    Paragraph — the inserted paragraph

    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 Paragraph(childIndex, text)

    Creates and inserts a new Paragraph 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

    Paragraph — the new paragraph

    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 Table(childIndex)

    Creates and inserts a new Table at the specified index.

    Parameters

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

    Return

    Table — the new table

    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 Table(childIndex, cells)

    Creates and inserts a new Table containing the specified cells, at the specified index.

    Parameters

    Name Type Description
    child Index
    		Integer the index at which to insert
    cells
    		String[][] the text contents of the table cells to add to the new table

    Return

    Table — the new table

    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 Table(childIndex, table)

    Inserts the given Table at the specified index.

    Parameters

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

    Return

    Table — the inserted table

    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

    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

    Table Cell — 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

    Table Cell — 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

    Table Cell — 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

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

    Table Cell — 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 Background Color(color)

    Sets the background color.

    Parameters

    Name Type Description
    color
    		String the background color, formatted in CSS notation (like '#ffffff' )

    Return

    Table Cell — 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

    Table Cell — 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 Padding Bottom(paddingBottom)

    Sets the bottom padding, in points.

    Parameters

    Name Type Description
    padding Bottom
    		Number the bottom padding, in points

    Return

    Table Cell — 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 Padding Left(paddingLeft)

    Sets the left padding, in points.

    Parameters

    Name Type Description
    padding Left
    		Number the left padding, in points

    Return

    Table Cell — 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 Padding Right(paddingRight)

    Sets the right padding, in points.

    Parameters

    Name Type Description
    padding Right
    		Number The right padding, in points.

    Return

    Table Cell — 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 Padding Top(paddingTop)

    Sets the top padding, in points.

    Parameters

    Name Type Description
    padding Top
    		Number the top padding, in points

    Return

    Table Cell — 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 as plain text.

    Note: existing contents are cleared.

    Parameters

    Name Type Description
    text
    		String the new text contents

    Return

    Table Cell — 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 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

    Table Cell — 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 Vertical Alignment(alignment)

    Sets the vertical alignment.

    Parameters

    Name Type Description
    alignment
    		Vertical Alignment the vertical alignment

    Return

    Table Cell — 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 Width(width)

    Sets the width of the column containing the current cell, in points.

    Parameters

    Name Type Description
    width
    		Number the column width, in points

    Return

    Table Cell — 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: