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

charts	Retourne une collection de graphiques qui font partie de la feuille de calcul.
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
freezePanes	Obtient un objet qui peut être utilisé pour manipuler des volets figés dans la feuille de calcul.
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.
names	Collection de noms inclus dans l’étendue de la feuille de calcul active.
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.
showGridlines	Spécifie si le quadrillage est visible par l’utilisateur.
showHeadings	Spécifie si les titres sont visibles par l’utilisateur.
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.
tables	Collection de tableaux qui font partie de la feuille de calcul.
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.
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.
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.
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.
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.
onDeactivated	Se produit lorsque la feuille de calcul est désactivée.
onSelectionChanged	Se produit lorsque la sélection change dans une feuille de calcul spécifique.

Détails de la propriété

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

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

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

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

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 ]

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

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 ]

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

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

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

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

OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>

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

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

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.WorksheetDeactivatedEventArgs>

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

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.WorksheetSelectionChangedEventArgs>

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

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