Excel.WorksheetCollection class
Représente une collection d’objets de feuille de calcul qui font partie du classeur.
- Extends
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
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 |
get |
Obtient la feuille de calcul active du classeur. |
get |
Obtient le nombre de feuilles de calcul dans la collection. |
get |
Obtient la première feuille de calcul dans la collection. |
get |
Obtient un objet de feuille de calcul à l’aide de son nom ou de son ID. |
get |
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 |
get |
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 |
load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
toJSON() | Remplace la méthode JavaScript |
Événements
on |
Se produit lorsqu’une feuille de calcul du classeur est activée. |
on |
Se produit lorsqu’une nouvelle feuille de calcul est ajoutée au classeur. |
on |
Se produit lorsqu’une feuille de calcul du classeur est calculée. |
on |
Se produit lorsqu’une feuille de calcul dans le classeur est modifiée. |
on |
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. |
on |
Se produit lorsqu’une feuille de calcul du classeur est désactivée. |
on |
Se produit lorsqu’une feuille de calcul est supprimée du classeur. |
on |
Se produit lorsque le format d’une feuille de calcul du classeur est modifié. |
on |
Se produit lorsqu’une ou plusieurs formules sont modifiées dans une feuille de calcul de cette collection. 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. |
on |
Se produit lorsqu’une feuille de calcul est déplacée dans un classeur. Cet événement se déclenche uniquement lorsqu’une feuille de calcul est déplacée directement dans un classeur. Cet événement ne se déclenche pas lorsque la position d’une feuille de calcul est modifiée indirectement, par exemple lorsqu’une nouvelle feuille de calcul est insérée et que les feuilles de calcul existantes changent de position. |
on |
Se produit lorsque le nom de la feuille de calcul est modifié dans la collection de feuilles de calcul. |
on |
Se produit lorsque l’état de protection de la feuille de calcul est modifié. |
on |
Se produit lorsque l’état masqué d’une ou plusieurs lignes a changé dans une feuille de calcul spécifique. |
on |
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. |
on |
Se produit lorsque la sélection change sur n’importe quelle feuille de calcul. |
on |
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. |
on |
Se produit lorsque la visibilité de la feuille de calcul est modifiée dans la collection de feuilles de calcul. |
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é
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: Excel.Worksheet[];
Valeur de propriété
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
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
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 true
la 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
getFirst(visibleOnly)
Obtient la première feuille de calcul dans la collection.
getFirst(visibleOnly?: boolean): Excel.Worksheet;
Paramètres
- visibleOnly
-
boolean
Optional. Si true
la valeur est , prend uniquement en compte les feuilles de calcul visibles, en ignorant toutes les feuilles de calcul masquées.
Retours
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
Remarques
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
Remarques
getLast(visibleOnly)
Obtient la dernière feuille de calcul dans la collection.
getLast(visibleOnly?: boolean): Excel.Worksheet;
Paramètres
- visibleOnly
-
boolean
Optional. Si true
la valeur est , prend uniquement en compte les feuilles de calcul visibles, en ignorant toutes les feuilles de calcul masquées.
Retours
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
Fournit des options pour les propriétés de l’objet à charger.
Retours
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
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
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.
toJSON(): Excel.Interfaces.WorksheetCollectionData;
Retours
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
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
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
Remarques
onChanged
Se produit lorsqu’une feuille de calcul dans le classeur est modifiée.
readonly onChanged: OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>;
Type d'événement
Remarques
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
Remarques
onDeactivated
Se produit lorsqu’une feuille de calcul du classeur est désactivée.
readonly onDeactivated: OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>;
Type d'événement
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
Remarques
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
Remarques
onFormulaChanged
Se produit lorsqu’une ou plusieurs formules sont modifiées dans une feuille de calcul de cette collection. 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
onMoved
Se produit lorsqu’une feuille de calcul est déplacée dans un classeur. Cet événement se déclenche uniquement lorsqu’une feuille de calcul est déplacée directement dans un classeur. Cet événement ne se déclenche pas lorsque la position d’une feuille de calcul est modifiée indirectement, par exemple lorsqu’une nouvelle feuille de calcul est insérée et que les feuilles de calcul existantes changent de position.
readonly onMoved: OfficeExtension.EventHandlers<Excel.WorksheetMovedEventArgs>;
Type d'événement
Remarques
onNameChanged
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
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
Remarques
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
Remarques
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
Remarques
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
Remarques
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
Remarques
onVisibilityChanged
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>;