ModulePageInfo Class

Definition

Represents a page of user interface for a module.

public ref class ModulePageInfo sealed
public sealed class ModulePageInfo
type ModulePageInfo = class
Public NotInheritable Class ModulePageInfo
Inheritance
ModulePageInfo

Examples

The following example creates a ModulePageInfo instance and registers it by using the Microsoft.Web.Management.Client.IControlPanel.RegisterPage method.

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

    protected override void Initialize(
        IServiceProvider serviceProvider, ModuleInfo moduleInfo) 
    {

        base.Initialize(serviceProvider, moduleInfo);
        Trace.WriteLine(" ClientModuleTypeName : " + 
            moduleInfo.ClientModuleTypeName);
        Trace.WriteLine(" Name : " + moduleInfo.Name);
        
        // Clear the trace window.
        resetTrace();

        IControlPanel controlPanel = 
            (IControlPanel)GetService(typeof(IControlPanel));
        ModulePageInfo modPgInfo = getModulePage();

        controlPanel.RegisterPage(modPgInfo);
        controlPanel.RegisterPage(
            ControlPanelCategoryInfo.HealthAndDiagnostics, modPgInfo);

Remarks

A ModulePageInfo object is used to register an item in the control panel of the connection and for navigation. The ModulePageInfo instance is typically created in the Microsoft.Web.Management.Client.Module.Initialize method.

Constructors

ModulePageInfo(Module, Type, String)

Initializes a new instance of the ModulePageInfo class, using the specified module, type, and title.

ModulePageInfo(Module, Type, String, String)

Initializes a new instance of the ModulePageInfo class, using the specified module, type, title, and description.

ModulePageInfo(Module, Type, String, String, Object, Object)

Initializes a new instance of the ModulePageInfo class, using the specified module, type, title, description, and images.

ModulePageInfo(Module, Type, String, String, Object, Object, String)

Initializes a new instance of the ModulePageInfo class, using the specified module, type, title, description, images, and long description.

Properties

AssociatedModule

Gets the module associated with the page.

Description

Gets the description of the page.

IsEnabled

Gets a value indicating whether the associated module is enabled.

LargeImage

Gets the large image associated with the page.

LongDescription

Gets the long description associated with the page.

PageType

Gets the type of the page.

SmallImage

Gets the small image that is associated with the page.

Title

Gets the title of the page.

Methods

Equals(Object)

Determines whether the specified object is equal to the current ModulePageInfo.

GetHashCode()

Returns a hash code for the page.

Applies to