Excel.NumberFormatInfo class

Définit le format culturellement approprié d’affichage des nombres. Ceci est basé sur les paramètres de culture système actuels.

Extends

Propriétés

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

currencySymbol

Obtient le symbole monétaire pour les valeurs monétaires. Ceci est basé sur les paramètres système actuels.

numberDecimalSeparator

Récupère la chaîne utilisée comme séparateur décimal pour les valeurs numériques. Ceci est basé sur les paramètres système actuels.

numberGroupSeparator

Obtient la chaîne utilisée pour séparer les groupes de chiffres à gauche du séparateur décimal pour les valeurs numériques. Ceci est basé sur les paramètres système actuels.

Méthodes

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(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(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.

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.NumberFormatInfo est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.NumberFormatInfoDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

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é

currencySymbol

Obtient le symbole monétaire pour les valeurs monétaires. Ceci est basé sur les paramètres système actuels.

readonly currencySymbol: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.17

numberDecimalSeparator

Récupère la chaîne utilisée comme séparateur décimal pour les valeurs numériques. Ceci est basé sur les paramètres système actuels.

readonly numberDecimalSeparator: string;

Valeur de propriété

string

Remarques

Jeu 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

// This will convert a number like "14,37" to "14.37"
// (assuming the system decimal separator is ".").
  await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const decimalSource = sheet.getRange("B2");
decimalSource.load("values");
context.application.cultureInfo.numberFormat.load("numberDecimalSeparator");
await context.sync();

const systemDecimalSeparator = context.application.cultureInfo.numberFormat.numberDecimalSeparator;
const oldDecimalString: string = decimalSource.values[0][0];

// This assumes the input column is standardized to use "," as the decimal separator. 
const newDecimalString = oldDecimalString.replace(",", systemDecimalSeparator);

const resultRange = sheet.getRange("C2");
resultRange.values = [[newDecimalString]];
resultRange.format.autofitColumns();
await context.sync();
  });

numberGroupSeparator

Obtient la chaîne utilisée pour séparer les groupes de chiffres à gauche du séparateur décimal pour les valeurs numériques. Ceci est basé sur les paramètres système actuels.

readonly numberGroupSeparator: string;

Valeur de propriété

string

Remarques

Jeu 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) => {
  // This will convert a number like "123-456-789" to "123,456,789"
  // (assuming the system thousands separator is ",").
  const sheet = context.workbook.worksheets.getItem("Sample");
  const bigNumberSource = sheet.getRange("B3");
  bigNumberSource.load("values");
  context.application.cultureInfo.numberFormat.load("numberGroupSeparator");
  await context.sync();

  const systemThousandsSeparator = context.application.cultureInfo.numberFormat.numberGroupSeparator;
  const oldBigNumberString: string = bigNumberSource.values[0][0];
  
  // This assumes the input column is standardized to use "-" as the number group separator. 
  const newBigNumberString = oldBigNumberString.replace(/-/g, systemThousandsSeparator);

  const resultRange = sheet.getRange("C3");
  resultRange.values = [[newBigNumberString]];
  resultRange.format.autofitColumns();
  await context.sync();
});

Détails de la méthode

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.NumberFormatInfoLoadOptions): Excel.NumberFormatInfo;

Paramètres

options
Excel.Interfaces.NumberFormatInfoLoadOptions

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.NumberFormatInfo;

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.NumberFormatInfo;

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

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.NumberFormatInfo est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.NumberFormatInfoDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.NumberFormatInfoData;

Retours