Excel.Application class
Représente l’application Excel qui gère le classeur.
- Extends
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
Propriétés
calculation |
Renvoie la version du moteur de calcul Excel utilisée pour le dernier recalcul complet. |
calculation |
Retourne le mode de calcul utilisé dans le classeur, tel que défini par les constantes dans |
calculation |
Renvoie l’état de calcul de l’application. Pour plus d’informations, consultez |
context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
culture |
Fournit des informations basées sur les paramètres de culture système actuels. Cela inclut les noms de culture, la mise en forme des nombres et d’autres paramètres dépendants de la culture. |
decimal |
Obtient la chaîne utilisée comme séparateur décimal pour les valeurs numériques. Cela est basé sur les paramètres Excel locaux. |
iterative |
Retourne les paramètres de calcul itératifs. Dans Excel sur Windows et Mac, les paramètres s’appliquent à l’application Excel. Dans Excel sur le Web et d’autres plateformes, les paramètres s’appliquent au classeur actif. |
thousands |
Obtient la chaîne utilisée pour séparer les groupes de chiffres à gauche du décimal pour les valeurs numériques. Cela est basé sur les paramètres Excel locaux. |
use |
Spécifie si les séparateurs système d’Excel sont activés. Les séparateurs système incluent le séparateur décimal et le séparateur de milliers. |
Méthodes
calculate(calculation |
Recalcule tous les classeurs actuellement ouverts dans Excel. |
calculate(calculation |
Recalcule tous les classeurs actuellement ouverts dans Excel. |
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. |
suspend |
Suspend le calcul jusqu’à ce que le suivant |
suspend |
Suspend la mise à jour de l’écran jusqu’à ce que le suivant
Remarque* : n’appelez |
toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
calculationEngineVersion
Renvoie la version du moteur de calcul Excel utilisée pour le dernier recalcul complet.
readonly calculationEngineVersion: number;
Valeur de propriété
number
Remarques
calculationMode
Retourne le mode de calcul utilisé dans le classeur, tel que défini par les constantes dans Excel.CalculationMode
. Les valeurs possibles sont : Automatic
, où Excel contrôle le recalcul ;AutomaticExceptTables
, où Excel contrôle le recalcul mais ignore les modifications apportées aux tableaux ; Manual
, où le calcul est effectué lorsque l’utilisateur le demande.
calculationMode: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual";
Valeur de propriété
Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual"
Remarques
calculationState
Renvoie l’état de calcul de l’application. Pour plus d’informations, consultez Excel.CalculationState
.
readonly calculationState: Excel.CalculationState | "Done" | "Calculating" | "Pending";
Valeur de propriété
Excel.CalculationState | "Done" | "Calculating" | "Pending"
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é
cultureInfo
Fournit des informations basées sur les paramètres de culture système actuels. Cela inclut les noms de culture, la mise en forme des nombres et d’autres paramètres dépendants de la culture.
readonly cultureInfo: Excel.CultureInfo;
Valeur de propriété
Remarques
decimalSeparator
Obtient la chaîne utilisée comme séparateur décimal pour les valeurs numériques. Cela est basé sur les paramètres Excel locaux.
readonly decimalSeparator: string;
Valeur de propriété
string
Remarques
[ Ensemble d’API : ExcelApi 1.11 ]
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/culture-info.yaml
await Excel.run(async (context) => {
context.application.load("decimalSeparator,thousandsSeparator");
context.application.cultureInfo.numberFormat.load("numberDecimalSeparator,numberGroupSeparator");
await context.sync();
// Local settings are set under the "Options > Advanced" menu.
const localDecimalSeparator = context.application.decimalSeparator;
const localThousandsSeparator = context.application.thousandsSeparator;
const systemDecimalSeparator = context.application.cultureInfo.numberFormat.numberDecimalSeparator;
const systemThousandsSeparator = context.application.cultureInfo.numberFormat.numberGroupSeparator;
console.log("Local character settings: ");
console.log(` Local decimal separator: ${localDecimalSeparator}`);
console.log(` Local thousands separator: ${localThousandsSeparator}`);
console.log("System culture settings: ");
console.log(` System decimal separator: ${systemDecimalSeparator}`);
console.log(` System thousands separator: ${systemThousandsSeparator}`);
console.log(` `);
await context.sync();
});
iterativeCalculation
Retourne les paramètres de calcul itératifs. Dans Excel sur Windows et Mac, les paramètres s’appliquent à l’application Excel. Dans Excel sur le Web et d’autres plateformes, les paramètres s’appliquent au classeur actif.
readonly iterativeCalculation: Excel.IterativeCalculation;
Valeur de propriété
Remarques
thousandsSeparator
Obtient la chaîne utilisée pour séparer les groupes de chiffres à gauche du décimal pour les valeurs numériques. Cela est basé sur les paramètres Excel locaux.
readonly thousandsSeparator: string;
Valeur de propriété
string
Remarques
useSystemSeparators
Spécifie si les séparateurs système d’Excel sont activés. Les séparateurs système incluent le séparateur décimal et le séparateur de milliers.
readonly useSystemSeparators: boolean;
Valeur de propriété
boolean
Remarques
Détails de la méthode
calculate(calculationType)
Recalcule tous les classeurs actuellement ouverts dans Excel.
calculate(calculationType: Excel.CalculationType): void;
Paramètres
- calculationType
- Excel.CalculationType
Spécifie le type de calcul à utiliser. Pour plus d’informations, consultez Excel.CalculationType
.
Retours
void
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/90-scenarios/performance-optimization.yaml
await Excel.run(async (context) => {
context.application.calculate(Excel.CalculationType.full);
});
calculate(calculationTypeString)
Recalcule tous les classeurs actuellement ouverts dans Excel.
calculate(calculationTypeString: "Recalculate" | "Full" | "FullRebuild"): void;
Paramètres
- calculationTypeString
-
"Recalculate" | "Full" | "FullRebuild"
Spécifie le type de calcul à utiliser. Pour plus d’informations, consultez Excel.CalculationType
.
Retours
void
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
Exemples
await Excel.run(async (context) => {
context.workbook.application.calculate('Full');
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.ApplicationLoadOptions): Excel.Application;
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.Application;
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 application = context.workbook.application;
application.load('calculationMode');
await context.sync();
console.log(application.calculationMode);
});
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.Application;
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.ApplicationUpdateData, options?: OfficeExtension.UpdateOptions): void;
Paramètres
- properties
- Excel.Interfaces.ApplicationUpdateData
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.Application): void;
Paramètres
- properties
- Excel.Application
Retours
void
suspendApiCalculationUntilNextSync()
Suspend le calcul jusqu’à ce que le suivant context.sync()
soit appelé. Une fois cette option définie, il incombe au développeur de recalculer le classeur afin de garantir que toutes les dépendances sont propagées.
suspendApiCalculationUntilNextSync(): void;
Retours
void
Remarques
suspendScreenUpdatingUntilNextSync()
Suspend la mise à jour de l’écran jusqu’à ce que le suivant context.sync()
soit appelé.
Remarque* : n’appelez suspendScreenUpdatingUntilNextSync
pas à plusieurs reprises (par exemple, dans une boucle). Les appels répétés entraînent le scintillement de la fenêtre Excel.
suspendScreenUpdatingUntilNextSync(): void;
Retours
void
Remarques
[ Ensemble d’API : ExcelApi 1.9 ]
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/90-scenarios/performance-optimization.yaml
await Excel.run(async (context) => {
// Recreate the data in the worksheet with random data.
const sheet = context.workbook.worksheets.getActiveWorksheet();
const startTime = Date.now();
console.log("Starting...");
// If other parts of the sample have toggled screen painting off, this will stop screen updating until context.sync is called.
if (pauseScreenPainting) {
context.application.suspendScreenUpdatingUntilNextSync();
}
for (let i = 1; i < ROW_COUNT; i++) {
for (let j = 1; j < COLUMN_COUNT; j++) {
let cell = sheet.getCell(i, j);
cell.values = [[i * j * Math.random()]];
// If other parts of the sample have toggled tracking off, we will avoid tracking this range and having to manage the proxy objects.
// For more information, see https://zcusa.951200.xyz/office/dev/add-ins/concepts/resource-limits-and-performance-optimization#untrack-unneeded-proxy-objects
if (untrack) {
cell.untrack();
}
}
}
await context.sync();
console.log(`Ending. Adding ${ROW_COUNT * COLUMN_COUNT} cells took ${Date.now() - startTime} milliseconds`);
});
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.Application
est un objet API, la toJSON
méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.ApplicationData
que ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Excel.Interfaces.ApplicationData;