Share via


Event Class

Represents the runtime class for XEvent objects. Each instance of this class represents a row in sys.server_event_session_events.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
    Microsoft.SqlServer.Management.XEvent.Event

Namespace:  Microsoft.SqlServer.Management.XEvent
Assembly:  Microsoft.SqlServer.Management.XEvent (in Microsoft.SqlServer.Management.XEvent.dll)

Syntax

'Declaration
Public NotInheritable Class Event _
    Inherits SfcInstance _
    Implements ISfcDiscoverObject
'Usage
Dim instance As Event
public sealed class Event : SfcInstance, 
    ISfcDiscoverObject
public ref class Event sealed : public SfcInstance, 
    ISfcDiscoverObject
[<SealedAttribute>]
type Event =  
    class 
        inherit SfcInstance 
        interface ISfcDiscoverObject 
    end
public final class Event extends SfcInstance implements ISfcDiscoverObject

The Event type exposes the following members.

Constructors

  Name Description
Public method Event() Initializes a new instance of the Event class.
Public method Event(Session, EventInfo) Initializes a new instance of the Event class from the parent Package object and an EventInfo object.
Public method Event(Session, String) Initializes a new instance of the Event class from the parent Package object and the name of the event.

Top

Properties

  Name Description
Protected property AbstractIdentityKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public property Actions Gets the actions for the XEvent object constructed by the user.
Public property Description Gets or sets the Description property. The set accessor is for internal use only.
Public property EventFields Gets the EventFieldCollection.
Public property ID Gets the ID property as Int32.
Public property IdentityKey Gets the IdentityKey property.
Public property Metadata Returns metadata about the instance and its domain. (Inherited from SfcInstance.)
Public property ModuleID Gets the module identifier.
Public property Name Gets or sets the name of the Event object.
Public property PackageName Gets the name of the Package object that owns the event.
Public property Parent Gets or sets the parent Session object for an event.
Public property Predicate Gets or sets the predicate tree for PredicateExpression.
Public property PredicateExpression Gets or sets the string representation of the PredExpr object of an Event object.
Public property Properties Returns a collection instance properties. (Inherited from SfcInstance.)
Public property State Gets the state of the object used in Alter function in session.
Public property Urn Returns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.)

Top

Methods

  Name Description
Public method AddAction(String) Creates an Action object with the specified name and adds it to the ActionCollection.
Public method AddAction(ActionInfo) Creates an Action object from an ActionInfo object and adds it to the ActionCollection.
Protected method CreateIdentityKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Discover Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Equals (Inherited from Object.)
Protected method GetChildCollection Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method GetDomain Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method GetHashCode (Inherited from Object.)
Public methodStatic member GetObjectFactory Gets the object factory constructor used to create an Action object.
Public method GetPropertySet Returns the set of properties for the SfcInstance object. (Inherited from SfcInstance.)
Public method GetType (Inherited from Object.)
Protected method GetTypeMetadataImpl Indicates the domains that override by returning the right TypeMetadata class directly. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method InitializeUIPropertyState Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method OnPropertyMetadataChanges Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)
Protected method OnPropertyValueChanges Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)
Public method Refresh Refreshes the object's properties by reading them from the server. (Inherited from SfcInstance.)
Public method RemoveAction Removes an Action object from the Session object.
Protected method ResetKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Serialize Serializes the instance to XML. (Inherited from SfcInstance.)
Public method SetEventInfo Sets the EventInfo object for a pending XEvent object.
Public method ToString Returns a string representation of the instance Urn. (Inherited from SfcInstance.)

Top

Events

  Name Description
Public event PropertyChanged CLS-compliant event for property changes. (Inherited from SfcInstance.)
Public event PropertyMetadataChanged CLS-compliant event for property metadata changes. (Inherited from SfcInstance.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ISfcDiscoverObject.Discover Discovers an Action object in metadata by using the ISfcDependencyDiscoveryObjectSink object.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.XEvent Namespace