RuleSettings Class
Configures the ASP.NET event rules. This class cannot be inherited.
Namespace: System.Web.Configuration
Assembly: System.Web (in System.Web.dll)
The RuleSettings type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | RuleSettings(String, String, String) | Initializes a new instance of the RuleSettings class using default settings; however, the name, event name, and provider are specified. |
![]() | RuleSettings(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. |
![]() | RuleSettings(String, String, String, String, Int32, Int32, TimeSpan, String) | Initializes a new instance of the BufferModeSettings class where all values are specified. |
| Name | Description | |
|---|---|---|
![]() | CurrentConfiguration | Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.) |
![]() | Custom | Gets or sets the fully qualified type of a custom class that implements IWebEventCustomEvaluator. |
![]() | ElementInformation | Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.) |
![]() | ElementProperty | Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.) |
![]() | EventName | Gets or sets the name of the EventMappingSettings object this rule applies to. |
![]() | Item[ConfigurationProperty] | Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.) |
![]() | Item[String] | Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.) |
![]() | LockAllAttributesExcept | Gets the collection of locked attributes. (Inherited from ConfigurationElement.) |
![]() | LockAllElementsExcept | Gets the collection of locked elements. (Inherited from ConfigurationElement.) |
![]() | LockAttributes | Gets the collection of locked attributes (Inherited from ConfigurationElement.) |
![]() | LockElements | Gets the collection of locked elements. (Inherited from ConfigurationElement.) |
![]() | LockItem | Gets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.) |
![]() | MaxLimit | Gets or sets the maximum number of times events of the same type are raised. |
![]() | MinInstances | Gets or sets the minimum number of occurrences of the same type of event before the event is raised to the provider. |
![]() | MinInterval | Gets or sets the minimum time interval between two events of the same type. |
![]() | Name | Gets or sets the name of the RuleSettings object. |
![]() | Profile | Gets or sets the name of the ProfileSettings object this rule applies to. |
![]() | Properties | Gets the collection of properties. (Inherited from ConfigurationElement.) |
![]() | Provider | Gets or sets the name of the ProviderSettings object this rule applies to. |
| Name | Description | |
|---|---|---|
![]() | DeserializeElement | Reads XML from the configuration file. (Inherited from ConfigurationElement.) |
![]() | Equals | Compares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement.) |
![]() | GetHashCode | Gets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | Init | Sets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.) |
![]() | InitializeDefault | Used to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.) |
![]() | IsModified | Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class. (Inherited from ConfigurationElement.) |
![]() | IsReadOnly | Gets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement.) |
![]() | Reset | Resets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement.) |
![]() | ResetModified | Resets the value of the IsModified method to false when implemented in a derived class. (Inherited from ConfigurationElement.) |
![]() | SerializeElement | Writes the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.) |
![]() | SerializeToXmlElement | Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.) |
![]() | SetReadOnly | Sets the IsReadOnly property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | Unmerge | Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.) |
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. RuleSettings ruleSetting = 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 (System.Int32 i = 0; i < healthMonitoringSection.Rules.Count; i++) { ruleSetting = healthMonitoringSection.Rules[i]; string name = ruleSetting.Name; string eventName = ruleSetting.EventName; string provider = ruleSetting.Provider; string profile = ruleSetting.Profile; int minInstances = ruleSetting.MinInstances; int maxLimit = ruleSetting.MaxLimit; TimeSpan minInterval = ruleSetting.MinInterval; string custom = ruleSetting.Custom; string item = "Name='" + name + "', EventName='" + eventName + "', Provider = '" + provider + "', Profile = '" + profile + "', MinInstances = '" + minInstances + "', MaxLimit = '" + maxLimit + "', MinInterval = '" + minInterval + "', Custom = '" + custom + "'"; Console.WriteLine(" Item {0}: {1}", i, item); }
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.
