A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://developers.google.com/apps-script/reference/document/footer-section below:

Class FooterSection | Apps Script

Skip to main content Class FooterSection

Stay organized with collections Save and categorize content based on your preferences.

Methods Method Return type Brief description appendHorizontalRule() HorizontalRule Creates and appends a new HorizontalRule. appendImage(image) InlineImage Creates and appends a new InlineImage from the specified image blob. appendImage(image) InlineImage Appends the given InlineImage. appendListItem(listItem) ListItem Appends the given ListItem. appendListItem(text) ListItem Creates and appends a new ListItem containing the specified text contents. appendParagraph(paragraph) Paragraph Appends the given Paragraph. appendParagraph(text) Paragraph Creates and appends a new Paragraph containing the specified text contents. appendTable() Table Creates and appends a new Table. appendTable(cells) Table Appends a new Table containing a TableCell for each specified string value. appendTable(table) Table Appends the given Table. clear() FooterSection Clears the contents of the element. copy() FooterSection Returns a detached, deep copy of the current element. editAsText() Text Obtains a Text version of the current element, for editing. findElement(elementType) RangeElement Searches the contents of the element for a descendant of the specified type. findElement(elementType, from) RangeElement Searches the contents of the element for a descendant of the specified type, starting from the specified RangeElement. findText(searchPattern) RangeElement Searches the contents of the element for the specified text pattern using regular expressions. findText(searchPattern, from) RangeElement Searches the contents of the element for the specified text pattern, starting from a given search result. getAttributes() Object Retrieves the element's attributes. getChild(childIndex) Element Retrieves the child element at the specified child index. getChildIndex(child) Integer Retrieves the child index for the specified child element. getImages() InlineImage[] Retrieves all the InlineImages contained in the section. getListItems() ListItem[] Retrieves all the ListItems contained in the section. getNumChildren() Integer Retrieves the number of children. getParagraphs() Paragraph[] Retrieves all the Paragraphs contained in the section (including ListItems). getParent() ContainerElement Retrieves the element's parent element. getTables() Table[] Retrieves all the Tables contained in the section. getText() String Retrieves the contents of the element as a text string. getTextAlignment() TextAlignment Gets the text alignment. getType() ElementType Retrieves the element's ElementType. insertHorizontalRule(childIndex) HorizontalRule Creates and inserts a new HorizontalRule at the specified index. insertImage(childIndex, image) InlineImage Creates and inserts an InlineImage from the specified image blob, at the specified index. insertImage(childIndex, image) InlineImage Inserts the given InlineImage at the specified index. insertListItem(childIndex, listItem) ListItem Inserts the given ListItem at the specified index. insertListItem(childIndex, text) ListItem Creates and inserts a new ListItem at the specified index, containing the specified text contents. insertParagraph(childIndex, paragraph) Paragraph Inserts the given Paragraph at the specified index. insertParagraph(childIndex, text) Paragraph Creates and inserts a new Paragraph at the specified index, containing the specified text contents. insertTable(childIndex) Table Creates and inserts a new Table at the specified index. insertTable(childIndex, cells) Table Creates and inserts a new Table containing the specified cells, at the specified index. insertTable(childIndex, table) Table Inserts the given Table at the specified index. removeChild(child) FooterSection Removes the specified child element. removeFromParent() FooterSection Removes the element from its parent. replaceText(searchPattern, replacement) Element Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions. setAttributes(attributes) FooterSection Sets the element's attributes. setText(text) FooterSection Sets the contents as plain text. setTextAlignment(textAlignment) FooterSection Sets the text alignment. Deprecated methods Detailed documentation appendHorizontalRule()

Creates and appends a new HorizontalRule.

The HorizontalRule will be contained in a new Paragraph.

Return

HorizontalRule — The new horizontal rule.

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

appendImage(image)

Creates and appends a new InlineImage from the specified image blob.

The image will be contained in a new Paragraph.

Parameters Name Type Description image BlobSource The image data. Return

InlineImage — The appended image.

Authorization

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

appendImage(image)

Appends the given InlineImage.

The InlineImage will be contained in a new Paragraph.

Use this version of appendImage when appending a copy of an existing InlineImage.

Parameters Name Type Description image InlineImage The image data. Return

InlineImage — The appended image.

Authorization

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

appendListItem(listItem)

Appends the given ListItem.

Use this version of appendListItem when appending a copy of an existing ListItem.

Parameters Name Type Description listItem ListItem The list item to append. Return

ListItem — The appended list item.

Authorization

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

appendListItem(text)

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

Consecutive list items are added as part of the same list.

Parameters Name Type Description text String The list item's text contents. Return

ListItem — The new list item.

Authorization

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

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:

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:

appendTable()

Creates and appends a new Table.

This method will also append an empty paragraph after the table, since Google Docs documents cannot end with a table.

Return

Table — The new table.

Authorization

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

appendTable(cells)

Appends a new Table containing a TableCell for each specified string value.

This method will also append an empty paragraph after the table, since Google Docs documents cannot end with a table.

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:

appendTable(table)

Appends the given Table.

Use this version of appendTable when appending a copy of an existing Table. This method will also append an empty paragraph after the table, since Google Docs documents cannot end with a 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:

clear()

Clears the contents of the element.

Return

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

FooterSection — The new copy.

Authorization

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

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 elementType ElementType The type of element to search for. Return

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

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 elementType ElementType The type of element to search for. from RangeElement The search result to search from. Return

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

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 searchPattern String the pattern to search for Return

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

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 searchPattern String the pattern to search for from RangeElement the search result to search from Return

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

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:

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

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:

getImages()

Retrieves all the InlineImages contained in the section.

Return

InlineImage[] — The section images.

Authorization

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

getListItems()

Retrieves all the ListItems contained in the section.

Return

ListItem[] — The section list items.

Authorization

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

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:

getParagraphs()

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

Return

Paragraph[] — The section paragraphs.

Authorization

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

getParent()

Retrieves the element's parent element.

The parent element contains the current element.

Return

ContainerElement — The parent element.

Authorization

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

getTables()

Retrieves all the Tables contained in the section.

Return

Table[] — The section tables.

Authorization

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

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:

getTextAlignment()

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

Return

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

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:

insertHorizontalRule(childIndex)

Creates and inserts a new HorizontalRule at the specified index.

The HorizontalRule will be contained in a new Paragraph.

Parameters Name Type Description childIndex Integer The index at which to insert the element. Return

HorizontalRule — The new horizontal rule.

Authorization

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

insertImage(childIndex, image)

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

Parameters Name Type Description childIndex Integer The index at which to insert the element. image BlobSource The image data. Return

InlineImage — The inserted inline image.

Authorization

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

insertImage(childIndex, image)

Inserts the given InlineImage at the specified index.

The image will be contained in a new Paragraph.

Parameters Name Type Description childIndex Integer The index at which to insert the element. image InlineImage The image to insert. Return

InlineImage — The inserted inline image.

Authorization

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

insertListItem(childIndex, listItem)

Inserts the given ListItem at the specified index.

Parameters Name Type Description childIndex Integer The index at which to insert. listItem ListItem The list item to insert. Return

ListItem — The inserted list item.

Authorization

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

insertListItem(childIndex, text)

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

Parameters Name Type Description childIndex Integer The index at which to insert. text String The list item's text contents. Return

ListItem — The new list item.

Authorization

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

insertParagraph(childIndex, paragraph)

Inserts the given Paragraph at the specified index.

Parameters Name Type Description childIndex 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:

insertParagraph(childIndex, text)

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

Parameters Name Type Description childIndex 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:

insertTable(childIndex)

Creates and inserts a new Table at the specified index.

Parameters Name Type Description childIndex Integer The index at which to insert. Return

Table — The new table.

Authorization

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

insertTable(childIndex, cells)

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

Parameters Name Type Description childIndex 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:

insertTable(childIndex, table)

Inserts the given Table at the specified index.

Parameters Name Type Description childIndex Integer The index at which to insert. 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:

removeChild(child)

Removes the specified child element.

Parameters Name Type Description child Element The child element to remove. Return

FooterSection — The current element.

Authorization

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

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

FooterSection — The removed element.

Authorization

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

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

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

FooterSection — The current element.

Authorization

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

setText(text)

Sets the contents as plain text.

Note: existing contents are cleared.

Parameters Name Type Description text String The new text contents. Return

FooterSection — The current element.

Authorization

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

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 textAlignment TextAlignment the type of text alignment to apply Return

FooterSection — the current element

Authorization

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

Deprecated methods getLinkUrl()

Deprecated. Instead of applying a link to an entire section, apply the link to an element within the section instead.

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:

getNextSibling()

Deprecated. This element does not have any siblings.

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:

getPreviousSibling()

Deprecated. This element does not have any siblings.

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:

isAtDocumentEnd()

Deprecated. This method is not reliable for HeaderSection.

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:

setLinkUrl(url)

Deprecated. Instead of applying a link to an entire section, apply the link to an element within the section instead.

Sets the link url.

Parameters Name Type Description url String the link url Return

FooterSection — the current element

Authorization

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

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-12-03 UTC.

[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-03 UTC."],[[["A FooterSection represents the footer of a Google Doc and allows manipulation of its content and properties."],["The FooterSection object provides methods for content modification, element retrieval, and navigation."],["You can add, insert, retrieve, and remove elements like paragraphs, lists, tables, and images within the footer."],["Methods like `findElement`, `findText`, `getAttributes`, etc.allow searching, retrieving content, and getting element properties."],["Most FooterSection methods require specific authorization scopes for execution."]]],[]]


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4