Excel.CultureInfo class

  • Référence
Paquet:
excel

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.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.11 ]

Propriétés

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
datetimeFormat

Définit le format culturellement approprié de l’affichage de la date et de l’heure. Cela est basé sur les paramètres de culture système actuels.
name

Obtient le nom de la culture au format languagecode2-country/regioncode2 (par exemple, « zh-cn » ou « en-us »). Cela est basé sur les paramètres système actuels.
numberFormat

Définit le format d’affichage des nombres adapté à la culture. Cela est basé sur les paramètres de culture 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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Excel.CultureInfo d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Excel.Interfaces.CultureInfoDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

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é

Excel.RequestContext

datetimeFormat

Définit le format culturellement approprié de l’affichage de la date et de l’heure. Cela est basé sur les paramètres de culture système actuels.

readonly datetimeFormat: Excel.DatetimeFormatInfo;

Valeur de propriété

Excel.DatetimeFormatInfo

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/culture-info-date-time.yaml

await Excel.run(async (context) => {
  context.application.cultureInfo.datetimeFormat.load([
    "longDatePattern",
    "shortDatePattern",
    "dateSeparator",
    "longTimePattern",
    "timeSeparator"
  ]);
  await context.sync();

  // Use the cultural settings API to retrieve the user's system date and time settings.
  const systemLongDatePattern = context.application.cultureInfo.datetimeFormat.longDatePattern;
  const systemShortDatePattern = context.application.cultureInfo.datetimeFormat.shortDatePattern;
  const systemDateSeparator = context.application.cultureInfo.datetimeFormat.dateSeparator;
  const systemLongTimePattern = context.application.cultureInfo.datetimeFormat.longTimePattern;
  const systemTimeSeparator = context.application.cultureInfo.datetimeFormat.timeSeparator;

  // Write the date and time settings in your table. 
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const dateTimeData = sheet.getRange("A2:B6");
  dateTimeData.values = [
    ["Long date", systemLongDatePattern], 
    ["Short date", systemShortDatePattern], 
    ["Date separator", systemDateSeparator], 
    ["Long time format", systemLongTimePattern],
    ["Time separator", systemTimeSeparator]
  ];

  sheet.tables
    .getItemAt(0)
    .getRange()
    .format.autofitColumns();

  await context.sync();
});

name

Obtient le nom de la culture au format languagecode2-country/regioncode2 (par exemple, « zh-cn » ou « en-us »). Cela est basé sur les paramètres système actuels.

readonly name: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.11 ]

numberFormat

Définit le format d’affichage des nombres adapté à la culture. Cela est basé sur les paramètres de culture système actuels.

readonly numberFormat: Excel.NumberFormatInfo;

Valeur de propriété

Excel.NumberFormatInfo

Remarques

[ Ensemble d’API : ExcelApi 1.11 ]

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.CultureInfoLoadOptions): Excel.CultureInfo;

Paramètres

options
Excel.Interfaces.CultureInfoLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.CultureInfo

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

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

Excel.CultureInfo

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

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

Excel.CultureInfo

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 Excel.CultureInfo d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Excel.Interfaces.CultureInfoDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.CultureInfoData;

Retours

Excel.Interfaces.CultureInfoData