Excel.WorksheetCollection class

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é

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: Excel.Worksheet[];

Valeur de propriété

Ajoute une nouvelle feuille de calcul au classeur. La feuille de calcul est ajoutée à la fin des feuilles de calcul existantes. Si vous souhaitez activer la feuille de calcul nouvellement ajoutée, appelez-la .activate() .

add(name?: string): Excel.Worksheet;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => { 
    const wSheetName = 'Sample Name';
    const worksheet = context.workbook.worksheets.add(wSheetName);
    worksheet.load('name');
    await context.sync();
    
    console.log(worksheet.name);
});

Obtient la feuille de calcul active du classeur.

getActiveWorksheet(): Excel.Worksheet;

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => {  
    const activeWorksheet = context.workbook.worksheets.getActiveWorksheet();
    activeWorksheet.load('name');
    await context.sync();
    console.log(activeWorksheet.name);
});

Obtient le nombre de feuilles de calcul dans la collection.

getCount(visibleOnly?: boolean): OfficeExtension.ClientResult<number>;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.4

Obtient la première feuille de calcul dans la collection.

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

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.5

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

Obtient un objet de feuille de calcul à l’aide de son nom ou de son ID.

getItem(key: string): Excel.Worksheet;

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/10-chart/chart-axis-formatting.yaml

function displayUnit(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let chart = sheet.charts.getItem("SalesChart");
    let axis = chart.axes.valueAxis;
    axis.displayUnit = "Thousands";
}

Obtient un objet de feuille de calcul à l’aide de son nom ou de son ID. Si la feuille de calcul n’existe pas, 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.

getItemOrNullObject(key: string): Excel.Worksheet;

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/90-scenarios/performance-optimization.yaml

/** Helper to create or recreate a worksheet. */
async function forceCreateSheet(workbook: Excel.Workbook, sheetName: string): Promise<Excel.Worksheet> {
  workbook.worksheets.getItemOrNullObject(sheetName).delete();
  await workbook.context.sync();
  return workbook.worksheets.add(sheetName);
}

Obtient la dernière feuille de calcul dans la collection.

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

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.5

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

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.WorksheetCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCollection;

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

Paramètres

Retours

Exemples

await Excel.run(async (context) => { 
    const worksheets = context.workbook.worksheets;
    worksheets.load('items');
    await context.sync();
    
    for (let i = 0; i < worksheets.items.length; i++) {
        console.log(worksheets.items[i].name);
    }
});

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?: OfficeExtension.LoadOption): Excel.WorksheetCollection;

Paramètres

Retours

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.WorksheetCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.WorksheetCollectionDataqui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): Excel.Interfaces.WorksheetCollectionData;

Retours

Se produit lorsqu’une feuille de calcul du classeur est activée.

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

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

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

await Excel.run(async (context) => {
    let sheets = context.workbook.worksheets;
    sheets.onActivated.add(onActivate);

    await context.sync();
    console.log("A handler has been registered for the OnActivate event.");
});

Se produit lorsqu’une nouvelle feuille de calcul est ajoutée au classeur.

readonly onAdded: OfficeExtension.EventHandlers<Excel.WorksheetAddedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

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

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets;
    sheet.onAdded.add(onWorksheetAdd);

    await context.sync();
    console.log("A handler has been registered for the OnAdded event.");
});

Se produit lorsqu’une feuille de calcul du classeur est calculée.

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

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.8

Se produit lorsqu’une feuille de calcul dans le classeur est modifiée.

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

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.9

Se produit lorsqu’une ou plusieurs colonnes ont été triées. Ce problème se produit en raison de l’opération de tri de gauche à droite.

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

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.10

Se produit quand une feuille de calcul du classeur est désactivée.

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

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

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

await Excel.run(async (context) => {
    let sheets = context.workbook.worksheets;
    sheets.onDeactivated.add(onDeactivate);

    await context.sync();
    console.log("A handler has been registered for the OnDeactivate event.");
});

Se produit lorsqu’une feuille de calcul est supprimée du classeur.

readonly onDeleted: OfficeExtension.EventHandlers<Excel.WorksheetDeletedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.7

Se produit lorsque le format d’une feuille de calcul du classeur a changé.

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

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.9

Se produit lorsqu’une ou plusieurs formules sont modifiées dans une feuille de calcul de cette collection. Cet événement concerne la modification de la formule elle-même, 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

Jeu d’API : ExcelApi 1.13

Se produit lorsqu’une feuille de calcul est déplacée au sein d’un classeur. Cet événement se déclenche uniquement lorsqu’une feuille de calcul est directement déplacée au sein d’un classeur. Cet événement ne se déclenche pas lorsque la position d’une feuille de calcul est indirectement modifiée, par exemple lorsqu’une nouvelle feuille de calcul est insérée, et entraîne la modification des positions des feuilles de calcul existantes.

readonly onMoved: OfficeExtension.EventHandlers<Excel.WorksheetMovedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.17

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

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

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.17

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

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

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.14

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

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

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.11

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

Remarques

Jeu d’API : ExcelApi 1.10

Se produit lorsque la sélection change sur n’importe quelle feuille de calcul.

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

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.9

Se produit lorsque l’opération clic/appui gauche se produit dans la collection de feuilles 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 dans le 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

Jeu d’API : ExcelApi 1.10

Se produit lorsque la visibilité de la feuille de calcul est modifiée dans la collection de feuilles de calcul.

readonly onVisibilityChanged: OfficeExtension.EventHandlers<Excel.WorksheetVisibilityChangedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.17

Exemples

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

await Excel.run(async (context) => {
    // Register an event handler for visibility changes to any worksheet in the collection.
    context.workbook.worksheets.onVisibilityChanged.add(onWorksheetCollectionVisibilityChanged);

    await context.sync();
    console.log("Registered the worksheet collection visibility changed event handler.");
});

...

async function onWorksheetCollectionVisibilityChanged(args: Excel.WorksheetVisibilityChangedEventArgs) {
    console.log(`Worksheet collection event: Worksheet ${args.worksheetId} visibility changed from ${args.visibilityBefore} to ${args.visibilityAfter}.`);
}