UrlMappingsSection Class (System.Web.Configuration)

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

UrlMappingsSection Class

Provides programmatic access to the urlMappings configuration section. This class cannot be inherited.

Namespace: System.Web.Configuration
Assembly: System.Web (in System.Web.dll)

Syntax

Visual Basic (Declaration)

Public NotInheritable Class UrlMappingsSection _
    Inherits ConfigurationSection

Visual Basic (Usage)

Dim instance As UrlMappingsSection

public sealed class UrlMappingsSection : ConfigurationSection

Visual C++

public ref class UrlMappingsSection sealed : public ConfigurationSection

JScript

public final class UrlMappingsSection extends ConfigurationSection

Remarks

The UrlMappingsSection class provides a way to programmatically access and modify the urlMappings section of a configuration file.

Note:
The urlMappings section contains UrlMapping objects that map URLs that are displayed to users to URLs that exist in your Web application. The UrlMappingsSection can write information into the related section of the configuration file according to the restrictions defined by the section property AllowDefinition whose value is MachineToApplication. Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy.

Note:

The urlMappings section contains UrlMapping objects that map URLs that are displayed to users to URLs that exist in your Web application. The UrlMappingsSection can write information into the related section of the configuration file according to the restrictions defined by the section property AllowDefinition whose value is MachineToApplication. Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy.

Examples

The following code example shows how to obtain the UrlMappingsSection object from the configuration file of an existing Web application. Also shown is an excerpt of the configuration file.

Visual Basic

' Get the Web application configuration.
Dim configuration _
As System.Configuration.Configuration = _
WebConfigurationManager.OpenWebConfiguration( _
"/aspnetTest")

' Get the <urlMapping> section.
Dim urlMappingSection _
As UrlMappingsSection = _
CType(configuration.GetSection( _
"system.web/urlMappings"), UrlMappingsSection)

' Get the url mapping collection.
Dim urlMappings _
As UrlMappingCollection = _
urlMappingSection.UrlMappings

// Get the Web application configuration.
System.Configuration.Configuration configuration =
    WebConfigurationManager.OpenWebConfiguration(
    "/aspnetTest");

// Get the <urlMapping> section.
UrlMappingsSection urlMappingSection =
  (UrlMappingsSection)configuration.GetSection(
  "system.web/urlMappings");


// Get the url mapping collection.
UrlMappingCollection urlMappings =
  urlMappingSection.UrlMappings;

<urlMappings enabled="true">
  <add url= "~/home.aspx"
    mappedUrl="~/default.aspx?parm1=1"/>
  <add url= "~/products.aspx"
    mappedUrl="~/default.aspx?parm1=2"/>
</urlMappings>

Inheritance Hierarchy

System..::.Object
  System.Configuration..::.ConfigurationElement
    System.Configuration..::.ConfigurationSection
      System.Web.Configuration..::.UrlMappingsSection

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

UrlMappingsSection Members

System.Web.Configuration Namespace

UrlMapping

UrlMappingsSection

Other Resources

urlMappings Element (ASP.NET Settings Schema)