Fonctionnement des paramètres optionnels dans les solutions Office
Mise à jour : novembre 2007
De nombreuses méthodes des modèles objet des applications Microsoft Office acceptent les paramètres optionnels. Les paramètres optionnels sont facultatifs uniquement lorsque vous appelez une méthode à l'aide de Visual Basic. En effet, lorsque vous utilisez C# pour programmer une application Microsoft Office, vous devez passer une valeur pour tous les paramètres.
Différences liées aux paramètres optionnels entre Visual Basic et Visual C#
Si vous utilisez Visual Basic pour programmer une application Microsoft Office, il est inutile de passer une valeur pour les paramètres optionnels car les valeurs par défaut sont utilisées automatiquement pour chaque paramètre manquant. Toutefois, les paramètres optionnels n'étant pas pris en charge en C#, vous devez passer une valeur à la méthode pour chaque paramètre.
Les projets Visual Studio Tools pour Office intègrent une variable globale nommée missing affectée à la valeur Type.Missing dans le code généré. Vous pouvez passer cette variable globale pour supposer la valeur par défaut de chaque paramètre optionnel qui accepte un type référence, comme Object. Pour les paramètres optionnels qui acceptent un type valeur, vous devez passer la valeur par défaut réelle. Pour plus d'informations, consultez Passage de types valeur à des paramètres optionnels dans Visual C#.
Exemple dans Excel
La méthode Worksheet.CheckSpelling utilise les paramètres optionnels suivants qui acceptent les types référence :
CustomDictionary. Indique s'il faut utiliser un dictionnaire personnel si le mot est introuvable dans le dictionnaire principal.
IgnoreUppercase. Indique s'il faut ignorer les majuscules.
AlwaysSuggest. Indique si Excel doit afficher une liste de mots orthographiés différemment s'il trouve une faute d'orthographe.
SpellLang. Indique la langue du dictionnaire utilisé.
Vous pouvez accepter la valeur par défaut de ces paramètres, comme indiqué dans l'exemple de code suivant.
Globals.Sheet1.CheckSpelling()
Globals.Sheet1.CheckSpelling(missing, missing, missing, missing);
Exemple dans Word
En règle générale, l'appel de méthodes Microsoft Office Word à partir de C# est plus complexe que pour les autres applications Office, car vous devez passer tous les paramètres optionnels par référence.
Par exemple, la méthode Document.CheckSpelling utilise les paramètres optionnels suivants pour vérifier l'orthographe d'un document Word :
CustomDictionary. Nom de fichier du dictionnaire personnel.
IgnoreUppercase. Indique s'il faut ignorer les majuscules.
AlwaysSuggest. Indique si Word doit afficher une liste de mots orthographiés différemment s'il trouve une faute d'orthographe.
CustomDictionary2 – CustomDictionary10. Noms de fichiers des dictionnaires personnels supplémentaires. Vous pouvez spécifier jusqu'à neuf dictionnaires supplémentaires.
Vous pouvez accepter la valeur par défaut de ces paramètres, comme indiqué dans l'exemple de code suivant.
Me.CheckSpelling()
this.CheckSpelling(
ref missing, ref missing, ref missing, ref missing, ref missing, ref missing,
ref missing, ref missing, ref missing, ref missing, ref missing, ref missing);
Passage de types valeur à des paramètres optionnels dans Visual C#
Dans Visual C#, vous pouvez passer uniquement la variable missing globale pour les paramètres optionnels qui acceptent les types référence. En ce qui concerne les paramètres optionnels qui accepte les types valeur, vous devez déterminer la valeur par défaut réelle et la passer.
Par exemple, la méthode Sort de la classe NamedRange accepte comme paramètres un grand nombre de valeurs énumérées telles que Microsoft.Office.Interop.Excel.XlSortOrder. Parce qu'il s'agit d'un type valeur, vous devez spécifier l'une des valeurs XlSortOrder plutôt que passer la variable globale missing.
Pour plus d'informations sur les paramètres de type valeur et référence, consultez Passage d'arguments par valeur et par référence (pour Visual Basic) et Passage de paramètres (Guide de programmation C#).
Voir aussi
Concepts
Développement de solutions Office