Esta página foi traduzida pela API Cloud Translation.

Class Position

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

Métodos

Método	Tipo de retorno	Breve descrição
`getElement()`	`Element`	Recebe o elemento que contém esse `Position`.
`getOffset()`	`Integer`	Recebe o local relativo deste `Position` no elemento que o contém.
`getSurroundingText()`	`Text`	Crie um elemento `Text` artificial que represente o texto e a formatação da `Paragraph` ou do `ListItem` que contém o `Position`, seja diretamente ou por uma cadeia de elementos filhos.
`getSurroundingTextOffset()`	`Integer`	Recebe o deslocamento desse `Position` no elemento `Text` retornado por `getSurroundingText()`.
`insertBookmark()`	`Bookmark`	Cria e insere um novo `Bookmark` neste `Position`.
`insertInlineImage(image)`	`InlineImage`	Cria e insere um novo `InlineImage` neste `Position` usando o blob de imagem especificado.
`insertText(text)`	`Text`	Insere o texto especificado neste `Position`.

Documentação detalhada

`getElement()`

Recebe o elemento que contém esse Position. Ele será um elemento Text ou um contêiner como Paragraph. Nos dois casos, a posição relativa no elemento pode ser determinada com getOffset().

Retornar

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

`getOffset()`

Recebe o local relativo deste Position no elemento que o contém. Se o elemento for Text, o deslocamento será o número de caracteres antes de Position (ou seja, o índice do caractere após este Position). Para qualquer outro elemento, o deslocamento será o número de elementos filhos antes desse Position dentro do mesmo elemento de contêiner (ou seja, o índice do elemento filho após o Position).

Retornar

Integer: para elementos Text, o número de caracteres antes dessa Position. Para outros elementos, o número de elementos filhos antes desta Position no mesmo elemento do 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()`

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

Retornar

Text: um elemento equivalente ao resultado da chamada de editAsText() em Paragraph ou ListItem que contém 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 desse Position no elemento Text retornado por getSurroundingText(). O deslocamento é o número de caracteres antes da Position, ou seja, o índice do caractere após essa Position.

Retornar

Integer: o número de caracteres antes desta Position na Paragraph ou no ListItem que contém a Position, seja 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 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

`insertInlineImage(image)`

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

Parâmetros

Nome	Tipo	Descrição
`image`	`BlobSource`	os dados de imagem a serem inseridos neste `Position`

Retornar

InlineImage: o novo elemento de imagem, ou null se o elemento em que Position está localizado não permitir que as imagens sejam inseridas.

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 já existente, para que seja fácil de definir o estilo do novo elemento.

Parâmetros

Nome	Tipo	Descrição
`text`	`String`	a string a ser inserida neste `Position`

Retornar

Text: o novo elemento de texto, ou null se o elemento em que Position estiver localizado não permitir que o texto seja inserido.

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