BuildEventArgs Class

Definition

This class encapsulates the default data associated with build events. It is intended to be extended/sub-classed.

public ref class BuildEventArgs abstract : EventArgs
[System.Serializable]
public abstract class BuildEventArgs : EventArgs
[<System.Serializable>]
type BuildEventArgs = class
    inherit EventArgs
Public MustInherit Class BuildEventArgs
Inherits EventArgs
Inheritance
BuildEventArgs
Derived
Attributes

Remarks

WARNING: marking a type [Serializable] without implementing ISerializable imposes a serialization contract -- it is a promise to never change the type's fields i.e. the type is immutable; adding new fields in the next version of the type without following certain special FX guidelines, can break both forward and backward compatibility

Constructors

BuildEventArgs()

Default constructor

BuildEventArgs(String, String, String)

This constructor allows all event data to be initialized

BuildEventArgs(String, String, String, DateTime)

This constructor allows all event data to be initialized while providing a custom timestamp.

Properties

BuildEventContext

Event contextual information for the build event argument

HelpKeyword

Custom help keyword associated with event.

Message

Text of event.

RawMessage

Exposes the underlying message field without side-effects. Used for serialization.

RawTimestamp

Exposes the private Microsoft.Build.Framework.BuildEventArgs.timestamp field to derived types. Used for serialization. Avoids the side effects of calling the Timestamp getter.

SenderName

Name of the object sending this event.

ThreadId

The thread that raised event.

Timestamp

The time when event was raised.

Applies to