_Application3.FormatString - Méthode (Object, String, String)

Article
05/11/2015

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.

Espace de noms : Microsoft.Office.Interop.InfoPath
Assembly : Microsoft.Office.Interop.InfoPath (dans Microsoft.Office.Interop.InfoPath.dll)

Syntaxe

'Déclaration
Function FormatString ( _
    varInput As Object, _
    bstrCategory As String, _
    bstrOptions As String _
) As String
'Utilisation
Dim instance As _Application3
Dim varInput As Object
Dim bstrCategory As String
Dim bstrOptions As String
Dim returnValue As String

returnValue = instance.FormatString(varInput, _
    bstrCategory, bstrOptions)

string FormatString(
    Object varInput,
    string bstrCategory,
    string bstrOptions
)

Paramètres

varInput
Type : System.Object

Valeur ou nœud à mettre en forme.

bstrCategory
Type : System.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
Type : System.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 ».

Valeur renvoyée

Type : System.String
La chaîne spécifiée ou le nœud XML mis en forme selon la catégorie et les options spécifiés.

Implémentations

_Application2.FormatString(Object, String, String)

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 tableaux suivants répertorient les valeurs pouvant être utilisées pour bstrCategory et bstrOptions:

Liste de catégories

Name	Description
number	Utilise des valeurs numériques. Les options valides pour cette catégorie sont « locale », « numDigits », « leadingZero », « grouping », « decimalSep », « thousandSep » et « negativeOrder ».
percentage	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 ».
datetime	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

Name	Description
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.
grouping	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.

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 dans un format de date longue :

thisApplication.FormatString("2003-01-08", "date", "dateFormat:Long Date");

Voir aussi

Référence

_Application3 interface

_Application3 - Membres

FormatString - Surcharge

Microsoft.Office.Interop.InfoPath - Espace de noms

Partager via