Excel.WorksheetCollection class

Référence

Paquet:: excel

Représente une collection d’objets de feuille de calcul qui font partie du classeur.

Extends: OfficeExtension.ClientObject

Remarques

Propriétés

context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
items	Obtient l’élément enfant chargé dans cette collection de sites.

Méthodes

add(name)	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 qui vient d’être ajoutée, appelez-la `.activate()` .
getActiveWorksheet()	Obtient la feuille de calcul active du classeur.
getCount(visibleOnly)	Obtient le nombre de feuilles de calcul dans la collection.
getFirst(visibleOnly)	Obtient la première feuille de calcul dans la collection.
getItem(key)	Obtient un objet de feuille de calcul à l’aide de son nom ou de son ID.
getItemOrNullObject(key)	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 retourne un objet avec sa `isNullObject` propriété définie sur `true`. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getLast(visibleOnly)	Obtient la dernière feuille de calcul dans la collection.
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.
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.WorksheetCollection` est un objet API, la `toJSON` méthode renvoie un objet JavaScript brut (typé en tant `Excel.Interfaces.WorksheetCollectionData`que ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

Événements

onActivated	Se produit lorsqu’une feuille de calcul du classeur est activée.
onAdded	Se produit lorsqu’une nouvelle feuille de calcul est ajoutée au classeur.
onCalculated	Se produit lorsqu’une feuille de calcul du classeur est calculée.
onChanged	Se produit lorsqu’une feuille de calcul dans le classeur est modifiée.
onColumnSorted	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.
onDeactivated	Se produit lorsqu’une feuille de calcul du classeur est désactivée.
onDeleted	Se produit lorsqu’une feuille de calcul est supprimée du classeur.
onFormatChanged	Se produit lorsque le format d’une feuille de calcul du classeur 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 sur n’importe quelle feuille de calcul.
onSingleClicked	Se produit lorsque l’opération avec clic gauche/appuyé se produit dans la collection de feuilles de calcul. Cet événement n’est 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.

Détails de la propriété

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

items

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

readonly items: Excel.Worksheet[];

Valeur de propriété

Excel.Worksheet[]

Détails de la méthode

add(name)

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 qui vient d’être ajoutée, appelez-la .activate() .

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

Paramètres

name: string

Optional. Nom de la feuille de calcul à ajouter. S’il est spécifié, le nom doit être unique. Si cette propriété n’est pas définie, Excel détermine le nom de la nouvelle feuille de calcul.

Retours

Excel.Worksheet

Remarques

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

getActiveWorksheet()

Obtient la feuille de calcul active du classeur.

getActiveWorksheet(): Excel.Worksheet;

Retours

Excel.Worksheet

Remarques

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

getCount(visibleOnly)

Obtient le nombre de feuilles de calcul dans la collection.

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

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

OfficeExtension.ClientResult<number>

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

getFirst(visibleOnly)

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

getFirst(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

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

getItem(key)

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

getItem(key: string): Excel.Worksheet;

Paramètres

key: string

Nom ou ID de la feuille de calcul.

Retours

Excel.Worksheet

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

getItemOrNullObject(key)

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 retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getItemOrNullObject(key: string): Excel.Worksheet;

Paramètres

key: string

Nom ou ID de la feuille de calcul.

Retours

Excel.Worksheet

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

getLast(visibleOnly)

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

getLast(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

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

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

Paramètres

options: Excel.Interfaces.WorksheetCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Retours

Excel.WorksheetCollection

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

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

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

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

Paramètres

propertyNamesAndPaths: OfficeExtension.LoadOption

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

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.WorksheetCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.WorksheetCollectionDataque ) qui 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

Excel.Interfaces.WorksheetCollectionData

Détails de l'événement

onActivated

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

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

Type d'événement

OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>

Remarques

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

onAdded

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

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

Type d'événement

OfficeExtension.EventHandlers<Excel.WorksheetAddedEventArgs>

Remarques

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

onCalculated

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

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

Type d'événement

OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

onChanged

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

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

Type d'événement

OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

onColumnSorted

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

OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

onDeactivated

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

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

Type d'événement

OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>

Remarques

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

onDeleted

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

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

Type d'événement

OfficeExtension.EventHandlers<Excel.WorksheetDeletedEventArgs>

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

onFormatChanged

Se produit lorsque le format d’une feuille de calcul du classeur est modifié.

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

Type d'événement

OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

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 ]

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

[ Ensemble d’API : ExcelApi 1.10 ]

onSelectionChanged

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

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

Type d'événement

OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

onSingleClicked

Se produit lorsque l’opération avec clic gauche/appuyé se produit dans la collection de feuilles de calcul. Cet événement n’est 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

OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Partager via

Excel.WorksheetCollection class

Remarques

Propriétés

Méthodes

Événements

Détails de la propriété

context

Valeur de propriété

items

Valeur de propriété

Détails de la méthode

add(name)

Paramètres

Retours

Remarques

Exemples

getActiveWorksheet()

Retours

Remarques

Exemples

getCount(visibleOnly)

Paramètres

Retours

Remarques

getFirst(visibleOnly)

Paramètres

Retours

Remarques

Exemples

getItem(key)

Paramètres

Retours

Remarques

getItemOrNullObject(key)

Paramètres

Retours

Remarques

getLast(visibleOnly)

Paramètres

Retours

Remarques

Exemples

load(options)

Paramètres

Retours

load(propertyNames)

Paramètres

Retours

Exemples

load(propertyNamesAndPaths)

Paramètres

Retours

toJSON()

Retours

Détails de l'événement

onActivated

Type d'événement

Remarques

Exemples

onAdded

Type d'événement

Remarques

Exemples

onCalculated

Type d'événement

Remarques

onChanged

Type d'événement

Remarques

onColumnSorted

Type d'événement

Remarques

onDeactivated

Type d'événement

Remarques

Exemples

onDeleted

Type d'événement

Remarques