WebPartsSection Classe
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Fournit un accès programmatique à la section du webParts fichier de configuration. Cette classe ne peut pas être héritée.
public ref class WebPartsSection sealed : System::Configuration::ConfigurationSection
public sealed class WebPartsSection : System.Configuration.ConfigurationSection
type WebPartsSection = class
inherit ConfigurationSection
Public NotInheritable Class WebPartsSection
Inherits ConfigurationSection
- Héritage
Exemples
Cet exemple montre comment spécifier des valeurs de manière déclarative pour plusieurs attributs de la webParts section, qui sont également accessibles en tant que membres de la WebPartsSection classe.
L’exemple de fichier de configuration suivant montre comment spécifier des valeurs de manière déclarative pour la webParts section.
<system.web>
<webParts>
<personalization
defaultProvider=" AspNetSqlPersonalizationProvider ">
<!-- Providers may only be defined at the
application level -->
<providers>
<add name="AspNetSqlPersonalizationProvider"
type="System.Web.UI.WebControls.WebParts.SqlPersonalizationProvider"
connectionStringName="LocalSqlServer"
applicationName="/" />
</providers>
<authorization>
<deny users="*" verbs="enterSharedScope" />
<allow users="Admin" verbs="modifyState" />
</authorization>
</personalization>
<transformers>
<add name="RowToFieldTransformer"
type="System.Web.UI.WebControls.WebParts.RowToFieldTransformer" />
<add name="RowToFilterTransformer"
type="System.Web.UI.WebControls.WebParts.RowToFilterTransformer" />
<add name="RowToParametersTransformer"
type="System.Web.UI.WebControls.WebParts.RowToParametersTransformer" />
</transformers>
</webParts>
</system.web>
L’exemple de code suivant montre comment utiliser la WebPartsSection classe.
using System;
using System.Collections;
using System.Collections.Specialized;
using System.IO;
using System.Text;
using System.Text.RegularExpressions;
using System.Configuration;
using System.Configuration.Provider;
using System.Web.Configuration;
namespace Samples.Aspnet.SystemWebConfiguration
{
// Accesses the System.Web.Configuration.WebPartsSection
// members selected by the user.
class UsingWebPartsSection
{
public static void Main()
{
// Process the System.Web.Configuration.WebPartsSectionobject.
try
{
// Get the Web application configuration.
Configuration configuration =
WebConfigurationManager.OpenWebConfiguration("/aspnet");
// Get the section.
WebPartsSection webPartsSection = (WebPartsSection)
configuration.Sections["system.web/webParts"];
// Add a Transfomer Info Object to the collection using a constructor.
webPartsSection.Transformers.Add(new TransformerInfo(
"RowToFilterTransformer",
"MyCustomTransformers.RowToFilterTransformer"));
// Show all TransformerInfo objects in the collection.
for (int ti = 0;
ti < webPartsSection.Personalization.Providers.Count; ti++)
{
Console.WriteLine(" #{0} Name={1} Type={2}", ti,
webPartsSection.Transformers[ti].Name,
webPartsSection.Transformers[ti].Type);
}
// Remove a TransformerInfo object by name.
webPartsSection.Transformers.Remove("RowToFilterTransformer");
// Remove a TransformerInfo object by index.
webPartsSection.Transformers.RemoveAt(0);
// Clear all TransformerInfo objects from the collection.
webPartsSection.Transformers.Clear();
// Get the current DefaultProvider property value.
Console.WriteLine(
"Current DefaultProvider value: '{0}'",
webPartsSection.Personalization.DefaultProvider);
// Set the DefaultProvider property.
webPartsSection.Personalization.DefaultProvider =
"ASPNetSQLPersonalizationProvider";
// Add a provider.
webPartsSection.Personalization.Providers.Add(
new ProviderSettings("CustomProvider",
"MyCustomProviders.Provider"));
// List current providers.
for (int pi = 0;
pi < webPartsSection.Personalization.Providers.Count; pi++)
{
Console.WriteLine(" #{0} Name={1} Type={2}", pi,
webPartsSection.Personalization.Providers[pi].Name,
webPartsSection.Personalization.Providers[pi].Type);
}
// Add an authorization.
AuthorizationRule ar =
new AuthorizationRule(AuthorizationRuleAction.Allow);
ar.Verbs.Add("ModifyState");
ar.Users.Add("Admin");
webPartsSection.Personalization.Authorization.Rules.Add(ar);
// List current authorizations.
for (int ai = 0;
ai < webPartsSection.Personalization.Authorization.Rules.Count;
ai++)
{
Console.WriteLine(" #{0}:", ai);
AuthorizationRule aRule =
webPartsSection.Personalization.Authorization.Rules[ai];
Console.WriteLine(" Verbs=");
foreach (string verb in aRule.Verbs)
Console.WriteLine(" * {0}", verb);
Console.WriteLine(" Roles=");
foreach (string role in aRule.Roles)
Console.WriteLine(" * {0}", role);
Console.WriteLine(" Users=");
foreach (string user in aRule.Users)
Console.WriteLine(" * {0}", user);
}
// Update if not locked.
if (!webPartsSection.IsReadOnly())
{
configuration.Save();
Console.WriteLine("** Configuration updated.");
}
else
{
Console.WriteLine("** Could not update, section is locked.");
}
}
catch (System.ArgumentException e)
{
// Unknown error.
Console.WriteLine(
"A invalid argument exception detected in UsingWebPartsSection Main. Check your");
Console.WriteLine("command line for errors.");
}
}
} // UsingWebPartsSection class end.
} // Samples.Aspnet.SystemWebConfiguration namespace end.
Imports System.Collections
Imports System.Collections.Specialized
Imports System.IO
Imports System.Text
Imports System.Text.RegularExpressions
Imports System.Configuration
Imports System.Web.Configuration
Namespace Samples.Aspnet.SystemWebConfiguration
' Accesses the System.Web.Configuration.WebPartsSection
' members selected by the user.
Class UsingWebPartsSection
Public Shared Sub Main()
' Process the System.Web.Configuration.WebPartsSectionobject.
Try
' Get the Web application configuration.
Dim configuration As System.Configuration.Configuration = _
WebConfigurationManager.OpenWebConfiguration("/aspnet")
' Get the section.
Dim webPartsSection As WebPartsSection = _
CType(configuration.Sections("system.web/webParts"), _
WebPartsSection)
' Add a Transfomer Info Object to the collection using a constructor.
webPartsSection.Transformers.Add(New TransformerInfo( _
"RowToFilterTransformer", _
"MyCustomTransformers.RowToFilterTransformer"))
' Show all TransformerInfo objects in the collection.
Dim ti As Integer
For ti = 0 To webPartsSection.Personalization.Providers.Count - 1
Console.WriteLine(" #{0} Name={1} Type={2}", ti, _
webPartsSection.Transformers(ti).Name, _
webPartsSection.Transformers(ti).Type)
Next
' Remove a TransformerInfo object by name.
webPartsSection.Transformers.Remove("RowToFilterTransformer")
' Remove a TransformerInfo object by index.
webPartsSection.Transformers.RemoveAt(0)
' Clear all TransformerInfo objects from the collection.
webPartsSection.Transformers.Clear()
' Get the current DefaultProvider property value.
Console.WriteLine( _
"Current DefaultProvider value: '{0}'", _
webPartsSection.Personalization.DefaultProvider)
' Set the DefaultProvider property.
webPartsSection.Personalization.DefaultProvider = _
"ASPNetSQLPersonalizationProvider"
' Add a provider.
webPartsSection.Personalization.Providers.Add( _
New ProviderSettings("CustomProvider", _
"MyCustomProviders.Provider"))
' List current providers.
Dim pi As Integer
For pi = 0 To webPartsSection.Personalization.Providers.Count - 1
Console.WriteLine(" #{0} Name={1} Type={2}", pi, _
webPartsSection.Personalization.Providers(pi).Name, _
webPartsSection.Personalization.Providers(pi).Type)
Next
' Add an authorization.
Dim ar As AuthorizationRule = _
New AuthorizationRule(AuthorizationRuleAction.Allow)
ar.Verbs.Add("ModifyState")
ar.Users.Add("Admin")
webPartsSection.Personalization.Authorization.Rules.Add(ar)
' List current authorizations.
Dim ai As Integer
For ai = 0 To _
webPartsSection.Personalization.Authorization.Rules.Count
Console.WriteLine(" #{0}:", ai)
Dim aRule As AuthorizationRule = _
webPartsSection.Personalization.Authorization.Rules(ai)
Console.WriteLine(" Verbs=")
Dim verb As String
For Each verb In aRule.Verbs
Console.WriteLine(" * {0}", verb)
Console.WriteLine(" Roles=")
Next
Dim role As String
For Each role In aRule.Roles
Console.WriteLine(" * {0}", role)
Console.WriteLine(" Users=")
Next
Dim user As String
For Each user In aRule.Users
Console.WriteLine(" * {0}", user)
Next
Next
' Update if not locked.
If Not webPartsSection.IsReadOnly() Then
configuration.Save()
Console.WriteLine("** Configuration updated.")
Else
Console.WriteLine("** Could not update, section is locked.")
End If
Catch e As System.ArgumentException
' Unknown error.
Console.WriteLine( _
"A invalid argument exception detected in UsingWebPartsSection Main. Check your")
Console.WriteLine("command line for errors.")
End Try
End Sub
End Class
End Namespace ' Samples.Aspnet.SystemWebConfiguration
Remarques
La webParts section fichier de configuration vous permet de spécifier un fournisseur de personnalisation de composants WebPart, de définir des autorisations de personnalisation et d’ajouter des classes personnalisées qui étendent la WebPartTransformer classe à utiliser par les connexions de composants WebPart.
Constructeurs
| Nom | Description |
|---|---|
| WebPartsSection() |
Initialise une nouvelle instance de la classe à l’aide WebPartsSection des paramètres par défaut. |
Propriétés
| Nom | Description |
|---|---|
| CurrentConfiguration |
Obtient une référence à l’instance de niveau supérieur Configuration qui représente la hiérarchie de configuration à laquelle appartient l’instance ConfigurationElement actuelle. (Hérité de ConfigurationElement) |
| ElementInformation |
Obtient un objet ElementInformation qui contient les informations et fonctionnalités non personnalisables de l’objet ConfigurationElement. (Hérité de ConfigurationElement) |
| ElementProperty |
Obtient l’objet ConfigurationElementProperty qui représente l’objet ConfigurationElement lui-même. (Hérité de ConfigurationElement) |
| EnableExport |
Obtient ou définit une valeur indiquant s’il faut activer l’exportation des données de contrôle vers un fichier de description XML. |
| EvaluationContext |
Obtient l'objet ContextInformation pour l'objet ConfigurationElement. (Hérité de ConfigurationElement) |
| HasContext |
Obtient une valeur qui indique si la propriété CurrentConfiguration est |
| Item[ConfigurationProperty] |
Obtient ou définit une propriété ou un attribut de cet élément de configuration. (Hérité de ConfigurationElement) |
| Item[String] |
Obtient ou définit une propriété, un attribut ou un élément enfant de cet élément de configuration. (Hérité de ConfigurationElement) |
| LockAllAttributesExcept |
Obtient la collection d’attributs verrouillés. (Hérité de ConfigurationElement) |
| LockAllElementsExcept |
Obtient la collection d’éléments verrouillés. (Hérité de ConfigurationElement) |
| LockAttributes |
Obtient la collection d’attributs verrouillés. (Hérité de ConfigurationElement) |
| LockElements |
Obtient la collection d’éléments verrouillés. (Hérité de ConfigurationElement) |
| LockItem |
Obtient ou définit une valeur indiquant si l’élément est verrouillé. (Hérité de ConfigurationElement) |
| Personalization |
Obtient un WebPartsPersonalization objet qui vous permet de spécifier le fournisseur de personnalisation de composants WebPart et de définir des autorisations de personnalisation de composants WebPart. |
| Properties |
Obtient la collection de propriétés. (Hérité de ConfigurationElement) |
| SectionInformation |
Obtient un SectionInformation objet qui contient les informations et fonctionnalités non personnalisables de l’objet ConfigurationSection . (Hérité de ConfigurationSection) |
| Transformers |
Obtient une collection d’objets TransformerInfo . |
Méthodes
| Nom | Description |
|---|---|
| DeserializeElement(XmlReader, Boolean) |
Lit le code XML à partir du fichier de configuration. (Hérité de ConfigurationElement) |
| DeserializeSection(XmlReader) |
Lit le code XML à partir du fichier de configuration. (Hérité de ConfigurationSection) |
| Equals(Object) |
Compare l’instance actuelle ConfigurationElement à l’objet spécifié. (Hérité de ConfigurationElement) |
| GetHashCode() |
Obtient une valeur unique représentant l’instance actuelle ConfigurationElement . (Hérité de ConfigurationElement) |
| GetRuntimeObject() |
Retourne un objet personnalisé en cas de substitution dans une classe dérivée. (Hérité de ConfigurationSection) |
| GetTransformedAssemblyString(String) |
Retourne la version transformée du nom d’assembly spécifié. (Hérité de ConfigurationElement) |
| GetTransformedTypeString(String) |
Retourne la version transformée du nom de type spécifié. (Hérité de ConfigurationElement) |
| GetType() |
Obtient la Type de l’instance actuelle. (Hérité de Object) |
| Init() |
Définit l’objet ConfigurationElement à son état initial. (Hérité de ConfigurationElement) |
| InitializeDefault() |
Permet d’initialiser un jeu de valeurs par défaut pour l’objet ConfigurationElement. (Hérité de ConfigurationElement) |
| IsModified() |
Indique si cet élément de configuration a été modifié depuis son dernier enregistrement ou chargé lors de l’implémentation dans une classe dérivée. (Hérité de ConfigurationSection) |
| IsReadOnly() |
Obtient une valeur indiquant si l’objet ConfigurationElement est en lecture seule. (Hérité de ConfigurationElement) |
| ListErrors(IList) |
Ajoute les erreurs de propriété non valides dans cet objet ConfigurationElement et, dans tous les sous-éléments, à la liste passée. (Hérité de ConfigurationElement) |
| MemberwiseClone() |
Crée une copie superficielle du Objectactuel. (Hérité de Object) |
| OnDeserializeUnrecognizedAttribute(String, String) |
Obtient une valeur indiquant si un attribut inconnu est rencontré lors de la désérialisation. (Hérité de ConfigurationElement) |
| OnDeserializeUnrecognizedElement(String, XmlReader) |
Obtient une valeur indiquant si un élément inconnu est rencontré lors de la désérialisation. (Hérité de ConfigurationElement) |
| OnRequiredPropertyNotFound(String) |
Lève une exception lorsqu’une propriété requise est introuvable. (Hérité de ConfigurationElement) |
| PostDeserialize() |
Appelé après la désérialisation. (Hérité de ConfigurationElement) |
| PreSerialize(XmlWriter) |
Appelé avant la sérialisation. (Hérité de ConfigurationElement) |
| Reset(ConfigurationElement) |
Réinitialise l’état interne de l’objet ConfigurationElement , y compris les verrous et les collections de propriétés. (Hérité de ConfigurationElement) |
| ResetModified() |
Réinitialise la valeur de la IsModified() méthode |
| SerializeElement(XmlWriter, Boolean) |
Écrit le contenu de cet élément de configuration dans le fichier de configuration en cas d’implémentation dans une classe dérivée. (Hérité de ConfigurationElement) |
| SerializeSection(ConfigurationElement, String, ConfigurationSaveMode) |
Crée une chaîne XML contenant une vue non fusionnée de l’objet ConfigurationSection sous la forme d’une section unique à écrire dans un fichier. (Hérité de ConfigurationSection) |
| SerializeToXmlElement(XmlWriter, String) |
Écrit les balises externes de cet élément de configuration dans le fichier de configuration en cas d’implémentation dans une classe dérivée. (Hérité de ConfigurationElement) |
| SetPropertyValue(ConfigurationProperty, Object, Boolean) |
Définit une propriété sur la valeur spécifiée. (Hérité de ConfigurationElement) |
| SetReadOnly() |
Définit la IsReadOnly() propriété de l’objet ConfigurationElement et de tous les sous-éléments. (Hérité de ConfigurationElement) |
| ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName) |
Indique si l’élément spécifié doit être sérialisé lorsque la hiérarchie d’objets de configuration est sérialisée pour la version cible spécifiée du .NET Framework. (Hérité de ConfigurationSection) |
| ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement) |
Indique si la propriété spécifiée doit être sérialisée lorsque la hiérarchie d’objets de configuration est sérialisée pour la version cible spécifiée du .NET Framework. (Hérité de ConfigurationSection) |
| ShouldSerializeSectionInTargetVersion(FrameworkName) |
Indique si l’instance ConfigurationSection actuelle doit être sérialisée lorsque la hiérarchie d’objets de configuration est sérialisée pour la version cible spécifiée du framework .NET. (Hérité de ConfigurationSection) |
| ToString() |
Retourne une chaîne qui représente l’objet actuel. (Hérité de Object) |
| Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) |
Modifie l’objet ConfigurationElement pour supprimer toutes les valeurs qui ne doivent pas être enregistrées. (Hérité de ConfigurationElement) |