Share via


Paramètres optionnels dans les solutions Office

De nombreuses méthodes des modèles objet des applications Microsoft Office acceptent les paramètres optionnels.Si vous utilisez Visual Basic pour développer une solution Office dans Visual Studio 2012, vous n'avez pas besoin de passer une valeur pour les paramètres optionnels car les valeurs par défaut sont automatiquement utilisées pour chaque paramètre manquant.Dans la plupart des cas, vous pouvez également omettre les paramètres facultatifs dans les projets visual C#. Toutefois, vous ne pouvez pas omettre les paramètres facultatifs d' ref de la classe d' ThisDocument dans les projets au niveau de le document Word.

S'applique à : Les informations contenues dans cette rubrique s'appliquent aux projets de niveau document et de niveau application pour Office 2013 et Office 2010. Pour en savoir plus, consultez Fonctionnalités disponibles par type d'application et de projet Office.

Pour plus d'informations sur l'utilisation des paramètres optionnels dans les projets Visual C# et Visual Basic, consultez Arguments nommés et facultatifs (Guide de programmation C#) et Paramètres facultatifs (Visual Basic).

[!REMARQUE]

Dans les versions antérieures de Visual Studio, vous devez passer une valeur pour chaque paramètre optionnel des projets Visual C#.Pour des raisons pratiques, ces projets incluent une variable globale nommée missing que vous pouvez passer à un paramètre optionnel lorsque vous voulez utiliser la valeur par défaut du paramètre.Les projets Visual C# pour Office dans Visual Studio 2012 incluent toujours la variable missing, mais vous n'avez généralement pas besoin de l'utiliser lorsque vous développez des solutions Office dans Visual Studio 2012, sauf lorsque vous appelez des méthodes avec les paramètres ref optionnels dans la classe ThisDocument des projets de niveau document pour Word.

Exemple dans Excel

La méthode Worksheet.CheckSpelling possède de nombreux paramètres optionnels.Vous pouvez spécifier des valeurs pour certains paramètres et accepter la valeur par défaut pour d'autres, comme indiqué dans l'exemple de code suivant.Cet exemple requiert un projet de niveau document avec une classe de feuille de calcul nommée Sheet1.

Globals.Sheet1.CheckSpelling(ignoreUppercase:=True)

Globals.Sheet1.CheckSpelling(ignoreUppercase: true);

Exemple dans Word

La méthode Find.Execute possède de nombreux paramètres optionnels.Vous pouvez spécifier des valeurs pour certains paramètres et accepter la valeur par défaut pour d'autres, comme indiqué dans l'exemple de code suivant.

With Me.Application.ActiveDocument.Content
    .Find.ClearFormatting()
    .Find.Execute(FindText:="blue", ReplaceWith:="red", Replace:=Word.WdReplace.wdReplaceAll)
End With
Word.Range documentRange = this.Application.ActiveDocument.Content;
documentRange.Find.ClearFormatting();
documentRange.Find.Execute(FindText: "blue", ReplaceWith: "red", Replace: Word.WdReplace.wdReplaceAll);            

Utilisation des paramètres facultatifs de méthodes dans la classe ThisDocument dans les projets au niveau du document de Visual C# pour Word

Le modèle objet Word contient de nombreuses méthodes comportant des paramètres ref facultatifs qui acceptent des valeurs Object.Cependant, vous ne pouvez pas omettre les paramètres ref facultatifs des méthodes de la classe ThisDocument générée dans les projets au niveau du document Visual C# pour Word.Visual C# vous permet d'omettre les paramètres ref facultatifs uniquement pour les méthodes d'interfaces, pas pour les classes.Par exemple, l'exemple de code suivant ne compile pas, parce que vous ne pouvez pas omettre les paramètres ref facultatifs de la méthode CheckSpelling de la classe ThisDocument.

Globals.ThisDocument.CheckSpelling(ignoreUppercase: true);

Lorsque vous appelez des méthodes de la classe ThisDocument, suivez ces indications :

  • Pour accepter la valeur par défaut d'un paramètre ref optionnel, passez la variable missing au paramètre.La variable missing est automatiquement définie dans les projets Office Visual C# et est assignée à la valeur Type.Missing dans le code de projet généré.

  • Pour spécifier votre propre valeur pour un paramètre ref optionnel, déclarez un objet assigné à la valeur que vous souhaitez spécifier, puis passez l'objet au paramètre.

L'exemple de code suivant montre comment appeler la méthode CheckSpelling en spécifiant une valeur pour le paramètre ignoreUppercase et en acceptant la valeur par défaut pour les autres paramètres.

object ignoreUppercase = true;
Globals.ThisDocument.CheckSpelling(
    ref missing, ref ignoreUppercase, ref missing, ref missing, ref missing, ref missing,
    ref missing, ref missing, ref missing, ref missing, ref missing, ref missing);

Si vous voulez écrire du code qui omet les paramètres ref optionnels d'une méthode dans la classe ThisDocument, vous pouvez appeler la même méthode sur l'objet Microsoft.Office.Interop.Word.Document retourné par la propriété InnerObject et omettre les paramètres de cette méthode.Vous pouvez faire cela dans la mesure où Microsoft.Office.Interop.Word.Document est une interface, plutôt qu'une classe.

Globals.ThisDocument.InnerObject.CheckSpelling(IgnoreUppercase: true);

Pour plus d'informations sur les paramètres de type valeur et référence, consultez Passage d'un argument par valeur et par référence (Visual Basic) (pour Visual Basic) et Passage de paramètres (Guide de programmation C#).

Voir aussi

Concepts

Écriture de code dans les solutions Office

Autres ressources

Développement de solutions Office