Class RangeList

Collection d'une ou de plusieurs instances Range dans la même feuille. Vous pouvez utiliser cette classe pour appliquer des opérations sur des collections de plages ou de cellules non adjacentes.

Méthodes

Méthode	Type renvoyé	Brève description
`activate()`	`RangeList`	Sélectionne la liste des instances `Range`.
`breakApart()`	`RangeList`	Sépare à nouveau toutes les cellules fusionnées horizontalement ou verticalement contenues dans la liste de plages.
`check()`	`RangeList`	Définit l'état des cases à cocher de la plage sur "coché".
`clear()`	`RangeList`	Efface le contenu, les formats et les règles de validation des données pour chaque `Range` de la liste de plages.
`clear(options)`	`RangeList`	Efface le contenu, le format, les règles de validation des données et les commentaires de la plage, comme spécifié dans les options fournies.
`clearContent()`	`RangeList`	Efface le contenu de chaque `Range` de la liste de plages, en conservant la mise en forme.
`clearDataValidations()`	`RangeList`	Efface les règles de validation des données pour chaque `Range` de la liste de plages.
`clearFormat()`	`RangeList`	Efface la mise en forme du texte pour chaque `Range` de la liste de plages.
`clearNote()`	`RangeList`	Efface la note pour chaque `Range` de la liste de plages.
`getRanges()`	`Range[]`	Renvoie une liste d'une ou plusieurs instances `Range` dans la même feuille.
`insertCheckboxes()`	`RangeList`	Insère des cases à cocher dans chaque cellule de la plage, configurées avec `true` pour les cases cochées et `false` pour les cases décochées.
`insertCheckboxes(checkedValue)`	`RangeList`	Insère des cases à cocher dans chaque cellule de la plage, configurées avec une valeur personnalisée pour les cases cochées et une chaîne vide pour les cases décochées.
`insertCheckboxes(checkedValue, uncheckedValue)`	`RangeList`	Insère des cases à cocher dans chaque cellule de la plage, configurées avec des valeurs personnalisées pour les états "coché" et "décoché".
`removeCheckboxes()`	`RangeList`	Supprime toutes les cases à cocher de la plage.
`setBackground(color)`	`RangeList`	Définit la couleur d'arrière-plan de chaque `Range` dans la liste des plages.
`setBackgroundRGB(red, green, blue)`	`RangeList`	Définit l'arrière-plan sur la couleur RVB indiquée.
`setBorder(top, left, bottom, right, vertical, horizontal)`	`RangeList`	Définit la propriété de bordure pour chaque `Range` de la liste de plages.
`setBorder(top, left, bottom, right, vertical, horizontal, color, style)`	`RangeList`	Définit la propriété de bordure avec la couleur et/ou le style pour chaque `Range` de la liste de plages.
`setFontColor(color)`	`RangeList`	Définit la couleur de police pour chaque `Range` de la liste des plages.
`setFontFamily(fontFamily)`	`RangeList`	Définit la famille de polices pour chaque `Range` de la liste des plages.
`setFontLine(fontLine)`	`RangeList`	Définit le style de ligne de la police pour chaque `Range` de la liste des plages.
`setFontSize(size)`	`RangeList`	Définit la taille de police (en points) pour chaque `Range` de la liste des plages.
`setFontStyle(fontStyle)`	`RangeList`	Définissez le style de police pour chaque `Range` de la liste des plages.
`setFontWeight(fontWeight)`	`RangeList`	Définissez la graisse de la police pour chaque `Range` de la liste des plages.
`setFormula(formula)`	`RangeList`	Met à jour la formule pour chaque `Range` de la liste de plage.
`setFormulaR1C1(formula)`	`RangeList`	Met à jour la formule pour chaque `Range` de la liste de plage.
`setHorizontalAlignment(alignment)`	`RangeList`	Définissez l'alignement horizontal pour chaque `Range` de la liste de plages.
`setNote(note)`	`RangeList`	Définit le texte de la note pour chaque `Range` de la liste de plages.
`setNumberFormat(numberFormat)`	`RangeList`	Définit le format de nombre ou de date pour chaque `Range` de la liste de plages.
`setShowHyperlink(showHyperlink)`	`RangeList`	Indique si chaque `Range` de la liste de plages doit afficher des liens hypertexte.
`setTextDirection(direction)`	`RangeList`	Définit le sens du texte pour les cellules de chaque `Range` dans la liste de plage.
`setTextRotation(degrees)`	`RangeList`	Définit les paramètres de rotation du texte pour les cellules de chaque `Range` de la liste de plages.
`setValue(value)`	`RangeList`	Définit la valeur de chaque `Range` dans la liste des plages.
`setVerticalAlignment(alignment)`	`RangeList`	Définissez l'alignement vertical pour chaque `Range` de la liste de plages.
`setVerticalText(isVertical)`	`RangeList`	Indique si le texte des cellules de chaque `Range` de la liste de plage doit être empilé ou non.
`setWrap(isWrapEnabled)`	`RangeList`	Définissez le retour à la ligne pour chaque `Range` de la liste de plages.
`setWrapStrategy(strategy)`	`RangeList`	Définit la stratégie d'habillage du texte pour chaque `Range` de la liste de plages.
`trimWhitespace()`	`RangeList`	Supprime les espaces blancs (espaces, tabulations ou sauts de ligne, par exemple) dans chaque cellule de cette liste de plages.
`uncheck()`	`RangeList`	Définit l'état des cases à cocher de la plage sur "non cochées".

Documentation détaillée

`activate()`

Sélectionne la liste des instances Range. La dernière plage de la liste est définie comme active range.

Remarque : Cela permet de sélectionner plusieurs plages.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.activate();

const selection = sheet.getSelection();
// Current cell: B2
const currentCell = selection.getCurrentCell();
// Active range: B2:C4
const activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
const activeRangeList = selection.getActiveRangeList();

Renvois

RangeList : liste des plages actives, pour l'enchaînement.

Autorisation

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

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

`breakApart()`

Sépare à nouveau toutes les cellules fusionnées horizontalement ou verticalement contenues dans la liste de plages.

Appeler cette fonction sur une liste de plages équivaut à sélectionner un ensemble de plages et à sélectionner l'élément de menu Format > Fusionner > Dissocier de Sheets.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.breakApart();

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`check()`

Modifie l'état des cases à cocher de la plage sur "coché". Ignore les cellules de la plage qui ne contiennent pas actuellement la valeur cochée ou décochée configurée.

// Changes the state of cells which currently contain either the checked or
// unchecked value configured in the ranges D4 and E6 to 'checked'.
const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);
rangeList.check();

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`clear()`

Efface le contenu, les formats et les règles de validation des données pour chaque Range de la liste de plages.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clear();

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`clear(options)`

Efface le contenu, le format, les règles de validation des données et les commentaires de la plage, comme spécifié dans les options fournies. Par défaut, toutes les données sont effacées.

// The code below clears the contents of the following ranges A:A and C:C in the
// active sheet, but preserves the format, data validation rules, and comments.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clear({contentsOnly: true});

Paramètres

Nom	Type	Description
`options`	`Object`	Objet JavaScript qui spécifie les paramètres avancés, comme indiqué ci-dessous.

Paramètres avancés

Nom	Type	Description
`commentsOnly`	`Boolean`	Indique si seuls les commentaires doivent être effacés.
`contentsOnly`	`Boolean`	Indique s'il faut effacer uniquement le contenu.
`formatOnly`	`Boolean`	Indique si seul le format doit être effacé. Notez que l'effacement du format efface également les règles de validation des données.
`validationsOnly`	`Boolean`	Indique s'il faut effacer uniquement les règles de validation des données.
`skipFilteredRows`	`Boolean`	Indique s'il faut éviter d'effacer les lignes filtrées.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`clearContent()`

Efface le contenu de chaque Range de la liste de plages, en conservant la mise en forme.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearContent();

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`clearDataValidations()`

Efface les règles de validation des données pour chaque Range de la liste de plages.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearDataValidations();

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`clearFormat()`

Efface la mise en forme du texte pour chaque Range de la liste de plages.

Cette option efface la mise en forme du texte pour chaque plage, mais ne réinitialise aucune règle de mise en forme des nombres.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearFormat();

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`clearNote()`

Efface la note pour chaque Range de la liste de plages.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearNote();

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`getRanges()`

Renvoie une liste d'une ou plusieurs instances Range dans la même feuille.

Renvois

Range[] : liste des plages.

Autorisation

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

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

`insertCheckboxes()`

Insère des cases à cocher dans chaque cellule de la plage, configurées avec true pour les cases cochées et false pour les cases décochées. Définit la valeur de toutes les cellules de la plage sur false.

const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with
// 'true' for checked and 'false' for unchecked. Also, sets the value of each
// cell in the ranges D4 and E6 to 'false'.
rangeList.insertCheckboxes();

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`insertCheckboxes(checkedValue)`

Insère des cases à cocher dans chaque cellule de la plage, configurées avec une valeur personnalisée pour les cases cochées et une chaîne vide pour les cases décochées. Définit la valeur de chaque cellule de la plage sur la chaîne vide.

const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with
// 'yes' for checked and the empty string for unchecked. Also, sets the value of
// each cell in the ranges D4 and E6 to the empty string.
rangeList.insertCheckboxes('yes');

Paramètres

Nom	Type	Description
`checkedValue`	`Object`	Valeur cochée pour la validation des données de la case à cocher.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`insertCheckboxes(checkedValue, uncheckedValue)`

Insère des cases à cocher dans chaque cellule de la plage, configurées avec des valeurs personnalisées pour les états "coché" et "décoché". Définit la valeur de chaque cellule de la plage sur la valeur personnalisée "Non cochée".

const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with
// 'yes' for checked and 'no' for unchecked. Also, sets the value of each cell
// in the ranges D4 and E6 to 'no'.
rangeList.insertCheckboxes('yes', 'no');

Paramètres

Nom	Type	Description
`checkedValue`	`Object`	Valeur cochée pour la validation des données de la case à cocher.
`uncheckedValue`	`Object`	Valeur de la case à cocher lorsque celle-ci n'est pas cochée.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`removeCheckboxes()`

Supprime toutes les cases à cocher de la plage. Efface la validation des données de chaque cellule et efface également sa valeur si la cellule contient la valeur cochée ou décochée.

const range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:B10.
range.insertCheckboxes('yes', 'no');

const rangeList1 = SpreadsheetApp.getActive().getRangeList(['A1', 'A3']);
rangeList1.setValue('yes');
// Removes the checkbox data validation in cells A1 and A3 and clears their
// value.
rangeList1.removeCheckboxes();

const rangeList2 = SpreadsheetApp.getActive().getRangeList(['A5', 'A7']);
rangeList2.setValue('random');
// Removes the checkbox data validation in cells A5 and A7 but does not clear
// their value.
rangeList2.removeCheckboxes();

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setBackground(color)`

Définit la couleur d'arrière-plan de chaque Range dans la liste des plages. La couleur est représentée en notation CSS, par exemple '#ffffff' ou 'white'.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setBackground('red');

Paramètres

Nom	Type	Description
`color`	`String`	Code de couleur d'arrière-plan en notation CSS, tel que `'#ffffff'` ou `'white'`. Une valeur `null` réinitialise la couleur.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setBackgroundRGB(red, green, blue)`

Définit l'arrière-plan sur la couleur RVB indiquée. Il s'agit d'un wrapper pratique pour un appel setBackground(color).

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
// Sets the background to red for each range in the range list.
rangeList.setBackgroundRGB(255, 0, 0);

Paramètres

Nom	Type	Description
`red`	`Integer`	Valeur rouge dans la notation RVB.
`green`	`Integer`	Valeur verte dans la notation RVB.
`blue`	`Integer`	Valeur bleue dans la notation RVB.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setBorder(top, left, bottom, right, vertical, horizontal)`

Définit la propriété de bordure pour chaque Range de la liste de plages. Les valeurs valides sont true (activé), false (désactivé) et null (aucune modification).

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A2:B4', 'C1:D4']);
// Sets borders on the top and bottom of the ranges A2:B4 and C1:D4, but leaves
// the left and right unchanged.
rangeList.setBorder(true, null, true, null, false, false);

Paramètres

Nom	Type	Description
`top`	`Boolean`	`true` pour la bordure, `false` pour aucune bordure, `null` pour aucun changement.
`left`	`Boolean`	`true` pour la bordure, `false` pour aucune bordure, `null` pour aucun changement.
`bottom`	`Boolean`	`true` pour la bordure, `false` pour aucune bordure, `null` pour aucun changement.
`right`	`Boolean`	`true` pour la bordure, `false` pour aucune bordure, `null` pour aucun changement.
`vertical`	`Boolean`	`true` pour les bordures verticales internes, `false` pour aucune bordure, `null` pour aucune modification.
`horizontal`	`Boolean`	`true` pour les bordures horizontales internes, `false` pour aucune bordure, `null` pour ne rien changer.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setBorder(top, left, bottom, right, vertical, horizontal, color, style)`

Définit la propriété de bordure avec la couleur et/ou le style pour chaque Range de la liste de plages. Les valeurs valides sont true (activé), false (désactivé) et null (aucune modification). La couleur est représentée dans la notation CSS, par exemple '#ffffff' ou 'white'.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A2:B4', 'C1:D4']);
// Sets borders on the top and bottom, but leaves the left and right unchanged
// of the ranges A2:B4 and C1:D4. Also sets the color to 'red', and the border
// to 'DASHED'.
rangeList.setBorder(
    true,
    null,
    true,
    null,
    false,
    false,
    'red',
    SpreadsheetApp.BorderStyle.DASHED,
);

Paramètres

Nom	Type	Description
`top`	`Boolean`	`true` pour la bordure, `false` pour aucune bordure, `null` pour aucun changement.
`left`	`Boolean`	`true` pour la bordure, `false` pour aucune bordure, `null` pour aucun changement.
`bottom`	`Boolean`	`true` pour la bordure, `false` pour aucune bordure, `null` pour aucun changement.
`right`	`Boolean`	`true` pour la bordure, `false` pour aucune bordure, `null` pour aucun changement.
`vertical`	`Boolean`	`true` pour les bordures verticales internes, `false` pour aucune bordure, `null` pour aucune modification.
`horizontal`	`Boolean`	`true` pour les bordures horizontales internes, `false` pour aucune bordure, `null` pour ne rien changer.
`color`	`String`	Couleur de la bordure en notation CSS, comme `'#ffffff'` ou `'white'`, `null` pour la couleur par défaut (noir).
`style`	`BorderStyle`	Style des bordures, `null` pour le style par défaut (plein).

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setFontColor(color)`

Définit la couleur de police pour chaque Range de la liste des plages. La couleur est représentée dans la notation CSS, par exemple '#ffffff' ou 'white'.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontColor('red');

Paramètres

Nom	Type	Description
`color`	`String`	Couleur de la police en notation CSS, par exemple `'#ffffff'` ou `'white'`. Une valeur `null` réinitialise la couleur.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setFontFamily(fontFamily)`

Définit la famille de polices pour chaque Range de la liste des plages. La famille de polices est décrite par un identifiant de chaîne tel que Arial ou Roboto.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontFamily('Roboto');

Paramètres

Nom	Type	Description
`fontFamily`	`String`	Famille de polices à définir. Une valeur `null` réinitialise la famille de polices.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setFontLine(fontLine)`

Définit le style de ligne de la police pour chaque Range de la liste des plages. Les options de style de ligne sont 'underline', 'line-through' ou 'none'.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontLine('line-through');

Paramètres

Nom	Type	Description
`fontLine`	`String`	Style de ligne de la police (`'underline'`, `'line-through'` ou `'none'`). Une valeur `null` réinitialise le style de ligne de la police.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setFontSize(size)`

Définit la taille de police (en points) pour chaque Range de la liste des plages.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontSize(20);

Paramètres

Nom	Type	Description
`size`	`Integer`	Taille de police en points.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setFontStyle(fontStyle)`

Définissez le style de police pour chaque Range de la liste des plages. Les options de style de police sont 'italic' ou 'normal'.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontStyle('italic');

Paramètres

Nom	Type	Description
`fontStyle`	`String`	Style de police, `'italic'` ou `'normal'`. Une valeur `null` réinitialise le style de police.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setFontWeight(fontWeight)`

Définissez la graisse de la police pour chaque Range de la liste des plages. Les options d'épaisseur de la police sont 'normal' ou 'bold'.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontWeight('bold');

Paramètres

Nom	Type	Description
`fontWeight`	`String`	Épaisseur de la police (`'bold'` ou `'normal'`). Une valeur `null` réinitialise l'épaisseur de la police.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setFormula(formula)`

Met à jour la formule pour chaque Range de la liste de plage. La formule fournie doit être au format A1.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A11', 'C11']);
rangeList.setFormula('=SUM(B1:B10)');

Paramètres

Nom	Type	Description
`formula`	`String`	Chaîne représentant la formule à définir.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setFormulaR1C1(formula)`

Met à jour la formule pour chaque Range de la liste de plage. La formule fournie doit être au format R1C1.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A11', 'C11']);
// This sets the formula to be the sum of the 3 rows above B5
rangeList.setFormulaR1C1('=SUM(R[-3]C[0]:R[-1]C[0])');

Paramètres

Nom	Type	Description
`formula`	`String`	Formule de chaîne.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setHorizontalAlignment(alignment)`

Définissez l'alignement horizontal pour chaque Range de la liste de plages. Les options d'alignement sont 'left', 'center' ou 'right'.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setHorizontalAlignment('center');

Paramètres

Nom	Type	Description
`alignment`	`String`	L'alignement, qui peut être `'left'`, `'center'` ou `'normal'`. Une valeur `null` réinitialise l'alignement.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setNote(note)`

Définit le texte de la note pour chaque Range de la liste de plages.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setNote('This is a note');

Paramètres

Nom	Type	Description
`note`	`String`	Texte de la note à définir. Une valeur `null` supprime la note.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setNumberFormat(numberFormat)`

Définit le format de nombre ou de date pour chaque Range de la liste de plages.

Les modèles de mise en forme acceptés sont décrits dans le guide de mise en forme des dates et des nombres de l'API Sheets.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
// Always show 3 decimal points for the specified ranges.
rangeList.setNumberFormat('0.000');

Paramètres

Nom	Type	Description
`numberFormat`	`String`	Chaîne de format numérique.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setShowHyperlink(showHyperlink)`

Indique si chaque Range de la liste de plages doit afficher des liens hypertexte.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
// Show hyperlinks for all the ranges.
rangeList.setShowHyperlink(true);

Paramètres

Nom	Type	Description
`showHyperlink`	`Boolean`	Indique si le lien hypertexte doit être affiché ou non.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setTextDirection(direction)`

Définit le sens du texte pour les cellules de chaque Range dans la liste de plage. Si une direction spécifiée est null, la direction est déduite, puis définie.

// Sets right-to-left text direction each range in the range list.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
rangeList.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

Paramètres

Nom	Type	Description
`direction`	`TextDirection`	Direction du texte souhaitée. Si la valeur est `null`, la direction est déduite avant la définition.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setTextRotation(degrees)`

Définit les paramètres de rotation du texte pour les cellules de chaque Range de la liste de plages. L'entrée correspond à l'angle entre l'orientation standard du texte et l'orientation souhaitée. Une entrée de zéro indique que le texte est défini sur l'orientation standard.

Pour le sens d'écriture de gauche à droite, les angles positifs sont dans le sens inverse des aiguilles d'une montre, tandis que pour le sens d'écriture de droite à gauche, ils sont dans le sens des aiguilles d'une montre.

// Sets the cells in the ranges A1:A10 and C1:C10 to have text rotated up 45
// degrees.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
rangeList.setTextRotation(45);

Paramètres

Nom	Type	Description
`degrees`	`Integer`	Angle souhaité entre l'orientation standard et l'orientation souhaitée. Pour le texte de gauche à droite, les angles positifs sont dans le sens inverse des aiguilles d'une montre.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setValue(value)`

Définit la valeur de chaque Range dans la liste des plages. La valeur peut être numérique, une chaîne, une valeur booléenne ou une date. Si elle commence par "=", elle est interprétée comme une formule.

const sheet = SpreadsheetApp.getActiveSheet();
// Set value of 100 to each range in the range list.
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setValue(100);

Paramètres

Nom	Type	Description
`value`	`Object`	Valeur de la plage.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setVerticalAlignment(alignment)`

Définissez l'alignement vertical pour chaque Range de la liste de plages. Les options d'alignement sont 'top', 'middle' ou 'bottom'.

// Sets the vertical alignment to middle for the list of ranges.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setVerticalAlignment('middle');

Paramètres

Nom	Type	Description
`alignment`	`String`	L'alignement, qui peut être `'top'`, `'middle'` ou `'bottom'`. Une valeur `null` réinitialise l'alignement.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setVerticalText(isVertical)`

Indique si le texte des cellules de chaque Range de la liste de plage doit être empilé ou non. Si le texte est empilé verticalement, le paramètre de rotation du texte en degrés est ignoré.

// Sets all cell's in ranges D4 and B2:D4 to have vertically stacked text.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setVerticalText(true);

Paramètres

Nom	Type	Description
`isVertical`	`Boolean`	Indique si le texte doit être empilé ou non.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setWrap(isWrapEnabled)`

Définissez le retour à la ligne pour chaque Range de la liste de plages. Les cellules pour lesquelles le retour à la ligne est activé sont redimensionnées pour afficher l'intégralité de leur contenu. Les cellules pour lesquelles le retour à la ligne est désactivé affichent autant de texte que possible sans redimensionnement ni retour à la ligne.

// Enable text wrap for the list of ranges.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setWrap(true);

Paramètres

Nom	Type	Description
`isWrapEnabled`	`Boolean`	Indique si le texte doit être renvoyé à la ligne.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`setWrapStrategy(strategy)`

Définit la stratégie d'habillage du texte pour chaque Range de la liste de plages.

// Sets the list of ranges to use the clip wrap strategy.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

Paramètres

Nom	Type	Description
`strategy`	`WrapStrategy`	Stratégie d'habillage souhaitée.

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

`trimWhitespace()`

Supprime les espaces blancs (espaces, tabulations ou sauts de ligne, par exemple) dans chaque cellule de cette liste de plages. Supprime tous les espaces blancs au début et à la fin du texte de chaque cellule, et réduit toute sous-séquence de caractères d'espacement restants à un seul espace.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('A1:A4');
range.activate();
range.setValues([
  ' preceding space',
  'following space ',
  'two  middle  spaces',
  '   =SUM(1,2)',
]);

const rangeList = sheet.getRangeList(['A1', 'A2', 'A3', 'A4']);
rangeList.trimWhitespace();

const values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces',
// '=SUM(1,2)']

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

Voir aussi

Range.trimWhitespace()

`uncheck()`

Modifie l'état des cases à cocher de la plage sur "non cochée". Ignore les cellules de la plage qui ne contiennent actuellement pas la valeur cochée ou non cochée configurée.

// Changes the state of cells which currently contain either the checked or
// unchecked value configured in the ranges D4 and E6 to 'unchecked'.
const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);
rangeList.uncheck();

Renvois

RangeList : cette liste de plages, pour le chaînage.

Autorisation

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

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

Class RangeList Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Méthodes

Documentation détaillée

activate()

Renvois

Autorisation

breakApart()

Renvois

Autorisation

check()

Renvois

Autorisation

clear()

Renvois

Autorisation

clear(options)

Paramètres

Paramètres avancés

Renvois

Autorisation

clearContent()

Renvois

Autorisation

clearDataValidations()

Renvois

Autorisation

clearFormat()

Renvois

Autorisation

clearNote()

Renvois

Autorisation

getRanges()

Renvois

Autorisation

insertCheckboxes()

Renvois

Autorisation

insertCheckboxes(checkedValue)

Paramètres

Renvois

Autorisation

insertCheckboxes(checkedValue, uncheckedValue)

Paramètres

Renvois

Autorisation

removeCheckboxes()

Renvois

Autorisation

setBackground(color)

Paramètres

Renvois

Autorisation

setBackgroundRGB(red, green, blue)

Paramètres

Renvois

Autorisation

setBorder(top, left, bottom, right, vertical, horizontal)

Paramètres

Renvois

Autorisation

setBorder(top, left, bottom, right, vertical, horizontal, color, style)

Paramètres

Renvois

Autorisation

setFontColor(color)

Paramètres

Renvois

Autorisation

setFontFamily(fontFamily)

Paramètres

Renvois

Autorisation

setFontLine(fontLine)

Paramètres

Renvois

Autorisation

setFontSize(size)

Paramètres

Renvois

Class RangeList

`activate()`

`breakApart()`

`check()`

`clear()`

`clear(options)`

`clearContent()`

`clearDataValidations()`

`clearFormat()`

`clearNote()`

`getRanges()`

`insertCheckboxes()`

`insertCheckboxes(checkedValue)`

`insertCheckboxes(checkedValue, uncheckedValue)`

`removeCheckboxes()`

`setBackground(color)`

`setBackgroundRGB(red, green, blue)`

`setBorder(top, left, bottom, right, vertical, horizontal)`

`setBorder(top, left, bottom, right, vertical, horizontal, color, style)`

`setFontColor(color)`

`setFontFamily(fontFamily)`

`setFontLine(fontLine)`

`setFontSize(size)`

`setFontStyle(fontStyle)`

`setFontWeight(fontWeight)`

`setFormula(formula)`

`setFormulaR1C1(formula)`

`setHorizontalAlignment(alignment)`

`setNote(note)`

`setNumberFormat(numberFormat)`

`setShowHyperlink(showHyperlink)`

`setTextDirection(direction)`

`setTextRotation(degrees)`

`setValue(value)`

`setVerticalAlignment(alignment)`

`setVerticalText(isVertical)`

`setWrap(isWrapEnabled)`

`setWrapStrategy(strategy)`

`trimWhitespace()`

`uncheck()`