HierarchyService Class

Definition

public ref class HierarchyService abstract

public abstract class HierarchyService

type HierarchyService = class

Public MustInherit Class HierarchyService

Inheritance

Object

HierarchyService

Examples

The following example demonstrates most of the events and methods of the HierarchyService class.

    {
    private HierarchyService _hierarchyService;

    public DemoHierarchyProvider(IServiceProvider serviceProvider)
        : base(serviceProvider) {
        // Register the provider
        _hierarchyService = (HierarchyService)GetService(typeof(HierarchyService));

        // Refer to the customized events
        _hierarchyService.InfoRefreshed += new HierarchyInfoEventHandler(OnHierarchServiceInfoRefreshed);
        _hierarchyService.InfoCollapsed += new HierarchyInfoEventHandler(OnHierarchServiceInfoCollapsed);
        _hierarchyService.InfoExpanded += new HierarchyInfoEventHandler(OnHierarchServiceInfoExpanded);
        _hierarchyService.ChildrenAdded += new HierarchyCollectionEventHandler(OnHierarchServiceChildrenAdded);
        _hierarchyService.InfoRemoved += new HierarchyInfoEventHandler(OnHierarchServiceInfoRemoved);

    }
    // Add these customized events
    // The InfoRefreshed event.
    private void OnHierarchServiceInfoRefreshed(object sender, HierarchyInfoEventArgs e) {
        MessageBox.Show(e.HierarchyInfo.Text + " refreshed");
    }

    // The InfoCollapsed event.
    private void OnHierarchServiceInfoCollapsed(object sender, HierarchyInfoEventArgs e) {
        MessageBox.Show(e.HierarchyInfo.Text + " collapsed");
    }

    // The InfoExpanded event.
    private void OnHierarchServiceInfoExpanded(object sender, HierarchyInfoEventArgs e) {
        string message;
        message = e.HierarchyInfo.Text + " expanded";
        message = message + "\nchild node of " + e.HierarchyInfo.Parent.Text;
        MessageBox.Show(message);
    }

    // The ChildrenAdded event.
    private void OnHierarchServiceChildrenAdded(object sender, HierarchyCollectionEventArgs e) {
        MessageBox.Show(e.HierarchyInfo.Text + " has added a child.");
    }

    // The InfoRemoved event.
    private void OnHierarchServiceInfoRemoved(object sender, HierarchyInfoEventArgs e) {
        MessageBox.Show(e.HierarchyInfo.Text + " removed");
    }

    public override HierarchyInfo[] GetChildren(HierarchyInfo item) {
        if (item.NodeType == HierarchyInfo.ServerConnection) {
            return new HierarchyInfo[] { new DemoHierarchyInfo(this) };
        }

        return null;
    }

    internal class DemoHierarchyInfo : HierarchyInfo {

        public DemoHierarchyInfo(IServiceProvider serviceProvider)
            : base(serviceProvider) {
        }

        public override string NodeType {
            get {
                return "DemoHierarchyInfo";
            }
        }

        public override bool SupportsChildren {
            get {
                return false;
            }
        }

        public override string Text {
            get {
                return "Demo Page";
            }
        }

        protected override bool OnSelected() {
            return Navigate(typeof(DemoPage));
        }
    }
} 

Remarks

You can get a reference to a HierarchyService object through a service provider. You can use the HierarchyService to handle the tree programmatically, exposing methods to perform actions such as expanding or collapsing a node, selecting a node, and refreshing a node.

The hierarchy is displayed in the Connections pane of IIS Manager. This class provides the extensibility features of the hierarchy tree.

The members of this abstract class are empty. This class exists as a convenience for creating HierarchyService objects.

The HierarchyInfo object represents a node in the Connections pane and is a key object in the HierarchyService class.

Constructors

Properties

Methods

Events

Applies to