ExcelScript.Application interface

Paquet:

ExcelScript

Représente l’application Excel qui gère le classeur.

Méthodes

calculate(calculationType)	Recalcule tous les classeurs actuellement ouverts dans Excel.
getCalculationEngineVersion()	Renvoie la version du moteur de calcul Excel utilisée pour le dernier recalcul complet.
getCalculationMode()	Retourne le mode de calcul utilisé dans le classeur, tel que défini par les constantes dans ExcelScript.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.
getCalculationState()	Renvoie l’état de calcul de l’application. Pour plus d’informations, consultez ExcelScript.CalculationState .
getCultureInfo()	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.
getDecimalSeparator()	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.
getIterativeCalculation()	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.
getThousandsSeparator()	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.
getUseSystemSeparators()	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.
setCalculationMode(calculationMode)	Retourne le mode de calcul utilisé dans le classeur, tel que défini par les constantes dans ExcelScript.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.

Détails de la méthode

calculate(calculationType)

Recalcule tous les classeurs actuellement ouverts dans Excel.

calculate(calculationType: CalculationType): void;

Paramètres

calculationType

ExcelScript.CalculationType

Spécifie le type de calcul à utiliser. Pour plus d’informations, consultez ExcelScript.CalculationType .

Retours

void

Exemples

/**
 * This script fully recalculates the entire workbook.
 * This code is useful when automatic recalculation is turned off
 * but later parts of the script rely on updated values.
 */
function main(workbook: ExcelScript.Workbook, workbookURL: string) {
  const application = workbook.getApplication();
  application.calculate(ExcelScript.CalculationType.fullRebuild);
}

getCalculationEngineVersion()

Renvoie la version du moteur de calcul Excel utilisée pour le dernier recalcul complet.

getCalculationEngineVersion(): number;

Retours

number

getCalculationMode()

Retourne le mode de calcul utilisé dans le classeur, tel que défini par les constantes dans ExcelScript.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.

getCalculationMode(): CalculationMode;

Retours

ExcelScript.CalculationMode

getCalculationState()

Renvoie l’état de calcul de l’application. Pour plus d’informations, consultez ExcelScript.CalculationState .

getCalculationState(): CalculationState;

Retours

ExcelScript.CalculationState

Exemples

/**
 * This script uses the fill color of the first cell to indicate the current
 * calculation state of the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first cell in the first worksheet.
  const cell = workbook.getWorksheets()[0].getCell(0,0);

  // Get that cell's fill object.
  const cellFill = cell.getFormat().getFill();

  // Set the cell fill based on the calculation state.
  const calcState = workbook.getApplication().getCalculationState();
  switch (calcState) {
    case ExcelScript.CalculationState.pending:
      cellFill.setColor("Red");
      break;
    case ExcelScript.CalculationState.calculating:
      cellFill.setColor("Yellow");
      break;
    case ExcelScript.CalculationState.done:
      cellFill.setColor("Green");
      break;
  }
}

getCultureInfo()

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.

getCultureInfo(): CultureInfo;

Retours

ExcelScript.CultureInfo

getDecimalSeparator()

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.

getDecimalSeparator(): string;

Retours

string

getIterativeCalculation()

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.

getIterativeCalculation(): IterativeCalculation;

Retours

ExcelScript.IterativeCalculation

getThousandsSeparator()

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.

getThousandsSeparator(): string;

Retours

string

getUseSystemSeparators()

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.

getUseSystemSeparators(): boolean;

Retours

boolean

setCalculationMode(calculationMode)

Retourne le mode de calcul utilisé dans le classeur, tel que défini par les constantes dans ExcelScript.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.

setCalculationMode(calculationMode: CalculationMode): void;

Paramètres

calculationMode

ExcelScript.CalculationMode

Retours

void