Excel.CultureInfo class
Proporciona información basada en la configuración actual de la cultura del sistema. Esto incluye los nombres de referencia cultural, el formato de número y otras configuraciones que dependen de la cultura cultural.
- Extends
Propiedades
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| datetime |
Define el formato culturalmente adecuado para mostrar la fecha y la hora. Esto se basa en la configuración actual de la cultura del sistema. |
| name | Obtiene el nombre de la referencia cultural en el formato languagecode2-country/regioncode2 (por ejemplo, "zh-cn" o "en-us"). Esto se basa en la configuración actual del sistema. |
| number |
Define el formato culturalmente apropiado para mostrar los números. Esto se basa en la configuración actual de la cultura del sistema. |
Métodos
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| toJSON() | Reemplaza el método JavaScript |
Detalles de las propiedades
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
context: RequestContext;
Valor de propiedad
datetimeFormat
Define el formato culturalmente adecuado para mostrar la fecha y la hora. Esto se basa en la configuración actual de la cultura del sistema.
readonly datetimeFormat: Excel.DatetimeFormatInfo;
Valor de propiedad
Comentarios
Conjunto de API: ExcelApi 1.12
Ejemplos
// 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
Obtiene el nombre de la referencia cultural en el formato languagecode2-country/regioncode2 (por ejemplo, "zh-cn" o "en-us"). Esto se basa en la configuración actual del sistema.
readonly name: string;
Valor de propiedad
string
Comentarios
numberFormat
Define el formato culturalmente apropiado para mostrar los números. Esto se basa en la configuración actual de la cultura del sistema.
readonly numberFormat: Excel.NumberFormatInfo;
Valor de propiedad
Comentarios
Detalles del método
load(options)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(options?: Excel.Interfaces.CultureInfoLoadOptions): Excel.CultureInfo;
Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames?: string | string[]): Excel.CultureInfo;
Parámetros
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
Devoluciones
load(propertyNamesAndPaths)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.CultureInfo;
Parámetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
toJSON()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.CultureInfo es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.CultureInfoData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
toJSON(): Excel.Interfaces.CultureInfoData;