SecurityPolicySection Class

Reference

Definition

Namespace:: System.Web.Configuration

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines configuration settings that are used to support the security infrastructure of a Web application. This class cannot be inherited.

public ref class SecurityPolicySection sealed : System::Configuration::ConfigurationSection

public sealed class SecurityPolicySection : System.Configuration.ConfigurationSection

type SecurityPolicySection = class
    inherit ConfigurationSection

Public NotInheritable Class SecurityPolicySection
Inherits ConfigurationSection

Inheritance: Object

ConfigurationElement

ConfigurationSection
SecurityPolicySection

Examples

This example demonstrates how to specify values declaratively within the securityPolicy section, which can also be accessed as members of the SecurityPolicySection class.

The following configuration file example shows how to specify values declaratively for the securityPolicy section.

<system.web>  
  <securityPolicy>  
    <trustLevel name="Full" policyFile="internal" />  
    <trustLevel name="High" policyFile="web_hightrust.config" />  
    <trustLevel name="Medium" policyFile="web_mediumtrust.config" />  
    <trustLevel name="Low" policyFile="web_lowtrust.config" />  
    <trustLevel name="Minimal" policyFile="web_minimaltrust.config" />  
  </securityPolicy>  
</system.web>

The following code example demonstrates how to use the SecurityPolicySection class.

#region Using directives

using System;
using System.Collections.Generic;
using System.Text;
using System.Configuration;
using System.Web;
using System.Web.Configuration;

#endregion

namespace Samples.Aspnet.SystemWebConfiguration
{
  class UsingSecurityPolicySection
  {
    static void Main(string[] args)
    {
      try
      {
        // Set the path of the config file.
        string configPath = "";

        // Get the Web application configuration object.
        Configuration config = 
          WebConfigurationManager.OpenWebConfiguration(configPath);

        // Get the section-related object.
        SecurityPolicySection configSection =
          (SecurityPolicySection)config.GetSection("system.web/securityPolicy");

        // Display title and info.
        Console.WriteLine("ASP.NET Configuration Info");
        Console.WriteLine();

        // Display Config details.
        Console.WriteLine("File Path: {0}",
          config.FilePath);
        Console.WriteLine("Section Path: {0}",
          configSection.SectionInformation.Name);

        // Display the number of trust levels.
        Console.WriteLine("TrustLevels Collection Count: {0}",
          configSection.TrustLevels.Count);

        // Display elements of the TrustLevels collection property.
        for (int i = 0; i < configSection.TrustLevels.Count; i++) 
        {
          Console.WriteLine();
          Console.WriteLine("TrustLevel {0}:", i);
          Console.WriteLine("Name: {0}", 
            configSection.TrustLevels.Get(i).Name);
          Console.WriteLine("Type: {0}", 
            configSection.TrustLevels.Get(i).PolicyFile);
        }

        // Add a TrustLevel element to the configuration file.
        configSection.TrustLevels.Add(new TrustLevel("myTrust", "mytrust.config"));

        // Update if not locked.
        if (!configSection.SectionInformation.IsLocked)
        {
          config.Save();
          Console.WriteLine("** Configuration updated.");
        }
        else
        {
          Console.WriteLine("** Could not update; section is locked.");
        }
      }

      catch (Exception e)
      {
        // Unknown error.
        Console.WriteLine(e.ToString());
      }

      // Display and wait
      Console.ReadLine();
    }
  }
}

Imports System.Collections.Generic
Imports System.Text
Imports System.Configuration
Imports System.Web
Imports System.Web.Configuration

Namespace Samples.Aspnet.SystemWebConfiguration
  Class UsingSecurityPolicySection
    Public Shared Sub Main()
      Try
        ' Set the path of the config file.
        Dim configPath As String = ""

        ' Get the Web application configuration object.
        Dim config As System.Configuration.Configuration = _
         System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration(configPath)

                ' Get the section-related object.
        Dim configSection As System.Web.Configuration.SecurityPolicySection = _
         CType(config.GetSection("system.web/securityPolicy"), _
         System.Web.Configuration.SecurityPolicySection)

        ' Display title and info.
        Console.WriteLine("ASP.NET Configuration Info")
        Console.WriteLine()

        ' Display Config details.
        Console.WriteLine("File Path: {0}", config.FilePath)
        Console.WriteLine("Section Path: {0}", configSection.SectionInformation.Name)

                ' Display the number of trust levels.
        Console.WriteLine("TrustLevels Collection Count: {0}", _
          configSection.TrustLevels.Count)

        ' Display elements of the TrustLevels collection property.
        For i As Integer = 0 To (configSection.TrustLevels.Count - 1)
          Console.WriteLine()
          Console.WriteLine("TrustLevel {0}:", i)
          Console.WriteLine("Name: {0}", _
           configSection.TrustLevels.Get(i).Name)
          Console.WriteLine("Type: {0}", _
           configSection.TrustLevels.Get(i).PolicyFile)
        Next i

        ' Add a TrustLevel element to the configuration file.
        configSection.TrustLevels.Add(New TrustLevel("myTrust", "mytrust.config"))

        ' Update if not locked.
        If Not configSection.SectionInformation.IsLocked Then
          config.Save()
          Console.WriteLine("** Configuration updated.")
        Else
                    Console.WriteLine("** Could not update; section is locked.")
        End If

      Catch e As Exception
        ' Unknown error.
        Console.WriteLine(e.ToString())
      End Try

      ' Display and wait
      Console.ReadLine()
    End Sub
  End Class
End Namespace

Remarks

The SecurityPolicySection class provides a way to programmatically access and modify the content of the securityPolicy section of the configuration file.

Constructors

SecurityPolicySection()

Initializes a new instance of the SecurityPolicySection class by using default settings.

Properties

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)
EvaluationContext	Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement)
HasContext	Gets a value that indicates whether the CurrentConfiguration property is `null`. (Inherited from ConfigurationElement)
Item[ConfigurationProperty]	Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement)
Item[String]	Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement)
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)
SectionInformation	Gets a SectionInformation object that contains the non-customizable information and functionality of the ConfigurationSection object. (Inherited from ConfigurationSection)
TrustLevels	Gets the TrustLevels collection.

Methods

DeserializeElement(XmlReader, Boolean)	Reads XML from the configuration file. (Inherited from ConfigurationElement)
DeserializeSection(XmlReader)	Reads XML from the configuration file. (Inherited from ConfigurationSection)
Equals(Object)	Compares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement)
GetHashCode()	Gets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement)
GetRuntimeObject()	Returns a custom object when overridden in a derived class. (Inherited from ConfigurationSection)
GetTransformedAssemblyString(String)	Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement)
GetTransformedTypeString(String)	Returns the transformed version of the specified type name. (Inherited from ConfigurationElement)
GetType()	Gets the Type of the current instance. (Inherited from Object)
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)
IsModified()	Indicates whether this configuration element has been modified since it was last saved or loaded when implemented in a derived class. (Inherited from ConfigurationSection)
IsReadOnly()	Gets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement)
ListErrors(IList)	Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnDeserializeUnrecognizedAttribute(String, String)	Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Gets a value indicating whether an unknown element is encountered during deserialization. (Inherited from ConfigurationElement)
OnRequiredPropertyNotFound(String)	Throws an exception when a required property is not found. (Inherited from ConfigurationElement)
PostDeserialize()	Called after deserialization. (Inherited from ConfigurationElement)
PreSerialize(XmlWriter)	Called before serialization. (Inherited from ConfigurationElement)
Reset(ConfigurationElement)	Resets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement)
ResetModified()	Resets the value of the IsModified() method to `false` when implemented in a derived class. (Inherited from ConfigurationSection)
SerializeElement(XmlWriter, Boolean)	Writes the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement)
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode)	Creates an XML string containing an unmerged view of the ConfigurationSection object as a single section to write to a file. (Inherited from ConfigurationSection)
SerializeToXmlElement(XmlWriter, String)	Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Sets a property to the specified value. (Inherited from ConfigurationElement)
SetReadOnly()	Sets the IsReadOnly() property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement)
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName)	Indicates whether the specified element should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. (Inherited from ConfigurationSection)
ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement)	Indicates whether the specified property should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. (Inherited from ConfigurationSection)
ShouldSerializeSectionInTargetVersion(FrameworkName)	Indicates whether the current ConfigurationSection instance should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. (Inherited from ConfigurationSection)
ToString()	Returns a string that represents the current object. (Inherited from Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement)

Applies to

Share via