DefaultParameterValueAttribute Класс

Определение

Пространство имен:

System.Runtime.InteropServices

Сборка:

System.Runtime.InteropServices.dll

Исходный код:

DefaultParameterValueAttribute.cs

Устанавливает значение параметра по умолчанию, которое используется, если параметр вызывается из языка, поддерживающего параметры по умолчанию. Этот класс не наследуется.

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-интерфейса взаимодействия.

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

DefaultParameterValueAttribute(Object)

Инициализирует новый экземпляр класса DefaultParameterValueAttribute значением параметра по умолчанию.

Свойства

TypeId	В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute. (Унаследовано от Attribute)
Value	Возвращает значение, присваиваемое параметру по умолчанию.

Методы

Equals(Object)	Возвращает значение, показывающее, равен ли экземпляр указанному объекту. (Унаследовано от Attribute)
GetHashCode()	Возвращает хэш-код данного экземпляра. (Унаследовано от Attribute)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
IsDefaultAttribute()	При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса. (Унаследовано от Attribute)
Match(Object)	При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту. (Унаследовано от Attribute)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)