Event Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Runtime class for Event. Each instance of this class represents a row in sys.server_event_session_events.
public sealed class Event : Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance, Microsoft.SqlServer.Management.XEvent.ISessionObjecttype Event = class
inherit SfcInstance
interface ISfcDiscoverObject
interface ISessionObjectPublic NotInheritable Class Event
Inherits SfcInstance
Implements ISessionObject- Inheritance
- Implements
Constructors
| Event() |
Initializes a new instance of the Event class. Empty constructor is a convention in SFC. |
| Event(Session, EventInfo) |
Initializes a new instance of the Event class from an EventInfo object. |
| Event(Session, String) |
Initializes a new instance of the Event class with given parent and name. |
Fields
| TypeTypeName |
Type name |
Properties
| AbstractIdentityKey | (Inherited from SfcInstance) |
| Actions |
Gets the actions for this event. |
| Description |
Gets or sets event description. Set accessor is for internal use only. |
| EventFields |
Gets the event fileds collection. |
| ID |
Gets the description. |
| IdentityKey |
Gets the identity key. |
| KeyChain |
Returns the identity path of the object (Inherited from SfcInstance) |
| Metadata | (Inherited from SfcInstance) |
| ModuleID |
Gets the module ID. |
| Name |
The name of the Event |
| PackageName |
Gets the package name that the event belongs to. |
| Parent |
Parent Property for Event. |
| Predicate |
Predicate tree for PredicateExpression. |
| PredicateExpression |
This is the string representation of the predicate. |
| Properties | (Inherited from SfcInstance) |
| PropertyStorageProvider |
This property returns the default implementation of SFC for ISfcPropertyStorageProvider interface, it can be overriden in the child classes to return another storage provider (i.e. flat properties list) (Inherited from SfcInstance) |
| ScriptName |
Gets Event name formatted for scripting. |
| State |
State of the object, used in Alter function in session. |
| Urn |
Create a new Urn string on each request and return it. (Inherited from SfcInstance) |
Methods
| AddAction(ActionInfo) |
Create an action from the ActionInfo and add it into the action collection. |
| AddAction(String) |
Create an action with the specify name and add it to the actions. |
| AlterImpl() | (Inherited from SfcInstance) |
| CheckObjectCreated() |
To be called from domain for when an API requires the object to be Created Stronger than CheckObjectState (Inherited from SfcInstance) |
| CheckObjectState() |
To be called from domain for any access to the object (Inherited from SfcInstance) |
| CreateIdentityKey() | (Inherited from SfcInstance) |
| CreateImpl() | (Inherited from SfcInstance) |
| Discover(ISfcDependencyDiscoveryObjectSink) | (Inherited from SfcInstance) |
| DropImpl() | (Inherited from SfcInstance) |
| GetChildCollection(String) |
Get the child collection in this instance for the given element name string. (Inherited from SfcInstance) |
| GetDomain() | (Inherited from SfcInstance) |
| GetObjectFactory() |
Gets the object factory. |
| GetPropertySet() | (Inherited from SfcInstance) |
| GetTypeMetadata() |
Gets Sfc Type Metadata. |
| GetTypeMetadataImpl() | (Inherited from SfcInstance) |
| HasCustomizableField() |
Determines whether the event has at least one field needs to be set. |
| InitializeUIPropertyState() |
Overridable from the child objects who care about initializing their states (dynamic metadata which is currently the ".Enabled" property) (Inherited from SfcInstance) |
| MarkForDropImpl(Boolean) | (Inherited from SfcInstance) |
| MarkRootAsConnected() | (Inherited from SfcInstance) |
| MoveImpl(SfcInstance) | (Inherited from SfcInstance) |
| OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs) | (Inherited from SfcInstance) |
| OnPropertyValueChanges(PropertyChangedEventArgs) | (Inherited from SfcInstance) |
| PostAlter(Object) | (Inherited from SfcInstance) |
| PostCreate(Object) | (Inherited from SfcInstance) |
| PostDrop(Object) | (Inherited from SfcInstance) |
| PostMove(Object) | (Inherited from SfcInstance) |
| PostRename(Object) | (Inherited from SfcInstance) |
| Refresh() |
refreshes the object's properties by reading them from the server (Inherited from SfcInstance) |
| RemoveAction(Action) |
Removes the action from the session. |
| RenameImpl(SfcKey) | (Inherited from SfcInstance) |
| ResetKey() | (Inherited from SfcInstance) |
| Serialize(XmlWriter) | (Inherited from SfcInstance) |
| SetEventInfo(EventInfo) |
Set the EventInfo for a pending Event. |
| ToString() | (Inherited from SfcInstance) |
| UpdateUIPropertyState() | (Inherited from SfcInstance) |
| Validate() |
Basic child object's validation (Inherited from SfcInstance) |
Events
| propertyChanged | (Inherited from SfcInstance) |
| PropertyChanged | (Inherited from SfcInstance) |
| propertyMetadataChanged | (Inherited from SfcInstance) |
| PropertyMetadataChanged | (Inherited from SfcInstance) |
Explicit Interface Implementations
| ISessionObject.GetCreateScript() |
Generate the script for add an event. Used in Create Session. |
| ISessionObject.GetDropScript() |
Generating the script for drop the event. Used in Alter Session. |
| ISessionObject.IsDirty() | |
| ISfcDiscoverObject.Discover(ISfcDependencyDiscoveryObjectSink) | |