ExcelScript.DatetimeFormatInfo interface

Paquet:

ExcelScript

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

Remarques

Exemples

/**
 * This script sets the value of a cell to a date string for January 2, 2023.
 * It writes the day or month first in the string based on system settings.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first cell in the current worksheet.
  const cell = workbook.getActiveWorksheet().getCell(0,0);

  // Get the date format.
  const cultureInfo : ExcelScript.CultureInfo = workbook.getApplication().getCultureInfo();
  const systemDateTimeFormat : ExcelScript.DatetimeFormatInfo = cultureInfo.getDatetimeFormat();
  const shortDatePattern : string = systemDateTimeFormat.getShortDatePattern();

  // Determine if the date should start with the month or day.
  if (shortDatePattern.startsWith("m")) {
    cell.setValue("1/2/2023");
  } else {
    cell.setValue("2/1/2023");
  }
}

Méthodes

getDateSeparator()	Obtient la chaîne utilisée comme séparateur de date. Cela est basé sur les paramètres système actuels.
getLongDatePattern()	Obtient la chaîne de format pour une valeur de date longue. Cela est basé sur les paramètres système actuels.
getLongTimePattern()	Obtient la chaîne de format pour une valeur de longue durée. Cela est basé sur les paramètres système actuels.
getShortDatePattern()	Obtient la chaîne de format pour une valeur de date courte. Cela est basé sur les paramètres système actuels.
getTimeSeparator()	Obtient la chaîne utilisée comme séparateur de temps. Cela est basé sur les paramètres système actuels.

Détails de la méthode

getDateSeparator()

Obtient la chaîne utilisée comme séparateur de date. Cela est basé sur les paramètres système actuels.

getDateSeparator(): string;

Retours

string

Exemples

/**
 * This script writes the current date, month, and year.
 * It uses the system's date separator character.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first cell in the current worksheet.
  const cell = workbook.getActiveWorksheet().getCell(0,0);

  // Get the date separation string.
  const cultureInfo = workbook.getApplication().getCultureInfo();
  const systemDateTimeFormat = cultureInfo.getDatetimeFormat();
  const separator = systemDateTimeFormat.getDateSeparator();

  // Get the current date.
  const currentDate = new Date(Date.now());

  // Write the date using the system's separator character.
  cell.setValue(`${currentDate.getMonth()}${separator}${currentDate.getDate()}${separator}${currentDate.getFullYear()}`);
}

getLongDatePattern()

Obtient la chaîne de format pour une valeur de date longue. Cela est basé sur les paramètres système actuels.

getLongDatePattern(): string;

Retours

string

Exemples

/**
 * This script returns the system's long date pattern. 
 * This could be used in a Power Automate flow to keep date formatting consistent.
 */
function main(workbook: ExcelScript.Workbook) : string {
    const cultureInfo = workbook.getApplication().getCultureInfo();
    const dateTimeInfo =  cultureInfo.getDatetimeFormat();
    
    return dateTimeInfo.getLongDatePattern();
}

getLongTimePattern()

Obtient la chaîne de format pour une valeur de longue durée. Cela est basé sur les paramètres système actuels.

getLongTimePattern(): string;

Retours

string

getShortDatePattern()

Obtient la chaîne de format pour une valeur de date courte. Cela est basé sur les paramètres système actuels.

getShortDatePattern(): string;

Retours

string

getTimeSeparator()

Obtient la chaîne utilisée comme séparateur de temps. Cela est basé sur les paramètres système actuels.

getTimeSeparator(): string;

Retours

string

Exemples

/**
 * This script writes the current hour, minute, and second.
 * It uses the system's time separator character.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first cell in the current worksheet.
  const cell = workbook.getActiveWorksheet().getCell(0, 0);

  // Get the date separation string.
  const cultureInfo = workbook.getApplication().getCultureInfo();
  const systemDateTimeFormat = cultureInfo.getDatetimeFormat();
  const separator = systemDateTimeFormat.getTimeSeparator();

  // Get the current time.
  const currentTime = new Date(Date.now());

  // Write the date using the system's separator character.
  cell.setValue(`${currentTime.getHours()}${separator}${currentTime.getMinutes()}${separator}${currentTime.getSeconds()}`);
}