Class Document

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

É um documento que contém rich text e elementos como tabelas e listas.

É possível abrir ou criar documentos usando DocumentApp.

// Open a document by ID.
var doc = DocumentApp.openById("<my-id>");

// Create and open a document.
doc = DocumentApp.create("Document Title");

Métodos

MétodoTipo de retornoBreve descrição
addBookmark(position)BookmarkAdiciona uma Bookmark no Position especificado.
addEditor(emailAddress)DocumentAdiciona o usuário especificado à lista de editores do Document.
addEditor(user)DocumentAdiciona o usuário especificado à lista de editores do Document.
addEditors(emailAddresses)DocumentAdiciona a matriz de usuários especificada à lista de editores do Document.
addFooter()FooterSectionAdiciona uma seção de rodapé a um documento, se não houver nenhuma.
addHeader()HeaderSectionAdiciona uma seção de cabeçalho do documento, se não existir nenhuma.
addNamedRange(name, range)NamedRangeAdiciona um NamedRange, que é um Range com um nome e um ID a serem usados para recuperação posterior.
addViewer(emailAddress)DocumentAdiciona o usuário especificado à lista de visualizadores para o Document.
addViewer(user)DocumentAdiciona o usuário especificado à lista de visualizadores para o Document.
addViewers(emailAddresses)DocumentAdiciona a matriz de usuários especificada à lista de visualizadores para o Document.
getAs(contentType)BlobRecupera o conteúdo do Document atual como um blob do tipo especificado.
getBlob()BlobRecupera o conteúdo do Document atual como um blob.
getBody()BodyRecupera o Body do documento ativo.
getBookmark(id)BookmarkRecebe o Bookmark com o ID fornecido.
getBookmarks()Bookmark[]Recebe todos os objetos Bookmark no documento.
getCursor()PositionAcessa o cursor do usuário no documento ativo.
getEditors()User[]Recebe a lista de editores para esse Document.
getFooter()FooterSectionRecupera a seção de rodapé do documento, se houver.
getFootnotes()Footnote[]Recupera todos os elementos Footnote no corpo do documento.
getHeader()HeaderSectionRecupera a seção do cabeçalho do documento, se houver.
getId()StringRecupera o identificador exclusivo do documento.
getLanguage()StringRecebe o código de idioma do documento.
getName()StringRecupera o título do documento.
getNamedRangeById(id)NamedRangeRecebe o NamedRange com o ID fornecido.
getNamedRanges()NamedRange[]Recebe todos os objetos NamedRange no documento.
getNamedRanges(name)NamedRange[]Recebe todos os objetos NamedRange no documento com o nome fornecido.
getSelection()RangeRecebe a seleção do usuário no documento ativo.
getSupportedLanguageCodes()String[]Recebe todos os códigos de idioma compatíveis com arquivos do Documentos Google.
getUrl()StringRecupera o URL para acessar o documento atual.
getViewers()User[]Recebe a lista de leitores e comentaristas desta Document.
newPosition(element, offset)PositionCria um novo Position, que é uma referência a um local no documento, em relação a um elemento específico.
newRange()RangeBuilderCria um builder usado para construir objetos Range a partir de elementos do documento.
removeEditor(emailAddress)DocumentRemove o usuário em questão da lista de editores do Document.
removeEditor(user)DocumentRemove o usuário em questão da lista de editores do Document.
removeViewer(emailAddress)DocumentRemove o usuário da lista de leitores e comentaristas da Document.
removeViewer(user)DocumentRemove o usuário da lista de leitores e comentaristas da Document.
saveAndClose()voidSalva o Document atual.
setCursor(position)DocumentDefine o cursor do usuário no documento ativo, considerando um Position.
setLanguage(languageCode)DocumentDefine o código de idioma do documento.
setName(name)DocumentDefine o título do documento.
setSelection(range)DocumentDefine a seleção do usuário no documento ativo, considerando um Range.

Documentação detalhada

addBookmark(position)

Adiciona uma Bookmark no Position especificado.

Parâmetros

NomeTipoDescrição
positionPositiona posição do novo favorito

Retornar

Bookmark: o novo favorito

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

addEditor(emailAddress)

Adiciona o usuário especificado à lista de editores do Document. Se o usuário já estiver na lista de espectadores, esse método o promoverá fora da lista.

Parâmetros

NomeTipoDescrição
emailAddressStringEndereço de e-mail do usuário a ser adicionado.

Retornar

Document: este Document, para encadeamento.

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

addEditor(user)

Adiciona o usuário especificado à lista de editores do Document. Se o usuário já estiver na lista de espectadores, esse método o promoverá fora da lista.

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário a ser adicionado.

Retornar

Document: este Document, para encadeamento.

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

addEditors(emailAddresses)

Adiciona a matriz de usuários especificada à lista de editores do Document. Se algum dos usuários já estiver na lista de visualizadores, esse método os promoverá fora da lista de visualizadores.

Parâmetros

NomeTipoDescrição
emailAddressesString[]Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retornar

Document: este Document, para encadeamento.

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

addFooter()

Adiciona uma seção de rodapé a um documento, se não houver nenhuma.

Retornar

FooterSection: o rodapé 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

addHeader()

Adiciona uma seção de cabeçalho do documento, se não existir nenhuma.

Retornar

HeaderSection: o cabeçalho 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

addNamedRange(name, range)

Adiciona um NamedRange, que é um Range com um nome e um ID a serem usados para recuperação posterior. Os nomes não são necessariamente exclusivos. Vários intervalos diferentes no mesmo documento podem ter o mesmo nome, assim como uma classe no HTML. Por outro lado, os IDs são exclusivos no documento, como um ID em HTML. Depois de adicionar um NamedRange a um documento, não será possível modificá-lo, apenas removê-lo.

Qualquer script que acesse o documento pode acessar um NamedRange. Para evitar conflitos não planejados entre scripts, considere prefixar nomes de intervalo com uma string exclusiva.

// Creates a named range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.addNamedRange('Document tables', rangeBuilder.build());

Parâmetros

NomeTipoDescrição
nameStringO nome do intervalo, que não precisa ser exclusivo. Os nomes de intervalo precisam ter de 1 a 256 caracteres.
rangeRangeÉ o intervalo de elementos a serem associados ao nome. O intervalo pode ser a seleção ativa, um resultado da pesquisa ou ser criado manualmente com newRange().

Retornar

NamedRange: o NamedRange.

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

addViewer(emailAddress)

Adiciona o usuário especificado à lista de visualizadores para o Document. Esse método não terá efeito se o usuário já estiver na lista de editores.

Parâmetros

NomeTipoDescrição
emailAddressStringEndereço de e-mail do usuário a ser adicionado.

Retornar

Document: este Document, para encadeamento.

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

addViewer(user)

Adiciona o usuário especificado à lista de visualizadores para o Document. Esse método não terá efeito se o usuário já estiver na lista de editores.

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário a ser adicionado.

Retornar

Document: este Document, para encadeamento.

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

addViewers(emailAddresses)

Adiciona a matriz de usuários especificada à lista de visualizadores para o Document. Se algum dos usuários já estiver na lista de editores, esse método não vai ter efeito para eles.

Parâmetros

NomeTipoDescrição
emailAddressesString[]Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retornar

Document: este Document, para encadeamento.

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

getAs(contentType)

Recupera o conteúdo do Document atual como um blob do tipo especificado.

Parâmetros

NomeTipoDescrição
contentTypeStringO tipo MIME para conversão. Apenas 'application/pdf' é aceito.

Retornar

Blob: o documento atual como um blob


getBlob()

Recupera o conteúdo do Document atual como um blob.

Retornar

Blob: o documento atual como um blob


getBody()

Recupera o Body do documento ativo.

Os documentos podem conter diferentes tipos de seções (por exemplo, HeaderSection e FooterSection). A seção ativa de um documento é a Body.

Os métodos do elemento em Document delegam ao Body ativo.

Retornar

Body: a seção de corpo do documento ativo

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

getBookmark(id)

Recebe o Bookmark com o ID fornecido. Esse método vai retornar null se essa Bookmark não existir.

Parâmetros

NomeTipoDescrição
idStringo ID de Bookmark

Retornar

Bookmark: o Bookmark com o ID fornecido, ou null se esse Bookmark não existir

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

getBookmarks()

Recebe todos os objetos Bookmark no documento.

Retornar

Bookmark[]: uma matriz dos objetos Bookmark no 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

getCursor()

Acessa o cursor do usuário no documento ativo. Um script só pode acessar o cursor do usuário que está executando o script e somente se ele estiver vinculado ao documento.

// Insert some text at the cursor position and make it bold.
var cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's
  // containing element doesn't allow insertions, so show the user an error message.
  var element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Retornar

Position: uma representação do cursor do usuário, ou null se o usuário não tiver um cursor posicionado no documento ou se o script não estiver vinculado ao 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

getEditors()

Recebe a lista de editores para esse Document.

Retornar

User[]: uma matriz de usuários com permissão para ediçã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

getFooter()

Recupera a seção de rodapé do documento, se houver.

Retornar

FooterSection: o rodapé 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

getFootnotes()

Recupera todos os elementos Footnote no corpo do documento.

As chamadas para getFootnotes causam uma iteração nos elementos do documento. Para documentos grandes, evite chamadas desnecessárias para esse método.

Retornar

Footnote[]: as notas de rodapé 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

getHeader()

Recupera a seção do cabeçalho do documento, se houver.

Retornar

HeaderSection: o cabeçalho 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

getId()

Recupera o identificador exclusivo do documento. O ID do documento é usado com DocumentApp.openById() para abrir uma instância de documento específica.

Retornar

String: o ID 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

getLanguage()

Recebe o código de idioma do documento. Esse é o idioma mostrado no arquivo Arquivo > Idioma do editor de documentos, que pode não ser o mesmo idioma que o documento contém.

Retornar

String: o idioma do documento, ou null se não 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

getName()

Recupera o título do documento.

Retornar

String: o título 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

getNamedRangeById(id)

Recebe o NamedRange com o ID fornecido. Esse método vai retornar null se esse NamedRange não existir. Os nomes não são necessariamente exclusivos. Vários intervalos diferentes no mesmo documento podem ter o mesmo nome, assim como uma classe no HTML. Por outro lado, os IDs são exclusivos no documento, como um ID em HTML.

Parâmetros

NomeTipoDescrição
idStringo ID do intervalo, que é exclusivo no documento.

Retornar

NamedRange: o NamedRange com o ID fornecido, ou null se esse intervalo não existir

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

getNamedRanges()

Recebe todos os objetos NamedRange no documento.

Um NamedRange pode ser acessado por qualquer script que acesse o documento. Para evitar conflitos não planejados entre scripts, considere prefixar nomes de intervalo com uma string exclusiva.

Retornar

NamedRange[]: uma matriz dos objetos NamedRange no documento, possivelmente incluindo vários intervalos com o mesmo nome.

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

getNamedRanges(name)

Recebe todos os objetos NamedRange no documento com o nome fornecido. Os nomes não são necessariamente exclusivos. Vários intervalos diferentes no mesmo documento podem ter o mesmo nome, assim como uma classe no HTML. Por outro lado, os IDs são exclusivos no documento, como um ID em HTML.

Um NamedRange pode ser acessado por qualquer script que acesse o documento. Para evitar conflitos não planejados entre scripts, considere prefixar nomes de intervalo com uma string exclusiva.

Parâmetros

NomeTipoDescrição
nameStringo nome do intervalo, que não é necessariamente exclusivo

Retornar

NamedRange[]: uma matriz dos objetos NamedRange no documento com o nome fornecido

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

getSelection()

Recebe a seleção do usuário no documento ativo. Um script só pode acessar a seleção do usuário que está executando o script e somente se ele estiver vinculado ao documento.

// Display a dialog box that tells the user how many elements are included in the selection.
var selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  var elements = selection.getRangeElements();
  DocumentApp.getUi().alert('Number of selected elements: ' + elements.length);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

Retornar

Range: uma representação da seleção do usuário, ou null se o usuário não tiver nada selecionado no documento, se apenas o final de um parágrafo for selecionado, se apenas o final de um parágrafo e uma nova linha forem selecionados ou se o script não estiver vinculado ao 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

getSupportedLanguageCodes()

Recebe todos os códigos de idioma compatíveis com arquivos do Documentos Google.

Retornar

String[]: uma matriz de códigos de idioma.

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

getUrl()

Recupera o URL para acessar o documento atual.

var doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail("<email-address>", doc.getName(), doc.getUrl());

Retornar

String: o URL para acessar o documento 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

getViewers()

Recebe a lista de leitores e comentaristas desta Document.

Retornar

User[]: uma matriz de usuários com permissão para visualização ou comentário.

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

newPosition(element, offset)

Cria um novo Position, que é uma referência a um local no documento, em relação a um elemento específico. O cursor do usuário é representado como um Position, entre outros usos.

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var doc = DocumentApp.getActiveDocument();
var paragraph = doc.getBody().appendParagraph('My new paragraph.');
var position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parâmetros

NomeTipoDescrição
elementElemento elemento que conterá o novo Position; precisa ser um elemento Text ou um elemento contêiner como Paragraph
offsetIntegerpara elementos Text, o número de caracteres antes do Position; para outros elementos, o número de elementos filhos antes do Position no mesmo elemento de contêiner

Retornar

Position: o novo Position

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

newRange()

Cria um builder usado para construir objetos Range a partir de elementos do documento.

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Retornar

RangeBuilder: o novo builder

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

removeEditor(emailAddress)

Remove o usuário em questão da lista de editores do Document. Esse método não impede que os usuários acessem o Document se pertencerem a uma classe de usuários com acesso geral, por exemplo, se o Document for compartilhado com todo o domínio do usuário ou se Document estiver em um drive compartilhado que o usuário possa acessar.

No caso de arquivos do Drive, isso também remove o usuário da lista de leitores.

Parâmetros

NomeTipoDescrição
emailAddressStringEndereço de e-mail do usuário a ser removido.

Retornar

Document: este Document, para encadeamento.

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

removeEditor(user)

Remove o usuário em questão da lista de editores do Document. Esse método não impede que os usuários acessem o Document se pertencerem a uma classe de usuários com acesso geral, por exemplo, se o Document for compartilhado com todo o domínio do usuário ou se Document estiver em um drive compartilhado que o usuário possa acessar.

No caso de arquivos do Drive, isso também remove o usuário da lista de leitores.

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário a ser removido.

Retornar

Document: este Document, para encadeamento.

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

removeViewer(emailAddress)

Remove o usuário da lista de leitores e comentaristas da Document. Esse método não terá efeito se o usuário for um editor, não um leitor ou comentarista. Esse método também não impede que os usuários acessem o Document se pertencerem a uma classe de usuários que tenham acesso geral, por exemplo, se o Document for compartilhado com todo o domínio do usuário ou se Document estiver em um drive compartilhado que o usuário possa acessar.

Nos arquivos do Drive, essa ação também remove o usuário da lista de editores.

Parâmetros

NomeTipoDescrição
emailAddressStringEndereço de e-mail do usuário a ser removido.

Retornar

Document: este Document para encadeamentos.

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

removeViewer(user)

Remove o usuário da lista de leitores e comentaristas da Document. Esse método não terá efeito se o usuário for um editor, não um leitor. Esse método também não impede que os usuários acessem o Document se pertencerem a uma classe de usuários com acesso geral. Por exemplo, se o Document for compartilhado com todo o domínio do usuário ou se o Document estiver em um drive compartilhado que o usuário pode acessar.

Nos arquivos do Drive, essa ação também remove o usuário da lista de editores.

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário a ser removido.

Retornar

Document: este Document para encadeamentos.

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

saveAndClose()

Salva o Document atual. Faz com que as atualizações pendentes sejam removidas e aplicadas.

O método saveAndClose() é invocado automaticamente no final da execução do script para cada Document editável aberto.

Não é possível editar um Document fechado. Use DocumentApp.openById() para reabrir um determinado documento para ediçã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

setCursor(position)

Define o cursor do usuário no documento ativo, considerando um Position. Um script só pode acessar o cursor do usuário que o está executando e somente se o script estiver vinculado ao documento.

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var doc = DocumentApp.getActiveDocument();
var paragraph = doc.getBody().appendParagraph('My new paragraph.');
var position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parâmetros

NomeTipoDescrição
positionPositiona nova localização do cursor

Retornar

Document: este Document para encadeamentos

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

setLanguage(languageCode)

Define o código de idioma do documento. Esse é o idioma mostrado no arquivo Arquivo > Idioma do editor de documentos, que pode não ser o mesmo idioma que o documento contém. Use getSupportedLanguageCodes() para receber todos os códigos de idioma válidos.

Parâmetros

NomeTipoDescrição
languageCodeStringO código do idioma.

Retornar

Document: este Document, para encadeamento.

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

setName(name)

Define o título do documento.

Parâmetros

NomeTipoDescrição
nameStringo título do novo documento

Retornar

Document: o documento 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

setSelection(range)

Define a seleção do usuário no documento ativo, considerando um Range. Um script só pode acessar a seleção do usuário que o está executando e somente se o script estiver vinculado ao documento.

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Parâmetros

NomeTipoDescrição
rangeRangeo novo intervalo de elementos a ser selecionado

Retornar

Document: este Document para encadeamentos

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