Class TableCell  |  Apps Script  |  Google for Developers (original) (raw)

Methods

Method Return type Brief description
appendHorizontalRule() HorizontalRule Creates and appends a new HorizontalRule.
appendImage(image) InlineImage Creates and appends a new InlineImage from the specified image blob.
appendImage(image) InlineImage Appends the given InlineImage.
appendListItem(listItem) ListItem Appends the given ListItem.
appendListItem(text) ListItem Creates and appends a new ListItem.
appendParagraph(paragraph) Paragraph Appends the given Paragraph.
appendParagraph(text) Paragraph Creates and appends a new Paragraph.
appendTable() Table Creates and appends a new Table.
appendTable(cells) Table Appends a new Table containing the specified cells.
appendTable(table) Table Appends the given Table.
clear() TableCell Clears the contents of the element.
copy() TableCell Returns a detached, deep copy of the current element.
editAsText() Text Obtains a Text version of the current element, for editing.
findElement(elementType) RangeElement Searches the contents of the element for a descendant of the specified type.
findElement(elementType, from) RangeElement Searches the contents of the element for a descendant of the specified type, starting from the specified RangeElement.
findText(searchPattern) RangeElement Searches the contents of the element for the specified text pattern using regular expressions.
findText(searchPattern, from) RangeElement Searches the contents of the element for the specified text pattern, starting from a given search result.
getAttributes() Object Retrieves the element's attributes.
getBackgroundColor() String Retrieves the background color.
getChild(childIndex) Element Retrieves the child element at the specified child index.
getChildIndex(child) Integer Retrieves the child index for the specified child element.
getColSpan() Integer Retrieves the column span, which is the number of columns of table cells this cell spans.
getLinkUrl() String Retrieves the link url.
getNextSibling() Element Retrieves the element's next sibling element.
getNumChildren() Integer Retrieves the number of children.
getPaddingBottom() Number Retrieves the bottom padding, in points.
getPaddingLeft() Number Retrieves the left padding, in points.
getPaddingRight() Number Retrieves the right padding, in points.
getPaddingTop() Number Retrieves the top padding, in points.
getParent() ContainerElement Retrieves the element's parent element.
getParentRow() TableRow Retrieves the TableRow containing the current TableCell.
getParentTable() Table Retrieves the Table containing the current TableCell.
getPreviousSibling() Element Retrieves the element's previous sibling element.
getRowSpan() Integer Retrieves the row span, which is the number of rows of table cells this cell spans.
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.
getVerticalAlignment() VerticalAlignment Retrieves the VerticalAlignment.
getWidth() Number Retrieves the width of the column containing the cell, in points.
insertHorizontalRule(childIndex) HorizontalRule Creates and inserts a new HorizontalRule at the specified index.
insertImage(childIndex, image) InlineImage Creates and inserts an InlineImage from the specified image blob, at the specified index.
insertImage(childIndex, image) InlineImage Inserts the given InlineImage at the specified index.
insertListItem(childIndex, listItem) ListItem Inserts the given ListItem at the specified index.
insertListItem(childIndex, text) ListItem Creates and inserts a new ListItem at the specified index.
insertParagraph(childIndex, paragraph) Paragraph Inserts the given Paragraph at the specified index.
insertParagraph(childIndex, text) Paragraph Creates and inserts a new Paragraph at the specified index.
insertTable(childIndex) Table Creates and inserts a new Table at the specified index.
insertTable(childIndex, cells) Table Creates and inserts a new Table containing the specified cells, at the specified index.
insertTable(childIndex, table) Table Inserts the given Table at the specified index.
isAtDocumentEnd() Boolean Determines whether the element is at the end of the Document.
merge() TableCell Merges the element with the preceding sibling of the same type.
removeChild(child) TableCell Removes the specified child element.
removeFromParent() TableCell Removes the element from its parent.
replaceText(searchPattern, replacement) Element Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions.
setAttributes(attributes) TableCell Sets the element's attributes.
setBackgroundColor(color) TableCell Sets the background color.
setLinkUrl(url) TableCell Sets the link url.
setPaddingBottom(paddingBottom) TableCell Sets the bottom padding, in points.
setPaddingLeft(paddingLeft) TableCell Sets the left padding, in points.
setPaddingRight(paddingRight) TableCell Sets the right padding, in points.
setPaddingTop(paddingTop) TableCell Sets the top padding, in points.
setText(text) TableCell Sets the contents as plain text.
setTextAlignment(textAlignment) TableCell Sets the text alignment.
setVerticalAlignment(alignment) TableCell Sets the vertical alignment.
setWidth(width) TableCell Sets the width of the column containing the current cell, in points.

Detailed documentation

appendHorizontalRule()

Creates and appends a new [HorizontalRule](/apps-script/reference/document/horizontal-rule).

The [HorizontalRule](/apps-script/reference/document/horizontal-rule) will be contained in a new [Paragraph](/apps-script/reference/document/paragraph).

Return

[HorizontalRule](/apps-script/reference/document/horizontal-rule) — the new horizontal rule

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

appendImage(image)

Creates and appends a new [InlineImage](/apps-script/reference/document/inline-image) from the specified image blob.

The [InlineImage](/apps-script/reference/document/inline-image) will be contained in a new [Paragraph](/apps-script/reference/document/paragraph).

Parameters

Name Type Description
image BlobSource the image data

Return

[InlineImage](/apps-script/reference/document/inline-image) — the new image

Authorization

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

appendImage(image)

Appends the given [InlineImage](/apps-script/reference/document/inline-image).

The [InlineImage](/apps-script/reference/document/inline-image) will be contained in a new [Paragraph](/apps-script/reference/document/paragraph).

Parameters

Name Type Description
image InlineImage the image data

Return

[InlineImage](/apps-script/reference/document/inline-image) — the appended image

Authorization

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

appendListItem(listItem)

Appends the given [ListItem](/apps-script/reference/document/list-item).

Parameters

Name Type Description
listItem ListItem the list item to append

Return

[ListItem](/apps-script/reference/document/list-item) — the appended list item

Authorization

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

appendListItem(text)

Creates and appends a new [ListItem](/apps-script/reference/document/list-item).

Parameters

Name Type Description
text String the text contents

Return

[ListItem](/apps-script/reference/document/list-item) — the new list item

Authorization

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

appendParagraph(paragraph)

Appends the given [Paragraph](/apps-script/reference/document/paragraph).

Parameters

Name Type Description
paragraph Paragraph the paragraph to append

Return

[Paragraph](/apps-script/reference/document/paragraph) — the appended paragraph

Authorization

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

appendParagraph(text)

Creates and appends a new [Paragraph](/apps-script/reference/document/paragraph).

Parameters

Name Type Description
text String the text contents

Return

[Paragraph](/apps-script/reference/document/paragraph) — the new paragraph

Authorization

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

appendTable()

Creates and appends a new [Table](/apps-script/reference/document/table).

Return

[Table](/apps-script/reference/document/table) — the new table

Authorization

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

appendTable(cells)

Appends a new [Table](/apps-script/reference/document/table) containing the specified cells.

Parameters

Name Type Description
cells String[][] the text contents of the table cells to add to the new table

Return

[Table](/apps-script/reference/document/table) — the appended table

Authorization

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

appendTable(table)

Appends the given [Table](/apps-script/reference/document/table).

Parameters

Name Type Description
table Table the table to append

Return

[Table](/apps-script/reference/document/table) — the appended table

Authorization

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

clear()

Clears the contents of the element.

Return

[TableCell](#) — The current element.

copy()

Returns a detached, deep copy of the current element.

Any child elements present in the element are also copied. The new element doesn't have a parent.

Return

[TableCell](#) — The new copy.

Authorization

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

editAsText()

Obtains a [Text](/apps-script/reference/document/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](/apps-script/reference/document/inline-image) and [HorizontalRule](/apps-script/reference/document/horizontal-rule)).

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](/apps-script/reference/document/text) — a text version of the current element

findElement(elementType)

Searches the contents of the element for a descendant of the specified type.

Parameters

Name Type Description
elementType ElementType The type of element to search for.

Return

[RangeElement](/apps-script/reference/document/range-element) — A search result indicating the position of the search element.

Authorization

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

findElement(elementType, from)

Searches the contents of the element for a descendant of the specified type, starting from the specified [RangeElement](/apps-script/reference/document/range-element).

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](/apps-script/reference/document/range-element) — A search result indicating the next position of the search element.

Authorization

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

findText(searchPattern)

Searches the contents of the element for the specified text pattern using regular expressions.

A subset of the JavaScript regular expression features are not fully supported, such as capture groups and mode modifiers.

The provided regular expression pattern is independently matched against each text block contained in the current element.

Parameters

Name Type Description
searchPattern String the pattern to search for

Return

[RangeElement](/apps-script/reference/document/range-element) — a search result indicating the position of the search text, or null if there is no match

Authorization

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

findText(searchPattern, from)

Searches the contents of the element for the specified text pattern, starting from a given search result.

A subset of the JavaScript regular expression features are not fully supported, such as capture groups and mode modifiers.

The provided regular expression pattern is independently matched against each text block contained in the current element.

Parameters

Name Type Description
searchPattern String the pattern to search for
from RangeElement the search result to search from

Return

[RangeElement](/apps-script/reference/document/range-element) — a search result indicating the next position of the search text, or null if there is no match

Authorization

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

getAttributes()

Retrieves the element's attributes.

The result is an object containing a property for each valid element attribute where each property name corresponds to an item in the DocumentApp.Attribute enumeration.

const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody();

// Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true);

// Retrieve the paragraph's attributes. const atts = par.getAttributes();

// Log the paragraph attributes. for (const att in atts) { Logger.log(${att}:${atts[att]}); }

Return

Object — The element's attributes.

Authorization

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

getBackgroundColor()

Retrieves the background color.

Return

String — the background color, formatted in CSS notation (like '#ffffff')

Authorization

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

getChild(childIndex)

Retrieves the child element at the specified child index.

const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab. const firstChild = body.getChild(0);

// If it's a paragraph, set its contents. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText('This is the first paragraph.'); }

Parameters

Name Type Description
childIndex Integer The index of the child element to retrieve.

Return

[Element](/apps-script/reference/document/element) — The child element at the specified index.

Authorization

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

getChildIndex(child)

Retrieves the child index for the specified child element.

Parameters

Name Type Description
child Element The child element for which to retrieve the index.

Return

Integer — The child index.

Authorization

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

getColSpan()

Retrieves the column span, which is the number of columns of table cells this cell spans. Non-merged cells have a col span of 1.

Return

Integer — the column span or 0 for a cell which is merged over by another cell

Authorization

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

getLinkUrl()

Retrieves the link url.

Return

String — the link url, or null if the element contains multiple values for this attribute

Authorization

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

getNextSibling()

Retrieves the element's next sibling element.

The next sibling has the same parent and follows the current element.

Return

[Element](/apps-script/reference/document/element) — The next sibling element.

Authorization

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

getNumChildren()

Retrieves the number of children.

const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Log the number of elements in the tab. Logger.log(There are ${body.getNumChildren()} elements in the tab's body.);

Return

Integer — The number of children.

Authorization

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

getPaddingBottom()

Retrieves the bottom padding, in points.

Return

Number — the bottom padding, in points

Authorization

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

getPaddingLeft()

Retrieves the left padding, in points.

Return

Number — the left padding, in points

Authorization

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

getPaddingRight()

Retrieves the right padding, in points.

Return

Number — the right padding, in points

Authorization

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

getPaddingTop()

Retrieves the top padding, in points.

Return

Number — the top padding, in points

Authorization

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

getParent()

Retrieves the element's parent element.

The parent element contains the current element.

Return

[ContainerElement](/apps-script/reference/document/container-element) — The parent element.

Authorization

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

getParentRow()

Retrieves the [TableRow](/apps-script/reference/document/table-row) containing the current [TableCell](#).

Return

[TableRow](/apps-script/reference/document/table-row) — the table row containing the current cell

Authorization

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

getParentTable()

Retrieves the [Table](/apps-script/reference/document/table) containing the current [TableCell](#).

Return

[Table](/apps-script/reference/document/table) — the table containing the current cell

Authorization

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

getPreviousSibling()

Retrieves the element's previous sibling element.

The previous sibling has the same parent and precedes the current element.

Return

[Element](/apps-script/reference/document/element) — The previous sibling element.

Authorization

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

getRowSpan()

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.

Return

Integer — the row span or 0 for a cell which is merged over by another cell

Authorization

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

getText()

Retrieves the contents of the element as a text string.

Return

String — the contents of the element as text string

Authorization

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

getTextAlignment()

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

Return

[TextAlignment](/apps-script/reference/document/text-alignment) — the type of text alignment, or null if the text contains multiple types of text alignments or if the text alignment has never been set

Authorization

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

getType()

Retrieves the element's [ElementType](/apps-script/reference/document/element-type).

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](/apps-script/reference/document/element-type) — The element type.

Authorization

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

getVerticalAlignment()

Retrieves the [VerticalAlignment](/apps-script/reference/document/vertical-alignment).

Return

[VerticalAlignment](/apps-script/reference/document/vertical-alignment) — the vertical alignment

Authorization

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

getWidth()

Retrieves the width of the column containing the cell, in points.

Return

Number — the column width, in points

Authorization

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

insertHorizontalRule(childIndex)

Creates and inserts a new [HorizontalRule](/apps-script/reference/document/horizontal-rule) at the specified index.

The horizontal rule will be contained in a new [Paragraph](/apps-script/reference/document/paragraph).

Parameters

Name Type Description
childIndex Integer the index at which to insert the element

Return

[HorizontalRule](/apps-script/reference/document/horizontal-rule) — the new horizontal rule

Authorization

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

insertImage(childIndex, image)

Creates and inserts an [InlineImage](/apps-script/reference/document/inline-image) from the specified image blob, at the specified index.

The image will be contained in a new [Paragraph](/apps-script/reference/document/paragraph).

Parameters

Name Type Description
childIndex Integer the index at which to insert the element
image BlobSource the image data

Return

[InlineImage](/apps-script/reference/document/inline-image) — the inserted inline image

Authorization

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

insertImage(childIndex, image)

Inserts the given [InlineImage](/apps-script/reference/document/inline-image) at the specified index.

The image will be contained in a new [Paragraph](/apps-script/reference/document/paragraph).

Parameters

Name Type Description
childIndex Integer the index at which to insert the element
image InlineImage the image to insert

Return

[InlineImage](/apps-script/reference/document/inline-image) — the inserted inline image

Authorization

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

insertListItem(childIndex, listItem)

Inserts the given [ListItem](/apps-script/reference/document/list-item) at the specified index.

Parameters

Name Type Description
childIndex Integer the index at which to insert the element
listItem ListItem the list item to insert

Return

[ListItem](/apps-script/reference/document/list-item) — inserted new list item

Authorization

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

insertListItem(childIndex, text)

Creates and inserts a new [ListItem](/apps-script/reference/document/list-item) at the specified index.

Parameters

Name Type Description
childIndex Integer the index at which to insert the element
text String the text contents

Return

[ListItem](/apps-script/reference/document/list-item) — the new list item

Authorization

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

insertParagraph(childIndex, paragraph)

Inserts the given [Paragraph](/apps-script/reference/document/paragraph) at the specified index.

Parameters

Name Type Description
childIndex Integer the index at which to insert the element
paragraph Paragraph the paragraph to insert

Return

[Paragraph](/apps-script/reference/document/paragraph) — the inserted paragraph

Authorization

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

insertParagraph(childIndex, text)

Creates and inserts a new [Paragraph](/apps-script/reference/document/paragraph) at the specified index.

Parameters

Name Type Description
childIndex Integer the index at which to insert the element
text String the text contents

Return

[Paragraph](/apps-script/reference/document/paragraph) — the new paragraph

Authorization

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

insertTable(childIndex)

Creates and inserts a new [Table](/apps-script/reference/document/table) at the specified index.

Parameters

Name Type Description
childIndex Integer the index at which to insert the element

Return

[Table](/apps-script/reference/document/table) — the new table

Authorization

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

insertTable(childIndex, cells)

Creates and inserts a new [Table](/apps-script/reference/document/table) containing the specified cells, at the specified index.

Parameters

Name Type Description
childIndex Integer the index at which to insert
cells String[][] the text contents of the table cells to add to the new table

Return

[Table](/apps-script/reference/document/table) — the new table

Authorization

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

insertTable(childIndex, table)

Inserts the given [Table](/apps-script/reference/document/table) at the specified index.

Parameters

Name Type Description
childIndex Integer the index at which to insert the element
table Table the table to insert

Return

[Table](/apps-script/reference/document/table) — the inserted table

Authorization

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

isAtDocumentEnd()

Determines whether the element is at the end of the [Document](/apps-script/reference/document/document).

Return

Boolean — Whether the element is at the end of the tab.

Authorization

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

merge()

Merges the element with the preceding sibling of the same type.

Only elements of the same [ElementType](/apps-script/reference/document/element-type) 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

[TableCell](#) — The merged element.

Authorization

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

removeChild(child)

Removes the specified child element.

Parameters

Name Type Description
child Element the child element to remove

Return

[TableCell](#) — the current element

Authorization

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

removeFromParent()

Removes the element from its parent.

const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody();

// Remove all images in the active tab's body. const imgs = body.getImages(); for (let i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }

Return

[TableCell](#) — The removed element.

Authorization

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

replaceText(searchPattern, replacement)

Replaces all occurrences of a given text pattern with a given replacement string, using regular expressions.

The search pattern is passed as a string, not a JavaScript regular expression object. Because of this you'll need to escape any backslashes in the pattern.

This methods uses Google's RE2 regular expression library, which limits the supported syntax.

The provided regular expression pattern is independently matched against each text block contained in the current element.

const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.Apps ?Script.$', 'Apps Script');

Parameters

Name Type Description
searchPattern String the regex pattern to search for
replacement String the text to use as replacement

Return

[Element](/apps-script/reference/document/element) — the current element

Authorization

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

setAttributes(attributes)

Sets the element's attributes.

The specified attributes parameter must be an object where each property name is an item in the DocumentApp.Attribute enumeration and each property value is the new value to be applied.

const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody();

// Define a custom paragraph style. const style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph. const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style. par.setAttributes(style);

Parameters

Name Type Description
attributes Object The element's attributes.

Return

[TableCell](#) — The current element.

Authorization

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

setBackgroundColor(color)

Sets the background color.

Parameters

Name Type Description
color String the background color, formatted in CSS notation (like '#ffffff')

Return

[TableCell](#) — the current element

Authorization

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

setLinkUrl(url)

Sets the link url.

Parameters

Name Type Description
url String the link url

Return

[TableCell](#) — the current element

Authorization

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

setPaddingBottom(paddingBottom)

Sets the bottom padding, in points.

Parameters

Name Type Description
paddingBottom Number the bottom padding, in points

Return

[TableCell](#) — the current element

Authorization

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

setPaddingLeft(paddingLeft)

Sets the left padding, in points.

Parameters

Name Type Description
paddingLeft Number the left padding, in points

Return

[TableCell](#) — the current element

Authorization

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

setPaddingRight(paddingRight)

Sets the right padding, in points.

Parameters

Name Type Description
paddingRight Number The right padding, in points.

Return

[TableCell](#) — The current element.

Authorization

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

setPaddingTop(paddingTop)

Sets the top padding, in points.

Parameters

Name Type Description
paddingTop Number the top padding, in points

Return

[TableCell](#) — the current element

Authorization

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

setText(text)

Sets the contents as plain text.

Note: existing contents are cleared.

Parameters

Name Type Description
text String the new text contents

Return

[TableCell](#) — the current element

Authorization

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

setTextAlignment(textAlignment)

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

// Make the entire first paragraph in the active tab be superscript. const documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); const text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parameters

Name Type Description
textAlignment TextAlignment the type of text alignment to apply

Return

[TableCell](#) — the current element

Authorization

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

setVerticalAlignment(alignment)

Sets the vertical alignment.

Parameters

Name Type Description
alignment VerticalAlignment the vertical alignment

Return

[TableCell](#) — the current element

Authorization

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

setWidth(width)

Sets the width of the column containing the current cell, in points.

Parameters

Name Type Description
width Number the column width, in points

Return

[TableCell](#) — the current element

Authorization

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