CallerMemberNameAttribute Třída

Definice

Obor názvů:

System.Runtime.CompilerServices

Sestavení:

netstandard.dll, System.Runtime.dll

Zdroj:

CallerMemberNameAttribute.cs

Parametr značek, který by měl být vyplněný konkrétním názvem člena volajícího.

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

Dědičnost

Object

Attribute

CallerMemberNameAttribute

Atributy

AttributeUsageAttribute

Příklady

Následující příklad ukazuje, jak použít CallerMemberName atribut. Při každém volání TraceMessage metody se informace volajícího nahradí jako argument volitelného parametru.

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

Poznámky

Atribut použijete CallerMemberName na volitelný parametr, který má výchozí hodnotu. Je nutné zadat explicitní výchozí hodnotu volitelného parametru. Tento atribut nelze použít u parametrů, které nejsou zadány jako volitelné.

Atribut můžete použít CallerMemberName k tomu, abyste zabránili zadání názvu člena jako argumentu pro volanou String metodu. Pomocí této techniky se vyhnete problému, ve kterém Rename Refactoring nezmění String hodnoty. To je užitečné zejména pro následující úlohy:

• Použití trasovacích a diagnostických rutin

• Implementace rozhraní INotifyPropertyChanged při vazbě dat. Toto rozhraní umožňuje vlastnost objektu oznámit vázanému ovládacímu prvku, že se vlastnost změnila, aby ovládací prvek mohl zobrazit aktualizované informace. Bez atributu CallerMemberName je nutné zadat název vlastnosti jako literál.

Následující graf ukazuje názvy členů, které se vrátí při použití atributu CallerMemberName .

Volání probíhá v rámci	Výsledky jména člena
Metoda, vlastnost nebo událost	Název metody, vlastnosti nebo události, ze které volání pochází.
Konstruktor	Řetězec ".ctor"
Statický konstruktor	Řetězec ".cctor"
Destruktor	Řetězec "Finalize"
Uživatelem definované operátory nebo převody	Vygenerovaný název člena, například "op_Addition".
Konstruktor atributů	Název člena, na který se atribut použije. Pokud je atribut libovolný prvek v rámci členu (například parametr, návratová hodnota nebo parametr obecného typu), tento výsledek je název člena, který je přidružený k tomuto prvku.
Žádný obsahující člen (například úroveň sestavení nebo atributy použité u typů)	Výchozí hodnota volitelného parametru.

Konstruktory

Name	Description
CallerMemberNameAttribute()	Inicializuje novou instanci CallerMemberNameAttribute třídy.

Vlastnosti

Name	Description
TypeId	Při implementaci v odvozené třídě získá jedinečný identifikátor pro tento Attribute. (Zděděno od Attribute)

Metody

Name	Description
Equals(Object)	Vrátí hodnotu, která určuje, zda je tato instance rovna zadanému objektu. (Zděděno od Attribute)
GetHashCode()	Vrátí kód hash pro tuto instanci. (Zděděno od Attribute)
GetType()	Získá Type aktuální instance. (Zděděno od Object)
IsDefaultAttribute()	Při přepsání v odvozené třídě určuje, zda hodnota této instance je výchozí hodnotou pro odvozenou třídu. (Zděděno od Attribute)
Match(Object)	Při přepsání v odvozené třídě vrátí hodnotu, která určuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Viz také

• CallerFilePathAttribute
• CallerLineNumberAttribute