Esta página foi traduzida pela API Cloud Translation.

Class Text

Um elemento que representa uma região de rich text. Todo o texto em um Document está contido em elementos Text. Um elemento Text pode estar contido em um Equation, EquationFunction, ListItem ou Paragraph, mas não pode conter nenhum outro elemento. Para mais informações sobre a estrutura de documentos, consulte o guia para estender o Google Docs.

// Gets the body contents of the active tab.
const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Use editAsText to obtain a single text element containing
// all the characters in the tab.
const text = body.editAsText();

// Insert text at the beginning of the tab.
text.insertText(0, 'Inserted text.\n');

// Insert text at the end of the tab.
text.appendText('\nAppended text.');

// Make the first half of the tab 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 independente do elemento atual.
`deleteText(startOffset, endOffsetInclusive)`	`Text`	Exclui um intervalo de texto.
`editAsText()`	`Text`	Recebe uma versão `Text` do elemento atual para edição.
`findText(searchPattern)`	`RangeElement\|null`	Pesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
`findText(searchPattern, from)`	`RangeElement\|null`	Pesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa.
`getAttributes()`	`Object`	Recupera os atributos do elemento.
`getAttributes(offset)`	`Object`	Recupera os atributos no deslocamento de caractere especificado.
`getBackgroundColor()`	`String\|null`	Recupera a configuração de cor de plano de fundo.
`getBackgroundColor(offset)`	`String\|null`	Recupera a cor de plano de fundo no deslocamento de caractere especificado.
`getFontFamily()`	`String\|null`	Recupera a configuração da família de fontes.
`getFontFamily(offset)`	`String\|null`	Recupera a família de fontes no deslocamento de caractere especificado.
`getFontSize()`	`Number\|null`	Recupera a configuração de tamanho da fonte.
`getFontSize(offset)`	`Number\|null`	Recupera o tamanho da fonte no deslocamento de caractere especificado.
`getForegroundColor()`	`String\|null`	Recupera a configuração de cor do primeiro plano.
`getForegroundColor(offset)`	`String\|null`	Recupera a cor de primeiro plano no deslocamento de caractere especificado.
`getLinkUrl()`	`String\|null`	Recupera o URL do link.
`getLinkUrl(offset)`	`String\|null`	Recupera o URL do link no deslocamento de caractere especificado.
`getNextSibling()`	`Element\|null`	Recupera o próximo elemento irmão do elemento.
`getParent()`	`ContainerElement\|null`	Recupera o elemento pai do elemento.
`getPreviousSibling()`	`Element\|null`	Recupera o elemento irmão anterior do elemento.
`getText()`	`String`	Recupera o conteúdo do elemento como uma string de texto.
`getTextAlignment()`	`TextAlignment\|null`	Recebe o alinhamento do texto.
`getTextAlignment(offset)`	`TextAlignment\|null`	Recebe o alinhamento de 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 distintas.
`getType()`	`ElementType`	Recupera o `ElementType` do elemento.
`insertText(offset, text)`	`Text`	Insere o texto especificado no deslocamento de caractere indicado.
`isAtDocumentEnd()`	`Boolean`	Determina se o elemento está no final do `Document`.
`isBold()`	`Boolean\|null`	Recupera a configuração de negrito.
`isBold(offset)`	`Boolean\|null`	Recupera a configuração de negrito no deslocamento de caractere especificado.
`isItalic()`	`Boolean\|null`	Recupera a configuração de itálico.
`isItalic(offset)`	`Boolean\|null`	Recupera a configuração de itálico no deslocamento de caractere especificado.
`isStrikethrough()`	`Boolean\|null`	Recupera a configuração de tachado.
`isStrikethrough(offset)`	`Boolean\|null`	Recupera a configuração de tachado no deslocamento de caractere especificado.
`isUnderline()`	`Boolean\|null`	Recupera a configuração de sublinhado.
`isUnderline(offset)`	`Boolean\|null`	Recupera a configuração de sublinhado no deslocamento de caractere especificado.
`merge()`	`Text\|null`	Mescla o elemento com o irmão anterior do mesmo tipo.
`removeFromParent()`	`Text\|null`	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 determinado.
`setAttributes(attributes)`	`Text`	Define os atributos do elemento.
`setBackgroundColor(startOffset, endOffsetInclusive, color)`	`Text`	Define a cor de fundo para o 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 para o 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 de primeiro plano para o intervalo de caracteres especificado.
`setForegroundColor(color)`	`Text`	Define a cor de 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 do 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 para o intervalo de caracteres especificado.

Documentação detalhada

`appendText(text)`

Adiciona o texto especificado ao final desta região de texto.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Adds the text, 'Sample body text,' to the end of the tab body.
const text = body.editAsText().appendText('Sample body text');

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 independente do elemento atual.

Todos os elementos filhos presentes no elemento também são copiados. O novo elemento não tem um elemento pai.

Retornar

Text: o novo 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

`deleteText(startOffset, endOffsetInclusive)`

Exclui um intervalo de texto.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Deletes the first 10 characters in the body.
const text = body.editAsText().deleteText(0, 9);

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 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.

Os elementos filhos totalmente contidos em um intervalo de texto excluído são removidos do elemento.

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

Retornar

Text: uma versão de texto do elemento atual

`findText(searchPattern)`

Pesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.

Um subconjunto dos recursos de expressão regular do JavaScript não é totalmente compatível, como grupos de captura e modificadores de modo.

O padrão de expressão regular fornecido é correspondido de forma independente a cada bloco de texto contido no elemento atual.

Parâmetros

Nome	Tipo	Descrição
`searchPattern`	`String`	o padrão a ser pesquisado

Retornar

RangeElement|null: um resultado da pesquisa que indica a posição do texto pesquisado ou nulo se não houver uma 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 em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa.

Um subconjunto dos recursos de expressão regular do JavaScript não é totalmente compatível, como grupos de captura e modificadores de modo.

O padrão de expressão regular fornecido é correspondido de forma independente a 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 para pesquisar

Retornar

RangeElement|null: um resultado da pesquisa que indica a próxima posição do texto pesquisado ou nulo se não houver uma 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

`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.

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

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 caractere 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.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Declares style attributes.
const style = {};
style[DocumentApp.Attribute.BOLD] = true;
style[DocumentApp.Attribute.ITALIC] = true;
style[DocumentApp.Attribute.FONT_SIZE] = 29;

// Sets the style attributes to the tab's body.
const text = body.editAsText();
text.setAttributes(style);

// Gets the style attributes applied to the eleventh character in the
// body and logs them to the console.
const attributes = text.getAttributes(10);
console.log(attributes);

Parâmetros

Nome	Tipo	Descrição
`offset`	`Integer`	O deslocamento de caractere.

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 plano de fundo.

Retornar

String|null: a cor de plano de fundo, formatada na 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

`getBackgroundColor(offset)`

Recupera a cor de plano de fundo no deslocamento de caractere especificado.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the background color of the first 3 characters in the body.
const text = body.editAsText().setBackgroundColor(0, 2, '#FFC0CB');

// Gets the background color of the first character in the body.
const backgroundColor = text.getBackgroundColor(0);

// Logs the background color to the console.
console.log(backgroundColor);

Parâmetros

Nome	Tipo	Descrição
`offset`	`Integer`	O deslocamento de caractere.

Retornar

String|null: a cor de plano de fundo, formatada na 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 "Fonte" no Google Docs 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 do enum FontFamily. Embora essa enumeração esteja descontinuada, ela vai continuar disponível para compatibilidade com scripts mais antigos.

Retornar

String|null: a família de fontes 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

`getFontFamily(offset)`

Recupera a família de fontes no deslocamento de caractere especificado. O nome pode ser qualquer fonte do menu "Fonte" no Docs 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 FontFamily. Embora essa enumeração esteja descontinuada, ela vai continuar disponível para compatibilidade com scripts mais antigos.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the font of the first 16 characters to Impact.
const text = body.editAsText().setFontFamily(0, 15, 'Impact');

// Gets the font family of the 16th character in the tab body.
const fontFamily = text.getFontFamily(15);

// Logs the font family to the console.
console.log(fontFamily);

Parâmetros

Nome	Tipo	Descrição
`offset`	`Integer`	O deslocamento de caractere.

Retornar

String|null: 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 de tamanho da fonte.

Retornar

Number|null: 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 caractere especificado.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the font size of the first 13 characters to 15.
const text = body.editAsText().setFontSize(0, 12, 15);

// Gets the font size of the first character.
const fontSize = text.getFontSize(0);

// Logs the font size to the console.
console.log(fontSize);

Parâmetros

Nome	Tipo	Descrição
`offset`	`Integer`	O deslocamento de caractere.

Retornar

Number|null: 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 de primeiro plano.

Retornar

String|null: a cor de primeiro plano, formatada na 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

`getForegroundColor(offset)`

Recupera a cor de primeiro plano no deslocamento de caractere especificado.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the foreground color of the first 3 characters in the tab body.
const text = body.editAsText().setForegroundColor(0, 2, '#0000FF');

// Gets the foreground color of the first character in the tab body.
const foregroundColor = text.getForegroundColor(0);

// Logs the foreground color to the console.
console.log(foregroundColor);

Parâmetros

Nome	Tipo	Descrição
`offset`	`Integer`	O deslocamento de caractere.

Retornar

String|null: a cor do primeiro plano, formatada na 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|null: 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 caractere especificado.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Applies a link to the first 10 characters in the body.
const text = body.editAsText().setLinkUrl(0, 9, 'https://www.example.com/');

// Gets the URL of the link from the first character.
const link = text.getLinkUrl(0);

// Logs the link URL to the console.
console.log(link);

Parâmetros

Nome	Tipo	Descrição
`offset`	`Integer`	O deslocamento de caractere.

Retornar

String|null: 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 elemento irmão tem o mesmo elemento pai e segue o elemento atual.

Retornar

Element|null: 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|null: 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|null: 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 uma 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|null: o tipo de alinhamento de texto ou null se o texto tiver vários tipos de alinhamento ou se o alinhamento 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 de texto para um único caractere. Os tipos de alinhamento disponíveis são DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT e DocumentApp.TextAlignment.SUPERSCRIPT.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the text alignment of the tab's body to NORMAL.
const text =
    body.editAsText().setTextAlignment(DocumentApp.TextAlignment.NORMAL);

// Gets the text alignment of the ninth character.
const alignment = text.getTextAlignment(8);

// Logs the text alignment to the console.
console.log(alignment.toString());

Parâmetros

Nome	Tipo	Descrição
`offset`	`Integer`	O deslocamento do caractere.

Retornar

TextAlignment|null: o tipo de alinhamento do texto ou null se o alinhamento nunca foi 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 distintas.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the text indices at which text formatting changes.
const indices = body.editAsText().getTextAttributeIndices();

// Logs the indices to the console.
console.log(indices.toString());

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 elemento específico.

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

Retornar

ElementType: o tipo de 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 caractere indicado.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Inserts the text, 'Sample inserted text', at the start of the body content.
const text = body.editAsText().insertText(0, 'Sample inserted text');

Parâmetros

Nome	Tipo	Descrição
`offset`	`Integer`	O deslocamento de caractere em que o texto será inserido.
`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 final do Document.

Retornar

Boolean: indica se o elemento está no final da guia.

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 de negrito.

Retornar

Boolean|null: se o texto está em negrito ou nulo se o elemento contém 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 de negrito no deslocamento de caractere especificado.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Bolds the first 4 characters in the tab body.
const text = body.editAsText().setBold(0, 3, true);

// Gets whether or not the text is bold.
const bold = text.editAsText().isBold(0);

// Logs the text's bold setting to the console
console.log(bold);

Parâmetros

Nome	Tipo	Descrição
`offset`	`Integer`	O deslocamento de caractere.

Retornar

Boolean|null: a configuração de 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|null: indica se o texto está em itálico ou é nulo 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

`isItalic(offset)`

Recupera a configuração de itálico no deslocamento de caractere especificado.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 13 characters of the tab body to italic.
const text = body.editAsText().setItalic(0, 12, true);

// Gets whether the fifth character in the tab body is set to
// italic and logs it to the console.
const italic = text.isItalic(4);
console.log(italic);

Parâmetros

Nome	Tipo	Descrição
`offset`	`Integer`	O deslocamento de caractere.

Retornar

Boolean|null: 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 de tachado.

Retornar

Boolean|null: indica se o texto está tachado ou é nulo 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

`isStrikethrough(offset)`

Recupera a configuração de tachado no deslocamento de caractere especificado.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 17 characters of the tab body to strikethrough.
const text = body.editAsText().setStrikethrough(0, 16, true);

// Gets whether the first character in the tab body is set to
// strikethrough and logs it to the console.
const strikethrough = text.isStrikethrough(0);
console.log(strikethrough);

Parâmetros

Nome	Tipo	Descrição
`offset`	`Integer`	O deslocamento de caractere.

Retornar

Boolean|null: 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|null: se o texto está sublinhado ou nulo se o elemento contém 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 caractere especificado.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 13 characters of the tab body to underline.
const text = body.editAsText().setUnderline(0, 12, false);

// Gets whether the first character in the tab body is set to
// underline and logs it to the console
const underline = text.editAsText().isUnderline(0);
console.log(underline);

Parâmetros

Nome	Tipo	Descrição
`offset`	`Integer`	O deslocamento de caractere.

Retornar

Boolean|null: 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.

Só é possível mesclar elementos do mesmo ElementType. Todos os elementos filhos contidos no elemento atual são movidos para o elemento irmão anterior.

O elemento atual é removido do documento.

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

Retornar

Text|null: 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.

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

Retornar

Text|null: 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, não como um objeto de expressão regular JavaScript. Por isso, é necessário inserir uma barra de escape antes de cada barra invertida no padrão.

Esses métodos usam a biblioteca de expressões regulares RE2 do Google, que limita a sintaxe compatível.

O padrão de expressão regular fornecido é correspondido de forma independente a cada bloco de texto contido no elemento atual.

const 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 substituição

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 determinado.

O parâmetro de atributos especificado 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.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Declares style attributes for font size and font family.
const style = {};
style[DocumentApp.Attribute.FONT_SIZE] = 20;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Impact';

// Sets the style attributes to the first 9 characters in the tab's body.
const text = body.setAttributes(0, 8, style);

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.

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

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 de fundo para o intervalo de caracteres especificado.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the background color of the first 3 characters in the
// tab body to hex color #0000FF.
const text = body.editAsText().setBackgroundColor(0, 2, '#0000FF');

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 plano de fundo, formatada na 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 plano de fundo, formatada na 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`	a 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.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to bold.
const text = body.editAsText().setBold(0, 10, true);

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`	A 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 para o intervalo de caracteres especificado. O nome pode ser qualquer fonte do menu "Fonte" no Google Docs ou do Google Fonts e diferencia maiúsculas de minúsculas. Nomes de fontes não reconhecidos serão renderizados como Arial. Os métodos getFontFamily(offset) e setFontFamily(fontFamilyName) agora usam nomes de string para fontes em vez da enumeração FontFamily. Embora essa enumeração esteja descontinuada, ela vai continuar disponível para compatibilidade com scripts mais antigos.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the font of the first 4 characters in the tab's body to Roboto.
const text = body.editAsText().setFontFamily(0, 3, 'Roboto');

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`	O nome da família de fontes, do menu "Fonte" no Google Docs 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 "Fonte" no Google Docs ou do Google Fonts e diferencia maiúsculas de minúsculas. Nomes de fontes não reconhecidos serão renderizados como Arial. Os métodos getFontFamily() e setFontFamily(fontFamilyName) agora usam nomes de string para fontes em vez da enumeração FontFamily. Embora essa enumeração esteja descontinuada, ela vai continuar disponível para compatibilidade com scripts mais antigos.

Parâmetros

Nome	Tipo	Descrição
`fontFamilyName`	`String`	o nome da família de fontes, no menu "Fonte" do Google Docs ou no 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.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the size of the first 11 characters in the tab's body to 12.
const text = body.editAsText().setFontSize(0, 10, 12);

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 de primeiro plano para o intervalo de caracteres especificado.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the foreground color of the first 2 characters in the
// tab's body to hex color #FF0000.
const text = body.editAsText().setForegroundColor(0, 1, '#FF0000');

// Gets the foreground color for the second character in the tab's body.
const foregroundColor = text.getForegroundColor(1);

//  Logs the foreground color to the console.
console.log(foregroundColor);

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 na 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 de primeiro plano.

Parâmetros

Nome	Tipo	Descrição
`color`	`String`	a cor do primeiro plano, formatada na 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`	a 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.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to italic.
const text = body.editAsText().setItalic(0, 10, true);

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`	A 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.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Applies a link to the first 11 characters in the body.
const text = body.editAsText().setLinkUrl(0, 10, 'https://example.com');

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`	O 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`	o 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.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to strikethrough.
const text = body.editAsText().setStrikethrough(0, 10, true);

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 do texto.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Replaces the contents of the body with the text, 'New body text.'
const text = body.editAsText().setText('New body text.');

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	O novo conteúdo de 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 of the active tab be
// superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.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 in the active tab be superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const 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

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`	a 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 para o intervalo de caracteres especificado.

// Opens the Docs file by its URL. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the URL with your own.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/DOCUMENT_ID/edit',
);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Sets the first 11 characters in the tab's body to underline.
const text = body.editAsText().setUnderline(0, 10, true);

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`	A 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

Class Text Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Métodos

Documentação detalhada

appendText(text)

Parâmetros

Retornar

Autorização

copy()

Retornar

Autorização

deleteText(startOffset, endOffsetInclusive)

Parâmetros

Retornar

Autorização

editAsText()

Retornar

findText(searchPattern)

Parâmetros

Retornar

Autorização

findText(searchPattern, from)

Parâmetros

Retornar

Autorização

getAttributes()

Retornar

Autorização

getAttributes(offset)

Parâmetros

Retornar

Autorização

getBackgroundColor()

Retornar

Autorização

getBackgroundColor(offset)

Parâmetros

Retornar

Autorização

getFontFamily()

Retornar

Autorização

getFontFamily(offset)

Parâmetros

Retornar

Autorização

getFontSize()

Retornar

Autorização

getFontSize(offset)

Parâmetros

Retornar

Autorização

getForegroundColor()

Retornar

Autorização

getForegroundColor(offset)

Parâmetros

Retornar

Autorização

getLinkUrl()

Retornar

Autorização

getLinkUrl(offset)

Parâmetros

Retornar

Autorização

getNextSibling()

Retornar

Autorização

getParent()

Retornar

Autorização

getPreviousSibling()

Retornar

Autorização

getText()

Retornar

Autorização

getTextAlignment()

Retornar

Class Text

`appendText(text)`

`copy()`

`deleteText(startOffset, endOffsetInclusive)`

`editAsText()`

`findText(searchPattern)`

`findText(searchPattern, from)`

`getAttributes()`

`getAttributes(offset)`

`getBackgroundColor()`

`getBackgroundColor(offset)`

`getFontFamily()`

`getFontFamily(offset)`

`getFontSize()`

`getFontSize(offset)`

`getForegroundColor()`

`getForegroundColor(offset)`

`getLinkUrl()`

`getLinkUrl(offset)`

`getNextSibling()`

`getParent()`

`getPreviousSibling()`

`getText()`

`getTextAlignment()`

`getTextAlignment(offset)`

`getTextAttributeIndices()`

`getType()`

`insertText(offset, text)`

`isAtDocumentEnd()`

`isBold()`

`isBold(offset)`

`isItalic()`

`isItalic(offset)`

`isStrikethrough()`

`isStrikethrough(offset)`

`isUnderline()`

`isUnderline(offset)`

`merge()`

`removeFromParent()`

`replaceText(searchPattern, replacement)`

`setAttributes(startOffset, endOffsetInclusive, attributes)`

`setAttributes(attributes)`

`setBackgroundColor(startOffset, endOffsetInclusive, color)`

`setBackgroundColor(color)`