Partager via


_Application2.FormatString(Object, String, String) Méthode

Définition

Met en forme la chaîne ou le nœud XML spécifié selon la catégorie et les paramètres d'option spécifiés.

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

Paramètres

varInput
Object

Valeur ou nœud à mettre en forme.

bstrCategory
String

Valeur spécifiant la catégorie utilisée pour la mise en forme. Les catégories disponibles sont « number », « percentage », « currency », « date », « time » et « datetime ».

bstrOptions
String

Valeur spécifiant les options utilisées pour la mise en forme. Prend la forme d'une chaîne qui respecte la casse si le format choisi est « optionName:value ».

Retours

string mise en forme selon la catégorie et les paramètres d'option spécifiés.

Implémente

Exemples

Dans l’exemple suivant, la méthode FormatString de l’objet Application est utilisée pour mettre en forme la chaîne de date spécifiée dans un format de date longue :

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

Remarques

Vous pouvez utiliser la méthode FormatString chaque fois que vous devez modifier le format d'une chaîne spécifiée. Elle doit être qualifiée par le nom de l'application et sa valeur de retour doit être affectée à une variable ou utilisée comme expression nécessitant une valeur de chaîne.

Les sections suivantes répertorient les valeurs qui peuvent être utilisées pour bstrCategory et bstrOptions:

Liste de catégories

number Utilise des valeurs numériques. Les options valides pour cette catégorie sont « locale », « numDigits », « leadingZero », « grouping », « decimalSep », « thousandSep » et « negativeOrder ».
Pourcentage Utilise des valeurs de type pourcentage. Les options valides pour cette catégorie sont « locale », « numDigits », « leadingZero », « grouping », « decimalSep », « thousandSep » et « negativeOrder ».
currency Utilise des valeurs de type devise. Les options valides pour cette catégorie sont « locale », « numDigits », « leadingZero », « grouping », « decimalSep », « thousandSep » et « negativeOrder », « positiveOrder » et « currencyLocale »
date Utilise des valeurs de type date. Les options valides pour cette catégorie sont « locale », « dateFormat », « useAltCalendar » et « useEnglishStringsAlways ».
time Utilise des valeurs de type heure. Les options valides pour cette catégorie sont « locale », « timeFormat » et « noSeconds ».
Date/Heure Utilise des valeurs de type date et heure. Les options valides pour cette catégorie sont « locale », « dateFormat », « timeFormat », « noSeconds », « useAltCalendar » et « useEnglishStringAlways ».

Liste d'options

locale Spécifie l'identificateur de paramètres régionaux (LCID, Locale Identifier). LCID de l'utilisateur actuel utilisé par défaut si aucune valeur n'est spécifiée.
numDigits Spécifie le nombre de chiffres fractionnaires après le séparateur décimal. La valeur auto peut être également utilisée pour indiquer que le nombre de décimales entré initialement sera le nombre de décimales dans le résultat. Par exemple, 1,234, 1,234, 1,00, 1,00, 1,56e2, ou 156,00. Utilise par défaut la valeur correspondante dans les paramètres régionaux si aucune valeur n'est spécifiée.
leadingZero Spécifie si des zéros non significatifs doivent être utilisés dans les champs décimaux. Utilisez 0 pour désactiver les zéros non significatifs et 1 pour les activer. Utilise par défaut la valeur correspondante dans les paramètres régionaux si aucune valeur n'est spécifiée.
Regroupement Spécifie la taille de chaque groupe de chiffres à gauche de la décimale. Les valeurs valides sont les valeurs de la plage 0–9 et la valeur 32. La valeur 32 indique que le groupe se compose de trois chiffres, suivis de deux chiffres. Utilise par défaut la valeur correspondante dans les paramètres régionaux si aucune valeur n'est spécifiée.
decimalSep Spécifie la chaîne du séparateur décimal. Utilise par défaut la valeur correspondante dans les paramètres régionaux si aucune valeur n'est spécifiée.
thousandSep Spécifie la chaîne du séparateur de milliers. Utilise par défaut la valeur correspondante dans les paramètres régionaux si aucune valeur n'est spécifiée.
negativeOrder Spécifie le mode du nombre négatif. Utilise par défaut la valeur correspondante dans les paramètres régionaux si aucune valeur n'est spécifiée.
positiveOrder Spécifie le mode du nombre positif. Utilise par défaut la valeur correspondante dans les paramètres régionaux si aucune valeur n'est spécifiée.
currencyLocale Spécifie l'identificateur de paramètres régionaux (LCID, Locale Identifier) pour le symbole de la devise. Utilise par défaut la valeur spécifiée par les paramètres régionaux si aucune valeur n'est spécifiée.
Dateformat Spécifie une chaîne d'image de format utilisée pour former la chaîne date. Les valeurs « Short Date », « Long Date », « Year Month » et « none » peuvent également être utilisées pour indiquer respectivement les formats date courte, date complète, année mois, ou l'absence de format. Les formats « Date courte », « Date longue » et « Année Mois » sont les formats fournis par défaut par les paramètres régionaux et linguistiques du système d'exploitation.
useAltCalendar Spécifie si un calendrier de remplacement doit être utilisé pour le format de date. Choisissez 0 pour utiliser le calendrier normal et 1 pour utiliser le calendrier de remplacement. La valeur 0 est utilisée par défaut si aucune valeur n'est spécifiée.
useEnglishStringsAlways Spécifie si les chaînes en anglais doivent toujours être utilisées pour le format de la date. Choisissez 0 pour utiliser la langue spécifiée dans les paramètres régionaux et 1 pour utiliser l'anglais. La valeur 0 est utilisée par défaut si aucune valeur n'est spécifiée.
timeFormat Spécifie une chaîne de format utilisée pour former la chaîne heure. La valeur « none » peut également être utilisée pour indiquer l'absence de format. Le format d'heure des paramètres régionaux est utilisé par défaut si aucune valeur n'est spécifiée.
noSeconds Spécifie si les secondes doivent être utilisées. Choisissez 0 pour utiliser les secondes et 1 pour ne pas les utiliser. La valeur 0 est utilisée par défaut si aucune valeur n'est spécifiée.

S’applique à