IControlPanel Interface

Reference

Definition

Namespace:: Microsoft.Web.Management.Client

Assembly:: Microsoft.Web.Management.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.

Provides functionality for managing the list of features available in the connection.

public interface class IControlPanel

public interface IControlPanel

type IControlPanel = interface

Public Interface IControlPanel

Examples

The following example registers a feature in the Home page for a connection.

internal class DemoModule :
    Microsoft.Web.Management.Client.Module {

    protected override void Initialize(
        IServiceProvider serviceProvider,
        ModuleInfo moduleInfo) {
        base.Initialize(serviceProvider, moduleInfo);
        IControlPanel cp =
            (IControlPanel)GetService(typeof(IControlPanel));
        ModulePageInfo modulePageInfo = new ModulePageInfo(
            this,
            typeof(DemoPage),
            "My Page Title 4",
            "My Page Description 4",
            rLoadImg.loadImgs("rSmall.bmp"),   // small image
            rLoadImg.loadImgs("rLarge.bmp"),  // large image
            "My Page long description 4"     // long description
            );

        cp.RegisterPage(modulePageInfo);

        // Register the Category as
        // Application Development
        string s = 
            ControlPanelCategoryInfo.ApplicationDevelopment;
        cp.RegisterPage(s, modulePageInfo);

        // Register the Area as IIS
        s = ControlPanelCategoryInfo.Iis;
        cp.RegisterPage(s, modulePageInfo);
      //  cp.RegisterHomepage(modulePageInfo);

    }
}

Remarks

The IControlPanel interface exposes all the methods required to interact with the Home page of each connection object in IIS Manager. These methods enable you to perform such actions as registering pages, adding new categories, and getting the list of pages.

The IControlPanel methods and properties are scoped to a single connection. A module should use this interface at initialization to register features for display in the connection's Home page.

Properties

Categorizations	Gets the collection of categories that have been registered for the Home page of a connection in IIS Manager.
ControlPanelPage	Gets the ModulePageInfo object that represents the Home page of a connection in IIS Manager.
Pages	Gets the collection of items registered by a specific module.

Methods

GetCategories(String)	Retrieves the set of categories that are registered for the specified category type.
GetCategory(String, ModulePageInfo)	Retrieves the Home page category of the feature that is associated with the specified category string.
GetPage(Type)	Retrieves the feature that has the specified type.
GetPages(Module)	Retrieves the collection of features that are registered in the specified module.
GetPages(String, String)	Retrieves the collection of features that are registered in the specified category.
RegisterCategory(ControlPanelCategoryInfo)	Registers a new category of features in the Home page.
RegisterHomepage(ModulePageInfo)	Registers the Home page that is associated with the connection.
RegisterPage(ModulePageInfo)	Registers a new feature with the Home page without categorizing it.
RegisterPage(String, ModulePageInfo)	Registers a new item in a Home page category.

Applies to

Share via