Excel.CultureInfo class
Fornece informações com base nas definições atuais da cultura do sistema. Isto inclui os nomes de cultura, a formatação de números e outras definições culturalmente dependentes.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.11 ]
Propriedades
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| datetime |
Define o formato culturalmente apropriado da apresentação da data e hora. Isto baseia-se nas definições atuais da cultura do sistema. |
| name | Obtém o nome da cultura no formato languagecode2-country/regioncode2 (por exemplo, "zh-cn" ou "en-us"). Isto baseia-se nas definições atuais do sistema. |
| number |
Define o formato culturalmente apropriado da apresentação de números. Isto baseia-se nas definições atuais da cultura do sistema. |
Métodos
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
context
O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
context: RequestContext;Valor da propriedade
datetimeFormat
Define o formato culturalmente apropriado da apresentação da data e hora. Isto baseia-se nas definições atuais da cultura do sistema.
readonly datetimeFormat: Excel.DatetimeFormatInfo;Valor da propriedade
Comentários
[ Conjunto de API: ExcelApi 1.12 ]
Exemplos
// 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
Obtém o nome da cultura no formato languagecode2-country/regioncode2 (por exemplo, "zh-cn" ou "en-us"). Isto baseia-se nas definições atuais do sistema.
readonly name: string;Valor da propriedade
string
Comentários
numberFormat
Define o formato culturalmente apropriado da apresentação de números. Isto baseia-se nas definições atuais da cultura do sistema.
readonly numberFormat: Excel.NumberFormatInfo;Valor da propriedade
Comentários
Detalhes do método
load(options)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(options?: Excel.Interfaces.CultureInfoLoadOptions): Excel.CultureInfo;Parâmetros
Fornece opções para as propriedades do objeto a carregar.
Retornos
load(propertyNames)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames?: string | string[]): Excel.CultureInfo;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
load(propertyNamesAndPaths)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.CultureInfo;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto excel.CultureInfo original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.CultureInfoData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.CultureInfoData;