Share via


ApplicationDefaults Class

Definition

Defines the default values for applications that are created for a Web site.

public ref class ApplicationDefaults sealed : Microsoft::Web::Administration::ConfigurationElement
public sealed class ApplicationDefaults : Microsoft.Web.Administration.ConfigurationElement
type ApplicationDefaults = class
    inherit ConfigurationElement
Public NotInheritable Class ApplicationDefaults
Inherits ConfigurationElement
Inheritance
ApplicationDefaults

Examples

The following example displays the default application values for each site.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Web.Administration;
using Microsoft.Web.Management;

namespace AdministrationSnippets
{
    public class AdministrationApplicationDefaults
    {
// Displays the default application values for all configured sites.
public void GetApplicationDefaults()
{
    ServerManager manager = new ServerManager();
    foreach (Site s in manager.Sites)
    {
        ApplicationDefaults d = s.ApplicationDefaults;
        Console.WriteLine("Site: {0}", s.Name);
        Console.WriteLine("  |--Default Application Pool:  {0}", 
            d.ApplicationPoolName);
        Console.WriteLine("  +--Default Protocols Enabled: {0}\r\n", 
            d.EnabledProtocols);
    }

}
    }
}

The following example sets the default values for applications created under the default Web site, creates a new application, and then verifies that the application properties are set to the default values.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Web.Administration;
using Microsoft.Web.Management;

namespace AdministrationSnippets
{
    public class AdministrationApplicationDefaults
    {
// Sets the default values for applications configured under the 
// default Web site.
public void SetApplicationDefaults()
{
    ServerManager manager = new ServerManager();
    Site defaultSite = manager.Sites["Default Web Site"];
    ApplicationDefaults defaultVals = defaultSite.ApplicationDefaults;

    // Set the application defaults.
    defaultVals.ApplicationPoolName = "CommunitySites";
    defaultVals.EnabledProtocols = "http";
    
    // Create a new application.
    defaultSite.Applications.Add(
        "/discussion", @"C:\inetpub\wwwroot\forums");
    manager.CommitChanges();

    // Read the application's values.
    Application discussion = defaultSite.Applications["/discussion"];
    Console.WriteLine("Site: {0}", defaultSite.Name);
    Console.WriteLine("  |--Default Application Pool:  {0}", 
        discussion.ApplicationPoolName);
    Console.WriteLine("  +--Default Protocols Enabled: {0}\r\n", 
        discussion.EnabledProtocols);
}
    }
}

Remarks

This class is sealed and does not implement a public constructor. You can access an instance of the ApplicationDefaults class through the ApplicationDefaults property of the Site class.

Properties

ApplicationPoolName

Gets or sets the application pool that is assigned by default to all applications under the current Web site.

Attributes

Gets a configuration attribute collection that contains the list of attributes for this element.

(Inherited from ConfigurationElement)
ChildElements

Gets all the child elements of the current element.

(Inherited from ConfigurationElement)
ElementTagName (Inherited from ConfigurationElement)
EnabledProtocols

Gets or sets the protocols that are enabled by default for all applications under the current Web site.

IsLocallyStored

Gets a value indicating whether the configuration element is stored in a particular configuration file.

(Inherited from ConfigurationElement)
Item[String]

Gets or sets an attribute with the specified name.

(Inherited from ConfigurationElement)
Methods

Gets a collection of methods for the configuration element.

(Inherited from ConfigurationElement)
RawAttributes (Inherited from ConfigurationElement)
Schema

Gets the schema for the current element.

(Inherited from ConfigurationElement)

Methods

Delete() (Inherited from ConfigurationElement)
GetAttribute(String)

Returns a ConfigurationAttribute object that represents the requested attribute.

(Inherited from ConfigurationElement)
GetAttributeValue(String)

Returns the value of the specified attribute.

(Inherited from ConfigurationElement)
GetChildElement(String, Type)

Returns a child element that is under the current configuration element and has the specified name and type.

(Inherited from ConfigurationElement)
GetChildElement(String)

Returns a child element that is under the current configuration element and has the specified name.

(Inherited from ConfigurationElement)
GetCollection()

Returns the default collection for the current configuration element.

(Inherited from ConfigurationElement)
GetCollection(String, Type)

Returns the configuration element that has the specified name and type and is under the current configuration element.

(Inherited from ConfigurationElement)
GetCollection(String)

Returns all configuration elements that belong to the current configuration element.

(Inherited from ConfigurationElement)
GetCollection(Type)

Returns the configuration element that has the specified type and is under the current configuration element.

(Inherited from ConfigurationElement)
GetMetadata(String)

Returns metadata values from the element schema.

(Inherited from ConfigurationElement)
SetAttributeValue(String, Object)

Sets the value of the specified attribute.

(Inherited from ConfigurationElement)
SetMetadata(String, Object)

Sets metadata values from the element schema.

(Inherited from ConfigurationElement)

Applies to