Excel. Worksheet class

Exemples

// Get a Worksheet object by its name and activate it.
await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.activate();
    await context.sync(); 
});

Propriétés

autoFilter	Représente l’objet `AutoFilter` de la feuille de calcul.
charts	Retourne une collection de graphiques qui font partie de la feuille de calcul.
comments	Renvoie une collection de tous les objets Lecteur sur l’ordinateur.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
customProperties	Obtient une collection de propriétés personnalisées au niveau de la feuille de calcul.
enableCalculation	Détermine si Excel doit recalculer la feuille de calcul si nécessaire. True si Excel recalcule la feuille de calcul si nécessaire. Elle a la valeur False si Excel ne recalcule pas la feuille.
freezePanes	Obtient un objet qui peut être utilisé pour manipuler des volets figés dans la feuille de calcul.
horizontalPageBreaks	Obtient la collection de saut de page horizontal pour la feuille de calcul. Cette collection contient uniquement les sauts de page manuels.
id	Renvoie une valeur qui permet d’identifier la feuille de calcul de façon unique dans un classeur donné. La valeur de l’identificateur reste identique, même lorsque la feuille de calcul est renommée ou déplacée.
name	Nom complet de la feuille de calcul. Le nom doit comporter moins de 32 caractères.
namedSheetViews	Retourne une collection d’affichages feuille qui sont présents dans la feuille de calcul.
names	Collection de noms inclus dans l’étendue de la feuille de calcul active.
pageLayout	Obtient l’objet `PageLayout` de la feuille de calcul.
pivotTables	Collection de tableaux croisés dynamiques qui font partie de la feuille de calcul.
position	Position de la feuille de calcul au sein du classeur (sur une base zéro).
protection	Renvoie l’objet de protection de feuille pour une feuille de calcul.
shapes	Renvoie une collection de tous les objets Forme sur la feuille de calcul.
showGridlines	Spécifie si le quadrillage est visible par l’utilisateur.
showHeadings	Spécifie si les titres sont visibles par l’utilisateur.
slicers	Retourne une collection de segments qui font partie de la feuille de calcul.
standardHeight	Renvoie la hauteur standard (par défaut) de toutes les lignes dans la feuille de calcul, en points.
standardWidth	Spécifie la largeur standard (par défaut) de toutes les colonnes de la feuille de calcul. Une unité de largeur de colonne est égale à la largeur d'un caractère du style Normal. Dans le cas des polices proportionnelles, la largeur du caractère 0 (zéro) est utilisée.
tabColor	Couleur d’onglet de la feuille de calcul. Lors de la récupération de la couleur de l’onglet, si la feuille de calcul est invisible, la valeur est `null`. Si la feuille de calcul est visible, mais que la couleur de l’onglet est définie sur auto, une chaîne vide est retournée. Sinon, la propriété sera définie sur une couleur, au format #RRGGBB (par exemple, « FFA500 »). Lorsque vous définissez la couleur, utilisez une chaîne vide pour définir une couleur « auto » ou une couleur réelle dans le cas contraire.
tabId	Retourne une valeur représentant cette feuille de calcul qui peut être lue par Open Office XML. Il s’agit d’une valeur entière, qui est différente de `worksheet.id` (qui retourne un identificateur global unique) et `worksheet.name` (qui retourne une valeur telle que « Sheet1 »).
tables	Collection de tableaux qui font partie de la feuille de calcul.
tasks	Retourne une collection de tâches présentes dans la feuille de calcul.
verticalPageBreaks	Obtient la collection de saut de page vertical pour la feuille de calcul. Cette collection contient uniquement les sauts de page manuels.
visibility	Visibilité de la feuille de calcul.

Méthodes

activate()	Active la feuille de calcul dans l’interface utilisateur Excel.
calculate(markAllDirty)	Calcule toutes les cellules d’une feuille de calcul.
copy(positionType, relativeTo)	Copie une feuille de calcul et la place à la position spécifiée.
copy(positionTypeString, relativeTo)	Copie une feuille de calcul et la place à la position spécifiée.
delete()	Supprime la feuille de calcul du classeur. Notez que si la visibilité de la feuille de calcul est définie sur « VeryHidden », l’opération de suppression échoue avec une `InvalidOperation` exception. Vous devez d’abord modifier sa visibilité sur masquée ou visible avant de la supprimer.
findAll(text, criteria)	Recherche toutes les occurrences de la chaîne donnée en fonction des critères spécifiés et les renvoie en tant qu’objet `RangeAreas` , comprenant une ou plusieurs plages rectangulaires.
findAllOrNullObject(text, criteria)	Recherche toutes les occurrences de la chaîne donnée en fonction des critères spécifiés et les renvoie en tant qu’objet `RangeAreas` , comprenant une ou plusieurs plages rectangulaires.
getCell(row, column)	Obtient l’objet `Range` contenant la cellule unique en fonction 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 feuille de calcul.
getNext(visibleOnly)	Obtient la feuille de calcul qui suit celle-ci. Si aucune feuille de calcul ne suit celle-ci, cette méthode génère une erreur.
getNextOrNullObject(visibleOnly)	Obtient la feuille de calcul qui suit celle-ci. Si aucune feuille de calcul ne suit celle-ci, cette méthode retourne un objet avec sa `isNullObject` propriété définie sur `true`. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getPrevious(visibleOnly)	Obtient la feuille de calcul qui précède celle-ci. S’il n’existe aucune feuille de calcul précédente, cette méthode génère une erreur.
getPreviousOrNullObject(visibleOnly)	Obtient la feuille de calcul qui précède celle-ci. S’il n’existe aucune feuille de calcul précédente, cette méthode retourne un objet avec sa `isNullObject` propriété définie sur `true`. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getRange(address)	Obtient l’objet `Range` , qui représente un seul bloc rectangulaire de cellules, spécifié par l’adresse ou le nom.
getRangeByIndexes(startRow, startColumn, rowCount, columnCount)	Obtient l’objet `Range` commençant à un index de ligne et d’un index de colonne particuliers, et couvrant un certain nombre de lignes et de colonnes.
getRanges(address)	Obtient l’objet `RangeAreas` , qui représente un ou plusieurs blocs de plages rectangulaires, spécifiés par l’adresse ou le nom.
getUsedRange(valuesOnly)	La plage utilisée est la plus petite plage qui englobe toutes les cellules auxquelles une valeur ou un format est affecté. Si la feuille de calcul entière est vide, cette fonction renvoie la cellule supérieure gauche (c’est-à-dire qu’elle ne génère pas d’erreur).
getUsedRangeOrNullObject(valuesOnly)	La plage utilisée est la plus petite plage qui englobe toutes les cellules auxquelles une valeur ou un format est affecté. Si la feuille de calcul entière est vide, cette méthode retourne un objet avec sa `isNullObject` propriété définie sur `true`. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
load(options)	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)	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)	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.
replaceAll(text, replacement, criteria)	Détecte et remplace la chaîne donnée basée sur les critères spécifiés dans la plage active.
set(properties, options)	Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties)	Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
showOutlineLevels(rowLevels, columnLevels)	Affiche les groupes de lignes ou de colonnes selon leurs niveaux hiérarchiques. Présente les groupes et résume une liste de données dans la feuille de calcul. Les `rowLevels` paramètres et `columnLevels` spécifient le nombre de niveaux du plan qui seront affichés. La plage d’arguments acceptables est comprise entre 0 et 8. La valeur 0 ne modifie pas l’affichage actuel. Une valeur supérieure au nombre actuel de niveaux affiche tous les niveaux.
toJSON()	Remplace la méthode JavaScript `toJSON()` afin de fournir une sortie plus utile lorsqu’un objet API est passé à `JSON.stringify()`. (`JSON.stringify`appelle à son tour la `toJSON` méthode de l’objet qui lui est passé.) Alors que l’objet d’origine `Excel.Worksheet` est un objet API, la `toJSON` méthode renvoie un objet JavaScript brut (typé en tant `Excel.Interfaces.WorksheetData`que ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Événements

onActivated	Se produit lorsque la feuille de calcul est activée.
onCalculated	Se produit lorsque la feuille de calcul est calculée.
onChanged	Se produit lorsque les données changent dans une feuille de calcul spécifique.
onColumnSorted	Se produit lorsqu’une ou plusieurs colonnes ont été triées. Cela se produit à la suite d’une opération de tri de gauche à droite.
onDeactivated	Se produit lorsque la feuille de calcul est désactivée.
onFiltered	Se produit lorsqu’un filtre est appliqué à une feuille de calcul spécifique.
onFormatChanged	Se produit lorsque le filtre est modifié sur un tableau spécifique.
onFormulaChanged	Se produit lorsqu’une ou plusieurs formules sont modifiées dans cette feuille de calcul. Cet événement est destiné au moment où la formule elle-même change, et non la valeur de données résultant du calcul de la formule.
onNameChanged	Se produit lorsque le nom de la feuille de calcul est modifié.
onProtectionChanged	Se produit lorsque l’état de protection de la feuille de calcul est modifié.
onRowHiddenChanged	Se produit lorsque l’état masqué d’une ou plusieurs lignes a changé dans une feuille de calcul spécifique.
onRowSorted	Se produit lorsqu’une ou plusieurs lignes ont été triées. Cela se produit en raison d’une opération de tri de haut en bas.
onSelectionChanged	Se produit lorsque la sélection change dans une feuille de calcul spécifique.
onSingleClicked	Se produit lorsqu’une action avec clic gauche/appuyé se produit dans la feuille de calcul. Cet événement ne sera pas déclenché lors d’un clic dans les cas suivants : L’utilisateur fait glisser la souris pour la sélection multiple. L’utilisateur sélectionne une cellule en mode lorsque les arguments de cellule sont sélectionnés pour les références de formule.
onVisibilityChanged	Se produit lorsque la visibilité de la feuille de calcul est modifiée.

Détails de la propriété

autoFilter

Représente l’objet AutoFilter de la feuille de calcul.

readonly autoFilter: Excel.AutoFilter;

Valeur de propriété

Excel.AutoFilter

Remarques

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function adds a percentage AutoFilter to the active worksheet 
// and applies the filter to a column of the used range.
await Excel.run(async (context) => {
    // Retrieve the active worksheet and the used range on that worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const farmData = sheet.getUsedRange();

    // Add a filter that will only show the rows with the top 50% of values in column 3.
    sheet.autoFilter.apply(farmData, 3, {
        criterion1: "50",
        filterOn: Excel.FilterOn.topPercent
    });

    await context.sync();
});

charts

Retourne une collection de graphiques qui font partie de la feuille de calcul.

readonly charts: Excel.ChartCollection;

Valeur de propriété

Excel.ChartCollection

Remarques

comments

Renvoie une collection de tous les objets Lecteur sur l’ordinateur.

readonly comments: Excel.CommentCollection;

Valeur de propriété

Excel.CommentCollection

Remarques

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

customProperties

Obtient une collection de propriétés personnalisées au niveau de la feuille de calcul.

readonly customProperties: Excel.WorksheetCustomPropertyCollection;

Valeur de propriété

Excel.WorksheetCustomPropertyCollection

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml

await Excel.run(async (context) => {
  // Load the keys and values of all custom properties in the current worksheet.
  const customWorksheetProperties = context.workbook.worksheets.getActiveWorksheet().customProperties;
  customWorksheetProperties.load(["key", "value"]);
  await context.sync();

  // Log each custom property to the console.
  // Note that your document may have more properties than those you have set using this snippet.
  customWorksheetProperties.items.forEach((property) => {
    console.log(`${property.key}:${property.value}`);
  });
});

enableCalculation

Détermine si Excel doit recalculer la feuille de calcul si nécessaire. True si Excel recalcule la feuille de calcul si nécessaire. Elle a la valeur False si Excel ne recalcule pas la feuille.

enableCalculation: boolean;

Valeur de propriété

boolean

Remarques

freezePanes

Obtient un objet qui peut être utilisé pour manipuler des volets figés dans la feuille de calcul.

readonly freezePanes: Excel.WorksheetFreezePanes;

Valeur de propriété

Excel.WorksheetFreezePanes

Remarques

horizontalPageBreaks

Obtient la collection de saut de page horizontal pour la feuille de calcul. Cette collection contient uniquement les sauts de page manuels.

readonly horizontalPageBreaks: Excel.PageBreakCollection;

Valeur de propriété

Excel.PageBreakCollection

Remarques

id

Renvoie une valeur qui permet d’identifier la feuille de calcul de façon unique dans un classeur donné. La valeur de l’identificateur reste identique, même lorsque la feuille de calcul est renommée ou déplacée.

readonly id: string;

Valeur de propriété

string

Remarques

name

Nom complet de la feuille de calcul. Le nom doit comporter moins de 32 caractères.

name: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApiOnline 1.1 ]

namedSheetViews

Retourne une collection d’affichages feuille qui sont présents dans la feuille de calcul.

readonly namedSheetViews: Excel.NamedSheetViewCollection;

Valeur de propriété

Excel.NamedSheetViewCollection

Remarques

names

Collection de noms inclus dans l’étendue de la feuille de calcul active.

readonly names: Excel.NamedItemCollection;

Valeur de propriété

Excel.NamedItemCollection

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

pageLayout

Obtient l’objet PageLayout de la feuille de calcul.

readonly pageLayout: Excel.PageLayout;

Valeur de propriété

Excel.PageLayout

Remarques

pivotTables

Collection de tableaux croisés dynamiques qui font partie de la feuille de calcul.

readonly pivotTables: Excel.PivotTableCollection;

Valeur de propriété

Excel.PivotTableCollection

Remarques

[ Ensemble d’API : ExcelApi 1.3 ]

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) => {
  // Get the names of all the PivotTables in the current worksheet.
  const pivotTables = context.workbook.worksheets.getActiveWorksheet().pivotTables;
  pivotTables.load("name");
  await context.sync();

  // Display the names in the console.
  console.log("PivotTables in the current worksheet:")
  pivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
});

position

Position de la feuille de calcul au sein du classeur (sur une base zéro).

position: number;

Valeur de propriété

number

Remarques

Exemples

// Set worksheet position.
await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.position = 2;
    await context.sync(); 
});

protection

Renvoie l’objet de protection de feuille pour une feuille de calcul.

readonly protection: Excel.WorksheetProtection;

Valeur de propriété

Excel.WorksheetProtection

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

Exemples

// Unprotecting a worksheet with unprotect() will remove all 
// WorksheetProtectionOptions options applied to a worksheet.
// To remove only a subset of WorksheetProtectionOptions use the 
// protect() method and set the options you wish to remove to true.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sheet1");
  sheet.protection.protect({
    allowInsertRows: false, // Protect row insertion
    allowDeleteRows: true // Unprotect row deletion
  });
});

shapes

Renvoie une collection de tous les objets Forme sur la feuille de calcul.

readonly shapes: Excel.ShapeCollection;

Valeur de propriété

Excel.ShapeCollection

Remarques

showGridlines

Spécifie si le quadrillage est visible par l’utilisateur.

showGridlines: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/gridlines.yaml

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

    await context.sync();
});

showHeadings

Spécifie si les titres sont visibles par l’utilisateur.

showHeadings: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

slicers

Retourne une collection de segments qui font partie de la feuille de calcul.

readonly slicers: Excel.SlicerCollection;

Valeur de propriété

Excel.SlicerCollection

Remarques

Exemples

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Pivot");
    const slicer = sheet.slicers.add(
        "Farm Sales", /* The slicer data source. For PivotTables, this can be the PivotTable object reference or name. */
        "Type" /* The field in the data source to filter by. For PivotTables, this can be a PivotField object reference or ID. */
    );
    slicer.name = "Fruit Slicer";
    await context.sync();
});

standardHeight

Renvoie la hauteur standard (par défaut) de toutes les lignes dans la feuille de calcul, en points.

readonly standardHeight: number;

Valeur de propriété

number

Remarques

standardWidth

Spécifie la largeur standard (par défaut) de toutes les colonnes de la feuille de calcul. Une unité de largeur de colonne est égale à la largeur d'un caractère du style Normal. Dans le cas des polices proportionnelles, la largeur du caractère 0 (zéro) est utilisée.

standardWidth: number;

Valeur de propriété

number

Remarques

tabColor

Couleur d’onglet de la feuille de calcul. Lors de la récupération de la couleur de l’onglet, si la feuille de calcul est invisible, la valeur est null. Si la feuille de calcul est visible, mais que la couleur de l’onglet est définie sur auto, une chaîne vide est retournée. Sinon, la propriété sera définie sur une couleur, au format #RRGGBB (par exemple, « FFA500 »). Lorsque vous définissez la couleur, utilisez une chaîne vide pour définir une couleur « auto » ou une couleur réelle dans le cas contraire.

tabColor: string;

Valeur de propriété

string

Remarques

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/tab-color.yaml

await Excel.run(async (context) => {
    const activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.tabColor = "#FF0000";

    await context.sync();
});

tabId

Retourne une valeur représentant cette feuille de calcul qui peut être lue par Open Office XML. Il s’agit d’une valeur entière, qui est différente de worksheet.id (qui retourne un identificateur global unique) et worksheet.name (qui retourne une valeur telle que « Sheet1 »).

readonly tabId: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.14 ]

tables

Collection de tableaux qui font partie de la feuille de calcul.

readonly tables: Excel.TableCollection;

Valeur de propriété

Excel.TableCollection

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

tasks

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Retourne une collection de tâches présentes dans la feuille de calcul.

readonly tasks: Excel.DocumentTaskCollection;

Valeur de propriété

Excel.DocumentTaskCollection

Remarques

verticalPageBreaks

Obtient la collection de saut de page vertical pour la feuille de calcul. Cette collection contient uniquement les sauts de page manuels.

readonly verticalPageBreaks: Excel.PageBreakCollection;

Valeur de propriété

Excel.PageBreakCollection

Remarques

[ Ensemble d’API : ExcelApi 1.1 pour la lecture de la visibilité ; 1.2 pour sa définition. ]

visibility

Visibilité de la feuille de calcul.

visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";

Valeur de propriété

Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"

Remarques

Détails de la méthode

activate()

Active la feuille de calcul dans l’interface utilisateur Excel.

activate(): void;

Retours

void

Remarques

Exemples

await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.activate();
    await context.sync(); 
});

calculate(markAllDirty)

Calcule toutes les cellules d’une feuille de calcul.

calculate(markAllDirty: boolean): void;

Paramètres

markAllDirty: boolean

True, pour marquer tout comme sale.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.6 ]

copy(positionType, relativeTo)

Copie une feuille de calcul et la place à la position spécifiée.

copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet): Excel.Worksheet;

Paramètres

positionType: Excel.WorksheetPositionType

Emplacement dans le classeur où placer la feuille de calcul nouvellement créée. La valeur par défaut est « None », ce qui insère la feuille de calcul au début de la feuille de calcul.

relativeTo: Excel.Worksheet

Feuille de calcul existante qui détermine la position de la feuille de calcul nouvellement créée. Cela n’est nécessaire que si positionType est « Avant » ou « Après ».

Retours

Excel.Worksheet

Feuille de calcul nouvellement créée.

Remarques

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-copy.yaml

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

    let myWorkbook = context.workbook;
    let sampleSheet = myWorkbook.worksheets.getActiveWorksheet();
    let copiedSheet = sampleSheet.copy("End")

    sampleSheet.load("name");
    copiedSheet.load("name");

    await context.sync();

    console.log("'" + sampleSheet.name + "' was copied to '" + copiedSheet.name + "'")
});

copy(positionTypeString, relativeTo)

Copie une feuille de calcul et la place à la position spécifiée.

copy(positionTypeString?: "None" | "Before" | "After" | "Beginning" | "End", relativeTo?: Excel.Worksheet): Excel.Worksheet;

Paramètres

positionTypeString: "None" | "Before" | "After" | "Beginning" | "End"

Emplacement dans le classeur où placer la feuille de calcul nouvellement créée. La valeur par défaut est « None », ce qui insère la feuille de calcul au début de la feuille de calcul.

relativeTo: Excel.Worksheet

Feuille de calcul existante qui détermine la position de la feuille de calcul nouvellement créée. Cela n’est nécessaire que si positionType est « Avant » ou « Après ».

Retours

Excel.Worksheet

Feuille de calcul nouvellement créée.

Remarques

delete()

Supprime la feuille de calcul du classeur. Notez que si la visibilité de la feuille de calcul est définie sur « VeryHidden », l’opération de suppression échoue avec une InvalidOperation exception. Vous devez d’abord modifier sa visibilité sur masquée ou visible avant de la supprimer.

delete(): void;

Retours

void

Remarques

Exemples

await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.delete();
    await context.sync(); 
});

findAll(text, criteria)

Recherche toutes les occurrences de la chaîne donnée en fonction des critères spécifiés et les renvoie en tant qu’objet RangeAreas , comprenant une ou plusieurs plages rectangulaires.

findAll(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

Paramètres

text: string

Chaîne à rechercher.

criteria: Excel.WorksheetSearchCriteria

Critères de recherche supplémentaires, notamment si la recherche doit correspondre à la cellule entière ou respecter la casse.

Retours

Excel.RangeAreas

Objet RangeAreas , comprenant une ou plusieurs plages rectangulaires, qui correspond aux critères de recherche. Si aucune cellule ne répond à ce critère, une ItemNotFound erreur est générée.

Remarques

findAllOrNullObject(text, criteria)

Recherche toutes les occurrences de la chaîne donnée en fonction des critères spécifiés et les renvoie en tant qu’objet RangeAreas , comprenant une ou plusieurs plages rectangulaires.

findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

Paramètres

text: string

Chaîne à rechercher.

criteria: Excel.WorksheetSearchCriteria

Critères de recherche supplémentaires, notamment si la recherche doit correspondre à la cellule entière ou respecter la casse.

Retours

Excel.RangeAreas

Objet RangeAreas , comprenant une ou plusieurs plages rectangulaires, qui correspond aux critères de recherche. S’il n’existe aucune correspondance, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

Remarques

Exemples

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const foundRanges = sheet.findAllOrNullObject("Complete", {
        completeMatch: true,
        matchCase: false
    });

    await context.sync();

    if (foundRanges.isNullObject) {
        console.log("No complete projects");
    } else {
        foundRanges.format.fill.color = "green"
    }
});

getCell(row, column)

Obtient l’objet Range contenant la cellule unique en fonction 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 feuille de calcul.

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

Paramètres

row: number

Numéro de ligne de la cellule à récupérer. Avec indice zéro.

column: number

Numéro de colonne de la cellule à récupérer. Avec indice zéro.

Retours

Excel.Range

Remarques

Exemples

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

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

getNext(visibleOnly)

Obtient la feuille de calcul qui suit celle-ci. Si aucune feuille de calcul ne suit celle-ci, cette méthode génère une erreur.

getNext(visibleOnly?: boolean): Excel.Worksheet;

Paramètres

visibleOnly: boolean

Optional. Si truela valeur est , prend uniquement en compte les feuilles de calcul visibles, en ignorant toutes les feuilles de calcul masquées.

Retours

Excel.Worksheet

Remarques

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml

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

    // We don't want to include the default worksheet that was created
    // when the workbook was created, so our "firstSheet" will be the one
    // after the literal first. Note chaining of navigation methods.
    const firstSheet = sheets.getFirst().getNext();
    const lastSheet = sheets.getLast();
    const firstTaxRateRange = firstSheet.getRange("B2");
    const lastTaxRateRange = lastSheet.getRange("B2");

    firstSheet.load("name");
    lastSheet.load("name");
    firstTaxRateRange.load("text");
    lastTaxRateRange.load("text");

    await context.sync();

    let firstYear = firstSheet.name.substr(5, 4);
    let lastYear = lastSheet.name.substr(5, 4);
    console.log(`Tax Rate change from ${firstYear} to ${lastYear}`, `Tax rate for ${firstYear}: ${firstTaxRateRange.text[0][0]}\nTax rate for ${lastYear}: ${lastTaxRateRange.text[0][0]}`)

    await context.sync();
});

getNextOrNullObject(visibleOnly)

Obtient la feuille de calcul qui suit celle-ci. Si aucune feuille de calcul ne suit celle-ci, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getNextOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

Paramètres

visibleOnly: boolean

Optional. Si truela valeur est , prend uniquement en compte les feuilles de calcul visibles, en ignorant toutes les feuilles de calcul masquées.

Retours

Excel.Worksheet

Remarques

getPrevious(visibleOnly)

Obtient la feuille de calcul qui précède celle-ci. S’il n’existe aucune feuille de calcul précédente, cette méthode génère une erreur.

getPrevious(visibleOnly?: boolean): Excel.Worksheet;

Paramètres

visibleOnly: boolean

Optional. Si truela valeur est , prend uniquement en compte les feuilles de calcul visibles, en ignorant toutes les feuilles de calcul masquées.

Retours

Excel.Worksheet

Remarques

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml

await Excel.run(async (context) => {
    const sheets = context.workbook.worksheets;
    const currentSheet = sheets.getActiveWorksheet();
    const previousYearSheet = currentSheet.getPrevious();
    const currentTaxDueRange = currentSheet.getRange("C2");
    const previousTaxDueRange = previousYearSheet.getRange("C2");

    currentSheet.load("name");
    previousYearSheet.load("name");
    currentTaxDueRange.load("text");
    previousTaxDueRange.load("text");

    await context.sync();

    let currentYear = currentSheet.name.substr(5, 4);
    let previousYear = previousYearSheet.name.substr(5, 4);
    console.log("Two Year Tax Due Comparison", `Tax due for ${currentYear} was ${currentTaxDueRange.text[0][0]}\nTax due for ${previousYear} was ${previousTaxDueRange.text[0][0]}`)

    await context.sync();
});

getPreviousOrNullObject(visibleOnly)

Obtient la feuille de calcul qui précède celle-ci. S’il n’existe aucune feuille de calcul précédente, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getPreviousOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

Paramètres

visibleOnly: boolean

Optional. Si truela valeur est , prend uniquement en compte les feuilles de calcul visibles, en ignorant toutes les feuilles de calcul masquées.

Retours

Excel.Worksheet

Remarques

getRange(address)

Obtient l’objet Range , qui représente un seul bloc rectangulaire de cellules, spécifié par l’adresse ou le nom.

getRange(address?: string): Excel.Range;

Paramètres

address: string

Optional. Chaîne représentant l’adresse ou le nom de la plage. Par exemple, « A1 :B2 ». Si cette propriété n’est pas définie, la plage de la feuille de calcul toute entière est renvoyée.

Retours

Excel.Range

Remarques

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);
});

getRangeByIndexes(startRow, startColumn, rowCount, columnCount)

Obtient l’objet Range commençant à un index de ligne et d’un index de colonne particuliers, et couvrant un certain nombre de lignes et de colonnes.

getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number): Excel.Range;

Paramètres

startRow: number

Ligne de début (indexé zéro).

startColumn: number

Colonne de début (indexé zéro).

rowCount: number

Nombre de lignes à inclure dans la plage.

columnCount: number

Nombre de colonnes à inclure dans la plage.

Retours

Excel.Range

Remarques

getRanges(address)

Obtient l’objet RangeAreas , qui représente un ou plusieurs blocs de plages rectangulaires, spécifiés par l’adresse ou le nom.

getRanges(address?: string): Excel.RangeAreas;

Paramètres

address: string

Optional. Chaîne contenant les adresses ou les noms séparés par des virgules ou des points-virgules des plages individuelles. Par exemple, « A1 :B2, A5 :B5 » ou « A1 :B2 ; A5 :B5". S’il n’est pas spécifié, un RangeAreas objet pour la feuille de calcul entière est retourné.

Retours

Excel.RangeAreas

Remarques

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 specifiedRanges = sheet.getRanges("D3:D5, G3:G5");
    specifiedRanges.format.fill.color = "pink";

    await context.sync();
})

getUsedRange(valuesOnly)

La plage utilisée est la plus petite plage qui englobe toutes les cellules auxquelles une valeur ou un format est affecté. Si la feuille de calcul entière est vide, cette fonction renvoie la cellule supérieure gauche (c’est-à-dire qu’elle ne génère pas d’erreur).

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

Paramètres

valuesOnly: boolean

Optional. Si truela valeur est , considère uniquement les cellules avec des valeurs comme cellules utilisées (en ignorant la mise en forme). [Ensemble d’API : ExcelApi 1.2]

Retours

Excel.Range

Remarques

Exemples

await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    const usedRange = worksheet.getUsedRange();
    usedRange.load('address');
    await context.sync();
    
    console.log(usedRange.address);
});

getUsedRangeOrNullObject(valuesOnly)

La plage utilisée est la plus petite plage qui englobe toutes les cellules auxquelles une valeur ou un format est affecté. Si la feuille de calcul entière est vide, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

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

Paramètres

valuesOnly: boolean

Optional. Prend uniquement en compte les cellules avec des valeurs sous forme de cellules utilisées.

Retours

Excel.Range

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

load(options)

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.WorksheetLoadOptions): Excel.Worksheet;

Paramètres

options: Excel.Interfaces.WorksheetLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.Worksheet

load(propertyNames)

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.Worksheet;

Paramètres

propertyNames: string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Excel.Worksheet

Exemples

// Get worksheet properties based on sheet name.
await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.load('position')
    await context.sync();
    
    console.log(worksheet.position);
});

load(propertyNamesAndPaths)

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.Worksheet;

Paramètres

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Excel.Worksheet

replaceAll(text, replacement, criteria)

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

text: string

Chaîne à rechercher.

replacement: string

Chaîne qui remplace la chaîne d’origine.

criteria: Excel.ReplaceCriteria

Critères de remplacement supplémentaires.

Retours

OfficeExtension.ClientResult<number>

Nombre de remplacements effectués.

Remarques

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

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

Paramètres

properties: Excel.Interfaces.WorksheetUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options: OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

Exemples

// Set the color and name of the current worksheet.
await Excel.run(async (context) => {
  const activeSheet = context.workbook.worksheets.getActiveWorksheet();
  activeSheet.set({
    tabColor: "yellow",
    name: "MySheet"
  });

  await context.sync();
});

set(properties)

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

set(properties: Excel.Worksheet): void;

Paramètres

properties: Excel.Worksheet

Retours

void

showOutlineLevels(rowLevels, columnLevels)

Affiche les groupes de lignes ou de colonnes selon leurs niveaux hiérarchiques. Présente les groupes et résume une liste de données dans la feuille de calcul. Les rowLevels paramètres et columnLevels spécifient le nombre de niveaux du plan qui seront affichés. La plage d’arguments acceptables est comprise entre 0 et 8. La valeur 0 ne modifie pas l’affichage actuel. Une valeur supérieure au nombre actuel de niveaux affiche tous les niveaux.

showOutlineLevels(rowLevels: number, columnLevels: number): void;

Paramètres

rowLevels: number

Nombre de niveaux de ligne d’un plan à afficher.

columnLevels: number

Nombre de niveaux de colonne d’un plan à afficher.

Retours

void

Remarques

OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>

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 shows the top 3 outline levels; collapsing any additional sublevels.
    sheet.showOutlineLevels(3, 3);
    await context.sync();
});

toJSON()

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

toJSON(): Excel.Interfaces.WorksheetData;

Retours

Excel.Interfaces.WorksheetData

Détails de l'événement

onActivated

Se produit lorsque la feuille de calcul est activée.

readonly onActivated: OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>;

Type d'événement

Remarques

OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>

Exemples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onActivated.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The activated worksheet ID is: " + event.worksheetId);
            await context.sync();
        });
    });
    await context.sync();
});

onCalculated

Se produit lorsque la feuille de calcul est calculée.

readonly onCalculated: OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>;

Type d'événement

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Exemples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onCalculated.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The worksheet has recalculated.");
            await context.sync();
        });
    });
    await context.sync();
});

onChanged

Se produit lorsque les données changent dans une feuille de calcul spécifique.

readonly onChanged: OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>;

Type d'événement

OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>

Remarques

OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml

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

    console.log("Added a worksheet-level data-changed event handler.");
});

onColumnSorted

Se produit lorsqu’une ou plusieurs colonnes ont été triées. Cela se produit à la suite d’une opération de tri de gauche à droite.

readonly onColumnSorted: OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>;

Type d'événement

Remarques

OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>

Exemples

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

await Excel.run(async (context) => {
    console.log("Adding column handler");
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // This will fire whenever a column has been moved as the result of a sort action.
    sheet.onColumnSorted.add((event) => {
        return Excel.run((context) => {
            console.log("Column sorted: " + event.address);
            const sheet = context.workbook.worksheets.getActiveWorksheet();

            // Clear formatting for section, then highlight the sorted area.
            sheet.getRange("A1:E5").format.fill.clear();
            if (event.address !== "") {
                sheet.getRanges(event.address).format.fill.color = "yellow";
            }

            return context.sync();
        });
    });
});

onDeactivated

Se produit lorsque la feuille de calcul est désactivée.

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>;

Type d'événement

Remarques

OfficeExtension.EventHandlers<Excel.WorksheetFilteredEventArgs>

Exemples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onDeactivated.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The deactivated worksheet is: " + event.worksheetId);
            await context.sync();
        });
    });
    await context.sync();
});

onFiltered

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Se produit lorsqu’un filtre est appliqué à une feuille de calcul spécifique.

readonly onFiltered: OfficeExtension.EventHandlers<Excel.WorksheetFilteredEventArgs>;

Type d'événement

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

onFormatChanged

Se produit lorsque le filtre est modifié sur un tableau spécifique.

readonly onFormatChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>;

Type d'événement

OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>

Remarques

OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>

onFormulaChanged

Se produit lorsqu’une ou plusieurs formules sont modifiées dans cette feuille de calcul. Cet événement est destiné au moment où la formule elle-même change, et non la valeur de données résultant du calcul de la formule.

readonly onFormulaChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>;

Type d'événement

Remarques

[ Ensemble d’API : ExcelApi 1.13 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-formula-changed.yaml

await Excel.run(async (context) => {
  // Retrieve the worksheet named "Sample".
  let sheet = context.workbook.worksheets.getItem("Sample");
  
  // Register the formula changed event handler for this worksheet.
  sheet.onFormulaChanged.add(formulaChangeHandler);
  await context.sync();
  
  console.log("Registered a formula changed event handler for this worksheet.");
});

...

async function formulaChangeHandler(event: Excel.WorksheetFormulaChangedEventArgs) {
  await Excel.run(async (context) => {
    // Retrieve details about the formula change event.
    const cellAddress = event.formulaDetails[0].cellAddress;
    const previousFormula = event.formulaDetails[0].previousFormula;
    const source = event.source;
    
    // Print out the change event details.
    console.log(
      `The formula in cell ${cellAddress} changed. 
      The previous formula was: ${previousFormula}. 
      The source of the change was: ${source}.`
    );
  });
}

onNameChanged

Se produit lorsque le nom de la feuille de calcul est modifié.

readonly onNameChanged: OfficeExtension.EventHandlers<Excel.WorksheetNameChangedEventArgs>;

Type d'événement

OfficeExtension.EventHandlers<Excel.WorksheetNameChangedEventArgs>

Remarques

[ Ensemble d’API : ExcelApi 1.17 ]

onProtectionChanged

Se produit lorsque l’état de protection de la feuille de calcul est modifié.

readonly onProtectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetProtectionChangedEventArgs>;

Type d'événement

OfficeExtension.EventHandlers<Excel.WorksheetProtectionChangedEventArgs>

Remarques

[ Ensemble d’API : ExcelApi 1.14 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet-protection.yaml

// This function registers an event handler for the onProtectionChanged event of a worksheet.
await Excel.run(async (context) => {
    // Set "Sample" as the active worksheet.
    context.workbook.worksheets.getItemOrNullObject("Sample").delete();
    const sheet = context.workbook.worksheets.add("Sample");
    sheet.activate();

    // Register the onProtectionChanged event handler.
    sheet.onProtectionChanged.add(checkProtection);
    await context.sync();
    console.log("Added a worksheet protection change event handler.");
});

...

async function checkProtection(event: Excel.WorksheetProtectionChangedEventArgs) {
    // This function is an event handler that returns the protection status of a worksheet
    // and information about the changed worksheet.
    await Excel.run(async (context) => {
        const protectionStatus = event.isProtected;
        const worksheetId = event.worksheetId;
        const source = event.source;
        console.log("Protection status changed. Protection status is now: " + protectionStatus + ".");
        console.log("    ID of changed worksheet: " + worksheetId + ".");
        console.log("    Source of change event: " + source + ".");
    });
}

onRowHiddenChanged

Se produit lorsque l’état masqué d’une ou plusieurs lignes a changé dans une feuille de calcul spécifique.

readonly onRowHiddenChanged: OfficeExtension.EventHandlers<Excel.WorksheetRowHiddenChangedEventArgs>;

Type d'événement

OfficeExtension.EventHandlers<Excel.WorksheetRowHiddenChangedEventArgs>

Remarques

[ Ensemble d’API : ExcelApi 1.11 ]

Exemples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.onRowHiddenChanged.add(function (event) {
        return Excel.run(async (context) => {
            console.log(`Row ${event.address} is now ${event.changeType}`);
            await context.sync();
        });
    });
    await context.sync();
});

onRowSorted

Se produit lorsqu’une ou plusieurs lignes ont été triées. Cela se produit en raison d’une opération de tri de haut en bas.

readonly onRowSorted: OfficeExtension.EventHandlers<Excel.WorksheetRowSortedEventArgs>;

Type d'événement

OfficeExtension.EventHandlers<Excel.WorksheetRowSortedEventArgs>

Remarques

OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>

Exemples

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

await Excel.run(async (context) => {
    console.log("Adding row handler");
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // This will fire whenever a row has been moved as the result of a sort action.
    sheet.onRowSorted.add((event) => {
        return Excel.run((context) => {
            console.log("Row sorted: " + event.address);
            const sheet = context.workbook.worksheets.getActiveWorksheet();

            // Clear formatting for section, then highlight the sorted area.
            sheet.getRange("A1:E5").format.fill.clear();
            if (event.address !== "") {
                sheet.getRanges(event.address).format.fill.color = "yellow";
            }

            return context.sync();
        });
    });
});

onSelectionChanged

Se produit lorsque la sélection change dans une feuille de calcul spécifique.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>;

Type d'événement

Remarques

OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>

Exemples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onSelectionChanged.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The selected range has changed to: " + event.address);
            await context.sync();
        });
    });
    await context.sync();
});

onSingleClicked

Se produit lorsqu’une action avec clic gauche/appuyé se produit dans la feuille de calcul. Cet événement ne sera pas déclenché lors d’un clic dans les cas suivants :

L’utilisateur fait glisser la souris pour la sélection multiple.
L’utilisateur sélectionne une cellule en mode lorsque les arguments de cellule sont sélectionnés pour les références de formule.

readonly onSingleClicked: OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>;

Type d'événement

Remarques