Excel.Workbook class
Workbook est l’objet de niveau supérieur qui contient des objets de classeur associés tels que des feuilles de calcul, des tableaux et des plages. Pour en savoir plus sur le modèle objet de classeur, consultez Utiliser des classeurs à l’aide de l’API JavaScript Excel.
- Extends
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
Propriétés
| application | Représente l’application Excel instance qui contient ce classeur. |
| bindings | Représente une collection de liaisons appartenant au classeur. |
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| custom |
Représente la collection de parties XML personnalisées contenues dans ce classeur. |
| data |
Représente toutes les connexions de données dans le classeur. |
| functions | Représente une collection de fonctions de feuille de calcul qui peuvent être utilisées pour le calcul. |
| name | Obtient le nom du classeur. |
| names | Représente une collection d’éléments nommés de portée classeur (plages et constantes nommées). |
| pivot |
Représente une collection de tableaux croisés dynamiques associés au classeur. |
| properties | Obtient les propriétés du classeur. |
| protection | Retourne l’objet de protection d’un classeur. |
| read |
Retourne |
| settings | Représente une collection de paramètres associés au classeur. |
| styles | Représente une collection de styles associés au classeur. |
| tables | Représente une collection de tableaux associés au classeur. |
| worksheets | Représente une collection de feuilles de calcul associées au classeur. |
Méthodes
| get |
Obtient la cellule active du classeur. |
| get |
Obtient la plage unique actuellement sélectionnée à partir du classeur. Si plusieurs plages sont sélectionnées, cette méthode génère une erreur. |
| 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 |
Événements
| on |
Se produit quand la sélection change dans le document. |
Détails de la propriété
application
Représente l’application Excel instance qui contient ce classeur.
readonly application: Excel.Application;Valeur de propriété
Remarques
bindings
Représente une collection de liaisons appartenant au classeur.
readonly bindings: Excel.BindingCollection;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é
customXmlParts
Représente la collection de parties XML personnalisées contenues dans ce classeur.
readonly customXmlParts: Excel.CustomXmlPartCollection;Valeur de propriété
Remarques
dataConnections
Représente toutes les connexions de données dans le classeur.
readonly dataConnections: Excel.DataConnectionCollection;Valeur de propriété
Remarques
functions
Représente une collection de fonctions de feuille de calcul qui peuvent être utilisées pour le calcul.
readonly functions: Excel.Functions;Valeur de propriété
Remarques
name
Obtient le nom du classeur.
readonly name: string;Valeur de propriété
string
Remarques
names
Représente une collection d’éléments nommés de portée classeur (plages et constantes nommées).
readonly names: Excel.NamedItemCollection;Valeur de propriété
Remarques
pivotTables
Représente une collection de tableaux croisés dynamiques associés au classeur.
readonly pivotTables: Excel.PivotTableCollection;Valeur de propriété
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 workbook.
const pivotTables = context.workbook.pivotTables;
pivotTables.load("name");
await context.sync();
// Display the names in the console.
console.log("PivotTables in the workbook:")
pivotTables.items.forEach((pivotTable) => {
console.log(`\t${pivotTable.name}`);
});
});
properties
Obtient les propriétés du classeur.
readonly properties: Excel.DocumentProperties;Valeur de propriété
Remarques
[ Ensemble d’API : ExcelApi 1.7 ]
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/properties.yaml
await Excel.run(async (context) => {
let titleValue = "Excel document properties API";
let subjectValue = "Set and get document properties";
let keywordsValue = "Set and get operations";
let commentsValue = "This is an Excel document properties API code sample";
let categoryValue = "Office Add-ins";
let managerValue = "John";
let companyValue = "Microsoft";
let docProperties = context.workbook.properties;
// Set the writeable document properties.
docProperties.title = titleValue;
docProperties.subject = subjectValue;
docProperties.keywords = keywordsValue;
docProperties.comments = commentsValue;
docProperties.category = categoryValue;
docProperties.manager = managerValue;
docProperties.company = companyValue;
await context.sync();
console.log("Set the following document properties: title, subject, keywords, comments, category, manager, company.");
});
protection
Retourne l’objet de protection d’un classeur.
readonly protection: Excel.WorkbookProtection;Valeur de propriété
Remarques
readOnly
Retourne true si le classeur est ouvert en mode lecture seule.
readonly readOnly: boolean;Valeur de propriété
boolean
Remarques
settings
Représente une collection de paramètres associés au classeur.
readonly settings: Excel.SettingCollection;Valeur de propriété
Remarques
styles
Représente une collection de styles associés au classeur.
readonly styles: Excel.StyleCollection;Valeur de propriété
Remarques
[ Ensemble d’API : ExcelApi 1.7 ]
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml
await Excel.run(async (context) => {
let styles = context.workbook.styles;
// Add a new style to the style collection.
// Styles is in the Home tab ribbon.
styles.add("Diagonal Orientation Style");
let newStyle = styles.getItem("Diagonal Orientation Style");
// The "Diagonal Orientation Style" properties.
newStyle.textOrientation = 38;
newStyle.autoIndent = true;
newStyle.includeProtection = true;
newStyle.shrinkToFit = true;
newStyle.locked = false;
await context.sync();
console.log("Successfully added a new style with diagonal orientation to the Home tab ribbon.");
});
tables
Représente une collection de tableaux associés au classeur.
readonly tables: Excel.TableCollection;Valeur de propriété
Remarques
worksheets
Représente une collection de feuilles de calcul associées au classeur.
readonly worksheets: Excel.WorksheetCollection;Valeur de propriété
Remarques
Détails de la méthode
getActiveCell()
Obtient la cellule active du classeur.
getActiveCell(): Excel.Range;Retours
Remarques
[ Ensemble d’API : ExcelApi 1.7 ]
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-get-active-cell.yaml
await Excel.run(async (context) => {
let myWorkbook = context.workbook;
let activeCell = myWorkbook.getActiveCell();
activeCell.load("address");
await context.sync();
console.log("The active cell is " + activeCell.address);
});
getSelectedRange()
Obtient la plage unique actuellement sélectionnée à partir du classeur. Si plusieurs plages sont sélectionnées, cette méthode génère une erreur.
getSelectedRange(): Excel.Range;Retours
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
Exemples
await Excel.run(async (context) => {
const selectedRange = context.workbook.getSelectedRange();
selectedRange.load('address');
await context.sync();
console.log(selectedRange.address);
});
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.WorkbookLoadOptions): Excel.Workbook;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.Workbook;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
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.Workbook;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.WorkbookUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Excel.Interfaces.WorkbookUpdateData
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
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.Workbook): void;Paramètres
- properties
- Excel.Workbook
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.Workbook est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.WorkbookDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Excel.Interfaces.WorkbookData;Retours
Détails de l'événement
onSelectionChanged
Se produit quand la sélection change dans le document.
readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.SelectionChangedEventArgs>;