CallerMemberNameAttribute 类

定义

命名空间:

System.Runtime.CompilerServices

程序集:

netstandard.dll, System.Runtime.dll

Source:

CallerMemberNameAttribute.cs

应使用特定调用方成员名称填充的标记参数。

public ref class CallerMemberNameAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Parameter, Inherited=false)]
public sealed class CallerMemberNameAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Parameter, Inherited=false)>]
type CallerMemberNameAttribute = class
    inherit Attribute

Public NotInheritable Class CallerMemberNameAttribute
Inherits Attribute

继承

Object

Attribute

CallerMemberNameAttribute

属性

AttributeUsageAttribute

示例

以下示例演示如何使用 CallerMemberName 特性。 每次调用 TraceMessage 该方法时，调用方信息都将替换为可选参数的参数。

public void DoProcessing()
{
    TraceMessage("Something happened.");
}

public void TraceMessage(string message,
        [System.Runtime.CompilerServices.CallerMemberName] string memberName = "",
        [System.Runtime.CompilerServices.CallerFilePath] string sourceFilePath = "",
        [System.Runtime.CompilerServices.CallerLineNumber] int sourceLineNumber = 0)
{
    System.Diagnostics.Trace.WriteLine("message: " + message);
    System.Diagnostics.Trace.WriteLine("member name: " + memberName);
    System.Diagnostics.Trace.WriteLine("source file path: " + sourceFilePath);
    System.Diagnostics.Trace.WriteLine("source line number: " + sourceLineNumber);
}

// Sample Output:
//  message: Something happened.
//  member name: DoProcessing
//  source file path: c:\Users\username\Documents\Visual Studio 2012\Projects\CallerInfoCS\CallerInfoCS\Form1.cs
//  source line number: 31

Private Sub DoProcessing()
    TraceMessage("Something happened.")
End Sub

Public Sub TraceMessage(message As String,
        <System.Runtime.CompilerServices.CallerMemberName> Optional memberName As String = Nothing,
        <System.Runtime.CompilerServices.CallerFilePath> Optional sourcefilePath As String = Nothing,
        <System.Runtime.CompilerServices.CallerLineNumber()> Optional sourceLineNumber As Integer = 0)

    System.Diagnostics.Trace.WriteLine("message: " & message)
    System.Diagnostics.Trace.WriteLine("member name: " & memberName)
    System.Diagnostics.Trace.WriteLine("source file path: " & sourcefilePath)
    System.Diagnostics.Trace.WriteLine("source line number: " & sourceLineNumber)
End Sub

' Sample output:
'   message: Something happened.
'   member name: DoProcessing
'   source file path: C:\Users\username\Documents\Visual Studio 2012\Projects\CallerInfoVB\CallerInfoVB\Form1.vb
'   source line number: 15

注解

将 CallerMemberName 属性应用于具有默认值的可选参数。 必须为可选参数指定显式默认值。 不能将此属性应用于未指定为可选参数的参数。

可以使用特性 CallerMemberName 来避免将成员名称指定为 String 所调用方法的参数。 使用此方法可以避免 重命名重构 不会更改 String 值的问题。 这对于以下任务特别有用：

• 使用跟踪和诊断例程。

• 在绑定数据时实现 INotifyPropertyChanged 接口。 此接口允许对象的属性通知绑定控件属性已更改，以便控件可以显示更新的信息。 如果没有属性 CallerMemberName ，则必须将属性名称指定为文本。

下图显示了使用 CallerMemberName 属性时返回的成员名称。

调用发生在	成员名称结果
方法、属性或事件	调用源自的方法、属性或事件的名称。
构造函数	字符串“.ctor”
静态构造函数	字符串“.cctor”
破坏者	字符串“Finalize”
用户定义的运算符或转换	为成员生成的名称，例如，“op_Addition”。
特性构造函数	应用特性的成员的名称。 如果特性是成员中的任何元素（如参数、返回值或泛型类型参数），则结果是与该元素关联的成员的名称。
没有包含成员（例如，应用于类型的程序集级别或属性）	可选参数的默认值。

构造函数

名称	说明
CallerMemberNameAttribute()	初始化 CallerMemberNameAttribute 类的新实例。

属性

名称	说明
TypeId	在派生类中实现时，获取此 Attribute的唯一标识符。 (继承自 Attribute)

方法

名称	说明
Equals(Object)	返回一个值，该值指示此实例是否等于指定对象。 (继承自 Attribute)
GetHashCode()	返回此实例的哈希代码。 (继承自 Attribute)
GetType()	获取当前实例的 Type。 (继承自 Object)
IsDefaultAttribute()	在派生类中重写时，指示此实例的值是否为派生类的默认值。 (继承自 Attribute)
Match(Object)	在派生类中重写时，返回一个值，该值指示此实例是否等于指定对象。 (继承自 Attribute)
MemberwiseClone()	创建当前 Object的浅表副本。 (继承自 Object)
ToString()	返回一个表示当前对象的字符串。 (继承自 Object)

另请参阅

• CallerFilePathAttribute
• CallerLineNumberAttribute