_Application3.FormatString(Object, String, String) Método

Definição

Namespace:

Microsoft.Office.Interop.InfoPath

Assembly:

Microsoft.Office.Interop.InfoPath.dll

Formata a cadeia de caracteres especificada ou o nó XML de acordo com os parâmetros de categoria e opções especificados.

public:
 System::String ^ FormatString(System::Object ^ varInput, System::String ^ bstrCategory, System::String ^ bstrOptions);

public string FormatString (object varInput, string bstrCategory, string bstrOptions);

abstract member FormatString : obj * string * string -> string

Public Function FormatString (varInput As Object, bstrCategory As String, bstrOptions As String) As String

Parâmetros

varInput

Object

O valor ou nó XML a ser formatado.

bstrCategory

String

O valor que especifica a categoria usada para formatação. Os valores incluem número, percentual, moeda, data, hora e datetime.

bstrOptions

String

O valor que especifica as opções usadas para formatação. Usa a forma de uma cadeia de caracteres sensível a maiúsculas de maiúsculas de minúsculas no formato "optionName:value".

Retornos

String

A cadeia de caracteres ou nó XML especificado formatado de acordo com os parâmetros de categoria e opções especificados.

Implementações

FormatString(Object, String, String)

Exemplos

No exemplo a seguir, o método FormatString do Application objeto é usado para formatar a cadeia de caracteres de data especificada em um formato de data longa:

thisApplication.<span class="label">FormatString</span>("2003-01-08", "date", "dateFormat:Long Date");

Comentários

O método FormatString pode ser usado em qualquer lugar que você precise para alterar o formato de uma cadeia de caracteres especificada. Ele deve ser qualificado com o nome do aplicativo e seu valor de retorno deve ser atribuído a uma variável ou usado como uma expressão que requer um valor de cadeia de caracteres.

As tabelas a seguir listam os valores para os quais podem ser usados bstrCategory e bstrOptions:

Lista de categorias

número	Usa valores numéricos. As opções válidas para essa categoria incluem "locale", "numDigits", "leadingZero", "grouping", "decimalSep", "thousandSep" e "negativeOrder".
Porcentagem	Usa valores percentuais. As opções válidas para essa categoria incluem "locale", "numDigits", "leadingZero", "grouping", "decimalSep", "thousandSep" e "negativeOrder".
currency	Usa valores de moeda. As opções válidas para essa categoria incluem "locale", "numDigits", "leadingZero", "grouping", "decimalSep", "thousandSep" e "negativeOrder", "positiveOrder" e "currencyLocale".
data	Usa valores de data. As opções válidas para essa categoria incluem "locale", "dateFormat", "useAltCalendar" e "useEnglishStringsAlways".
time	Usa valores de tempo. As opções válidas para essa categoria incluem "locale", "timeFormat" e "noSeconds".
datetime	Usa valores datetime. As opções válidas para essa categoria incluem "locale", "dateFormat", "timeFormat", "noSeconds", "useAltCalendar" e "useEnglishStringAlways".

Lista de opções

locale	Especifica o identificador de localidade (LCID). Padrão para o LCID do usuário atual se não for especificado.
numDigits	Especifica o número de dígitos fracionários após o separador decimal. O valor automático também pode ser usado para indicar que o número de casas decimais inseridas será o número de casas decimais na saída. Por exemplo, 1.234, 1.234, 1.00, 1.00, 1.56e2 ou 156,00. Padrão para o valor correspondente em configurações regionais, se não for especificado.
leadingZero	Especifica se deve usar zeros líderes em campos decimais. Especifique 0 para indicar nenhum zero à esquerda e 1 para indicar zeros principais. Padrão para o valor correspondente em configurações regionais, se não for especificado.
Agrupamento	Especifica o tamanho de cada grupo de dígitos à esquerda do decimal. Os valores no intervalo de 0 a 9 e no valor 32 são válidos. O valor 32 indica que o agrupamento é de três dígitos e dois dígitos depois disso. Padrão para o valor correspondente em configurações regionais, se não for especificado.
decimalSep	Especifica a cadeia de caracteres do separador decimal. Padrão para o valor correspondente em configurações regionais, se não for especificado.
thousandSep	Especifica a cadeia de caracteres de milhares de separadores. Padrão para o valor correspondente em configurações regionais, se não for especificado.
negativeOrder	Especifica o modo de número negativo. Padrão para o valor correspondente em configurações regionais, se não for especificado.
positiveOrder	Especifica o modo de número positivo. Padrão para o valor correspondente em configurações regionais, se não for especificado.
currencyLocale	Especifica o identificador de localidade (LCID) para o símbolo de moeda. Padrão para o valor especificado pela localidade se não for especificado.
Dateformat	Especifica uma cadeia de caracteres de imagem de formato usada para formar a cadeia de caracteres de data. Os valores "Short Date", "Long Date", "Year Month" e "none" também podem ser usados para indicar formato de data curta, formato de data longa, formato de mês de ano e nenhum formato, respectivamente. "Short Date", "Long Date" e "Year Month" são os formatos padrão fornecidos pelas configurações regionais e de idioma do sistema operacional.
useAltCalendar	Especifica se deve usar um calendário alternativo para formatação de datas. Especifique 0 para usar o calendário normal e 1 para usar o calendário alternativo. O padrão será 0 se não for especificado.
useEnglishStringsAlways	Especifica se sempre usar cadeias de caracteres em inglês para formatação de data. Especifique 0 para usar o idioma especificado pela localidade e 1 para sempre usar o inglês. O padrão será 0 se não for especificado.
Timeformat	Especifica uma cadeia de caracteres de formato usada para formar a cadeia de caracteres de tempo. O valor "nenhum" também pode ser usado para indicar nenhum formato. Padrão para o formato de tempo em configurações regionais, se não for especificado.
noSeconds	Especifica se não deve usar segundos. Especifique 0 para usar segundos e 1 para não usar segundos. O padrão será 0 se não for especificado.