WebPartsSection Klasa
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Zapewnia dostęp programowy do webParts sekcji pliku konfiguracji. Klasa ta nie może być dziedziczona.
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
- Dziedziczenie
Przykłady
W tym przykładzie pokazano, jak deklaratywnie określić wartości dla kilku atrybutów webParts sekcji, do których można również uzyskać dostęp jako elementy członkowskie WebPartsSection klasy.
W poniższym przykładzie pliku konfiguracji pokazano, jak deklaratywnie określić wartości dla webParts sekcji.
<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>
W poniższym przykładzie kodu pokazano, jak używać WebPartsSection klasy .
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
Uwagi
Sekcja webParts pliku konfiguracji umożliwia określenie dostawcy personalizacji składników Web Part, ustawienie autoryzacji personalizacji i dodanie klas niestandardowych rozszerzających klasę WebPartTransformer do użycia przez połączenia składników Web Part.
Konstruktory
| Nazwa | Opis |
|---|---|
| WebPartsSection() |
Inicjuje WebPartsSection nowe wystąpienie klasy przy użyciu ustawień domyślnych. |
Właściwości
| Nazwa | Opis |
|---|---|
| CurrentConfiguration |
Pobiera odwołanie do wystąpienia najwyższego poziomu Configuration, które reprezentuje hierarchię konfiguracji, do którego należy bieżące wystąpienie ConfigurationElement. (Odziedziczone po ConfigurationElement) |
| ElementInformation |
Pobiera obiekt ElementInformation zawierający informacje i funkcje obiektu ConfigurationElement, które nie można dostosowywać. (Odziedziczone po ConfigurationElement) |
| ElementProperty |
Pobiera obiekt ConfigurationElementProperty reprezentujący sam obiekt ConfigurationElement. (Odziedziczone po ConfigurationElement) |
| EnableExport |
Pobiera lub ustawia wartość wskazującą, czy umożliwić eksportowanie danych kontrolnych do pliku opisu XML. |
| EvaluationContext |
Pobiera obiekt ContextInformation dla obiektu ConfigurationElement. (Odziedziczone po ConfigurationElement) |
| HasContext |
Pobiera wartość wskazującą, czy właściwość CurrentConfiguration jest |
| Item[ConfigurationProperty] |
Pobiera lub ustawia właściwość lub atrybut tego elementu konfiguracji. (Odziedziczone po ConfigurationElement) |
| Item[String] |
Pobiera lub ustawia właściwość, atrybut lub element podrzędny tego elementu konfiguracji. (Odziedziczone po ConfigurationElement) |
| LockAllAttributesExcept |
Pobiera kolekcję zablokowanych atrybutów. (Odziedziczone po ConfigurationElement) |
| LockAllElementsExcept |
Pobiera kolekcję zablokowanych elementów. (Odziedziczone po ConfigurationElement) |
| LockAttributes |
Pobiera kolekcję zablokowanych atrybutów. (Odziedziczone po ConfigurationElement) |
| LockElements |
Pobiera kolekcję zablokowanych elementów. (Odziedziczone po ConfigurationElement) |
| LockItem |
Pobiera lub ustawia wartość wskazującą, czy element jest zablokowany. (Odziedziczone po ConfigurationElement) |
| Personalization |
WebPartsPersonalization Pobiera obiekt, który umożliwia określenie dostawcy personalizacji składników Web Part i ustawienie autoryzacji personalizacji składników Web Part. |
| Properties |
Pobiera kolekcję właściwości. (Odziedziczone po ConfigurationElement) |
| SectionInformation |
Pobiera obiekt SectionInformation zawierający informacje i funkcje obiektu ConfigurationSection, które nie można dostosowywać. (Odziedziczone po ConfigurationSection) |
| Transformers |
Pobiera kolekcję TransformerInfo obiektów. |
Metody
| Nazwa | Opis |
|---|---|
| DeserializeElement(XmlReader, Boolean) |
Odczytuje kod XML z pliku konfiguracji. (Odziedziczone po ConfigurationElement) |
| DeserializeSection(XmlReader) |
Odczytuje kod XML z pliku konfiguracji. (Odziedziczone po ConfigurationSection) |
| Equals(Object) |
Porównuje bieżące wystąpienie ConfigurationElement z określonym obiektem. (Odziedziczone po ConfigurationElement) |
| GetHashCode() |
Pobiera unikatową wartość reprezentującą bieżące wystąpienie ConfigurationElement. (Odziedziczone po ConfigurationElement) |
| GetRuntimeObject() |
Zwraca obiekt niestandardowy podczas zastępowania w klasie pochodnej. (Odziedziczone po ConfigurationSection) |
| GetTransformedAssemblyString(String) |
Zwraca przekształconą wersję określonej nazwy zestawu. (Odziedziczone po ConfigurationElement) |
| GetTransformedTypeString(String) |
Zwraca przekształconą wersję określonej nazwy typu. (Odziedziczone po ConfigurationElement) |
| GetType() |
Pobiera Type bieżącego wystąpienia. (Odziedziczone po Object) |
| Init() |
Ustawia obiekt ConfigurationElement na stan początkowy. (Odziedziczone po ConfigurationElement) |
| InitializeDefault() |
Służy do inicjowania domyślnego zestawu wartości dla obiektu ConfigurationElement. (Odziedziczone po ConfigurationElement) |
| IsModified() |
Wskazuje, czy ten element konfiguracji został zmodyfikowany od czasu ostatniego zapisania, czy załadowany podczas implementacji w klasie pochodnej. (Odziedziczone po ConfigurationSection) |
| IsReadOnly() |
Pobiera wartość wskazującą, czy obiekt ConfigurationElement jest tylko do odczytu. (Odziedziczone po ConfigurationElement) |
| ListErrors(IList) |
Dodaje błędy nieprawidłowej właściwości w tym obiekcie ConfigurationElement i we wszystkich elementach podrzędnych do przekazanej listy. (Odziedziczone po ConfigurationElement) |
| MemberwiseClone() |
Tworzy płytkią kopię bieżącego Object. (Odziedziczone po Object) |
| OnDeserializeUnrecognizedAttribute(String, String) |
Pobiera wartość wskazującą, czy podczas deserializacji napotkano nieznany atrybut. (Odziedziczone po ConfigurationElement) |
| OnDeserializeUnrecognizedElement(String, XmlReader) |
Pobiera wartość wskazującą, czy podczas deserializacji napotkano nieznany element. (Odziedziczone po ConfigurationElement) |
| OnRequiredPropertyNotFound(String) |
Zgłasza wyjątek, gdy nie można odnaleźć wymaganej właściwości. (Odziedziczone po ConfigurationElement) |
| PostDeserialize() |
Wywoływana po deserializacji. (Odziedziczone po ConfigurationElement) |
| PreSerialize(XmlWriter) |
Wywoływana przed serializacji. (Odziedziczone po ConfigurationElement) |
| Reset(ConfigurationElement) |
Resetuje stan wewnętrzny obiektu ConfigurationElement, w tym blokady i kolekcje właściwości. (Odziedziczone po ConfigurationElement) |
| ResetModified() |
Resetuje wartość metody IsModified(), aby |
| SerializeElement(XmlWriter, Boolean) |
Zapisuje zawartość tego elementu konfiguracji w pliku konfiguracji po zaimplementowaniu w klasie pochodnej. (Odziedziczone po ConfigurationElement) |
| SerializeSection(ConfigurationElement, String, ConfigurationSaveMode) |
Tworzy ciąg XML zawierający niezaergowany widok obiektu ConfigurationSection jako pojedynczą sekcję do zapisu w pliku. (Odziedziczone po ConfigurationSection) |
| SerializeToXmlElement(XmlWriter, String) |
Zapisuje zewnętrzne tagi tego elementu konfiguracji do pliku konfiguracji po zaimplementowaniu w klasie pochodnej. (Odziedziczone po ConfigurationElement) |
| SetPropertyValue(ConfigurationProperty, Object, Boolean) |
Ustawia właściwość na określoną wartość. (Odziedziczone po ConfigurationElement) |
| SetReadOnly() |
Ustawia właściwość IsReadOnly() dla obiektu ConfigurationElement i wszystkich podelementów. (Odziedziczone po ConfigurationElement) |
| ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName) |
Wskazuje, czy określony element powinien być serializowany, gdy hierarchia obiektów konfiguracji jest serializowana dla określonej wersji docelowej platformy .NET. (Odziedziczone po ConfigurationSection) |
| ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement) |
Wskazuje, czy określona właściwość powinna być serializowana, gdy hierarchia obiektów konfiguracji jest serializowana dla określonej wersji docelowej programu .NET Framework. (Odziedziczone po ConfigurationSection) |
| ShouldSerializeSectionInTargetVersion(FrameworkName) |
Wskazuje, czy bieżące wystąpienie ConfigurationSection powinno być serializowane, gdy hierarchia obiektów konfiguracji jest serializowana dla określonej wersji docelowej programu .NET Framework. (Odziedziczone po ConfigurationSection) |
| ToString() |
Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object) |
| Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) |
Modyfikuje obiekt ConfigurationElement, aby usunąć wszystkie wartości, które nie powinny być zapisywane. (Odziedziczone po ConfigurationElement) |