Export (0) Print
Expand All

RuleSettings Class

Configures the ASP.NET event rules. This class cannot be inherited.

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

'Declaration
Public NotInheritable Class RuleSettings _
	Inherits ConfigurationElement

The RuleSettings type exposes the following members.

  NameDescription
Public methodRuleSettings(String, String, String)Initializes a new instance of the RuleSettings class using default settings; however, the name, event name, and provider are specified.
Public methodRuleSettings(String, String, String, String, Int32, Int32, TimeSpan)Initializes a new instance of the RuleSettings class where all values except those of the Custom class are specified.
Public methodRuleSettings(String, String, String, String, Int32, Int32, TimeSpan, String)Initializes a new instance of the BufferModeSettings class where all values are specified.
Top

  NameDescription
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 propertyCustomGets or sets the fully qualified type of a custom class that implements IWebEventCustomEvaluator.
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 propertyEventNameGets or sets the name of the EventMappingSettings object this rule applies to.
Protected propertyItem(ConfigurationProperty)Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.)
Protected propertyItem(String)Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.)
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.)
Public propertyMaxLimitGets or sets the maximum number of times events of the same type are raised.
Public propertyMinInstancesGets or sets the minimum number of occurrences of the same type of event before the event is raised to the provider.
Public propertyMinIntervalGets or sets the minimum time interval between two events of the same type.
Public propertyNameGets or sets the name of the RuleSettings object.
Public propertyProfileGets or sets the name of the ProfileSettings object this rule applies to.
Protected propertyPropertiesGets the collection of properties. (Inherited from ConfigurationElement.)
Public propertyProviderGets or sets the name of the ProviderSettings object this rule applies to.
Top

  NameDescription
Protected methodDeserializeElementReads XML from the configuration file. (Inherited from ConfigurationElement.)
Public methodEqualsCompares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement.)
Public methodGetHashCodeGets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement.)
Public methodGetTypeGets the Type of the current instance. (Inherited from 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.)
Protected methodIsModifiedIndicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class. (Inherited from ConfigurationElement.)
Public methodIsReadOnlyGets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement.)
Protected methodResetResets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement.)
Protected methodResetModifiedResets the value of the IsModified method to false when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSerializeElementWrites the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSerializeToXmlElementWrites the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSetReadOnlySets the IsReadOnly property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodUnmergeModifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)
Top

Event rules determine which event, using which profile, is fired to which provider.

The following configuration file excerpt shows how to declaratively specify the properties of the RuleSettings class.

<healthMonitoring>
    <rules>
        <add name="All Errors Default"
            eventName="All Errors"
            provider="EventLogProvider"
            profile="Default"
            minInterval="00:01:00" 
        />
        <add name="All Audits Default"
            eventName="All Audits"
            provider="SqlWebEventProvider"
            profile="Default"
            minInterval="00:00:30" 
        />
        <add name="Failure Audits Default"
            eventName="Failure Audits"
            provider="WmiWebEventProvider"
            profile="Critical"
            minInterval="00:00:30" 
        />
        <add name="Request Processing Errors"
            eventName="Request Processing Errors"
            provider="CriticalMailEventProvider"
            profile="Default"
        />
        <add name="Infrastructure Notifications"
            eventName="Infrastructure Errors"
            provider="CriticalMailEventProvider"
            profile="Critical"
        />
   </rules>
</healthMonitoring>

The following code example shows how to create and set the values of the RuleSettings type. This code example is part of a larger example provided for the HealthMonitoringSection class.

' Add a RuleSettings object to the Rules collection property. 
Dim ruleSetting As RuleSettings = new RuleSettings("All Errors Default", _
    "All Errors", "EventLogProvider")
ruleSetting.Name = "All Errors Custom"
ruleSetting.EventName = "All Errors"
ruleSetting.Provider = "EventLogProvider"
ruleSetting.Profile = "Custom"
ruleSetting.MaxLimit = Int32.MaxValue
ruleSetting.MinInstances = 1
ruleSetting.MinInterval = TimeSpan.Parse("00:00:30")
ruleSetting.Custom = "MyEvaluators.MyCustomeEvaluator2, MyCustom.dll"
healthMonitoringSection.Rules.Add(ruleSetting)

The following code example shows how to get and display the values of the RuleSettings type. This code example is part of a larger example provided for the HealthMonitoringSection class.

' Display contents of the Rules collection property
Console.WriteLine( _
    "Rules Collection contains {0} values:", healthMonitoringSection.Rules.Count)

' Display all elements. 
For i As System.Int32 = 0 To healthMonitoringSection.Rules.Count -1
ruleSetting = healthMonitoringSection.Rules(i)
Dim name As String = ruleSetting.Name
Dim eventName As String = ruleSetting.EventName
Dim provider As String = ruleSetting.Provider
Dim profile As String = ruleSetting.Profile
Dim minInstances As Integer = ruleSetting.MinInstances
Dim maxLimit As Integer = ruleSetting.MaxLimit
Dim minInterval As TimeSpan = ruleSetting.MinInterval
Dim custom As String = ruleSetting.Custom
    Dim item As String = "Name='" & name & "', EventName='" & eventName & _
        "', Provider =  '" & provider & "', Profile =  '" & profile & _
        "', MinInstances =  '" & minInstances & "', MaxLimit =  '" & maxLimit & _
        "', MinInterval =  '" & minInterval.ToString() & "', Custom =  '" & custom & "'"
    Console.WriteLine("  Item {0}: {1}", i, item)
Next

.NET Framework

Supported in: 4.5.2, 4.5.1, 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