DefaultParameterValueAttribute Clase

Definición

Espacio de nombres:

System.Runtime.InteropServices

Ensamblado:

System.Runtime.InteropServices.dll

Source:

DefaultParameterValueAttribute.cs

Establece el valor predeterminado de un parámetro cuando se le llama desde un lenguaje que admite parámetros predeterminados. Esta clase no puede heredarse.

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

Herencia

Object

Attribute

DefaultParameterValueAttribute

Atributos

AttributeUsageAttribute

Ejemplos

En el ejemplo de código siguiente se muestra cómo aplicar el DefaultParameterValueAttribute atributo a un parámetro de un método escrito en C#. El fragmento de código también usa el OptionalAttribute atributo para permitir que se llame al método sin ningún argumento.

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

Hay algunas diferencias de comportamiento entre los argumentos opcionales de C# y el uso DefaultParameterValueAttribute con OptionalAttribute. En el siguiente fragmento de código se muestran estas diferencias.

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
}

Comentarios

El DefaultParameterValueAttribute atributo permite especificar un valor de parámetro predeterminado en un idioma que no admite parámetros predeterminados. Después de aplicar este atributo al código, los idiomas que admiten parámetros predeterminados pueden usar el valor especificado como parámetro predeterminado.

DefaultParameterValueAttribute Resulta especialmente útil especificar parámetros predeterminados para los métodos de una interfaz de interoperabilidad COM.

Constructores

DefaultParameterValueAttribute(Object)

Inicializa una nueva instancia de la clase DefaultParameterValueAttribute con el valor predeterminado de un parámetro.

Propiedades

TypeId	Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. (Heredado de Attribute)
Value	Obtiene el valor predeterminado del parámetro.

Métodos

Equals(Object)	Devuelve un valor que indica si esta instancia es igual que un objeto especificado. (Heredado de Attribute)
GetHashCode()	Devuelve el código hash de esta instancia. (Heredado de Attribute)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
IsDefaultAttribute()	Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada. (Heredado de Attribute)
Match(Object)	Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. (Heredado de Attribute)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)