Excel.NumberFormatInfo class
Define el formato culturalmente adecuado para mostrar números. Esto se basa en la configuración actual de la referencia cultural del sistema.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.11 ]
Propiedades
context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
currency |
Obtiene el símbolo de moneda para los valores de moneda. Esto se basa en la configuración actual del sistema. |
number |
Obtiene la cadena utilizada como separador decimal para los valores numéricos. Esto se basa en la configuración actual del sistema. |
number |
Obtiene la cadena usada para separar grupos de dígitos a la izquierda del decimal para los valores numéricos. Esto se basa en la configuración actual 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() | Invalida el método JavaScript |
Detalles de las propiedades
context
Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
context: RequestContext;
Valor de propiedad
currencySymbol
Obtiene el símbolo de moneda para los valores de moneda. Esto se basa en la configuración actual del sistema.
readonly currencySymbol: string;
Valor de propiedad
string
Comentarios
numberDecimalSeparator
Obtiene la cadena utilizada como separador decimal para los valores numéricos. Esto se basa en la configuración actual del sistema.
readonly numberDecimalSeparator: string;
Valor de propiedad
string
Comentarios
[ Conjunto de API: ExcelApi 1.11 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/culture-info.yaml
// This will convert a number like "14,37" to "14.37"
// (assuming the system decimal separator is ".").
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const decimalSource = sheet.getRange("B2");
decimalSource.load("values");
context.application.cultureInfo.numberFormat.load("numberDecimalSeparator");
await context.sync();
const systemDecimalSeparator = context.application.cultureInfo.numberFormat.numberDecimalSeparator;
const oldDecimalString: string = decimalSource.values[0][0];
// This assumes the input column is standardized to use "," as the decimal separator.
const newDecimalString = oldDecimalString.replace(",", systemDecimalSeparator);
const resultRange = sheet.getRange("C2");
resultRange.values = [[newDecimalString]];
resultRange.format.autofitColumns();
await context.sync();
});
numberGroupSeparator
Obtiene la cadena usada para separar grupos de dígitos a la izquierda del decimal para los valores numéricos. Esto se basa en la configuración actual del sistema.
readonly numberGroupSeparator: string;
Valor de propiedad
string
Comentarios
[ Conjunto de API: ExcelApi 1.11 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/culture-info.yaml
await Excel.run(async (context) => {
// This will convert a number like "123-456-789" to "123,456,789"
// (assuming the system thousands separator is ",").
const sheet = context.workbook.worksheets.getItem("Sample");
const bigNumberSource = sheet.getRange("B3");
bigNumberSource.load("values");
context.application.cultureInfo.numberFormat.load("numberGroupSeparator");
await context.sync();
const systemThousandsSeparator = context.application.cultureInfo.numberFormat.numberGroupSeparator;
const oldBigNumberString: string = bigNumberSource.values[0][0];
// This assumes the input column is standardized to use "-" as the number group separator.
const newBigNumberString = oldBigNumberString.replace(/-/g, systemThousandsSeparator);
const resultRange = sheet.getRange("C3");
resultRange.values = [[newBigNumberString]];
resultRange.format.autofitColumns();
await context.sync();
});
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.NumberFormatInfoLoadOptions): Excel.NumberFormatInfo;
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.NumberFormatInfo;
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.NumberFormatInfo;
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()
Invalida el método JavaScript toJSON()
para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify()
. (JSON.stringify
a su vez, llama al toJSON
método del objeto que se le pasa). Mientras que el objeto Excel.NumberFormatInfo original es un objeto de API, el toJSON
método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.NumberFormatInfoData
) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.NumberFormatInfoData;