Stay organized with collections Save and categorize content based on your preferences.
ListItemAn element representing a list item. A ListItem
is a Paragraph
that is associated with a list ID. A ListItem
may contain Equation
, Footnote
, HorizontalRule
, InlineDrawing
, InlineImage
, PageBreak
, and Text
elements. For more information on document structure, see the guide to extending Google Docs.
ListItems
may not contain new-line characters. New-line characters ("\n") are converted to line-break characters ("\r").
ListItems
with the same list ID belong to the same list and are numbered accordingly. The ListItems
for a given list are not required to be adjacent in the tab or even have the same parent element. Two items belonging to the same list may exist anywhere in the tab while maintaining consecutive numbering, as the following example illustrates:
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a new list item to the body. const item1 = body.appendListItem('Item 1'); // Log the new list item's list ID. Logger.log(item1.getListId()); // Append a table after the list item. body.appendTable([['Cell 1', 'Cell 2']]); // Append a second list item with the same list ID. The two items are treated as // the same list, despite not being consecutive. const item2 = body.appendListItem('Item 2'); item2.setListId(item1);Methods Method Return type Brief description
addPositionedImage(image)
PositionedImage
Creates and inserts a new PositionedImage
from the specified image blob. appendHorizontalRule()
HorizontalRule
Creates and appends a new HorizontalRule
. appendInlineImage(image)
InlineImage
Creates and appends a new InlineImage
from the specified image blob. appendInlineImage(image)
InlineImage
Appends the given InlineImage
. appendPageBreak()
PageBreak
Creates and appends a new PageBreak
. appendPageBreak(pageBreak)
PageBreak
Appends the given PageBreak
. appendText(text)
Text
Creates and appends a new Text
element with the specified contents. appendText(text)
Text
Appends the given Text
element. clear()
ListItem
Clears the contents of the element. copy()
ListItem
Returns a detached, deep copy of the current element. editAsText()
Text
Obtains a Text
version of the current element, for editing. findElement(elementType)
RangeElement
Searches the contents of the element for a descendant of the specified type. findElement(elementType, from)
RangeElement
Searches the contents of the element for a descendant of the specified type, starting from the specified RangeElement
. findText(searchPattern)
RangeElement
Searches the contents of the element for the specified text pattern using regular expressions. findText(searchPattern, from)
RangeElement
Searches the contents of the element for the specified text pattern, starting from a given search result. getAlignment()
HorizontalAlignment
Retrieves the HorizontalAlignment
. getAttributes()
Object
Retrieves the element's attributes. getChild(childIndex)
Element
Retrieves the child element at the specified child index. getChildIndex(child)
Integer
Retrieves the child index for the specified child element. getGlyphType()
GlyphType
Retrieves the list item's GlyphType
. getHeading()
ParagraphHeading
Retrieves the ParagraphHeading
. getIndentEnd()
Number
Retrieves the end indentation, in points. getIndentFirstLine()
Number
Retrieves the first line indentation, in points. getIndentStart()
Number
Retrieves the start indentation. getLineSpacing()
Number
Retrieves the line spacing, in points. getLinkUrl()
String
Retrieves the link url. getListId()
String
Retrieves the list ID. getNestingLevel()
Integer
Retrieves the list item's nesting level. getNextSibling()
Element
Retrieves the element's next sibling element. getNumChildren()
Integer
Retrieves the number of children. getParent()
ContainerElement
Retrieves the element's parent element. getPositionedImage(id)
PositionedImage
Gets a PositionedImage
by the image's ID. getPositionedImages()
PositionedImage[]
Gets all PositionedImage
objects anchored to the paragraph. getPreviousSibling()
Element
Retrieves the element's previous sibling element. getSpacingAfter()
Number
Retrieves the spacing after the element, in points. getSpacingBefore()
Number
Retrieves the spacing before the element, in points. getText()
String
Retrieves the contents of the element as a text string. getTextAlignment()
TextAlignment
Gets the text alignment. getType()
ElementType
Retrieves the element's ElementType
. insertHorizontalRule(childIndex)
HorizontalRule
Creates and inserts a HorizontalRule
at the specified index. insertInlineImage(childIndex, image)
InlineImage
Creates and inserts a new InlineImage
from the specified image blob, at the specified index. insertInlineImage(childIndex, image)
InlineImage
Inserts the given InlineImage
at the specified index. insertPageBreak(childIndex)
PageBreak
Creates and inserts a new PageBreak
at the specified index. insertPageBreak(childIndex, pageBreak)
PageBreak
Inserts the given PageBreak
at the specified index. insertText(childIndex, text)
Text
Creates and inserts a new text element at the specified index. insertText(childIndex, text)
Text
Inserts the given Text
element at the specified index, with the specified text contents. isAtDocumentEnd()
Boolean
Determines whether the element is at the end of the Document
. isLeftToRight()
Boolean
Retrieves the left-to-right setting. merge()
ListItem
Merges the element with the preceding sibling of the same type. removeChild(child)
ListItem
Removes the specified child element. removeFromParent()
ListItem
Removes the element from its parent. removePositionedImage(id)
Boolean
Removes a PositionedImage
by the image's ID. replaceText(searchPattern, replacement)
Element
Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions. setAlignment(alignment)
ListItem
Sets the HorizontalAlignment
. setAttributes(attributes)
ListItem
Sets the element's attributes. setGlyphType(glyphType)
ListItem
Sets the list item's GlyphType
. setHeading(heading)
ListItem
Sets the ParagraphHeading
. setIndentEnd(indentEnd)
ListItem
Sets the end indentation, in points. setIndentFirstLine(indentFirstLine)
ListItem
Sets the first line indentation, in points. setIndentStart(indentStart)
ListItem
Sets the start indentation, in points. setLeftToRight(leftToRight)
ListItem
Sets the left-to-right setting. setLineSpacing(multiplier)
ListItem
Sets the line spacing, as a quantity indicating the number of lines to use for spacing. setLinkUrl(url)
ListItem
Sets the link url. setListId(listItem)
ListItem
Sets the list ID. setNestingLevel(nestingLevel)
ListItem
Sets the list item's nesting level. setSpacingAfter(spacingAfter)
ListItem
Sets the spacing after the element, in points. setSpacingBefore(spacingBefore)
ListItem
Sets the spacing before the element, in points. setText(text)
void
Sets the contents of the list item as text. setTextAlignment(textAlignment)
ListItem
Sets the text alignment. Detailed documentation addPositionedImage(image)
Creates and inserts a new PositionedImage
from the specified image blob.
image
BlobSource
the image data Return
PositionedImage
— the new positioned image
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
appendHorizontalRule()
Creates and appends a new HorizontalRule
.
HorizontalRule
— the new horizontal rule
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
appendInlineImage(image)
Creates and appends a new InlineImage
from the specified image blob.
image
BlobSource
the image data Return
InlineImage
— the appended image
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
appendInlineImage(image)
Appends the given InlineImage
.
InlineImage
— the appended image
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
appendPageBreak()
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.
PageBreak
— the new page break element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
appendPageBreak(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.
pageBreak
PageBreak
the page break to append Return
PageBreak
— the appended page break element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
appendText(text)
Creates and appends a new Text
element with the specified contents.
text
String
the text contents Return
Text
— the new text element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
appendText(text)
Appends the given Text
element.
text
Text
the text element to append Return
Text
— the appended text element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
clear()
Clears the contents of the element.
ReturnListItem
— The current element.
copy()
Returns a detached, deep copy of the current element.
Any child elements present in the element are also copied. The new element doesn't have a parent.
ReturnListItem
— The new copy.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
editAsText()
Obtains a Text
version of the current element, for editing.
Use editAsText
for manipulating the elements contents as rich text. The editAsText
mode ignores non-text elements (such as InlineImage
and HorizontalRule
).
Child elements fully contained within a deleted text range are removed from the element.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, 'An editAsText sample.'); body.insertHorizontalRule(0); body.insertParagraph(0, 'An example.'); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);Return
Text
— a text version of the current element
findElement(elementType)
Searches the contents of the element for a descendant of the specified type.
Parameters Name Type DescriptionelementType
ElementType
The type of element to search for. Return
RangeElement
— A search result indicating the position of the search element.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
findElement(elementType, from)
Searches the contents of the element for a descendant of the specified type, starting from the specified RangeElement
.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. let searchResult = null; // Search until the paragraph is found. while ( (searchResult = body.findElement( DocumentApp.ElementType.PARAGRAPH, searchResult, ))) { const par = searchResult.getElement().asParagraph(); if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) { // Found one, update and stop. par.setText('This is the first header.'); break; } }Parameters Name Type Description
elementType
ElementType
The type of element to search for. from
RangeElement
The search result to search from. Return
RangeElement
— A search result indicating the next position of the search element.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
findText(searchPattern)
Searches the contents of the element for the specified text pattern using regular expressions.
A subset of the JavaScript regular expression features are not fully supported, such as capture groups and mode modifiers.
The provided regular expression pattern is independently matched against each text block contained in the current element.
Parameters Name Type DescriptionsearchPattern
String
the pattern to search for Return
RangeElement
— a search result indicating the position of the search text, or null if there is no match
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
Searches the contents of the element for the specified text pattern, starting from a given search result.
A subset of the JavaScript regular expression features are not fully supported, such as capture groups and mode modifiers.
The provided regular expression pattern is independently matched against each text block contained in the current element.
Parameters Name Type DescriptionsearchPattern
String
the pattern to search for from
RangeElement
the search result to search from Return
RangeElement
— a search result indicating the next position of the search text, or null if there is no match
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getAlignment()
Retrieves the HorizontalAlignment
.
HorizontalAlignment
— the alignment
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getAttributes()
Retrieves the element's attributes.
The result is an object containing a property for each valid element attribute where each property name corresponds to an item in the DocumentApp.Attribute
enumeration.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. const atts = par.getAttributes(); // Log the paragraph attributes. for (const att in atts) { Logger.log(`${att}:${atts[att]}`); }Return
Object
— The element's attributes.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getChild(childIndex)
Retrieves the child element at the specified child index.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. const firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText('This is the first paragraph.'); }Parameters Name Type Description
childIndex
Integer
The index of the child element to retrieve. Return
Element
— The child element at the specified index.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getChildIndex(child)
Retrieves the child index for the specified child element.
Parameters Name Type Descriptionchild
Element
The child element for which to retrieve the index. Return
Integer
— The child index.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getGlyphType()
Retrieves the list item's GlyphType
.
GlyphType
— the glyph type
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getHeading()
Retrieves the ParagraphHeading
.
ParagraphHeading
— the heading
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getIndentEnd()
Retrieves the end indentation, in points.
ReturnNumber
— the end indentation, in points
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getIndentFirstLine()
Retrieves the first line indentation, in points.
ReturnNumber
— the first line indentation, in points
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getIndentStart()
Retrieves the start indentation.
ReturnNumber
— the start indentation
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getLineSpacing()
Retrieves the line spacing, in points.
ReturnNumber
— the line spacing, in points
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getLinkUrl()
Retrieves the link url.
ReturnString
— the link url, or null if the element contains multiple values for this attribute
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getListId()
Retrieves the list ID.
ReturnString
— the list ID
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getNestingLevel()
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.
ReturnInteger
— the nesting level
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getNextSibling()
Retrieves the element's next sibling element.
The next sibling has the same parent and follows the current element.
ReturnElement
— The next sibling element.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getNumChildren()
Retrieves the number of children.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Log the number of elements in the tab. Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);Return
Integer
— The number of children.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getParent()
Retrieves the element's parent element.
The parent element contains the current element.
ReturnContainerElement
— The parent element.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getPositionedImage(id)
Gets a PositionedImage
by the image's ID.
id
String
the image id Return
PositionedImage
— the positioned image
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getPositionedImages()
Gets all PositionedImage
objects anchored to the paragraph.
PositionedImage[]
— a list of positioned images
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getPreviousSibling()
Retrieves the element's previous sibling element.
The previous sibling has the same parent and precedes the current element.
ReturnElement
— The previous sibling element.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getSpacingAfter()
Retrieves the spacing after the element, in points.
ReturnNumber
— the spacing after the element, in points
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getSpacingBefore()
Retrieves the spacing before the element, in points.
ReturnNumber
— the spacing before the element, in points
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getText()
Retrieves the contents of the element as a text string.
ReturnString
— the contents of the element as text string
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getTextAlignment()
Gets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
, and DocumentApp.TextAlignment.SUPERSCRIPT
.
TextAlignment
— the type of text alignment, or null
if the text contains multiple types of text alignments or if the text alignment has never been set
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
getType()
Retrieves the element's ElementType
.
Use getType()
to determine the exact type of a given element.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Obtain the first element in the active tab's body. const firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }Return
ElementType
— The element type.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
insertHorizontalRule(childIndex)
Creates and inserts a HorizontalRule
at the specified index.
childIndex
Integer
the index at which to insert the element Return
HorizontalRule
— the new horizontal rule element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
insertInlineImage(childIndex, image)
Creates and inserts a new InlineImage
from the specified image blob, at the specified index.
childIndex
Integer
the index at which to insert the element image
BlobSource
the image data Return
InlineImage
— the inserted inline image element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
insertInlineImage(childIndex, image)
Inserts the given InlineImage
at the specified index.
childIndex
Integer
the index at which to insert the element image
InlineImage
the image data Return
InlineImage
— the inserted inline image element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex)
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.
childIndex
Integer
the index at which to insert the element Return
PageBreak
— the new page break element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex, 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.
childIndex
Integer
the index at which to insert the element pageBreak
PageBreak
the p[age break to insert Return
PageBreak
— the inserted page break element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
insertText(childIndex, text)
Creates and inserts a new text element at the specified index.
Parameters Name Type DescriptionchildIndex
Integer
the index at which to insert the element text
String
the text contents Return
Text
— the new text element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
insertText(childIndex, text)
Inserts the given Text
element at the specified index, with the specified text contents.
childIndex
Integer
the index at which to insert the element text
Text
the text element to insert Return
Text
— the inserted text element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
Determines whether the element is at the end of the Document
.
Boolean
— Whether the element is at the end of the tab.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
isLeftToRight()
Retrieves the left-to-right setting.
ReturnBoolean
— the left-to-right setting
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
merge()
Merges the element with the preceding sibling of the same type.
Only elements of the same ElementType
can be merged. Any child elements contained in the current element are moved to the preceding sibling element.
The current element is removed from the document.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. const par1 = body.appendParagraph('Paragraph 1.'); const par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. const cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'], ]; // Build a table from the array. const table = body.appendTable(cells); // Get the first row in the table. const row = table.getRow(0); // Get the two cells in this row. const cell1 = row.getCell(0); const cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. const merged = cell2.merge();Return
ListItem
— The merged element.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
removeChild(child)
Removes the specified child element.
Parameters Name Type Descriptionchild
Element
the child element to remove Return
ListItem
— the current element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
removeFromParent()
Removes the element from its parent.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Remove all images in the active tab's body. const imgs = body.getImages(); for (let i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }Return
ListItem
— The removed element.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
removePositionedImage(id)
Removes a PositionedImage
by the image's ID.
id
String
Return
Boolean
— whether or not the specified image was removed
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions.
The search pattern is passed as a string, not a JavaScript regular expression object. Because of this you'll need to escape any backslashes in the pattern.
This methods uses Google's RE2 regular expression library, which limits the supported syntax.
The provided regular expression pattern is independently matched against each text block contained in the current element.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.*Apps ?Script.*$', 'Apps Script');Parameters Name Type Description
searchPattern
String
the regex pattern to search for replacement
String
the text to use as replacement Return
Element
— the current element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
setAlignment(alignment)
Sets the HorizontalAlignment
.
ListItem
— the current element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
setAttributes(attributes)
Sets the element's attributes.
The specified attributes parameter must be an object where each property name is an item in the DocumentApp.Attribute
enumeration and each property value is the new value to be applied.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Define a custom paragraph style. const style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. const par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);Parameters Name Type Description
attributes
Object
The element's attributes. Return
ListItem
— The current element.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
setGlyphType(glyphType)
Sets the list item's GlyphType
.
glyphType
GlyphType
the glyph type Return
ListItem
— the current element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
setHeading(heading)
Sets the ParagraphHeading
.
ListItem
— the current element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
setIndentEnd(indentEnd)
Sets the end indentation, in points.
Parameters Name Type DescriptionindentEnd
Number
the end indentation, in points Return
ListItem
— the current element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
setIndentFirstLine(indentFirstLine)
Sets the first line indentation, in points.
Parameters Name Type DescriptionindentFirstLine
Number
the first line indentation, in points Return
ListItem
— the current element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
setIndentStart(indentStart)
Sets the start indentation, in points.
Parameters Name Type DescriptionindentStart
Number
the start indentation, in points Return
ListItem
— the current element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
setLeftToRight(leftToRight)
Sets the left-to-right setting.
Parameters Name Type DescriptionleftToRight
Boolean
the left-to-right setting Return
ListItem
— the current element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
setLineSpacing(multiplier)
Sets the line spacing, as a quantity indicating the number of lines to use for spacing.
Parameters Name Type Descriptionmultiplier
Number
the number of lines Return
ListItem
— the current element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
setLinkUrl(url)
Sets the link url.
Parameters Name Type Descriptionurl
String
the link url Return
ListItem
— the current element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
setListId(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.
listItem
ListItem
the list item whose list ID to use Return
ListItem
— the current element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
setNestingLevel(nestingLevel)
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.
Parameters Name Type DescriptionnestingLevel
Integer
the nesting level Return
ListItem
— the current element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
setSpacingAfter(spacingAfter)
Sets the spacing after the element, in points.
Parameters Name Type DescriptionspacingAfter
Number
the spacing after the element, in points Return
ListItem
— the current element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
setSpacingBefore(spacingBefore)
Sets the spacing before the element, in points.
Parameters Name Type DescriptionspacingBefore
Number
the spacing before the element, in points Return
ListItem
— the current element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
setText(text)
Sets the contents of the list item as text.
Note: existing contents are cleared.
Parameters Name Type Descriptiontext
String
the new text contents Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
setTextAlignment(textAlignment)
Sets the text alignment. The available types of alignment are DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
, and DocumentApp.TextAlignment.SUPERSCRIPT
.
// Make the entire first paragraph in the active tab be superscript. const documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); const text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);Parameters Name Type Description
textAlignment
TextAlignment
the type of text alignment to apply Return
ListItem
— the current element
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-03 UTC."],[[["A ListItem is a paragraph linked to a list ID, allowing for numbered or bulleted lists within a Google Doc."],["ListItems can hold various elements like text, images, equations, and support nested lists with formatting options."],["Key functionalities include appending, inserting, searching, modifying, and removing elements within a ListItem."],["`editAsText` mode ignores non-text elements, and PageBreaks cannot reside within TableCells."],["Numerous methods are provided to manipulate ListItem properties and content, like `appendText()`, `insertInlineImage()`, `setListId()`, etc."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4