DefaultParameterValueAttribute Classe

Définition

public ref class DefaultParameterValueAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Parameter)]
public sealed class DefaultParameterValueAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Parameter)>]
type DefaultParameterValueAttribute = class
    inherit Attribute

Public NotInheritable Class DefaultParameterValueAttribute
Inherits Attribute

Héritage

Object

Attribute

DefaultParameterValueAttribute

Attributs

AttributeUsageAttribute

Exemples

L’exemple de code suivant montre comment appliquer l’attribut DefaultParameterValueAttribute à un paramètre d’une méthode écrite en C#. L’extrait de code utilise également l’attribut OptionalAttribute pour permettre à la méthode d’être appelée sans arguments.

using System;
using System.Runtime.InteropServices;

public class Program
{
    public static void MethodWithDefaultParam([Optional, DefaultParameterValue("DEFAULT_PARAM_VALUE")] string str)
    {
        Console.WriteLine($"The passed value is: {str}");
    }

    public static void Main()
    {
        MethodWithDefaultParam(); // The passed value is: DEFAULT_PARAM_VALUE
        MethodWithDefaultParam("NEW_VALUE"); // The passed value is: NEW_VALUE
    }    
}

Il existe des différences de comportement entre les arguments facultatifs C# et l’utilisation de DefaultParameterValueAttribute avec OptionalAttribute. L’extrait de code suivant illustre ces différences.

using System.Runtime.InteropServices;

public class Program
{
    public static void MethodWithObjectDefaultAttr1([Optional, DefaultParameterValue(123)] object obj) {} // OK
    public static void MethodWithObjectDefaultAttr2([Optional, DefaultParameterValue("abc")] object obj) {} // OK
    public static void MethodWithObjectDefaultAttr3([Optional, DefaultParameterValue(null)] object? obj) {} // OK

    public static void MethodWithObjectDefaultParam1(object obj = 123) {} // CS1763
    public static void MethodWithObjectDefaultParam2(object obj = "abc") {} // CS1763
    public static void MethodWithObjectDefaultParam3(object obj? = null) {} // OK
}

Remarques

L’attribut DefaultParameterValueAttribute vous permet de spécifier une valeur de paramètre par défaut dans une langue qui ne prend pas en charge les paramètres par défaut. Après avoir appliqué cet attribut à votre code, les langues qui prennent en charge les paramètres par défaut peuvent utiliser la valeur spécifiée comme paramètre par défaut.

Le DefaultParameterValueAttribute est particulièrement utile pour spécifier les paramètres par défaut pour les méthodes d’une interface d’interopérabilité COM.

Constructeurs

Propriétés

Méthodes

Implémentations d’interfaces explicites

S’applique à