Excel.NumberFormatInfo class
Define o formato culturalmente apropriado da apresentação de números. Isto baseia-se nas definições atuais da cultura do sistema.
- 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. |
| number |
Obtém a cadeia utilizada como separador decimal para valores numéricos. Isto baseia-se nas definições atuais do sistema. |
| number |
Obtém a cadeia utilizada para separar grupos de dígitos à esquerda do decimal para valores numéricos. Isto baseia-se nas definições atuais 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
numberDecimalSeparator
Obtém a cadeia utilizada como separador decimal para valores numéricos. Isto baseia-se nas definições atuais do sistema.
readonly numberDecimalSeparator: string;Valor da propriedade
string
Comentários
[ Conjunto de API: ExcelApi 1.11 ]
Exemplos
// 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
Obtém a cadeia utilizada para separar grupos de dígitos à esquerda do decimal para valores numéricos. Isto baseia-se nas definições atuais do sistema.
readonly numberGroupSeparator: string;Valor da propriedade
string
Comentários
[ Conjunto de API: ExcelApi 1.11 ]
Exemplos
// 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();
});
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.NumberFormatInfoLoadOptions): Excel.NumberFormatInfo;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.NumberFormatInfo;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.NumberFormatInfo;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 original Excel.NumberFormatInfo é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.NumberFormatInfoData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.NumberFormatInfoData;