DefaultParameterValueAttribute Classe

Definizione

Spazio dei nomi:

System.Runtime.InteropServices

Assembly:

System.Runtime.InteropServices.dll

Source:

DefaultParameterValueAttribute.cs

Imposta il valore predefinito di un parametro quando viene chiamato da un linguaggio che supporta parametri predefiniti. La classe non può essere ereditata.

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 in altro modo 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.

Costruttori

DefaultParameterValueAttribute(Object)

Inizializza una nuova istanza della classe DefaultParameterValueAttribute con il valore predefinito di un parametro.

Proprietà

TypeId	Quando è implementata in una classe derivata, ottiene un identificatore univoco della classe Attribute. (Ereditato da Attribute)
Value	Ottiene il valore predefinito di un parametro.

Metodi

Equals(Object)	Restituisce un valore che indica se questa istanza è uguale a un oggetto specificato. (Ereditato da Attribute)
GetHashCode()	Restituisce il codice hash per l'istanza. (Ereditato da Attribute)
GetType()	Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object)
IsDefaultAttribute()	In caso di override in una classe derivata, indica se il valore di questa istanza è il valore predefinito per la classe derivata. (Ereditato da Attribute)
Match(Object)	Quando è sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza equivale a un oggetto specificato. (Ereditato da Attribute)
MemberwiseClone()	Crea una copia superficiale dell'oggetto Object corrente. (Ereditato da Object)
ToString()	Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)