Class Position

Posizione

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

MetodoTipo restituitoBreve descrizione
getElement()ElementRecupera l'elemento che contiene questa Position.
getOffset()IntegerRecupera la posizione relativa di questa Position all'interno dell'elemento che la contiene.
getSurroundingText()TextCrea un elemento artificiale Text che rappresenta il testo e la formattazione di Paragraph o ListItem che contiene Position, direttamente o tramite una catena di elementi secondari.
getSurroundingTextOffset()IntegerRecupera l'offset di questo Position all'interno dell'elemento Text restituito da getSurroundingText().
insertBookmark()BookmarkCrea e inserisce un nuovo Bookmark in questa Position.
insertInlineImage(image)InlineImage|nullCrea e inserisce un nuovo InlineImage in questo Position dal blob di immagine specificato.
insertText(text)Text|nullInserisce il testo specificato in questa Position.

Documentazione dettagliata

getElement()

Recupera l'elemento che contiene questa Position. Si tratta di un elemento Text o di un elemento contenitore come Paragraph. In entrambi i casi, la posizione relativa all'interno dell'elemento può essere determinata con getOffset().

Indietro

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

getOffset()

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

Indietro

Integer : per gli elementi Text, il numero di caratteri prima di questa Position; per altri elementi, il numero di elementi secondari prima di questa 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 la Position, direttamente o tramite una catena di elementi secondari. Per determinare l'offset di Position nell'elemento Text restituito, utilizza getSurroundingTextOffset().

Indietro

Text : un elemento equivalente al risultato della chiamata di editAsText() su Paragraph o ListItem che contiene la 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 della Position (ovvero l'indice del carattere dopo questa Position).

Indietro

Integer : il numero di caratteri prima di questa Position in Paragraph o ListItem che contiene la 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 questa Position.

Indietro

Bookmark : il nuovo segnalibro

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 una nuova InlineImage in questa Position dal blob di immagine specificato.

Parametri

NomeTipoDescrizione
imageBlobSourcei dati dell'immagine da inserire in questa Position

Indietro

InlineImage|null : il nuovo elemento immagine o null se l'elemento in cui si trova questo Position è situato 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 questa Position. Questo metodo crea un nuovo Text elemento, anche se la stringa viene inserita all'interno di un elemento Text esistente, in modo che sia facile applicare lo stile al nuovo elemento.

Parametri

NomeTipoDescrizione
textStringla stringa da inserire in questa Position

Indietro

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