Class TableRow

    • TableRow represents a row within a Table and can only contain TableCell elements.

    • Methods are available to append, insert, remove, and retrieve TableCell elements within a TableRow.

    • You can search for specific elements or text patterns within a TableRow using methods like findElement and findText .

    • TableRow elements support setting and retrieving attributes, link URLs, minimum height, and text alignment.

    • Methods like clear , copy , editAsText , merge , and removeFromParent provide ways to manipulate the TableRow element itself.
    TableRow

    An element representing a table row. A TableRow is always contained within a Table and may only contain TableCell elements. For more information on document structure, see the guide to extending Google Docs .

    Methods

    Method Return type Brief description
    append Table Cell()
    		Table Cell Creates and appends a new Table Cell .
    append Table Cell(textContents)
    		Table Cell Appends the given Table Cell containing the specified text.
    append Table Cell(tableCell)
    		Table Cell Appends the given Table Cell .
    clear()
    		Table Row Clears the contents of the element.
    copy()
    		Table Row 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 |null Searches the contents of the element for a descendant of the specified type.
    find Element(elementType, from)
    		Range Element |null Searches the contents of the element for a descendant of the specified type, starting from the specified Range Element .
    find Text(searchPattern)
    		Range Element |null Searches the contents of the element for the specified text pattern using regular expressions.
    find Text(searchPattern, from)
    		Range Element |null 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 Cell(cellIndex)
    		Table Cell |null Retrieves the Table Cell at the specified cell index.
    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 Link Url()
    		String|null Retrieves the link url.
    get Minimum Height()
    		Number|null Retrieves the minimum height, in points.
    get Next Sibling()
    		Element |null Retrieves the element's next sibling element.
    get Num Cells()
    		Integer Retrieves the number of cells in the row.
    get Num Children()
    		Integer Retrieves the number of children.
    get Parent()
    		Container Element |null Retrieves the element's parent element.
    get Parent Table()
    		Table |null Retrieves the Table containing the current row.
    get Previous Sibling()
    		Element |null Retrieves the element's previous sibling element.
    get Text()
    		String Retrieves the contents of the element as a text string.
    get Text Alignment()
    		Text Alignment |null Gets the text alignment.
    get Type()
    		Element Type Retrieves the element's Element Type .
    insert Table Cell(childIndex)
    		Table Cell Creates and inserts a new Table Cell at the specified index.
    insert Table Cell(childIndex, textContents)
    		Table Cell Inserts the given Table Cell at the specified index, containing the given text.
    insert Table Cell(childIndex, tableCell)
    		Table Cell Inserts the given Table Cell at the specified index.
    is At Document End()
    		Boolean Determines whether the element is at the end of the Document .
    merge()
    		Table Row |null Merges the element with the preceding sibling of the same type.
    remove Cell(cellIndex)
    		Table Cell Removes the Table Cell at the specified cell index.
    remove Child(child)
    		Table Row Removes the specified child element.
    remove From Parent()
    		Table Row |null 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 Row Sets the element's attributes.
    set Link Url(url)
    		Table Row Sets the link url.
    set Minimum Height(minHeight)
    		Table Row Sets the minimum height, in points.
    set Text Alignment(textAlignment)
    		Table Row Sets the text alignment.

    Detailed documentation

    appendTableCell()

    Creates and appends a new TableCell .

    Return

    TableCell — the new table 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

    appendTableCell(textContents)

    Appends the given TableCell containing the specified text.

    Parameters

    Name Type Description
    text Contents
    		String the cell's text contents

    Return

    TableCell — the appended table cell 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

    appendTableCell(tableCell)

    Appends the given TableCell .

    Parameters

    Name Type Description
    table Cell
    		Table Cell the table cell to append

    Return

    TableCell — the appended table 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

    clear()

    Clears the contents of the element.

    Return

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

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

    editAsText()

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

    Use editAsText for manipulating the elements contents as rich text. The editAsText mode ignores non-text elements (such as InlineImage and HorizontalRule ).

    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

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

    RangeElement |null — 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

    findElement(elementType, from)

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

     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

    RangeElement |null — 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

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

    RangeElement |null — 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

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

    RangeElement |null — 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

    getAttributes()

    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 DocumentApp.Attribute enumeration.

     const 
  
 doc 
  
 = 
  
 DocumentApp 
 . 
 getActiveDocument 
 (); 
 const 
  
 documentTab 
  
 = 
  
 doc 
 . 
 getActiveTab 
 (). 
 asDocumentTab 
 (); 
 const 
  
 body 
  
 = 
  
 documentTab 
 . 
 getBody 
 (); 
 // Append a styled paragraph. 
 const 
  
 par 
  
 = 
  
 body 
 . 
 appendParagraph 
 ( 
 'A bold, italicized paragraph.' 
 ); 
 par 
 . 
 setBold 
 ( 
 true 
 ); 
 par 
 . 
 setItalic 
 ( 
 true 
 ); 
 // Retrieve the paragraph's attributes. 
 const 
  
 atts 
  
 = 
  
 par 
 . 
 getAttributes 
 (); 
 // Log the paragraph attributes. 
 for 
  
 ( 
 const 
  
 att 
  
 in 
  
 atts 
 ) 
  
 { 
  
 Logger 
 . 
 log 
 ( 
 ` 
 ${ 
 att 
 } 
 : 
 ${ 
 atts 
 [ 
 att 
 ] 
 } 
 ` 
 ); 
 }

    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

    getCell(cellIndex)

    Retrieves the TableCell at the specified cell index.

    Parameters

    Name Type Description
    cell Index
    		Integer the index of the cell to retrieve

    Return

    TableCell |null — the table 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

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

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

    getLinkUrl()

    Retrieves the link url.

    Return

    String|null — 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

    getMinimumHeight()

    Retrieves the minimum height, in points.

    Return

    Number|null — the minimum height, 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

    getNextSibling()

    Retrieves the element's next sibling element.

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

    Return

    Element |null — The next sibling element.

    Authorization

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

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

    getNumCells()

    Retrieves the number of cells in the row.

    Return

    Integer — the number of cells

    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

    getNumChildren()

    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

    getParent()

    Retrieves the element's parent element.

    The parent element contains the current element.

    Return

    ContainerElement |null — 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

    getParentTable()

    Retrieves the Table containing the current row.

    Return

    Table |null — the table containing the current row

    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

    getPreviousSibling()

    Retrieves the element's previous sibling element.

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

    Return

    Element |null — The previous sibling element.

    Authorization

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

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

    getText()

    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

    getTextAlignment()

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

    Return

    TextAlignment |null — 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

    getType()

    Retrieves the element's ElementType .

    Use getType() 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

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

    insertTableCell(childIndex)

    Creates and inserts a new TableCell at the specified index.

    Parameters

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

    Return

    TableCell — the new table 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

    insertTableCell(childIndex, textContents)

    Inserts the given TableCell at the specified index, containing the given text.

    Parameters

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

    Return

    TableCell — the inserted table 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

    insertTableCell(childIndex, tableCell)

    Inserts the given TableCell at the specified index.

    Parameters

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

    Return

    TableCell — the inserted table 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

    isAtDocumentEnd()

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

    TableRow |null — 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

    removeCell(cellIndex)

    Removes the TableCell at the specified cell index.

    Parameters

    Name Type Description
    cell Index
    		Integer the index of the cell to remove

    Return

    TableCell — the removed 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

    removeChild(child)

    Removes the specified child element.

    Parameters

    Name Type Description
    child
    		Element the child element to remove

    Return

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

    removeFromParent()

    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

    TableRow |null — 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

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

    setAttributes(attributes)

    Sets the element's attributes.

    The specified attributes parameter must be an object where each property name is an item in the DocumentApp.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

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

    setLinkUrl(url)

    Sets the link url.

    Parameters

    Name Type Description
    url
    		String the link url

    Return

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

    setMinimumHeight(minHeight)

    Sets the minimum height, in points.

    Parameters

    Name Type Description
    min Height
    		Number the minimum height, in points

    Return

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

    setTextAlignment(textAlignment)

    Sets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL , DocumentApp.TextAlignment.SUBSCRIPT , and DocumentApp.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

    TableRow — 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
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: