Uma referência a um local na guia do documento, relativo a um elemento específico. O cursor do usuário
é representado como Position
, entre outros usos. Os scripts só podem acessar o cursor do elemento
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.'); }
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getElement() | Element | Recebe o elemento que contém esse Position . |
getOffset() | Integer | Recebe a localização relativa desse Position no elemento que o contém. |
getSurroundingText() | Text | Cria um elemento Text artificial que representa o texto e a formatação da
Paragraph ou 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 da imagem especificada
blob. |
insertText(text) | Text | Insere o texto especificado no Position . |
Documentação detalhada
getElement()
Recebe o elemento que contém esse Position
. Isso pode ser Text
de contêiner ou um elemento de contêiner, como Paragraph
. Em ambos os casos, o objeto
a posição no elemento pode ser determinada com getOffset()
.
Retornar
Element
: o contêiner ou elemento Text
em que esse objeto Position
está localizado.
getOffset()
Recebe a localização relativa desse Position
no elemento que o contém. Se o
é um elemento Text
, o deslocamento é o número de caracteres antes da Position
(ou seja, o índice do caractere após esse Position
); para qualquer outro
elemento, o deslocamento é o número de elementos filhos antes deste Position
dentro dos
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 desse Position
. para
outros elementos, o número de elementos filhos antes desse Position
dentro do mesmo
elemento do contêiner
Autorização
Os scripts que usam esse método precisam de 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 da
Paragraph
ou ListItem
que contém o Position
, seja diretamente ou por uma cadeia de elementos filhos. Para determinar o deslocamento de Position
no elemento Text
retornado, use getSurroundingTextOffset()
.
Retornar
Text
: um elemento equivalente ao resultado da chamada de editAsText()
.
no 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 precisam de 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 do Position
(ou seja, o índice do caractere após este Position
).
Retornar
Integer
: o número de caracteres antes desse Position
na Paragraph
ou no ListItem
que contém o Position
, seja diretamente ou por meio de uma cadeia de elementos filhos
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertBookmark()
insertInlineImage(image)
Cria e insere um novo InlineImage
neste Position
da imagem especificada
blob.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
image | BlobSource | os dados da imagem a serem inseridos neste Position |
Retornar
InlineImage
: o novo elemento de imagem, ou null
se o elemento em que esse Position
está
localizado não permite a inserção de imagens
Autorização
Os scripts que usam esse método precisam de 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 no Position
. Esse método cria um novo objeto Text
.
mesmo que a string seja inserida em um elemento Text
já existente, para que seja
fácil de estilizar o 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 este Position
está
localizado não permite a inserção de texto
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents