Class Position

Posizione

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

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

Documentazione dettagliata

getElement()

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

Invio

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

getOffset()

Ottiene 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 che precedono Position (ovvero l'indice del carattere dopo questo Position); per qualsiasi altra , l'offset è il numero di elementi secondari prima di Position all'interno dell'elemento stesso elemento contenitore (ovvero, l'indice dell'elemento figlio dopo Position).

Invio

Integer: per elementi Text, il numero di caratteri che precedono Position; della altri elementi, il numero di elementi secondari prima di Position nello 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 dell'elemento Paragraph o ListItem che contiene Position, direttamente o tramite una catena di elementi secondari. Per determinare l'offset di Position nell'elemento Text restituito, usa getSurroundingTextOffset().

Invio

Text: un elemento equivalente al risultato della chiamata a 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 è il numero di caratteri che precedono Position (ovvero l'indice del carattere dopo Position).

Invio

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

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 questo Position dall'immagine specificata blob.

Parametri

NomeTipoDescrizione
imageBlobSourcei dati dell'immagine da inserire a questo Position

Invio

InlineImage: il nuovo elemento immagine o null se l'elemento in cui 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 Text anche se la stringa viene inserita all'interno di un elemento Text esistente, in modo che venga è facile applicare uno stile al nuovo elemento.

Parametri

NomeTipoDescrizione
textStringla stringa da inserire in questo Position

Invio

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