Home COM GDI+ WebBrowser Data Access 

Advanced Hosting Reference

 

 

This document describes the interfaces, methods, structures, and enumerated types used for customizing the behavior of MSHTML objects. For a more general overview of MSHTML's hosting and extensibility mechanisms, see Reusing MSHTML.

 

 

Interfaces

 

ICustomDoc

IDocHostShowUI

IDocHostUIHandler

IDocHostUIHandler2

 

 

IDownloadManager

IElementBehaviorRender

IHostDialogHelper

IHTMLOMWindowServices

 

Enumerations

 

DOCHOSTUIDBLCLK

 

Defines values used to indicate the proper action on a double-click event.

%DOCHOSTUIDBLCLK_DEFAULT = 0
' Perform the default action.
%DOCHOSTUIDBLCLK_SHOWPROPERTIES = 1
' Show the item's properties.
%DOCHOSTUIDBLCLK_SHOWCODE = 2
' Show the page's source.
 

 

DOCHOSTUIFLAG

 

Defines a set of flags that indicate the capabilities of an IDocHostUIHandler implementation.

%DOCHOSTUIFLAG_DIALOG = &H00000001
' MSHTML does not enable selection of the text in the form.
%DOCHOSTUIFLAG_DISABLE_HELP_MENU = &H00000002
' MSHTML does not add the Help menu item to the container's menu.
%DOCHOSTUIFLAG_NO3DBORDER = &H00000004
' MSHTML does not use 3-D borders on any frames or framesets. To turn the border off on only the outer frameset use DOCHOSTUIFLAG_NO3DOUTERBORDER
%DOCHOSTUIFLAG_SCROLL_NO = &H00000008
' MSHTML does not have scroll bars.
%DOCHOSTUIFLAG_DISABLE_SCRIPT_INACTIVE = &H00000010
' MSHTML does not execute any script when loading pages.
%DOCHOSTUIFLAG_OPENNEWWIN = &H00000020
' MSHTML opens a site in a new window when a link is clicked rather than browse to the new site using the same browser window.
%DOCHOSTUIFLAG_DISABLE_OFFSCREEN = &H00000040
' Not implemented.
%DOCHOSTUIFLAG_FLAT_SCROLLBAR = &H00000080
' MSHTML uses flat scroll bars for any user interface (UI) it displays.
%DOCHOSTUIFLAG_DIV_BLOCKDEFAULT = &H00000100
' MSHTML inserts the div tag if a return is entered in edit mode. Without this flag, MSHTML will use the p tag.
%DOCHOSTUIFLAG_ACTIVATE_CLIENTHIT_ONLY = &H00000200
' MSHTML only becomes UI active if the mouse is clicked in the client area of the window. It does not become UI active if the mouse is clicked on a nonclient area, such as a scroll bar.
%DOCHOSTUIFLAG_OVERRIDEBEHAVIORFACTORY = &H00000400
' MSHTML consults the host before retrieving a behavior from the URL specified on the page. If the host does not support the behavior, MSHTML does not proceed to query other hosts or instantiate the behavior itself, even for behaviors developed in script (HTML Components (HTCs)).
%DOCHOSTUIFLAG_CODEPAGELINKEDFONTS = &H00000800
' Microsoft Internet Explorer 5 or later. Provides font selection compatibility for Microsoft Outlook Express. If the flag is enabled, the displayed characters are inspected to determine whether the current font supports the code page. If disabled, the current font is used, even if it does not contain a glyph for the character. This flag assumes that the user is using Internet Explorer 5 and Outlook Express 4.0.
%DOCHOSTUIFLAG_URL_ENCODING_DISABLE_UTF8 = &H00001000
' Internet Explorer 5 or later. Controls how nonnative URLs are transmitted over the Internet. Nonnative refers to characters outside the multibyte encoding of the URL. If this flag is set, the URL is not submitted to the server in UTF-8 encoding.
%DOCHOSTUIFLAG_URL_ENCODING_ENABLE_UTF8 = &H00002000
' Internet Explorer 5 or later. Controls how nonnative URLs are transmitted over the Internet. Nonnative refers to characters outside the multibyte encoding of the URL. If this flag is set, the URL is submitted to the server in UTF-8 encoding.
%DOCHOSTUIFLAG_ENABLE_FORMS_AUTOCOMPLETE = &H00004000
' Internet Explorer 5 or later. This flag enables the AutoComplete feature for forms in the hosted browser. The Intelliforms feature is only turned on if the user has previously enabled it. If the user has turned the AutoComplete feature off for forms, it is off whether this flag is specified or not.
%DOCHOSTUIFLAG_ENABLE_INPLACE_NAVIGATION = &H00010000
' Internet Explorer 5 or later. This flag enables the host to specify that navigation should happen in place. This means that applications hosting MSHTML directly can specify that navigation happen in the application's window. For instance, if this flag is set, you can click a link in HTML mail and navigate in the mail instead of opening a new Internet Explorer window.
%DOCHOSTUIFLAG_IME_ENABLE_RECONVERSION = &H00020000
' Internet Explorer 5 or later. During initialization, the host can set this flag to enable Input Method Editor (IME) reconversion, allowing computer users to employ IME reconversion while browsing Web pages. An input method editor is a program that allows users to enter complex characters and symbols, such as Japanese Kanji characters, using a standard keyboard. For more information, see the International Features reference in the Base Services section of the Microsoft Platform Software Development Kit (SDK).
%DOCHOSTUIFLAG_THEME = &H00040000
' Internet Explorer 6 or later. Specifies that the hosted browser should use themes for pages it displays.
%DOCHOSTUIFLAG_NOTHEME = &H00080000
' Internet Explorer 6 or later. Specifies that the hosted browser should not use themes for pages it displays.
%DOCHOSTUIFLAG_NOPICS = &H00100000
' Internet Explorer 6 or later. Disables PICS ratings for the hosted browser.
%DOCHOSTUIFLAG_NO3DOUTERBORDER = &H00200000
' Internet Explorer 6 or later. Turns off any 3-D border on the outermost frame or frameset only. To turn borders off on all frame sets, use DOCHOSTUIFLAG_NO3DBORDER
%DOCHOSTUIFLAG_DISABLE_EDIT_NS_FIXUP = &H00400000
' Internet Explorer 6 or later. Disables the automatic correction of namespaces when editing HTML elements.
%DOCHOSTUIFLAG_LOCAL_MACHINE_ACCESS_CHECK = &H00800000
' Internet Explorer 6 or later. Prevents Web sites in the Internet zone from accessing files in the Local Machine zone.
%DOCHOSTUIFLAG_DISABLE_UNTRUSTEDPROTOCOL = &H01000000
' Internet Explorer 6 or later. Turns off untrusted protocols. Untrusted protocols include ms-its, ms-itss, its, and mk:@msitstore.
%DOCHOSTUIFLAG_ENABLE_REDIRECT_NOTIFICATIONS = &H04000000
 

Note This documentation is preliminary and is subject to change.
 

Internet Explorer 7 or later. Causes MSHTML to fire an additional DWebBrowserEvents2::BeforeNavigate2 event when redirect navigations occur. Applications hosting the WebBrowser Control can choose to cancel or continue the redirect by returning an appropriate value in the Cancel parameter of the event.
 

 

DOCHOSTUITYPE

 

Defines values that indicate the type of user interface.

%DOCHOSTUITYPE_BROWSE = 0
' Value that indicates the user interface is for browsing.
%DOCHOSTUITYPE_AUTHOR = 1
' Value that indicates the user interface is for authoring.

 

 

Structures

 

DOCHOSTUIDINFO

 

Used by the IDocHostUIHandler::GetHostInfo method to allow MSHTML to retrieve information about the host's UI requirements.

TYPE DOCHOSTUIINFO
   cbSize AS DWORD
   dwFlags AS DWORD
   dwDoubleClick AS DWORD
   pchHostCss AS DWORD
   pchHostNS AS DWORD
END TYPE

Members

cbSize
ULONG containing the size of this structure, in bytes.
dwFlags
One or more of the DOCHOSTUIFLAG values that specify the UI capabilities of the host.
dwDoubleClick
One of the DOCHOSTUIDBLCLK values that specify the operation that should take place in response to a double-click.
pchHostCss
Pointer to a set of Cascading Style Sheets (CSS) rules sent down by the host. These CSS rules affect the page containing them.
pchHostNS
Pointer to a semicolon-delimited namespace list. This list allows the host to supply a namespace declaration for custom tags on the page.
 

 

Page last updated on Sunday, 22 January 2006 22:17:37 +0100