Excel.Workbook class
Le classeur est l’objet de niveau supérieur qui contient des objets de classeur associés tels que des feuilles de calcul, des tables et des plages. Pour en savoir plus sur le modèle objet de classeur, consultez Utiliser des classeurs à l’aide de l’API JavaScript d’Excel.
- Extends
Remarques
Utilisateur
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);
});
Propriétés
| application | Représente l’instance d’application Excel qui contient ce classeur. |
| auto |
Spécifie si le classeur est en mode d’enregistrement automatique. |
| bindings | Représente une collection de liaisons appartenant au classeur. |
| calculation |
Renvoie un nombre sur la version de moteur de calcul Excel. |
| chart |
True si tous les graphiques dans le classeur suivent les points de données réelles auquel qu’il sont joints. False si les graphiques suivent l’index des points de données. |
| comments | Représente un ensemble de commentaires associés au classeur. |
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| custom |
Représente l’ensemble des parties XML personnalisées contenues dans ce classeur. |
| data |
Représente toutes les connexions de données dans le classeur. |
| external |
Spécifie la durée maximale, en secondes, allouée à une formule qui dépend d’un service de code externe. La plage valide est comprise entre 1 et 86 400 inclus. |
| functions | Représente un ensemble de fonctions de feuille de calcul pouvant être utilisées pour le calcul. |
| is |
Indique si des modifications ont été apportées depuis le dernier enregistrement du classeur. Vous pouvez définir cette propriété sur |
| linked |
Renvoie une collection de domaines de données d’entité liés qui sont disponibles dans le classeur. |
| linked |
Renvoie une collection de classeurs liés. Dans les formules, les liens de classeur peuvent être utilisés pour référencer des données (valeurs et noms de cellules) en dehors du classeur actif. |
| local |
Renvoie l’objet |
| name | Obtient le nom du classeur. |
| names | Représente une collection d’éléments nommés de portée de classeur (plages nommées et constantes). |
| notes | Renvoie une collection de tous les objets de notes du classeur. |
| pivot |
Représente une collection de tableaux croisés dynamiques associés au classeur. |
| pivot |
Représente une collection de PivotTableStyles associée au classeur. |
| previously |
Indique si le classeur a déjà été enregistré localement ou en ligne. |
| properties | Obtient les propriétés du classeur. |
| protection | Renvoie l’objet de protection pour un classeur. |
| queries | Renvoie un ensemble de requêtes Power Query qui font partie du classeur. |
| read |
Retourne |
| sensitivity |
Renvoie l’étiquette de confidentialité du classeur. |
| settings | Représente un ensemble de paramètres associés au classeur. |
| show |
Indique si le volet de liste de champs du tableau croisé dynamique s’affiche au niveau du classeur. |
| slicers | Représente une collection de segments associés au classeur. |
| slicer |
Représente une collection de styles 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. |
| table |
Représente une collection de TableStyles associés au classeur. |
| tasks | Renvoie un ensemble de tâches présentes dans le classeur. |
| timeline |
Représente une collection de TimelineStyles associés au classeur. |
| use1904Date |
True si le classeur utilise le calendrier depuis 1904. |
| use |
True si les calculs réalisés dans ce classeur utiliseront uniquement la précision des nombres tels qu’ils sont affichés. Les données perdront définitivement de leur précision lors du basculement de cette propriété de |
| worksheets | Représente une collection de feuilles de calcul associées au classeur. |
Méthodes
| autorun |
Avertit l’application hôte que l’exécution du code du complément est terminée dans un événement d’exécution automatique. |
| close(close |
Fermer le classeur actif. |
| close(close |
Fermer le classeur actif. |
| focus() | Définit le focus sur le classeur. Cela provoque la réception d’événements de clavier par la grille Excel ou l’objet actif. |
| get |
Obtient la cellule active du classeur. |
| get |
Obtient la feuille de calcul active du classeur. S’il n’y a aucun graphique actif, une |
| get |
Obtient la feuille de calcul active du classeur. S’il n’y a pas de graphique actif, cette méthode renvoie un objet dont la |
| get |
Obtient la forme active dans le classeur. Génère une |
| get |
Obtient la forme active dans le classeur. S’il n’y a pas de forme active, cette méthode renvoie un objet dont la |
| get |
Obtient le segment actif actuel du classeur. S’il n’y a pas de segment actif, une |
| get |
Obtient le segment actif actuel du classeur. S’il n’y a pas de segment actif, cette méthode renvoie un objet dont la |
| get |
Retourne |
| get |
Retourne a |
| get |
Obtient la plage unique actuellement sélectionnée à partir du classeur. Si plusieurs plages sont sélectionnées, cette méthode renvoie une erreur. |
| get |
Obtient la ou les plage(s) sélectionnée(s) actuelle(s) dans le classeur. Contrairement à |
| in |
Indique si le classeur est actuellement en mode aperçu. |
| insert |
Insère les feuilles de calcul spécifiées à partir d’un classeur source dans le classeur actif. La |
| 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 |
| save(save |
Enregistrer le classeur actif. |
| save(save |
Enregistrer le classeur actif. |
| set(properties, options) | Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit 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 lorsque le classeur est activé. Remarque : cet événement ne se déclenche pas lorsque le classeur est ouvert. |
| on |
Se produit lorsque le paramètre d’enregistrement automatique est modifié dans le classeur. |
| on |
Se produit quand la sélection change dans le document. |
Détails de la propriété
application
Représente l’instance d’application Excel qui contient ce classeur.
readonly application: Excel.Application;Valeur de propriété
Remarques
autoSave
Spécifie si le classeur est en mode d’enregistrement automatique.
readonly autoSave: boolean;Valeur de propriété
boolean
Remarques
bindings
Représente une collection de liaisons appartenant au classeur.
readonly bindings: Excel.BindingCollection;Valeur de propriété
Remarques
calculationEngineVersion
Renvoie un nombre sur la version de moteur de calcul Excel.
readonly calculationEngineVersion: number;Valeur de propriété
number
Remarques
chartDataPointTrack
True si tous les graphiques dans le classeur suivent les points de données réelles auquel qu’il sont joints. False si les graphiques suivent l’index des points de données.
chartDataPointTrack: boolean;Valeur de propriété
boolean
Remarques
comments
Représente un ensemble de commentaires associés au classeur.
readonly comments: Excel.CommentCollection;Valeur de propriété
Remarques
context
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é
customXmlParts
Représente l’ensemble des 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
externalCodeServiceTimeout
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Spécifie la durée maximale, en secondes, allouée à une formule qui dépend d’un service de code externe. La plage valide est comprise entre 1 et 86 400 inclus.
externalCodeServiceTimeout: number;Valeur de propriété
number
Remarques
functions
Représente un ensemble de fonctions de feuille de calcul pouvant être utilisées pour le calcul.
readonly functions: Excel.Functions;Valeur de propriété
Remarques
isDirty
Indique si des modifications ont été apportées depuis le dernier enregistrement du classeur. Vous pouvez définir cette propriété sur true si vous souhaitez fermer un classeur modifié sans l’enregistrer ou être invité à l’enregistrer.
isDirty: boolean;Valeur de propriété
boolean
Remarques
linkedEntityDataDomains
Renvoie une collection de domaines de données d’entité liés qui sont disponibles dans le classeur.
readonly linkedEntityDataDomains: Excel.LinkedEntityDataDomainCollection;Valeur de propriété
Remarques
linkedWorkbooks
Renvoie une collection de classeurs liés. Dans les formules, les liens de classeur peuvent être utilisés pour référencer des données (valeurs et noms de cellules) en dehors du classeur actif.
readonly linkedWorkbooks: Excel.LinkedWorkbookCollection;Valeur de propriété
Remarques
localImage
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Renvoie l’objet LocalImage associé au classeur.
readonly localImage: Excel.LocalImage;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 de classeur (plages nommées et constantes).
readonly names: Excel.NamedItemCollection;Valeur de propriété
Remarques
notes
Renvoie une collection de tous les objets de notes du classeur.
readonly notes: Excel.NoteCollection;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
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}`);
});
});
pivotTableStyles
Représente une collection de PivotTableStyles associée au classeur.
readonly pivotTableStyles: Excel.PivotTableStyleCollection;Valeur de propriété
Remarques
previouslySaved
Indique si le classeur a déjà été enregistré localement ou en ligne.
readonly previouslySaved: boolean;Valeur de propriété
boolean
Remarques
properties
Obtient les propriétés du classeur.
readonly properties: Excel.DocumentProperties;Valeur de propriété
Remarques
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
Renvoie l’objet de protection pour un classeur.
readonly protection: Excel.WorkbookProtection;Valeur de propriété
Remarques
queries
Renvoie un ensemble de requêtes Power Query qui font partie du classeur.
readonly queries: Excel.QueryCollection;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
sensitivityLabel
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Renvoie l’étiquette de confidentialité du classeur.
readonly sensitivityLabel: Excel.SensitivityLabel;Valeur de propriété
Remarques
settings
Représente un ensemble de paramètres associés au classeur.
readonly settings: Excel.SettingCollection;Valeur de propriété
Remarques
showPivotFieldList
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Indique si le volet de liste de champs du tableau croisé dynamique s’affiche au niveau du classeur.
showPivotFieldList: boolean;Valeur de propriété
boolean
Remarques
slicers
Représente une collection de segments associés au classeur.
readonly slicers: Excel.SlicerCollection;Valeur de propriété
Remarques
slicerStyles
Représente une collection de styles associés au classeur.
readonly slicerStyles: Excel.SlicerStyleCollection;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
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
tableStyles
Représente une collection de TableStyles associés au classeur.
readonly tableStyles: Excel.TableStyleCollection;Valeur de propriété
Remarques
tasks
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Renvoie un ensemble de tâches présentes dans le classeur.
readonly tasks: Excel.DocumentTaskCollection;Valeur de propriété
Remarques
timelineStyles
Représente une collection de TimelineStyles associés au classeur.
readonly timelineStyles: Excel.TimelineStyleCollection;Valeur de propriété
Remarques
use1904DateSystem
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
True si le classeur utilise le calendrier depuis 1904.
use1904DateSystem: boolean;Valeur de propriété
boolean
Remarques
usePrecisionAsDisplayed
True si les calculs réalisés dans ce classeur utiliseront uniquement la précision des nombres tels qu’ils sont affichés. Les données perdront définitivement de leur précision lors du basculement de cette propriété de false à true.
usePrecisionAsDisplayed: boolean;Valeur de propriété
boolean
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
autorunEventCompleted(AutorunEventCompletedOptions)
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Avertit l’application hôte que l’exécution du code du complément est terminée dans un événement d’exécution automatique.
autorunEventCompleted(AutorunEventCompletedOptions: Excel.AutorunEventCompletedOptions): void;Paramètres
- AutorunEventCompletedOptions
- Excel.AutorunEventCompletedOptions
Obligatoire. Options permettant de terminer l’événement d’exécution automatique.
Retours
void
Remarques
close(closeBehavior)
Fermer le classeur actif.
close(closeBehavior?: Excel.CloseBehavior): void;Paramètres
- closeBehavior
- Excel.CloseBehavior
Comportement de fermeture de classeur.
Retours
void
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-save-and-close.yaml
await Excel.run(async (context) => {
context.workbook.close(Excel.CloseBehavior.save);
});
close(closeBehavior)
Fermer le classeur actif.
close(closeBehavior?: "Save" | "SkipSave"): void;Paramètres
- closeBehavior
-
"Save" | "SkipSave"
Comportement de fermeture de classeur.
Retours
void
Remarques
focus()
Définit le focus sur le classeur. Cela provoque la réception d’événements de clavier par la grille Excel ou l’objet actif.
focus(): void;Retours
void
Remarques
getActiveCell()
Obtient la cellule active du classeur.
getActiveCell(): Excel.Range;Retours
Remarques
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);
});
getActiveChart()
Obtient la feuille de calcul active du classeur. S’il n’y a aucun graphique actif, une ItemNotFound exception est levée.
getActiveChart(): Excel.Chart;Retours
Remarques
getActiveChartOrNullObject()
Obtient la feuille de calcul active du classeur. S’il n’y a pas de graphique actif, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getActiveChartOrNullObject(): Excel.Chart;Retours
Remarques
getActiveShape()
Obtient la forme active dans le classeur. Génère une ItemNotFound erreur s’il n’y a pas de forme active.
getActiveShape(): Excel.Shape;Retours
Remarques
getActiveShapeOrNullObject()
Obtient la forme active dans le classeur. S’il n’y a pas de forme active, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getActiveShapeOrNullObject(): Excel.Shape;Retours
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-get-active.yaml
// This method gets the active shape and displays it as an image in the task pane.
await Excel.run(async (context) => {
// Get the currently active shape, if any.
const activeShape = context.workbook.getActiveShapeOrNullObject();
if (activeShape) {
// Convert the active shape to an image.
const shapeImage = activeShape.getAsImage(Excel.PictureFormat.png);
await context.sync();
// Display the image in the task pane.
const imageContainer = document.getElementById("image");
imageContainer.innerHTML = ''; // Clear the container before adding a new image.
const imageElement = document.createElement("img");
imageElement.src = "data:image/png;base64," + shapeImage.value;
imageContainer.appendChild(imageElement);
} else {
console.log("No active shape");
}
});
getActiveSlicer()
Obtient le segment actif actuel du classeur. S’il n’y a pas de segment actif, une ItemNotFound exception est levée.
getActiveSlicer(): Excel.Slicer;Retours
Remarques
getActiveSlicerOrNullObject()
Obtient le segment actif actuel du classeur. S’il n’y a pas de segment actif, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getActiveSlicerOrNullObject(): Excel.Slicer;Retours
Remarques
getIsActiveCollabSession()
Retourne true si le classeur est en cours de modification par plusieurs utilisateurs (par le biais de la co-édition). Veuillez noter qu’il peut y avoir un certain délai entre le moment où le status du classeur change et le moment où les modifications sont répercutées sur le résultat de la méthode.
getIsActiveCollabSession(): OfficeExtension.ClientResult<boolean>;Retours
OfficeExtension.ClientResult<boolean>
Remarques
getLinkedEntityCellValue(linkedEntityCellValueId)
Retourne a LinkedEntityCellValue en fonction de la valeur .LinkedEntityId
getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId): OfficeExtension.ClientResult<LinkedEntityCellValue>;Paramètres
- linkedEntityCellValueId
- Excel.LinkedEntityId
Identificateur qui spécifie un individu LinkedEntityCellValue.
Retours
Remarques
getSelectedRange()
Obtient la plage unique actuellement sélectionnée à partir du classeur. Si plusieurs plages sont sélectionnées, cette méthode renvoie une erreur.
getSelectedRange(): Excel.Range;Retours
Remarques
Exemples
await Excel.run(async (context) => {
const selectedRange = context.workbook.getSelectedRange();
selectedRange.load('address');
await context.sync();
console.log(selectedRange.address);
});
getSelectedRanges()
Obtient la ou les plage(s) sélectionnée(s) actuelle(s) dans le classeur. Contrairement à getSelectedRange(), cette méthode renvoie un RangeAreas objet qui représente toutes les plages sélectionnées.
getSelectedRanges(): Excel.RangeAreas;Retours
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml
await Excel.run(async (context) => {
const selectedRanges = context.workbook.getSelectedRanges();
selectedRanges.format.fill.color = "lightblue";
await context.sync();
})
inPreviewMode()
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Indique si le classeur est actuellement en mode aperçu.
inPreviewMode(): OfficeExtension.ClientResult<boolean>;Retours
OfficeExtension.ClientResult<boolean>
Remarques
insertWorksheetsFromBase64(base64File, options)
Insère les feuilles de calcul spécifiées à partir d’un classeur source dans le classeur actif.
La extensionHardening clé de Registre Windows affecte cette API. L’extension de fichier définie par le base64File paramètre doit correspondre au type de fichier réel du fichier inséré. Si extensionHardening est configuré pour refuser les incompatibilités et que l’extension de fichier ne correspond pas au type de fichier réel, cette API génère l’erreur suivante : « Cette opération n’est pas autorisée en raison de la stratégie de renforcement de l’extension. »
insertWorksheetsFromBase64(base64File: string, options?: Excel.InsertWorksheetOptions): OfficeExtension.ClientResult<string[]>;Paramètres
- base64File
-
string
Obligatoire. Chaîne codée en Base64 représentant le fichier de classeur source.
- options
- Excel.InsertWorksheetOptions
Facultatif. Les options qui définissent les feuilles de calcul à insérer et l’emplacement dans le classeur où les nouvelles feuilles de calcul seront insérées. Par défaut, toutes les feuilles de calcul du classeur source sont insérées à la fin du classeur actif.
Retours
OfficeExtension.ClientResult<string[]>
Tableau d’ID correspondant à chaque feuille de calcul nouvellement insérée.
Remarques
Pour l’instant, cette API n’est prise en charge que pour Office sur Windows, Mac et le web. Dans Excel sur le Web, cette API ne prend pas en charge l’insertion de graphiques, de commentaires, de tableaux croisés dynamiques ou de segments.
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-insert-external-worksheets.yaml
// Retrieve the file and set up an HTML FileReader element.
const myFile = document.getElementById("file") as HTMLInputElement;
const reader = new FileReader();
reader.onload = (event) => {
// Remove the metadata before the Base64-encoded string.
const startIndex = reader.result.toString().indexOf("base64,");
externalWorkbook = reader.result.toString().substr(startIndex + 7);
};
// Read the file as a data URL so that we can parse the Base64-encoded string.
reader.readAsDataURL(myFile.files[0]);
...
await Excel.run(async (context) => {
// Retrieve the source workbook.
const workbook = context.workbook;
// Set up the insert options.
const options = {
sheetNamesToInsert: [], // Insert all the worksheets from the source workbook.
positionType: Excel.WorksheetPositionType.after, // Insert after the `relativeTo` sheet.
relativeTo: "Sheet1" // The sheet relative to which the other worksheets will be inserted. Used with `positionType`.
};
// Insert the new worksheets.
workbook.insertWorksheetsFromBase64(externalWorkbook, options);
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.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 spécifiant 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
save(saveBehavior)
Enregistrer le classeur actif.
save(saveBehavior?: Excel.SaveBehavior): void;Paramètres
- saveBehavior
- Excel.SaveBehavior
Le comportement de sauvegarde doit être « Enregistrer » ou « Invite ». La valeur par défaut est « Enregistrer ».
Retours
void
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-save-and-close.yaml
await Excel.run(async (context) => {
context.workbook.save(Excel.SaveBehavior.save);
});
save(saveBehavior)
Enregistrer le classeur actif.
save(saveBehavior?: "Save" | "Prompt"): void;Paramètres
- saveBehavior
-
"Save" | "Prompt"
Le comportement de sauvegarde doit être « Enregistrer » ou « Invite ». La valeur par défaut est « Enregistrer ».
Retours
void
Remarques
set(properties, options)
Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.
set(properties: Interfaces.WorkbookUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Excel.Interfaces.WorkbookUpdateData
Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux 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 de propriétés 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.stringify, à son tour, appelle 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 simple (typé ) Excel.Interfaces.WorkbookDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.WorkbookData;Retours
Détails de l’événement
onActivated
Se produit lorsque le classeur est activé. Remarque : cet événement ne se déclenche pas lorsque le classeur est ouvert.
readonly onActivated: OfficeExtension.EventHandlers<Excel.WorkbookActivatedEventArgs>;Type d’événement
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-activated.yaml
async function workbookActivated(event: Excel.WorkbookActivatedEventArgs) {
await Excel.run(async (context) => {
// Callback function for when the workbook is activated.
console.log("The workbook was activated.");
});
}
...
await Excel.run(async (context) => {
const workbook = context.workbook;
// Register the workbook activated event handler.
workbook.onActivated.add(workbookActivated);
await context.sync();
console.log("Added event handler for workbook activated.");
});
onAutoSaveSettingChanged
Se produit lorsque le paramètre d’enregistrement automatique est modifié dans le classeur.
readonly onAutoSaveSettingChanged: OfficeExtension.EventHandlers<Excel.WorkbookAutoSaveSettingChangedEventArgs>;Type d’événement
Remarques
onSelectionChanged
Se produit quand la sélection change dans le document.
readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.SelectionChangedEventArgs>;