Class FootnoteSection

    • FootnoteSection elements represent the text for a Footnote.

    • FootnoteSection can contain ListItem or Paragraph elements.

    • FootnoteSection provides methods to manipulate its contents, such as appending, inserting, clearing, and removing Paragraphs.

    • You can search for elements or text patterns within a FootnoteSection.

    • Methods are available to get and set attributes, text content, and text alignment of a FootnoteSection.
    FootnoteSection

    An element representing a footnote section. A FootnoteSection contains the text that corresponds to a Footnote . The FootnoteSection may contain ListItem or Paragraph elements. For more information on document structure, see the guide to extending Google Docs .

    Methods

    Method Return type Brief description
    append Paragraph(paragraph)
    		Paragraph Appends the given Paragraph .
    append Paragraph(text)
    		Paragraph Creates and appends a new Paragraph containing the specified text contents.
    clear()
    		Footnote Section Clears the contents of the element.
    copy()
    		Footnote Section 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 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 Next Sibling()
    		Element |null Retrieves the element's next sibling element.
    get Num Children()
    		Integer Retrieves the number of children.
    get Paragraphs()
    		Paragraph[] |null Retrieves all the Paragraphs contained in the section (including List Items ).
    get Parent()
    		Container Element |null Retrieves the element's parent element.
    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 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, containing the specified text contents.
    remove Child(child)
    		Footnote Section Removes the specified child element.
    remove From Parent()
    		Footnote Section |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)
    		Footnote Section Sets the element's attributes.
    set Text(text)
    		Footnote Section Sets the contents as plain text.
    set Text Alignment(textAlignment)
    		Footnote Section Sets the text alignment.

    Detailed documentation

    appendParagraph(paragraph)

    Appends the given Paragraph .

    Use this version of appendParagraph when appending a copy of an existing 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

    appendParagraph(text)

    Creates and appends a new Paragraph containing the specified text contents.

    Parameters

    Name Type Description
    text
    		String The paragraph's 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

    clear()

    Clears the contents of the element.

    Return

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

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

    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

    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

    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

    getParagraphs()

    Retrieves all the Paragraphs contained in the section (including ListItems ).

    Return

    Paragraph[] |null — The section paragraphs.

    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

    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

    insertParagraph(childIndex, paragraph)

    Inserts the given Paragraph at the specified index.

    Parameters

    Name Type Description
    child Index
    		Integer The index at which to insert.
    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

    insertParagraph(childIndex, text)

    Creates and inserts a new Paragraph at the specified index, containing the specified text contents.

    Parameters

    Name Type Description
    child Index
    		Integer The index at which to insert.
    text
    		String The paragraph's 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

    removeChild(child)

    Removes the specified child element.

    Parameters

    Name Type Description
    child
    		Element The child element to remove.

    Return

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

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

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

    setText(text)

    Sets the contents as plain text.

    Note: existing contents are cleared.

    Parameters

    Name Type Description
    text
    		String The new text contents.

    Return

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

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

    Deprecated methods
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: