Export (0) Print
Expand All

AddToFavoritesBar Method

Adds a URL to the Favorites Bar.

Syntax

window.external.AddToFavoritesBar(URL, Title [, Type])

Parameters

URL Required. The URL of the page to add.
Title Required. The Title for this page.
Type Optional. String that specifies one of the following, or null.
feed
The content is a Really Simple Syndication (RSS) feed.
slice
The content is a Web Slice.

Return Value

No return value.

Remarks

Caller must specify a non- null, non-empty URL and Title, and can optionally identify the URL as an RSS feed or a Web Slice. If the Type is a feed or slice, the function will subscribe using the Windows RSS Platform. When subscribing to a feed or a Web Slice, the Title is only used until the data can be retrieved from the server.

If no Type is specified, the item is simply added as a bookmark to the Favorites Bar .

Windows Internet Explorer 8 and later. For security reasons, the AddToFavoritesBar method must be called as a response to a user-initiated action, such a mouse click. If called from a different context, such as the onload event of the body element, the AddToFavoritesBar method fails silently.

Example

The following button subscribes the user to a specific Web Slice by using the ID of the clip container as the fragment (named anchor reference) on the URL.


<button
    onclick="external.AddToFavoritesBar(
        'http://example.com/slices.aspx#weather',
        'Weather Conditions','slice')">
    Current Weather Conditions</button>  

Standards Information

There is no public standard that applies to this method.

Applies To

external

See Also

Subscribing to Content with Web Slices

Community Additions

ADD
Show:
© 2014 Microsoft