Paramètres facultatifs dans les solutions Bureau

  • Article

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

S’applique à : les informations contenues dans cette rubrique s’appliquent aux projets au niveau du document et aux projets de complément VSTO. Consultez les fonctionnalités disponibles par application Office lication et le type de projet.

Pour plus d’informations sur l’utilisation des paramètres facultatifs dans les projets Visual C# et Visual Basic, consultez les arguments nommés et facultatifs (guide de programmation C#) et les paramètres facultatifs (Visual Basic).

Remarque

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

Exemple dans Excel

La méthode 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 utilise un projet de niveau document avec une classe de feuille de calcul nommée Sheet1.


Globals.Sheet1.CheckSpelling(ignoreUppercase: true);

Exemple dans Word

La méthode 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.

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

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

Le modèle objet Word contient de nombreuses méthodes avec des paramètres ref facultatifs qui acceptent des Object valeurs. Toutefois, vous ne pouvez pas omettre les paramètres ref facultatifs des méthodes de la classe générée ThisDocument 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, et non pour les classes. Par exemple, l’exemple de code suivant ne compile pas, car vous ne pouvez pas omettre les paramètres ref facultatifs de la CheckSpelling méthode de la ThisDocument classe.

Globals.ThisDocument.CheckSpelling(ignoreUppercase: true);

Quand vous appelez des méthodes de la classe ThisDocument, suivez ces consignes :

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

  • Pour spécifier votre propre valeur pour un paramètre ref facultatif, déclarez un objet affecté à la valeur que vous souhaitez spécifier, puis transmettez l’objet au paramètre.

    L’exemple de code suivant montre comment appeler la CheckSpelling méthode 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 souhaitez écrire du code qui omet les paramètres ref facultatifs d’une méthode dans la ThisDocument classe, vous pouvez également appeler la même méthode sur l’objet Document retourné par la InnerObject propriété et omettre les paramètres de cette méthode. Vous pouvez faire cela dans la mesure où Document est une interface, pas une classe.

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

    Pour plus d’informations sur les paramètres de type valeur et référence, consultez Les arguments Pass par valeur et par référence (Visual Basic) (pour Visual Basic) et Les paramètres Pass (Guide de programmation C#).

Contenu connexe