RuleSettingsCollection Class
A collection of RuleSettings objects. This class cannot be inherited.
System.Configuration.ConfigurationElement
System.Configuration.ConfigurationElementCollection
System.Web.Configuration.RuleSettingsCollection
Namespace: System.Web.Configuration
Assembly: System.Web (in System.Web.dll)
The RuleSettingsCollection type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | RuleSettingsCollection | Infrastructure. Initializes a new instance of the RuleSettingsCollection class. |
| Name | Description | |
|---|---|---|
![]() | AddElementName | Gets 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.) |
![]() | ClearElementName | Gets 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.) |
![]() | CollectionType | Gets the type of the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.) |
![]() | Count | Gets the number of elements in the collection. (Inherited from ConfigurationElementCollection.) |
![]() | 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.) |
![]() | 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.) |
![]() | EmitClear | Gets or sets a value that specifies whether the collection has been cleared. (Inherited from ConfigurationElementCollection.) |
![]() | IsSynchronized | Gets a value indicating whether access to the collection is synchronized. (Inherited from ConfigurationElementCollection.) |
![]() | Item[ConfigurationProperty] | Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.) |
![]() | Item[Int32] | Gets the RuleSettings object at the specified numeric index. |
![]() | Item[String] | Gets the RuleSettings object based on the specified key in the collection. |
![]() | 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.) |
![]() | Properties | Gets the collection of properties. (Inherited from ConfigurationElement.) |
![]() | RemoveElementName | Gets 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.) |
![]() | SyncRoot | Gets an object used to synchronize access to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.) |
| Name | Description | |
|---|---|---|
![]() | Add | Adds a RuleSettings object to the collection. |
![]() | BaseAdd(ConfigurationElement, Boolean) | Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection.) |
![]() | BaseClear | Removes all configuration element objects from the collection. (Inherited from ConfigurationElementCollection.) |
![]() | BaseGet(Int32) | Gets the configuration element at the specified index location. (Inherited from ConfigurationElementCollection.) |
![]() | BaseGet(Object) | Returns the configuration element with the specified key. (Inherited from ConfigurationElementCollection.) |
![]() | BaseGetAllKeys | Returns an array of the keys for all of the configuration elements contained in the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.) |
![]() | BaseGetKey | Gets the key for the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection.) |
![]() | BaseIsRemoved | Indicates whether the ConfigurationElement with the specified key has been removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.) |
![]() | BaseRemove | Removes a ConfigurationElement from the collection. (Inherited from ConfigurationElementCollection.) |
![]() | BaseRemoveAt | Removes the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection.) |
![]() | Clear | Removes all RuleSettings objects from the collection. |
![]() | Contains | Returns true if the collection contains a RuleSettings object with the specified name. |
![]() | CopyTo | Copies the contents of the ConfigurationElementCollection to an array. (Inherited from ConfigurationElementCollection.) |
![]() | DeserializeElement | Reads XML from the configuration file. (Inherited from ConfigurationElement.) |
![]() | Equals | Compares the ConfigurationElementCollection to the specified object. (Inherited from ConfigurationElementCollection.) |
![]() | GetEnumerator | Infrastructure. Gets an IEnumerator which is used to iterate through the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.) |
![]() | GetHashCode | Gets a unique value representing the ConfigurationElementCollection instance. (Inherited from ConfigurationElementCollection.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | IndexOf | Finds the index of a RuleSettings object in the collection with the specified name. |
![]() | 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.) |
![]() | Insert | Adds the specified RuleSettings object to the specified index point in the collection. |
![]() | IsModified | Indicates whether this ConfigurationElementCollection has been modified since it was last saved or loaded when overridden in a derived class. (Inherited from ConfigurationElementCollection.) |
![]() | IsReadOnly | Indicates whether the ConfigurationElementCollection object is read only. (Inherited from ConfigurationElementCollection.) |
![]() | Remove | Removes a RuleSettings object from the collection. |
![]() | RemoveAt | Removes a RuleSettings object at the specified index location from the collection. |
![]() | Reset | Resets the ConfigurationElementCollection to its unmodified state when overridden in a derived class. (Inherited from ConfigurationElementCollection.) |
![]() | ResetModified | Resets the value of the IsModified property to false when overridden in a derived class. (Inherited from ConfigurationElementCollection.) |
![]() | SerializeElement | Writes the configuration data to an XML element in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection.) |
![]() | SerializeToXmlElement | Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.) |
![]() | SetReadOnly | Infrastructure. Sets the IsReadOnly property for the ConfigurationElementCollection object and for all sub-elements. (Inherited from ConfigurationElementCollection.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | Unmerge | Infrastructure. Reverses the effect of merging configuration information from different levels of the configuration hierarchy (Inherited from ConfigurationElementCollection.) |
| Name | Description | |
|---|---|---|
![]() ![]() | ICollection.CopyTo | Copies the ConfigurationElementCollection to an array. (Inherited from ConfigurationElementCollection.) |
RuleSettings objects are used to define event rules.
The following code example shows how to use the RuleSettingsCollection 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); // Add a RuleSettings object to the Rules collection property. healthMonitoringSection.Rules.Add(new RuleSettings("All Errors Default", "All Errors", "EventLogProvider")); // Add a RuleSettings object to the Rules collection property. healthMonitoringSection.Rules.Add(new RuleSettings("Failure Audits Default", "Failure Audits", "EventLogProvider", "Default", 1, Int32.MaxValue, new TimeSpan(0, 1, 0))); // Add a RuleSettings object to the Rules collection property. healthMonitoringSection.Rules.Add(new RuleSettings("Failure Audits Custom", "Failure Audits", "EventLogProvider", "Custom", 1, Int32.MaxValue, new TimeSpan(0, 1, 0), "MyEvaluators.MyCustomeEvaluator2, MyCustom.dll")); // Insert an RuleSettings object into the Rules collection property. healthMonitoringSection.Rules.Insert(1, new RuleSettings("All Errors Default2", "All Errors", "EventLogProvider")); // 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); } // See if the Rules collection property contains the RuleSettings 'All Errors Default'. Console.WriteLine("EventMappings contains 'All Errors Default': {0}.", healthMonitoringSection.Rules.Contains("All Errors Default")); // Get the index of the 'All Errors Default' RuleSettings in the Rules collection property. Console.WriteLine("EventMappings index for 'All Errors Default': {0}.", healthMonitoringSection.Rules.IndexOf("All Errors Default")); // Get a named RuleSettings ruleSetting = healthMonitoringSection.Rules["All Errors Default"]; // Remove a RuleSettings object from the Rules collection property. healthMonitoringSection.Rules.Remove("All Errors Default"); // Remove a RuleSettings object from the Rules collection property. healthMonitoringSection.Rules.RemoveAt(0); // Clear all RuleSettings object from the Rules collection property. healthMonitoringSection.Rules.Clear();
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.
