Google Apps Script

Class TableRow

An element representing a table row. A TableRow is always contained within a Table and may only contain TableCell elements. For more information on document structure, see the guide to extending Google Docs.

Methods

MethodReturn typeBrief description
appendTableCell()TableCellCreates and appends a new TableCell.
appendTableCell(textContents)TableCellAppends the given TableCell containing the specified text.
appendTableCell(tableCell)TableCellAppends the given TableCell.
clear()TableRowClears the contents of the element.
copy()TableRowReturns a detached, deep copy of the current element.
editAsText()TextObtains a Text version of the current element, for editing.
findElement(elementType)RangeElementSearches the contents of the element for a descendant of the specified type.
findElement(elementType, from)RangeElementSearches the contents of the element for a descendant of the specified type, starting from the specified RangeElement.
findText(searchPattern)RangeElementSearches the contents of the element for the specified text pattern using regular expressions.
findText(searchPattern, from)RangeElementSearches the contents of the element for the specified text pattern, starting from a given search result.
getAttributes()ObjectRetrieves the element's attributes.
getCell(cellIndex)TableCellRetrieves the TableCell at the specified cell index.
getChild(childIndex)ElementRetrieves the child element at the specified child index.
getChildIndex(child)IntegerRetrieves the child index for the specified child element.
getLinkUrl()StringRetrieves the link url.
getMinimumHeight()IntegerRetrieves the minimum height, in points.
getNextSibling()ElementRetrieves the element's next sibling element.
getNumCells()IntegerRetrieves the number of cells in the row.
getNumChildren()IntegerRetrieves the number of children.
getParent()ContainerElementRetrieves the element's parent element.
getParentTable()TableRetrieves the Table containing the current row.
getPreviousSibling()ElementRetrieves the element's previous sibling element.
getText()StringRetrieves the contents of the element as a text string.
getType()ElementTypeRetrieves the element's ElementType.
insertTableCell(childIndex)TableCellCreates and inserts a new TableCell at the specified index.
insertTableCell(childIndex, textContents)TableCellInserts the given TableCell at the specified index, containing the given text.
insertTableCell(childIndex, tableCell)TableCellInserts the given TableCell at the specified index.
isAtDocumentEnd()BooleanDetermines whether the element is at the end of the Document.
merge()TableRowMerges the element with the preceding sibling of the same type.
removeCell(cellIndex)TableCellRemoves the TableCell at the specified cell index.
removeChild(child)TableRowRemoves the specified child element.
removeFromParent()TableRowRemoves the element from its parent.
replaceText(searchPattern, replacement)ElementReplaces all occurrences of a given text pattern with a given replacement string, using regular expressions.
setAttributes(attributes)TableRowSets the element's attributes.
setLinkUrl(url)TableRowSets the link url.
setMinimumHeight(minHeight)TableRowSets the minimum height, in points.

Detailed documentation

appendTableCell()

Creates and appends a new TableCell.

Return

TableCell — the new table cell


appendTableCell(textContents)

Appends the given TableCell containing the specified text.

Parameters

NameTypeDescription
textContentsStringthe cell's text contents

Return

TableCell — the appended table cell element


appendTableCell(tableCell)

Appends the given TableCell.

Parameters

NameTypeDescription
tableCellTableCellthe table cell to append

Return

TableCell — the appended table cell


clear()

Clears the contents of the element.

Return

TableRow — 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 will not have a parent.

Return

TableRow — the new copy


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.

 
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);
 

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

NameTypeDescription
elementTypeElementTypethe type of element to search for

Return

RangeElement — a search result indicating the position of the search element


findElement(elementType, from)

Searches the contents of the element for a descendant of the specified type, starting from the specified 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;
   }
 }
 

Parameters

NameTypeDescription
elementTypeElementTypethe type of element to search for
fromRangeElementthe search result to search from

Return

RangeElement — a search result indicating the next position of the search element


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

NameTypeDescription
searchPatternStringthe pattern to search for

Return

RangeElement — a search result indicating the position of the search text, or null if there is no match


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

NameTypeDescription
searchPatternStringthe pattern to search for
fromRangeElementthe 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


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.

 
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]);
 }
 

Return

Object — the element's attributes


getCell(cellIndex)

Retrieves the TableCell at the specified cell index.

Parameters

NameTypeDescription
cellIndexIntegerthe index of the cell to retrieve

Return

TableCell — the table cell


getChild(childIndex)

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.");
 }
 

Parameters

NameTypeDescription
childIndexIntegerthe index of the child element to retrieve

Return

Element — the child element at the specified index


getChildIndex(child)

Retrieves the child index for the specified child element.

Parameters

NameTypeDescription
childElementthe child element for which to retrieve the index

Return

Integer — the child index


getLinkUrl()

Retrieves the link url.

Return

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


getMinimumHeight()

Retrieves the minimum height, in points.

Return

Integer — the minimum height, in points


getNextSibling()

Retrieves the element's next sibling element.

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

Return

Element — the next sibling element


getNumCells()

Retrieves the number of cells in the row.

Return

Integer — the number of cells


getNumChildren()

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.");
 

Return

Integer — the number of children


getParent()

Retrieves the element's parent element.

The parent element contains the current element.

Return

ContainerElement — the parent element


getParentTable()

Retrieves the Table containing the current row.

Return

Table — the table containing the current row


getPreviousSibling()

Retrieves the element's previous sibling element.

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

Return

Element — the previous sibling element


getText()

Retrieves the contents of the element as a text string.

Return

String — the contents of the element as text string


getType()

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.');
 }
 

Return

ElementType — the element type


insertTableCell(childIndex)

Creates and inserts a new TableCell at the specified index.

Parameters

NameTypeDescription
childIndexIntegerthe index at which to insert the element

Return

TableCell — the new table cell


insertTableCell(childIndex, textContents)

Inserts the given TableCell at the specified index, containing the given text.

Parameters

NameTypeDescription
childIndexIntegerthe index at which to insert the element
textContentsStringthe cell's text contents

Return

TableCell — the inserted table cell


insertTableCell(childIndex, tableCell)

Inserts the given TableCell at the specified index.

Parameters

NameTypeDescription
childIndexIntegerthe index at which to insert the element
tableCellTableCellthe table cell to insert

Return

TableCell — the inserted table cell


isAtDocumentEnd()

Determines whether the element is at the end of the Document.

Return

Boolean — whether the element is at the end of the document


merge()

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();
 

Return

TableRow — the merged element


removeCell(cellIndex)

Removes the TableCell at the specified cell index.

Parameters

NameTypeDescription
cellIndexIntegerthe index of the cell to remove

Return

TableCell — the removed cell


removeChild(child)

Removes the specified child element.

Parameters

NameTypeDescription
childElementthe child element to remove

Return

TableRow — the current element


removeFromParent()

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();
 }
 

Return

TableRow — the removed element


replaceText(searchPattern, replacement)

Replaces all occurrences of a given text pattern with a given replacement string, 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.

 
var body = DocumentApp.getActiveDocument().getBody();

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

Parameters

NameTypeDescription
searchPatternStringthe regex pattern to search for
replacementStringthe text to use as replacement

Return

Element — the current element


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.

 
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] =
     DocumentApp.FontFamily.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);
 

Parameters

NameTypeDescription
attributesObjectthe element's attributes

Return

TableRow — the current element


setLinkUrl(url)

Sets the link url.

Parameters

NameTypeDescription
urlStringthe link url

Return

TableRow — the current element


setMinimumHeight(minHeight)

Sets the minimum height, in points.

Parameters

NameTypeDescription
minHeightIntegerthe minimum height, in points

Return

TableRow — the current element

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.