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. Le curseur de l'utilisateur est représenté par un Position, entre autres utilisations. Les scripts ne peuvent accéder qu'au curseur de l'utilisateur qui exécute le script, et uniquement 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éthode	Type renvoyé	Brève description
`getElement()`	`Element`	Récupère l'élément qui contient cette `Position`.
`getOffset()`	`Integer`	Récupère la position relative de cet élément `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 du `ListItem` contenant le `Position`, directement ou 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 `Bookmark` à cet emplacement `Position`.
`insertInlineImage(image)`	`InlineImage`	Crée et insère un `InlineImage` à cet emplacement `Position` à partir du blob d'image spécifié.
`insertText(text)`	`Text`	Insère le texte spécifié à cet emplacement `Position`.

Documentation détaillée

`getElement()`

Récupère l'élément qui contient cette 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 : conteneur ou élément Text dans lequel se trouve cet objet Position

`getOffset()`

Récupère la position relative de cet élément 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 Position (c'est-à-dire l'indice du caractère après Position). Pour tout autre élément, le décalage correspond au nombre d'éléments enfants avant Position dans le même élément conteneur (c'est-à-dire l'indice 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 les autres éléments, nombre d'éléments enfants avant cet élément Position au sein du même élément conteneur

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 du ListItem contenant 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, 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 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 le Position (c'est-à-dire l'index du caractère après ce Position).

Renvois

Integer : nombre de caractères avant cet élément Position dans l'élément Paragraph ou ListItem qui le contient, directement ou via une chaîne d'éléments enfantsPosition

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 Bookmark à cet emplacement Position.

Renvois

Bookmark : nouveau favori

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 InlineImage à cet emplacement Position à partir du blob d'image spécifié.

Paramètres

Nom	Type	Description
`image`	`BlobSource`	les données d'image à insérer à cet élément `Position`

Renvois

InlineImage : nouvel élément d'image, ou null si l'élément dans lequel se trouve cet élément Position n'autorise pas l'insertion d'images

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 élément Text, même si la chaîne est insérée dans un élément Text existant, afin de pouvoir facilement styliser le nouvel élément.

Paramètres

Nom	Type	Description
`text`	`String`	la chaîne à insérer à cet emplacement `Position`

Renvois

Text : nouvel élément de texte, ou null si l'élément dans lequel se trouve cet élément Position n'autorise pas l'insertion de texte

Autorisation

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

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