Excel.Worksheet class
Une feuille de calcul Excel est une grille de cellules. Il peut contenir des données, des tables, des graphiques, etc. Pour en savoir plus sur le modèle objet de feuille de calcul, consultez Utiliser des feuilles de calcul à l’aide de l’API JavaScript Excel.
- Extends
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
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. |
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. |
position | Position de la feuille de calcul au sein du classeur (sur une base zéro). |
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. |
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 |
get |
Obtient l’objet |
get |
Obtient l’objet |
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 |
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 |
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é
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é
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
position
Position de la feuille de calcul au sein du classeur (sur une base zéro).
position: number;
Valeur de propriété
number
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
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();
});
tables
Collection de tableaux qui font partie de la feuille de calcul.
readonly tables: Excel.TableCollection;
Valeur de propriété
Remarques
visibility
Visibilité de la feuille de calcul.
visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";
Valeur de propriété
Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"
Remarques
[ Ensemble d’API : ExcelApi 1.1 pour la lecture de la visibilité ; 1.2 pour sa définition. ]
Détails de la méthode
activate()
Active la feuille de calcul dans l’interface utilisateur Excel.
activate(): void;
Retours
void
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
Exemples
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.activate();
await context.sync();
});
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
[ Ensemble d’API : ExcelApi 1.1 ]
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
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
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);
});
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
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
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);
});
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
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.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
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
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.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.
toJSON(): Excel.Interfaces.WorksheetData;