Excel.CultureInfo class

Pacote:

excel

Fornece informações com base nas configurações atuais de cultura do sistema. Isso inclui os nomes de cultura, a formatação de números e outras configurações culturalmente dependentes.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
datetimeFormat	Define o formato culturalmente apropriado de exibir data e hora. Isso se baseia nas configurações atuais de cultura do sistema.
name	Obtém o nome da cultura no formato languagecode2-country/regioncode2 (por exemplo, "zh-cn" ou "en-us"). Isso se baseia nas configurações atuais do sistema.
numberFormat	Define o formato culturalmente apropriado de exibir números. Isso se baseia nas configurações atuais de cultura do sistema.

Métodos

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(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
toJSON()	Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.CultureInfo original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.CultureInfoData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

datetimeFormat

Define o formato culturalmente apropriado de exibir data e hora. Isso se baseia nas configurações atuais de cultura do sistema.

readonly datetimeFormat: Excel.DatetimeFormatInfo;

Valor da propriedade

Excel.DatetimeFormatInfo

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"). Isso se baseia nas configurações atuais do sistema.

readonly name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

numberFormat

Define o formato culturalmente apropriado de exibir números. Isso se baseia nas configurações atuais de cultura do sistema.

readonly numberFormat: Excel.NumberFormatInfo;

Valor da propriedade

Excel.NumberFormatInfo

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

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

options

Excel.Interfaces.CultureInfoLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.CultureInfo

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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Excel.CultureInfo

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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.CultureInfo

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.CultureInfo original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.CultureInfoData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.CultureInfoData;

Retornos

Excel.Interfaces.CultureInfoData