MMCCtrl.GetTitle method

The GetTitle method returns the string to be used for the taskpad's title.

Syntax

MMCCtrl.GetTitle( _
  ByVal szGroupText _
)

Parameters

szGroupText [in]

A string that contains the group name that identifies the taskpad. The group name is the string that follows the hash (#) in the string passed in the ppViewType parameter when MMC called IComponent::GetResultViewType to display the taskpad. If no group name was specified, szGroupText is an empty string.

Be aware that the group name is stored in the hash property of the ___location object of the taskpad's HTML page. See the following example.

Return value

String that contains the taskpad title.

Examples

The following code example gets the title string by calling the GetTitle method on an MMCCtrl control with an ID of taskctrl:

var mszTaskpadTitle;
var hash = ___location.hash;
if (hash != "") {
    hash = hash.substr(1);
}
 
// get taskpad title
mszTaskpadTitle = taskctrl.GetTitle (hash);

Requirements