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 | |
---|---|---|
Event() | Initializes a new instance of the Event class. | |
Event(Session, EventInfo) | Initializes a new instance of the Event class from the parent Package object and an EventInfo object. | |
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 | |
---|---|---|
AbstractIdentityKey | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) | |
Actions | Gets the actions for the XEvent object constructed by the user. | |
Description | Gets or sets the Description property. The set accessor is for internal use only. | |
EventFields | Gets the EventFieldCollection. | |
ID | Gets the ID property as Int32. | |
IdentityKey | Gets the IdentityKey property. | |
Metadata | Returns metadata about the instance and its domain. (Inherited from SfcInstance.) | |
ModuleID | Gets the module identifier. | |
Name | Gets or sets the name of the Event object. | |
PackageName | Gets the name of the Package object that owns the event. | |
Parent | Gets or sets the parent Session object for an event. | |
Predicate | Gets or sets the predicate tree for PredicateExpression. | |
PredicateExpression | Gets or sets the string representation of the PredExpr object of an Event object. | |
Properties | Returns a collection instance properties. (Inherited from SfcInstance.) | |
State | Gets the state of the object used in Alter function in session. | |
Urn | Returns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.) |
Top
Methods
Name | Description | |
---|---|---|
AddAction(String) | Creates an Action object with the specified name and adds it to the ActionCollection. | |
AddAction(ActionInfo) | Creates an Action object from an ActionInfo object and adds it to the ActionCollection. | |
CreateIdentityKey | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) | |
Discover | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) | |
Equals | (Inherited from Object.) | |
GetChildCollection | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) | |
GetDomain | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) | |
GetHashCode | (Inherited from Object.) | |
GetObjectFactory | Gets the object factory constructor used to create an Action object. | |
GetPropertySet | Returns the set of properties for the SfcInstance object. (Inherited from SfcInstance.) | |
GetType | (Inherited from Object.) | |
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.) | |
InitializeUIPropertyState | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) | |
OnPropertyMetadataChanges | Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.) | |
OnPropertyValueChanges | Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.) | |
Refresh | Refreshes the object's properties by reading them from the server. (Inherited from SfcInstance.) | |
RemoveAction | Removes an Action object from the Session object. | |
ResetKey | Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.) | |
Serialize | Serializes the instance to XML. (Inherited from SfcInstance.) | |
SetEventInfo | Sets the EventInfo object for a pending XEvent object. | |
ToString | Returns a string representation of the instance Urn. (Inherited from SfcInstance.) |
Top
Events
Name | Description | |
---|---|---|
PropertyChanged | CLS-compliant event for property changes. (Inherited from SfcInstance.) | |
PropertyMetadataChanged | CLS-compliant event for property metadata changes. (Inherited from SfcInstance.) |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
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.