Cette page a été traduite par l'API Cloud Translation.

Class Position

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

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

Méthodes

Méthode	Type renvoyé	Brève description
`getElement()`	`Element`	Récupère l'élément contenant ce `Position`.
`getOffset()`	`Integer`	Récupère l'emplacement relatif de ce `Position` dans l'élément qui le contient.
`getSurroundingText()`	`Text`	Crée un élément `Text` artificiel qui représente le texte et la mise en forme du `Paragraph` ou `ListItem` qui contient le `Position`, soit directement, soit via une chaîne d'éléments enfants.
`getSurroundingTextOffset()`	`Integer`	Récupère le décalage de cet élément `Position` dans l'élément `Text` renvoyé par `getSurroundingText()`.
`insertBookmark()`	`Bookmark`	Crée et insère un nouveau `Bookmark` à cet `Position`.
`insertInlineImage(image)`	`InlineImage`	Crée et insère un nouveau `InlineImage` au niveau de cette `Position` à partir de l'image spécifiée blob.
`insertText(text)`	`Text`	Insère le texte spécifié à cet emplacement `Position`.

Documentation détaillée

`getElement()`

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

Renvois

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

`getOffset()`

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

Renvois

Integer : pour les éléments Text, nombre de caractères avant cet élément Position. pour autres éléments, le nombre d'éléments enfants avant ce Position au sein du même élément conteneur

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application 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 du Paragraph ou ListItem qui contient le 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 le Paragraph ou le ListItem contenant le Position, soit directement, soit via une chaîne d'éléments enfants

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

`getSurroundingTextOffset()`

Récupère le décalage de cet élément 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 cet élément Position dans l'élément Paragraph ou ListItem contenant le Position, soit directement, soit via une chaîne d'éléments enfants

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

`insertBookmark()`

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

Renvois

Bookmark : nouveau favori

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

`insertInlineImage(image)`

Crée et insère un nouveau InlineImage au niveau de cette Position à partir de l'image spécifiée blob.

Paramètres

Nom	Type	Description
`image`	`BlobSource`	les données d'image à insérer à cet emplacement (`Position`)

Renvois

InlineImage : nouvel élément image, ou null si l'élément dans lequel cette Position est ne permet pas l'insertion d'images

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

`insertText(text)`

Insère le texte spécifié à cet emplacement Position. Cette méthode crée un Text même si la chaîne est insérée dans un élément Text existant, de sorte qu'elle soit facile de styliser le nouvel élément.

Paramètres

Nom	Type	Description
`text`	`String`	Chaîne à insérer à cet emplacement (`Position`)

Renvois

Text : le nouvel élément de texte, ou null si l'élément dans lequel cette Position est ne permet pas l'insertion de texte

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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