IExtendTaskPad interface

The IExtendTaskPad interface is introduced in MMC 1.1.

The IExtendTaskPad interface enables a snap-in component to set up a taskpad and receive notifications from the taskpad.

When to implement

Implement this interface in your in-process server DLL to add one or more taskpads to a snap-in component.

If you implement the IExtendTaskPad interface to display one or more taskpads for your snap-in's scope items, you must implement this interface in the IComponent object. For more information about implementing IExtendTaskPad for taskpad extension snap-ins, see Using Taskpads.

You must also implement the IEnumTASK interface to specify the tasks you want to add to a taskpad.

If your snap-in owns the scope item that displays the taskpad, IExtendTaskPad is used by MMC to set up the taskpad, to get a pointer to the IEnumTASK interface, and to send notifications from the taskpad to your snap-in. To display the task in taskpads for your snap-in's items, you must also load the taskpad by specifying the taskpad template in IComponent::GetResultViewType.

If your snap-in is a taskpad extension, IExtendTaskPad is used by MMC to get a pointer to the IEnumTASK interface and to send notifications from the taskpad to your snap-in. Be aware that the snap-in that owns the scope item that is that displays the taskpad is responsible for loading the taskpad template and setting up the taskpad through its own IExtendTaskPad methods.

For more information, see Using Taskpads.

When to use

Only MMC calls this interface.

When the taskpad DHTML page is loaded, the MMCCtrl control on that page calls methods in MMC. In turn, MMC attempts to get the IExtendTaskPad from the IComponent object and calls the methods required to provide the MMCCtrl control with the data required to render the taskpad's general elements: title text, banner image, and background image. If MMC cannot get a pointer to the IExtendTaskPad interface on your snap-in, the taskpad is not displayed.

If the taskpad is a list-view taskpad, MMC calls IExtendTaskPad::GetListPadInfo to get the title text for the list control, text for an optional button, and the command ID passed to IExtendTaskPad::TaskNotify when the button is clicked.

MMC calls the IExtendTaskPad::EnumTasks method to get a pointer to the IEnumTASK interface of an object that specifies the tasks your snap-in must add to the taskpad. If a taskpad extension snap-in has been added to your snap-in, MMC gets a pointer to the IExtendTaskPad interface on that snap-in and calls the IExtendTaskPad::EnumTasks method to get a pointer to the IEnumTASK interface for that snap-in.

MMC calls the IExtendTaskPad::TaskNotify method to notify the snap-in when a task or a list-view button has been clicked. The list-view button applies only to list-view taskpads — it is the optional button specified in the IExtendTaskPad::GetListPadInfo method. The command ID for the specific task or list-view button is passed as a VARIANT.

Members

The IExtendTaskPad interface inherits from the IUnknown interface. IExtendTaskPad also has these types of members:

Methods

The IExtendTaskPad interface has these methods.

MethodDescription
EnumTasks

Enables MMC to get a pointer to the IEnumTASK interface of the object that contains the snap-in's tasks.

GetBackground

Enables MMC to get the taskpad's background image.

GetDescriptiveText

Enables MMC to get the taskpad's descriptive text, which is displayed beneath the title.

GetListPadInfo

Used for list-view taskpads only. Enables MMC to get the title text for the list control, text for an optional button, and the command ID passed to IExtendTaskPad::TaskNotify when the button is clicked.

GetTitle

Enables MMC to get the taskpad's title text.

TaskNotify

Enables MMC to notify the snap-in when a task is clicked. If the taskpad is a list-view taskpad, MMC also calls TaskNotify when a list-view button is clicked.

 

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Header

Mmc.h

 

 

Show: