ExcelScript.DatetimeFormatInfo interface

パッケージ:

ExcelScript

数値を表示するカルチャに適した形式を定義します。 これは、現在のシステム カルチャ設定に基づいています。

注釈

例

/**
 * 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");
  }
}

メソッド

getDateSeparator()	日付区切り記号として使用される文字列を取得します。 これは、現在のシステム設定に基づいています。
getLongDatePattern()	長い日付値の書式指定文字列を取得します。 これは、現在のシステム設定に基づいています。
getLongTimePattern()	長い時間の値の書式指定文字列を取得します。 これは、現在のシステム設定に基づいています。
getShortDatePattern()	短い日付値の書式指定文字列を取得します。 これは、現在のシステム設定に基づいています。
getTimeSeparator()	時刻区切り記号として使用される文字列を取得します。 これは、現在のシステム設定に基づいています。

メソッドの詳細

getDateSeparator()

日付区切り記号として使用される文字列を取得します。 これは、現在のシステム設定に基づいています。

getDateSeparator(): string;

戻り値

string

例

/**
 * 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()

長い日付値の書式指定文字列を取得します。 これは、現在のシステム設定に基づいています。

getLongDatePattern(): string;

戻り値

string

例

/**
 * 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()

長い時間の値の書式指定文字列を取得します。 これは、現在のシステム設定に基づいています。

getLongTimePattern(): string;

戻り値

string

getShortDatePattern()

短い日付値の書式指定文字列を取得します。 これは、現在のシステム設定に基づいています。

getShortDatePattern(): string;

戻り値

string

getTimeSeparator()

時刻区切り記号として使用される文字列を取得します。 これは、現在のシステム設定に基づいています。

getTimeSeparator(): string;

戻り値

string

例

/**
 * 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()}`);
}