NameValueConfigurationCollection 类
定义
包含 NameValueConfigurationElement 对象的集合。Contains a collection of NameValueConfigurationElement objects. 此类不能被继承。This class cannot be inherited.
public ref class NameValueConfigurationCollection sealed : System::Configuration::ConfigurationElementCollection
[System.Configuration.ConfigurationCollection(typeof(System.Configuration.NameValueConfigurationElement))]
public sealed class NameValueConfigurationCollection : System.Configuration.ConfigurationElementCollection
public sealed class NameValueConfigurationCollection : System.Configuration.ConfigurationElementCollection
[System.Configuration.ConfigurationCollection(typeof(System.Configuration.NameValueConfigurationElement), AddItemName="add", ClearItemsName="clear", CollectionType=System.Configuration.ConfigurationElementCollectionType.AddRemoveClearMap, RemoveItemName="remove")]
public sealed class NameValueConfigurationCollection : System.Configuration.ConfigurationElementCollection
[<System.Configuration.ConfigurationCollection(typeof(System.Configuration.NameValueConfigurationElement))>]
type NameValueConfigurationCollection = class
inherit ConfigurationElementCollection
type NameValueConfigurationCollection = class
inherit ConfigurationElementCollection
[<System.Configuration.ConfigurationCollection(typeof(System.Configuration.NameValueConfigurationElement), AddItemName="add", ClearItemsName="clear", CollectionType=System.Configuration.ConfigurationElementCollectionType.AddRemoveClearMap, RemoveItemName="remove")>]
type NameValueConfigurationCollection = class
inherit ConfigurationElementCollection
Public NotInheritable Class NameValueConfigurationCollection
Inherits ConfigurationElementCollection
- 继承
- 属性
示例
下面的代码示例演示如何使用 NameValueConfigurationCollection 类型。The following code example demonstrates how to use the NameValueConfigurationCollection type.
#region Using directives
using System;
using System.Configuration;
using System.Web.Configuration;
using System.Collections;
using System.Text;
#endregion
namespace Samples.AspNet
{
class UsingNameValueConfigurationCollection
{
static void Main(string[] args)
{
try
{
// Set the path of the config file.
// Make sure that you have a Web site on the
// same server called TestConfig.
string configPath = "/TestConfig";
// Get the Web application configuration object.
Configuration config =
WebConfigurationManager.OpenWebConfiguration(configPath);
// Get the section related object.
AnonymousIdentificationSection configSection =
(AnonymousIdentificationSection)config.GetSection
("system.web/anonymousIdentification");
// Display title and info.
Console.WriteLine("Configuration Info");
Console.WriteLine();
// Display Config details.
Console.WriteLine("File Path: {0}",
config.FilePath);
Console.WriteLine("Section Path: {0}",
configSection.SectionInformation.Name);
Console.WriteLine();
// Create a NameValueConfigurationCollection object.
NameValueConfigurationCollection myNameValConfigCollection =
new NameValueConfigurationCollection();
foreach (PropertyInformation propertyItem in
configSection.ElementInformation.Properties)
{
// Assign domain name.
if (propertyItem.Name == "domain")
propertyItem.Value = "MyDomain";
if (propertyItem.Value != null)
{
// Enable SSL for cookie exchange.
if (propertyItem.Name == "cookieRequireSSL")
propertyItem.Value = true;
NameValueConfigurationElement nameValConfigElement =
new NameValueConfigurationElement
(propertyItem.Name.ToString(), propertyItem.Value.ToString());
// Add a NameValueConfigurationElement
// to the collection.
myNameValConfigCollection.Add(nameValConfigElement);
}
}
// Count property.
Console.WriteLine("Collection Count: {0}",
myNameValConfigCollection.Count);
// Item property.
Console.WriteLine("Value of property 'enabled': {0}",
myNameValConfigCollection["enabled"].Value);
// Display the contents of the collection.
foreach (NameValueConfigurationElement configItem
in myNameValConfigCollection)
{
Console.WriteLine();
Console.WriteLine("Configuration Details:");
Console.WriteLine("Name: {0}", configItem.Name);
Console.WriteLine("Value: {0}", configItem.Value);
}
// Assign the domain calue.
configSection.Domain = myNameValConfigCollection["domain"].Value;
// Assign the SSL required value.
if (myNameValConfigCollection["cookieRequireSSL"].Value == "true")
configSection.CookieRequireSSL = true;
// Remove domain from the collection.
NameValueConfigurationElement myConfigElement =
myNameValConfigCollection["domain"];
// Remove method.
myNameValConfigCollection.Remove(myConfigElement);
// Save changes to the configuration file.
// This modifies the Web.config of the TestConfig site.
config.Save(ConfigurationSaveMode.Minimal, true);
// Clear the collection.
myNameValConfigCollection.Clear();
}
catch (Exception e)
{
// Unknown error.
Console.WriteLine(e.ToString());
}
// Display and wait.
Console.ReadLine();
}
}
}
Imports System.Configuration
Imports System.Web
Imports System.Collections
Imports System.Text
Namespace Samples.AspNet
Class UsingNameValueConfigurationCollection
Public Shared Sub Main(ByVal args As String())
Try
' Set the path of the config file.
' Make sure that you have a Web site on the
' same server called TestConfig.
Dim configPath As String = "/TestConfig"
' Get the Web application configuration object.
Dim config As Configuration = _
System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration(configPath)
' Get the section related object.
Dim configSection _
As System.Web.Configuration.AnonymousIdentificationSection = _
DirectCast(config.GetSection("system.web/anonymousIdentification"), _
System.Web.Configuration.AnonymousIdentificationSection)
' Display title and info.
Console.WriteLine("Configuration Info")
Console.WriteLine()
' Display Config details.
Console.WriteLine("File Path: {0}", config.FilePath)
Console.WriteLine("Section Path: {0}", configSection.SectionInformation.Name)
Console.WriteLine()
' Create a NameValueConfigurationCollection object.
Dim myNameValConfigCollection As New NameValueConfigurationCollection()
For Each propertyItem As PropertyInformation In configSection.ElementInformation.Properties
' Assign domain name.
If propertyItem.Name = "domain" Then
propertyItem.Value = "MyDomain"
End If
If propertyItem.Value <> Nothing Then
' Enable SSL for cookie exchange.
If propertyItem.Name = "cookieRequireSSL" Then
propertyItem.Value = True
End If
Dim nameValConfigElement As New NameValueConfigurationElement(propertyItem.Name.ToString(), propertyItem.Value.ToString())
' Add a NameValueConfigurationElement
' to the collection.
myNameValConfigCollection.Add(nameValConfigElement)
End If
Next
' Count property.
Console.WriteLine("Collection Count: {0}", myNameValConfigCollection.Count)
' Item property.
Console.WriteLine("Value of property 'enabled': {0}", myNameValConfigCollection("enabled").Value)
' Display the contents of the collection.
For Each configItem As NameValueConfigurationElement In myNameValConfigCollection
Console.WriteLine()
Console.WriteLine("Configuration Details:")
Console.WriteLine("Name: {0}", configItem.Name)
Console.WriteLine("Value: {0}", configItem.Value)
Next
' Assign the domain calue.
configSection.Domain = myNameValConfigCollection("domain").Value
' Assign the SSL required value.
If myNameValConfigCollection("cookieRequireSSL").Value = "true" Then
configSection.CookieRequireSSL = True
End If
' Remove domain from the collection.
Dim myConfigElement As NameValueConfigurationElement = myNameValConfigCollection("domain")
' Remove method.
myNameValConfigCollection.Remove(myConfigElement)
' Save changes to the configuration file.
' This modifies the Web.config of the TestConfig site.
config.Save(ConfigurationSaveMode.Minimal, True)
' Clear the collection.
myNameValConfigCollection.Clear()
Catch e As Exception
' Unknown error.
Console.WriteLine(e.ToString())
End Try
' Display and wait.
Console.ReadLine()
End Sub
End Class
End Namespace
注解
NameValueConfigurationCollection类允许以编程方式访问对象的集合 NameValueConfigurationElement 。The NameValueConfigurationCollection class allows you to programmatically access a collection of NameValueConfigurationElement objects.
构造函数
| NameValueConfigurationCollection() |
初始化 NameValueConfigurationCollection 类的新实例。Initializes a new instance of the NameValueConfigurationCollection class. |
属性
| AddElementName |
在派生的类中重写时,获取或设置 ConfigurationElement 的名称,以便在 ConfigurationElementCollection 中与添加操作关联。Gets or sets the name of the ConfigurationElement to associate with the add operation in the ConfigurationElementCollection when overridden in a derived class. (继承自 ConfigurationElementCollection) |
| AllKeys |
获取 NameValueConfigurationCollection 中包含的所有项的键。Gets the keys to all items contained in the NameValueConfigurationCollection. |
| ClearElementName |
在派生的类中重写时,获取或设置 ConfigurationElement 的名称,以便在 ConfigurationElementCollection 中与清除操作关联。Gets or sets the name for the ConfigurationElement to associate with the clear operation in the ConfigurationElementCollection when overridden in a derived class. (继承自 ConfigurationElementCollection) |
| CollectionType |
获取 ConfigurationElementCollection 的类型。Gets the type of the ConfigurationElementCollection. (继承自 ConfigurationElementCollection) |
| Count |
获取集合中的元素数。Gets the number of elements in the collection. (继承自 ConfigurationElementCollection) |
| CurrentConfiguration |
获取对顶级 Configuration 实例的引用,该实例表示当前 ConfigurationElement 实例所属的配置层次结构。Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (继承自 ConfigurationElement) |
| ElementInformation |
获取包含 ConfigurationElement 对象的不可自定义的信息和功能的 ElementInformation 对象。Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (继承自 ConfigurationElement) |
| ElementName |
获取在派生的类中重写时用于标识配置文件中此元素集合的名称。Gets the name used to identify this collection of elements in the configuration file when overridden in a derived class. (继承自 ConfigurationElementCollection) |
| ElementProperty |
获取表示 ConfigurationElement 对象本身的 ConfigurationElementProperty 对象。Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (继承自 ConfigurationElement) |
| EmitClear |
获取或设置一个值,该值指定是否已清除集合。Gets or sets a value that specifies whether the collection has been cleared. (继承自 ConfigurationElementCollection) |
| EvaluationContext |
获取 ConfigurationElement 对象的 ContextInformation 对象。Gets the ContextInformation object for the ConfigurationElement object. (继承自 ConfigurationElement) |
| HasContext |
获取一个值,该值指示 CurrentConfiguration 属性是否为 |
| IsSynchronized |
获取一个值,该值指示是否同步对集合的访问。Gets a value indicating whether access to the collection is synchronized. (继承自 ConfigurationElementCollection) |
| Item[ConfigurationProperty] |
获取或设置此配置元素的属性或特性。Gets or sets a property or attribute of this configuration element. (继承自 ConfigurationElement) |
| Item[String] |
基于所提供的参数,获取或设置 NameValueConfigurationElement 对象。Gets or sets the NameValueConfigurationElement object based on the supplied parameter. |
| LockAllAttributesExcept |
获取被锁定的特性的集合。Gets the collection of locked attributes. (继承自 ConfigurationElement) |
| LockAllElementsExcept |
获取被锁定的元素的集合。Gets the collection of locked elements. (继承自 ConfigurationElement) |
| LockAttributes |
获取被锁定的特性的集合。Gets the collection of locked attributes. (继承自 ConfigurationElement) |
| LockElements |
获取被锁定的元素的集合。Gets the collection of locked elements. (继承自 ConfigurationElement) |
| LockItem |
获取或设置一个值,该值指示是否已锁定该元素。Gets or sets a value indicating whether the element is locked. (继承自 ConfigurationElement) |
| Properties |
获取属性的集合。Gets the collection of properties. (继承自 ConfigurationElement) |
| RemoveElementName |
在派生的类中重写时,获取或设置 ConfigurationElement 的名称,以便在 ConfigurationElementCollection 中与移除操作关联。Gets or sets the name of the ConfigurationElement to associate with the remove operation in the ConfigurationElementCollection when overridden in a derived class. (继承自 ConfigurationElementCollection) |
| SyncRoot |
获取用于同步对 ConfigurationElementCollection 的访问的对象。Gets an object used to synchronize access to the ConfigurationElementCollection. (继承自 ConfigurationElementCollection) |
| ThrowOnDuplicate |
获取一个值,该值指示尝试向 ConfigurationElement 添加重复的 ConfigurationElementCollection 是否会导致引发异常。Gets a value indicating whether an attempt to add a duplicate ConfigurationElement to the ConfigurationElementCollection will cause an exception to be thrown. (继承自 ConfigurationElementCollection) |
方法
| Add(NameValueConfigurationElement) |
将 NameValueConfigurationElement 对象添加到集合中。Adds a NameValueConfigurationElement object to the collection. |
| BaseAdd(ConfigurationElement) |
向 ConfigurationElementCollection 添加配置元素。Adds a configuration element to the ConfigurationElementCollection. (继承自 ConfigurationElementCollection) |
| BaseAdd(ConfigurationElement, Boolean) |
向配置元素集合添加配置元素。Adds a configuration element to the configuration element collection. (继承自 ConfigurationElementCollection) |
| BaseAdd(Int32, ConfigurationElement) |
向配置元素集合添加配置元素。Adds a configuration element to the configuration element collection. (继承自 ConfigurationElementCollection) |
| BaseClear() |
从集合中移除所有配置元素对象。Removes all configuration element objects from the collection. (继承自 ConfigurationElementCollection) |
| BaseGet(Int32) |
获取位于指定索引位置的配置元素。Gets the configuration element at the specified index location. (继承自 ConfigurationElementCollection) |
| BaseGet(Object) |
返回具有指定键的配置元素。Returns the configuration element with the specified key. (继承自 ConfigurationElementCollection) |
| BaseGetAllKeys() |
返回 ConfigurationElementCollection 中包含的所有配置元素的键数组。Returns an array of the keys for all of the configuration elements contained in the ConfigurationElementCollection. (继承自 ConfigurationElementCollection) |
| BaseGetKey(Int32) |
获取位于指定索引位置的 ConfigurationElement 的键。Gets the key for the ConfigurationElement at the specified index location. (继承自 ConfigurationElementCollection) |
| BaseIndexOf(ConfigurationElement) |
获取指定的 ConfigurationElement 的索引。Indicates the index of the specified ConfigurationElement. (继承自 ConfigurationElementCollection) |
| BaseIsRemoved(Object) |
指示是否已从 ConfigurationElement 中移除具有指定键的 ConfigurationElementCollection。Indicates whether the ConfigurationElement with the specified key has been removed from the ConfigurationElementCollection. (继承自 ConfigurationElementCollection) |
| BaseRemove(Object) |
从集合中删除 ConfigurationElement 对象。Removes a ConfigurationElement from the collection. (继承自 ConfigurationElementCollection) |
| BaseRemoveAt(Int32) |
移除位于指定索引位置的 ConfigurationElement。Removes the ConfigurationElement at the specified index location. (继承自 ConfigurationElementCollection) |
| Clear() |
清除 NameValueConfigurationCollection。Clears the NameValueConfigurationCollection. |
| CopyTo(ConfigurationElement[], Int32) |
将 ConfigurationElementCollection 的内容复制到数组。Copies the contents of the ConfigurationElementCollection to an array. (继承自 ConfigurationElementCollection) |
| CreateNewElement() |
在派生的类中重写时,创建一个新的 ConfigurationElement。When overridden in a derived class, creates a new ConfigurationElement. (继承自 ConfigurationElementCollection) |
| CreateNewElement(String) |
在派生的类中重写时,创建新的 ConfigurationElement。Creates a new ConfigurationElement when overridden in a derived class. (继承自 ConfigurationElementCollection) |
| DeserializeElement(XmlReader, Boolean) |
从配置文件读取 XML。Reads XML from the configuration file. (继承自 ConfigurationElement) |
| Equals(Object) |
将 ConfigurationElementCollection 与指定的对象进行比较。Compares the ConfigurationElementCollection to the specified object. (继承自 ConfigurationElementCollection) |
| GetElementKey(ConfigurationElement) |
在派生类中重写时获取指定配置元素的元素键。Gets the element key for a specified configuration element when overridden in a derived class. (继承自 ConfigurationElementCollection) |
| GetEnumerator() |
获取用于循环访问 IEnumerator 的 ConfigurationElementCollection。Gets an IEnumerator which is used to iterate through the ConfigurationElementCollection. (继承自 ConfigurationElementCollection) |
| GetHashCode() |
获取表示 ConfigurationElementCollection 实例的唯一值。Gets a unique value representing the ConfigurationElementCollection instance. (继承自 ConfigurationElementCollection) |
| GetTransformedAssemblyString(String) |
返回指定程序集名称的转换版本。Returns the transformed version of the specified assembly name. (继承自 ConfigurationElement) |
| GetTransformedTypeString(String) |
返回指定类型名称的转换版本。Returns the transformed version of the specified type name. (继承自 ConfigurationElement) |
| GetType() |
获取当前实例的 Type。Gets the Type of the current instance. (继承自 Object) |
| Init() |
将 ConfigurationElement 对象设置为其初始状态。Sets the ConfigurationElement object to its initial state. (继承自 ConfigurationElement) |
| InitializeDefault() |
用于初始化 ConfigurationElement 对象的默认值集。Used to initialize a default set of values for the ConfigurationElement object. (继承自 ConfigurationElement) |
| IsElementName(String) |
指示指定的 ConfigurationElement 是否存在于 ConfigurationElementCollection 中。Indicates whether the specified ConfigurationElement exists in the ConfigurationElementCollection. (继承自 ConfigurationElementCollection) |
| IsElementRemovable(ConfigurationElement) |
指示是否可从 ConfigurationElement 中移除指定 ConfigurationElementCollection。Indicates whether the specified ConfigurationElement can be removed from the ConfigurationElementCollection. (继承自 ConfigurationElementCollection) |
| IsModified() |
在派生的类中重写时,指示从最后一次保存或加载此 ConfigurationElementCollection 后是否对其进行了修改。Indicates whether this ConfigurationElementCollection has been modified since it was last saved or loaded when overridden in a derived class. (继承自 ConfigurationElementCollection) |
| IsReadOnly() |
指示 ConfigurationElementCollection 对象是否为只读的。Indicates whether the ConfigurationElementCollection object is read only. (继承自 ConfigurationElementCollection) |
| ListErrors(IList) |
将此 ConfigurationElement 对象以及所有子元素中无效属性的错误添加到传递的列表中。Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (继承自 ConfigurationElement) |
| MemberwiseClone() |
创建当前 Object 的浅表副本。Creates a shallow copy of the current Object. (继承自 Object) |
| OnDeserializeUnrecognizedAttribute(String, String) |
获取一个值,该值指示反序列化过程中是否遇到未知特性。Gets a value indicating whether an unknown attribute is encountered during deserialization. (继承自 ConfigurationElement) |
| OnDeserializeUnrecognizedElement(String, XmlReader) |
导致配置系统引发异常。Causes the configuration system to throw an exception. (继承自 ConfigurationElementCollection) |
| OnRequiredPropertyNotFound(String) |
找不到所需属性时引发异常。Throws an exception when a required property is not found. (继承自 ConfigurationElement) |
| PostDeserialize() |
反序列化后调用。Called after deserialization. (继承自 ConfigurationElement) |
| PreSerialize(XmlWriter) |
在序列化之前调用。Called before serialization. (继承自 ConfigurationElement) |
| Remove(NameValueConfigurationElement) |
基于所提供的参数,从集合中移除 NameValueConfigurationElement 对象。Removes a NameValueConfigurationElement object from the collection based on the provided parameter. |
| Remove(String) |
基于所提供的参数,从集合中移除 NameValueConfigurationElement 对象。Removes a NameValueConfigurationElement object from the collection based on the provided parameter. |
| Reset(ConfigurationElement) |
在派生的类中重写时,将 ConfigurationElementCollection 重置为其未被修改时的状态。Resets the ConfigurationElementCollection to its unmodified state when overridden in a derived class. (继承自 ConfigurationElementCollection) |
| ResetModified() |
在派生的类中重写时,将 IsModified() 属性的值重置为 |
| SerializeElement(XmlWriter, Boolean) |
在派生的类中重写时,将配置数据写入配置文件中的 XML 元素。Writes the configuration data to an XML element in the configuration file when overridden in a derived class. (继承自 ConfigurationElementCollection) |
| SerializeToXmlElement(XmlWriter, String) |
当在派生类中实现后,将此配置元素的外部标记写入配置文件。Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (继承自 ConfigurationElement) |
| SetPropertyValue(ConfigurationProperty, Object, Boolean) |
将属性设置为指定值。Sets a property to the specified value. (继承自 ConfigurationElement) |
| SetReadOnly() |
为 IsReadOnly() 对象和所有子元素设置 ConfigurationElementCollection 属性。Sets the IsReadOnly() property for the ConfigurationElementCollection object and for all sub-elements. (继承自 ConfigurationElementCollection) |
| ToString() |
返回表示当前对象的字符串。Returns a string that represents the current object. (继承自 Object) |
| Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) |
反转从配置层次结构的不同级别合并配置信息的效果。Reverses the effect of merging configuration information from different levels of the configuration hierarchy. (继承自 ConfigurationElementCollection) |
显式接口实现
| ICollection.CopyTo(Array, Int32) |
将 ConfigurationElementCollection 复制到数组。Copies the ConfigurationElementCollection to an array. (继承自 ConfigurationElementCollection) |
扩展方法
| Cast<TResult>(IEnumerable) |
将 IEnumerable 的元素强制转换为指定的类型。Casts the elements of an IEnumerable to the specified type. |
| OfType<TResult>(IEnumerable) |
根据指定类型筛选 IEnumerable 的元素。Filters the elements of an IEnumerable based on a specified type. |
| AsParallel(IEnumerable) |
启用查询的并行化。Enables parallelization of a query. |
| AsQueryable(IEnumerable) |
将 IEnumerable 转换为 IQueryable。Converts an IEnumerable to an IQueryable. |