Paramètres optionnels dans les solutions OfficeOptional parameters in Office solutions

De nombreuses méthodes des modèles objet fournis dans les applications Microsoft Office acceptent les paramètres optionnels.Many of the methods in the object models of Microsoft Office applications accept optional parameters. 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.If you use Visual Basic to develop an Office solution in Visual Studio, you do not have to pass a value for optional parameters because the default values are automatically used for each missing parameter. Dans la plupart des cas, vous pouvez également omettre les paramètres optionnels dans les projets Visual c#.In most cases, you can also omit optional parameters in Visual C# projects. Toutefois, vous ne pouvez pas omettre ref les paramètres de la ThisDocument classe dans les projets Word au niveau du document.However, you cannot omit optional ref parameters of the ThisDocument class in document-level Word projects.

S’applique à : les informations contenues dans cette rubrique s’applique au document-projets et ajouter de VSTO de niveau-dans les projets.Applies to: The information in this topic applies to document-level projects and VSTO Add-in projects. Consultez fonctionnalités disponibles par type d’application et de projet Office.See Features available by Office application and project type.

Pour plus d’informations sur l’utilisation des paramètres optionnels dans les projets Visual c# et Visual Basic, consultez arguments nommés et optionnels (C# guide de programmation) et (Visual Basic).For more information about working with optional parameters in Visual C# and Visual Basic projects, see Named and optional arguments (C# programming guide) and Optional parameters (Visual Basic).

Note

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#.In earlier versions of Visual Studio, you must pass a value for every optional parameter in Visual C# projects. 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.For convenience, these projects include a global variable named missing that you can pass to an optional parameter when you want to use the default value of the parameter. Projets Visual c# pour Office dans Visual Studio incluent toujours le missing variable, mais vous n’est généralement pas nécessaire pour l’utiliser lorsque vous développez des solutions Office dans Visual Studio 2013Visual Studio 2013, sauf lorsque vous appelez des méthodes avec ref paramètres de la ThisDocument classe dans les projets au niveau du document pour Word.Visual C# projects for Office in Visual Studio still include the missing variable, but you typically do not need to use it when you develop Office solutions in Visual Studio 2013Visual Studio 2013, except when you call methods with optional ref parameters in the ThisDocument class in document-level projects for Word.

Exemple dans ExcelExample in Excel

La méthode CheckSpelling possède de nombreux paramètres optionnels.The CheckSpelling method has many optional parameters. 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.You can specify values for some parameters and accept the default value of others as shown in the following code example. Cet exemple utilise un projet de niveau document avec une classe de feuille de calcul nommée Sheet1.This example requires a document-level project with a worksheet class named Sheet1.


Globals.Sheet1.CheckSpelling(ignoreUppercase: true);
Globals.Sheet1.CheckSpelling(ignoreUppercase:=True)

Exemple dans WordExample in Word

La méthode Execute possède de nombreux paramètres optionnels.The Execute method has many optional parameters. 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.You can specify values for some parameters and accept the default value of others as shown in the following code example.

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);            

Utiliser des paramètres optionnels des méthodes de la classe ThisDocument dans les projets au niveau du document Visual c# pour WordUse optional parameters of methods in the ThisDocument class in Visual C# document-level projects for Word

Le modèle objet Word contient de nombreuses méthodes comportant ref paramètres qui acceptent les Object valeurs.The Word object model contains many methods with optional ref parameters that accept Object values. Toutefois, vous ne pouvez pas omettre ref les paramètres des méthodes généré ThisDocument classe dans les projets au niveau du document Visual c# pour Word.However, you cannot omit optional ref parameters of methods of the generated ThisDocument class in Visual C# document-level projects for Word. Visual c# vous permet d’omettre ref paramètres uniquement pour les méthodes des interfaces, ne classes pas.Visual C# enables you to omit optional ref parameters only for methods of interfaces, not classes. Par exemple, l’exemple de code suivant ne se compile pas, car vous ne pouvez pas omettre ref les paramètres de la CheckSpelling méthode de la ThisDocument classe.For example, the following code example does not compile, because you cannot omit optional ref parameters of the CheckSpelling method of the ThisDocument class.

Globals.ThisDocument.CheckSpelling(ignoreUppercase: true);

Quand vous appelez des méthodes de la classe ThisDocument, suivez ces consignes :When you call methods of the ThisDocument class, follow these guidelines:

  • Pour accepter la valeur par défaut facultative ref , passez le missing variable au paramètre.To accept the default value of an optional ref parameter, pass the missing variable to the parameter. 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é.The missing variable is automatically defined in Visual C# Office projects and is assigned to the value Missing in the generated project code.

  • Pour spécifier votre propre valeur pour une option ref , déclarez un objet qui est assigné à la valeur que vous souhaitez spécifier et puis passer l’objet au paramètre.To specify your own value for an optional ref parameter, declare an object that is assigned to the value that you want to specify, and then pass the object to the parameter.

    L’exemple de code suivant montre comment appeler le CheckSpelling méthode en spécifiant une valeur pour le ignoreUppercase paramètre et en acceptant la valeur par défaut pour les autres paramètres.The following code example demonstrates how to call the CheckSpelling method by specifying a value for the ignoreUppercase parameter and accepting the default value for the other parameters.

    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 ref paramètres d’une méthode dans le ThisDocument (classe), vous pouvez également appeler la même méthode sur le Document objet retourné par la InnerObject propriété et omettez la paramètres de cette méthode.If you want to write code that omits optional ref parameters of a method in the ThisDocument class, you can alternatively call the same method on the Document object returned by the InnerObject property, and omit the parameters from that method. Vous pouvez faire cela dans la mesure où Document est une interface, pas une classe.You can do this because Document is an interface, rather than a class.

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

    Pour plus d’informations sur les paramètres de type valeur et référence, consultez passer des arguments par valeur et par référence (Visual Basic) (pour Visual Basic) et passer des paramètres (C# guide de programmation).For more information about value and reference type parameters, see Pass arguments by value and by reference (Visual Basic) (for Visual Basic) and Pass parameters (C# programming guide).

Voir aussiSee also

Développer des solutions Office Develop Office solutions
Écrire du code dans les solutions OfficeWrite code in Office solutions