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

Definición

Espacio de nombres:

Microsoft.Office.Interop.InfoPath

Ensamblado:

Microsoft.Office.Interop.InfoPath.dll

Da formato a la cadena o al nodo XML indicados según la categoría y los parámetros de opciones 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

Valor o nodo XML al que se va a aplicar formato.

bstrCategory

String

Valor que especifica la categoría utilizada para el formato. Entre los valores se encuentran number, percentage, currency, date, time y datetime.

bstrOptions

String

Valor que especifica las opciones utilizadas para el formato. Toma la forma de una cadena que distingue entre mayúsculas y minúsculas con el formato "optionName:valor".

Devoluciones

String

Cadena especificada o nodo XML con formato según los parámetros de categoría y opciones especificados.

Implementaciones

FormatString(Object, String, String)

Ejemplos

En el ejemplo siguiente, se usa el método FormatString del Application objeto para dar formato a la cadena de fecha especificada en un formato de fecha larga:

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

Comentarios

El método FormatString se puede utilizar en cualquier punto donde se necesite cambiar el formato de una cadena concreta. Se debe cualificar con el nombre de Application y su valor de retorno debe asignarse a una variable o utilizarse como expresión que exige un valor de cadena.

En las tablas siguientes se enumeran los valores que se pueden usar para bstrCategory y bstrOptions:

Lista de categorías

number	Utiliza valores numéricos. Entres las opciones válidas para esta categoría se encuentran "locale", "numDigits", "leadingZero", "grouping", "decimalSep", "thousandSep" y "negativeOrder".
Porcentaje	Utiliza valores porcentuales. Entre las opciones válidas para esta categoría se encuentran "locale", "numDigits", "leadingZero", "grouping", "decimalSep", "thousandSep" y "negativeOrder".
currency	Utiliza valores de monedas. Entre las opciones válidas para esta categoría se encuentran "locale", "numDigits", "leadingZero", "grouping", "decimalSep", "thousandSep" y "negativeOrder", "positiveOrder" y "currencyLocale".
date	Utiliza valores de fechas. Entre las opciones válidas para esta categoría se encuentran "locale", "dateFormat", "useAltCalendar" y "useEnglishStringsAlways".
time	Utiliza valores de horas. Entre las opciones válidas para esta categoría se encuentran "locale", "timeFormat" y "noSeconds".
Datetime	Utiliza valores de fecha y hora. Entre las opciones válidas para esta categoría se encuentran "locale", "dateFormat", "timeFormat", "noSeconds", "useAltCalendar" y "useEnglishStringAlways".

Lista de opciones

locale	Especifica el identificador de configuración regional (LCID). El valor predeterminado es el LCID del usuario actual si no se especifica.
numDigits	Especifica el número de dígitos fraccionales después del separador decimal. El valor auto también se puede usar para indicar que el número de decimales escrito será el número de decimales de salida. Por ejemplo, 1,234; 1,234; 1,00; 1,00; 1,56e2 ó 156,00. Toma de forma predeterminada el valor correspondiente de la configuración regional si no se especifica.
leadingZero	Especifica si se utilizarán ceros iniciales en los campos de decimales. Especifique 0 para indicar que no se usarán ceros iniciales o 1 para indicar que sí se utilizarán. Toma de forma predeterminada el valor correspondiente de la configuración regional si no se especifica.
Agrupación	Especifica el tamaño de cada grupo de dígitos a la izquierda del separador decimal. Son válidos los valores comprendidos entre 0 y 9 y el valor 32. El valor 32 indica que la agrupación será de tres dígitos y, a continuación, de dos en dos. Toma de forma predeterminada el valor correspondiente de la configuración regional si no se especifica.
decimalSep	Especifica la cadena del separador decimal. Toma de forma predeterminada el valor correspondiente de la configuración regional si no se especifica.
thousandSep	Especifica la cadena del separador de millares. Toma de forma predeterminada el valor correspondiente de la configuración regional si no se especifica.
negativeOrder	Especifica el modo de números negativos. Toma de forma predeterminada el valor correspondiente de la configuración regional si no se especifica.
positiveOrder	Especifica el modo de números positivos. Toma de forma predeterminada el valor correspondiente de la configuración regional si no se especifica.
currencyLocale	Especifica el identificador regional (LCID) del símbolo de moneda. Toma de forma predeterminada el valor indicado en la configuración regional si no se especifica.
dateFormat	Especifica una cadena de imagen de formato que se utiliza para componer la cadena de fecha. Los valores "Short Date", "Long Date", "Year Month" y "none" también se podrían utilizar para indicar el formato de fecha corta, larga, de año y mes y sin formato, respectivamente. "Short Date", "Long Date" y "Year Month" son los formatos predeterminados proporcionados por la configuración regional y de idioma del sistema operativo.
useAltCalendar	Especifica si se utilizará un calendario alternativo para el formato de fechas. Especifique 0 para usar el calendario normal o 1 para utilizar el alternativo. Si no se especifica, toma de forma predeterminada el valor 0.
useEnglishStringsAlways	Especifica si siempre se utilizarán cadenas en inglés para el formato de fechas. Especifique 0 si desea utilizar el idioma indicado en la configuración regional y 1 para usar siempre el inglés. Si no se especifica, toma de forma predeterminada el valor 0.
timeFormat	Especifica una cadena de formato que se utiliza para componer la cadena de hora. También se puede utilizar el valor "none" para indicar que no se aplicará ningún formato. Toma de forma predeterminada el formato de hora de la configuración regional si no se especifica.
noSeconds	Especifica si se utilizarán segundos o no. Especifique 0 para usar segundos y 1 para no utilizarlos. Si no se especifica, toma de forma predeterminada el valor 0.