* // Create and open a new document.
* var doc = DocumentApp.create('Document Name');
*
*
* @param name - the new document's name
*
* @returns the new document instance
*/
function create(
name: string
): DocumentApp.Document
/**
* Returns the document to which the script is container-bound. To interact with document to which
* the script is not container-bound, use openById(id) or openByUrl(url)
* instead.
*
* * // Get the document to which this script is bound. * var doc = DocumentApp.getActiveDocument(); ** * @returns the document instance */ function getActiveDocument(): DocumentApp.Document /** * Returns an instance of the document's user-interface environment that allows the script to add * features like menus, dialogs, and sidebars. A script can only interact with the UI for the * current instance of an open document, and only if the script is bound to the document. For more information, see the * guides to menus and dialogs and sidebars. * *
* // Add a custom menu to the active document, including a separator and a sub-menu.
* function onOpen(e) {
* DocumentApp.getUi()
* .createMenu('My Menu')
* .addItem('My menu item', 'myFunction')
* .addSeparator()
* .addSubMenu(DocumentApp.getUi().createMenu('My sub-menu')
* .addItem('One sub-menu item', 'mySecondFunction')
* .addItem('Another sub-menu item', 'myThirdFunction'))
* .addToUi();
* }
*
*
* @returns an instance of this document's user-interface environment
*/
function getUi(): Ui
/**
* Returns the document with the specified ID. If the script is container-bound to the document,
* use getActiveDocument() instead.
*
*
* // Open a document by ID.
* var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');
*
*
* @param id - the ID of the document to open
*
* @returns the document instance
*/
function openById(
id: string
): DocumentApp.Document
/**
* Opens and returns the document with the specified URL. If the script is container-bound to the
* document, use getActiveDocument() instead.
*
* * // Open a document by URL. * var doc = DocumentApp.openByUrl( * 'https://docs.google.com/document/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit'); ** * @param url - the URL of the document to open * * @returns the document instance */ function openByUrl( url: string ): DocumentApp.Document enum Attribute { /** * The background color of an element (Paragraph, Table, etc) or document. */ BACKGROUND_COLOR = "BACKGROUND_COLOR", /** * The font weight setting, for rich text. */ BOLD = "BOLD", /** * The border color, for table elements. */ BORDER_COLOR = "BORDER_COLOR", /** * The border width in points, for table elements. */ BORDER_WIDTH = "BORDER_WIDTH", /** * The code contents, for equation elements. */ CODE = "CODE", /** * The font family setting, for rich text. */ FONT_FAMILY = "FONT_FAMILY", /** * The font size setting in points, for rich text. */ FONT_SIZE = "FONT_SIZE", /** * The foreground color setting, for rich text. */ FOREGROUND_COLOR = "FOREGROUND_COLOR", /** * The glyph type, for list item elements. */ GLYPH_TYPE = "GLYPH_TYPE", /** * The heading type, for paragraph elements (for example,
DocumentApp.ParagraphHeading.HEADING1).
*/
HEADING = "HEADING",
/**
* The height setting, for image elements.
*/
HEIGHT = "HEIGHT",
/**
* The horizontal alignment, for paragraph elements (for example, DocumentApp.HorizontalAlignment.CENTER).
*/
HORIZONTAL_ALIGNMENT = "HORIZONTAL_ALIGNMENT",
/**
* The end indentation setting in points, for paragraph elements.
*/
INDENT_END = "INDENT_END",
/**
* The first line indentation setting in points, for paragraph elements.
*/
INDENT_FIRST_LINE = "INDENT_FIRST_LINE",
/**
* The start indentation setting in points, for paragraph elements.
*/
INDENT_START = "INDENT_START",
/**
* The font style setting, for rich text.
*/
ITALIC = "ITALIC",
/**
* The text direction setting, for rich text.
*/
LEFT_TO_RIGHT = "LEFT_TO_RIGHT",
/**
* The line spacing setting as a multiplier, for paragraph elements.
*/
LINE_SPACING = "LINE_SPACING",
/**
* The link URL, for rich text. The default link style (foreground color, underline) is
* automatically applied.
*/
LINK_URL = "LINK_URL",
/**
* The ID of the encompassing list, for list item elements.
*/
LIST_ID = "LIST_ID",
/**
* The bottom margin setting in points, for paragraph elements.
*/
MARGIN_BOTTOM = "MARGIN_BOTTOM",
/**
* The left margin setting in points, for paragraph elements.
*/
MARGIN_LEFT = "MARGIN_LEFT",
/**
* The right margin setting in points, for paragraph elements.
*/
MARGIN_RIGHT = "MARGIN_RIGHT",
/**
* The top margin setting in points, for paragraph elements.
*/
MARGIN_TOP = "MARGIN_TOP",
/**
* The minimum height setting in points, for table row elements.
*/
MINIMUM_HEIGHT = "MINIMUM_HEIGHT",
/**
* The item nesting level, for list item elements.
*/
NESTING_LEVEL = "NESTING_LEVEL",
/**
* The bottom padding setting in points, for table cell elements.
*/
PADDING_BOTTOM = "PADDING_BOTTOM",
/**
* The left padding setting in points, for table cell elements.
*/
PADDING_LEFT = "PADDING_LEFT",
/**
* The right padding setting in points, for table cell elements.
*/
PADDING_RIGHT = "PADDING_RIGHT",
/**
* The top padding setting in points, for table cell elements.
*/
PADDING_TOP = "PADDING_TOP",
/**
* The page height setting in points, for documents.
*/
PAGE_HEIGHT = "PAGE_HEIGHT",
/**
* The page width setting in points, for documents.
*/
PAGE_WIDTH = "PAGE_WIDTH",
/**
* The bottom spacing setting in points, for paragraph elements.
*/
SPACING_AFTER = "SPACING_AFTER",
/**
* The top spacing setting in points, for paragraph elements.
*/
SPACING_BEFORE = "SPACING_BEFORE",
/**
* The strike-through setting, for rich text.
*/
STRIKETHROUGH = "STRIKETHROUGH",
/**
* The underline setting, for rich text.
*/
UNDERLINE = "UNDERLINE",
/**
* The vertical alignment setting, for table cell elements.
*/
VERTICAL_ALIGNMENT = "VERTICAL_ALIGNMENT",
/**
* The width setting, for table cell and image elements.
*/
WIDTH = "WIDTH",
}
class Body {
private constructor();
/**
* Creates and appends a new HorizontalRule.
*
* The HorizontalRule will be contained in a new Paragraph.
*
* @returns the new horizontal rule
*/
appendHorizontalRule(): DocumentApp.HorizontalRule
/**
* Creates and appends a new InlineImage from the specified image blob.
*
*
The image will be contained in a new Paragraph.
*
* @param image - the image data
*
* @returns the appended image
*/
appendImage(
image: BlobSource
): DocumentApp.InlineImage
/**
* 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.
*
* @param image - the image data
*
* @returns the appended image
*/
appendImage(
image: DocumentApp.InlineImage
): DocumentApp.InlineImage
/**
* Appends the given ListItem.
*
*
Use this version of appendListItem when appending a copy of an existing ListItem.
*
* @param listItem - the list item to append
*
* @returns the appended list item
*/
appendListItem(
listItem: DocumentApp.ListItem
): DocumentApp.ListItem
/**
* Creates and appends a new ListItem containing the specified text contents.
*
*
Consecutive list items are added as part of the same list.
*
* @param text - the list item's text contents
*
* @returns the new list item
*/
appendListItem(
text: string
): DocumentApp.ListItem
/**
* Creates and appends a new PageBreak.
*
*
The PageBreak will be contained in a new Paragraph.
*
* @returns the new page break
*/
appendPageBreak(): DocumentApp.PageBreak
/**
* Appends the given PageBreak.
*
*
The PageBreak will be contained in a new Paragraph.
*
*
Use this version of appendPageBreak when appending a copy of an existing PageBreak.
*
* @param pageBreak - the page break to append
*
* @returns the appended page break
*/
appendPageBreak(
pageBreak: DocumentApp.PageBreak
): DocumentApp.PageBreak
/**
* Appends the given Paragraph.
*
*
Use this version of appendParagraph when appending a copy of an existing Paragraph.
*
* @param paragraph - the paragraph to append
*
* @returns the appended paragraph
*/
appendParagraph(
paragraph: DocumentApp.Paragraph
): DocumentApp.Paragraph
/**
* Creates and appends a new Paragraph containing the specified text contents.
*
* @param text - the paragraph's text contents
*
* @returns the new paragraph
*/
appendParagraph(
text: string
): DocumentApp.Paragraph
/**
* 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.
*
* @returns the new table
*/
appendTable(): DocumentApp.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.
*
* @param table - the table to append
*
* @returns the appended table
*/
appendTable(
table: DocumentApp.Table
): DocumentApp.Table
/**
* 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. * * @param cells - the text contents of the table cells to add to the new table * * @returns the appended table */ appendTable( cells: string[][] ): DocumentApp.Table /** * Clears the contents of the element. * * @returns the current element */ clear(): DocumentApp.Body /** * Returns a detached, deep copy of the current element. * *
Any child elements present in the element are also copied. The new element will not have a
* parent.
*
* @returns the new copy
*/
copy(): DocumentApp.Body
/**
* 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. * *
* var body = DocumentApp.getActiveDocument().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);
* RangeElement.
*
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define the search parameters.
* var searchType = DocumentApp.ElementType.PARAGRAPH;
* var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
* var searchResult = null;
*
* // Search until the paragraph is found.
* while (searchResult = body.findElement(searchType, searchResult)) {
* var par = searchResult.getElement().asParagraph();
* if (par.getHeading() == searchHeading) {
* // Found one, update and stop.
* par.setText('This is the first header.');
* return;
* }
* }
* 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. * * @param searchPattern - the pattern to search for * * @returns a search result indicating the position of the search text, or null if there is no * match */ findText( searchPattern: string ): DocumentApp.RangeElement /** * 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. * * @param searchPattern - the pattern to search for * @param from - the search result to search from * * @returns a search result indicating the next position of the search text, or null if there is no * match */ findText( searchPattern: string, from: DocumentApp.RangeElement ): DocumentApp.RangeElement /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document.
* var 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.");
* }
* Footnotes contained in the section.
*
* @returns the section footnotes
*/
getFootnotes(): DocumentApp.Footnote[]
/**
* Retrieves the set of attributes for the provided ParagraphHeading.
*
* @param paragraphHeading - the heading whose attributes will be retrieved
*
* @returns a map of the attributes and their current values
*/
getHeadingAttributes(
paragraphHeading: DocumentApp.ParagraphHeading
): object
/**
* Retrieves all the InlineImages contained in the section.
*
* @returns the section images
*/
getImages(): DocumentApp.InlineImage[]
/**
* Retrieves the link url.
*
* @returns the link url, or null if the element contains multiple values for this attribute
*/
getLinkUrl(): string
/**
* Retrieves all the ListItems contained in the section.
*
* @returns the section list items
*/
getListItems(): DocumentApp.ListItem[]
/**
* Retrieves the bottom margin, in points.
*
* @returns the bottom margin, in points
*/
getMarginBottom(): Number
/**
* Retrieves the left margin, in points.
*
* @returns the left margin, in points
*/
getMarginLeft(): Number
/**
* Retrieves the right margin.
*
* @returns the right margin, in points
*/
getMarginRight(): Number
/**
* Retrieves the top margin.
*
* @returns the top margin, in points
*/
getMarginTop(): Number
/**
* Retrieves the element's next sibling element.
*
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the number of children. * *
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Log the number of elements in the document.
* Logger.log("There are " + body.getNumChildren() +
* " elements in the document body.");
* Paragraphs contained in the section (including ListItems).
*
* @returns the section paragraphs
*/
getParagraphs(): DocumentApp.Paragraph[]
/**
* Retrieves the element's parent element.
*
* The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves all the Tables contained in the section.
*
* @returns the section tables
*/
getTables(): DocumentApp.Table[]
/**
* Retrieves the contents of the element as a text string.
*
* @returns the contents of the element as text string
*/
getText(): string
/**
* Gets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
* @returns 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
*/
getTextAlignment(): DocumentApp.TextAlignment
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* HorizontalRule at the specified index.
*
* The HorizontalRule will be contained in a new Paragraph.
*
* @param childIndex - the index at which to insert the element
*
* @returns the new horizontal rule
*/
insertHorizontalRule(
childIndex: number
): DocumentApp.HorizontalRule
/**
* Creates and inserts an InlineImage from the specified image blob, at the specified
* index.
*
* @param childIndex - the index at which to insert the element
* @param image - the image data
*
* @returns the inserted inline image
*/
insertImage(
childIndex: number,
image: BlobSource
): DocumentApp.InlineImage
/**
* Inserts the given InlineImage at the specified index.
*
*
The image will be contained in a new Paragraph.
*
* @param childIndex - the index at which to insert the element
* @param image - the image to insert
*
* @returns the inserted inline image
*/
insertImage(
childIndex: number,
image: DocumentApp.InlineImage
): DocumentApp.InlineImage
/**
* Inserts the given ListItem at the specified index.
*
* @param childIndex - the index at which to insert
* @param listItem - the list item to insert
*
* @returns the inserted list item
*/
insertListItem(
childIndex: number,
listItem: DocumentApp.ListItem
): DocumentApp.ListItem
/**
* Creates and inserts a new ListItem at the specified index, containing the specified
* text contents.
*
* @param childIndex - the index at which to insert
* @param text - the list item's text contents
*
* @returns the new list item
*/
insertListItem(
childIndex: number,
text: string
): DocumentApp.ListItem
/**
* Creates and inserts a new PageBreak at the specified index.
*
*
The PageBreak will be contained in a new Paragraph.
*
* @param childIndex - the index at which to insert the element
*
* @returns the new page break
*/
insertPageBreak(
childIndex: number
): DocumentApp.PageBreak
/**
* Inserts the given PageBreak at the specified index.
*
*
The PageBreak will be contained in a new Paragraph.
*
* @param childIndex - the index at which to insert the element
* @param pageBreak - the p[age break to insert
*
* @returns the inserted page break
*/
insertPageBreak(
childIndex: number,
pageBreak: DocumentApp.PageBreak
): DocumentApp.PageBreak
/**
* Inserts the given Paragraph at the specified index.
*
* @param childIndex - the index at which to insert
* @param paragraph - the paragraph to insert
*
* @returns the inserted paragraph
*/
insertParagraph(
childIndex: number,
paragraph: DocumentApp.Paragraph
): DocumentApp.Paragraph
/**
* Creates and inserts a new Paragraph at the specified index, containing the specified
* text contents.
*
* @param childIndex - the index at which to insert
* @param text - the paragraph's text contents
*
* @returns the new paragraph
*/
insertParagraph(
childIndex: number,
text: string
): DocumentApp.Paragraph
/**
* Creates and inserts a new Table at the specified index.
*
* @param childIndex - the index at which to insert
*
* @returns the new table
*/
insertTable(
childIndex: number
): DocumentApp.Table
/**
* Inserts the given Table at the specified index.
*
* @param childIndex - the index at which to insert
* @param table - the table to insert
*
* @returns the inserted table
*/
insertTable(
childIndex: number,
table: DocumentApp.Table
): DocumentApp.Table
/**
* Creates and inserts a new Table containing the specified cells, at the specified index.
*
* @param childIndex - the index at which to insert
* @param cells - the text contents of the table cells to add to the new table
*
* @returns the new table
*/
insertTable(
childIndex: number,
cells: string[][]
): DocumentApp.Table
/**
* Determines whether the element is at the end of the Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Removes the specified child element.
*
* @param child - the child element to remove
*
* @returns the current element
*/
removeChild(
child: DocumentApp.Element
): DocumentApp.Body
/**
* 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Clear the text surrounding "Apps Script", with or without text.
* body.replaceText("^.*Apps ?Script.*$", "Apps Script");
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* ParagraphHeading.
*
* @param paragraphHeading - the heading whose attributes will be set
* @param attributes - a map of attributes and the values to set them to
*
* @returns the current element
*/
setHeadingAttributes(
paragraphHeading: DocumentApp.ParagraphHeading,
attributes: object
): DocumentApp.Body
/**
* Sets the link url.
*
* @param url - the link url
*
* @returns the current element
*/
setLinkUrl(
url: string
): DocumentApp.Body
/**
* Sets the bottom margin, in points.
*
* @param marginBottom - the bottom margin, in points
*
* @returns the current element
*/
setMarginBottom(
marginBottom: Number
): DocumentApp.Body
/**
* Sets the left margin, in points.
*
* @param marginLeft - the left margin, in points
*
* @returns the current element
*/
setMarginLeft(
marginLeft: Number
): DocumentApp.Body
/**
* Sets the right margin, in points.
*
* @param marginRight - the right margin
*
* @returns the current element
*/
setMarginRight(
marginRight: Number
): DocumentApp.Body
/**
* Sets the top margin.
*
* @param marginTop - the top margin, in points
*
* @returns the current element
*/
setMarginTop(
marginTop: Number
): DocumentApp.Body
/**
* Sets the page height, in points.
*
* @param pageHeight - the page height, in points
*
* @returns the current element
*/
setPageHeight(
pageHeight: Number
): DocumentApp.Body
/**
* Sets the page width, in points.
*
* @param pageWidth - the page width, in points
*
* @returns the current element
*/
setPageWidth(
pageWidth: Number
): DocumentApp.Body
/**
* Sets the contents as plain text.
*
* Note: existing contents are cleared.
*
* @param text - the new text contents
*
* @returns the current element
*/
setText(
text: string
): DocumentApp.Body
/**
* 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 be superscript.
* var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
* text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
* Bookmark. The ID is unique within the document.
*
* @returns the Bookmark's ID, which is unique within the document
*/
getId(): string
/**
* Gets the Position of the Bookmark within the Document. The Position remains accurate so long as the Bookmark is not deleted, even if the script
* changes the document structure.
*
* @returns the position of the Bookmark
*/
getPosition(): DocumentApp.Position
/**
* Deletes the Bookmark. Calling this method on a Bookmark that has already been
* deleted has no effect.
*/
remove(): void
}
class ContainerElement {
private constructor();
/**
* Returns the current element as a Body.
*
* Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asBody(): DocumentApp.Body
/**
* Returns the current element as a Equation.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asEquation(): DocumentApp.Equation
/**
* Returns the current element as a FooterSection.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asFooterSection(): DocumentApp.FooterSection
/**
* Returns the current element as a FootnoteSection.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asFootnoteSection(): DocumentApp.FootnoteSection
/**
* Returns the current element as a HeaderSection.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asHeaderSection(): DocumentApp.HeaderSection
/**
* Returns the current element as a ListItem.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asListItem(): DocumentApp.ListItem
/**
* Returns the current element as a Paragraph.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asParagraph(): DocumentApp.Paragraph
/**
* Returns the current element as a Table.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asTable(): DocumentApp.Table
/**
* Returns the current element as a TableCell.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asTableCell(): DocumentApp.TableCell
/**
* Returns the current element as a TableOfContents.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asTableOfContents(): DocumentApp.TableOfContents
/**
* Returns the current element as a TableRow.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific * type. * * @returns the current element */ asTableRow(): DocumentApp.TableRow /** * Clears the contents of the element. * * @returns the current element */ clear(): DocumentApp.ContainerElement /** * Returns a detached, deep copy of the current element. * *
Any child elements present in the element are also copied. The new element will not have a
* parent.
*
* @returns the new copy
*/
copy(): DocumentApp.ContainerElement
/**
* 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. * *
* var body = DocumentApp.getActiveDocument().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);
* RangeElement.
*
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define the search parameters.
* var searchType = DocumentApp.ElementType.PARAGRAPH;
* var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
* var searchResult = null;
*
* // Search until the paragraph is found.
* while (searchResult = body.findElement(searchType, searchResult)) {
* var par = searchResult.getElement().asParagraph();
* if (par.getHeading() == searchHeading) {
* // Found one, update and stop.
* par.setText('This is the first header.');
* return;
* }
* }
* 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. * * @param searchPattern - the pattern to search for * * @returns a search result indicating the position of the search text, or null if there is no * match */ findText( searchPattern: string ): DocumentApp.RangeElement /** * 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. * * @param searchPattern - the pattern to search for * @param from - the search result to search from * * @returns a search result indicating the next position of the search text, or null if there is no * match */ findText( searchPattern: string, from: DocumentApp.RangeElement ): DocumentApp.RangeElement /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document.
* var 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.");
* }
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the number of children. * *
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Log the number of elements in the document.
* Logger.log("There are " + body.getNumChildren() +
* " elements in the document body.");
* The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the contents of the element as a text string.
*
* @returns the contents of the element as text string
*/
getText(): string
/**
* Gets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
* @returns 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
*/
getTextAlignment(): DocumentApp.TextAlignment
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Merges the element with the preceding sibling of the same type.
*
* Only elements of the same ElementType may 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append two paragraphs to the document.
* var par1 = body.appendParagraph('Paragraph 1.');
* var par2 = body.appendParagraph('Paragraph 2.');
*
* // Merge the newly added paragraphs into a single paragraph.
* par2.merge();
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Clear the text surrounding "Apps Script", with or without text.
* body.replaceText("^.*Apps ?Script.*$", "Apps Script");
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
*
* // Make the entire first paragraph be superscript.
* var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
* text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
* Bookmark at the given Position.
*
* @param position - the position of the new bookmark
*
* @returns the new bookmark
*/
addBookmark(
position: DocumentApp.Position
): DocumentApp.Bookmark
/**
* Adds the given user to the list of editors for the Document. If the user was already
* on the list of viewers, this method promotes the user out of the list of viewers.
*
* @param emailAddress - The email address of the user to add.
*
* @returns This Document, for chaining.
*/
addEditor(
emailAddress: string
): DocumentApp.Document
/**
* Adds the given user to the list of editors for the Document. If the user was already
* on the list of viewers, this method promotes the user out of the list of viewers.
*
* @param user - A representation of the user to add.
*
* @returns This Document, for chaining.
*/
addEditor(
user: User
): DocumentApp.Document
/**
* Adds the given array of users to the list of editors for the Document. If any of the
* users were already on the list of viewers, this method promotes them out of the list of
* viewers.
*
* @param emailAddresses - An array of email addresses of the users to add.
*
* @returns This Document, for chaining.
*/
addEditors(
emailAddresses: string[]
): DocumentApp.Document
/**
* Adds a document footer section, if none exists.
*
* @returns the document footer
*/
addFooter(): DocumentApp.FooterSection
/**
* Adds a document header section, if none exists.
*
* @returns the document header
*/
addHeader(): DocumentApp.HeaderSection
/**
* Adds a new NamedRange, which is a Range that has a name and ID to allow
* later retrieval. Names are not necessarily unique; several different ranges in the same
* document may share the same name, much like a class in HTML. By contrast, IDs are unique within
* the document, like an ID in HTML. Once a NamedRange has been added to a document, it
* cannot be modified, only removed.
*
* A NamedRange can be accessed by any script that accesses the document. To avoid
* unintended conflicts between scripts, consider prefixing range names with a unique string.
*
*
* // Change the user's selection to a range that includes every table in the document.
* var doc = DocumentApp.getActiveDocument();
* var rangeBuilder = doc.newRange();
* var tables = doc.getBody().getTables();
* for (var i = 0; i < tables.length; i++) {
* rangeBuilder.addElement(tables[i]);
* }
* doc.setSelection(rangeBuilder.build());
* newRange()
*
* @returns the new NamedRange
*/
addNamedRange(
name: string,
range: DocumentApp.Range
): DocumentApp.NamedRange
/**
* Adds the given user to the list of viewers for the Document. If the user was already
* on the list of editors, this method has no effect.
*
* @param emailAddress - The email address of the user to add.
*
* @returns This Document, for chaining.
*/
addViewer(
emailAddress: string
): DocumentApp.Document
/**
* Adds the given user to the list of viewers for the Document. If the user was already
* on the list of editors, this method has no effect.
*
* @param user - A representation of the user to add.
*
* @returns This Document, for chaining.
*/
addViewer(
user: User
): DocumentApp.Document
/**
* Adds the given array of users to the list of viewers for the Document. If any of the
* users were already on the list of editors, this method has no effect for them.
*
* @param emailAddresses - An array of email addresses of the users to add.
*
* @returns This Document, for chaining.
*/
addViewers(
emailAddresses: string[]
): DocumentApp.Document
/**
* Retrieves the current Document contents as a blob of the specified type.
*
* @param contentType - the MIME type to convert to; currently only 'application/pdf' is
* supported
*
* @returns the current document as a blob
*/
getAs(
contentType: string
): Blob
/**
* Retrieves the current Document contents as a blob.
*
* @returns the current document as a blob
*/
getBlob(): Blob
/**
* Retrieves the active document's Body.
*
* Documents may contain different types of sections (e.g. HeaderSection, FooterSection). The active section for a document is the Body.
*
*
Element methods in Document delegate to the active Body.
*
* @returns the active document body section
*/
getBody(): DocumentApp.Body
/**
* Gets the Bookmark with the given ID. This method returns null if no such Bookmark exists.
*
* @param id - the ID for the Bookmark
*
* @returns the Bookmark with the given ID, or null if no such Bookmark
* exists
*/
getBookmark(
id: string
): DocumentApp.Bookmark
/**
* Gets all Bookmark objects in the document.
*
* @returns an array of the Bookmark objects in the document
*/
getBookmarks(): DocumentApp.Bookmark[]
/**
* Gets the user's cursor in the active document. A script can only access the cursor of the user
* who is running the script, and only if the script is bound to the document.
*
*
* // Insert some text at the cursor position and make it bold.
* var cursor = DocumentApp.getActiveDocument().getCursor();
* if (cursor) {
* // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's
* // containing element doesn't allow insertions, so show the user an error message.
* var element = cursor.insertText('ಠ‿ಠ');
* if (element) {
* element.setBold(true);
* } else {
* DocumentApp.getUi().alert('Cannot insert text here.');
* }
* } else {
* DocumentApp.getUi().alert('Cannot find a cursor.');
* }
*
*
* @returns A representation of the user's cursor, or null if the user does not have a
* cursor placed in the document or if the script is not bound to the document.
*/
getCursor(): DocumentApp.Position
/**
* Gets the list of editors for this Document.
*
* @returns An array of users with edit permission.
*/
getEditors(): User[]
/**
* Retrieves the document's footer section, if one exists.
*
* @returns the document footer
*/
getFooter(): DocumentApp.FooterSection
/**
* Retrieves all the Footnote elements in the document body.
*
* Calls to getFootnotes cause an iteration over the document's elements. For large
* documents, avoid unnecessary calls to this method.
*
* @returns the document footnotes
*/
getFootnotes(): DocumentApp.Footnote[]
/**
* Retrieves the document's header section, if one exists.
*
* @returns the document header
*/
getHeader(): DocumentApp.HeaderSection
/**
* Retrieves the document's unique identifier. The document ID is used with DocumentApp.openById() to open a specific document instance.
*
* @returns the document's ID
*/
getId(): string
/**
* Gets the document's language code. This is the language shown in the document editor's File
* > Language, which may not be the actual language that the document contains.
*
* @returns The document language, or null if not defined.
*/
getLanguage(): string
/**
* Retrieves the title of the document.
*
* @returns the document title
*/
getName(): string
/**
* Gets the NamedRange with the given ID. This method returns null if no such
* NamedRange exists. Names are not necessarily unique; several different ranges in the
* same document may share the same name, much like a class in HTML. By contrast, IDs are unique
* within the document, like an ID in HTML.
*
* @param id - the range's ID, which is unique within the document
*
* @returns the NamedRange with the given ID, or null if no such range exists
*/
getNamedRangeById(
id: string
): DocumentApp.NamedRange
/**
* Gets all NamedRange objects in the document.
*
*
A NamedRange can be accessed by any script that accesses the document. To avoid
* unintended conflicts between scripts, consider prefixing range names with a unique string.
*
* @returns an array of the NamedRange objects in the document, possibly including multiple
* ranges with the same name
*/
getNamedRanges(): DocumentApp.NamedRange[]
/**
* Gets all NamedRange objects in the document with the given name. Names are not
* necessarily unique; several different ranges in the same document may share the same name, much
* like a class in HTML. By contrast, IDs are unique within the document, like an ID in HTML.
*
*
A NamedRange can be accessed by any script that accesses the document. To avoid
* unintended conflicts between scripts, consider prefixing range names with a unique string.
*
* @param name - the range's name, which is not necessarily unique
*
* @returns an array of the NamedRange objects in the document with the given name
*/
getNamedRanges(
name: string
): DocumentApp.NamedRange[]
/**
* Gets the user's selection in the active document. A script can only access the selection of the
* user who is running the script, and only if the script is bound to the document.
*
*
* // Display a dialog box that tells the user how many elements are included in the selection.
* var selection = DocumentApp.getActiveDocument().getSelection();
* if (selection) {
* var elements = selection.getRangeElements();
* DocumentApp.getUi().alert('Number of selected elements: ' + elements.length);
* } else {
* DocumentApp.getUi().alert('Nothing is selected.');
* }
* null if the user does not have
* anything selected in the document, if only the end of a paragraph is selected, if only the
* end of a paragraph and a new line are selected, or if the script is not bound to the
* document.
*/
getSelection(): DocumentApp.Range
/**
* Gets all language codes that are supported in Google Docs files.
*
* @returns An array of language codes.
*/
getSupportedLanguageCodes(): string[]
/**
* Retrieves the URL to access the current document.
*
*
* var doc = DocumentApp.getActiveDocument();
*
* // Send out the link to open the document.
* MailApp.sendEmail("<email-address>", doc.getName(), doc.getUrl());
* Document.
*
* @returns An array of users with view or comment permission.
*/
getViewers(): User[]
/**
* Creates a new Position, which is a reference to a location in the document, relative to
* a specific element. The user's cursor is represented as a Position, among other uses.
*
*
* // Append a paragraph, then place the user's cursor after the first word of the new paragraph.
* var doc = DocumentApp.getActiveDocument();
* var paragraph = doc.getBody().appendParagraph('My new paragraph.');
* var position = doc.newPosition(paragraph.getChild(0), 2);
* doc.setCursor(position);
* Position; this must be either a
* Text element or a container element like Paragraph
* @param offset - for Text elements, the number of characters before the Position;
* for other elements, the number of child elements before the Position within the
* same container element
*
* @returns the new Position
*/
newPosition(
element: DocumentApp.Element,
offset: number
): DocumentApp.Position
/**
* Creates a builder used to construct Range objects from document elements.
*
*
* // Change the user's selection to a range that includes every table in the document.
* var doc = DocumentApp.getActiveDocument();
* var rangeBuilder = doc.newRange();
* var tables = doc.getBody().getTables();
* for (var i = 0; i < tables.length; i++) {
* rangeBuilder.addElement(tables[i]);
* }
* doc.setSelection(rangeBuilder.build());
* Document. This method doesn't
* block users from accessing the Document if they belong to a class of users who have
* general access—for example, if the Document is shared with the user's entire
* domain, or if the Document is in a shared drive that the user can access.
*
* For Drive files, this also removes the user from the list of viewers.
*
* @param emailAddress - The email address of the user to remove.
*
* @returns This Document, for chaining.
*/
removeEditor(
emailAddress: string
): DocumentApp.Document
/**
* Removes the given user from the list of editors for the Document. This method doesn't
* block users from accessing the Document if they belong to a class of users who have
* general access—for example, if the Document is shared with the user's entire
* domain, or if the Document is in a shared drive that the user can access.
*
*
For Drive files, this also removes the user from the list of viewers.
*
* @param user - A representation of the user to remove.
*
* @returns This Document, for chaining.
*/
removeEditor(
user: User
): DocumentApp.Document
/**
* Removes the given user from the list of viewers and commenters for the Document. This
* method has no effect if the user is an editor, not a viewer or commenter. This method also
* doesn't block users from accessing the Document if they belong to a class of users who
* have general access—for example, if the Document is shared with the user's
* entire domain, or if the Document is in a shared drive that the user can access.
*
*
For Drive files, this also removes the user from the list of editors.
*
* @param emailAddress - The email address of the user to remove.
*
* @returns This Document for chaining.
*/
removeViewer(
emailAddress: string
): DocumentApp.Document
/**
* Removes the given user from the list of viewers and commenters for the Document. This
* method has no effect if the user is an editor, not a viewer. This method also doesn't block
* users from accessing the Document if they belong to a class of users who have general
* access—for example, if the Document is shared with the user's entire domain, or
* if the Document is in a shared drive that the user can access.
*
*
For Drive files, this also removes the user from the list of editors.
*
* @param user - A representation of the user to remove.
*
* @returns This Document for chaining.
*/
removeViewer(
user: User
): DocumentApp.Document
/**
* Saves the current Document. Causes pending updates to be flushed and applied.
*
*
The saveAndClose() method is automatically invoked at the end of script execution
* for each open editable Document.
*
*
A closed Document can't be edited. Use DocumentApp.openById() to reopen a
* given document for editing.
*/
saveAndClose(): void
/**
* Sets the user's cursor in the active document, given a Position. A script can only
* access the cursor of the user who is running the script, and only if the script is bound to the document.
*
*
* // Append a paragraph, then place the user's cursor after the first word of the new paragraph.
* var doc = DocumentApp.getActiveDocument();
* var paragraph = doc.getBody().appendParagraph('My new paragraph.');
* var position = doc.newPosition(paragraph.getChild(0), 2);
* doc.setCursor(position);
* Document, for chaining
*/
setCursor(
position: DocumentApp.Position
): DocumentApp.Document
/**
* Sets the document's language code. This is the language shown in the document editor's File
* > Language, which may not be the actual language that the document contains. Use getSupportedLanguageCodes() to get all the valid language codes.
*
* @param languageCode - The language code.
*
* @returns This Document, for chaining.
*/
setLanguage(
languageCode: string
): DocumentApp.Document
/**
* Sets the document title.
*
* @param name - the new document title
*
* @returns the current document
*/
setName(
name: string
): DocumentApp.Document
/**
* Sets the user's selection in the active document, given a Range. A script can
* only access the selection of the user who is running the script, and only if the script is bound to the document.
*
*
* // Change the user's selection to a range that includes every table in the document.
* var doc = DocumentApp.getActiveDocument();
* var rangeBuilder = doc.newRange();
* var tables = doc.getBody().getTables();
* for (var i = 0; i < tables.length; i++) {
* rangeBuilder.addElement(tables[i]);
* }
* doc.setSelection(rangeBuilder.build());
* Document, for chaining
*/
setSelection(
range: DocumentApp.Range
): DocumentApp.Document
}
class Element {
private constructor();
/**
* Returns the current element as a Body.
*
* Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asBody(): DocumentApp.Body
/**
* Returns the current element as a Equation.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asEquation(): DocumentApp.Equation
/**
* Returns the current element as a EquationFunction.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asEquationFunction(): DocumentApp.EquationFunction
/**
* Returns the current element as a EquationFunctionArgumentSeparator.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asEquationFunctionArgumentSeparator(): DocumentApp.EquationFunctionArgumentSeparator
/**
* Returns the current element as a EquationSymbol.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asEquationSymbol(): DocumentApp.EquationSymbol
/**
* Returns the current element as a FooterSection.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asFooterSection(): DocumentApp.FooterSection
/**
* Returns the current element as a Footnote.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asFootnote(): DocumentApp.Footnote
/**
* Returns the current element as a FootnoteSection.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asFootnoteSection(): DocumentApp.FootnoteSection
/**
* Returns the current element as a HeaderSection.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asHeaderSection(): DocumentApp.HeaderSection
/**
* Returns the current element as a HorizontalRule.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asHorizontalRule(): DocumentApp.HorizontalRule
/**
* Returns the current element as a InlineDrawing.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asInlineDrawing(): DocumentApp.InlineDrawing
/**
* Returns the current element as a InlineImage.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asInlineImage(): DocumentApp.InlineImage
/**
* Returns the current element as a ListItem.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asListItem(): DocumentApp.ListItem
/**
* Returns the current element as a PageBreak.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asPageBreak(): DocumentApp.PageBreak
/**
* Returns the current element as a Paragraph.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asParagraph(): DocumentApp.Paragraph
/**
* Returns the current element as a Table.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asTable(): DocumentApp.Table
/**
* Returns the current element as a TableCell.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asTableCell(): DocumentApp.TableCell
/**
* Returns the current element as a TableOfContents.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asTableOfContents(): DocumentApp.TableOfContents
/**
* Returns the current element as a TableRow.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific
* type.
*
* @returns the current element
*/
asTableRow(): DocumentApp.TableRow
/**
* Returns the current element as a Text.
*
*
Use this method to aid auto-complete whenever a given element is known to be of a specific * type. * * @returns the current element */ asText(): DocumentApp.Text /** * Returns a detached, deep copy of the current element. * *
Any child elements present in the element are also copied. The new element will not have a * parent. * * @returns the new copy */ copy(): DocumentApp.Element /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the element's parent element. * *
The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Merges the element with the preceding sibling of the same type.
*
* Only elements of the same ElementType may 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append two paragraphs to the document.
* var par1 = body.appendParagraph('Paragraph 1.');
* var par2 = body.appendParagraph('Paragraph 2.');
*
* // Merge the newly added paragraphs into a single paragraph.
* par2.merge();
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* Body element.
*/
BODY_SECTION = "BODY_SECTION",
/**
* The type corresponding to the CommentSectionEquation element.
*/
EQUATION = "EQUATION",
/**
* The type corresponding to the EquationFunction element.
*/
EQUATION_FUNCTION = "EQUATION_FUNCTION",
/**
* The type corresponding to the EquationFunctionArgumentSeparator
* element.
*/
EQUATION_FUNCTION_ARGUMENT_SEPARATOR = "EQUATION_FUNCTION_ARGUMENT_SEPARATOR",
/**
* The type corresponding to the EquationSymbol element.
*/
EQUATION_SYMBOL = "EQUATION_SYMBOL",
/**
* The type corresponding to the FooterSection element.
*/
FOOTER_SECTION = "FOOTER_SECTION",
/**
* The type corresponding to the Footnote element.
*/
FOOTNOTE = "FOOTNOTE",
/**
* The type corresponding to the FootnoteSection element.
*/
FOOTNOTE_SECTION = "FOOTNOTE_SECTION",
/**
* The type corresponding to the HeaderSection element.
*/
HEADER_SECTION = "HEADER_SECTION",
/**
* The type corresponding to the HorizontalRule element.
*/
HORIZONTAL_RULE = "HORIZONTAL_RULE",
/**
* The type corresponding to the InlineDrawing element.
*/
INLINE_DRAWING = "INLINE_DRAWING",
/**
* The type corresponding to the InlineImage element.
*/
INLINE_IMAGE = "INLINE_IMAGE",
/**
* The type corresponding to the ListItem element.
*/
LIST_ITEM = "LIST_ITEM",
/**
* The type corresponding to the PageBreak element.
*/
PAGE_BREAK = "PAGE_BREAK",
/**
* The type corresponding to the Paragraph element.
*/
PARAGRAPH = "PARAGRAPH",
/**
* The type corresponding to the Table element.
*/
TABLE = "TABLE",
/**
* The type corresponding to the TableCell element.
*/
TABLE_CELL = "TABLE_CELL",
/**
* The type corresponding to the TableOfContents element.
*/
TABLE_OF_CONTENTS = "TABLE_OF_CONTENTS",
/**
* The type corresponding to the TableRow element.
*/
TABLE_ROW = "TABLE_ROW",
/**
* The type corresponding to the Text
* element.
*/
TEXT = "TEXT",
/**
* The type corresponding to UnsupportedElement. Unsupported elements
* represent document portions that do not support scripting.
*/
UNSUPPORTED = "UNSUPPORTED",
}
class Equation {
private constructor();
/**
* Clears the contents of the element.
*
* @returns the current element
*/
clear(): DocumentApp.Equation
/**
* Returns a detached, deep copy of the current element.
*
* Any child elements present in the element are also copied. The new element will not have a
* parent.
*
* @returns the new copy
*/
copy(): DocumentApp.Equation
/**
* 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. * *
* var body = DocumentApp.getActiveDocument().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);
* RangeElement.
*
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define the search parameters.
* var searchType = DocumentApp.ElementType.PARAGRAPH;
* var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
* var searchResult = null;
*
* // Search until the paragraph is found.
* while (searchResult = body.findElement(searchType, searchResult)) {
* var par = searchResult.getElement().asParagraph();
* if (par.getHeading() == searchHeading) {
* // Found one, update and stop.
* par.setText('This is the first header.');
* return;
* }
* }
* 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. * * @param searchPattern - the pattern to search for * * @returns a search result indicating the position of the search text, or null if there is no * match */ findText( searchPattern: string ): DocumentApp.RangeElement /** * 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. * * @param searchPattern - the pattern to search for * @param from - the search result to search from * * @returns a search result indicating the next position of the search text, or null if there is no * match */ findText( searchPattern: string, from: DocumentApp.RangeElement ): DocumentApp.RangeElement /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document.
* var 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.");
* }
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the number of children. * *
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Log the number of elements in the document.
* Logger.log("There are " + body.getNumChildren() +
* " elements in the document body.");
* The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the contents of the element as a text string.
*
* @returns the contents of the element as text string
*/
getText(): string
/**
* Gets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
* @returns 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
*/
getTextAlignment(): DocumentApp.TextAlignment
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Merges the element with the preceding sibling of the same type.
*
* Only elements of the same ElementType may 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append two paragraphs to the document.
* var par1 = body.appendParagraph('Paragraph 1.');
* var par2 = body.appendParagraph('Paragraph 2.');
*
* // Merge the newly added paragraphs into a single paragraph.
* par2.merge();
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Clear the text surrounding "Apps Script", with or without text.
* body.replaceText("^.*Apps ?Script.*$", "Apps Script");
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
*
* // Make the entire first paragraph be superscript.
* var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
* text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
* Any child elements present in the element are also copied. The new element will not have a
* parent.
*
* @returns the new copy
*/
copy(): DocumentApp.EquationFunction
/**
* 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. * *
* var body = DocumentApp.getActiveDocument().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);
* RangeElement.
*
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define the search parameters.
* var searchType = DocumentApp.ElementType.PARAGRAPH;
* var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
* var searchResult = null;
*
* // Search until the paragraph is found.
* while (searchResult = body.findElement(searchType, searchResult)) {
* var par = searchResult.getElement().asParagraph();
* if (par.getHeading() == searchHeading) {
* // Found one, update and stop.
* par.setText('This is the first header.');
* return;
* }
* }
* 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. * * @param searchPattern - the pattern to search for * * @returns a search result indicating the position of the search text, or null if there is no * match */ findText( searchPattern: string ): DocumentApp.RangeElement /** * 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. * * @param searchPattern - the pattern to search for * @param from - the search result to search from * * @returns a search result indicating the next position of the search text, or null if there is no * match */ findText( searchPattern: string, from: DocumentApp.RangeElement ): DocumentApp.RangeElement /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document.
* var 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.");
* }
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the number of children. * *
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Log the number of elements in the document.
* Logger.log("There are " + body.getNumChildren() +
* " elements in the document body.");
* The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the contents of the element as a text string.
*
* @returns the contents of the element as text string
*/
getText(): string
/**
* Gets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
* @returns 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
*/
getTextAlignment(): DocumentApp.TextAlignment
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Merges the element with the preceding sibling of the same type.
*
* Only elements of the same ElementType may 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append two paragraphs to the document.
* var par1 = body.appendParagraph('Paragraph 1.');
* var par2 = body.appendParagraph('Paragraph 2.');
*
* // Merge the newly added paragraphs into a single paragraph.
* par2.merge();
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Clear the text surrounding "Apps Script", with or without text.
* body.replaceText("^.*Apps ?Script.*$", "Apps Script");
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
*
* // Make the entire first paragraph be superscript.
* var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
* text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
* Any child elements present in the element are also copied. The new element will not have a * parent. * * @returns the new copy */ copy(): DocumentApp.EquationFunctionArgumentSeparator /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the element's parent element. * *
The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Merges the element with the preceding sibling of the same type.
*
* Only elements of the same ElementType may 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append two paragraphs to the document.
* var par1 = body.appendParagraph('Paragraph 1.');
* var par2 = body.appendParagraph('Paragraph 2.');
*
* // Merge the newly added paragraphs into a single paragraph.
* par2.merge();
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* Any child elements present in the element are also copied. The new element will not have a * parent. * * @returns the new copy */ copy(): DocumentApp.EquationSymbol /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the element's parent element. * *
The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Merges the element with the preceding sibling of the same type.
*
* Only elements of the same ElementType may 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append two paragraphs to the document.
* var par1 = body.appendParagraph('Paragraph 1.');
* var par2 = body.appendParagraph('Paragraph 2.');
*
* // Merge the newly added paragraphs into a single paragraph.
* par2.merge();
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* HorizontalRule.
*
* The HorizontalRule will be contained in a new Paragraph.
*
* @returns the new horizontal rule
*/
appendHorizontalRule(): DocumentApp.HorizontalRule
/**
* Creates and appends a new InlineImage from the specified image blob.
*
*
The image will be contained in a new Paragraph.
*
* @param image - the image data
*
* @returns the appended image
*/
appendImage(
image: BlobSource
): DocumentApp.InlineImage
/**
* 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.
*
* @param image - the image data
*
* @returns the appended image
*/
appendImage(
image: DocumentApp.InlineImage
): DocumentApp.InlineImage
/**
* Appends the given ListItem.
*
*
Use this version of appendListItem when appending a copy of an existing ListItem.
*
* @param listItem - the list item to append
*
* @returns the appended list item
*/
appendListItem(
listItem: DocumentApp.ListItem
): DocumentApp.ListItem
/**
* Creates and appends a new ListItem containing the specified text contents.
*
*
Consecutive list items are added as part of the same list.
*
* @param text - the list item's text contents
*
* @returns the new list item
*/
appendListItem(
text: string
): DocumentApp.ListItem
/**
* Appends the given Paragraph.
*
*
Use this version of appendParagraph when appending a copy of an existing Paragraph.
*
* @param paragraph - the paragraph to append
*
* @returns the appended paragraph
*/
appendParagraph(
paragraph: DocumentApp.Paragraph
): DocumentApp.Paragraph
/**
* Creates and appends a new Paragraph containing the specified text contents.
*
* @param text - the paragraph's text contents
*
* @returns the new paragraph
*/
appendParagraph(
text: string
): DocumentApp.Paragraph
/**
* 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.
*
* @returns the new table
*/
appendTable(): DocumentApp.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.
*
* @param table - the table to append
*
* @returns the appended table
*/
appendTable(
table: DocumentApp.Table
): DocumentApp.Table
/**
* 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. * * @param cells - the text contents of the table cells to add to the new table * * @returns the appended table */ appendTable( cells: string[][] ): DocumentApp.Table /** * Clears the contents of the element. * * @returns the current element */ clear(): DocumentApp.FooterSection /** * Returns a detached, deep copy of the current element. * *
Any child elements present in the element are also copied. The new element will not have a
* parent.
*
* @returns the new copy
*/
copy(): DocumentApp.FooterSection
/**
* 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. * *
* var body = DocumentApp.getActiveDocument().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);
* RangeElement.
*
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define the search parameters.
* var searchType = DocumentApp.ElementType.PARAGRAPH;
* var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
* var searchResult = null;
*
* // Search until the paragraph is found.
* while (searchResult = body.findElement(searchType, searchResult)) {
* var par = searchResult.getElement().asParagraph();
* if (par.getHeading() == searchHeading) {
* // Found one, update and stop.
* par.setText('This is the first header.');
* return;
* }
* }
* 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. * * @param searchPattern - the pattern to search for * * @returns a search result indicating the position of the search text, or null if there is no * match */ findText( searchPattern: string ): DocumentApp.RangeElement /** * 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. * * @param searchPattern - the pattern to search for * @param from - the search result to search from * * @returns a search result indicating the next position of the search text, or null if there is no * match */ findText( searchPattern: string, from: DocumentApp.RangeElement ): DocumentApp.RangeElement /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document.
* var 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.");
* }
* Footnotes contained in the section.
*
* @returns the section footnotes
*/
getFootnotes(): DocumentApp.Footnote[]
/**
* Retrieves all the InlineImages contained in the section.
*
* @returns the section images
*/
getImages(): DocumentApp.InlineImage[]
/**
* Retrieves the link url.
*
* @returns the link url, or null if the element contains multiple values for this attribute
*/
getLinkUrl(): string
/**
* Retrieves all the ListItems contained in the section.
*
* @returns the section list items
*/
getListItems(): DocumentApp.ListItem[]
/**
* Retrieves the element's next sibling element.
*
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the number of children. * *
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Log the number of elements in the document.
* Logger.log("There are " + body.getNumChildren() +
* " elements in the document body.");
* Paragraphs contained in the section (including ListItems).
*
* @returns the section paragraphs
*/
getParagraphs(): DocumentApp.Paragraph[]
/**
* Retrieves the element's parent element.
*
* The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves all the Tables contained in the section.
*
* @returns the section tables
*/
getTables(): DocumentApp.Table[]
/**
* Retrieves the contents of the element as a text string.
*
* @returns the contents of the element as text string
*/
getText(): string
/**
* Gets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
* @returns 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
*/
getTextAlignment(): DocumentApp.TextAlignment
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* HorizontalRule at the specified index.
*
* The HorizontalRule will be contained in a new Paragraph.
*
* @param childIndex - the index at which to insert the element
*
* @returns the new horizontal rule
*/
insertHorizontalRule(
childIndex: number
): DocumentApp.HorizontalRule
/**
* Creates and inserts an InlineImage from the specified image blob, at the specified
* index.
*
* @param childIndex - the index at which to insert the element
* @param image - the image data
*
* @returns the inserted inline image
*/
insertImage(
childIndex: number,
image: BlobSource
): DocumentApp.InlineImage
/**
* Inserts the given InlineImage at the specified index.
*
*
The image will be contained in a new Paragraph.
*
* @param childIndex - the index at which to insert the element
* @param image - the image to insert
*
* @returns the inserted inline image
*/
insertImage(
childIndex: number,
image: DocumentApp.InlineImage
): DocumentApp.InlineImage
/**
* Inserts the given ListItem at the specified index.
*
* @param childIndex - the index at which to insert
* @param listItem - the list item to insert
*
* @returns the inserted list item
*/
insertListItem(
childIndex: number,
listItem: DocumentApp.ListItem
): DocumentApp.ListItem
/**
* Creates and inserts a new ListItem at the specified index, containing the specified
* text contents.
*
* @param childIndex - the index at which to insert
* @param text - the list item's text contents
*
* @returns the new list item
*/
insertListItem(
childIndex: number,
text: string
): DocumentApp.ListItem
/**
* Inserts the given Paragraph at the specified index.
*
* @param childIndex - the index at which to insert
* @param paragraph - the paragraph to insert
*
* @returns the inserted paragraph
*/
insertParagraph(
childIndex: number,
paragraph: DocumentApp.Paragraph
): DocumentApp.Paragraph
/**
* Creates and inserts a new Paragraph at the specified index, containing the specified
* text contents.
*
* @param childIndex - the index at which to insert
* @param text - the paragraph's text contents
*
* @returns the new paragraph
*/
insertParagraph(
childIndex: number,
text: string
): DocumentApp.Paragraph
/**
* Creates and inserts a new Table at the specified index.
*
* @param childIndex - the index at which to insert
*
* @returns the new table
*/
insertTable(
childIndex: number
): DocumentApp.Table
/**
* Inserts the given Table at the specified index.
*
* @param childIndex - the index at which to insert
* @param table - the table to insert
*
* @returns the inserted table
*/
insertTable(
childIndex: number,
table: DocumentApp.Table
): DocumentApp.Table
/**
* Creates and inserts a new Table containing the specified cells, at the specified index.
*
* @param childIndex - the index at which to insert
* @param cells - the text contents of the table cells to add to the new table
*
* @returns the new table
*/
insertTable(
childIndex: number,
cells: string[][]
): DocumentApp.Table
/**
* Determines whether the element is at the end of the Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Removes the specified child element.
*
* @param child - the child element to remove
*
* @returns the current element
*/
removeChild(
child: DocumentApp.Element
): DocumentApp.FooterSection
/**
* Removes the element from its parent.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Clear the text surrounding "Apps Script", with or without text.
* body.replaceText("^.*Apps ?Script.*$", "Apps Script");
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* Note: existing contents are cleared.
*
* @param text - the new text contents
*
* @returns the current element
*/
setText(
text: string
): DocumentApp.FooterSection
/**
* 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 be superscript.
* var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
* text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
* Any child elements present in the element are also copied. The new element will not have a * parent. * * @returns the new copy */ copy(): DocumentApp.Footnote /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the element's parent element. * *
The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Removes the element from its parent.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* Paragraph.
*
* Use this version of appendParagraph when appending a copy of an existing Paragraph.
*
* @param paragraph - the paragraph to append
*
* @returns the appended paragraph
*/
appendParagraph(
paragraph: DocumentApp.Paragraph
): DocumentApp.Paragraph
/**
* Creates and appends a new Paragraph containing the specified text contents.
*
* @param text - the paragraph's text contents
*
* @returns the new paragraph
*/
appendParagraph(
text: string
): DocumentApp.Paragraph
/**
* Clears the contents of the element.
*
* @returns the current element
*/
clear(): DocumentApp.FootnoteSection
/**
* Returns a detached, deep copy of the current element.
*
*
Any child elements present in the element are also copied. The new element will not have a
* parent.
*
* @returns the new copy
*/
copy(): DocumentApp.FootnoteSection
/**
* 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. * *
* var body = DocumentApp.getActiveDocument().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);
* RangeElement.
*
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define the search parameters.
* var searchType = DocumentApp.ElementType.PARAGRAPH;
* var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
* var searchResult = null;
*
* // Search until the paragraph is found.
* while (searchResult = body.findElement(searchType, searchResult)) {
* var par = searchResult.getElement().asParagraph();
* if (par.getHeading() == searchHeading) {
* // Found one, update and stop.
* par.setText('This is the first header.');
* return;
* }
* }
* 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. * * @param searchPattern - the pattern to search for * * @returns a search result indicating the position of the search text, or null if there is no * match */ findText( searchPattern: string ): DocumentApp.RangeElement /** * 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. * * @param searchPattern - the pattern to search for * @param from - the search result to search from * * @returns a search result indicating the next position of the search text, or null if there is no * match */ findText( searchPattern: string, from: DocumentApp.RangeElement ): DocumentApp.RangeElement /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document.
* var 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.");
* }
* Footnotes contained in the section.
*
* @returns the section footnotes
*/
getFootnotes(): DocumentApp.Footnote[]
/**
* Retrieves the link url.
*
* @returns the link url, or null if the element contains multiple values for this attribute
*/
getLinkUrl(): string
/**
* Retrieves the element's next sibling element.
*
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the number of children. * *
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Log the number of elements in the document.
* Logger.log("There are " + body.getNumChildren() +
* " elements in the document body.");
* Paragraphs contained in the section (including ListItems).
*
* @returns the section paragraphs
*/
getParagraphs(): DocumentApp.Paragraph[]
/**
* Retrieves the element's parent element.
*
* The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the contents of the element as a text string.
*
* @returns the contents of the element as text string
*/
getText(): string
/**
* Gets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
* @returns 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
*/
getTextAlignment(): DocumentApp.TextAlignment
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* Paragraph at the specified index.
*
* @param childIndex - the index at which to insert
* @param paragraph - the paragraph to insert
*
* @returns the inserted paragraph
*/
insertParagraph(
childIndex: number,
paragraph: DocumentApp.Paragraph
): DocumentApp.Paragraph
/**
* Creates and inserts a new Paragraph at the specified index, containing the specified
* text contents.
*
* @param childIndex - the index at which to insert
* @param text - the paragraph's text contents
*
* @returns the new paragraph
*/
insertParagraph(
childIndex: number,
text: string
): DocumentApp.Paragraph
/**
* Determines whether the element is at the end of the Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Removes the specified child element.
*
* @param child - the child element to remove
*
* @returns the current element
*/
removeChild(
child: DocumentApp.Element
): DocumentApp.FootnoteSection
/**
* Removes the element from its parent.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Clear the text surrounding "Apps Script", with or without text.
* body.replaceText("^.*Apps ?Script.*$", "Apps Script");
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* Note: existing contents are cleared.
*
* @param text - the new text contents
*
* @returns the current element
*/
setText(
text: string
): DocumentApp.FootnoteSection
/**
* 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 be superscript.
* var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
* text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
* HorizontalRule.
*
* The HorizontalRule will be contained in a new Paragraph.
*
* @returns the new horizontal rule
*/
appendHorizontalRule(): DocumentApp.HorizontalRule
/**
* Creates and appends a new InlineImage from the specified image blob.
*
*
The image will be contained in a new Paragraph.
*
* @param image - the image data
*
* @returns the appended image
*/
appendImage(
image: BlobSource
): DocumentApp.InlineImage
/**
* 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.
*
* @param image - the image data
*
* @returns the appended image
*/
appendImage(
image: DocumentApp.InlineImage
): DocumentApp.InlineImage
/**
* Appends the given ListItem.
*
*
Use this version of appendListItem when appending a copy of an existing ListItem.
*
* @param listItem - the list item to append
*
* @returns the appended list item
*/
appendListItem(
listItem: DocumentApp.ListItem
): DocumentApp.ListItem
/**
* Creates and appends a new ListItem containing the specified text contents.
*
*
Consecutive list items are added as part of the same list.
*
* @param text - the list item's text contents
*
* @returns the new list item
*/
appendListItem(
text: string
): DocumentApp.ListItem
/**
* Appends the given Paragraph.
*
*
Use this version of appendParagraph when appending a copy of an existing Paragraph.
*
* @param paragraph - the paragraph to append
*
* @returns the appended paragraph
*/
appendParagraph(
paragraph: DocumentApp.Paragraph
): DocumentApp.Paragraph
/**
* Creates and appends a new Paragraph containing the specified text contents.
*
* @param text - the paragraph's text contents
*
* @returns the new paragraph
*/
appendParagraph(
text: string
): DocumentApp.Paragraph
/**
* 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.
*
* @returns the new table
*/
appendTable(): DocumentApp.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.
*
* @param table - the table to append
*
* @returns the appended table
*/
appendTable(
table: DocumentApp.Table
): DocumentApp.Table
/**
* 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. * * @param cells - the text contents of the table cells to add to the new table * * @returns the appended table */ appendTable( cells: string[][] ): DocumentApp.Table /** * Clears the contents of the element. * * @returns the current element */ clear(): DocumentApp.HeaderSection /** * Returns a detached, deep copy of the current element. * *
Any child elements present in the element are also copied. The new element will not have a
* parent.
*
* @returns the new copy
*/
copy(): DocumentApp.HeaderSection
/**
* 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. * *
* var body = DocumentApp.getActiveDocument().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);
* RangeElement.
*
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define the search parameters.
* var searchType = DocumentApp.ElementType.PARAGRAPH;
* var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
* var searchResult = null;
*
* // Search until the paragraph is found.
* while (searchResult = body.findElement(searchType, searchResult)) {
* var par = searchResult.getElement().asParagraph();
* if (par.getHeading() == searchHeading) {
* // Found one, update and stop.
* par.setText('This is the first header.');
* return;
* }
* }
* 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. * * @param searchPattern - the pattern to search for * * @returns a search result indicating the position of the search text, or null if there is no * match */ findText( searchPattern: string ): DocumentApp.RangeElement /** * 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. * * @param searchPattern - the pattern to search for * @param from - the search result to search from * * @returns a search result indicating the next position of the search text, or null if there is no * match */ findText( searchPattern: string, from: DocumentApp.RangeElement ): DocumentApp.RangeElement /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document.
* var 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.");
* }
* Footnotes contained in the section.
*
* @returns the section footnotes
*/
getFootnotes(): DocumentApp.Footnote[]
/**
* Retrieves all the InlineImages contained in the section.
*
* @returns the section images
*/
getImages(): DocumentApp.InlineImage[]
/**
* Retrieves the link url.
*
* @returns the link url, or null if the element contains multiple values for this attribute
*/
getLinkUrl(): string
/**
* Retrieves all the ListItems contained in the section.
*
* @returns the section list items
*/
getListItems(): DocumentApp.ListItem[]
/**
* Retrieves the element's next sibling element.
*
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the number of children. * *
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Log the number of elements in the document.
* Logger.log("There are " + body.getNumChildren() +
* " elements in the document body.");
* Paragraphs contained in the section (including ListItems).
*
* @returns the section paragraphs
*/
getParagraphs(): DocumentApp.Paragraph[]
/**
* Retrieves the element's parent element.
*
* The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves all the Tables contained in the section.
*
* @returns the section tables
*/
getTables(): DocumentApp.Table[]
/**
* Retrieves the contents of the element as a text string.
*
* @returns the contents of the element as text string
*/
getText(): string
/**
* Gets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
* @returns 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
*/
getTextAlignment(): DocumentApp.TextAlignment
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* HorizontalRule at the specified index.
*
* The HorizontalRule will be contained in a new Paragraph.
*
* @param childIndex - the index at which to insert the element
*
* @returns the new horizontal rule
*/
insertHorizontalRule(
childIndex: number
): DocumentApp.HorizontalRule
/**
* Creates and inserts an InlineImage from the specified image blob, at the specified
* index.
*
* @param childIndex - the index at which to insert the element
* @param image - the image data
*
* @returns the inserted inline image
*/
insertImage(
childIndex: number,
image: BlobSource
): DocumentApp.InlineImage
/**
* Inserts the given InlineImage at the specified index.
*
*
The image will be contained in a new Paragraph.
*
* @param childIndex - the index at which to insert the element
* @param image - the image to insert
*
* @returns the inserted inline image
*/
insertImage(
childIndex: number,
image: DocumentApp.InlineImage
): DocumentApp.InlineImage
/**
* Inserts the given ListItem at the specified index.
*
* @param childIndex - the index at which to insert
* @param listItem - the list item to insert
*
* @returns the inserted list item
*/
insertListItem(
childIndex: number,
listItem: DocumentApp.ListItem
): DocumentApp.ListItem
/**
* Creates and inserts a new ListItem at the specified index, containing the specified
* text contents.
*
* @param childIndex - the index at which to insert
* @param text - the list item's text contents
*
* @returns the new list item
*/
insertListItem(
childIndex: number,
text: string
): DocumentApp.ListItem
/**
* Inserts the given Paragraph at the specified index.
*
* @param childIndex - the index at which to insert
* @param paragraph - the paragraph to insert
*
* @returns the inserted paragraph
*/
insertParagraph(
childIndex: number,
paragraph: DocumentApp.Paragraph
): DocumentApp.Paragraph
/**
* Creates and inserts a new Paragraph at the specified index, containing the specified
* text contents.
*
* @param childIndex - the index at which to insert
* @param text - the paragraph's text contents
*
* @returns the new paragraph
*/
insertParagraph(
childIndex: number,
text: string
): DocumentApp.Paragraph
/**
* Creates and inserts a new Table at the specified index.
*
* @param childIndex - the index at which to insert
*
* @returns the new table
*/
insertTable(
childIndex: number
): DocumentApp.Table
/**
* Inserts the given Table at the specified index.
*
* @param childIndex - the index at which to insert
* @param table - the table to insert
*
* @returns the inserted table
*/
insertTable(
childIndex: number,
table: DocumentApp.Table
): DocumentApp.Table
/**
* Creates and inserts a new Table containing the specified cells, at the specified index.
*
* @param childIndex - the index at which to insert
* @param cells - the text contents of the table cells to add to the new table
*
* @returns the new table
*/
insertTable(
childIndex: number,
cells: string[][]
): DocumentApp.Table
/**
* Determines whether the element is at the end of the Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Removes the specified child element.
*
* @param child - the child element to remove
*
* @returns the current element
*/
removeChild(
child: DocumentApp.Element
): DocumentApp.HeaderSection
/**
* Removes the element from its parent.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Clear the text surrounding "Apps Script", with or without text.
* body.replaceText("^.*Apps ?Script.*$", "Apps Script");
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* Note: existing contents are cleared.
*
* @param text - the new text contents
*
* @returns the current element
*/
setText(
text: string
): DocumentApp.HeaderSection
/**
* 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 be superscript.
* var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
* text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
* Any child elements present in the element are also copied. The new element will not have a * parent. * * @returns the new copy */ copy(): DocumentApp.HorizontalRule /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the element's parent element. * *
The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Removes the element from its parent.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* Any child elements present in the element are also copied. The new element will not have a
* parent.
*
* @returns the new copy
*/
copy(): DocumentApp.InlineDrawing
/**
* Returns the drawing's alternate description.
*
* @returns the alternate title, or null if the element does not have an alternate title
*/
getAltDescription(): string
/**
* Returns the drawing's alternate title.
*
* @returns the alternate title, or null if the element does not have an alternate title
*/
getAltTitle(): string
/**
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the element's parent element. * *
The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Merges the element with the preceding sibling of the same type.
*
* Only elements of the same ElementType may 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append two paragraphs to the document.
* var par1 = body.appendParagraph('Paragraph 1.');
* var par2 = body.appendParagraph('Paragraph 2.');
*
* // Merge the newly added paragraphs into a single paragraph.
* par2.merge();
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* null, sets the
* description to the empty string.
*
* @param description - the alternate title
*
* @returns the current object
*/
setAltDescription(
description: string
): DocumentApp.InlineDrawing
/**
* Sets the drawing's alternate title. If the given title is null, sets the title to the
* empty string.
*
* @param title - the alternate title
*
* @returns the current object
*/
setAltTitle(
title: string
): DocumentApp.InlineDrawing
/**
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* Any child elements present in the element are also copied. The new element will not have a
* parent.
*
* @returns the new copy
*/
copy(): DocumentApp.InlineImage
/**
* Returns the image's alternate description.
*
* @returns the alternate title, or null if the element does not have an alternate title
*/
getAltDescription(): string
/**
* Returns the image's alternate title.
*
* @returns the alternate title, or null if the element does not have an alternate title
*/
getAltTitle(): string
/**
* Return the data inside this object as a blob converted to the specified content type. This
* method adds the appropriate extension to the filename—for example, "myfile.pdf". However, it
* assumes that the part of the filename that follows the last period (if any) is an existing
* extension that should be replaced. Consequently, "ShoppingList.12.25.2014" becomes
* "ShoppingList.12.25.pdf".
*
*
To view the daily quotas for conversions, see Quotas for Google
* Services. Newly created G Suite domains might be temporarily subject to stricter quotas.
*
* @param contentType - The MIME type to convert to. For most blobs, 'application/pdf' is
* the only valid option. For images in BMP, GIF, JPEG, or PNG format, any of 'image/bmp', 'image/gif', 'image/jpeg', or 'image/png' are also
* valid.
*
* @returns The data as a blob.
*/
getAs(
contentType: string
): Blob
/**
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
* null if the element contains multiple values for this
* attribute.
*/
getLinkUrl(): string
/**
* Retrieves the element's next sibling element.
*
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the element's parent element. * *
The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Merges the element with the preceding sibling of the same type.
*
* Only elements of the same ElementType may 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append two paragraphs to the document.
* var par1 = body.appendParagraph('Paragraph 1.');
* var par2 = body.appendParagraph('Paragraph 2.');
*
* // Merge the newly added paragraphs into a single paragraph.
* par2.merge();
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* null, sets the
* description to the empty string.
*
* @param description - the alternate title
*
* @returns the current object
*/
setAltDescription(
description: string
): DocumentApp.InlineImage
/**
* Sets the image's alternate title. If the given title is null, sets the title to the
* empty string.
*
* @param title - the alternate title
*
* @returns the current object
*/
setAltTitle(
title: string
): DocumentApp.InlineImage
/**
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* null or an empty string, this method will create
* a link with an empty URL that may display as "Invalid link" in Google Docs.
*
* @param url - the link URL
*
* @returns the current object
*/
setLinkUrl(
url: string
): DocumentApp.InlineImage
/**
* Sets the image's width, in pixels.
*
* @param width - the image's width, in pixels
*
* @returns the current object
*/
setWidth(
width: number
): DocumentApp.InlineImage
}
class ListItem {
private constructor();
/**
* Creates and inserts a new PositionedImage from the specified image blob.
*
* @param image - the image data
*
* @returns the new positioned image
*/
addPositionedImage(
image: BlobSource
): DocumentApp.PositionedImage
/**
* Creates and appends a new HorizontalRule.
*
* @returns the new horizontal rule
*/
appendHorizontalRule(): DocumentApp.HorizontalRule
/**
* Creates and appends a new InlineImage from the specified image blob.
*
* @param image - the image data
*
* @returns the appended image
*/
appendInlineImage(
image: BlobSource
): DocumentApp.InlineImage
/**
* Appends the given InlineImage.
*
* @param image - the image data
*
* @returns the appended image
*/
appendInlineImage(
image: DocumentApp.InlineImage
): DocumentApp.InlineImage
/**
* Creates and appends a new PageBreak.
*
* Note: PageBreaks may not be contained within TableCells.
* If the current element is contained in a table cell, an exception will be thrown.
*
* @returns the new page break element
*/
appendPageBreak(): DocumentApp.PageBreak
/**
* Appends the given PageBreak.
*
*
Note: PageBreaks may not be contained within TableCells.
* If the current element is contained in a table cell, an exception will be thrown.
*
* @param pageBreak - the page break to append
*
* @returns the appended page break element
*/
appendPageBreak(
pageBreak: DocumentApp.PageBreak
): DocumentApp.PageBreak
/**
* Appends the given Text element.
*
* @param text - the text element to append
*
* @returns the appended text element
*/
appendText(
text: DocumentApp.Text
): DocumentApp.Text
/**
* Creates and appends a new Text element with the specified contents.
*
* @param text - the text contents
*
* @returns the new text element
*/
appendText(
text: string
): DocumentApp.Text
/**
* Clears the contents of the element.
*
* @returns the current element
*/
clear(): DocumentApp.ListItem
/**
* Returns a detached, deep copy of the current element.
*
*
Any child elements present in the element are also copied. The new element will not have a
* parent.
*
* @returns the new copy
*/
copy(): DocumentApp.ListItem
/**
* 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. * *
* var body = DocumentApp.getActiveDocument().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);
* RangeElement.
*
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define the search parameters.
* var searchType = DocumentApp.ElementType.PARAGRAPH;
* var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
* var searchResult = null;
*
* // Search until the paragraph is found.
* while (searchResult = body.findElement(searchType, searchResult)) {
* var par = searchResult.getElement().asParagraph();
* if (par.getHeading() == searchHeading) {
* // Found one, update and stop.
* par.setText('This is the first header.');
* return;
* }
* }
* 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. * * @param searchPattern - the pattern to search for * * @returns a search result indicating the position of the search text, or null if there is no * match */ findText( searchPattern: string ): DocumentApp.RangeElement /** * 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.
*
* @param searchPattern - the pattern to search for
* @param from - the search result to search from
*
* @returns a search result indicating the next position of the search text, or null if there is no
* match
*/
findText(
searchPattern: string,
from: DocumentApp.RangeElement
): DocumentApp.RangeElement
/**
* Retrieves the HorizontalAlignment.
*
* @returns the alignment
*/
getAlignment(): DocumentApp.HorizontalAlignment
/**
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document.
* var 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.");
* }
* GlyphType.
*
* @returns the glyph type
*/
getGlyphType(): DocumentApp.GlyphType
/**
* Retrieves the ParagraphHeading.
*
* @returns the heading
*/
getHeading(): DocumentApp.ParagraphHeading
/**
* Retrieves the end indentation, in points.
*
* @returns the end indentation, in points
*/
getIndentEnd(): Number
/**
* Retrieves the first line indentation, in points.
*
* @returns the first line indentation, in points
*/
getIndentFirstLine(): Number
/**
* Retrieves the start indentation.
*
* @returns the start indentation
*/
getIndentStart(): Number
/**
* Retrieves the line spacing, in points.
*
* @returns the line spacing, in points
*/
getLineSpacing(): Number
/**
* Retrieves the link url.
*
* @returns the link url, or null if the element contains multiple values for this attribute
*/
getLinkUrl(): string
/**
* Retrieves the list ID.
*
* @returns the list ID
*/
getListId(): string
/**
* Retrieves the list item's nesting level.
*
* By default, list items have a nesting level of zero. The nesting level determines the glyph * that is used by the list item. * * @returns the nesting level */ getNestingLevel(): number /** * Retrieves the element's next sibling element. * *
The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the number of children. * *
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Log the number of elements in the document.
* Logger.log("There are " + body.getNumChildren() +
* " elements in the document body.");
* The parent element contains the current element.
*
* @returns the parent element
*/
getParent(): DocumentApp.ContainerElement
/**
* Gets a PositionedImage by the image's ID.
*
* @param id - the image id
*
* @returns the positioned image
*/
getPositionedImage(
id: string
): DocumentApp.PositionedImage
/**
* Gets all PositionedImage objects anchored to the paragraph.
*
* @returns a list of positioned images
*/
getPositionedImages(): DocumentApp.PositionedImage[]
/**
* Retrieves the element's previous sibling element.
*
*
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the spacing after the element, in points.
*
* @returns the spacing after the element, in points
*/
getSpacingAfter(): Number
/**
* Retrieves the spacing before the element, in points.
*
* @returns the spacing before the element, in points
*/
getSpacingBefore(): Number
/**
* Retrieves the contents of the element as a text string.
*
* @returns the contents of the element as text string
*/
getText(): string
/**
* Gets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
* @returns 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
*/
getTextAlignment(): DocumentApp.TextAlignment
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* HorizontalRule at the specified index.
*
* @param childIndex - the index at which to insert the element
*
* @returns the new horizontal rule element
*/
insertHorizontalRule(
childIndex: number
): DocumentApp.HorizontalRule
/**
* Creates and inserts a new InlineImage from the specified image blob, at the specified
* index.
*
* @param childIndex - the index at which to insert the element
* @param image - the image data
*
* @returns the inserted inline image element
*/
insertInlineImage(
childIndex: number,
image: BlobSource
): DocumentApp.InlineImage
/**
* Inserts the given InlineImage at the specified index.
*
* @param childIndex - the index at which to insert the element
* @param image - the image data
*
* @returns the inserted inline image element
*/
insertInlineImage(
childIndex: number,
image: DocumentApp.InlineImage
): DocumentApp.InlineImage
/**
* Creates and inserts a new PageBreak at the specified index.
*
* Note: PageBreaks may not be contained within TableCells.
* If the current element is contained in a table cell, an exception will be thrown.
*
* @param childIndex - the index at which to insert the element
*
* @returns the new page break element
*/
insertPageBreak(
childIndex: number
): DocumentApp.PageBreak
/**
* Inserts the given PageBreak at the specified index.
*
*
Note: PageBreaks may not be contained within TableCells.
* If the current element is contained in a table cell, an exception will be thrown.
*
* @param childIndex - the index at which to insert the element
* @param pageBreak - the p[age break to insert
*
* @returns the inserted page break element
*/
insertPageBreak(
childIndex: number,
pageBreak: DocumentApp.PageBreak
): DocumentApp.PageBreak
/**
* Inserts the given Text element at the specified index, with the specified text
* contents.
*
* @param childIndex - the index at which to insert the element
* @param text - the text element to insert
*
* @returns the inserted text element
*/
insertText(
childIndex: number,
text: DocumentApp.Text
): DocumentApp.Text
/**
* Creates and inserts a new text element at the specified index.
*
* @param childIndex - the index at which to insert the element
* @param text - the text contents
*
* @returns the new text element
*/
insertText(
childIndex: number,
text: string
): DocumentApp.Text
/**
* Determines whether the element is at the end of the Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Retrieves the left-to-right setting.
*
* @returns the left-to-right setting
*/
isLeftToRight(): Boolean
/**
* Merges the element with the preceding sibling of the same type.
*
*
Only elements of the same ElementType may 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append two paragraphs to the document.
* var par1 = body.appendParagraph('Paragraph 1.');
* var par2 = body.appendParagraph('Paragraph 2.');
*
* // Merge the newly added paragraphs into a single paragraph.
* par2.merge();
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* PositionedImage by the image's ID.
*
* @param id
*
* @returns whether or not the specified image was removed
*/
removePositionedImage(
id: string
): Boolean
/**
* 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Clear the text surrounding "Apps Script", with or without text.
* body.replaceText("^.*Apps ?Script.*$", "Apps Script");
* HorizontalAlignment.
*
* @param alignment - the horizontal alignment
*
* @returns the current element
*/
setAlignment(
alignment: DocumentApp.HorizontalAlignment
): DocumentApp.ListItem
/**
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* GlyphType.
*
* @param glyphType - the glyph type
*
* @returns the current element
*/
setGlyphType(
glyphType: DocumentApp.GlyphType
): DocumentApp.ListItem
/**
* Sets the ParagraphHeading.
*
* @param heading - the heading
*
* @returns the current element
*/
setHeading(
heading: DocumentApp.ParagraphHeading
): DocumentApp.ListItem
/**
* Sets the end indentation, in points.
*
* @param indentEnd - the end indentation, in points
*
* @returns the current element
*/
setIndentEnd(
indentEnd: Number
): DocumentApp.ListItem
/**
* Sets the first line indentation, in points.
*
* @param indentFirstLine - the first line indentation, in points
*
* @returns the current element
*/
setIndentFirstLine(
indentFirstLine: Number
): DocumentApp.ListItem
/**
* Sets the start indentation, in points.
*
* @param indentStart - the start indentation, in points
*
* @returns the current element
*/
setIndentStart(
indentStart: Number
): DocumentApp.ListItem
/**
* Sets the left-to-right setting.
*
* @param leftToRight - the left-to-right setting
*
* @returns the current element
*/
setLeftToRight(
leftToRight: Boolean
): DocumentApp.ListItem
/**
* Sets the line spacing, as a quantity indicating the number of lines to use for spacing.
*
* @param multiplier - the number of lines
*
* @returns the current element
*/
setLineSpacing(
multiplier: Number
): DocumentApp.ListItem
/**
* Sets the link url.
*
* @param url - the link url
*
* @returns the current element
*/
setLinkUrl(
url: string
): DocumentApp.ListItem
/**
* Sets the list ID.
*
* The list ID is set to the same value for the specified ListItem. The two ListItems will be treated as members of the same list.
*
* @param listItem - the list item whose list ID to use
*
* @returns the current element
*/
setListId(
listItem: DocumentApp.ListItem
): DocumentApp.ListItem
/**
* Sets the list item's nesting level.
*
*
By default, list items have a nesting level of zero. The nesting level determines the glyph * that is used by the list item. * * @param nestingLevel - the nesting level * * @returns the current element */ setNestingLevel( nestingLevel: number ): DocumentApp.ListItem /** * Sets the spacing after the element, in points. * * @param spacingAfter - the spacing after the element, in points * * @returns the current element */ setSpacingAfter( spacingAfter: Number ): DocumentApp.ListItem /** * Sets the spacing before the element, in points. * * @param spacingBefore - the spacing before the element, in points * * @returns the current element */ setSpacingBefore( spacingBefore: Number ): DocumentApp.ListItem /** * Sets the contents of the list item as text. * *
Note: existing contents are cleared.
*
* @param text - the new text contents
*/
setText(
text: string
): void
/**
* 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 be superscript.
* var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
* text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
* NamedRange. The ID is unique within the document.
*
* @returns the range's ID, which is unique within the document
*/
getId(): string
/**
* Gets the name of this NamedRange. The name is not necessarily unique.
*
* @returns the range's name, which is not necessarily unique
*/
getName(): string
/**
* Gets the range of elements associated with this NamedRange.
*
* @returns the range of elements associated with the name and ID
*/
getRange(): DocumentApp.Range
/**
* Removes this NamedRange from the document. This method does not delete the contents of
* the range; it merely the removes the reference. Calling this method on a NamedRange
* that has already been removed has no effect.
*/
remove(): void
}
class PageBreak {
private constructor();
/**
* Returns a detached, deep copy of the current element.
*
* Any child elements present in the element are also copied. The new element will not have a * parent. * * @returns the new copy */ copy(): DocumentApp.PageBreak /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the element's parent element. * *
The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Removes the element from its parent.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* PositionedImage from the specified image blob.
*
* @param image - the image data
*
* @returns the new positioned image
*/
addPositionedImage(
image: BlobSource
): DocumentApp.PositionedImage
/**
* Creates and appends a new HorizontalRule.
*
* @returns the new horizontal rule
*/
appendHorizontalRule(): DocumentApp.HorizontalRule
/**
* Creates and appends a new InlineImage from the specified image blob.
*
* @param image - the image data
*
* @returns the appended image
*/
appendInlineImage(
image: BlobSource
): DocumentApp.InlineImage
/**
* Appends the given InlineImage.
*
* @param image - the image data
*
* @returns the appended image
*/
appendInlineImage(
image: DocumentApp.InlineImage
): DocumentApp.InlineImage
/**
* Creates and appends a new PageBreak.
*
* Note: PageBreaks may not be contained within TableCells.
* If the current element is contained in a table cell, an exception will be thrown.
*
* @returns the new page break element
*/
appendPageBreak(): DocumentApp.PageBreak
/**
* Appends the given PageBreak.
*
*
Note: PageBreaks may not be contained within TableCells.
* If the current element is contained in a table cell, an exception will be thrown.
*
* @param pageBreak - the page break to append
*
* @returns the appended page break element
*/
appendPageBreak(
pageBreak: DocumentApp.PageBreak
): DocumentApp.PageBreak
/**
* Appends the given Text element.
*
* @param text - the text element to append
*
* @returns the appended text element
*/
appendText(
text: DocumentApp.Text
): DocumentApp.Text
/**
* Creates and appends a new Text element with the specified contents.
*
* @param text - the text contents
*
* @returns the new text element
*/
appendText(
text: string
): DocumentApp.Text
/**
* Clears the contents of the element.
*
* @returns the current element
*/
clear(): DocumentApp.Paragraph
/**
* Returns a detached, deep copy of the current element.
*
*
Any child elements present in the element are also copied. The new element will not have a
* parent.
*
* @returns the new copy
*/
copy(): DocumentApp.Paragraph
/**
* 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. * *
* var body = DocumentApp.getActiveDocument().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);
* RangeElement.
*
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define the search parameters.
* var searchType = DocumentApp.ElementType.PARAGRAPH;
* var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
* var searchResult = null;
*
* // Search until the paragraph is found.
* while (searchResult = body.findElement(searchType, searchResult)) {
* var par = searchResult.getElement().asParagraph();
* if (par.getHeading() == searchHeading) {
* // Found one, update and stop.
* par.setText('This is the first header.');
* return;
* }
* }
* 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. * * @param searchPattern - the pattern to search for * * @returns a search result indicating the position of the search text, or null if there is no * match */ findText( searchPattern: string ): DocumentApp.RangeElement /** * 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.
*
* @param searchPattern - the pattern to search for
* @param from - the search result to search from
*
* @returns a search result indicating the next position of the search text, or null if there is no
* match
*/
findText(
searchPattern: string,
from: DocumentApp.RangeElement
): DocumentApp.RangeElement
/**
* Retrieves the HorizontalAlignment.
*
* @returns the alignment
*/
getAlignment(): DocumentApp.HorizontalAlignment
/**
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document.
* var 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.");
* }
* ParagraphHeading.
*
* @returns the heading
*/
getHeading(): DocumentApp.ParagraphHeading
/**
* Retrieves the end indentation, in points.
*
* @returns the end indentation, in points
*/
getIndentEnd(): Number
/**
* Retrieves the first line indentation, in points.
*
* @returns the first line indentation, in points
*/
getIndentFirstLine(): Number
/**
* Retrieves the start indentation.
*
* @returns the start indentation
*/
getIndentStart(): Number
/**
* Retrieves the line spacing, in points.
*
* @returns the line spacing, in points
*/
getLineSpacing(): Number
/**
* Retrieves the link url.
*
* @returns the link url, or null if the element contains multiple values for this attribute
*/
getLinkUrl(): string
/**
* Retrieves the element's next sibling element.
*
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the number of children. * *
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Log the number of elements in the document.
* Logger.log("There are " + body.getNumChildren() +
* " elements in the document body.");
* The parent element contains the current element.
*
* @returns the parent element
*/
getParent(): DocumentApp.ContainerElement
/**
* Gets a PositionedImage by the image's ID.
*
* @param id - the image id
*
* @returns the positioned image
*/
getPositionedImage(
id: string
): DocumentApp.PositionedImage
/**
* Gets all PositionedImage objects anchored to the paragraph.
*
* @returns a list of positioned images
*/
getPositionedImages(): DocumentApp.PositionedImage[]
/**
* Retrieves the element's previous sibling element.
*
*
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the spacing after the element, in points.
*
* @returns the spacing after the element, in points
*/
getSpacingAfter(): Number
/**
* Retrieves the spacing before the element, in points.
*
* @returns the spacing before the element, in points
*/
getSpacingBefore(): Number
/**
* Retrieves the contents of the element as a text string.
*
* @returns the contents of the element as text string
*/
getText(): string
/**
* Gets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
* @returns 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
*/
getTextAlignment(): DocumentApp.TextAlignment
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* HorizontalRule at the specified index.
*
* @param childIndex - the index at which to insert the element
*
* @returns the new horizontal rule element
*/
insertHorizontalRule(
childIndex: number
): DocumentApp.HorizontalRule
/**
* Creates and inserts a new InlineImage from the specified image blob, at the specified
* index.
*
* @param childIndex - the index at which to insert the element
* @param image - the image data
*
* @returns the inserted inline image element
*/
insertInlineImage(
childIndex: number,
image: BlobSource
): DocumentApp.InlineImage
/**
* Inserts the given InlineImage at the specified index.
*
* @param childIndex - the index at which to insert the element
* @param image - the image data
*
* @returns the inserted inline image element
*/
insertInlineImage(
childIndex: number,
image: DocumentApp.InlineImage
): DocumentApp.InlineImage
/**
* Creates and inserts a new PageBreak at the specified index.
*
* Note: PageBreaks may not be contained within TableCells.
* If the current element is contained in a table cell, an exception will be thrown.
*
* @param childIndex - the index at which to insert the element
*
* @returns the new page break element
*/
insertPageBreak(
childIndex: number
): DocumentApp.PageBreak
/**
* Inserts the given PageBreak at the specified index.
*
*
Note: PageBreaks may not be contained within TableCells.
* If the current element is contained in a table cell, an exception will be thrown.
*
* @param childIndex - the index at which to insert the element
* @param pageBreak - the p[age break to insert
*
* @returns the inserted page break element
*/
insertPageBreak(
childIndex: number,
pageBreak: DocumentApp.PageBreak
): DocumentApp.PageBreak
/**
* Inserts the given Text element at the specified index, with the specified text
* contents.
*
* @param childIndex - the index at which to insert the element
* @param text - the text element to insert
*
* @returns the inserted text element
*/
insertText(
childIndex: number,
text: DocumentApp.Text
): DocumentApp.Text
/**
* Creates and inserts a new text element at the specified index.
*
* @param childIndex - the index at which to insert the element
* @param text - the text contents
*
* @returns the new text element
*/
insertText(
childIndex: number,
text: string
): DocumentApp.Text
/**
* Determines whether the element is at the end of the Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Retrieves the left-to-right setting.
*
* @returns the left-to-right setting
*/
isLeftToRight(): Boolean
/**
* Merges the element with the preceding sibling of the same type.
*
*
Only elements of the same ElementType may 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append two paragraphs to the document.
* var par1 = body.appendParagraph('Paragraph 1.');
* var par2 = body.appendParagraph('Paragraph 2.');
*
* // Merge the newly added paragraphs into a single paragraph.
* par2.merge();
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* PositionedImage by the image's ID.
*
* @param id - the image id
*
* @returns whether or not the specified image was removed
*/
removePositionedImage(
id: string
): Boolean
/**
* 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Clear the text surrounding "Apps Script", with or without text.
* body.replaceText("^.*Apps ?Script.*$", "Apps Script");
* HorizontalAlignment.
*
* @param alignment - the horizontal alignment
*
* @returns the current element
*/
setAlignment(
alignment: DocumentApp.HorizontalAlignment
): DocumentApp.Paragraph
/**
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* ParagraphHeading.
*
* @param heading - the heading
*
* @returns the current element
*/
setHeading(
heading: DocumentApp.ParagraphHeading
): DocumentApp.Paragraph
/**
* Sets the end indentation, in points.
*
* @param indentEnd - the end indentation, in points
*
* @returns the current element
*/
setIndentEnd(
indentEnd: Number
): DocumentApp.Paragraph
/**
* Sets the first line indentation, in points.
*
* @param indentFirstLine - the first line indentation, in points
*
* @returns the current element
*/
setIndentFirstLine(
indentFirstLine: Number
): DocumentApp.Paragraph
/**
* Sets the start indentation, in points.
*
* @param indentStart - the start indentation, in points
*
* @returns the current element
*/
setIndentStart(
indentStart: Number
): DocumentApp.Paragraph
/**
* Sets the left-to-right setting.
*
* @param leftToRight - the left-to-right setting
*
* @returns the current element
*/
setLeftToRight(
leftToRight: Boolean
): DocumentApp.Paragraph
/**
* Sets the line spacing, as a quantity indicating the number of lines to use for spacing.
*
* @param multiplier - the number of lines
*
* @returns the current element
*/
setLineSpacing(
multiplier: Number
): DocumentApp.Paragraph
/**
* Sets the link url.
*
* @param url - the link url
*
* @returns the current element
*/
setLinkUrl(
url: string
): DocumentApp.Paragraph
/**
* Sets the spacing after the element, in points.
*
* @param spacingAfter - the spacing after the element, in points
*
* @returns the current element
*/
setSpacingAfter(
spacingAfter: Number
): DocumentApp.Paragraph
/**
* Sets the spacing before the element, in points.
*
* @param spacingBefore - the spacing before the element, in points
*
* @returns the current element
*/
setSpacingBefore(
spacingBefore: Number
): DocumentApp.Paragraph
/**
* Sets the contents of the paragraph as text.
*
* Note: existing contents are cleared.
*
* @param text - the new text contents
*/
setText(
text: string
): void
/**
* 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 be superscript.
* var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
* text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
* Position. This will be either a Text
* element or a container element like Paragraph. In either case, the relative
* position within the element can be determined with getOffset().
*
* @returns the container or Text element in which this Position object is located
*/
getElement(): DocumentApp.Element
/**
* Gets this Position's relative location within the element that contains it. If the
* element is a Text element, the offset is the number of characters before the Position (that is, the index of the character after this Position); for any other
* element, the offset is the number of child elements before this Position within the
* same container element (that is, the index of the child element after the Position).
*
* @returns for Text elements, the number of characters before this Position; for
* other elements, the number of child elements before this Position within the same
* container element
*/
getOffset(): number
/**
* Creates an artificial Text element that represents the text and formatting of the
* Paragraph or ListItem that contains the Position, either directly or through a chain of child elements. To determine the Position's offset in the returned Text element, use getSurroundingTextOffset().
*
* @returns an element equivalent to the result of calling editAsText()
* on the Paragraph or ListItem that contains the Position, either directly or through a chain of child elements
*/
getSurroundingText(): DocumentApp.Text
/**
* Gets the offset of this Position within the Text element returned by getSurroundingText(). The offset is the number of characters before the Position
* (that is, the index of the character after this Position).
*
* @returns the number of characters before this Position in the Paragraph or ListItem that contains the Position, either directly or through a chain of child elements
*/
getSurroundingTextOffset(): number
/**
* Creates and inserts a new Bookmark at this Position.
*
* @returns the new bookmark
*/
insertBookmark(): DocumentApp.Bookmark
/**
* Creates and inserts a new InlineImage at this Position from the specified image
* blob.
*
* @param image - the image data to insert at this Position
*
* @returns the new image element, or null if the element in which this Position is
* located does not allow images to be inserted
*/
insertInlineImage(
image: BlobSource
): DocumentApp.InlineImage
/**
* Inserts the specified text at this Position. This method creates a new Text
* element, even if the string is inserted within an existing Text element, so that it is
* easy to style the new element.
*
* @param text - the string to insert at this Position
*
* @returns the new text element, or null if the element in which this Position is
* located does not allow text to be inserted
*/
insertText(
text: string
): DocumentApp.Text
}
class PositionedImage {
private constructor();
/**
* Return the data inside this object as a blob converted to the specified content type. This
* method adds the appropriate extension to the filename—for example, "myfile.pdf". However, it
* assumes that the part of the filename that follows the last period (if any) is an existing
* extension that should be replaced. Consequently, "ShoppingList.12.25.2014" becomes
* "ShoppingList.12.25.pdf".
*
* To view the daily quotas for conversions, see Quotas for Google
* Services. Newly created G Suite domains might be temporarily subject to stricter quotas.
*
* @param contentType - The MIME type to convert to. For most blobs, 'application/pdf' is
* the only valid option. For images in BMP, GIF, JPEG, or PNG format, any of 'image/bmp', 'image/gif', 'image/jpeg', or 'image/png' are also
* valid.
*
* @returns The data as a blob.
*/
getAs(
contentType: string
): Blob
/**
* Return the data inside this object as a blob.
*
* @returns The data as a blob.
*/
getBlob(): Blob
/**
* Retrieves the image's height, in pixels.
*
* @returns the image's height, in pixels
*/
getHeight(): number
/**
* Gets the image's ID.
*
* @returns the image ID
*/
getId(): string
/**
* Gets an enum value that represents how the image is laid out.
*
* @returns the image layout
*/
getLayout(): DocumentApp.PositionedLayout
/**
* Gets the image's offset, in points, from the paragraph's left.
*
* @returns the image offset from the left paragraph's left
*/
getLeftOffset(): Number
/**
* Gets the Paragraph the image is anchored to.
*
* @returns the parent paragraph
*/
getParagraph(): DocumentApp.Paragraph
/**
* Gets the image's offset, in points, from the paragraph's top.
*
* @returns the image offset from the left paragraph's top
*/
getTopOffset(): Number
/**
* Retrieves the image's width, in pixels.
*
* @returns the image's width, in pixels
*/
getWidth(): number
/**
* Sets the image's height, in pixels.
*
* @param height - the image's height, in pixels
*
* @returns the current object
*/
setHeight(
height: number
): DocumentApp.PositionedImage
/**
* Sets the definition of how the image is laid out.
*
* @param layout - an enum representing the layout mode
*
* @returns this object for chaining
*/
setLayout(
layout: DocumentApp.PositionedLayout
): DocumentApp.PositionedImage
/**
* Sets the image's offset, in points, from the paragraph's left.
*
* @param offset - offset from the paragraph's left
*
* @returns this object for chaining
*/
setLeftOffset(
offset: Number
): DocumentApp.PositionedImage
/**
* Sets the image's offset, in points, from the paragraph's top.
*
* @param offset - offset from the paragraph's top
*
* @returns this object for chaining
*/
setTopOffset(
offset: Number
): DocumentApp.PositionedImage
/**
* Sets the image's width, in pixels.
*
* @param width - the image's width, in pixels
*
* @returns the current object
*/
setWidth(
width: number
): DocumentApp.PositionedImage
}
enum PositionedLayout {
/**
* The image is positioned above the text.
*/
ABOVE_TEXT = "ABOVE_TEXT",
/**
* The image breaks the text on the left and right.
*/
BREAK_BOTH = "BREAK_BOTH",
/**
* The image breaks the text on the left.
*/
BREAK_LEFT = "BREAK_LEFT",
/**
* The image breaks the text on the right.
*/
BREAK_RIGHT = "BREAK_RIGHT",
/**
* The image is wrapped by text.
*/
WRAP_TEXT = "WRAP_TEXT",
}
class Range {
private constructor();
/**
* Gets all elements in this Range, including any partial Text elements (for example, in the case
* of a selection that includes only part of a Text element). To determine whether a
* Text element is only partially included in the range, see RangeElement.isPartial().
*
* @returns an array of elements, in the order they appear in the document
*/
getRangeElements(): DocumentApp.RangeElement[]
/**
* Gets all elements that the user has selected in the open instance of the document, including
* any partially selected Text
* elements.
*
* @returns an array of selected or partially selected elements, in the order they appear in the
* document
*/
getSelectedElements(): DocumentApp.RangeElement[]
}
class RangeBuilder {
private constructor();
/**
* Adds an entire Element to this RangeBuilder.
*
* @param element - the element to be added
*
* @returns this builder, for chaining
*/
addElement(
element: DocumentApp.Element
): DocumentApp.RangeBuilder
/**
* Adds a partial Text element to this RangeBuilder.
*
* @param textElement - the text element to be partially added
* @param startOffset - the number of characters before the first character to be included (that is,
* the index of the first character in the range)
* @param endOffsetInclusive - the number of characters before the last character to be included
* (that is, the index of the last character in the range)
*
* @returns this builder, for chaining
*/
addElement(
textElement: DocumentApp.Text,
startOffset: number,
endOffsetInclusive: number
): DocumentApp.RangeBuilder
/**
* Adds two entire elements, and all elements between them, to this RangeBuilder.
*
* @param startElement - the first element to be added
* @param endElementInclusive - the last element to be added
*
* @returns this builder, for chaining
*/
addElementsBetween(
startElement: DocumentApp.Element,
endElementInclusive: DocumentApp.Element
): DocumentApp.RangeBuilder
/**
* Adds two partial Text elements, and all elements between them, to the RangeBuilder.
*
* @param startTextElement - the first text element to be partially added
* @param startOffset - the number of characters before the first character of startTextElement to be included (that is, the index of the first character in the range)
* @param endTextElementInclusive - the last text element to be partially added
* @param endOffsetInclusive - the number of characters before the last character of endTextElementInclusive to be included (that is, the index of the last character in the
* range)
*
* @returns this builder, for chaining
*/
addElementsBetween(
startTextElement: DocumentApp.Text,
startOffset: number,
endTextElementInclusive: DocumentApp.Text,
endOffsetInclusive: number
): DocumentApp.RangeBuilder
/**
* Adds the contents of another Range to this RangeBuilder.
*
* @param range - the range whose elements should be added
*
* @returns this builder, for chaining
*/
addRange(
range: DocumentApp.Range
): DocumentApp.RangeBuilder
/**
* Constructs a Range from the settings applied to the builder.
*
* @returns the newly constructed range
*/
build(): DocumentApp.Range
/**
* Gets all elements in this Range, including any partial Text elements (for example, in the case
* of a selection that includes only part of a Text element). To determine whether a
* Text element is only partially included in the range, see RangeElement.isPartial().
*
* @returns an array of elements, in the order they appear in the document
*/
getRangeElements(): DocumentApp.RangeElement[]
/**
* Gets all elements that the user has selected in the open instance of the document, including
* any partially selected Text
* elements.
*
* @returns an array of selected or partially selected elements, in the order they appear in the
* document
*/
getSelectedElements(): DocumentApp.RangeElement[]
}
class RangeElement {
private constructor();
/**
* Gets the Element that corresponds to this RangeElement.
*
*
* // Log debug information about a range element.
* Logger.log('Element type: ' + rangeElement.getElement().getType());
* if (rangeElement.isPartial()) {
* Logger.log('The character range begins at ' + rangeElement.getStartOffset());
* Logger.log('The character range ends at ' + rangeElement.getEndOffsetInclusive());
* } else {
* Logger.log('The entire range element is included.');
* }
* RangeElement
*/
getElement(): DocumentApp.Element
/**
* Gets the position of the end of a partial range within the range element. If the element is a
* Text element and isPartial() returns true, the offset is the number of characters before the last
* character in the range (that is, the index of the last character in the range); in any other
* case, this method returns -1.
*
* @returns for Text elements, the
* number of character before the last character in the range; for other elements, -1
*/
getEndOffsetInclusive(): number
/**
* Gets the position of the start of a partial range within the range element. If the element is a
* Text element and isPartial() returns true, the offset is the number of characters before the start of
* the range (that is, the index of the first character in the range); in any other case, this
* method returns -1.
*
* @returns for Text elements, the
* number of characters before the start of the range; for other elements, -1
*/
getStartOffset(): number
/**
* Determines whether this range element covers the entire element or a partial selection of the
* element's characters. The beginning and end of a partial range element's range can be
* determined using getStartOffset() and getEndOffsetInclusive(), respectively.
*
* @returns true if the element is partially included; false if not
*/
isPartial(): Boolean
}
class Table {
private constructor();
/**
* Creates and appends a new TableRow.
*
* @returns the new table row element
*/
appendTableRow(): DocumentApp.TableRow
/**
* Appends the given TableRow.
*
* @param tableRow - the table row to append
*
* @returns the appended table row element
*/
appendTableRow(
tableRow: DocumentApp.TableRow
): DocumentApp.TableRow
/**
* Clears the contents of the element.
*
* @returns the current element
*/
clear(): DocumentApp.Table
/**
* Returns a detached, deep copy of the current element.
*
* Any child elements present in the element are also copied. The new element will not have a
* parent.
*
* @returns the new copy
*/
copy(): DocumentApp.Table
/**
* 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. * *
* var body = DocumentApp.getActiveDocument().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);
* RangeElement.
*
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define the search parameters.
* var searchType = DocumentApp.ElementType.PARAGRAPH;
* var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
* var searchResult = null;
*
* // Search until the paragraph is found.
* while (searchResult = body.findElement(searchType, searchResult)) {
* var par = searchResult.getElement().asParagraph();
* if (par.getHeading() == searchHeading) {
* // Found one, update and stop.
* par.setText('This is the first header.');
* return;
* }
* }
* 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. * * @param searchPattern - the pattern to search for * * @returns a search result indicating the position of the search text, or null if there is no * match */ findText( searchPattern: string ): DocumentApp.RangeElement /** * 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. * * @param searchPattern - the pattern to search for * @param from - the search result to search from * * @returns a search result indicating the next position of the search text, or null if there is no * match */ findText( searchPattern: string, from: DocumentApp.RangeElement ): DocumentApp.RangeElement /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
* '#ffffff')
*/
getBorderColor(): string
/**
* Retrieves the border width, in points.
*
* @returns the border width, in points
*/
getBorderWidth(): Number
/**
* Retrieves the TableCell at the specified row and cell indices.
*
* @param rowIndex - the index of the row containing the cell to retrieve
* @param cellIndex - the index of the cell to retrieve
*
* @returns the table cell
*/
getCell(
rowIndex: number,
cellIndex: number
): DocumentApp.TableCell
/**
* Retrieves the child element at the specified child index.
*
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document.
* var 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.");
* }
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the number of children. * *
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Log the number of elements in the document.
* Logger.log("There are " + body.getNumChildren() +
* " elements in the document body.");
* TableRows.
*
* @returns the number of table rows
*/
getNumRows(): number
/**
* Retrieves the element's parent element.
*
* The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the TableRow at the specified row index.
*
* @param rowIndex - the index of the row to retrieve
*
* @returns the table row
*/
getRow(
rowIndex: number
): DocumentApp.TableRow
/**
* Retrieves the contents of the element as a text string.
*
* @returns the contents of the element as text string
*/
getText(): string
/**
* Gets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
* @returns 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
*/
getTextAlignment(): DocumentApp.TextAlignment
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* TableRow at the specified index.
*
* @param childIndex - the index at which to insert the element
*
* @returns the current element
*/
insertTableRow(
childIndex: number
): DocumentApp.TableRow
/**
* Inserts the given TableRow at the specified index.
*
* @param childIndex - the index at which to insert the element
* @param tableRow - the table row to insert
*
* @returns the inserted table row element
*/
insertTableRow(
childIndex: number,
tableRow: DocumentApp.TableRow
): DocumentApp.TableRow
/**
* Determines whether the element is at the end of the Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Removes the specified child element.
*
* @param child - the child element to remove
*
* @returns the current element
*/
removeChild(
child: DocumentApp.Element
): DocumentApp.Table
/**
* Removes the element from its parent.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* TableRow at the specified row index.
*
* @param rowIndex - the index of the row to remove
*
* @returns the removed row
*/
removeRow(
rowIndex: number
): DocumentApp.TableRow
/**
* 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Clear the text surrounding "Apps Script", with or without text.
* body.replaceText("^.*Apps ?Script.*$", "Apps Script");
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* '#ffffff')
*
* @returns the current element
*/
setBorderColor(
color: string
): DocumentApp.Table
/**
* Sets the border width, in points.
*
* @param width - the border width, in points
*
* @returns the current element
*/
setBorderWidth(
width: Number
): DocumentApp.Table
/**
* Sets the width of the specified column, in points.
*
* @param columnIndex - the column index
* @param width - the border width, in points
*
* @returns the current element
*/
setColumnWidth(
columnIndex: number,
width: Number
): DocumentApp.Table
/**
* Sets the link url.
*
* @param url - the link url
*
* @returns the current element
*/
setLinkUrl(
url: string
): DocumentApp.Table
/**
* 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 be superscript.
* var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
* text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
* HorizontalRule.
*
* The HorizontalRule will be contained in a new Paragraph.
*
* @returns the new horizontal rule
*/
appendHorizontalRule(): DocumentApp.HorizontalRule
/**
* Creates and appends a new InlineImage from the specified image blob.
*
*
The InlineImage will be contained in a new Paragraph.
*
* @param image - the image data
*
* @returns the new image
*/
appendImage(
image: BlobSource
): DocumentApp.InlineImage
/**
* Appends the given InlineImage.
*
*
The InlineImage will be contained in a new Paragraph.
*
* @param image - the image data
*
* @returns the appended image
*/
appendImage(
image: DocumentApp.InlineImage
): DocumentApp.InlineImage
/**
* Appends the given ListItem.
*
* @param listItem - the list item to append
*
* @returns the appended list item
*/
appendListItem(
listItem: DocumentApp.ListItem
): DocumentApp.ListItem
/**
* Creates and appends a new ListItem.
*
* @param text - the text contents
*
* @returns the new list item
*/
appendListItem(
text: string
): DocumentApp.ListItem
/**
* Appends the given Paragraph.
*
* @param paragraph - the paragraph to append
*
* @returns the appended paragraph
*/
appendParagraph(
paragraph: DocumentApp.Paragraph
): DocumentApp.Paragraph
/**
* Creates and appends a new Paragraph.
*
* @param text - the text contents
*
* @returns the new paragraph
*/
appendParagraph(
text: string
): DocumentApp.Paragraph
/**
* Creates and appends a new Table.
*
* @returns the new table
*/
appendTable(): DocumentApp.Table
/**
* Appends the given Table.
*
* @param table - the table to append
*
* @returns the appended table
*/
appendTable(
table: DocumentApp.Table
): DocumentApp.Table
/**
* Appends a new Table containing the specified cells.
*
* @param cells - the text contents of the table cells to add to the new table
*
* @returns the appended table
*/
appendTable(
cells: string[][]
): DocumentApp.Table
/**
* Clears the contents of the element.
*
* @returns the current element
*/
clear(): DocumentApp.TableCell
/**
* Returns a detached, deep copy of the current element.
*
*
Any child elements present in the element are also copied. The new element will not have a
* parent.
*
* @returns the new copy
*/
copy(): DocumentApp.TableCell
/**
* 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. * *
* var body = DocumentApp.getActiveDocument().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);
* RangeElement.
*
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define the search parameters.
* var searchType = DocumentApp.ElementType.PARAGRAPH;
* var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
* var searchResult = null;
*
* // Search until the paragraph is found.
* while (searchResult = body.findElement(searchType, searchResult)) {
* var par = searchResult.getElement().asParagraph();
* if (par.getHeading() == searchHeading) {
* // Found one, update and stop.
* par.setText('This is the first header.');
* return;
* }
* }
* 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. * * @param searchPattern - the pattern to search for * * @returns a search result indicating the position of the search text, or null if there is no * match */ findText( searchPattern: string ): DocumentApp.RangeElement /** * 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. * * @param searchPattern - the pattern to search for * @param from - the search result to search from * * @returns a search result indicating the next position of the search text, or null if there is no * match */ findText( searchPattern: string, from: DocumentApp.RangeElement ): DocumentApp.RangeElement /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
* '#ffffff')
*/
getBackgroundColor(): string
/**
* Retrieves the child element at the specified child index.
*
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document.
* var 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.");
* }
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the number of children. * *
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Log the number of elements in the document.
* Logger.log("There are " + body.getNumChildren() +
* " elements in the document body.");
* The parent element contains the current element.
*
* @returns the parent element
*/
getParent(): DocumentApp.ContainerElement
/**
* Retrieves the TableRow containing the current TableCell.
*
* @returns the table row containing the current cell
*/
getParentRow(): DocumentApp.TableRow
/**
* Retrieves the Table containing the current TableCell.
*
* @returns the table containing the current cell
*/
getParentTable(): DocumentApp.Table
/**
* Retrieves the element's previous sibling element.
*
*
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the row span, which is the number of rows of table cells this cell spans. Non-merged
* cells have a row span of 1.
*
* @returns the row span or 0 for a cell which is merged over by another cell
*/
getRowSpan(): number
/**
* Retrieves the contents of the element as a text string.
*
* @returns the contents of the element as text string
*/
getText(): string
/**
* Gets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
* @returns 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
*/
getTextAlignment(): DocumentApp.TextAlignment
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* VerticalAlignment.
*
* @returns the vertical alignment
*/
getVerticalAlignment(): DocumentApp.VerticalAlignment
/**
* Retrieves the width of the column containing the cell, in points.
*
* @returns the column width, in points
*/
getWidth(): Number
/**
* Creates and inserts a new HorizontalRule at the specified index.
*
* The horizontal rule will be contained in a new Paragraph.
*
* @param childIndex - the index at which to insert the element
*
* @returns the new horizontal rule
*/
insertHorizontalRule(
childIndex: number
): DocumentApp.HorizontalRule
/**
* Creates and inserts an InlineImage from the specified image blob, at the specified
* index.
*
*
The image will be contained in a new Paragraph.
*
* @param childIndex - the index at which to insert the element
* @param image - the image data
*
* @returns the inserted inline image
*/
insertImage(
childIndex: number,
image: BlobSource
): DocumentApp.InlineImage
/**
* Inserts the given InlineImage at the specified index.
*
*
The image will be contained in a new Paragraph.
*
* @param childIndex - the index at which to insert the element
* @param image - the image to insert
*
* @returns the inserted inline image
*/
insertImage(
childIndex: number,
image: DocumentApp.InlineImage
): DocumentApp.InlineImage
/**
* Inserts the given ListItem at the specified index.
*
* @param childIndex - the index at which to insert the element
* @param listItem - the list item to insert
*
* @returns inserted new list item
*/
insertListItem(
childIndex: number,
listItem: DocumentApp.ListItem
): DocumentApp.ListItem
/**
* Creates and inserts a new ListItem at the specified index.
*
* @param childIndex - the index at which to insert the element
* @param text - the text contents
*
* @returns the new list item
*/
insertListItem(
childIndex: number,
text: string
): DocumentApp.ListItem
/**
* Inserts the given Paragraph at the specified index.
*
* @param childIndex - the index at which to insert the element
* @param paragraph - the paragraph to insert
*
* @returns the inserted paragraph
*/
insertParagraph(
childIndex: number,
paragraph: DocumentApp.Paragraph
): DocumentApp.Paragraph
/**
* Creates and inserts a new Paragraph at the specified index.
*
* @param childIndex - the index at which to insert the element
* @param text - the text contents
*
* @returns the new paragraph
*/
insertParagraph(
childIndex: number,
text: string
): DocumentApp.Paragraph
/**
* Creates and inserts a new Table at the specified index.
*
* @param childIndex - the index at which to insert the element
*
* @returns the new table
*/
insertTable(
childIndex: number
): DocumentApp.Table
/**
* Inserts the given Table at the specified index.
*
* @param childIndex - the index at which to insert the element
* @param table - the table to insert
*
* @returns the inserted table
*/
insertTable(
childIndex: number,
table: DocumentApp.Table
): DocumentApp.Table
/**
* Creates and inserts a new Table containing the specified cells, at the specified index.
*
* @param childIndex - the index at which to insert
* @param cells - the text contents of the table cells to add to the new table
*
* @returns the new table
*/
insertTable(
childIndex: number,
cells: string[][]
): DocumentApp.Table
/**
* Determines whether the element is at the end of the Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Merges the element with the preceding sibling of the same type.
*
*
Only elements of the same ElementType may 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append two paragraphs to the document.
* var par1 = body.appendParagraph('Paragraph 1.');
* var par2 = body.appendParagraph('Paragraph 2.');
*
* // Merge the newly added paragraphs into a single paragraph.
* par2.merge();
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Clear the text surrounding "Apps Script", with or without text.
* body.replaceText("^.*Apps ?Script.*$", "Apps Script");
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* '#ffffff')
*
* @returns the current element
*/
setBackgroundColor(
color: string
): DocumentApp.TableCell
/**
* Sets the link url.
*
* @param url - the link url
*
* @returns the current element
*/
setLinkUrl(
url: string
): DocumentApp.TableCell
/**
* Sets the bottom padding, in points.
*
* @param paddingBottom - the bottom padding, in points
*
* @returns the current element
*/
setPaddingBottom(
paddingBottom: Number
): DocumentApp.TableCell
/**
* Sets the left padding, in points.
*
* @param paddingLeft - the left padding, in points
*
* @returns the current element
*/
setPaddingLeft(
paddingLeft: Number
): DocumentApp.TableCell
/**
* Sets the right padding, in points.
*
* @param paddingTop - the right padding, in points
*
* @returns the current element
*/
setPaddingRight(
paddingTop: Number
): DocumentApp.TableCell
/**
* Sets the top padding, in points.
*
* @param paddingTop - the top padding, in points
*
* @returns the current element
*/
setPaddingTop(
paddingTop: Number
): DocumentApp.TableCell
/**
* Sets the contents as plain text.
*
* Note: existing contents are cleared.
*
* @param text - the new text contents
*
* @returns the current element
*/
setText(
text: string
): DocumentApp.TableCell
/**
* 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 be superscript.
* var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
* text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
* Any child elements present in the element are also copied. The new element will not have a
* parent.
*
* @returns the new copy
*/
copy(): DocumentApp.TableOfContents
/**
* 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. * *
* var body = DocumentApp.getActiveDocument().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);
* RangeElement.
*
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define the search parameters.
* var searchType = DocumentApp.ElementType.PARAGRAPH;
* var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
* var searchResult = null;
*
* // Search until the paragraph is found.
* while (searchResult = body.findElement(searchType, searchResult)) {
* var par = searchResult.getElement().asParagraph();
* if (par.getHeading() == searchHeading) {
* // Found one, update and stop.
* par.setText('This is the first header.');
* return;
* }
* }
* 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. * * @param searchPattern - the pattern to search for * * @returns a search result indicating the position of the search text, or null if there is no * match */ findText( searchPattern: string ): DocumentApp.RangeElement /** * 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. * * @param searchPattern - the pattern to search for * @param from - the search result to search from * * @returns a search result indicating the next position of the search text, or null if there is no * match */ findText( searchPattern: string, from: DocumentApp.RangeElement ): DocumentApp.RangeElement /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document.
* var 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.");
* }
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the number of children. * *
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Log the number of elements in the document.
* Logger.log("There are " + body.getNumChildren() +
* " elements in the document body.");
* The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the contents of the element as a text string.
*
* @returns the contents of the element as text string
*/
getText(): string
/**
* Gets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
* @returns 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
*/
getTextAlignment(): DocumentApp.TextAlignment
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Removes the element from its parent.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Clear the text surrounding "Apps Script", with or without text.
* body.replaceText("^.*Apps ?Script.*$", "Apps Script");
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
*
* // Make the entire first paragraph be superscript.
* var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
* text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
* TableCell.
*
* @returns the new table cell
*/
appendTableCell(): DocumentApp.TableCell
/**
* Appends the given TableCell.
*
* @param tableCell - the table cell to append
*
* @returns the appended table cell
*/
appendTableCell(
tableCell: DocumentApp.TableCell
): DocumentApp.TableCell
/**
* Appends the given TableCell containing the specified text.
*
* @param textContents - the cell's text contents
*
* @returns the appended table cell element
*/
appendTableCell(
textContents: string
): DocumentApp.TableCell
/**
* Clears the contents of the element.
*
* @returns the current element
*/
clear(): DocumentApp.TableRow
/**
* Returns a detached, deep copy of the current element.
*
* Any child elements present in the element are also copied. The new element will not have a
* parent.
*
* @returns the new copy
*/
copy(): DocumentApp.TableRow
/**
* 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. * *
* var body = DocumentApp.getActiveDocument().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);
* RangeElement.
*
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define the search parameters.
* var searchType = DocumentApp.ElementType.PARAGRAPH;
* var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
* var searchResult = null;
*
* // Search until the paragraph is found.
* while (searchResult = body.findElement(searchType, searchResult)) {
* var par = searchResult.getElement().asParagraph();
* if (par.getHeading() == searchHeading) {
* // Found one, update and stop.
* par.setText('This is the first header.');
* return;
* }
* }
* 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. * * @param searchPattern - the pattern to search for * * @returns a search result indicating the position of the search text, or null if there is no * match */ findText( searchPattern: string ): DocumentApp.RangeElement /** * 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. * * @param searchPattern - the pattern to search for * @param from - the search result to search from * * @returns a search result indicating the next position of the search text, or null if there is no * match */ findText( searchPattern: string, from: DocumentApp.RangeElement ): DocumentApp.RangeElement /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
* TableCell at the specified cell index.
*
* @param cellIndex - the index of the cell to retrieve
*
* @returns the table cell
*/
getCell(
cellIndex: number
): DocumentApp.TableCell
/**
* Retrieves the child element at the specified child index.
*
*
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document.
* var 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.");
* }
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the number of cells in the row. * * @returns the number of cells */ getNumCells(): number /** * Retrieves the number of children. * *
* // Get the body section of the active document.
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Log the number of elements in the document.
* Logger.log("There are " + body.getNumChildren() +
* " elements in the document body.");
* The parent element contains the current element.
*
* @returns the parent element
*/
getParent(): DocumentApp.ContainerElement
/**
* Retrieves the Table containing the current row.
*
* @returns the table containing the current row
*/
getParentTable(): DocumentApp.Table
/**
* Retrieves the element's previous sibling element.
*
*
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the contents of the element as a text string.
*
* @returns the contents of the element as text string
*/
getText(): string
/**
* Gets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
* @returns 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
*/
getTextAlignment(): DocumentApp.TextAlignment
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* TableCell at the specified index.
*
* @param childIndex - the index at which to insert the element
*
* @returns the new table cell
*/
insertTableCell(
childIndex: number
): DocumentApp.TableCell
/**
* Inserts the given TableCell at the specified index.
*
* @param childIndex - the index at which to insert the element
* @param tableCell - the table cell to insert
*
* @returns the inserted table cell
*/
insertTableCell(
childIndex: number,
tableCell: DocumentApp.TableCell
): DocumentApp.TableCell
/**
* Inserts the given TableCell at the specified index, containing the given text.
*
* @param childIndex - the index at which to insert the element
* @param textContents - the cell's text contents
*
* @returns the inserted table cell
*/
insertTableCell(
childIndex: number,
textContents: string
): DocumentApp.TableCell
/**
* Determines whether the element is at the end of the Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Merges the element with the preceding sibling of the same type.
*
* Only elements of the same ElementType may 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append two paragraphs to the document.
* var par1 = body.appendParagraph('Paragraph 1.');
* var par2 = body.appendParagraph('Paragraph 2.');
*
* // Merge the newly added paragraphs into a single paragraph.
* par2.merge();
* TableCell at the specified cell index.
*
* @param cellIndex - the index of the cell to remove
*
* @returns the removed cell
*/
removeCell(
cellIndex: number
): DocumentApp.TableCell
/**
* Removes the specified child element.
*
* @param child - the child element to remove
*
* @returns the current element
*/
removeChild(
child: DocumentApp.Element
): DocumentApp.TableRow
/**
* Removes the element from its parent.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Clear the text surrounding "Apps Script", with or without text.
* body.replaceText("^.*Apps ?Script.*$", "Apps Script");
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
*
* // Make the entire first paragraph be superscript.
* var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
* text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
* Any child elements present in the element are also copied. The new element will not have a
* parent.
*
* @returns the new copy
*/
copy(): DocumentApp.Text
/**
* Deletes a range of text.
*
* @param startOffset - the character offset of the first character to delete
* @param endOffsetInclusive - the character offset of the last character to delete
*
* @returns the current element
*/
deleteText(
startOffset: number,
endOffsetInclusive: number
): DocumentApp.Text
/**
* 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. * *
* var body = DocumentApp.getActiveDocument().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);
* 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. * * @param searchPattern - the pattern to search for * * @returns a search result indicating the position of the search text, or null if there is no * match */ findText( searchPattern: string ): DocumentApp.RangeElement /** * 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. * * @param searchPattern - the pattern to search for * @param from - the search result to search from * * @returns a search result indicating the next position of the search text, or null if there is no * match */ findText( searchPattern: string, from: DocumentApp.RangeElement ): DocumentApp.RangeElement /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
* The result is an object containing a property for each valid text attribute where each
* property name corresponds to an item in the DocumentApp.Attribute enumeration.
*
* @param offset - the character offset
*
* @returns the element's attributes
*/
getAttributes(
offset: number
): object
/**
* Retrieves the background color setting.
*
* @returns the background color, formatted in CSS notation (like '#ffffff'), or null
* if the element contains multiple values for this attribute
*/
getBackgroundColor(): string
/**
* Retrieves the background color at the specified character offset.
*
* @param offset - the character offset
*
* @returns the background color, formatted in CSS notation (like '#ffffff')
*/
getBackgroundColor(
offset: number
): string
/**
* Retrieves the font family setting. The name can be any font from the Font menu in Docs or Google Fonts, and is case-sensitive. The methods getFontFamily() and setFontFamily(fontFamilyName) now use string names for fonts instead of
* the FontFamilygetFontFamily() and setFontFamily(fontFamilyName)
* now use string names for fonts instead of the FontFamily'#ffffff'), or null
* if the element contains multiple values for this attribute
*/
getForegroundColor(): string
/**
* Retrieves the foreground color at the specified character offset.
*
* @param offset - the character offset
*
* @returns the foreground color, formatted in CSS notation (like '#ffffff')
*/
getForegroundColor(
offset: number
): string
/**
* Retrieves the link url.
*
* @returns the link url, or null if the element contains multiple values for this attribute
*/
getLinkUrl(): string
/**
* Retrieves the link url at the specified character offset.
*
* @param offset - the character offset
*
* @returns the link url
*/
getLinkUrl(
offset: number
): string
/**
* Retrieves the element's next sibling element.
*
*
The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the element's parent element. * *
The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the contents of the element as a text string.
*
* @returns the contents of the element as text string
*/
getText(): string
/**
* Gets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
* @returns 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
*/
getTextAlignment(): DocumentApp.TextAlignment
/**
* Gets the text alignment for a single character. The available types of alignment are DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and DocumentApp.TextAlignment.SUPERSCRIPT.
*
* @param offset - the offset of the character
*
* @returns the type of text alignment, or null if the text alignment has never been set
*/
getTextAlignment(
offset: number
): DocumentApp.TextAlignment
/**
* Retrieves the set of text indices that correspond to the start of distinct text formatting
* runs.
*
* @returns the set of text indices at which text formatting changes
*/
getTextAttributeIndices(): number[]
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Retrieves the bold setting.
*
* @returns whether the text is bold, or null if the element contains multiple values for this
* attribute
*/
isBold(): Boolean
/**
* Retrieves the bold setting at the specified character offset.
*
* @param offset - the character offset
*
* @returns the bold setting
*/
isBold(
offset: number
): Boolean
/**
* Retrieves the italic setting.
*
* @returns whether the text is italic, or null if the element contains multiple values for this
* attribute
*/
isItalic(): Boolean
/**
* Retrieves the italic setting at the specified character offset.
*
* @param offset - the character offset
*
* @returns the italic setting
*/
isItalic(
offset: number
): Boolean
/**
* Retrieves the strikethrough setting.
*
* @returns whether the text is strikethrough, or null if the element contains multiple values for
* this attribute
*/
isStrikethrough(): Boolean
/**
* Retrieves the strikethrough setting at the specified character offset.
*
* @param offset - the character offset
*
* @returns the strikethrough setting
*/
isStrikethrough(
offset: number
): Boolean
/**
* Retrieves the underline setting.
*
* @returns whether the text is underlined, or null if the element contains multiple values for
* this attribute
*/
isUnderline(): Boolean
/**
* Retrieves the underline setting at the specified character offset.
*
* @param offset - the character offset
*
* @returns the underline setting
*/
isUnderline(
offset: number
): Boolean
/**
* Merges the element with the preceding sibling of the same type.
*
* Only elements of the same ElementType may 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append two paragraphs to the document.
* var par1 = body.appendParagraph('Paragraph 1.');
* var par2 = body.appendParagraph('Paragraph 2.');
*
* // Merge the newly added paragraphs into a single paragraph.
* par2.merge();
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Clear the text surrounding "Apps Script", with or without text.
* body.replaceText("^.*Apps ?Script.*$", "Apps Script");
* 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.
*
* @param startOffset - the text range's start offset
* @param endOffsetInclusive - the text range's end offset
* @param attributes - the element's attributes
*
* @returns the current element
*/
setAttributes(
startOffset: number,
endOffsetInclusive: number,
attributes: object
): DocumentApp.Text
/**
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
* '#ffffff')
*
* @returns the current element
*/
setBackgroundColor(
startOffset: number,
endOffsetInclusive: number,
color: string
): DocumentApp.Text
/**
* Sets the background color.
*
* @param color - the background color, formatted in CSS notation (like '#ffffff')
*
* @returns the current element
*/
setBackgroundColor(
color: string
): DocumentApp.Text
/**
* Sets the bold setting.
*
* @param bold - the bold setting
*
* @returns the current element
*/
setBold(
bold: Boolean
): DocumentApp.Text
/**
* Sets the bold setting for the specified character range.
*
* @param startOffset - the text range's start offset
* @param endOffsetInclusive - the text range's end offset
* @param bold - the bold setting
*
* @returns the current element
*/
setBold(
startOffset: number,
endOffsetInclusive: number,
bold: Boolean
): DocumentApp.Text
/**
* Sets the font family for the specified character range. The name can be any font from the Font
* menu in Docs or Google Fonts, and is case-sensitive.
* Unrecognized font names will render as Arial. The methods getFontFamily(offset) and
* setFontFamily(fontFamilyName) now use string names for fonts instead of the FontFamilygetFontFamily() and setFontFamily(fontFamilyName) now use string names for fonts instead of the FontFamily'#ffffff')
*
* @returns the current element
*/
setForegroundColor(
startOffset: number,
endOffsetInclusive: number,
color: string
): DocumentApp.Text
/**
* Sets the foreground color.
*
* @param color - the foreground color, formatted in CSS notation (like '#ffffff')
*
* @returns the current element
*/
setForegroundColor(
color: string
): DocumentApp.Text
/**
* Sets the italic setting.
*
* @param italic - the italic setting
*
* @returns the current element
*/
setItalic(
italic: Boolean
): DocumentApp.Text
/**
* Sets the italic setting for the specified character range.
*
* @param startOffset - the text range's start offset
* @param endOffsetInclusive - the text range's end offset
* @param italic - the italic setting
*
* @returns the current element
*/
setItalic(
startOffset: number,
endOffsetInclusive: number,
italic: Boolean
): DocumentApp.Text
/**
* Sets the link url for the specified character range.
*
* @param startOffset - the text range's start offset
* @param endOffsetInclusive - the text range's end offset
* @param url - the link url
*
* @returns the current element
*/
setLinkUrl(
startOffset: number,
endOffsetInclusive: number,
url: string
): DocumentApp.Text
/**
* Sets the link url.
*
* @param url - the link url
*
* @returns the current element
*/
setLinkUrl(
url: string
): DocumentApp.Text
/**
* Sets the strikethrough setting.
*
* @param strikethrough - the strikethrough setting
*
* @returns the current element
*/
setStrikethrough(
strikethrough: Boolean
): DocumentApp.Text
/**
* Sets the strikethrough setting for the specified character range.
*
* @param startOffset - the text range's start offset
* @param endOffsetInclusive - the text range's end offset
* @param strikethrough - the strikethrough setting
*
* @returns the current element
*/
setStrikethrough(
startOffset: number,
endOffsetInclusive: number,
strikethrough: Boolean
): DocumentApp.Text
/**
* Sets the text contents.
*
* @param text - the new text contents
*
* @returns the current element
*/
setText(
text: string
): DocumentApp.Text
/**
* 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 be superscript.
* var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
* text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
* DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, and
* DocumentApp.TextAlignment.SUPERSCRIPT.
*
*
* // Make the first character in the first paragraph be superscript.
* var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
* text.setTextAlignment(0, 0, DocumentApp.TextAlignment.SUPERSCRIPT);
* Any child elements present in the element are also copied. The new element will not have a * parent. * * @returns the new copy */ copy(): DocumentApp.UnsupportedElement /** * 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append a styled paragraph.
* var par = body.appendParagraph('A bold, italicized paragraph.');
* par.setBold(true);
* par.setItalic(true);
*
* // Retrieve the paragraph's attributes.
* var atts = par.getAttributes();
*
* // Log the paragraph attributes.
* for (var att in atts) {
* Logger.log(att + ":" + atts[att]);
* }
* The next sibling has the same parent and follows the current element. * * @returns the next sibling element */ getNextSibling(): DocumentApp.Element /** * Retrieves the element's parent element. * *
The parent element contains the current element. * * @returns the parent element */ getParent(): DocumentApp.ContainerElement /** * Retrieves the element's previous sibling element. * *
The previous sibling has the same parent and precedes the current element.
*
* @returns the previous sibling element
*/
getPreviousSibling(): DocumentApp.Element
/**
* Retrieves the element's ElementType.
*
*
Use getType() to determine the exact type of a given element.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Obtain the first element in the document body.
*
* var 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.');
* }
* Document.
*
* @returns whether the element is at the end of the document
*/
isAtDocumentEnd(): Boolean
/**
* Merges the element with the preceding sibling of the same type.
*
* Only elements of the same ElementType may 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. * *
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Append two paragraphs to the document.
* var par1 = body.appendParagraph('Paragraph 1.');
* var par2 = body.appendParagraph('Paragraph 2.');
*
* // Merge the newly added paragraphs into a single paragraph.
* par2.merge();
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Remove all images in the document body.
* var imgs = body.getImages();
* for (var i = 0; i < imgs.length; i++) {
* imgs[i].removeFromParent();
* }
* 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.
*
*
* var body = DocumentApp.getActiveDocument().getBody();
*
* // Define a custom paragraph style.
* var 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.
* var par = body.appendParagraph('A paragraph with custom style.');
*
* // Apply the custom style.
* par.setAttributes(style);
*