Class RangeElement

Élément de plage

Encapsulement d'un Element avec un décalage de début et de fin possible. Ces décalages permettent de représenter une plage de caractères dans un élément Text dans les résultats de recherche, les sélections de documents et les plages nommées.

Méthodes

MéthodeType renvoyéBrève description
getElement()ElementRécupère la Element correspondant à cette RangeElement.
getEndOffsetInclusive()IntegerRécupère la position de fin d'une plage partielle dans l'élément de plage.
getStartOffset()IntegerRécupère la position de début d'une plage partielle dans l'élément de plage.
isPartial()BooleanDétermine si cet élément de plage couvre l'élément entier ou une sélection partielle des caractères de l'élément.

Documentation détaillée

getElement()

Récupère la Element correspondant à cette RangeElement. 

const rangeElement = DocumentApp.getActiveDocument().getSelection().getRangeElements()[0];

// Log debug information about a range element.
Logger.log(`Element type: ${rangeElement.getElement().getType()}`);
if (rangeElement.isPartial()) {
  Logger.log(`The character range begins at ${rangeElement.getStartOffset()}`);
  Logger.log(
      `The character range ends at ${rangeElement.getEndOffsetInclusive()}`,
  );
} else {
  Logger.log('The entire range element is included.');
}

Renvois

Element : élément correspondant à cet élément RangeElement

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

getEndOffsetInclusive()

Récupère la position de fin d'une plage partielle dans l'élément de plage. Si l'élément est un élément Text et que isPartial() renvoie true, le décalage correspond au nombre de caractères avant le dernier caractère de la plage (c'est-à-dire l'index du dernier caractère de la plage). Dans tous les autres cas, cette méthode renvoie -1.

Renvois

Integer : pour les éléments Text, nombre de caractères avant le dernier caractère de la plage ; pour les autres éléments, -1

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

getStartOffset()

Récupère la position de début d'une plage partielle dans l'élément de plage. Si l'élément est un élément Text et que isPartial() renvoie true, le décalage correspond au nombre de caractères avant le début de la plage (c'est-à-dire l'index du premier caractère de la plage). Dans tous les autres cas, cette méthode renvoie -1.

Renvois

Integer : pour les éléments Text, nombre de caractères avant le début de la plage ; pour les autres éléments, -1

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

isPartial()

Détermine si cet élément de plage couvre l'élément entier ou une sélection partielle des caractères de l'élément. Le début et la fin de la plage d'un élément de plage partielle peuvent être déterminés à l'aide de getStartOffset() et getEndOffsetInclusive(), respectivement.

Renvois

Boolean : true si l'élément est partiellement inclus, false sinon

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