ConfigurationElementCollection Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Представляет элемент конфигурации, содержащий коллекцию дочерних элементов.
public ref class ConfigurationElementCollection abstract : System::Configuration::ConfigurationElement, System::Collections::ICollectionpublic abstract class ConfigurationElementCollection : System.Configuration.ConfigurationElement, System.Collections.ICollectiontype ConfigurationElementCollection = class
inherit ConfigurationElement
interface ICollection
interface IEnumerablePublic MustInherit Class ConfigurationElementCollection
Inherits ConfigurationElement
Implements ICollection- Наследование
- Производный
- Реализации
Примеры
В следующем примере показано, как использовать ConfigurationElementCollection.
Первый пример состоит из трех классов: UrlsSection, UrlsCollection и UrlConfigElement. Класс UrlsSection использует для ConfigurationCollectionAttribute определения пользовательского раздела конфигурации. Этот раздел содержит коллекцию URL-адресов (определяемую классом UrlsCollection ) элементов URL-адресов (определяется классом UrlConfigElement ).
using System;
using System.Configuration;
// Define a UrlsSection custom section that contains a
// UrlsCollection collection of UrlConfigElement elements.
public class UrlsSection : ConfigurationSection
{
// Declare the UrlsCollection collection property.
[ConfigurationProperty("urls", IsDefaultCollection = false)]
[ConfigurationCollection(typeof(UrlsCollection),
AddItemName = "add",
ClearItemsName = "clear",
RemoveItemName = "remove")]
public UrlsCollection Urls
{
get
{
UrlsCollection urlsCollection =
(UrlsCollection)base["urls"];
return urlsCollection;
}
set
{
UrlsCollection urlsCollection = value;
}
}
// Create a new instance of the UrlsSection.
// This constructor creates a configuration element
// using the UrlConfigElement default values.
// It assigns this element to the collection.
public UrlsSection()
{
UrlConfigElement url = new UrlConfigElement();
Urls.Add(url);
}
}
// Define the UrlsCollection that contains the
// UrlsConfigElement elements.
// This class shows how to use the ConfigurationElementCollection.
public class UrlsCollection : ConfigurationElementCollection
{
public UrlsCollection()
{
}
public override ConfigurationElementCollectionType CollectionType
{
get
{
return ConfigurationElementCollectionType.AddRemoveClearMap;
}
}
protected override ConfigurationElement CreateNewElement()
{
return new UrlConfigElement();
}
protected override Object GetElementKey(ConfigurationElement element)
{
return ((UrlConfigElement)element).Name;
}
public UrlConfigElement this[int index]
{
get
{
return (UrlConfigElement)BaseGet(index);
}
set
{
if (BaseGet(index) != null)
{
BaseRemoveAt(index);
}
BaseAdd(index, value);
}
}
new public UrlConfigElement this[string Name]
{
get
{
return (UrlConfigElement)BaseGet(Name);
}
}
public int IndexOf(UrlConfigElement url)
{
return BaseIndexOf(url);
}
public void Add(UrlConfigElement url)
{
BaseAdd(url);
// Your custom code goes here.
}
protected override void BaseAdd(ConfigurationElement element)
{
BaseAdd(element, false);
// Your custom code goes here.
}
public void Remove(UrlConfigElement url)
{
if (BaseIndexOf(url) >= 0)
{
BaseRemove(url.Name);
// Your custom code goes here.
Console.WriteLine("UrlsCollection: {0}", "Removed collection element!");
}
}
public void RemoveAt(int index)
{
BaseRemoveAt(index);
// Your custom code goes here.
}
public void Remove(string name)
{
BaseRemove(name);
// Your custom code goes here.
}
public void Clear()
{
BaseClear();
// Your custom code goes here.
Console.WriteLine("UrlsCollection: {0}", "Removed entire collection!");
}
}
// Define the UrlsConfigElement elements that are contained
// by the UrlsCollection.
public class UrlConfigElement : ConfigurationElement
{
public UrlConfigElement(String name, String url, int port)
{
this.Name = name;
this.Url = url;
this.Port = port;
}
public UrlConfigElement()
{
}
[ConfigurationProperty("name", DefaultValue = "Contoso",
IsRequired = true, IsKey = true)]
public string Name
{
get
{
return (string)this["name"];
}
set
{
this["name"] = value;
}
}
[ConfigurationProperty("url", DefaultValue = "http://www.contoso.com",
IsRequired = true)]
[RegexStringValidator(@"\w+:\/\/[\w.]+\S*")]
public string Url
{
get
{
return (string)this["url"];
}
set
{
this["url"] = value;
}
}
[ConfigurationProperty("port", DefaultValue = (int)4040, IsRequired = false)]
[IntegerValidator(MinValue = 0, MaxValue = 8080, ExcludeRange = false)]
public int Port
{
get
{
return (int)this["port"];
}
set
{
this["port"] = value;
}
}
}
Imports System.Configuration
' Define a UrlsSection custom section that contains a
' UrlsCollection collection of UrlConfigElement elements.
Public Class UrlsSection
Inherits ConfigurationSection
' Declare the UrlsCollection collection property.
<ConfigurationProperty("urls", IsDefaultCollection:=False), ConfigurationCollection(GetType(UrlsCollection), AddItemName:="add", ClearItemsName:="clear", RemoveItemName:="remove")>
Public Property Urls() As UrlsCollection
Get
Dim urlsCollection As UrlsCollection = CType(MyBase.Item("urls"), UrlsCollection)
Return urlsCollection
End Get
Set(ByVal value As UrlsCollection)
Dim urlsCollection As UrlsCollection = value
End Set
End Property
' Create a new instance of the UrlsSection.
' This constructor creates a configuration element
' using the UrlConfigElement default values.
' It assigns this element to the collection.
Public Sub New()
Dim url As New UrlConfigElement()
Urls.Add(url)
End Sub
End Class
' Define the UrlsCollection that contains the
' UrlsConfigElement elements.
' This class shows how to use the ConfigurationElementCollection.
Public Class UrlsCollection
Inherits System.Configuration.ConfigurationElementCollection
Public Sub New()
End Sub
Public ReadOnly Property CollectionType() As ConfigurationElementCollectionType
Get
Return ConfigurationElementCollectionType.AddRemoveClearMap
End Get
End Property
Protected Overloads Overrides Function CreateNewElement() As ConfigurationElement
Return New UrlConfigElement()
End Function
Protected Overrides Function GetElementKey(ByVal element As ConfigurationElement) As Object
Return (CType(element, UrlConfigElement)).Name
End Function
Default Public Shadows Property Item(ByVal index As Integer) As UrlConfigElement
Get
Return CType(BaseGet(index), UrlConfigElement)
End Get
Set(ByVal value As UrlConfigElement)
If BaseGet(index) IsNot Nothing Then
BaseRemoveAt(index)
End If
BaseAdd(value)
End Set
End Property
Default Public Shadows ReadOnly Property Item(ByVal Name As String) As UrlConfigElement
Get
Return CType(BaseGet(Name), UrlConfigElement)
End Get
End Property
Public Function IndexOf(ByVal url As UrlConfigElement) As Integer
Return BaseIndexOf(url)
End Function
Public Sub Add(ByVal url As UrlConfigElement)
BaseAdd(url)
' Your custom code goes here.
End Sub
Protected Overloads Sub BaseAdd(ByVal element As ConfigurationElement)
BaseAdd(element, False)
' Your custom code goes here.
End Sub
Public Sub Remove(ByVal url As UrlConfigElement)
If BaseIndexOf(url) >= 0 Then
BaseRemove(url.Name)
' Your custom code goes here.
Console.WriteLine("UrlsCollection: {0}", "Removed collection element!")
End If
End Sub
Public Sub RemoveAt(ByVal index As Integer)
BaseRemoveAt(index)
' Your custom code goes here.
End Sub
Public Sub Remove(ByVal name As String)
BaseRemove(name)
' Your custom code goes here.
End Sub
Public Sub Clear()
BaseClear()
' Your custom code goes here.
Console.WriteLine("UrlsCollection: {0}", "Removed entire collection!")
End Sub
End Class
' Define the UrlsConfigElement elements that are contained
' by the UrlsCollection.
Public Class UrlConfigElement
Inherits ConfigurationElement
Public Sub New(ByVal name As String, ByVal url As String, ByVal port As Integer)
Me.Name = name
Me.Url = url
Me.Port = port
End Sub
Public Sub New()
End Sub
<ConfigurationProperty("name", DefaultValue:="Contoso", IsRequired:=True, IsKey:=True)>
Public Property Name() As String
Get
Return CStr(Me("name"))
End Get
Set(ByVal value As String)
Me("name") = value
End Set
End Property
<ConfigurationProperty("url", DefaultValue:="http://www.contoso.com", IsRequired:=True), RegexStringValidator("\w+:\/\/[\w.]+\S*")>
Public Property Url() As String
Get
Return CStr(Me("url"))
End Get
Set(ByVal value As String)
Me("url") = value
End Set
End Property
<ConfigurationProperty("port", DefaultValue:=CInt(4040), IsRequired:=False), IntegerValidator(MinValue:=0, MaxValue:=8080, ExcludeRange:=False)>
Public Property Port() As Integer
Get
Return CInt(Fix(Me("port")))
End Get
Set(ByVal value As Integer)
Me("port") = value
End Set
End Property
End Class
Во втором примере кода используются классы, указанные ранее. Эти два примера объединяются в проекте консольного приложения.
using System;
using System.Configuration;
using System.Text;
class UsingConfigurationCollectionElement
{
// Create a custom section and save it in the
// application configuration file.
static void CreateCustomSection()
{
try
{
// Get the current configuration file.
System.Configuration.Configuration config =
ConfigurationManager.OpenExeConfiguration(
ConfigurationUserLevel.None);
// Add the custom section to the application
// configuration file.
UrlsSection myUrlsSection = (UrlsSection)config.Sections["MyUrls"];
if (myUrlsSection == null)
{
// The configuration file does not contain the
// custom section yet. Create it.
myUrlsSection = new UrlsSection();
config.Sections.Add("MyUrls", myUrlsSection);
// Save the application configuration file.
myUrlsSection.SectionInformation.ForceSave = true;
config.Save(ConfigurationSaveMode.Modified);
}
else
if (myUrlsSection.Urls.Count == 0)
{
// The configuration file contains the
// custom section but its element collection is empty.
// Initialize the collection.
UrlConfigElement url = new UrlConfigElement();
myUrlsSection.Urls.Add(url);
// Save the application configuration file.
myUrlsSection.SectionInformation.ForceSave = true;
config.Save(ConfigurationSaveMode.Modified);
}
Console.WriteLine("Created custom section in the application configuration file: {0}",
config.FilePath);
Console.WriteLine();
}
catch (ConfigurationErrorsException err)
{
Console.WriteLine("CreateCustomSection: {0}", err.ToString());
}
}
static void ReadCustomSection()
{
try
{
// Get the application configuration file.
System.Configuration.Configuration config =
ConfigurationManager.OpenExeConfiguration(
ConfigurationUserLevel.None) as Configuration;
// Read and display the custom section.
UrlsSection myUrlsSection =
config.GetSection("MyUrls") as UrlsSection;
if (myUrlsSection == null)
{
Console.WriteLine("Failed to load UrlsSection.");
}
else
{
Console.WriteLine("Collection elements contained in the custom section collection:");
for (int i = 0; i < myUrlsSection.Urls.Count; i++)
{
Console.WriteLine(" Name={0} URL={1} Port={2}",
myUrlsSection.Urls[i].Name,
myUrlsSection.Urls[i].Url,
myUrlsSection.Urls[i].Port);
}
}
}
catch (ConfigurationErrorsException err)
{
Console.WriteLine("ReadCustomSection(string): {0}", err.ToString());
}
}
// Add an element to the custom section collection.
// This function uses the ConfigurationCollectionElement Add method.
static void AddCollectionElement()
{
try
{
// Get the current configuration file.
System.Configuration.Configuration config =
ConfigurationManager.OpenExeConfiguration(
ConfigurationUserLevel.None);
// Get the custom configuration section.
UrlsSection myUrlsSection = config.GetSection("MyUrls") as UrlsSection;
// Add the element to the collection in the custom section.
if (config.Sections["MyUrls"] != null)
{
UrlConfigElement urlElement = new UrlConfigElement();
urlElement.Name = "Microsoft";
urlElement.Url = "http://www.microsoft.com";
urlElement.Port = 8080;
// Use the ConfigurationCollectionElement Add method
// to add the new element to the collection.
myUrlsSection.Urls.Add(urlElement);
// Save the application configuration file.
myUrlsSection.SectionInformation.ForceSave = true;
config.Save(ConfigurationSaveMode.Modified);
Console.WriteLine("Added collection element to the custom section in the configuration file: {0}",
config.FilePath);
Console.WriteLine();
}
else
{
Console.WriteLine("You must create the custom section first.");
}
}
catch (ConfigurationErrorsException err)
{
Console.WriteLine("AddCollectionElement: {0}", err.ToString());
}
}
// Remove element from the custom section collection.
// This function uses one of the ConfigurationCollectionElement
// overloaded Remove methods.
static void RemoveCollectionElement()
{
try
{
// Get the current configuration file.
System.Configuration.Configuration config =
ConfigurationManager.OpenExeConfiguration(
ConfigurationUserLevel.None);
// Get the custom configuration section.
UrlsSection myUrlsSection = config.GetSection("MyUrls") as UrlsSection;
// Remove the element from the custom section.
if (config.Sections["MyUrls"] != null)
{
UrlConfigElement urlElement = new UrlConfigElement();
urlElement.Name = "Microsoft";
urlElement.Url = "http://www.microsoft.com";
urlElement.Port = 8080;
// Use one of the ConfigurationCollectionElement Remove
// overloaded methods to remove the element from the collection.
myUrlsSection.Urls.Remove(urlElement);
// Save the application configuration file.
myUrlsSection.SectionInformation.ForceSave = true;
config.Save(ConfigurationSaveMode.Full);
Console.WriteLine("Removed collection element from he custom section in the configuration file: {0}",
config.FilePath);
Console.WriteLine();
}
else
{
Console.WriteLine("You must create the custom section first.");
}
}
catch (ConfigurationErrorsException err)
{
Console.WriteLine("RemoveCollectionElement: {0}", err.ToString());
}
}
// Remove the collection of elements from the custom section.
// This function uses the ConfigurationCollectionElement Clear method.
static void ClearCollectionElements()
{
try
{
// Get the current configuration file.
System.Configuration.Configuration config =
ConfigurationManager.OpenExeConfiguration(
ConfigurationUserLevel.None);
// Get the custom configuration section.
UrlsSection myUrlsSection = config.GetSection("MyUrls") as UrlsSection;
// Remove the collection of elements from the section.
if (config.Sections["MyUrls"] != null)
{
myUrlsSection.Urls.Clear();
// Save the application configuration file.
myUrlsSection.SectionInformation.ForceSave = true;
config.Save(ConfigurationSaveMode.Full);
Console.WriteLine("Removed collection of elements from he custom section in the configuration file: {0}",
config.FilePath);
Console.WriteLine();
}
else
{
Console.WriteLine("You must create the custom section first.");
}
}
catch (ConfigurationErrorsException err)
{
Console.WriteLine("ClearCollectionElements: {0}", err.ToString());
}
}
public static void UserMenu()
{
string applicationName =
Environment.GetCommandLineArgs()[0] + ".exe";
StringBuilder buffer = new StringBuilder();
buffer.AppendLine("Application: " + applicationName);
buffer.AppendLine("Make your selection.");
buffer.AppendLine("? -- Display help.");
buffer.AppendLine("Q,q -- Exit the application.");
buffer.Append("1 -- Create a custom section that");
buffer.AppendLine(" contains a collection of elements.");
buffer.Append("2 -- Read the custom section that");
buffer.AppendLine(" contains a collection of custom elements.");
buffer.Append("3 -- Add a collection element to");
buffer.AppendLine(" the custom section.");
buffer.Append("4 -- Remove a collection element from");
buffer.AppendLine(" the custom section.");
buffer.Append("5 -- Clear the collection of elements from");
buffer.AppendLine(" the custom section.");
Console.Write(buffer.ToString());
}
// Obtain user's input and provide
// feedback.
static void Main(string[] args)
{
// Define user selection string.
string selection;
// Get the name of the application.
string appName =
Environment.GetCommandLineArgs()[0];
// Get user selection.
while (true)
{
UserMenu();
Console.Write("> ");
selection = Console.ReadLine();
if (!string.IsNullOrEmpty(selection))
break;
}
while (selection.ToLower() != "q")
{
// Process user's input.
switch (selection)
{
case "1":
// Create a custom section and save it in the
// application configuration file.
CreateCustomSection();
break;
case "2":
// Read the custom section from the
// application configuration file.
ReadCustomSection();
break;
case "3":
// Add a collection element to the
// custom section.
AddCollectionElement();
break;
case "4":
// Remove a collection element from the
// custom section.
RemoveCollectionElement();
break;
case "5":
// Clear the collection of elements from the
// custom section.
ClearCollectionElements();
break;
default:
UserMenu();
break;
}
Console.Write("> ");
selection = Console.ReadLine();
}
}
}
Imports System.Configuration
Imports System.Text
Friend Class UsingConfigurationCollectionElement
' Create a custom section and save it in the
' application configuration file.
Private Shared Sub CreateCustomSection()
Try
' Get the current configuration file.
Dim config As System.Configuration.Configuration = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None)
' Add the custom section to the application
' configuration file.
Dim myUrlsSection As UrlsSection = CType(config.Sections("MyUrls"), UrlsSection)
If myUrlsSection Is Nothing Then
' The configuration file does not contain the
' custom section yet. Create it.
myUrlsSection = New UrlsSection()
config.Sections.Add("MyUrls", myUrlsSection)
' Save the application configuration file.
myUrlsSection.SectionInformation.ForceSave = True
config.Save(ConfigurationSaveMode.Modified)
Else
If myUrlsSection.Urls.Count = 0 Then
' The configuration file contains the
' custom section but its element collection is empty.
' Initialize the collection.
Dim url As New UrlConfigElement()
myUrlsSection.Urls.Add(url)
' Save the application configuration file.
myUrlsSection.SectionInformation.ForceSave = True
config.Save(ConfigurationSaveMode.Modified)
End If
End If
Console.WriteLine("Created custom section in the application configuration file: {0}", config.FilePath)
Console.WriteLine()
Catch err As ConfigurationErrorsException
Console.WriteLine("CreateCustomSection: {0}", err.ToString())
End Try
End Sub
Private Shared Sub ReadCustomSection()
Try
' Get the application configuration file.
Dim config As System.Configuration.Configuration = TryCast(ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None), Configuration)
' Read and display the custom section.
Dim myUrlsSection As UrlsSection = TryCast(config.GetSection("MyUrls"), UrlsSection)
If myUrlsSection Is Nothing Then
Console.WriteLine("Failed to load UrlsSection.")
Else
Console.WriteLine("Collection elements contained in the custom section collection:")
For i As Integer = 0 To myUrlsSection.Urls.Count - 1
Console.WriteLine(" Name={0} URL={1} Port={2}", myUrlsSection.Urls(i).Name, myUrlsSection.Urls(i).Url, myUrlsSection.Urls(i).Port)
Next i
End If
Catch err As ConfigurationErrorsException
Console.WriteLine("ReadCustomSection(string): {0}", err.ToString())
End Try
End Sub
' Add an element to the custom section collection.
' This function uses the ConfigurationCollectionElement Add method.
Private Shared Sub AddCollectionElement()
Try
' Get the current configuration file.
Dim config As System.Configuration.Configuration = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None)
' Get the custom configuration section.
Dim myUrlsSection As UrlsSection = TryCast(config.GetSection("MyUrls"), UrlsSection)
' Add the element to the collection in the custom section.
If config.Sections("MyUrls") IsNot Nothing Then
Dim urlElement As New UrlConfigElement()
urlElement.Name = "Microsoft"
urlElement.Url = "http://www.microsoft.com"
urlElement.Port = 8080
' Use the ConfigurationCollectionElement Add method
' to add the new element to the collection.
myUrlsSection.Urls.Add(urlElement)
' Save the application configuration file.
myUrlsSection.SectionInformation.ForceSave = True
config.Save(ConfigurationSaveMode.Modified)
Console.WriteLine("Added collection element to the custom section in the configuration file: {0}", config.FilePath)
Console.WriteLine()
Else
Console.WriteLine("You must create the custom section first.")
End If
Catch err As ConfigurationErrorsException
Console.WriteLine("AddCollectionElement: {0}", err.ToString())
End Try
End Sub
' Remove element from the custom section collection.
' This function uses one of the ConfigurationCollectionElement
' overloaded Remove methods.
Private Shared Sub RemoveCollectionElement()
Try
' Get the current configuration file.
Dim config As System.Configuration.Configuration = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None)
' Get the custom configuration section.
Dim myUrlsSection As UrlsSection = TryCast(config.GetSection("MyUrls"), UrlsSection)
' Remove the element from the custom section.
If config.Sections("MyUrls") IsNot Nothing Then
Dim urlElement As New UrlConfigElement()
urlElement.Name = "Microsoft"
urlElement.Url = "http://www.microsoft.com"
urlElement.Port = 8080
' Use one of the ConfigurationCollectionElement Remove
' overloaded methods to remove the element from the collection.
myUrlsSection.Urls.Remove(urlElement)
' Save the application configuration file.
myUrlsSection.SectionInformation.ForceSave = True
config.Save(ConfigurationSaveMode.Full)
Console.WriteLine("Removed collection element from he custom section in the configuration file: {0}", config.FilePath)
Console.WriteLine()
Else
Console.WriteLine("You must create the custom section first.")
End If
Catch err As ConfigurationErrorsException
Console.WriteLine("RemoveCollectionElement: {0}", err.ToString())
End Try
End Sub
' Remove the collection of elements from the custom section.
' This function uses the ConfigurationCollectionElement Clear method.
Private Shared Sub ClearCollectionElements()
Try
' Get the current configuration file.
Dim config As System.Configuration.Configuration = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None)
' Get the custom configuration section.
Dim myUrlsSection As UrlsSection = TryCast(config.GetSection("MyUrls"), UrlsSection)
' Remove the collection of elements from the section.
If config.Sections("MyUrls") IsNot Nothing Then
myUrlsSection.Urls.Clear()
' Save the application configuration file.
myUrlsSection.SectionInformation.ForceSave = True
config.Save(ConfigurationSaveMode.Full)
Console.WriteLine("Removed collection of elements from he custom section in the configuration file: {0}", config.FilePath)
Console.WriteLine()
Else
Console.WriteLine("You must create the custom section first.")
End If
Catch err As ConfigurationErrorsException
Console.WriteLine("ClearCollectionElements: {0}", err.ToString())
End Try
End Sub
Public Shared Sub UserMenu()
Dim applicationName As String = Environment.GetCommandLineArgs()(0) & ".exe"
Dim buffer As New StringBuilder()
buffer.AppendLine("Application: " & applicationName)
buffer.AppendLine("Make your selection.")
buffer.AppendLine("? -- Display help.")
buffer.AppendLine("Q,q -- Exit the application.")
buffer.Append("1 -- Create a custom section that")
buffer.AppendLine(" contains a collection of elements.")
buffer.Append("2 -- Read the custom section that")
buffer.AppendLine(" contains a collection of custom elements.")
buffer.Append("3 -- Add a collection element to")
buffer.AppendLine(" the custom section.")
buffer.Append("4 -- Remove a collection element from")
buffer.AppendLine(" the custom section.")
buffer.Append("5 -- Clear the collection of elements from")
buffer.AppendLine(" the custom section.")
Console.Write(buffer.ToString())
End Sub
' Obtain user's input and provide
' feedback.
Shared Sub Main(ByVal args() As String)
' Define user selection string.
Dim selection As String
' Get the name of the application.
Dim appName As String = Environment.GetCommandLineArgs()(0)
' Get user selection.
Do
UserMenu()
Console.Write("> ")
selection = Console.ReadLine()
If selection <> String.Empty Then
Exit Do
End If
Loop
Do While selection.ToLower() <> "q"
' Process user's input.
Select Case selection
Case "1"
' Create a custom section and save it in the
' application configuration file.
CreateCustomSection()
Case "2"
' Read the custom section from the
' application configuration file.
ReadCustomSection()
Case "3"
' Add a collection element to the
' custom section.
AddCollectionElement()
Case "4"
' Remove a collection element from the
' custom section.
RemoveCollectionElement()
Case "5"
' Clear the collection of elements from the
' custom section.
ClearCollectionElements()
Case Else
UserMenu()
End Select
Console.Write("> ")
selection = Console.ReadLine()
Loop
End Sub
End Class
При запуске консольного приложения создается экземпляр UrlsSection класса , а в файле конфигурации приложения создаются следующие элементы конфигурации:
<configuration>
<configSections>
<section name="MyUrls" type="UrlsSection,
ConfigurationElementCollection, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />
</configSections>
<MyUrls>
<urls>
<add name="Contoso" url="http://www.contoso.com" port="4040" />
</urls>
</MyUrls>
</configuration
Комментарии
Представляет ConfigurationElementCollection коллекцию элементов в файле конфигурации.
Примечание
Элемент в файле конфигурации относится к базовому XML-элементу или разделу. Простой элемент — это XML-тег со связанными атрибутами, если таковые есть. Простой элемент представляет собой раздел. Сложные разделы могут содержать один или несколько простых элементов, коллекцию элементов и другие разделы.
Для работы с коллекцией ConfigurationElement объектов используется ConfigurationElementCollection . Реализуйте этот класс для добавления коллекций пользовательских ConfigurationElement элементов в ConfigurationSection.
Примечания для тех, кто реализует этот метод
Для создания пользовательского элемента конфигурации можно использовать программную или декларативную (атрибутивную) модель кодирования.
Программная модель требует, чтобы для каждого атрибута элемента создавалось свойство для получения и задания его значения, а также добавлялось во внутренний контейнер свойств базового ConfigurationElement класса.
Декларативная модель, также называемая моделью с атрибутами, позволяет определить атрибут элемента с помощью свойства и настроить его с помощью атрибутов. Эти атрибуты указывают системе конфигурации ASP.NET о типах свойств и их значениях по умолчанию. ASP.NET может использовать отражение для получения этих сведений, а затем создать объекты свойств элемента и выполнить необходимую инициализацию.
Конструкторы
| ConfigurationElementCollection() |
Инициализирует новый экземпляр класса ConfigurationElementCollection. |
| ConfigurationElementCollection(IComparer) |
Создает новый экземпляр класса ConfigurationElementCollection. |
Свойства
| AddElementName |
Возвращает или устанавливает имя ConfigurationElement, связанное с операцией добавления в ConfigurationElementCollection после переопределения в производном классе. |
| ClearElementName |
Возвращает или задает имя ConfigurationElement, связанное с операцией очистки в ConfigurationElementCollection после переопределения в производном классе. |
| CollectionType |
Возвращает тип службы ConfigurationElementCollection. |
| Count |
Получает количество элементов коллекции. |
| CurrentConfiguration |
Возвращает ссылку на экземпляр Configuration верхнего уровня, представляющий иерархию конфигурации, к которой относится текущий экземпляр ConfigurationElement. (Унаследовано от ConfigurationElement) |
| ElementInformation |
Возвращает объект ElementInformation, содержащий неизменяемую информацию и функциональность объекта ConfigurationElement. (Унаследовано от ConfigurationElement) |
| ElementName |
Получает имя, используемое для данной коллекции элементов в файле конфигурации после переопределения в производном классе. |
| ElementProperty |
Возвращает объект ConfigurationElementProperty, представляющий сам объект ConfigurationElement. (Унаследовано от ConfigurationElement) |
| EmitClear |
Получает или задает значение, указывающее, была ли коллекция очищена. |
| EvaluationContext |
Возвращает объект ContextInformation для объекта ConfigurationElement. (Унаследовано от ConfigurationElement) |
| HasContext |
Возвращает значение, указывающее, имеет ли свойство CurrentConfiguration значение |
| IsSynchronized |
Возвращает значение, показывающее, синхронизирован ли доступ к коллекции. |
| Item[ConfigurationProperty] |
Возвращает или задает свойство или атрибут данного элемента конфигурации. (Унаследовано от ConfigurationElement) |
| Item[String] |
Получает или задает свойство, атрибут или дочерний элемент данного элемента конфигурации. (Унаследовано от ConfigurationElement) |
| LockAllAttributesExcept |
Возвращает коллекцию заблокированных атрибутов. (Унаследовано от ConfigurationElement) |
| LockAllElementsExcept |
Возвращает коллекцию заблокированных элементов. (Унаследовано от ConfigurationElement) |
| LockAttributes |
Возвращает коллекцию заблокированных атрибутов. (Унаследовано от ConfigurationElement) |
| LockElements |
Возвращает коллекцию заблокированных элементов. (Унаследовано от ConfigurationElement) |
| LockItem |
Возвращает или задает значение, указывающее, заблокирован ли элемент. (Унаследовано от ConfigurationElement) |
| Properties |
Возвращает коллекцию свойств. (Унаследовано от ConfigurationElement) |
| RemoveElementName |
Получает или задает имя ConfigurationElement, связанное с операцией удаления в ConfigurationElementCollection после переопределения в производном классе. |
| SyncRoot |
Получает объект, используемый для синхронизации доступа к ConfigurationElementCollection. |
| ThrowOnDuplicate |
Возвращает значение, указывающее, выдаст ли исключение попытка добавить дубликат ConfigurationElement к ConfigurationElementCollection. |
Методы
| BaseAdd(ConfigurationElement) |
Добавляет новый элемент конфигурации в ConfigurationElementCollection. |
| BaseAdd(ConfigurationElement, Boolean) |
Добавляет элемент конфигурации в коллекцию элементов конфигурации. |
| BaseAdd(Int32, ConfigurationElement) |
Добавляет элемент конфигурации в коллекцию элементов конфигурации. |
| BaseClear() |
Удаляет все объекты элементов конфигурации из коллекции. |
| BaseGet(Int32) |
Возвращает элемент конфигурации с указанным расположением индекса. |
| BaseGet(Object) |
Возвращает элемент конфигурации с указанным ключом. |
| BaseGetAllKeys() |
Возвращает массив ключей для всех элементов конфигурации, содержащихся в ConfigurationElementCollection. |
| BaseGetKey(Int32) |
Получает ключ объекта ConfigurationElement по указанному расположению индекса. |
| BaseIndexOf(ConfigurationElement) |
Указывает индекс заданного объекта ConfigurationElement. |
| BaseIsRemoved(Object) |
Указывает, удален ли ConfigurationElement с указанным ключом из ConfigurationElementCollection. |
| BaseRemove(Object) |
Удаляет объект ConfigurationElement из коллекции. |
| BaseRemoveAt(Int32) |
Удаляет объект ConfigurationElement по указанному расположению индекса. |
| CopyTo(ConfigurationElement[], Int32) |
Копирует содержимое объекта ConfigurationElementCollection в массив. |
| CreateNewElement() |
При переопределении в производном классе создает новый объект ConfigurationElement. |
| CreateNewElement(String) |
При переопределении в производном классе создает новый элемент ConfigurationElement. |
| DeserializeElement(XmlReader, Boolean) |
Считывает XML из файла конфигурации. (Унаследовано от ConfigurationElement) |
| Equals(Object) |
Сравнивает ConfigurationElementCollection с указанным объектом. |
| GetElementKey(ConfigurationElement) |
При переопределении в производном классе возвращает ключ указанного элемента конфигурации. |
| GetEnumerator() |
Получает метод IEnumerator, используемый для итерации по ConfigurationElementCollection. |
| GetHashCode() |
Получает уникальное значение, представляющее экземпляр ConfigurationElementCollection. |
| GetTransformedAssemblyString(String) |
Возвращает преобразованную версию указанного имени сборки. (Унаследовано от ConfigurationElement) |
| GetTransformedTypeString(String) |
Возвращает преобразованную версию указанного имени типа. (Унаследовано от ConfigurationElement) |
| GetType() |
Возвращает объект Type для текущего экземпляра. (Унаследовано от Object) |
| Init() |
Задает объект ConfigurationElement в исходное состояние. (Унаследовано от ConfigurationElement) |
| InitializeDefault() |
Используется для инициализации набора значений по умолчанию для объекта ConfigurationElement. (Унаследовано от ConfigurationElement) |
| IsElementName(String) |
Указывает, существует ли указанный ConfigurationElement в ConfigurationElementCollection. |
| IsElementRemovable(ConfigurationElement) |
Указывает, может ли указанный объект ConfigurationElement быть удален из ConfigurationElementCollection. |
| IsModified() |
Указывает, был ли изменен ConfigurationElementCollection с момента последнего сохранения или загрузки после переопределения в производном классе. |
| IsReadOnly() |
Указывает, доступен ли объект ConfigurationElementCollection только для чтения. |
| ListErrors(IList) |
Добавляет ошибку "недействительное свойство" в данном объекте ConfigurationElement и всех его дочерних элементах к переданному списку. (Унаследовано от ConfigurationElement) |
| MemberwiseClone() |
Создает неполную копию текущего объекта Object. (Унаследовано от Object) |
| OnDeserializeUnrecognizedAttribute(String, String) |
Возвращает значение, указывающее, встретился ли неизвестный атрибут при десериализации. (Унаследовано от ConfigurationElement) |
| OnDeserializeUnrecognizedElement(String, XmlReader) |
Приводит к тому, что система конфигурации выдает исключение. |
| OnRequiredPropertyNotFound(String) |
Выдает исключение, если требуемое свойство не найдено. (Унаследовано от ConfigurationElement) |
| PostDeserialize() |
Вызывается после десериализации. (Унаследовано от ConfigurationElement) |
| PreSerialize(XmlWriter) |
Вызывается до сериализации. (Унаследовано от ConfigurationElement) |
| Reset(ConfigurationElement) |
Сбрасывает ConfigurationElementCollection в неизмененное состояние после переопределения в производном классе. |
| ResetModified() |
Переустанавливает значение свойства IsModified() в |
| SerializeElement(XmlWriter, Boolean) |
Записывает данные конфигурации в XML-элемент в файле конфигурации после переопределения в производном классе. |
| SerializeToXmlElement(XmlWriter, String) |
Записывает внешние теги данного элемента конфигурации в файл конфигурации при реализации в производном классе. (Унаследовано от ConfigurationElement) |
| SetPropertyValue(ConfigurationProperty, Object, Boolean) |
Задает для свойства указанное значение. (Унаследовано от ConfigurationElement) |
| SetReadOnly() |
Устанавливает свойство IsReadOnly() для объекта ConfigurationElementCollection и всех подчиненных элементов. |
| ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |
| Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) |
Отменяет эффект слияния данных конфигурации на разных уровнях иерархии конфигурации. |
Явные реализации интерфейса
| ICollection.CopyTo(Array, Int32) |
Копирует ConfigurationElementCollection в массив. |
Методы расширения
| Cast<TResult>(IEnumerable) |
Приводит элементы объекта IEnumerable к заданному типу. |
| OfType<TResult>(IEnumerable) |
Выполняет фильтрацию элементов объекта IEnumerable по заданному типу. |
| AsParallel(IEnumerable) |
Позволяет осуществлять параллельный запрос. |
| AsQueryable(IEnumerable) |
Преобразовывает коллекцию IEnumerable в объект IQueryable. |
