IHTMLAnchorElement::rel Property

  • Article

Sets or retrieves the relationship between the object and the destination of the link.

Syntax

HRESULT IHTMLAnchorElement::get_rel(BSTR *p);
HRESULT IHTMLAnchorElement::put_rel(BSTR v);

Parameters

  • p
    Pointer to a variable of type BSTR that receives one or more of the space delimited values in the list of Possible Values.
  • v
    BSTR that specifies one or more of the space delimited values in the list of Possible Values.

Possible Values

Alternate Substitute version of the file that contains the link.
Appendix Page that is an appendix for the set of pages.
Bookmark Bookmark.
Windows Internet Explorer 8. The anchor is an alternate navigation source for a Web Slice.
Chapter Page that is a chapter for a set of pages.
Contents Table of contents document.
Copyright Copyright notice for the current page.
Entry-Content Internet Explorer 8. The anchor is an alternate display source for a Web Slice.
FeedUrl Internet Explorer 8. The anchor is an alternate update source for a Web Slice.
Glossary Glossary for the current page.
Help Help document.
Index Index document for the current page.
Next Next document in a sequence.
Offline Path to the Channel Definition Format (CDF) file to be used for an offline favorite.
Prev Previous document in a sequence.
Search Internet Explorer 7 and later. The link refers to an OpenSearch Description file. (See Search Provider Extensibility in Internet Explorer for more information.) The Search type is not defined by the HTML 4.01 specification. For strict validation, include https://a9.com/-/spec/opensearch/1.1/ in the profile attribute of the head element.
Section Page that is a section for a set of pages.
Shortcut Icon Path to an icon file to be used for the favorite or link. See How to Add a Shortcut Icon to a Web Page.
Start First document of a set.
Stylesheet Style sheet.
Subsection Page that is a subsection for a set of pages.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

If no values are indicated, the IHTMLAnchorElement::rel property's default relationship is an empty string.

The Offline, Search, Shortcut Icon, and Stylesheet values apply only to the link object.

The IHTMLAnchorElement::rel property is similar to the IHTMLAnchorElement::rev property, but the semantics of these two properties' link types are in the reverse direction. For example, a link from A to B with REL="X" expresses the same relationship as a link from B to A with REV="X". An anchor can have both IHTMLAnchorElement::rel and IHTMLAnchorElement::rev properties.

Internet Explorer 8 and later. In IE8 Standards mode, the IHTMLAnchorElement::rel content attribute locates the Alternate token regardless of its position in a space-delimited list of tokens. For example, IHTMLAnchorElement::rel will locate Alternate whether it is parsed as rel="alternate stylesheet" or rel="stylesheet alternate". For more information on IE8 mode, see Defining Document Compatibility.

The Offline value is available in Microsoft Internet Explorer 5 and later. For more information about CDF files and offline favorites, see Enhancing Offline Favorites. CDF is obsolete as of Internet Explorer 7.

See Also

IHTMLAnchorElement::rev, Subscribing to Content with Web Slices