
This interface specifies the shape of a "hot spot" in a client-side image MAP.
IHTMLAreaElement Methods
HRESULT blur(void);
Causes the element to lose the focus and executes the code specified by get_onblur.
See also put_onblur
HRESULT focus(void);
Causes the element to receive the focus and executes the onfocus event.
See also get_onfocus, put_onfocus
HRESULT get_alt(
BSTR *p
);
Retrieves the optional text as an alternative to the graphic for rendering in nongraphical environments. Alternate text should be provided whenever the graphic is not rendered.
See also put_alt
HRESULT get_coords(
BSTR *p
);
Retrieves the coordinates that define the hot spot's shape.
See also put_coords
HRESULT get_hash(
BSTR *p
);
Retrieves the string stored in the hash property of the AREA object.
See also put_hash
HRESULT get_host(
BSTR *p
);
Retrieves the host name and the optional port information of the location or URL.
See also put_host
HRESULT get_hostname(
BSTR *p
);
Retrieves the host-name part of the location or URL.
See also put_hostname
HRESULT get_href(
BSTR *p
);
Retrieves the destination URL or anchor point.
The HREF attribute on the anchor is a scriptable attribute. HREFs on anchors can jump to bookmarks or any element's id attribute.
See also put_href
HRESULT get_noHref(
VARIANT_BOOL *p
);
Determines whether clicks in this region should cause no action.
See also put_noHref
HRESULT get_onblur(
VARIANT *p
);
Retrieves the inline script associated with the onblur event on the AREA element.
See also put_onblur, blur
HRESULT get_onfocus(
VARIANT *p
);
Retrieves the inline script associated with the onfocus event on the AREA element.
See also put_onfocus, focus
HRESULT get_pathname(
BSTR *p
);
Retrieves the file or object path from the URL for the current browser location.
See also put_pathname
HRESULT get_port(
BSTR *p
);
Retrieves the port number from the URL.
See also put_port
HRESULT get_protocol(
BSTR *p
);
Retrieves the protocol portion of the URL. The protocol portion, which indicates the access method, includes the initial substring of the URL up to and including the first colon.
See also put_protocol
HRESULT get_search(
BSTR *p
);
Retrieves the substring that follows the ? symbol in the href property of the AREA object.
See also put_search
HRESULT get_shape(
BSTR *p
);
Retrieves the type of shape used in the image map.
| "circ" | |
| "circle" | |
| "poly" | |
| "polygon" | |
| "rect" | |
| "rectangle" |
Each shape causes the coords property of the AREA object to take a different set of values. The relationships are as follows:
| RECT | Rectangle. Takes four coordinates: x1, y1, x2, and y2. |
| RECTANGLE | Rectangle. Takes four coordinates: x1, y1, x2, and y2. |
| CIRC | Circle. Takes three coordinates: centerx, centery, and radius. |
| CIRCLE | Circle. Takes three coordinates: centerx, centery, and radius. |
| POLY | Polygon. Takes three or more pairs of coordinates denoting a polygonal region. |
| POLYGON | Polygon. Takes three or more pairs of coordinates denoting a polygonal region. |
See also put_shape
HRESULT get_tabIndex(
short *p
);
Retrieves the tab index for the object.
Tab selection order is determined by the value of the tabIndex property as follows:
See also put_tabIndex
HRESULT get_target(
BSTR *p
);
Retrieves the target window or frame.
| _blank | Specifies to load the link into a new blank window. This window is not named. |
| _parent | Specifies to load the link into the immediate parent of the document the link is in. |
| _self | Specifies to load the link into the same window the link was clicked in. |
| _top | Specifies to load the link into the full body of the window. |
If there is no frame or window that matches the specified target, a new window is opened for the link.
The default value for the target depends upon the URL and site. If the user does not leave the site, the default is _self, but if the user exits to a new site, the default is _top.
HRESULT put_alt(
BSTR v
);
Sets the optional text, which is used as an alternative to the graphic for rendering in nongraphical environments. Alternate text should be provided whenever the graphic is not rendered. Alternate text is mandatory for Level 0 documents.
See also get_alt
HRESULT put_coords(
BSTR v
);
Sets the coordinates that define the hot spot's shape.
See also get_shape
HRESULT put_hash(
BSTR v
);
Sets the string associated with the hash property of the AREA object.
This property is useful for moving to a bookmark within a document. Assigning an invalid value does not cause an error.
See also get_hash
HRESULT put_host(
BSTR v
);
Sets the host name and the optional port information of the location or URL.
See also get_host
HRESULT put_hostname(
BSTR v
);
Sets the host-name portion of the location or URL.
See also get_hostname
HRESULT put_href(
BSTR v
);
Sets the destination URL or anchor point.
The HREF attribute on the anchor is a scriptable attribute. HREFs on anchors can jump to bookmarks or any element's id attribute.
See also get_href
HRESULT put_noHref(
VARIANT_BOOL v
);
Sets whether clicks in this region should cause no action.
See also get_noHref
HRESULT put_onblur(
VARIANT v
);
Sets the inline script associated with the onblur event for the AREA element.
See also get_onblur
HRESULT put_onfocus(
VARIANT v
);
Sets the inline script associated with the onfocus event for the AREA element.
See also get_onfocus
HRESULT put_pathname(
BSTR v
);
Sets the file or object path of the URL.
See also get_pathname
HRESULT put_port(
BSTR v
);
Sets the port number in a URL.
See also get_port
HRESULT put_protocol(
BSTR v
);
Sets the initial substring up to and including the first colon, which indicates the URL's access method.
See also get_protocol
HRESULT put_search(
BSTR v
);
Sets the substring that follows the ? symbol in the href property of the AREA object. This is the query string or form data.
See also get_search
HRESULT put_shape(
BSTR v
);
Sets the type of shape used in the image map.
| "circ" | |
| "circle" | |
| "poly" | |
| "polygon" | |
| "rect" | |
| "rectangle" |
Each shape causes the coords property to take a different set of values. The relationships are described as follows:
| RECT | Rectangle. Takes four coordinates: x1, y1, x2, and y2. |
| RECTANGLE | Rectangle. Takes four coordinates: x1, y1, x2, and y2. |
| CIRC | Circle. Takes three coordinates: centerx, centery, and radius. |
| CIRCLE | Circle. Takes three coordinates: centerx, centery, and radius. |
| POLY | Polygon. Takes three or more pairs of coordinates denoting a polygonal region. |
| POLYGON | Polygon. Takes three or more pairs of coordinates denoting a polygonal region. |
See also get_shape
HRESULT put_tabIndex(
short v
);
Sets the tab index for the object.
Tab selection order is determined by the value of the tabIndex property as follows:
See also get_tabIndex
HRESULT put_target(
BSTR v
);
Sets the target window or frame.
| _blank | Specifies to load the link into a new blank window. This window is not named. |
| _parent | Specifies to load the link into the immediate parent of the document the link is in. |
| _self | Specifies to load the link into the same window the link was clicked in. |
| _top | Specifies to load the link into the full body of the window. |
If there is no frame or window that matches the specified target, a new window is opened for the link.
The default value for the target depends upon the URL and site. If the user does not leave the site, the default is _self, but if the user exits to a new site, the default is _top.
See also get_target
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.