DefaultParameterValueAttribute Classe

Definizione

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

Ereditarietà

Object

Attribute

DefaultParameterValueAttribute

Attributi

AttributeUsageAttribute

Esempio

Nell'esempio di codice seguente viene illustrato come applicare l'attributo DefaultParameterValueAttribute a un parametro di un metodo scritto in C#. Il frammento di codice usa anche l'attributo OptionalAttribute per consentire la chiamata del metodo senza argomenti.

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
    }    
}

Esistono alcune differenze di comportamento tra gli argomenti facoltativi C# e l'uso di DefaultParameterValueAttribute con OptionalAttribute. Il frammento di codice seguente illustra queste differenze.

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
}

Commenti

L'attributo DefaultParameterValueAttribute consente di specificare un valore di parametro predefinito in una lingua che non supporta altrimenti i parametri predefiniti. Dopo aver applicato questo attributo al codice, le lingue che supportano i parametri predefiniti possono usare il valore specificato come parametro predefinito.

DefaultParameterValueAttribute è particolarmente utile per specificare i parametri predefiniti per i metodi di un'interfaccia di interoperabilità COM.