EventCollection Class

  • Reference

Definition

Namespace:
Microsoft.SqlServer.Management.XEvent
Assembly:
Microsoft.SqlServer.Management.XEvent.dll
Package:
Microsoft.SqlServer.SqlManagementObjects v150.18208.0
Package:
Microsoft.SqlServer.SqlManagementObjects v160.2004021.0

SFC Collection class for Event.

public sealed class EventCollection : Microsoft.SqlServer.Management.Sdk.Sfc.SfcCollatedDictionaryCollection<Microsoft.SqlServer.Management.XEvent.Event,Microsoft.SqlServer.Management.XEvent.Event.Key,Microsoft.SqlServer.Management.XEvent.Session>
type EventCollection = class
    inherit SfcCollatedDictionaryCollection<Event, Event.Key, Session>
Public NotInheritable Class EventCollection
Inherits SfcCollatedDictionaryCollection(Of Event, Event.Key, Session)
Inheritance
Object
SfcCollection<T,K,ParentT>
SfcCollatedDictionaryCollection<Event,Event.Key,Session>
EventCollection

Properties

Ascending

Sort in an ascending order manner for the current collection culture.

(Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
Count (Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
CultureInfo

Sorting the collection will use this .NET culture info.

(Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
IgnoreCase

Sort in a case-insensitive manner for the current collection culture.

(Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
Initialized (Inherited from SfcCollection<T,K,ParentT>)
IsReadOnly (Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
IsSynchronized (Inherited from SfcCollection<T,K,ParentT>)
Item[K] (Inherited from SfcCollection<T,K,ParentT>)
Item[String]

Gets the Event with the specified name.
Parent (Inherited from SfcCollection<T,K,ParentT>)
SyncRoot (Inherited from SfcCollection<T,K,ParentT>)

Methods

Add(T)

Adds the obj to the collection

(Inherited from SfcCollection<T,K,ParentT>)
AddImpl(T) (Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
AddShadow(T) (Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
AppendAlterScripts(StringBuilder, StringBuilder)

Check the current state of the events and return the script based on it. This should be used only in generating the alter script for session.
Clear() (Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
Contains(K) (Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
Contains(String)

Determines whether the collection contains the Event.
Contains(T) (Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
CopyTo(Array, Int32) (Inherited from SfcCollection<T,K,ParentT>)
CopyTo(T[], Int32) (Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
CreateAndInitializeChildObject(K) (Inherited from SfcCollection<T,K,ParentT>)
EnsureCollectionInitialized() (Inherited from SfcCollection<T,K,ParentT>)
FinishMerge() (Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
GetCollectionElementNameImpl() (Inherited from SfcCollection<T,K,ParentT>)
GetElementFactoryImpl() (Inherited from SfcCollection<T,K,ParentT>)
GetEnumerator() (Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
GetExistingObjectByKey(K) (Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
GetObjectByKey(K) (Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
InitInnerCollection() (Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
PrepareMerge() (Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
Refresh() (Inherited from SfcCollection<T,K,ParentT>)
Refresh(Boolean) (Inherited from SfcCollection<T,K,ParentT>)
Remove(T) (Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
RemoveImpl(T) (Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
RemoveInternal(T)

Remove the item given by the key. Existing object are marked with a state of ToBeDropped for dropping when their parent is Altered or Dropped. At that time the marked object will be removed fro the collection. Pending, None or Dropped objects are removed from the collection immediately.

(Inherited from SfcCollection<T,K,ParentT>)
Rename(T, K) (Inherited from SfcCollection<T,K,ParentT>)
ResetInnerCollection()

Call this if any of the CultureInfo, IgnoreCase, or Ascending properties change after Initialzation. The collection is reset to honor the new settings. TODO: The user is responsible for calling this after changing whatever properties they desire, it should be automated.

(Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
TryGetValue(K, T) (Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)

Explicit Interface Implementations

IComparer<K>.Compare(K, K)

Compare keys based on our current CultureInfo and IgnoreCase properties unless a custom comparer has been passed in.

(Inherited from SfcCollatedDictionaryCollection<T,K,ParentT>)
IEnumerable.GetEnumerator() (Inherited from SfcCollection<T,K,ParentT>)
IListSource.ContainsListCollection (Inherited from SfcCollection<T,K,ParentT>)
IListSource.GetList() (Inherited from SfcCollection<T,K,ParentT>)
ISfcCollection.Add(SfcInstance) (Inherited from SfcCollection<T,K,ParentT>)
ISfcCollection.AddShadow(SfcInstance) (Inherited from SfcCollection<T,K,ParentT>)
ISfcCollection.Count (Inherited from SfcCollection<T,K,ParentT>)
ISfcCollection.EnsureInitialized() (Inherited from SfcCollection<T,K,ParentT>)
ISfcCollection.FinishMerge() (Inherited from SfcCollection<T,K,ParentT>)
ISfcCollection.GetCollectionElementNameImpl() (Inherited from SfcCollection<T,K,ParentT>)
ISfcCollection.GetElementFactory() (Inherited from SfcCollection<T,K,ParentT>)
ISfcCollection.GetExisting(SfcKey, SfcInstance) (Inherited from SfcCollection<T,K,ParentT>)
ISfcCollection.GetObjectByKey(SfcKey) (Inherited from SfcCollection<T,K,ParentT>)
ISfcCollection.Initialized (Inherited from SfcCollection<T,K,ParentT>)
ISfcCollection.Parent (Inherited from SfcCollection<T,K,ParentT>)
ISfcCollection.PrepareMerge() (Inherited from SfcCollection<T,K,ParentT>)
ISfcCollection.Remove(SfcInstance) (Inherited from SfcCollection<T,K,ParentT>)
ISfcCollection.RemoveElement(SfcInstance) (Inherited from SfcCollection<T,K,ParentT>)
ISfcCollection.Rename(SfcInstance, SfcKey) (Inherited from SfcCollection<T,K,ParentT>)

Applies to