DefaultParameterValueAttribute Класс

Определение

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

Наследование

Object

Attribute

DefaultParameterValueAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере кода показано, как применить DefaultParameterValueAttribute атрибут к параметру метода, написанного на C#. В фрагменте OptionalAttribute кода также используется атрибут , чтобы разрешить вызов метода без аргументов.

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

Существуют некоторые различия в поведении между необязательными аргументами C# и использованием DefaultParameterValueAttribute с OptionalAttribute. Эти различия демонстрируются в следующем фрагменте кода.

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
}

Комментарии

Атрибут DefaultParameterValueAttribute позволяет указать значение параметра по умолчанию на языке, который в противном случае не поддерживает параметры по умолчанию. После применения этого атрибута к коду языки, поддерживающие параметры по умолчанию, могут использовать указанное значение в качестве параметра по умолчанию.

Особенно DefaultParameterValueAttribute удобно указывать параметры по умолчанию для методов интерфейса COM-взаимодействия.

Конструкторы

Свойства

Методы

Явные реализации интерфейса

Применяется к