Export (0) Print
Expand All

UrlMapping Class

Maps a URL that is displayed to users to the URL of a page in your Web application. This class cannot be inherited.

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

public sealed class UrlMapping : ConfigurationElement
public final class UrlMapping extends ConfigurationElement
public final class UrlMapping extends ConfigurationElement
Not applicable.

The UrlMapping class allows you to map a URL that is displayed to users to a URL that exists in your Web application. Adding a UrlMapping object to a UrlMappingCollection is the programmatic equivalent to including an add element in the urlMappings section of a configuration file.

Each UrlMapping object contains two properties identifying a URL. One property specifies the URL shown to the user; the other specifies a URL in your Web application. Trailing white-space characters are ignored in both the Url and MappedUrl properties.

NoteNote:

The UrlMapping property 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.

The following code example shows how to access all UrlMapping objects specified in the configuration file of an existing Web application.


StringBuilder allUrlMappings = new StringBuilder();

foreach (UrlMapping url_Mapping in urlMappings)
{

  shownUrl = url_Mapping.Url;

  mappedUrl = url_Mapping.MappedUrl;

  msg = String.Format(
        "Shown URL:  {0}\nMapped URL: {1}\n",
        shownUrl, mappedUrl);

  allUrlMappings.AppendLine(msg);
}


The following is a configuration file excerpt that shows the urlMappings section.

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

System.Object
   System.Configuration.ConfigurationElement
    System.Web.Configuration.UrlMapping

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

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft