DHTML Event Maps

The following macros can be used to handle DHTML events.

DHTML Event Map Macros

The following macros can be used to handle DHTML events in CDHtmlDialog-derived classes.

Name Description
BEGIN_DHTML_EVENT_MAP Marks the start of the DHTML event map.
BEGIN_DHTML_EVENT_MAP_INLINE Marks the start of the DHTML event map.
DECLARE_DHTML_EVENT_MAP Declares the DHTML event map.
DHTML_EVENT Used to handle an event at the document level for a single HTML element.
DHTML_EVENT_AXCONTROL Used to handle an event fired by an ActiveX control.
DHTML_EVENT_CLASS Used to handle an event at the document level for all HTML elements with a particular CSS class.
DHTML_EVENT_ELEMENT Used to handle an event at the element level.
DHTML_EVENT_ONAFTERUPDATE Used to handle the onafterupdate event from an HTML element.
DHTML_EVENT_ONBEFOREUPDATE Used to handle the onbeforeupdate event from an HTML element.
DHTML_EVENT_ONBLUR Used to handle the onblur event from an HTML element.
DHTML_EVENT_ONCHANGE Used to handle the onchange event from an HTML element.
DHTML_EVENT_ONCLICK Used to handle the onclick event from an HTML element.
DHTML_EVENT_ONDATAAVAILABLE Used to handle the ondataavailable event from an HTML element.
DHTML_EVENT_ONDATASETCHANGED Used to handle the ondatasetchanged event from an HTML element.
DHTML_EVENT_ONDATASETCOMPLETE Used to handle the ondatasetcomplete event from an HTML element.
DHTML_EVENT_ONDBLCLICK Used to handle the ondblclick event from an HTML element.
DHTML_EVENT_ONDRAGSTART Used to handle the ondragstart event from an HTML element.
DHTML_EVENT_ONERRORUPDATE Used to handle the onerrorupdate event from an HTML element.
DHTML_EVENT_ONFILTERCHANGE Used to handle the onfilterchange event from an HTML element.
DHTML_EVENT_ONFOCUS Used to handle the onfocus event from an HTML element.
DHTML_EVENT_ONHELP Used to handle the onhelp event from an HTML element.
DHTML_EVENT_ONKEYDOWN Used to handle the onkeydown event from an HTML element.
DHTML_EVENT_ONKEYPRESS Used to handle the onkeypress event from an HTML element.
DHTML_EVENT_ONKEYUP Used to handle the onkeyup event from an HTML element.
DHTML_EVENT_ONMOUSEDOWN Used to handle the onmousedown event from an HTML element.
DHTML_EVENT_ONMOUSEMOVE Used to handle the onmousemove event from an HTML element.
DHTML_EVENT_ONMOUSEOUT Used to handle the onmouseout event from an HTML element.
DHTML_EVENT_ONMOUSEOVER Used to handle the onmouseover event from an HTML element.
DHTML_EVENT_ONMOUSEUP Used to handle the onmouseup event from an HTML element.
DHTML_EVENT_ONRESIZE Used to handle the onresize event from an HTML element.
DHTML_EVENT_ONROWENTER Used to handle the onrowenter event from an HTML element.
DHTML_EVENT_ONROWEXIT Used to handle the onrowexit event from an HTML element.
DHTML_EVENT_ONSELECTSTART Used to handle the onselectstart event from an HTML element.
DHTML_EVENT_TAG Used to handle an event at the document level for all elements with a particular HTML tag.
END_DHTML_EVENT_MAP Marks the end of the DHTML event map.
END_DHTML_EVENT_MAP_INLINE Marks the end of the DHTML event map.

URL Event Map Macros

The following macros can be used to handle DHTML events in CMultiPageDHtmlDialog-derived classes.

Name Description
BEGIN_DHTML_URL_EVENT_MAP Marks the start of the multipage DHTML and URL event map.
BEGIN_EMBED_DHTML_EVENT_MAP Marks the start of an embedded DHTML event map.
BEGIN_URL_ENTRIES Marks the start of a URL event entry map.
DECLARE_DHTML_URL_EVENT_MAP Declares the multipage DHTML and URL event map.
END_DHTML_URL_EVENT_MAP Marks the end of the multipage DHTML and URL event map.
END_EMBED_DHTML_EVENT_MAP Marks the end of an embedded DHTML event map.
END_URL_ENTRIES Marks the end of a URL event entry map.
URL_EVENT_ENTRY Maps a URL or HTML resource to a page in a multipage dialog.

Requirements

Header afxdhtml.h

BEGIN_DHTML_EVENT_MAP

Marks the beginning of the DHTML event map when placed in the source file for the class identified by className.

BEGIN_DHTML_EVENT_MAP(className)

Parameters

className
The name of the class containing the DHTML event map. This class should derive directly or indirectly from CDHtmlDialog and include the DECLARE_DHTML_EVENT_MAP macro within its class definition.

Remarks

Add a DHTML event map to your class to provide information to CDHtmlDialog that can be used to route events fired by HTML elements or ActiveX controls in a web page to handler functions in your class.

Place the BEGIN_DHTML_EVENT_MAP macro in the class's implementation (.cpp) file followed by DHTML_EVENT macros for the events the class is to handle (for example, DHTML_EVENT_ONMOUSEOVER for mouseover events). Use the END_DHTML_EVENT_MAP macro to mark the end of the event map. These macros implement the following function:

virtual const DHtmlEventMapEntry* GetDHtmlEventMap();

Requirements

Header afxdhtml.h

BEGIN_DHTML_EVENT_MAP_INLINE

Marks the beginning of the DHTML event map within the class definition for className.

BEGIN_DHTML_EVENT_MAP_INLINE(className)

Parameters

className
The name of the class containing the DHTML event map. This class should derive directly or indirectly from CDHtmlDialog and include the DECLARE_DHTML_EVENT_MAP macro within its class definition.

Remarks

Add a DHTML event map to your class to provide information to CDHtmlDialog that can be used to route events fired by HTML elements or ActiveX controls in a web page to handler functions in your class.

Place the BEGIN_DHTML_EVENT_MAP macro in the class's definition (.h) file followed by DHTML_EVENT macros for the events the class is to handle (for example, DHTML_EVENT_ONMOUSEOVER for mouseover events). Use the END_DHTML_EVENT_MAP_INLINE macro to mark the end of the event map. These macros implement the following function:

virtual const DHtmlEventMapEntry* GetDHtmlEventMap();

Requirements

Header afxdhtml.h

DECLARE_DHTML_EVENT_MAP

Declares a DHTML event map in a class definition.

DECLARE_DHTML_EVENT_MAP()

Remarks

This macro is to be used in the definition of CDHtmlDialog-derived classes.

Use BEGIN_DHTML_EVENT_MAP or BEGIN_DHTML_EVENT_MAP_INLINE to implement the map.

DECLARE_DHTML_EVENT_MAP declares the following function:

virtual const DHtmlEventMapEntry* GetDHtmlEventMap( );

Requirements

Header afxdhtml.h

DHTML_EVENT

Handles (at the document level) an event identified by dispid originated by the HTML element identified by elemName.

DHTML_EVENT(dispid, elemName,  memberFxn)

Parameters

dispid
The DISPID of the event to be handled.

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event, or NULL to handle document events.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_AXCONTROL

Handles the event identified by dispid fired by the ActiveX control identified by controlName.

DHTML_EVENT_AXCONTROL(dispid, controlName,  memberFxn)

Parameters

dispid
The dispatch ID of the event to be handled.

controlName
An LPCWSTR holding the HTML ID of the control firing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_CLASS

Handles (at the document level) an event identified by dispid originated by any HTML element with the CSS class identified by elemName.

DHTML_EVENT_CLASS(dispid, elemName,  memberFxn)

Parameters

dispid
The dispatch ID of the event to be handled.

elemName
An LPCWSTR holding the CSS class of the HTML elements sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ELEMENT

Handles (at the element identified by elemName) an event identified by dispid.

DHTML_EVENT_ELEMENT(dispid, elemName,  memberFxn)

Parameters

dispid
The dispatch ID of the event to be handled.

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

If this macro is used to handle nonbubbling events, the source of the event will be the element identified by elemName.

If this macro is used to handle bubbling events, the element identified by elemName may not be the source of the event (the source could be any element contained by elemName).

Requirements

Header afxdhtml.h

DHTML_EVENT_ONAFTERUPDATE

Handles (at the document level) the onafterupdate event originated by the HTML element identified by elemName.

DHTML_EVENT_ONAFTERUPDATE(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONBEFOREUPDATE

Handles (at the document level) the onbeforeupdate event originated by the HTML element identified by elemName.

DHTML_EVENT_ONBEFOREUPDATE(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONBLUR

Handles (at the element level) the onblur event. This is a nonbubbling event.

DHTML_EVENT_ONBLUR(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONCHANGE

Handles (at the element level) the onchange event. This is a nonbubbling event.

DHTML_EVENT_ONCHANGE(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONCLICK

Handles (at the document level) the onclick event originated by the HTML element identified by elemName.

DHTML_EVENT_ONCLICK(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONDATAAVAILABLE

Handles (at the document level) the ondataavailable event originated by the HTML element identified by elemName.

DHTML_EVENT_ONDATAAVAILABLE(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONDATASETCHANGED

Handles (at the document level) the ondatasetchanged event originated by the HTML element identified by elemName.

DHTML_EVENT_ONDATASETCHANGED(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONDATASETCOMPLETE

Handles (at the document level) the ondatasetcomplete event originated by the HTML element identified by elemName.

DHTML_EVENT_ONDATASETCOMPLETE(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONDBLCLICK

Handles (at the document level) the ondblclick event originated by the HTML element identified by elemName.

DHTML_EVENT_ONDBLCLICK(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONDRAGSTART

Handles (at the document level) the ondragstart event originated by the HTML element identified by elemName.

DHTML_EVENT_ONDRAGSTART(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONERRORUPDATE

Handles (at the document level) the onerrorupdate event originated by the HTML element identified by elemName.

DHTML_EVENT_ONERRORUPDATE(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONFILTERCHANGE

Handles (at the document level) the onfilterchange event originated by the HTML element identified by elemName.

DHTML_EVENT_ONFILTERCHANGE(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONFOCUS

Handles (at the element level) the onfocus event. This is a nonbubbling event.

DHTML_EVENT_ONFOCUS(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONHELP

Handles (at the document level) the onhelp event originated by the HTML element identified by elemName.

DHTML_EVENT_ONHELP(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONKEYDOWN

Handles (at the document level) the onkeydown event originated by the HTML element identified by elemName.

DHTML_EVENT_ONKEYDOWN(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONKEYPRESS

Handles (at the document level) the onkeypress event originated by the HTML element identified by elemName.

DHTML_EVENT_ONKEYPRESS(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONKEYUP

Handles (at the document level) the onkeyup event originated by the HTML element identified by elemName.

DHTML_EVENT_ONKEYUP(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONMOUSEDOWN

Handles (at the document level) the onmousedown event originated by the HTML element identified by elemName.

DHTML_EVENT_ONMOUSEDOWN(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONMOUSEMOVE

Handles (at the document level) the onmousemove event originated by the HTML element identified by elemName.

DHTML_EVENT_ONMOUSEMOVE(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONMOUSEOUT

Handles (at the document level) the onmouseout event originated by the HTML element identified by elemName.

DHTML_EVENT_ONMOUSEOUT(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONMOUSEOVER

Handles (at the document level) the onmouseover event originated by the HTML element identified by elemName.

DHTML_EVENT_ONMOUSEOVER(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONMOUSEUP

Handles (at the document level) the onmouseup event originated by the HTML element identified by elemName.

DHTML_EVENT_ONMOUSEUP(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONRESIZE

Handles (at the element level) the onresize event. This is a nonbubbling event.

DHTML_EVENT_ONRESIZE(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONROWENTER

Handles (at the document level) the onrowenter event originated by the HTML element identified by elemName.

DHTML_EVENT_ONROWENTER(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONROWEXIT

Handles (at the document level) the onrowexit event originated by the HTML element identified by elemName.

DHTML_EVENT_ONROWEXIT(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_ONSELECTSTART

Handles (at the document level) the onselectstart event originated by the HTML element identified by elemName.

DHTML_EVENT_ONSELECTSTART(elemName, memberFxn)

Parameters

elemName
An LPCWSTR holding the ID of the HTML element sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

DHTML_EVENT_TAG

Handles (at the document level) an event identified by dispid originated by any HTML element with the HTML tag identified by elemName.

DHTML_EVENT_TAG(dispid, elemName,  memberFxn)

Parameters

dispid
The dispatch ID of the event to be handled.

elemName
The HTML tag of the HTML elements sourcing the event.

memberFxn
The handler function for the event.

Remarks

Use this macro to add an entry to the DHTML event map in your class.

Requirements

Header afxdhtml.h

END_DHTML_EVENT_MAP

Marks the end of the DHTML event map.

END_DHTML_EVENT_MAP()

Remarks

Must be used in conjunction with BEGIN_DHTML_EVENT_MAP.

Requirements

Header afxdhtml.h

BEGIN_DHTML_URL_EVENT_MAP

Starts the definition of a DHTML and URL event map in a multipage dialog.

BEGIN_DHTML_URL_EVENT_MAP()

Remarks

Put BEGIN_DHTML_URL_EVENT_MAP in the implementation file of your CMultiPageDHtmlDialog-derived class. Follow it with embedded DHTML event maps and URL entries, and then close it with END_DHTML_URL_EVENT_MAP. Include the DECLARE_DHTML_URL_EVENT_MAP macro within the class definition.

Example

BEGIN_DHTML_URL_EVENT_MAP(CMyMultiPageDlg)

BEGIN_EMBED_DHTML_EVENT_MAP(CMyMultiPageDlg, Page1)
   DHTML_EVENT_ONCLICK(_T("Next"), OnPage1Next)
END_EMBED_DHTML_EVENT_MAP()

BEGIN_EMBED_DHTML_EVENT_MAP(CMyMultiPageDlg, Page2)
   DHTML_EVENT_ONCLICK(_T("Back"), OnPage2Back)
   DHTML_EVENT_ONCLICK(_T("Next"), OnPage2Next)
END_EMBED_DHTML_EVENT_MAP()

BEGIN_EMBED_DHTML_EVENT_MAP(CMyMultiPageDlg, Page3)
   DHTML_EVENT_ONCLICK(_T("Back"), OnPage3Back)
END_EMBED_DHTML_EVENT_MAP()

BEGIN_URL_ENTRIES(CMyMultiPageDlg)
   URL_EVENT_ENTRY(CMyMultiPageDlg, _T("153"), Page1)
   URL_EVENT_ENTRY(CMyMultiPageDlg, _T("154"), Page2)
   URL_EVENT_ENTRY(CMyMultiPageDlg, _T("155"), Page3)
   // Note: IDR_PAGE1 = 153, IDR_PAGE2 = 154, IDR_PAGE3 = 155
END_URL_ENTRIES()

END_DHTML_URL_EVENT_MAP(CMyMultiPageDlg)

Requirements

Header afxdhtml.h

BEGIN_EMBED_DHTML_EVENT_MAP

Starts the definition of an embedded DHTML event map in a multipage dialog.

BEGIN_EMBED_DHTML_EVENT_MAP(className, mapName)

Parameters

className
The name of the class containing the event map. This class should derive directly or indirectly from CMultiPageDHtmlDialog. The embedded DHTML event map must be inside a DHTML and URL event map).

mapName
Specifies the page whose event map this is. This matches mapName in the URL_EVENT_ENTRY macro actually defining the URL or HTML resource.

Remarks

Because a multipage DHTML dialog consists of multiple HTML pages, each of which can raise DHTML events, embedded event maps are used to map events to handlers on a per-page basis.

Embedded event maps within a DHTML and URL event map consist of a BEGIN_EMBED_DHTML_EVENT_MAP macro followed by DHTML_EVENT macros and an END_EMBED_DHTML_EVENT_MAP macro.

Each embedded event map requires a corresponding URL event entry to map mapName (specified in BEGIN_EMBED_DHTML_EVENT_MAP) to a URL or HTML resource.

Example

See the example in BEGIN_DHTML_URL_EVENT_MAP.

Requirements

Header afxdhtml.h

BEGIN_URL_ENTRIES

Starts the definition of a URL event entry map in a multipage dialog.

BEGIN_URL_ENTRIES(className)

Parameters

className
The name of the class containing the URL event entry map. This class should derive directly or indirectly from CMultiPageDHtmlDialog. The URL event entry map must be inside a DHTML and URL event map).

Remarks

Because a multipage DHTML dialog consists of multiple HTML pages, URL event entries are used to map URLs or HTML resources to corresponding embedded DHTML event maps. Put URL_EVENT_ENTRY macros between BEGIN_URL_ENTRIES and END_URL_ENTRIES macros.

Example

See the example in BEGIN_DHTML_URL_EVENT_MAP.

Requirements

Header afxdhtml.h

DECLARE_DHTML_URL_EVENT_MAP

Declares a DHTML and URL event map in a class definition.

DECLARE_DHTML_URL_EVENT_MAP()

Remarks

This macro is to be used in the definition of CMultiPageDHtmlDialog-derived classes.

A DHTML and URL event map contains embedded DHTML event maps and URL event entries to map DHTML events to handlers on a per-page basis. Use BEGIN_DHTML_URL_EVENT_MAP to implement the map.

Requirements

Header afxdhtml.h

END_DHTML_URL_EVENT_MAP

Marks the end of a DHTML and URL event map.

END_DHTML_URL_EVENT_MAP(className)

Parameters

className
The name of the class containing the event map. This class should derive directly or indirectly from CMultiPageDHtmlDialog. This should match className in the corresponding BEGIN_DHTML_URL_EVENT_MAP macro.

Example

See the example in BEGIN_DHTML_URL_EVENT_MAP.

Requirements

Header afxdhtml.h

END_EMBED_DHTML_EVENT_MAP

Marks the end of an embedded DHTML event map.

END_EMBED_DHTML_EVENT_MAP()

Example

See the example in BEGIN_DHTML_URL_EVENT_MAP.

Requirements

Header afxdhtml.h

END_URL_ENTRIES

Marks the end of a URL event entry map.

END_URL_ENTRIES()

Example

See the example in BEGIN_DHTML_URL_EVENT_MAP.

Requirements

Header afxdhtml.h

URL_EVENT_ENTRY

Maps a URL or HTML resource to a page in a multipage dialog.

URL_EVENT_ENTRY(className, url,  mapName)

Parameters

className
The name of the class containing the URL event entry map. This class should derive directly or indirectly from CMultiPageDHtmlDialog. The URL event entry map must be inside a DHTML and URL event map).

url
The URL or HTML resource for the page.

mapName
Specifies the page whose URL is url. This matches mapName in the BEGIN_EMBED_DHTML_EVENT_MAP macro that maps events from this page.

Remarks

If the page is an HTML resource, url must be the string representation of the resource's ID number (that is, "123", not 123 or ID_HTMLRES1).

The page identifier, mapName, is an arbitrary symbol used to link embedded DHTML event maps to URL event entry maps. It is limited in scope to the DHTML and URL event map.

Example

See the example in BEGIN_DHTML_URL_EVENT_MAP.

Requirements

Header afxdhtml.h

END_DHTML_EVENT_MAP_INLINE

Marks the end of the DHTML event map.

Syntax

END_DHTML_EVENT_MAP_INLINE( )

Remarks

Must be used in conjunction with BEGIN_DHTML_EVENT_MAP_INLINE.

Requirements

Header: afxdhtml.h

See also

Macros and Globals