EventAttribute.Message Property

Definition

Namespace:

System.Diagnostics.Tracing

Assemblies:

netstandard.dll, System.Diagnostics.Tracing.dll

Source:

EventSource.cs

Gets or sets the message for the event.

C#

public string? Message { get; set; }

Property Value

String

The message for the event.

Examples

The following example shows how to use the Message property to specify event messages. This code example is part of a larger example provided for the EventSource class.

C#

[Event(1, Message = "Application Failure: {0}", Level = EventLevel.Error, Keywords = Keywords.Diagnostic)]
public void Failure(string message) { WriteEvent(1, message); }

C#

[Event(2, Message = "Starting up.", Keywords = Keywords.Perf, Level = EventLevel.Informational)]
public void Startup() { WriteEvent(2); }

C#

[Event(3, Message = "loading page {1} activityID={0}", Opcode = EventOpcode.Start,
    Task = Tasks.Page, Keywords = Keywords.Page, Level = EventLevel.Informational)]
public void PageStart(int ID, string url) { if (IsEnabled()) WriteEvent(3, ID, url); }

Remarks

You can use standard .NET Framework substitution operators (for example, {1}) in the string). They will be replaced with the string representation of the corresponding part of the event payload.

C#

[Event(1, Message = "Application Failure: {0}", Level = EventLevel.Error, Keywords = Keywords.Diagnostic)]  
        public void Failure(string message) { WriteEvent(1, message); }  

Applies to