Excel.Range class

Spécifie la référence de plage dans le style A1. La valeur Address contient la référence de feuille (par exemple, « Feuil1 ! A1 :B4").

readonly address: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Représente la référence de plage pour la plage spécifiée dans la langue de l’utilisateur.

readonly addressLocal: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Spécifie le nombre de cellules dans la plage. Cette API renvoie -1 si le nombre de cellules est supérieur à 2^31-1 (2 147 483 647).

readonly cellCount: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Spécifie le nombre total de colonnes dans la plage.

readonly columnCount: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Indique si toutes les colonnes de la plage actuelle sont masquées. true Valeur lorsque toutes les colonnes d’une plage sont masquées. Valeur lorsque false aucune colonne de la plage n’est masquée. null Valeur lorsque certaines colonnes d’une plage sont masquées et que d’autres colonnes de la même plage ne sont pas masquées.

columnHidden: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.2

Spécifie le numéro de colonne de la première cellule de la plage. Avec indice zéro.

readonly columnIndex: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

La collection de ConditionalFormats qui recoupe la gamme.

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Accède au contrôle de cellule appliqué à cette plage. Si la plage comporte plusieurs contrôles de cellule, .EmptyCellControl

control: CellControl;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.18

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml

// Add checkboxes to the table.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();

  // Get the second column in the table, without the header.
  const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();

  // Change the boolean values to checkboxes.
  range.control = {
    type: Excel.CellControlType.checkbox
  };
  await context.sync();
});

Renvoie un objet de validation des données.

readonly dataValidation: Excel.DataValidation;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.8

Renvoie un objet de mise en forme qui encapsule la police, le remplissage, les bordures, l’alignement et d’autres propriétés de la plage.

readonly format: Excel.RangeFormat;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Spécifie la formule de tableau d’une plage. Si la plage spécifiée ne contient pas de formule de tableau, cette propriété renvoie null.

formulaArray: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApiDesktop 1.1

Représente la formule dans le style de notation A1. Si une cellule n’a pas de formule, sa valeur est renvoyée à la place.

formulas: any[][];

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Représente la formule en notation A1, en utilisant le langage et les paramètres de format de nombre régionaux de l’utilisateur. Par exemple, la formule « =SUM(A1, 1.5) » en anglais deviendrait « =SUMME(A1; 1,5) » en allemand. Si une cellule n’a pas de formule, sa valeur est renvoyée à la place.

formulasLocal: any[][];

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Représente la formule dans le style de notation R1C1. Si une cellule n’a pas de formule, sa valeur est renvoyée à la place.

formulasR1C1: any[][];

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.2

Représente si toutes les cellules ont une bordure renversée. Renvoie true si toutes les cellules ont une bordure de débordement ou false si toutes les cellules n’ont pas de bordure de débordement. Renvoie null s’il y a des cellules avec et sans bordure de débordement dans la plage.

readonly hasSpill: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.12

Renvoie la distance en points, pour un zoom de 100 %, du bord supérieur de la plage au bord inférieur de la plage.

readonly height: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.10

Indique si toutes les cellules de la plage actuelle sont masquées. Valeur lorsque true toutes les cellules d’une plage sont masquées. Valeur lorsque false aucune cellule de la plage n’est masquée. null Valeur lorsque certaines cellules d’une plage sont masquées et que d’autres cellules de la même plage ne sont pas masquées.

readonly hidden: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.2

Représente le lien hypertexte de la plage active.

hyperlink: Excel.RangeHyperlink;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-hyperlink.yaml

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

    let productsRange = sheet.getRange("A3:A5");
    productsRange.load("values");

    await context.sync();

    // Create a hyperlink to a URL 
    // for each product name in the first table.
    for (let i = 0; i < productsRange.values.length; i++) {
        let cellRange = productsRange.getCell(i, 0);
        let cellText = productsRange.values[i][0];

        let hyperlink = {
            textToDisplay: cellText,
            screenTip: "Search Bing for '" + cellText + "'",
            address: "https://www.bing.com?q=" + cellText
        }
        cellRange.hyperlink = hyperlink;
    }

    await context.sync();
});

Représente si la plage active est une colonne entière.

readonly isEntireColumn: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Représente si la plage active est une ligne entière.

readonly isEntireRow: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Renvoie la distance en points, pour un zoom de 100 %, du bord gauche de la feuille de calcul au bord gauche de la plage.

readonly left: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.10

Représente l’état du type de données de chaque cellule.

readonly linkedDataTypeState: Excel.LinkedDataTypeState[][];

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Représente le code de format de nombre d’Excel pour une plage donnée. Pour plus d’informations sur la mise en forme des nombres dans Excel, voir Codes de format de nombre.

numberFormat: any[][];

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

// Set the text of the chart title to "My Chart" and display it as an overlay on the chart.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F5:G7";
    const numberFormat = [[null, "d-mmm"], [null, "d-mmm"], [null, null]]
    const values = [["Today", 42147], ["Tomorrow", "5/24"], ["Difference in days", null]];
    const formulas = [[null,null], [null,null], [null,"=G6-G5"]];
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.numberFormat = numberFormat;
    range.values = values;
    range.formulas= formulas;
    range.load('text');
    await context.sync();
    
    console.log(range.text);
});

Représente la catégorie de format de nombre de chaque cellule.

readonly numberFormatCategories: Excel.NumberFormatCategory[][];

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.12

Représente le code de format de nombre d’Excel pour une plage donnée, en fonction des paramètres de langue de l’utilisateur. Excel n’effectue aucune coercition de langage ou de format lors de l’obtention ou de la définition de la numberFormatLocal propriété. Tout texte renvoyé utilise les chaînes mises en forme localement en fonction de la langue spécifiée dans les paramètres système.

numberFormatLocal: any[][];

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Renvoie le nombre total de lignes de la plage.

readonly rowCount: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Indique si toutes les lignes de la plage actuelle sont masquées. Valeur lorsque true toutes les lignes d’une plage sont masquées. false Valeur lorsque aucune ligne de la plage n’est masquée. null Valeur lorsque certaines lignes d’une plage sont masquées et que d’autres lignes de la même plage ne sont pas masquées.

rowHidden: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.2

Renvoie le numéro de ligne de la première cellule de la plage. Avec indice zéro.

readonly rowIndex: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Indique si toutes les cellules sont enregistrées sous la forme d’une formule matricielle. Renvoie true si toutes les cellules sont enregistrées sous la forme d’une formule matricielle ou false si toutes les cellules ne sont pas enregistrées sous la forme d’une formule matricielle. Renvoie null si certaines cellules sont enregistrées en tant que formule matricielle et d’autres non.

readonly savedAsArray: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.12

Représente le tri de plage de la plage actuelle.

readonly sort: Excel.RangeSort;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.2

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml

async function sortTopToBottom(criteria: string) {
    await Excel.run(async (context) => {
        const sheet = context.workbook.worksheets.getActiveWorksheet();
        const range = sheet.getRange("A1:E5");

        // Find the column header that provides the sort criteria.
        const header = range.find(criteria, {});
        header.load("columnIndex");
        await context.sync();

        range.sort.apply(
            [
                {
                    key: header.columnIndex,
                    sortOn: Excel.SortOn.value
                }
            ],
            false /*matchCase*/,
            true /*hasHeaders*/,
            Excel.SortOrientation.rows
        );
        await context.sync();
    });
}

Représente le style de la plage actuelle. Si les styles des cellules sont incohérents, null est renvoyée. Pour les styles personnalisés, le nom du style est renvoyé. Pour les styles intégrés, une chaîne représentant une valeur dans l’énumération BuiltInStyle est renvoyée.

style: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml

await Excel.run(async (context) => {
    let worksheet = context.workbook.worksheets.getItem("Sample");
    let range = worksheet.getRange("A1:E1");

    // Apply built-in style. 
    // Styles are in the Home tab ribbon.
    range.style = Excel.BuiltInStyle.neutral;
    range.format.horizontalAlignment = "Right";

    await context.sync();
});

Valeurs de texte de la plage spécifiée. La valeur de texte ne dépend pas de la largeur de la cellule. La substitution de signe dièse (#) qui se produit dans l’interface utilisateur Excel n’affecte pas la valeur de texte retournée par l’API.

readonly text: string[][];

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Renvoie la distance en points, pour un zoom de 100 %, entre le bord supérieur de la feuille de calcul et le bord supérieur de la plage.

readonly top: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.10

Représente les valeurs brutes de la plage spécifiée. Les données renvoyées peuvent être une chaîne, un nombre ou une valeur booléenne. Les cellules contenant une erreur renvoie la chaîne d’erreur. Si la valeur renvoyée commence par un plus (« + »), moins (« - ») ou un signe égal (« = »), Excel interprète cette valeur comme une formule. Les chaînes en forme de paramètres régionaux (telles que la date « 19-8-2025 » en nl-NL ou fr-FR, format DD-MM-YYYY) sont stockées en tant que texte et non en tant que dates. Pour vous assurer que les dates sont stockées en tant que dates, utilisez une API adaptée aux paramètres régionaux, comme formulasLocal ou un format indépendant des paramètres régionaux, comme ISO (AAAA-MM-JJ) ou une date numérique de série.

values: any[][];

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml

// Change the value of the checkbox in B3.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const range = sheet.getRange("B3");

  range.values = [["TRUE"]];
  await context.sync();
});

Représentation JSON des valeurs dans les cellules de cette plage. Contrairement à Range.values, Range.valuesAsJson prend en charge tous les types de données pouvant se trouver dans une cellule. Par exemple, des valeurs numériques mises en forme et des images web, en plus des valeurs booléennes, numériques et de chaîne standard. Les données renvoyées à partir de cette API s’alignent toujours sur les paramètres régionaux fr-FR. Pour récupérer des données dans les paramètres régionaux d’affichage de l’utilisateur, utilisez Range.valuesAsJsonLocal.

valuesAsJson: CellValue[][];

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.16

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-formatted-number.yaml

// This function creates a double data type,
// and sets the format of this data type as a date.
await Excel.run(async (context) => {
  // Get the Sample worksheet and a range on that sheet.
  const sheet = context.workbook.worksheets.getItemOrNullObject("Sample");
  const dateRange = sheet.getRange("A1");

  // Write a number formatted as a date to cell A1.
  dateRange.valuesAsJson = [
    [
      {
        type: Excel.CellValueType.double,
        basicValue: 32889.0,
        numberFormat: "m/d/yyyy"
      }
    ]
  ];
  await context.sync();
});

Représentation JSON des valeurs dans les cellules de cette plage. Contrairement à Range.values, Range.valuesAsJsonLocal prend en charge tous les types de données pouvant se trouver dans une cellule. Par exemple, des valeurs numériques mises en forme et des images web, en plus des valeurs booléennes, numériques et de chaîne standard. Les données renvoyées par cette API s’alignent toujours sur les paramètres régionaux d’affichage de l’utilisateur. Pour récupérer des données indépendamment des paramètres régionaux, utilisez Range.valuesAsJson.

valuesAsJsonLocal: CellValue[][];

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.16

Spécifie le type de données dans chaque cellule.

readonly valueTypes: Excel.RangeValueType[][];

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Renvoie la distance en points, pour un zoom de 100 %, du bord gauche de la plage au bord droit de la plage.

readonly width: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.10

Feuille de calcul contenant la plage.

readonly worksheet: Excel.Worksheet;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Remplit une plage de la plage actuelle vers la plage de destination à l’aide de la logique de remplissage automatique spécifiée. La plage de destination peut être null ou étendre la plage source horizontalement ou verticalement. Les plages non contiguës ne sont pas prises en charge.

Pour plus d’informations, voir Utiliser la recopie incrémentée et le remplissage instantané.

autoFill(destinationRange?: Range | string, autoFillType?: Excel.AutoFillType): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.9, ExcelApi Preview pour null destinationRange

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-auto-fill.yaml

await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const sumCell = sheet.getRange("P4");
  
  // Copy everything. The formulas will be contextually updated based on their new locations.
  sumCell.autoFill("P4:P7", Excel.AutoFillType.fillCopy);
  sumCell.format.autofitColumns();
  await context.sync();
});

Remplit une plage de la plage actuelle vers la plage de destination à l’aide de la logique de remplissage automatique spécifiée. La plage de destination peut être null ou étendre la plage source horizontalement ou verticalement. Les plages non contiguës ne sont pas prises en charge.

Pour plus d’informations, voir Utiliser la recopie incrémentée et le remplissage instantané.

autoFill(destinationRange?: Range | string, autoFillType?: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.9, ExcelApi Preview pour null destinationRange

Calcule une plage de cellules dans une feuille de calcul.

calculate(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.6

Vérifie l’orthographe des mots de cette plage. Cette méthode ouvre la boîte de dialogue Orthographe dans l’interface utilisateur d’Excel.

checkSpelling(options?: Excel.CheckSpellingOptions): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApiDesktop 1.1

Effacer les valeurs de plage et la mise en forme, telles que le remplissage et la bordure.

clear(applyTo?: Excel.ClearApplyTo): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

// Clear the format and contents of the range.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D:F";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.clear();
    await context.sync(); 
});

Effacer les valeurs de plage et la mise en forme, telles que le remplissage et la bordure.

clear(applyTo?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Efface les valeurs des cellules de la plage, en accordant une attention particulière aux cellules contenant des contrôles. Si la plage ne contient que des valeurs vides et des contrôles définis sur leur valeur par défaut, les valeurs et la mise en forme des contrôles sont supprimées. Dans le cas contraire, les cellules avec les contrôles sont définies sur leur valeur par défaut et efface les valeurs des autres cellules de la plage.

clearOrResetContents(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.18

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml

// Remove all content from the Analysis column.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();

  // Get the second column in the table, without the header.
  const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();

  // Clear all the data from the second column.
  range.clearOrResetContents();
  await context.sync();
});

Convertit les cellules de la plage avec les types de données en texte.

convertDataTypeToText(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.9

Convertit les cellules de la plage en types de données liés dans la feuille de calcul.

convertToLinkedDataType(serviceID: number, languageCulture: string): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.9

Copie les données ou la mise en forme des cellules de la plage source ou RangeAreas de la plage active. La plage de destination peut être d’une taille différente de la plage source ou RangeAreas. La destination est développée automatiquement si elle est plus petite que la source. Remarque : comme la fonctionnalité de copie de l’interface utilisateur d’Excel, si la plage de destination est un multiple exact supérieur à la plage source dans les lignes ou les colonnes, le contenu source est répliqué plusieurs fois. Par exemple, une copie de la plage 2x2 dans une plage 2x6 donnera 3 copies de la plage 2x2 d’origine.

copyFrom(sourceRange: Range | RangeAreas | string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.9

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-copyfrom.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    // Place a label in front of the copied data.
    sheet.getRange("F2").values = [["Copied Formula"]];

    // Copy a range preserving the formulas.
    // Note: non-formula values are copied over as is.
    sheet.getRange("G2").copyFrom("A1:E1", Excel.RangeCopyType.formulas);
    await context.sync();
});

Copie les données ou la mise en forme des cellules de la plage source ou RangeAreas de la plage active. La plage de destination peut être d’une taille différente de la plage source ou RangeAreas. La destination est développée automatiquement si elle est plus petite que la source. Remarque : comme la fonctionnalité de copie de l’interface utilisateur d’Excel, si la plage de destination est un multiple exact supérieur à la plage source dans les lignes ou les colonnes, le contenu source est répliqué plusieurs fois. Par exemple, une copie de la plage 2x2 dans une plage 2x6 donnera 3 copies de la plage 2x2 d’origine.

copyFrom(sourceRange: Range | RangeAreas | string, copyType?: "All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths", skipBlanks?: boolean, transpose?: boolean): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.9

Supprime les cellules associées à la plage.

delete(shift: Excel.DeleteShiftDirection): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D:F";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.delete("Left");
    await context.sync(); 
});

Supprime les cellules associées à la plage.

delete(shift: "Up" | "Left"): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Recherche la chaîne donnée basée sur les critères spécifiés. Si la plage actuelle est plus grande qu’une seule cellule, la recherche est limitée à cette plage, sinon la recherche couvre toute la feuille commençant après cette cellule.

find(text: string, criteria: Excel.SearchCriteria): Excel.Range;

Paramètres

Retours

Objet Range représentant la première cellule qui contient une valeur correspondant au texte et aux critères de recherche.

Remarques

Jeu d’API : ExcelApi 1.9

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-find.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const table = sheet.tables.getItem("ExpensesTable");
    const searchRange = table.getRange();

    // NOTE: If no match is found, an ItemNotFound error
    // is thrown when Range.find is evaluated.
    const searchText = (document.getElementById("searchText") as HTMLTextAreaElement).value;
    const foundRange = searchRange.find(searchText, {
        completeMatch: isCompleteMatchToggle,
        matchCase: isMatchCaseToggle,
        searchDirection: searchDirectionToggle
    });
    
    foundRange.load("address");
    await context.sync();

    console.log(foundRange.address);
});

Recherche la chaîne donnée basée sur les critères spécifiés. Si la plage actuelle est plus grande qu’une seule cellule, la recherche est limitée à cette plage, sinon la recherche couvre toute la feuille commençant après cette cellule. S’il n’y a pas de correspondance, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

findOrNullObject(text: string, criteria: Excel.SearchCriteria): Excel.Range;

Paramètres

Retours

Le Range qui correspondait aux critères de recherche.

Remarques

Jeu d’API : ExcelApi 1.9

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-find.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const table = sheet.tables.getItem("ExpensesTable");
    const searchRange = table.getRange();
    const searchText = (document.getElementById("searchText") as HTMLTextAreaElement).value;
    const foundRange = searchRange.findOrNullObject(searchText, {
        completeMatch: isCompleteMatchToggle,
        matchCase: isMatchCaseToggle,
        searchDirection: searchDirectionToggle
    });
    
    foundRange.load("address");
    await context.sync();

    if (foundRange.isNullObject) {
        console.log("Text not found");
    } else {
        console.log(foundRange.address);
    }
});

Effectue un remplissage instantané à la plage actuelle. Le remplissage instantané renseigne automatiquement les données lorsqu’il détecte un modèle. La plage doit donc être une plage de colonne unique et avoir des données autour d’elle afin de trouver un modèle.

flashFill(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.9

Obtient un objet avec la Range même cellule supérieure gauche que l’objet actuel Range , mais avec le nombre spécifié de lignes et de colonnes.

getAbsoluteResizedRange(numRows: number, numColumns: number): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.7

Renvoie le plus petit objet de plage qui englobe les plages données. Par exemple, les GetBoundingRect valeurs de « B2 :C5 » et « D10 :E15 » font « B2 :E15 ».

getBoundingRect(anotherRange: Range | string): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D4:G6";
    let range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range = range.getBoundingRect("G4:H8");
    range.load('address');
    await context.sync();
    
    console.log(range.address); // Prints Sheet1!D4:H8
});

Renvoie l’objet de plage qui contient une cellule donnée sur la base des numéros de ligne et de colonne. La cellule peut se trouver en dehors des limites de sa plage parente, tant qu’elle reste dans la grille de la feuille de calcul. L’emplacement de la cellule renvoyée est déterminé à partir de la cellule supérieure gauche de la plage.

getCell(row: number, column: number): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const cell = range.getCell(0,0);
    cell.load('address');
    await context.sync();
    
    console.log(cell.address);
});

Renvoie une plage en 2D, qui comprend les propriétés de police, de remplissage, de bordures, d’alignement, etc. de la plage.

getCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions): OfficeExtension.ClientResult<CellProperties[][]>;

Paramètres

Retours

Tableau 2D où chaque élément représente les propriétés demandées de la cellule correspondante.

Remarques

Jeu d’API : ExcelApi 1.9

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml

await Excel.run(async (context) => {
    const cell = context.workbook.getActiveCell();

    // Get only the properties requested in this load-options object.
    const propertiesToGet: Excel.CellPropertiesLoadOptions = {
        address: true,
        format: {
            fill: {
                color: true
            },
            font: {
                bold: true,
                color: true
            }
        },
        style: true
    };
    const cellProperties = cell.getCellProperties(propertiesToGet);

    await context.sync();
    const activeCellProperties: Excel.CellProperties = cellProperties.value[0][0];
    console.log(JSON.stringify(activeCellProperties, null, 2));
});

Obtient une colonne contenue dans la plage.

getColumn(column: number): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => { 
    const sheetName = "Sheet19";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getColumn(1);
    range.load('address');
    await context.sync();

    console.log(range.address); // prints Sheet1!B1:B8
});

Renvoie une plage à dimension unique, qui comprend les données de char colonne de police, de remplissage, de bordures, d’alignement, etc. de la plage. Pour les propriétés ne sont pas cohérentes au sein de chaque cellule dans une colonne donnée, null est renvoyé.

getColumnProperties(columnPropertiesLoadOptions: ColumnPropertiesLoadOptions): OfficeExtension.ClientResult<ColumnProperties[]>;

Paramètres

Retours

Un tableau où chaque élément représente les propriétés demandées de la colonne correspondante.

Remarques

Jeu d’API : ExcelApi 1.9

Obtient un certain nombre de colonnes à droite de l’objet actuel Range .

getColumnsAfter(count?: number): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.2

Obtient un certain nombre de colonnes à gauche de l’objet actuel Range .

getColumnsBefore(count?: number): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.2

Renvoie un WorkbookRangeAreas objet qui représente la plage contenant toutes les cellules dépendantes d’une plage spécifiée dans la même feuille de calcul ou dans plusieurs feuilles de calcul. Génère une ItemNotFound erreur si aucune personne à charge n’est trouvée.

getDependents(): Excel.WorkbookRangeAreas;

Retours

Remarques

Jeu d’API : ExcelApi 1.15

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/precedents-and-dependents.yaml

/** Highlight all dependents (direct and indirect) of the active cell. */
async function getAllDependents() {
  await Excel.run(async (context) => {
    // Get addresses of all dependent cells of the active cell.
    const range = context.workbook.getActiveCell();
    const dependents = range.getDependents();
    range.load("address");
    dependents.areas.load("address");
    await context.sync();

    console.log(`All dependent cells of ${range.address} (orange cells):`);

    for (let i = 0; i < dependents.areas.items.length; i++) {
      // Highlight and print the address of each dependent cell.
      dependents.areas.items[i].format.fill.color = "Orange";
      console.log(`  ${dependents.areas.items[i].address}`);
    }
    await context.sync();
  });

Renvoie un WorkbookRangeAreas objet qui représente la plage contenant toutes les cellules dépendantes directes d’une plage spécifiée dans la même feuille de calcul ou dans plusieurs feuilles de calcul. Génère une ItemNotFound erreur si aucune personne à charge n’est trouvée.

getDirectDependents(): Excel.WorkbookRangeAreas;

Retours

Remarques

Jeu d’API : ExcelApi 1.13

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/precedents-and-dependents.yaml

/** Highlight the direct dependents of the active cell. */
async function getDirectDependents() {
  await Excel.run(async (context) => {
    // Direct dependents are cells that contain formulas that directly refer to the active cell.
    let range = context.workbook.getActiveCell();
    let directDependents = range.getDirectDependents();
    range.load("address");
    directDependents.areas.load("address");
    await context.sync();

    console.log(`Direct dependent cells of ${range.address} (yellow cells):`);

    for (let i = 0; i < directDependents.areas.items.length; i++) {
      // Highlight and print the address of each direct dependent cell.
      directDependents.areas.items[i].format.fill.color = "Yellow";
      console.log(`  ${directDependents.areas.items[i].address}`);
    }
    await context.sync();
  });

Renvoie un WorkbookRangeAreas objet qui représente la plage contenant toutes les cellules précédentes directes d’une plage spécifiée dans la même feuille de calcul ou dans plusieurs feuilles de calcul. Génère une ItemNotFound erreur si aucun précédent n’est trouvé.

getDirectPrecedents(): Excel.WorkbookRangeAreas;

Retours

Remarques

Jeu d’API : ExcelApi 1.12

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/precedents-and-dependents.yaml

/** Highlight the direct precedents of the active cell. */
async function getDirectPrecedents() {
  await Excel.run(async (context) => {
    // Precedents are cells referenced by the formula in a cell.
    // A "direct precedent" is a cell directly referenced by the selected formula.
    let range = context.workbook.getActiveCell();
    let directPrecedents = range.getDirectPrecedents();
    range.load("address");
    directPrecedents.areas.load("address");
    await context.sync();

    console.log(`Direct precedent cells of ${range.address} (yellow cells):`);

    for (let i = 0; i < directPrecedents.areas.items.length; i++) {
      // Highlight and print the address of each direct precedent cell.
      directPrecedents.areas.items[i].format.fill.color = "Yellow";
      console.log(`  ${directPrecedents.areas.items[i].address}`);
    }
    await context.sync();
  });

Renvoie un tableau 2D encapsulant les données d’affichage pour la police, le remplissage, les bordures, l’alignement et d’autres propriétés de chaque cellule. Contrairement à getCellProperties, qui affiche uniquement les propriétés définies directement pour la cellule, renvoie les propriétés affichées à partir de sources indirectes, telles que la mise en forme conditionnelle ou les styles.

getDisplayedCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions): OfficeExtension.ClientResult<CellProperties[][]>;

Paramètres

Retours

Un tableau 2D où chaque élément représente les propriétés d’affichage demandées de la cellule correspondante.

Remarques

Jeu d’API : ExcelApi 1.19

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const cell = sheet.getRange("D3");
    const propertiesToGet: Excel.CellPropertiesLoadOptions = {
        address: true,
        format: {
            fill: {
                color: true
            },
            font: {
                bold: true,
                color: true
            },
        },
        style: true
    };

    // Direct properties exclude formatting inherited from styles or conditional formatting.
    const directProperties = cell.getCellProperties(propertiesToGet);
    // Displayed properties include formatting inherited from styles or conditional formatting.
    const displayedProperties = cell.getDisplayedCellProperties(propertiesToGet);

    await context.sync();

    console.log("Direct properties:");
    console.log(JSON.stringify(directProperties.value[0][0], null, 2));
    console.log("Displayed properties (including conditional formatting):");
    console.log(JSON.stringify(displayedProperties.value[0][0], null, 2));
});

Obtient un objet qui représente la colonne entière de la plage (par exemple, si la plage actuelle représente les cellules « B4 :E11 », il s’agit getEntireColumn d’une plage qui représente les colonnes « B :E »).

getEntireColumn(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

// Note: the grid properties of the Range (values, numberFormat, formulas) 
// contains null since the Range in question is unbounded.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D:F";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    const rangeEC = range.getEntireColumn();
    rangeEC.load('address');
    await context.sync();
    
    console.log(rangeEC.address);
});

Obtient un objet qui représente la ligne entière de la plage (par exemple, si la plage actuelle représente les cellules « B4 :E11 », il s’agit GetEntireRow d’une plage qui représente les lignes « 4:11 »).

getEntireRow(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

// Gets an object that represents the entire row of the range 
// (for example, if the current range represents cells "B4:E11", 
// its GetEntireRow is a range that represents rows "4:11").
await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "D:F"; 
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    const rangeER = range.getEntireRow();
    rangeER.load('address');
    await context.sync();
    
    console.log(rangeER.address);
});

Renvoie un objet de plage qui inclut la plage actuelle et jusqu’au bord de la plage, en fonction de la direction fournie. Cela correspond au comportement Ctrl+Maj+Touche de direction dans l’interface utilisateur d’Excel sur Windows.

getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.13

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-get-range-edge.yaml

await Excel.run(async (context) => {
  // Get the selected range.
  const range = context.workbook.getSelectedRange();

  // Specify the direction with the `KeyboardDirection` enum.
  const direction = Excel.KeyboardDirection.down;

  // Get the active cell in the workbook.
  const activeCell = context.workbook.getActiveCell();

  // Get all the cells from the currently selected range to the bottom-most edge of the used range.
  // This method acts like the Ctrl+Shift+Arrow key keyboard shortcut while a range is selected.
  const extendedRange = range.getExtendedRange(
    direction,
    activeCell // If the selected range contains more than one cell, the active cell must be defined.
  );
  extendedRange.select();

  await context.sync();
});

Renvoie un objet de plage qui inclut la plage actuelle et jusqu’au bord de la plage, en fonction de la direction fournie. Cela correspond au comportement Ctrl+Maj+Touche de direction dans l’interface utilisateur d’Excel sur Windows.

getExtendedRange(direction: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.13

Rend la plage sous la forme d’une image PNG codée en Base64.

getImage(): OfficeExtension.ClientResult<string>;

Retours

Remarques

Jeu d’API : ExcelApi 1.7

Obtient l’objet de plage qui représente l’intersection rectangulaire des plages données.

getIntersection(anotherRange: Range | string): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = 
        context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getIntersection("D4:G6");
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!D4:F6
});

Obtient l’objet de plage qui représente l’intersection rectangulaire des plages données. Si aucune intersection n’est trouvée, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getIntersectionOrNullObject(anotherRange: Range | string): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.4

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-relationships.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const salesTable = sheet.tables.getItem("SalesTable");
    const dataRange = salesTable.getDataBodyRange();

    // We want the most recent quarter that has data, so
    // exclude quarters without data and get the last of
    // the remaining columns.
    const usedDataRange = dataRange.getUsedRange(true /* valuesOnly */);
    const currentQuarterRange = usedDataRange.getLastColumn();

    // Asian and European teams have separate contests.
    const asianSalesRange = sheet.getRange("A2:E4");
    const europeanSalesRange = sheet.getRange("A5:E7");

    // The data for each chart is the intersection of the
    // current quarter column and the rows for the continent.
    const asianContestRange = asianSalesRange.getIntersectionOrNullObject(currentQuarterRange);
    const europeanContestRange = europeanSalesRange.getIntersectionOrNullObject(currentQuarterRange);

    // Must sync before you can test the output of *OrNullObject
    // method/property.
    await context.sync();

    if (asianContestRange.isNullObject) {
        // See the declaration of this function for how to
        // test this code path.
        reportMissingData("Asian");
    } else {
        createContinentChart(
            sheet,
            "Asian",
            asianContestRange,
            "A9",
            "F24"
        );
    }

    if (europeanContestRange.isNullObject) {
        // See the declaration of this function for how to
        // test this code path.
        reportMissingData("European");
    } else {
        createContinentChart(
            sheet,
            "European",
            europeanContestRange,
            "A25",
            "F40"
        );
    }

    await context.sync();
});

Obtient la dernière cellule de la plage. Par exemple, la dernière cellule de la plage « B2:D5 » est « D5 ».

getLastCell(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastCell();
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!F8
});

Obtient la dernière colonne de la plage. Par exemple, la dernière colonne de la plage « B2:D5 » est « D2:D5 ».

getLastColumn(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastColumn();
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!F1:F8
});

Obtient la dernière ligne de la plage. Par exemple, la dernière ligne de la plage « B2:D5 » est « B5:D5 ».

getLastRow(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastRow();
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!A8:F8
});

Renvoie un RangeAreas objet qui représente les zones fusionnées dans cette plage. Notez que si le nombre de zones fusionnées dans cette plage est supérieur à 512, cette méthode ne renverra pas le résultat. Si l’objet RangeAreas n’existe pas, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getMergedAreasOrNullObject(): Excel.RangeAreas;

Retours

Remarques

Jeu d’API : ExcelApi 1.13

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-merged-ranges.yaml

await Excel.run(async (context) => {
  // Retrieve the worksheet and the table in that worksheet.
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const tableRange = sheet.getRange("B2:E6");

  // Retrieve the merged range within the table and load its details.
  const mergedAreas = tableRange.getMergedAreasOrNullObject();
  mergedAreas.load("address");
  mergedAreas.load("cellCount");

  // Select the merged range.
  const range = mergedAreas.areas.getItemAt(0);
  range.select();
  await context.sync();

  // Print out the details of the `mergedAreas` range object.
  console.log(`Address of the merged range: ${mergedAreas.address}`);
  console.log(`Number of cells in the merged range: ${mergedAreas.cellCount}`);

  await context.sync();
});

Obtient un objet qui représente une plage décalée par rapport à la plage spécifiée. Les dimensions de la plage renvoyée correspondent à cette plage. Si la plage obtenue se retrouve en dehors des limites de grille de la feuille de calcul, une erreur est déclenchée.

getOffsetRange(rowOffset: number, columnOffset: number): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D4:F6";
    const range = 
        context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getOffsetRange(-1,4);
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!H3:J5
});

Obtient une collection étendue de tableaux croisés dynamiques qui chevauchent la plage.

getPivotTables(fullyContained?: boolean): Excel.PivotTableScopedCollection;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.12

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml

await Excel.run(async (context) => {
  const activeRange = context.workbook.getSelectedRange();

  // Get all the PivotTables that intersect with this range.
  const partiallyContainedPivotTables = activeRange.getPivotTables();
  // Get all the PivotTables that are completely contained within this range.
  const fullyContainedPivotTables = activeRange.getPivotTables(true);

  partiallyContainedPivotTables.load("name");
  fullyContainedPivotTables.load("name");
  await context.sync();

  // Display the names in the console.
  console.log("PivotTables in the current range:")
  partiallyContainedPivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
  console.log("PivotTables completely contained in the current range:")
  fullyContainedPivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
});

Renvoie un WorkbookRangeAreas objet qui représente la plage contenant toutes les cellules précédentes d’une plage spécifiée dans la même feuille de calcul ou dans plusieurs feuilles de calcul. Génère une ItemNotFound erreur si aucun précédent n’est trouvé.

getPrecedents(): Excel.WorkbookRangeAreas;

Retours

Remarques

Jeu d’API : ExcelApi 1.14

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/precedents-and-dependents.yaml

/** Highlight all precedents (direct and indirect) of the active cell. */
async function getAllPrecedents() {
  await Excel.run(async (context) => {
    // Precedents are cells referenced by the formula in a cell.
    let range = context.workbook.getActiveCell();
    let precedents = range.getPrecedents();
    range.load("address");
    precedents.areas.load("address");
    await context.sync();

    console.log(`All precedent cells of ${range.address} (orange cells):`);

    for (let i = 0; i < precedents.areas.items.length; i++) {
      // Highlight and print the address of each precedent cell.
      precedents.areas.items[i].format.fill.color = "Orange";
      console.log(`  ${precedents.areas.items[i].address}`);
    }
    await context.sync();
  });

Renvoie un objet de plage qui est la cellule de bord de la région de données qui correspond à la direction fournie. Cela correspond au comportement de Ctrl+Touche de direction dans l’interface utilisateur d’Excel sur Windows.

getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.13

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-get-range-edge.yaml

await Excel.run(async (context) => {
  // Get the selected range.
  const range = context.workbook.getSelectedRange();

  // Specify the direction with the `KeyboardDirection` enum.
  const direction = Excel.KeyboardDirection.up;

  // Get the active cell in the workbook.
  const activeCell = context.workbook.getActiveCell();

  // Get the top-most cell of the current used range.
  // This method acts like the Ctrl+Arrow key keyboard shortcut while a range is selected.
  const rangeEdge = range.getRangeEdge(
    direction,
    activeCell // If the selected range contains more than one cell, the active cell must be defined.
  );
  rangeEdge.select();

  await context.sync();
});

Renvoie un objet de plage qui est la cellule de bord de la région de données qui correspond à la direction fournie. Cela correspond au comportement de Ctrl+Touche de direction dans l’interface utilisateur d’Excel sur Windows.

getRangeEdge(direction: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.13

Récupère un Range objet semblable à l’objet actuel Range , mais dont le coin inférieur droit est développé (ou réduit) d’un certain nombre de lignes et de colonnes.

getResizedRange(deltaRows: number, deltaColumns: number): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.2

Obtient une ligne contenue dans la plage.

getRow(row: number): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getRow(1);
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!A2:F2
});

Renvoie une plage à dimension unique , qui comprend les données de police, de remplissage, de bordures, d’alignement, etc. de la plage. Pour les propriétés qui ne sont pas cohérentes dans chaque cellule d’une ligne donnée, null sont retournées.

getRowProperties(rowPropertiesLoadOptions: RowPropertiesLoadOptions): OfficeExtension.ClientResult<RowProperties[]>;

Paramètres

Retours

Un tableau où chaque élément représente les propriétés demandées de la ligne correspondante.

Remarques

Jeu d’API : ExcelApi 1.9

Récupère un certain nombre de lignes au-dessus de l’objet actuel Range .

getRowsAbove(count?: number): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.2

Obtient un certain nombre de lignes sous l’objet actuel Range .

getRowsBelow(count?: number): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.2

Obtient l’objet RangeAreas , comprenant une ou plusieurs plages rectangulaires, qui représente toutes les cellules correspondant au type et à la valeur spécifiés. Si aucune cellule spéciale n’est trouvée, une ItemNotFound erreur est générée.

getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.9

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml

await Excel.run(async (context) => {

    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const usedRange = sheet.getUsedRange();

    // Find the ranges with either text or logical (boolean) values.
    const formulaRanges = usedRange.getSpecialCells("Constants", "LogicalText");
    formulaRanges.format.fill.color = "orange";

    return context.sync();
});

Obtient l’objet RangeAreas , comprenant une ou plusieurs plages rectangulaires, qui représente toutes les cellules correspondant au type et à la valeur spécifiés. Si aucune cellule spéciale n’est trouvée, une ItemNotFound erreur est générée.

getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible" | "DirtyFormulas", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.9

Récupère l’objet RangeAreas , comprenant une ou plusieurs plages, qui représente toutes les cellules correspondant au type et à la valeur spécifiés. Si aucune cellule spéciale n’est trouvée, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.9

Récupère l’objet RangeAreas , comprenant une ou plusieurs plages, qui représente toutes les cellules correspondant au type et à la valeur spécifiés. Si aucune cellule spéciale n’est trouvée, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getSpecialCellsOrNullObject(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible" | "DirtyFormulas", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.9

Obtient l’objet de la plage contenant la plage renversé lorsque appelée sur une cellule d’ancrage. Échoue si appliqué à une plage comportant plusieurs cellules.

getSpillingToRange(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.12

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/dynamic-arrays.yaml

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

  // Set G4 to a formula that returns a dynamic array.
  const targetCell = sheet.getRange("G4");
  targetCell.formulas = [["=A4:D4"]];

  // Get the address of the cells that the dynamic array spilled into.
  const spillRange = targetCell.getSpillingToRange();
  spillRange.load("address");

  // Fit the columns for readability.
  sheet.getUsedRange().format.autofitColumns();
  await context.sync();

  console.log(`Copying the table headers spilled into ${spillRange.address}.`);
});

Obtient l’objet de la plage contenant la plage renversé lorsque appelée sur une cellule d’ancrage. Si la plage n’est pas une cellule d’ancrage ou si la plage de déversement est introuvable, cette méthode renvoie un objet dont isNullObject la propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getSpillingToRangeOrNullObject(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.12

Obtient l’objet de la plage contenant la cellule d’ancrage d’une cellule prise renversée dans. Échoue si appliqué à une plage comportant plusieurs cellules.

getSpillParent(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.12

Obtient l’objet de plage contenant la cellule d’ancrage pour la cellule dans laquelle elle est déversée. S’il ne s’agit pas d’une cellule renversée ou si plusieurs cellules sont données, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getSpillParentOrNullObject(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.12

Renvoie un Range objet qui représente la région environnante pour la cellule en haut à gauche de cette plage. Une région environnante est une plage délimitée par une combinaison de lignes et de colonnes vides par rapport à cette plage.

getSurroundingRegion(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.7

Obtient une collection de tableaux qui se chevauchent avec la plage dans l’étendue.

getTables(fullyContained?: boolean): Excel.TableScopedCollection;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.9

Renvoie la plage utilisée d’un objet de plage donné. Si aucune cellule n’est utilisée dans la plage, cette fonction renvoie une ItemNotFound erreur.

getUsedRange(valuesOnly?: boolean): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-relationships.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const salesTable = sheet.tables.getItem("SalesTable");
    const dataRange = salesTable.getDataBodyRange();

    // We want the most recent quarter that has data, so
    // exclude quarters without data and get the last of
    // the remaining columns.
    const usedDataRange = dataRange.getUsedRange(true /* valuesOnly */);
    const currentQuarterRange = usedDataRange.getLastColumn();

    // Asian and European teams have separate contests.
    const asianSalesRange = sheet.getRange("A2:E4");
    const europeanSalesRange = sheet.getRange("A5:E7");

    // The data for each chart is the intersection of the
    // current quarter column and the rows for the continent.
    const asianContestRange = asianSalesRange.getIntersectionOrNullObject(currentQuarterRange);
    const europeanContestRange = europeanSalesRange.getIntersectionOrNullObject(currentQuarterRange);

    // Must sync before you can test the output of *OrNullObject
    // method/property.
    await context.sync();

    if (asianContestRange.isNullObject) {
        // See the declaration of this function for how to
        // test this code path.
        reportMissingData("Asian");
    } else {
        createContinentChart(
            sheet,
            "Asian",
            asianContestRange,
            "A9",
            "F24"
        );
    }

    if (europeanContestRange.isNullObject) {
        // See the declaration of this function for how to
        // test this code path.
        reportMissingData("European");
    } else {
        createContinentChart(
            sheet,
            "European",
            europeanContestRange,
            "A25",
            "F40"
        );
    }

    await context.sync();
});

Renvoie la plage utilisée d’un objet de plage donné. S’il n’y a pas de cellules utilisées dans la plage, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.4

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/used-range.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const salesTable = sheet.tables.getItem("SalesTable");
    const dataRange = salesTable.getDataBodyRange();

    // Pass true so only cells with values count as used
    const usedDataRange = dataRange.getUsedRangeOrNullObject(
        true /* valuesOnly */
    );

    //Must sync before reading value returned from *OrNullObject method/property.
    await context.sync();

    if (usedDataRange.isNullObject) {
        console.log("Need Data to Make Chart");
        console.log("To create a meaningful chart, press 'Fill the table' (or add names to the Product column and numbers to some of the other cells). Then press 'Try to create chart' again.");
    } else {
        const chart = sheet.charts.add(
            Excel.ChartType.columnClustered,
            dataRange,
            "Columns"
        );
        chart.setPosition("A15", "F30");
        chart.title.text = "Quarterly sales chart";
        chart.legend.position = "Right";
        chart.legend.format.fill.setSolidColor("white");
        chart.dataLabels.format.font.size = 15;
        chart.dataLabels.format.font.color = "black";
    }

    await context.sync();
});

Représente les lignes visibles de la plage en cours.

getVisibleView(): Excel.RangeView;

Retours

Remarques

Jeu d’API : ExcelApi 1.3

Regroupe des colonnes et des lignes pour établir un plan.

group(groupOption: Excel.GroupOption): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.10

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/outline.yaml

Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    
    // Group the larger, main level. Note that the outline controls
    // will be on row 10, meaning 4-9 will collapse and expand.
    sheet.getRange("4:9").group(Excel.GroupOption.byRows);

    // Group the smaller, sublevels. Note that the outline controls
    // will be on rows 6 and 9, meaning 4-5 and 7-8 will collapse and expand.
    sheet.getRange("4:5").group(Excel.GroupOption.byRows);
    sheet.getRange("7:8").group(Excel.GroupOption.byRows);
    await context.sync();
});

Regroupe des colonnes et des lignes pour établir un plan.

group(groupOption: "ByRows" | "ByColumns"): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.10

Masque les détails du groupe de lignes ou de colonnes.

hideGroupDetails(groupOption: Excel.GroupOption): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.10

Masque les détails du groupe de lignes ou de colonnes.

hideGroupDetails(groupOption: "ByRows" | "ByColumns"): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.10

Insère une cellule ou une plage de cellules dans la feuille de calcul à la place d’une plage donnée et décale les autres cellules pour libérer de l’espace. Renvoie un nouvel Range objet à l’espace vide.

insert(shift: Excel.InsertShiftDirection): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "F5:F10";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.insert(Excel.InsertShiftDirection.down);
    await context.sync();
});

Insère une cellule ou une plage de cellules dans la feuille de calcul à la place d’une plage donnée et décale les autres cellules pour libérer de l’espace. Renvoie un nouvel Range objet à l’espace vide.

insert(shift: "Down" | "Right"): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.RangeLoadOptions): Excel.Range;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.Range;

Paramètres

Retours

Exemples

// Use the range address to get the range object.
await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8"; 
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    range.load('cellCount');
    await context.sync();
    
    console.log(range.cellCount);
});

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Range;

Paramètres

Retours

Fusionne la plage de cellules dans une zone de la feuille de calcul.

merge(across?: boolean): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.2

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-merged-ranges.yaml

await Excel.run(async (context) => {
  // Retrieve the worksheet and the table in that worksheet.
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const tableRange = sheet.getRange("B2:E6");

  // Create a merged range in the first row of the table.
  const chartTitle = tableRange.getRow(0);
  chartTitle.merge(true);

  // Format the merged range.
  chartTitle.format.horizontalAlignment = "Center";

  await context.sync();
});

Déplacement des valeurs de cellule, de la mise en forme et des formules de la plage actuelle vers la plage de destination, en remplaçant les anciennes informations de ces cellules. La plage de destination est développée automatiquement si elle est inférieure à la plage actuelle. Toutes les cellules de la plage de destination qui se trouvent en dehors de la zone de la plage d’origine ne sont pas modifiées. Remarque : lorsqu’une plage est déplacée vers une nouvelle adresse à l’aide de cette API, le nouvel objet de plage doit être récupéré à l’aide de la nouvelle adresse.

moveTo(destinationRange: Range | string): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.11

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-copyfrom.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    // Place a label in front of the moved data.
    sheet.getRange("F12").values = [["Moved Range:"]];

    // Move the range from A1:E1 to G12:K12.
    sheet.getRange("A1:E1").moveTo("G12");
    await context.sync();
});

Supprime les valeurs dupliquées de la plage spécifiée par les colonnes.

removeDuplicates(columns: number[], includesHeader: boolean): Excel.RemoveDuplicatesResult;

Paramètres

Retours

Objet résultant qui contient le nombre de lignes supprimées et le nombre de lignes uniques restantes.

Remarques

Jeu d’API : ExcelApi 1.9

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-remove-duplicates.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B2:D11");

    const deleteResult = range.removeDuplicates([0],true);    
    deleteResult.load();    
    await context.sync();

    console.log(deleteResult.removed + " entries with duplicate names removed.");
    console.log(deleteResult.uniqueRemaining + " entries with unique names remain in the range.");
});

Détecte et remplace la chaîne donnée basée sur les critères spécifiés dans la plage active.

replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult<number>;

Paramètres

Retours

Nombre de remplacements effectués.

Remarques

Jeu d’API : ExcelApi 1.9

Sélectionne la plage spécifiée dans l’interface utilisateur d’Excel.

select(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "F5:F10"; 
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.select();
    await context.sync(); 
});

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.Range): void;

Paramètres

Retours

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/90-scenarios/multiple-property-set.yaml

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

    const sourceRange = sheet.getRange("B2:E2");
    sourceRange.load("format/fill/color, format/font/name, format/font/color");
    await context.sync();

    // Set properties based on the loaded and synced 
    // source range.
    const targetRange = sheet.getRange("B7:E7");
    targetRange.set(sourceRange); 
    targetRange.format.autofitColumns();
    await context.sync();
});

Mises à jour de la plage sur la base d’un tableau 2D de propriétés de cellule, encapsulant des éléments tels que la police, le remplissage, les bordures et l’alignement.

setCellProperties(cellPropertiesData: SettableCellProperties[][]): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.9

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // Create the SettableCellProperties objects for the range.
    // Create these objects once, outside the function, in your add-in.
    const topHeaderProps: Excel.SettableCellProperties = {
        // Set the style property to the name of an Excel style.
        // The `BuiltInStyle` enum lists the built-in style names.
        // A style overwrites formatting, so don't use style and format in the same object.
        style: Excel.BuiltInStyle.heading1
    };

    const headerProps: Excel.SettableCellProperties = {
        // Setting these cell properties doesn't change unspecified format subproperties.
        format: {
            fill: {
                color: "Blue"
            },
            font: {
                color: "White",
                bold: true
            }
        }
    };

    const nonApplicableProps: Excel.SettableCellProperties = {
        format: {
            fill: {
                pattern: Excel.FillPattern.gray25
            },
            font: {
                color: "Gray",
                italic: true
            }
        }
    };

    const matchupScoreProps: Excel.SettableCellProperties = {
        format: {
            borders: {
                bottom: {
                    style: Excel.BorderLineStyle.continuous
                },
                left: {
                    style: Excel.BorderLineStyle.continuous
                },
                right: {
                    style: Excel.BorderLineStyle.continuous
                },
                top: {
                    style: Excel.BorderLineStyle.continuous
                }
            },
            horizontalAlignment: Excel.HorizontalAlignment.center
        }
    };

    const range = sheet.getRange("A1:E5");

    // Use empty JSON objects to leave a cell's properties unchanged.
    range.setCellProperties([
        [topHeaderProps, {}, {}, {}, {}],
        [{}, {}, headerProps, headerProps, headerProps],
        [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps],
        [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps],
        [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps]
    ]);

    sheet.getUsedRange().format.autofitColumns();
    await context.sync();
});

Mises à jour de la plage sur la base d’un tableau unidimensionnel de propriétés de colonne, encapsulant des éléments tels que la police, le remplissage, les bordures et l’alignement.

setColumnProperties(columnPropertiesData: SettableColumnProperties[]): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.9

Cette méthode désigne une plage qui doit être recalculée lorsque le recalcul suivant se produit.

setDirty(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.9

Mises à jour de la plage sur la base d’un tableau unidimensionnel de propriétés de ligne, encapsulant des éléments tels que la police, le remplissage, les bordures et l’alignement.

setRowProperties(rowPropertiesData: SettableRowProperties[]): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.9

Affiche la carte pour une cellule active si son contenu est riche en valeur.

showCard(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.7

Cette méthode affiche les flèches d'audit signalant les dépendants directs de la plage.

showDependents(remove?: boolean): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApiDesktop 1.1

Affiche les détails du groupe de lignes ou de colonnes.

showGroupDetails(groupOption: Excel.GroupOption): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.10

Affiche les détails du groupe de lignes ou de colonnes.

showGroupDetails(groupOption: "ByRows" | "ByColumns"): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.10

Cette méthode affiche les flèches d'audit signalant les antécédents directs de la plage.

showPrecedents(remove?: boolean): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApiDesktop 1.1

Définit le mode de marshaling de Python dans Excel formula =PY.

togglePythonMarshalMode(marshalMode?: Excel.PythonMarshalMode): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi BÊTA (PRÉVERSION UNIQUEMENT)

Définit le mode de marshaling de Python dans Excel formula =PY.

togglePythonMarshalMode(marshalMode?: "PythonObject" | "ExcelValue"): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi BÊTA (PRÉVERSION UNIQUEMENT)

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.Range est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.RangeDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.RangeData;

Retours

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet entre des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run » et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivis lors de la création initiale de l’objet.

track(): Excel.Range;

Retours

Dissocie les colonnes et les lignes d’un plan.

ungroup(groupOption: Excel.GroupOption): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.10

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/outline.yaml

Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    
    // This removes two levels of groups from the "A1-R10" range.
    // Any groups at the same level on the same dimension will be removed by a single call.
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byRows);
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byRows);
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byColumns);
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byColumns);
    await context.sync();
});

Dissocie les colonnes et les lignes d’un plan.

ungroup(groupOption: "ByRows" | "ByColumns"): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.10

Annule la fusion de la plage de cellules.

unmerge(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.2

Exemples

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:C3";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.unmerge();
    await context.sync(); 
});

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la libération de mémoire prenne effet.

untrack(): Excel.Range;

Retours

Exemples

await Excel.run(async (context) => {
    const largeRange = context.workbook.getSelectedRange();
    largeRange.load(["rowCount", "columnCount"]);
    await context.sync();

    for (let i = 0; i < largeRange.rowCount; i++) {
        for (let j = 0; j < largeRange.columnCount; j++) {
            const cell = largeRange.getCell(i, j);
            cell.values = [[i *j]];

            // Call untrack() to release the range from memory.
            cell.untrack();
        }
    }

    await context.sync();
});