PostEditorEventNotify method

  • Article

Called by MSHTML after an event has been handled by the MSHTML Editor and any registered edit designers.

Syntax

HRESULT retVal = object.PostEditorEventNotify(inEvtDispId, pIEventObj);

Parameters

  • inEvtDispId [in]
    Type: DISPID

    A DISPID that specifies the event.

  • pIEventObj [in]
    Type: IHTMLEventObj

    A pointer to an IHTMLEventObj interface that specifies the event.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This method fires after an event has been completely handled. The event might have been handled by passing through the Editor, MSHTML, and all designer methods, or because of an S_OK return value from a designer method. IHTMLEditDesigner::PostEditorEventNotify cannot be canceled, and its return value is ignored. IHTMLEditDesigner::PostEditorEventNotify ensures that a designer completes its tasks. When multiple edit designers are attached to the Editor at the same time, one designer might interfere with other designers by returning S_OK from one of its IHTMLEditDesigner method calls. IHTMLEditDesigner::PostEditorEventNotify enables a designer to make sure that its work has been completed before the event is over.

The DISPID parameter provides the most efficient way for an IHTMLEditDesigner method to determine what type of event triggered the method call. The DISPID_HTMLELEMENTEVENTS2 identifiers are defined in Mshtmdid.h.

Note  IME events do not have DISPIDs, so the DISPID parameter is zero for any IME event. If a designer handles IME events and the DISPID is zero, the designer can determine the event type from the IHTMLEventObj::srcElement property.