DefaultParameterValueAttribute Kelas

Definisi

Ruang nama:

System.Runtime.InteropServices

Rakitan:

System.Runtime.InteropServices.dll

Sumber:

DefaultParameterValueAttribute.cs

Mengatur nilai default parameter saat dipanggil dari bahasa yang mendukung parameter default. Kelas ini tidak dapat diwariskan.

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

Warisan

Object

Attribute

DefaultParameterValueAttribute

Atribut

AttributeUsageAttribute

Contoh

Contoh kode berikut menunjukkan cara menerapkan DefaultParameterValueAttribute atribut ke parameter metode yang ditulis dalam C#. Cuplikan juga menggunakan OptionalAttribute atribut untuk memungkinkan metode dipanggil tanpa argumen apa pun.

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

Ada beberapa perbedaan perilaku antara argumen opsional C# dan menggunakan DefaultParameterValueAttribute dengan OptionalAttribute. Cuplikan kode berikut menunjukkan perbedaan ini.

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
}

Keterangan

Atribut DefaultParameterValueAttribute memungkinkan Anda menentukan nilai parameter default dalam bahasa yang tidak mendukung parameter default. Setelah Anda menerapkan atribut ini ke kode Anda, bahasa yang mendukung parameter default dapat menggunakan nilai yang ditentukan sebagai parameter default.

DefaultParameterValueAttribute sangat berguna untuk menentukan parameter default untuk metode antarmuka interop COM.

Konstruktor

DefaultParameterValueAttribute(Object)

Menginisialisasi instans DefaultParameterValueAttribute baru kelas dengan nilai default parameter.

Properti

TypeId	Ketika diimplementasikan di kelas turunan, mendapatkan pengidentifikasi unik untuk ini Attribute. (Diperoleh dari Attribute)
Value	Mendapatkan nilai default parameter.

Metode

Equals(Object)	Mengembalikan nilai yang menunjukkan apakah instans ini sama dengan objek tertentu. (Diperoleh dari Attribute)
GetHashCode()	Mengembalikan kode hash untuk instans ini. (Diperoleh dari Attribute)
GetType()	Mendapatkan dari instans Type saat ini. (Diperoleh dari Object)
IsDefaultAttribute()	Ketika ditimpa di kelas turunan, menunjukkan apakah nilai instans ini adalah nilai default untuk kelas turunan. (Diperoleh dari Attribute)
Match(Object)	Saat ditimpa di kelas turunan, mengembalikan nilai yang menunjukkan apakah instans ini sama dengan objek tertentu. (Diperoleh dari Attribute)
MemberwiseClone()	Membuat salinan dangkal dari saat ini Object. (Diperoleh dari Object)
ToString()	Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object)