Shell Helper API Reference

This section contains reference articles available for the IShellUIHelper API.

Methods

IShellUIHelper::AddChannel

Obsolete. Presents a dialog box that enables the user to add the specified channel, or to change the channel URL, if it is already installed.

IShellUIHelper::AddDesktopComponent

Adds a Web site or image to the Microsoft Active Desktop.

IShellUIHelper::AddFavorite

Prompts the user with a dialog box to add the specified URL to the Favorites list.

IShellUIHelper2::AddSearchProvider

Adds a search provider to the registry.

IShellUIHelper3::AddService

User initiated action to add a service.

IShellUIHelper3::AddToFavoritesBar

Adds a URL to the Favorites Bar.

IShellUIHelper::AutoCompleteSaveForm

Saves the specified form in the AutoComplete data store.

IShellUIHelper::AutoScan

No longer available as of Windows Internet Explorer 7. Attempts to connect to a Web server by passing the specified query through completion templates.

IShellUIHelper2::BrandImageUri

Not supported. Retrieves the Uniform Resource Identifier (URI) of an alternate product image.

IShellUIHelper3::BuildNewTabPage

Not supported. Check user's settings to show tab list and/or activities list.

IShellUIHelper3::ContentDiscoveryReset

Resets the list of feeds, search providers, and Web Slices associated with the page.

IShellUIHelper2::CustomizeClearType

Not supported. Sets a registry value to turn ClearType on or off.

IShellUIHelper2::CustomizeSettings

Not supported. Saves the user settings from a "first run" page.

IShellUIHelper2::DefaultSearchProvider

Not supported. Retrieves the name of the user's default search provider.

IShellUIHelper2::DiagnoseConnection

Not supported. Attempts to diagnose problems with the network connection.

IShellUIHelper3::EnableSuggestedSites

Not supported. Enables or disables Suggested Sites feature from a Web page.

IShellUIHelper::ImportExportFavorites

Deprecated. Handles the import and export of Internet Explorer favorites.

IShellUIHelper3::InPrivateFilteringEnabled

Detects whether the user has enabled InPrivate Filtering.

IShellUIHelper2::IsSearchMigrated

Not supported. Determines whether autosearch settings were migrated from a previous version of Internet Explorer.

IShellUIHelper2::IsSearchProviderInstalled

Determines if a search provider has been installed for the current user and whether it is set as default.

IShellUIHelper3::IsServiceInstalled

Check if a service is already installed.

IShellUIHelper::IsSubscribed

Obsolete. Retrieves a value indicating whether the client subscribes to the given channel.

IShellUIHelper3::IsSuggestedSitesEnabled

Not supported. Determines whether Suggested Sites feature is enabled.

IShellUIHelper4::msActiveXFilteringEnabled

Determines whether Microsoft ActiveX Filtering is enabled by the user.

IShellUIHelper4::msAddSiteMode

Creates a pinned site shortcut to the current webpage on the Windows Start menu.

IShellUIHelper4::msAddTrackingProtectionList

Adds an external Tracking Protection list.

IShellUIHelper4::msIsSiteMode

Determines whether the current page was launched as a pinned site.

IShellUIHelper4::msIsSiteModeFirstRun

Determines whether a pinned site was launched for the first time.

IShellUIHelper4::msSiteModeActivate

Flashes the pinned site taskbar button.

IShellUIHelper4::msSiteModeAddButtonStyle

Defines an alternate icon image and tooltip for the specified button.

IShellUIHelper4::msSiteModeAddJumpListItem

Adds a new entry to the Jump List of a taskbar button.

IShellUIHelper4::msSiteModeAddThumbBarButton

Adds a button to the Thumbnail Toolbar.

IShellUIHelper4::msSiteModeClearIconOverlay

Removes the icon overlay from the taskbar button.

IShellUIHelper4::msSiteModeClearJumpList

Deletes the Jump List.

IShellUIHelper4::msSiteModeCreateJumpList

Creates a new group of items on the Jump List.

IShellUIHelper4::msSiteModeSetIconOverlay

Adds an icon overlay to the pinned site taskbar button.

IShellUIHelper4::msSiteModeShowButtonStyle

Changes the icon image and tooltip of a Thumbnail Toolbar button.

IShellUIHelper4::msSiteModeShowJumpList

Shows updates to the list of items in a Jump List.

IShellUIHelper4::msSiteModeShowThumbBar

Enables the Thumbnail Toolbar in the thumbnail preview of a pinned site.

IShellUIHelper4::msSiteModeUpdateThumbBarButton

Changes the state of a Thumbnail Toolbar button.

IShellUIHelper4::msTrackingProtectionEnabled

Determines whether any Tracking Protection lists are enabled by the user.

IShellUIHelper::NavigateAndFind

Navigates to the specified URL and selects the specified text.

Navigates to the specified URL and selects the specified text.IShellUIHelper3::NavigateToSuggestedSites

Not supported. Initiates a navigation request to Suggested Sites service that includes recent entries from browser history.

IShellUIHelper2::PhishingEnabled

Not supported. Determines whether Microsoft Phishing Filter is enabled.

IShellUIHelper2::RunOnceHasShown

Not supported. Determines whether the "first run" page has been shown.

IShellUIHelper2::RunOnceRequiredSettingsComplete

Not supported. Sets a registry value to indicate whether the "first run" page completed successfully.

IShellUIHelper2::RunOnceShown

Not supported. Sets a registry value to indicate that the "first run" page has been shown.

IShellUIHelper2::SearchGuideUrl

Not supported. Retrieves the URL of a page that can be used to install additional search providers.

IShellUIHelper3::SetActivitiesVisible

Not supported. A setting that notifies the IShellUIHelper3::BuildNewTabPage method whether to show or hide the activities list.

IShellUIHelper3::SetRecentlyClosedVisible

Not supported. A setting that notifies the IShellUIHelper3::BuildNewTabPage method whether to show or hide the list of recently closed tabs.

IShellUIHelper::ShowBrowserUI

Opens the specified browser dialog box.

IShellUIHelper3::ShowTabsHelp

Not supported. Display the product help dialog box for the New Tab page in Internet Explorer.

IShellUIHelper2::SkipRunOnce

Not supported. Enables the user to select "first run" settings at a later time.

IShellUIHelper2::SkipTabsWelcome

Not supported. Disables the welcome screen that appears when opening a new tab in Internet Explorer 7.

IShellUIHelper2::SqmEnabled

Not supported. Determines whether Software Quality Monitoring (SQM) is enabled.

Not supported. Determines whether SQM is enabled.

Functions

AddUrlToFavorites

Adds a favorite. Use for backward compatibility only.

DoAddToFavDlg

Displays the standard Internet Explorer

DoOrganizeFavDlg

Displays the standard Internet Explorer

Interfaces

IShellUIHelper

Provides access to features available in the Windows Shell API.

IShellUIHelper2

Extends IShellUIHelper to add support for custom search providers and scriptable "first run" settings.

IShellUIHelper3

Extends IShellUIHelper2 to add support for Internet Explorer 8.

IShellUIHelper4

Extends IShellUIHelper3 with methods that support pinned sites.

Objects

ShellUIHelper

This object contains the interface that provides access to features available in the Windows Shell API.