Obtenir une plage à l’aide de l’API JavaScript Excel

  • Article

Cet article fournit des exemples qui montrent différentes façons d’obtenir une plage dans une feuille de calcul à l’aide de l’API JavaScript Excel. Pour obtenir la liste complète des propriétés et méthodes prises en charge par l’objet Range , voir Classe Excel.Range.

Remarque

L’API JavaScript Excel ne comprend pas d’objet ou de classe « Cellule ». L’API JavaScript Excel définit plutôt toutes les cellules Excel comme objetsRange. Une cellule individuelle dans l’interface utilisateur d’Excel se traduit par un objetRange avec une cellule dans l’API JavaScript Excel. Un objet Range peut également contenir plusieurs cellules contiguës. Consultez Travailler avec des cellules de calcul à l’aide de l’API JavaScript Excel pour en savoir plus.

Obtenir une plage en fonction d’une adresse

L’exemple de code suivant obtient la plage avec l’adresse B2:C5 à partir de la feuille de calcul nommée Sample, charge sa address propriété et écrit un message dans la console.

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    
    let range = sheet.getRange("B2:C5");
    range.load("address");
    await context.sync();
    
    console.log(`The address of the range B2:C5 is "${range.address}"`);
});

Obtenir une plage en fonction d’un nom

L’exemple de code suivant obtient la plage nommée MyRange à partir de la feuille de calcul nommée Sample, charge sa address propriété et écrit un message dans la console.

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");

    let range = sheet.getRange("MyRange");
    range.load("address");
    await context.sync();

    console.log(`The address of the range "MyRange" is "${range.address}"`);
});

Obtenir une plage utilisée

L’exemple de code suivant obtient la plage utilisée à partir de la feuille de calcul nommée Sample, charge sa address propriété et écrit un message dans la console. La plage utilisée est la plus petite plage qui englobe toutes les cellules de la feuille de calcul auxquelles une valeur ou un format est affecté. Si la feuille de calcul entière est vide, la getUsedRange() méthode retourne une plage qui se compose uniquement de la cellule supérieure gauche.

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");

    let range = sheet.getUsedRange();
    range.load("address");
    await context.sync();
    
    console.log(`The address of the used range in the worksheet is "${range.address}"`);
});

Obtenir l’intégralité d’une plage

L’exemple de code suivant obtient l’intégralité de la plage de feuilles de calcul à partir de la feuille de calcul nommée Sample, charge sa address propriété et écrit un message dans la console.

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");

    let range = sheet.getRange();
    range.load("address");
    await context.sync();
    
    console.log(`The address of the entire worksheet range is "${range.address}"`);
});

Voir aussi