Um elemento que representa uma tabela. Uma Table
só pode conter elementos TableRow
. Para
Saiba mais sobre a estrutura do documento no guia para ampliar os arquivos do Documentos Google.
Ao criar uma Table
que contenha um grande número de linhas ou células, considere criar
de uma matriz de strings, como mostrado no exemplo a seguir.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Create a two-dimensional array containing the cell contents. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. body.appendTable(cells);
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
appendTableRow() | TableRow | Cria e anexa um novo TableRow . |
appendTableRow(tableRow) | TableRow | Anexa o TableRow fornecido. |
clear() | Table | Limpa o conteúdo do elemento. |
copy() | Table | Retorna uma cópia detalhada e removida do elemento atual. |
editAsText() | Text | Recebe uma versão Text do elemento atual para edição. |
findElement(elementType) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado. |
findElement(elementType, from) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo
RangeElement especificado. |
findText(searchPattern) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares. |
findText(searchPattern, from) | RangeElement | Pesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um resultado da pesquisa. |
getAttributes() | Object | Recupera os atributos do elemento. |
getBorderColor() | String | Recupera a cor da borda. |
getBorderWidth() | Number | Recupera a largura da borda, em pontos. |
getCell(rowIndex, cellIndex) | TableCell | Recupera o TableCell nos índices de linha e célula especificados. |
getChild(childIndex) | Element | Recupera o elemento filho no índice filho especificado. |
getChildIndex(child) | Integer | Recupera o índice filho para o elemento filho especificado. |
getColumnWidth(columnIndex) | Number | Recupera a largura da coluna da tabela especificada, em pontos. |
getLinkUrl() | String | Recupera o URL do link. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getNumChildren() | Integer | Recupera o número de filhos. |
getNumRows() | Integer | Recupera o número de TableRows . |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getRow(rowIndex) | TableRow | Recupera o TableRow no índice de linha especificado. |
getText() | String | Recupera o conteúdo do elemento como uma string de texto. |
getTextAlignment() | TextAlignment | Extrai o alinhamento do texto. |
getType() | ElementType | Recupera o ElementType do elemento. |
insertTableRow(childIndex) | TableRow | Cria e insere um novo TableRow no índice especificado. |
insertTableRow(childIndex, tableRow) | TableRow | Insere o TableRow fornecido no índice especificado. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
removeChild(child) | Table | Remove o elemento filho especificado. |
removeFromParent() | Table | Remove o elemento do pai. |
removeRow(rowIndex) | TableRow | Remove o TableRow do índice de linha especificado. |
replaceText(searchPattern, replacement) | Element | Substitui todas as ocorrências de um determinado padrão de texto por uma string de substituição específica, usando valores expressões idiomáticas. |
setAttributes(attributes) | Table | Define os atributos do elemento. |
setBorderColor(color) | Table | Define a cor da borda. |
setBorderWidth(width) | Table | Define a largura da borda, em pontos. |
setColumnWidth(columnIndex, width) | Table | Define a largura da coluna especificada, em pontos. |
setLinkUrl(url) | Table | Define o URL do link. |
setTextAlignment(textAlignment) | Table | Define o alinhamento do texto. |
Documentação detalhada
appendTableRow()
appendTableRow(tableRow)
Anexa o TableRow
fornecido.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table in the tab and copies the second row. const table = body.getTables()[0]; const row = table.getChild(1).copy(); // Adds the copied row to the bottom of the table. const tableRow = table.appendTableRow(row);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
tableRow | TableRow | A linha da tabela a ser anexada. |
Retornar
TableRow
: o elemento da linha da tabela anexada.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
Retorna uma cópia detalhada e removida do elemento atual.
Todos os elementos filhos presentes no elemento também são copiados. O novo elemento não tem pai
Retornar
Table
: a nova cópia.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
Recebe uma versão Text
do elemento atual para edição.
Use editAsText
para manipular o conteúdo dos elementos como rich text. O modo editAsText
ignora elementos não textuais (como InlineImage
e HorizontalRule
).
Elementos filho totalmente contidos em um intervalo de texto excluído são removidos do elemento.
var 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);
Retornar
Text
: uma versão em texto do elemento atual.
findElement(elementType)
Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
elementType | ElementType | O tipo de elemento a ser pesquisado. |
Retornar
RangeElement
: um resultado da pesquisa que indica a posição do elemento de pesquisa.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo
RangeElement
especificado.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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; } }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
elementType | ElementType | O tipo de elemento a ser pesquisado. |
from | RangeElement | O resultado da pesquisa a partir do qual pesquisar. |
Retornar
RangeElement
: um resultado da pesquisa que indica a próxima posição do elemento de pesquisa.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
Pesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares.
Um subconjunto dos recursos de expressão regular JavaScript não tem suporte total, como grupos de captura e modificadores de modo.
O padrão de expressão regular fornecido corresponde independentemente a cada bloco de texto no elemento atual.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
searchPattern | String | o padrão a ser pesquisado |
Retornar
RangeElement
: um resultado da pesquisa que indica a posição do texto da pesquisa, ou nulo se não houver
correspondem
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
Pesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um resultado da pesquisa.
Um subconjunto dos recursos de expressão regular JavaScript não tem suporte total, como grupos de captura e modificadores de modo.
O padrão de expressão regular fornecido corresponde independentemente a cada bloco de texto no elemento atual.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
searchPattern | String | o padrão a ser pesquisado |
from | RangeElement | o resultado da pesquisa a ser pesquisado |
Retornar
RangeElement
: um resultado da pesquisa que indica a próxima posição do texto da pesquisa, ou nulo se não houver
correspondem
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAttributes()
Recupera os atributos do elemento.
O resultado é um objeto que contém uma propriedade para cada atributo de elemento válido, em que cada
nome da propriedade corresponde a um item na enumeração DocumentApp.Attribute
.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.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]); }
Retornar
Object
: os atributos do elemento.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBorderColor()
Recupera a cor da borda.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Sets the border color of the first table. table.setBorderColor('#00FF00'); // Logs the border color of the first table to the console. console.log(table.getBorderColor());
Retornar
String
: a cor da borda, formatada em notação CSS (como '#ffffff'
).
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBorderWidth()
Recupera a largura da borda, em pontos.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Sets the border width of the first table. table.setBorderWidth(20); // Logs the border width of the first table. console.log(table.getBorderWidth());
Retornar
Number
: a largura da borda, em pontos.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getCell(rowIndex, cellIndex)
Recupera o TableCell
nos índices de linha e célula especificados.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Gets the cell of the table's third row and second column. const cell = table.getCell(2, 1); // Logs the cell text to the console. console.log(cell.getText());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowIndex | Integer | O índice da linha que contém a célula a ser recuperada. |
cellIndex | Integer | O índice da célula a ser recuperada. |
Retornar
TableCell
: a célula da tabela.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
Recupera o elemento filho no índice filho especificado.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. 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."); }
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | O índice do elemento filho a ser recuperado. |
Retornar
Element
: o elemento filho no índice especificado.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
Recupera o índice filho para o elemento filho especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
child | Element | O elemento filho para o qual o índice será recuperado. |
Retornar
Integer
: o índice filho.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getColumnWidth(columnIndex)
Recupera a largura da coluna da tabela especificada, em pontos.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Sets the width of the second column to 100 points. const columnWidth = table.setColumnWidth(1, 100); // Gets the width of the second column and logs it to the console. console.log(columnWidth.getColumnWidth(1));
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnIndex | Integer | O índice da coluna. |
Retornar
Number
: a largura da coluna, em pontos.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLinkUrl()
Recupera o URL do link.
Retornar
String
: o URL do link ou nulo se o elemento tiver vários valores para o atributo
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
Recupera o próximo elemento irmão do elemento.
O próximo irmão tem o mesmo pai e segue o elemento atual.
Retornar
Element
: o próximo elemento irmão.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
Recupera o número de filhos.
var 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.");
Retornar
Integer
: o número de filhos.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumRows()
Recupera o número de TableRows
.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Logs the number of rows of the first table to the console. console.log(table.getNumRows());
Retornar
Integer
: o número de linhas da tabela.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
Recupera o elemento pai do elemento.
O elemento pai contém o elemento atual.
Retornar
ContainerElement
: o elemento pai.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
Recupera o elemento irmão anterior do elemento.
O irmão anterior tem o mesmo pai e precede o elemento atual.
Retornar
Element
: o elemento irmão anterior.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getRow(rowIndex)
Recupera o TableRow
no índice de linha especificado.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table and logs the text of first row to the console. const table = body.getTables()[0]; console.log(table.getRow(0).getText());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowIndex | Integer | O índice da linha a ser recuperada. |
Retornar
TableRow
: a linha da tabela.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getText()
Recupera o conteúdo do elemento como uma string de texto.
Retornar
String
: o conteúdo do elemento como uma string de texto
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTextAlignment()
Extrai o alinhamento do texto. Os tipos de alinhamento disponíveis são DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
e DocumentApp.TextAlignment.SUPERSCRIPT
.
Retornar
TextAlignment
: o tipo de alinhamento do texto ou null
se o texto contiver vários tipos de texto
alinhamentos ou se o alinhamento do texto nunca foi definido
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
Recupera o ElementType
do elemento.
Use getType()
para determinar o tipo exato de um determinado elemento.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Obtain the first element in the active tab's 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.'); }
Retornar
ElementType
: o tipo de elemento.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTableRow(childIndex)
Cria e insere um novo TableRow
no índice especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | o índice no qual o elemento será inserido |
Retornar
TableRow
: o elemento atual
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTableRow(childIndex, tableRow)
Insere o TableRow
fornecido no índice especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
childIndex | Integer | o índice no qual o elemento será inserido |
tableRow | TableRow | linha da tabela a ser inserida |
Retornar
TableRow
: o elemento de linha da tabela inserido
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
Determina se o elemento está no final do Document
.
Retornar
Boolean
: se o elemento está no final da guia.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeChild(child)
Remove o elemento filho especificado.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Finds the first table row and removes it. const element = table.findElement(DocumentApp.ElementType.TABLE_ROW); table.removeChild(element.getElement());
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
child | Element | O elemento filho a ser removido. |
Retornar
Table
: o elemento atual.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
Remove o elemento do pai.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab() var body = documentTab.getBody(); // Remove all images in the active tab's body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Retornar
Table
: o elemento removido.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeRow(rowIndex)
Remove o TableRow
do índice de linha especificado.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table and removes its second row. const table = body.getTables()[0]; table.removeRow(1);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
rowIndex | Integer | O índice da linha a ser removida. |
Retornar
TableRow
: a linha removida.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
Substitui todas as ocorrências de um determinado padrão de texto por uma string de substituição específica, usando valores expressões idiomáticas.
O padrão de pesquisa é transmitido como uma string, não um objeto de expressão regular JavaScript. Por isso, você precisará fazer o escape de todas as barras invertidas do padrão.
Esse método usa a linguagem RE2 padrão do Google, de expressão, o que limita a sintaxe suportada.
O padrão de expressão regular fornecido corresponde independentemente a cada bloco de texto no elemento atual.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
searchPattern | String | o padrão de regex a ser pesquisado |
replacement | String | o texto a ser usado como substituto |
Retornar
Element
: o elemento atual
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
Define os atributos do elemento.
O parâmetro de atributos especificado precisa ser um objeto em que cada nome de propriedade é um item
a enumeração DocumentApp.Attribute
e cada valor de propriedade é o novo valor a ser
aplicada.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.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);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
attributes | Object | Os atributos do elemento. |
Retornar
Table
: o elemento atual.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setBorderColor(color)
Define a cor da borda.
// Opens the Docs file by its ID. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Sets the border color of the table to green. table.setBorderColor('#00FF00');
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
color | String | A cor da borda, formatada em notação CSS (como '#ffffff' ). |
Retornar
Table
: o elemento atual.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setBorderWidth(width)
Define a largura da borda, em pontos.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
width | Number | a largura da borda, em pontos |
Retornar
Table
: o elemento atual
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setColumnWidth(columnIndex, width)
Define a largura da coluna especificada, em pontos.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
columnIndex | Integer | o índice da coluna |
width | Number | a largura da borda, em pontos |
Retornar
Table
: o elemento atual
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
Define o URL do link.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
url | String | o URL do link |
Retornar
Table
: o elemento atual
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setTextAlignment(textAlignment)
Define o alinhamento do texto. Os tipos de alinhamento disponíveis são DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
e DocumentApp.TextAlignment.SUPERSCRIPT
.
// Make the entire first paragraph in the active tab be superscript. var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); var text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
textAlignment | TextAlignment | o tipo de alinhamento de texto a ser aplicado |
Retornar
Table
: o elemento atual
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents