Class Position

Posição

Uma referência a um local na guia do documento, em relação a um elemento específico. O cursor do usuário é representado como um Position, entre outros usos. Os scripts só podem acessar o cursor do usuário que está executando o script e somente se o script estiver vinculado ao documento. 

// Insert some text at the cursor position and make it bold.
const 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.
  const element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Métodos

MétodoTipo de retornoBreve descrição
getElement()ElementRecebe o elemento que contém este Position.
getOffset()IntegerRecebe a localização relativa deste Position no elemento que o contém.
getSurroundingText()TextCria um elemento Text artificial que representa o texto e a formatação do Paragraph ou ListItem que contém o Position, diretamente ou por uma cadeia de elementos filhos.
getSurroundingTextOffset()IntegerRecebe o deslocamento deste Position no elemento Text retornado por getSurroundingText().
insertBookmark()BookmarkCria e insere um novo Bookmark neste Position.
insertInlineImage(image)InlineImage|nullCria e insere um novo InlineImage neste Position do blob de imagem especificado.
insertText(text)Text|nullInsere o texto especificado neste Position.

Documentação detalhada

getElement()

Recebe o elemento que contém este Position. Ele será um elemento Text ou um elemento de contêiner, como Paragraph. Em qualquer caso, a posição relativa dentro do elemento pode ser determinada com getOffset().

Retornar

Element: o contêiner ou elemento Text em que o objeto Position está localizado

getOffset()

Recebe a localização relativa deste Position no elemento que o contém. Se o elemento for um Text, o ajuste será o número de caracteres antes do Position (ou seja, o índice do caractere após esse Position). Para qualquer outro elemento, o ajuste será o número de elementos filhos antes desse Position no mesmo elemento contêiner (ou seja, o índice do elemento filho após o Position).

Retornar

Integer: para elementos Text, o número de caracteres antes deste Position; para outros elementos, o número de elementos filhos antes deste Position no mesmo elemento contêiner.

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

getSurroundingText()

Cria um elemento Text artificial que representa o texto e a formatação do Paragraph ou ListItem que contém o Position, diretamente ou por uma cadeia de elementos filhos. Para determinar o deslocamento do Position no elemento Text retornado, use getSurroundingTextOffset().

Retornar

Text: um elemento equivalente ao resultado da chamada de editAsText() no Paragraph ou ListItem que contém o Position, diretamente ou por uma cadeia de elementos filhos.

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

getSurroundingTextOffset()

Recebe o deslocamento deste Position no elemento Text retornado por getSurroundingText(). O deslocamento é o número de caracteres antes do Position (ou seja, o índice do caractere após esse Position).

Retornar

Integer: o número de caracteres antes deste Position no Paragraph ou ListItem que contém o Position, diretamente ou por uma cadeia de elementos filhos.

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

insertBookmark()

Cria e insere um novo Bookmark neste Position.

Retornar

Bookmark: o novo marcador

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

insertInlineImage(image)

Cria e insere um novo InlineImage neste Position do blob de imagem especificado.

Parâmetros

NomeTipoDescrição
imageBlobSourceos dados de imagem a serem inseridos neste Position

Retornar

InlineImage|null: o novo elemento de imagem ou null se o elemento em que este Position está localizado não permitir a inserção de imagens.

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

Insere o texto especificado neste Position. Esse método cria um novo elemento Text, mesmo que a string seja inserida em um elemento Text existente, para facilitar a estilização do novo elemento.

Parâmetros

NomeTipoDescrição
textStringa string a ser inserida neste Position

Retornar

Text|null: o novo elemento de texto ou null se o elemento em que este Position está localizado não permitir a inserção 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