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/footnote-section below:

Class FootnoteSection | Apps Script

Skip to main content Class FootnoteSection

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

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 appendParagraph(paragraph) Paragraph Appends the given Paragraph. appendParagraph(text) Paragraph Creates and appends a new Paragraph containing the specified text contents. clear() FootnoteSection Clears the contents of the element. copy() FootnoteSection 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. getNextSibling() Element Retrieves the element's next sibling element. 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. getPreviousSibling() Element Retrieves the element's previous sibling element. 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. 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. removeChild(child) FootnoteSection Removes the specified child element. removeFromParent() FootnoteSection 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) FootnoteSection Sets the element's attributes. setText(text) FootnoteSection Sets the contents as plain text. setTextAlignment(textAlignment) FootnoteSection Sets the text alignment. Deprecated methods 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.

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:

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:

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:

getNextSibling()

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:

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:

getPreviousSibling()

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:

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:

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:

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:

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

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

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

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

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

FootnoteSection — 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 `FootnoteSection` element in Google Docs represents the textual content of a footnote and can be manipulated using Google Apps Script."],["Developers can use `FootnoteSection` methods to add, modify, navigate, and search footnote content, as well as manage attributes and formatting."],["The `FootnoteSection` element provides various methods for interacting with its content and structure, including content modification, structure navigation, and search capabilities."],["Deprecated methods like `getFootnotes`, `getLinkUrl`, `isAtDocumentEnd`, and `setLinkUrl` are no longer recommended for use and should be avoided."],["Most `FootnoteSection` methods require authorization with specific scopes, such as `https://www.googleapis.com/auth/documents`, for security and access control."]]],["The `FootnoteSection` allows manipulation of footnote content. Key actions include appending or inserting paragraphs via `appendParagraph()` and `insertParagraph()`, removing content with `clear()` or `removeChild()`, and copying via `copy()`. Text can be edited with `editAsText()`, searched using `findText()`, replaced with `replaceText()`, set with `setText()`, and aligned via `setTextAlignment()`. Methods exist to get children `getChild()`, text content with `getText()`, and attributes using `getAttributes()`. Other methods involve setting and removing attributes and getting different data of the current FootnoteSection. All methods need authorization.\n"]]


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