DefaultParameterValueAttribute Classe

Definição

Namespace:

System.Runtime.InteropServices

Assembly:

System.Runtime.InteropServices.dll

Origem:

DefaultParameterValueAttribute.cs

Define o valor padrão de um parâmetro, quando chamado de uma linguagem que dá suporte a parâmetros padrão. Essa classe não pode ser herdada.

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

Herança

Object

Attribute

DefaultParameterValueAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo de código a seguir demonstra como aplicar o DefaultParameterValueAttribute atributo a um parâmetro de um método escrito em C#. O snippet também usa o OptionalAttribute atributo para permitir que o método seja chamado sem argumentos.

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

Há algumas diferenças de comportamento entre argumentos opcionais do C# e usando DefaultParameterValueAttribute com OptionalAttribute. O snippet de código a seguir demonstra essas diferenças.

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
}

Comentários

O DefaultParameterValueAttribute atributo permite que você especifique um valor de parâmetro padrão em um idioma que, de outra forma, não dá suporte a parâmetros padrão. Depois de aplicar esse atributo ao código, os idiomas que dão suporte a parâmetros padrão podem usar o valor especificado como um parâmetro padrão.

O DefaultParameterValueAttribute é particularmente útil para especificar parâmetros padrão para métodos de uma interface de interoperabilidade COM.

Construtores

DefaultParameterValueAttribute(Object)

Inicializa uma nova instância da classe DefaultParameterValueAttribute com o valor padrão de um parâmetro.

Propriedades

TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute)
Value	Obtém o valor padrão de um parâmetro.

Métodos

Equals(Object)	Retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
GetHashCode()	Retorna o código hash para a instância. (Herdado de Attribute)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IsDefaultAttribute()	Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada. (Herdado de Attribute)
Match(Object)	Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)