Excel.CultureInfo class
Предоставляет сведения на основе текущих параметров языка и региональных параметров системы. Сюда входят имена и региональные параметры, форматирование чисел и другие параметры, зависящие от культуры.
- Extends
Комментарии
Свойства
context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
datetime |
Определяет формат отображения даты и времени, соответствующий культуре. Это основано на текущих параметрах языка и региональных параметров системы. |
name | Возвращает имя языка и региональных параметров в формате languagecode2-country/regioncode2 (например, "zh-cn" или "en-us"). Это зависит от текущих параметров системы. |
number |
Определяет формат отображения чисел, соответствующий культуре. Это основано на текущих параметрах языка и региональных параметров системы. |
Методы
load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;
Значение свойства
datetimeFormat
Определяет формат отображения даты и времени, соответствующий культуре. Это основано на текущих параметрах языка и региональных параметров системы.
readonly datetimeFormat: Excel.DatetimeFormatInfo;
Значение свойства
Комментарии
Примеры
// 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
Возвращает имя языка и региональных параметров в формате languagecode2-country/regioncode2 (например, "zh-cn" или "en-us"). Это зависит от текущих параметров системы.
readonly name: string;
Значение свойства
string
Комментарии
numberFormat
Определяет формат отображения чисел, соответствующий культуре. Это основано на текущих параметрах языка и региональных параметров системы.
readonly numberFormat: Excel.NumberFormatInfo;
Значение свойства
Комментарии
Сведения о методе
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync()
.
load(options?: Excel.Interfaces.CultureInfoLoadOptions): Excel.CultureInfo;
Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync()
.
load(propertyNames?: string | string[]): Excel.CultureInfo;
Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync()
.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.CultureInfo;
Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
— это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand
строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON()
, чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify()
. (JSON.stringify
в свою очередь вызывает toJSON
метод переданного ему объекта.) В то время как исходный объект Excel.CultureInfo является объектом API, toJSON
метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.CultureInfoData
), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Excel.Interfaces.CultureInfoData;
Возвращаемое значение
Office Add-ins