Shell Helper API

This section covers functionality exposed by the IShellUIHelper interface. IShellUIHelper provides access to some features available in the Windows shell.

Functions

TopicContents
AddUrlToFavorites

Adds a favorite. Use for backward compatibility only.

DoAddToFavDlg

Displays the standard Windows Internet Explorer Add Favorite dialog box.

DoOrganizeFavDlg

Displays the standard Internet Explorer Organize Favorites dialog box.

 

Objects

TopicContents
ShellUIHelper

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

 

Interfaces

TopicContents
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 Windows Internet Explorer 8.

IShellUIHelper4

Extends IShellUIHelper3 with methods that support pinned sites.

 

Overviews/Tutorials

TopicContents
Shell Helper API

The IShellUIHelper interface provides methods to import and export Favorites, add Favorites, add channels, Microsoft Active Desktop items, find and navigate to specified text, and determine if a site is subscribed to.

 

Methods

TopicContents
IShellUIHelper::AddChannel

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

IShellUIHelper::AddDesktopComponent

Adds a Web site or image to theActive Desktop.

IShellUIHelper::AddFavorite

Prompts the user with a dialog box to add the specifiedURLto theFavoriteslist.

AddSearchProvider

Adds a search provider to the registry.

IShellUIHelper3::AddService

User initiated action to add a service.

IShellUIHelper3::AddToFavoritesBar

Adds aURLto theFavorites Bar.

IShellUIHelper::AutoCompleteSaveForm

Saves the specified form in the AutoComplete data store.

IShellUIHelper::AutoScan

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

BrandImageUri

Not supported. Retrieves theUniform 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, andWeb Slicesassociated with the page.

CustomizeClearType

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

CustomizeSettings

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

DefaultSearchProvider

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

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 ofInternet Explorerfavorites.

IShellUIHelper3::InPrivateFilteringEnabled

Detects whether the user has enabledInPrivate Filtering.

IsSearchMigrated

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

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 whetherMicrosoft ActiveXFiltering is enabled by the user.

IShellUIHelper4::msAddSiteMode

Creates apinned siteshortcut to the current webpage on theWindowsStart menu.

IShellUIHelper4::msAddTrackingProtectionList

Adds an externalTracking Protectionlist.

IShellUIHelper4::msIsSiteMode

Determines whether the current page was launched as apinned site.

IShellUIHelper4::msIsSiteModeFirstRun

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

IShellUIHelper4::msSiteModeActivate

Flashes thepinned sitetaskbar button.

IShellUIHelper4::msSiteModeAddButtonStyle

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

IShellUIHelper4::msSiteModeAddJumpListItem

Adds a new entry to theJump Listof a taskbar button.

IShellUIHelper4::msSiteModeAddThumbBarButton

Adds a button to theThumbnail Toolbar.

IShellUIHelper4::msSiteModeClearIconOverlay

Removes the icon overlay from the taskbar button.

IShellUIHelper4::msSiteModeClearJumpList

Deletes theJump List.

IShellUIHelper4::msSiteModeCreateJumpList

Creates a new group of items on theJump List.

IShellUIHelper4::msSiteModeSetIconOverlay

Adds an icon overlay to thepinned sitetaskbar button.

IShellUIHelper4::msSiteModeShowButtonStyle

Changes the icon image and tooltip of aThumbnail Toolbarbutton.

IShellUIHelper4::msSiteModeShowJumpList

Shows updates to the list of items in aJump List.

IShellUIHelper4::msSiteModeShowThumbBar

Enables theThumbnail Toolbarin the thumbnail preview of apinned site.

IShellUIHelper4::msSiteModeUpdateThumbBarButton

Changes the state of aThumbnail Toolbarbutton.

IShellUIHelper4::msTrackingProtectionEnabled

Determines whether anyTracking Protectionlists are enabled by the user.

IShellUIHelper::NavigateAndFind

Navigates to the specifiedURLand selects the specified text.

IShellUIHelper3::NavigateToSuggestedSites

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

PhishingEnabled

Not supported. Determines whetherMicrosoft Phishing Filteris enabled.

RunOnceHasShown

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

RunOnceRequiredSettingsComplete

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

RunOnceShown

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

SearchGuideUrl

Not supported. Retrieves theURLof 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.

SkipRunOnce

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

SkipTabsWelcome

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

SqmEnabled

Not supported. Determines whetherSoftware Quality Monitoring (SQM)is enabled.

 

 

 

Show: