Un riferimento a una posizione nel documento rispetto a un elemento specifico. Il cursore dell'utente è
rappresentato come Position
, tra gli altri utilizzi. Gli script possono accedere solo al cursore dell'utente che lo esegue e solo se sono associati al 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.'); }
Metodi
Metodo | Tipo restituito | Breve descrizione |
---|---|---|
getElement() | Element | Recupera l'elemento che contiene Position . |
getOffset() | Integer | Recupera la posizione relativa di questo elemento Position nell'elemento che lo contiene. |
getSurroundingText() | Text | Crea un elemento Text artificiale che rappresenta il testo e la formattazione di
Paragraph o ListItem che contiene Position , direttamente o attraverso una catena di elementi secondari. |
getSurroundingTextOffset() | Integer | Restituisce l'offset di Position all'interno dell'elemento Text restituito da getSurroundingText() . |
insertBookmark() | Bookmark | Crea e inserisce un nuovo Bookmark in questo Position . |
insertInlineImage(image) | InlineImage | Crea e inserisce un nuovo InlineImage in questo Position dal blob di immagine specificato. |
insertText(text) | Text | Inserisce il testo specificato in questo Position . |
Documentazione dettagliata
getElement()
Recupera l'elemento che contiene Position
. Sarà un elemento Text
o un elemento contenitore come Paragraph
. In entrambi i casi, la posizione relativa
all'interno dell'elemento può essere determinata con getOffset()
.
Ritorni
Element
: il contenitore o l'elemento Text
in cui si trova l'oggetto Position
getOffset()
Recupera la posizione relativa di questo elemento Position
nell'elemento che lo contiene. Se l'elemento è un elemento Text
, l'offset corrisponde al numero di caratteri che precedono Position
(ovvero, l'indice del carattere dopo questo Position
); per ogni altro elemento, l'offset corrisponde al numero di elementi secondari prima di questo Position
all'interno dello stesso elemento contenitore (ossia l'indice dell'elemento secondario dopo Position
).
Ritorni
Integer
: per gli elementi Text
, il numero di caratteri prima di questo Position
; per gli altri elementi, il numero di elementi secondari prima di questo Position
all'interno dello stesso elemento contenitore
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSurroundingText()
Crea un elemento Text
artificiale che rappresenta il testo e la formattazione di
Paragraph
o ListItem
che contiene Position
, direttamente o attraverso una catena di elementi secondari. Per determinare l'offset di Position
nell'elemento Text
restituito, utilizza getSurroundingTextOffset()
.
Ritorni
Text
: un elemento equivalente al risultato della chiamata di editAsText()
in Paragraph
o ListItem
che contiene Position
, direttamente o tramite una catena di elementi secondari
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSurroundingTextOffset()
Restituisce l'offset di Position
all'interno dell'elemento Text
restituito da getSurroundingText()
. L'offset corrisponde al numero di caratteri che precedono Position
, ovvero l'indice del carattere dopo questo Position
.
Ritorni
Integer
: il numero di caratteri che precedono questo Position
nel campo Paragraph
o ListItem
che contiene Position
, direttamente o tramite una catena di elementi secondari
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertBookmark()
Crea e inserisce un nuovo Bookmark
in questo Position
.
Ritorni
Bookmark
: il nuovo preferito
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertInlineImage(image)
Crea e inserisce un nuovo InlineImage
in questo Position
dal blob di immagine specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
image | BlobSource | i dati immagine da inserire a questo Position |
Ritorni
InlineImage
: il nuovo elemento immagine oppure null
se l'elemento in cui si trova Position
non consente l'inserimento di immagini
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertText(text)
Inserisce il testo specificato in questo Position
. Questo metodo crea un nuovo elemento Text
, anche se la stringa viene inserita all'interno di un elemento Text
esistente, in modo che sia facile definire lo stile del nuovo elemento.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | String | la stringa da inserire in questo Position |
Ritorni
Text
: il nuovo elemento di testo oppure null
se l'elemento in cui si trova Position
non consente l'inserimento di testo
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents