Export (0) Print
Expand All

EventMappingSettingsCollection Class

Provides a collection of EventMappingSettings objects. This class cannot be inherited.

Namespace:  System.Web.Configuration
Assembly:  System.Web (in System.Web.dll)

[ConfigurationCollectionAttribute(typeof(EventMappingSettings))]
public sealed class EventMappingSettingsCollection : ConfigurationElementCollection

The EventMappingSettingsCollection type exposes the following members.

  NameDescription
Public methodEventMappingSettingsCollectionInfrastructure. Initializes a new instance of the EventMappingSettingsCollection class.
Top

  NameDescription
Protected propertyAddElementNameGets or sets the name of the ConfigurationElement to associate with the add operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected propertyClearElementNameGets or sets the name for the ConfigurationElement to associate with the clear operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Public propertyCollectionTypeGets the type of the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Public propertyCountGets the number of elements in the collection. (Inherited from ConfigurationElementCollection.)
Public propertyCurrentConfigurationGets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.)
Public propertyElementInformationGets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected propertyElementPropertyGets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.)
Public propertyEmitClearGets or sets a value that specifies whether the collection has been cleared. (Inherited from ConfigurationElementCollection.)
Public propertyIsSynchronizedGets a value indicating whether access to the collection is synchronized. (Inherited from ConfigurationElementCollection.)
Protected propertyItem[ConfigurationProperty]Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.)
Public propertyItem[Int32]Gets or sets the EventMappingSettings object at the specified index location.
Public propertyItem[String]Gets the EventMappingSettings object based on the specified key in the collection.
Public propertyLockAllAttributesExceptGets the collection of locked attributes. (Inherited from ConfigurationElement.)
Public propertyLockAllElementsExceptGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockAttributesGets the collection of locked attributes (Inherited from ConfigurationElement.)
Public propertyLockElementsGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockItemGets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.)
Protected propertyPropertiesGets the collection of properties. (Inherited from ConfigurationElement.)
Protected propertyRemoveElementNameGets or sets the name of the ConfigurationElement to associate with the remove operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Public propertySyncRootGets an object used to synchronize access to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Top

  NameDescription
Public methodAddAdds an EventMappingSettings object to the collection.
Protected methodBaseAdd(ConfigurationElement, Boolean)Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseClearRemoves all configuration element objects from the collection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseGet(Int32)Gets the configuration element at the specified index location. (Inherited from ConfigurationElementCollection.)
Protected methodBaseGet(Object)Returns the configuration element with the specified key. (Inherited from ConfigurationElementCollection.)
Protected methodBaseGetAllKeysReturns an array of the keys for all of the configuration elements contained in the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseGetKeyGets the key for the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection.)
Protected methodBaseIsRemovedIndicates whether the ConfigurationElement with the specified key has been removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseRemoveRemoves a ConfigurationElement from the collection. (Inherited from ConfigurationElementCollection.)
Protected methodBaseRemoveAtRemoves the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection.)
Public methodClearRemoves all EventMappingSettings objects from the collection.
Public methodContainsIndicates whether the collection contains an EventMappingSettings object with the specified name.
Public methodCopyToCopies the contents of the ConfigurationElementCollection to an array. (Inherited from ConfigurationElementCollection.)
Protected methodDeserializeElementReads XML from the configuration file. (Inherited from ConfigurationElement.)
Public methodEqualsCompares the ConfigurationElementCollection to the specified object. (Inherited from ConfigurationElementCollection.)
Public methodGetEnumeratorInfrastructure. Gets an IEnumerator which is used to iterate through the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Public methodGetHashCodeGets a unique value representing the ConfigurationElementCollection instance. (Inherited from ConfigurationElementCollection.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfReturns the index of the specified EventMappingSettings object.
Protected methodInitSets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.)
Protected methodInitializeDefaultUsed to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Public methodInsertAdds the specified EventMappingSettings object to the specified index point in the collection.
Protected methodIsModifiedIndicates whether this ConfigurationElementCollection has been modified since it was last saved or loaded when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Public methodIsReadOnlyIndicates whether the ConfigurationElementCollection object is read only. (Inherited from ConfigurationElementCollection.)
Public methodRemoveRemoves an EventMappingSettings object from the collection.
Public methodRemoveAtRemoves an EventMappingSettings object from the collection.
Protected methodResetResets the ConfigurationElementCollection to its unmodified state when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected methodResetModifiedResets the value of the IsModified property to false when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected methodSerializeElementWrites the configuration data to an XML element in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected methodSerializeToXmlElementWrites the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSetReadOnlyInfrastructure. Sets the IsReadOnly property for the ConfigurationElementCollection object and for all sub-elements. (Inherited from ConfigurationElementCollection.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodUnmergeInfrastructure. Reverses the effect of merging configuration information from different levels of the configuration hierarchy (Inherited from ConfigurationElementCollection.)
Top

The EventMappingSettings class corresponds to the eventMappings configuration file element. The eventMappings element allows you to assign friendly names to event sources. These names are then used to associate event sources with the related event consumers, called providers, in the rules subsection of the healthMonitoring section of the configuration file.

The following code example shows how to use the EventMappingSettingsCollection type. This code example is part of a larger example provided for the HealthMonitoringSection class.


// Add a EventMappingsSettings object to the EventMappings collection property.
EventMappingSettings eventMappingSetting = new EventMappingSettings(
    "Failure Audits", "System.Web.Management.WebAuditEvent, System.Web");
eventMappingSetting.Name = "All Errors";
eventMappingSetting.Type = 
    "System.Web.Management.WebErrorEvent, System.Web";
eventMappingSetting.StartEventCode = 0;
eventMappingSetting.EndEventCode = 4096;
healthMonitoringSection.EventMappings.Add(eventMappingSetting);

// Add an EventMappingsSettings object to the EventMappings collection property.
healthMonitoringSection.EventMappings.Add(new EventMappingSettings(
    "Failure Audits", "System.Web.Management.WebAuditEvent, System.Web"));

// Add an EventMappingsSettings object to the EventMappings collection property.
healthMonitoringSection.EventMappings.Add(new EventMappingSettings(
    "Success Audits", "System.Web.Management.WebAuditEvent, System.Web",
    512, Int32.MaxValue));

// Insert an EventMappingsSettings object into the EventMappings collection property.
healthMonitoringSection.EventMappings.Insert(1, 
    new EventMappingSettings("HeartBeats", "", 1, 2));

// Display contents of the EventMappings collection property
Console.WriteLine(
    "EventMappings Collection contains {0} values:", healthMonitoringSection.EventMappings.Count);

// Display all elements. 
for (System.Int32 i = 0; i < healthMonitoringSection.EventMappings.Count; i++)
{
eventMappingSetting = healthMonitoringSection.EventMappings[i];
string name = eventMappingSetting.Name;
string type = eventMappingSetting.Type;
int startCd = eventMappingSetting.StartEventCode;
int endCd = eventMappingSetting.EndEventCode;
    string item = "Name='" + name + "', Type='" + type +
        "', StartEventCode =  '" + startCd.ToString() +
        "', EndEventCode =  '" + endCd.ToString() + "'";
    Console.WriteLine("  Item {0}: {1}", i, item);
}

// See if the EventMappings collection property contains the event 'HeartBeats'.
Console.WriteLine("EventMappings contains 'HeartBeats': {0}.",
    healthMonitoringSection.EventMappings.Contains("HeartBeats"));

// Get the index of the 'HeartBeats' event in the EventMappings collection property.
Console.WriteLine("EventMappings index for 'HeartBeats': {0}.",
    healthMonitoringSection.EventMappings.IndexOf("HeartBeats"));

// Get a named EventMappings
eventMappingSetting = healthMonitoringSection.EventMappings["HeartBeats"];

// Remove an EventMappingsSettings object from the EventMappings collection property.
healthMonitoringSection.EventMappings.Remove("HeartBeats");

// Remove an EventMappingsSettings object from the EventMappings collection property.
healthMonitoringSection.EventMappings.RemoveAt(0);

// Clear all EventMappingsSettings object from the EventMappings collection property.
healthMonitoringSection.EventMappings.Clear();

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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