Class Position

Posizione

Un riferimento a una posizione nella scheda del documento, relativa a un elemento specifico. Il cursore dell'utente è rappresentato come Position, tra gli altri usi. Gli script possono accedere solo al cursore dell'utente che lo esegue e solo se lo script è legato al 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.');
}

Metodi

Metodo	Tipo restituito	Breve descrizione
getElement()	Element	Recupera l'elemento che contiene questo Position.
getOffset()	Integer	Recupera la posizione relativa di questo Position all'interno dell'elemento che lo contiene.
getSurroundingText()	Text	Crea un elemento Text artificiale che rappresenta il testo e la formattazione del Paragraph o del ListItem contenente il Position, direttamente o tramite una catena di elementi secondari.
getSurroundingTextOffset()	Integer	Recupera l'offset di questo 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 questa posizione Position del blob di immagini specificato.
insertText(text)	Text	Consente di inserire il testo specificato in questa posizione Position.

Documentazione dettagliata

getElement()

Recupera l'elemento che contiene questo Position. Può essere 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().

Invio

Element: l'elemento contenitore o Text in cui si trova questo oggetto Position

---

getOffset()

Recupera la posizione relativa di questo Position all'interno dell'elemento che lo contiene. Se l'elemento è un elemento Text, l'offset è il numero di caratteri prima di Position (ovvero l'indice del carattere dopo questo Position); per qualsiasi altro elemento, l'offset è il numero di elementi secondari prima di questo Position all'interno dello stesso elemento contenitore (ovvero l'indice dell'elemento secondario dopo Position).

Invio

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 del Paragraph o del ListItem contenente il Position, direttamente o tramite una catena di elementi secondari. Per determinare l'offset di Position nell'elemento Text restituito, utilizza getSurroundingTextOffset().

Invio

Text: un elemento equivalente al risultato della chiamata di editAsText() nell'elemento Paragraph o ListItem contenente 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()

Recupera l'offset di questo Position all'interno dell'elemento Text restituito da getSurroundingText(). L'offset è il numero di caratteri prima di Position (ovvero l'indice del carattere dopo questo Position).

Invio

Integer: il numero di caratteri prima di questo Position nell'elemento 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.

Invio

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 questa posizione Position del blob di immagini specificato.

Parametri

Nome	Tipo	Descrizione
image	BlobSource	i dati dell'immagine da inserire in questo Position

Invio

InlineImage: il nuovo elemento immagine o null se l'elemento in cui si trova questo 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)

Consente di inserire il testo specificato in questa posizione Position. Questo metodo crea un nuovo elemento Text anche se la stringa viene inserita in un elemento Text esistente, in modo da semplificare la definizione dello stile del nuovo elemento.

Parametri

Nome	Tipo	Descrizione
text	String	la stringa da inserire in questo Position

Invio

Text: il nuovo elemento di testo o null se l'elemento in cui si trova questo 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