Class Position

Position

Référence à un emplacement dans l'onglet du document, par rapport à un élément spécifique. Le curseur de l'utilisateur est représenté par un Position, entre autres. Les scripts ne peuvent accéder au curseur de l'utilisateur qui exécute le script que si le script est lié au document. 

// 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.');
}

Méthodes

MéthodeType renvoyéBrève description
getElement()ElementRécupère l'élément qui contient ce Position.
getOffset()IntegerObtient l'emplacement relatif de ce Position dans l'élément qui le contient.
getSurroundingText()TextCrée un élément Text artificiel qui représente le texte et la mise en forme de Paragraph ou ListItem contenant Position, directement ou via une chaîne d'éléments enfants.
getSurroundingTextOffset()IntegerObtient le décalage de ce Position dans l'élément Text renvoyé par getSurroundingText().
insertBookmark()BookmarkCrée et insère un Bookmark à ce Position.
insertInlineImage(image)InlineImage|nullCrée et insère un InlineImage à ce Position à partir du blob d'image spécifié.
insertText(text)Text|nullInsère le texte spécifié à cet Position.

Documentation détaillée

getElement()

Récupère l'élément qui contient ce Position. Il s'agit d'un élément Text ou d'un élément de conteneur tel que Paragraph. Dans les deux cas, la position relative dans l'élément peut être déterminée avec getOffset().

Renvois

Element : élément conteneur ou Text dans lequel se trouve cet objet Position

getOffset()

Obtient l'emplacement relatif de ce Position dans l'élément qui le contient. Si l'élément est un élément Text, le décalage correspond au nombre de caractères avant le Position (c'est-à-dire l'index du caractère après ce Position). Pour tout autre élément, le décalage correspond au nombre d'éléments enfants avant ce Position dans le même élément conteneur (c'est-à-dire l'index de l'élément enfant après le Position).

Renvois

Integer : pour les éléments Text, nombre de caractères avant ce Position ; pour les autres éléments, nombre d'éléments enfants avant ce Position dans le même élément conteneur

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSurroundingText()

Crée un élément Text artificiel qui représente le texte et la mise en forme de Paragraph ou ListItem contenant Position, directement ou via une chaîne d'éléments enfants. Pour déterminer le décalage de Position dans l'élément Text renvoyé, utilisez getSurroundingTextOffset().

Renvois

Text : élément équivalent au résultat de l'appel de editAsText() sur Paragraph ou ListItem contenant Position, directement ou via une chaîne d'éléments enfants

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSurroundingTextOffset()

Obtient le décalage de ce Position dans l'élément Text renvoyé par getSurroundingText(). Le décalage correspond au nombre de caractères avant Position (c'est-à-dire l'index du caractère après Position).

Renvois

Integer : nombre de caractères avant ce Position dans le Paragraph ou le ListItem contenant le Position, directement ou via une chaîne d'éléments enfants

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertBookmark()

Crée et insère un Bookmark à ce Position.

Renvois

Bookmark : le nouveau favori

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertInlineImage(image)

Crée et insère un InlineImage à ce Position à partir du blob d'image spécifié.

Paramètres

NomTypeDescription
imageBlobSourceDonnées d'image à insérer à cet Position

Renvois

InlineImage|null : nouvel élément d'image, ou null si l'élément dans lequel se trouve ce Position ne permet pas d'insérer des images

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertText(text)

Insère le texte spécifié à cet Position. Cette méthode crée un élément Text, même si la chaîne est insérée dans un élément Text existant, afin de faciliter la mise en forme du nouvel élément.

Paramètres

NomTypeDescription
textStringChaîne à insérer à ce Position

Renvois

Text|null : nouvel élément de texte, ou null si l'élément dans lequel se trouve ce Position ne permet pas d'insérer du texte

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents