Elemento que representa uma região de rich text. Todo o texto em um Document
está incluído em elementos Text
.
Um elemento Text
pode estar contido em um Equation
, EquationFunction
, ListItem
ou Paragraph
, mas não pode conter nenhum outro elemento. Veja mais informações sobre a estrutura de documentos no guia de extensão do Documentos Google.
var body = DocumentApp.getActiveDocument().getBody(); // Use editAsText to obtain a single text element containing // all the characters in the document. var text = body.editAsText(); // Insert text at the beginning of the document. text.insertText(0, 'Inserted text.\n'); // Insert text at the end of the document. text.appendText('\nAppended text.'); // Make the first half of the document blue. text.setForegroundColor(0, text.getText().length / 2, '#00FFFF');
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
appendText(text) | Text | Adiciona o texto especificado ao final desta região de texto. |
copy() | Text | Retorna uma cópia detalhada e removida do elemento atual. |
deleteText(startOffset, endOffsetInclusive) | Text | Exclui um intervalo de texto. |
editAsText() | Text | Recebe uma versão de Text do elemento atual para edição. |
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 para o padrão de texto especificado, começando com um determinado resultado da pesquisa. |
getAttributes() | Object | Recupera os atributos do elemento. |
getAttributes(offset) | Object | Recupera os atributos no deslocamento de caracteres especificado. |
getBackgroundColor() | String | Recupera a configuração de cor de fundo. |
getBackgroundColor(offset) | String | Recupera a cor do plano de fundo no deslocamento de caracteres especificado. |
getFontFamily() | String | Recupera a configuração da família de fontes. |
getFontFamily(offset) | String | Recupera a família de fontes no deslocamento de caracteres especificado. |
getFontSize() | Number | Recupera a configuração do tamanho da fonte. |
getFontSize(offset) | Number | Recupera o tamanho da fonte no deslocamento de caracteres especificado. |
getForegroundColor() | String | Recupera a configuração de cor em primeiro plano. |
getForegroundColor(offset) | String | Recupera a cor do primeiro plano no deslocamento de caracteres especificado. |
getLinkUrl() | String | Recupera o URL do link. |
getLinkUrl(offset) | String | Recupera o URL do link no deslocamento de caracteres especificado. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getText() | String | Recupera o conteúdo do elemento como uma string de texto. |
getTextAlignment() | TextAlignment | Recebe o alinhamento do texto. |
getTextAlignment(offset) | TextAlignment | Recebe o alinhamento do texto para um único caractere. |
getTextAttributeIndices() | Integer[] | Recupera o conjunto de índices de texto que correspondem ao início de execuções de formatação de texto diferentes. |
getType() | ElementType | Recupera o ElementType do elemento. |
insertText(offset, text) | Text | Insere o texto especificado no deslocamento de caracteres especificado. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no fim do Document . |
isBold() | Boolean | Recupera a configuração em negrito. |
isBold(offset) | Boolean | Recupera a configuração em negrito no deslocamento de caracteres especificado. |
isItalic() | Boolean | Recupera a configuração de itálico. |
isItalic(offset) | Boolean | Recupera a configuração de itálico no deslocamento de caracteres especificado. |
isStrikethrough() | Boolean | Recupera a configuração tachada. |
isStrikethrough(offset) | Boolean | Recupera a configuração tachada no deslocamento de caracteres especificado. |
isUnderline() | Boolean | Recupera a configuração de sublinhado. |
isUnderline(offset) | Boolean | Recupera a configuração de sublinhado no deslocamento de caracteres especificado. |
merge() | Text | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeFromParent() | Text | Remove o elemento do pai. |
replaceText(searchPattern, replacement) | Element | Substitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição usando expressões regulares. |
setAttributes(startOffset, endOffsetInclusive, attributes) | Text | Aplica os atributos especificados ao intervalo de caracteres especificado. |
setAttributes(attributes) | Text | Define os atributos do elemento. |
setBackgroundColor(startOffset, endOffsetInclusive, color) | Text | Define a cor do plano de fundo do intervalo de caracteres especificado. |
setBackgroundColor(color) | Text | Define a cor do plano de fundo. |
setBold(bold) | Text | Define a configuração de negrito. |
setBold(startOffset, endOffsetInclusive, bold) | Text | Define a configuração de negrito para o intervalo de caracteres especificado. |
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName) | Text | Define a família de fontes do intervalo de caracteres especificado. |
setFontFamily(fontFamilyName) | Text | Define a família de fontes. |
setFontSize(startOffset, endOffsetInclusive, size) | Text | Define o tamanho da fonte para o intervalo de caracteres especificado. |
setFontSize(size) | Text | Define o tamanho da fonte. |
setForegroundColor(startOffset, endOffsetInclusive, color) | Text | Define a cor do primeiro plano para o intervalo de caracteres especificado. |
setForegroundColor(color) | Text | Define a cor do primeiro plano. |
setItalic(italic) | Text | Define a configuração de itálico. |
setItalic(startOffset, endOffsetInclusive, italic) | Text | Define a configuração de itálico para o intervalo de caracteres especificado. |
setLinkUrl(startOffset, endOffsetInclusive, url) | Text | Define o URL do link para o intervalo de caracteres especificado. |
setLinkUrl(url) | Text | Define o URL do link. |
setStrikethrough(strikethrough) | Text | Define a configuração de tachado. |
setStrikethrough(startOffset, endOffsetInclusive, strikethrough) | Text | Define a configuração de tachado para o intervalo de caracteres especificado. |
setText(text) | Text | Define o conteúdo de texto. |
setTextAlignment(startOffset, endOffsetInclusive, textAlignment) | Text | Define o alinhamento do texto para um determinado intervalo de caracteres. |
setTextAlignment(textAlignment) | Text | Define o alinhamento do texto. |
setUnderline(underline) | Text | Define a configuração de sublinhado. |
setUnderline(startOffset, endOffsetInclusive, underline) | Text | Define a configuração de sublinhado do intervalo de caracteres especificado. |
Documentação detalhada
appendText(text)
Adiciona o texto especificado ao final desta região de texto.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
text | String | o texto a ser anexado |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
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 um pai.
Retornar
Text
: a nova cópia.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
deleteText(startOffset, endOffsetInclusive)
Exclui um intervalo de texto.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startOffset | Integer | o deslocamento do primeiro caractere a ser excluído |
endOffsetInclusive | Integer | o deslocamento do último caractere a ser excluído |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem 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 de Text
do elemento atual para edição.
Use a editAsText
para manipular o conteúdo dos elementos como rich text. O modo editAsText
ignora elementos não textuais, como InlineImage
e HorizontalRule
.
Os elementos filhos totalmente contidos em um intervalo de texto excluído são removidos do elemento.
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);
Retornar
Text
: uma versão em texto do elemento atual
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 em JavaScript não é totalmente compatível, como grupos de captura e modificadores de modo.
O padrão de expressão regular fornecido corresponde de maneira independente para cada bloco de texto contido no elemento atual.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
searchPattern | String | o padrão a ser pesquisado |
Retornar
RangeElement
: um resultado da pesquisa indicando a posição do texto de pesquisa ou nulo, se não houver correspondência.
Autorização
Os scripts que usam esse método exigem 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 para o padrão de texto especificado, começando com um determinado resultado da pesquisa.
Um subconjunto dos recursos de expressão regular em JavaScript não é totalmente compatível, como grupos de captura e modificadores de modo.
O padrão de expressão regular fornecido corresponde de maneira independente para cada bloco de texto contido no elemento atual.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
searchPattern | String | o padrão a ser pesquisado |
from | RangeElement | o resultado da pesquisa |
Retornar
RangeElement
: um resultado da pesquisa que indica a próxima posição do texto de pesquisa ou, se não houver correspondência, será nulo.
Autorização
Os scripts que usam esse método exigem 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 de propriedade corresponde a um item na enumeração DocumentApp.Attribute
.
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]); }
Retornar
Object
: os atributos do elemento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAttributes(offset)
Recupera os atributos no deslocamento de caracteres especificado.
O resultado é um objeto que contém uma propriedade para cada atributo de texto válido, em que cada
nome de propriedade corresponde a um item na enumeração DocumentApp.Attribute
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
offset | Integer | o deslocamento de caracteres |
Retornar
Object
: os atributos do elemento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBackgroundColor()
Recupera a configuração de cor de fundo.
Retornar
String
: a cor de fundo, formatada em notação CSS (como '#ffffff'
), ou nula
se o elemento contiver vários valores para esse atributo
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBackgroundColor(offset)
Recupera a cor do plano de fundo no deslocamento de caracteres especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
offset | Integer | o deslocamento de caracteres |
Retornar
String
: a cor do plano de fundo, formatada em notação CSS (como '#ffffff'
).
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getFontFamily()
Recupera a configuração da família de fontes. O nome pode ser qualquer fonte do menu "Fontes" do Documentos ou do Google Fonts e diferencia maiúsculas de minúsculas. Os métodos getFontFamily()
e setFontFamily(fontFamilyName)
agora usam nomes de string para fontes em vez
da enumeração
. Embora essa enumeração seja descontinuada, ela continuará disponível para compatibilidade com scripts mais antigos.FontFamily
Retornar
String
: a família de fontes, ou nula se o elemento contiver vários valores para esse atributo
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getFontFamily(offset)
Recupera a família de fontes no deslocamento de caracteres especificado. O nome pode ser qualquer fonte do menu
"Font" no Documentos ou no Google Fonts e diferencia maiúsculas de minúsculas. Os métodos getFontFamily()
e setFontFamily(fontFamilyName)
agora usam nomes de string para fontes em vez de
. Embora essa enumeração seja descontinuada, ela continuará disponível para compatibilidade com scripts mais antigos.FontFamily
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
offset | Integer | o deslocamento de caracteres |
Retornar
String
: a família de fontes.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getFontSize()
Recupera a configuração do tamanho da fonte.
Retornar
Number
: o tamanho da fonte, ou nulo se o elemento contiver vários valores para esse atributo.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getFontSize(offset)
Recupera o tamanho da fonte no deslocamento de caracteres especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
offset | Integer | o deslocamento de caracteres |
Retornar
Number
: o tamanho da fonte.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getForegroundColor()
Recupera a configuração de cor em primeiro plano.
Retornar
String
: a cor do primeiro plano, formatada em notação CSS (como '#ffffff'
), ou nula
se o elemento tiver vários valores para esse atributo.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getForegroundColor(offset)
Recupera a cor do primeiro plano no deslocamento de caracteres especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
offset | Integer | o deslocamento de caracteres |
Retornar
String
: a cor do primeiro plano, formatada em notação CSS (como '#ffffff'
).
Autorização
Os scripts que usam esse método exigem 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 contiver vários valores para esse atributo
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLinkUrl(offset)
Recupera o URL do link no deslocamento de caracteres especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
offset | Integer | o deslocamento de caracteres |
Retornar
String
: o URL do link
Autorização
Os scripts que usam esse método exigem 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 exigem 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 exigem 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 exigem 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 string de texto
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTextAlignment()
Recebe 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 alinhamento de
texto ou se o alinhamento do texto nunca tiver sido definido
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTextAlignment(offset)
Recebe o alinhamento do texto para um único caractere. Os tipos de alinhamento disponíveis são DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
e DocumentApp.TextAlignment.SUPERSCRIPT
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
offset | Integer | o deslocamento do caractere |
Retornar
TextAlignment
: o tipo de alinhamento do texto, ou null
se o alinhamento do texto nunca tiver sido definido
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTextAttributeIndices()
Recupera o conjunto de índices de texto que correspondem ao início de execuções de formatação de texto diferentes.
Retornar
Integer[]
: o conjunto de índices de texto em que a formatação do texto muda
Autorização
Os scripts que usam esse método exigem 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 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.'); }
Retornar
ElementType
: o tipo do elemento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertText(offset, text)
Insere o texto especificado no deslocamento de caracteres especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
offset | Integer | o deslocamento de caracteres para inserir |
text | String | o texto a ser inserido |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem 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 fim do Document
.
Retornar
Boolean
: se o elemento está no final do documento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isBold()
Recupera a configuração em negrito.
Retornar
Boolean
: se o texto está em negrito ou nulo se o elemento contiver vários valores para esse
atributo.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isBold(offset)
Recupera a configuração em negrito no deslocamento de caracteres especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
offset | Integer | o deslocamento de caracteres |
Retornar
Boolean
: a configuração em negrito
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isItalic()
Recupera a configuração de itálico.
Retornar
Boolean
: se o texto é itálico ou nulo se o elemento contiver vários valores para esse
atributo
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isItalic(offset)
Recupera a configuração de itálico no deslocamento de caracteres especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
offset | Integer | o deslocamento de caracteres |
Retornar
Boolean
: a configuração de itálico.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isStrikethrough()
Recupera a configuração tachada.
Retornar
Boolean
: se o texto é tachado ou nulo se o elemento contiver vários valores para
esse atributo
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isStrikethrough(offset)
Recupera a configuração tachada no deslocamento de caracteres especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
offset | Integer | o deslocamento de caracteres |
Retornar
Boolean
: a configuração de tachado
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isUnderline()
Recupera a configuração de sublinhado.
Retornar
Boolean
: se o texto é sublinhado ou nulo se o elemento contiver vários valores para
esse atributo.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isUnderline(offset)
Recupera a configuração de sublinhado no deslocamento de caracteres especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
offset | Integer | o deslocamento de caracteres |
Retornar
Boolean
: a configuração de sublinhado.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
merge()
Mescla o elemento com o irmão anterior do mesmo tipo.
Somente elementos do mesmo ElementType
podem ser mesclados. Todos os elementos filhos contidos no
elemento atual são movidos para o elemento irmão anterior.
O elemento atual é removido do documento.
var body = DocumentApp.getActiveDocument().getBody(); // Example 1: Merge paragraphs // 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(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's 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. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
Retornar
Text
: o elemento mesclado.
Autorização
Os scripts que usam esse método exigem 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 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(); }
Retornar
Text
: o elemento removido.
Autorização
Os scripts que usam esse método exigem 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 determinada string de substituição usando expressões regulares.
O padrão de pesquisa é transmitido como uma string, e não como um objeto JavaScript de expressão regular. Por isso, é preciso evitar barras invertidas no padrão.
Esses métodos usam a biblioteca de expressão regular RE2 do Google, que limita a sintaxe compatível.
O padrão de expressão regular fornecido corresponde de maneira independente para cada bloco de texto contido no elemento atual.
var body = DocumentApp.getActiveDocument().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 regex a ser pesquisado |
replacement | String | o texto a ser substituído |
Retornar
Element
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(startOffset, endOffsetInclusive, attributes)
Aplica os atributos especificados ao intervalo de caracteres especificado.
O parâmetro de atributos especificados precisa ser um objeto em que cada nome de propriedade é um item na
enumeração DocumentApp.Attribute
e cada valor de propriedade é o novo valor a ser
aplicado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startOffset | Integer | o deslocamento inicial do intervalo de texto |
endOffsetInclusive | Integer | o deslocamento final do intervalo de texto |
attributes | Object | os atributos do elemento; |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem 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 especificados precisa ser um objeto em que cada nome de propriedade é um item na
enumeração DocumentApp.Attribute
e cada valor de propriedade é o novo valor a ser
aplicado.
var body = DocumentApp.getActiveDocument().getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
attributes | Object | Os atributos do elemento. |
Retornar
Text
: o elemento atual.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setBackgroundColor(startOffset, endOffsetInclusive, color)
Define a cor do plano de fundo do intervalo de caracteres especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startOffset | Integer | o deslocamento inicial do intervalo de texto |
endOffsetInclusive | Integer | o deslocamento final do intervalo de texto |
color | String | A cor de fundo, formatada em notação CSS (como '#ffffff' ) |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setBackgroundColor(color)
Define a cor do plano de fundo.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
color | String | A cor de fundo, formatada em notação CSS (como '#ffffff' ) |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setBold(bold)
Define a configuração de negrito.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
bold | Boolean | Configuração em negrito |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setBold(startOffset, endOffsetInclusive, bold)
Define a configuração de negrito para o intervalo de caracteres especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startOffset | Integer | o deslocamento inicial do intervalo de texto |
endOffsetInclusive | Integer | o deslocamento final do intervalo de texto |
bold | Boolean | Configuração em negrito |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)
Define a família de fontes do intervalo de caracteres especificado. O nome pode ser qualquer fonte do menu
"Font" no Documentos ou no Google Fonts e diferencia maiúsculas de minúsculas.
Nomes de fontes não reconhecidos serão renderizados como GTIN. Os métodos getFontFamily(offset)
e
setFontFamily(fontFamilyName)
agora usam nomes de string para fontes em vez de
. Embora essa enumeração seja descontinuada, ela continuará disponível para compatibilidade com scripts mais antigos.FontFamily
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startOffset | Integer | o deslocamento inicial do intervalo de texto |
endOffsetInclusive | Integer | o deslocamento final do intervalo de texto |
fontFamilyName | String | Nome da família de fontes no menu "Fontes" do Documentos ou do Google Fonts. |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setFontFamily(fontFamilyName)
Define a família de fontes. O nome pode ser qualquer fonte do menu "Fontes" do Documentos ou do Google Fonts e diferencia maiúsculas de minúsculas. Nomes de fonte
não reconhecidos serão renderizados como GTFS. Os métodos getFontFamily()
e setFontFamily(fontFamilyName)
agora usam nomes de string para fontes em vez de
. Embora essa enumeração seja descontinuada, ela continuará disponível para compatibilidade com scripts mais antigos.FontFamily
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
fontFamilyName | String | Nome da família de fontes no menu "Fontes" do Documentos ou do Google Fonts. |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setFontSize(startOffset, endOffsetInclusive, size)
Define o tamanho da fonte para o intervalo de caracteres especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startOffset | Integer | o deslocamento inicial do intervalo de texto |
endOffsetInclusive | Integer | o deslocamento final do intervalo de texto |
size | Number | o tamanho da fonte. |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setFontSize(size)
Define o tamanho da fonte.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
size | Number | o tamanho da fonte. |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setForegroundColor(startOffset, endOffsetInclusive, color)
Define a cor do primeiro plano para o intervalo de caracteres especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startOffset | Integer | o deslocamento inicial do intervalo de texto |
endOffsetInclusive | Integer | o deslocamento final do intervalo de texto |
color | String | a cor do primeiro plano, formatada em notação CSS (como '#ffffff' ). |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setForegroundColor(color)
Define a cor do primeiro plano.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
color | String | a cor do primeiro plano, formatada em notação CSS (como '#ffffff' ). |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setItalic(italic)
Define a configuração de itálico.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
italic | Boolean | Configuração de itálico |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setItalic(startOffset, endOffsetInclusive, italic)
Define a configuração de itálico para o intervalo de caracteres especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startOffset | Integer | o deslocamento inicial do intervalo de texto |
endOffsetInclusive | Integer | o deslocamento final do intervalo de texto |
italic | Boolean | Configuração de itálico |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(startOffset, endOffsetInclusive, url)
Define o URL do link para o intervalo de caracteres especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startOffset | Integer | o deslocamento inicial do intervalo de texto |
endOffsetInclusive | Integer | o deslocamento final do intervalo de texto |
url | String | URL do link |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem 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 | URL do link |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setStrikethrough(strikethrough)
Define a configuração de tachado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
strikethrough | Boolean | a configuração de tachado |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)
Define a configuração de tachado para o intervalo de caracteres especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startOffset | Integer | o deslocamento inicial do intervalo de texto |
endOffsetInclusive | Integer | o deslocamento final do intervalo de texto |
strikethrough | Boolean | a configuração de tachado |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setText(text)
Define o conteúdo de texto.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
text | String | o conteúdo do novo texto |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)
Define o alinhamento do texto para um determinado intervalo de caracteres. Os tipos de alinhamento disponíveis são
DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
e
DocumentApp.TextAlignment.SUPERSCRIPT
.
// Make the first character in the first paragraph be superscript. var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(0, 0, DocumentApp.TextAlignment.SUPERSCRIPT);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startOffset | Integer | o deslocamento inicial do intervalo de caracteres |
endOffsetInclusive | Integer | o deslocamento final do intervalo de caracteres (inclusivo) |
textAlignment | TextAlignment | o tipo de alinhamento de texto a ser aplicado |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem 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 be superscript. var text = DocumentApp.getActiveDocument().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
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setUnderline(underline)
Define a configuração de sublinhado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
underline | Boolean | configuração de sublinhado |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setUnderline(startOffset, endOffsetInclusive, underline)
Define a configuração de sublinhado do intervalo de caracteres especificado.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
startOffset | Integer | o deslocamento inicial do intervalo de texto |
endOffsetInclusive | Integer | o deslocamento final do intervalo de texto |
underline | Boolean | configuração de sublinhado |
Retornar
Text
: o elemento atual
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents