WebBrowserBox

Inheritance Hierarchy

          IComponent

          IControl

          IWebBrowserBox

          WebBrowserBox

Description

The WebBrowserBox component is used to load and display web pages.

Working with the Component

To load a web page, use the Navigate method. If the HTML code is available, it can be entered in the DocumentText property. A loaded page can be managed via properties and methods of the WebBrowser object, which the WebBrowserBox component is based on. Properties and methods of the IWebBrowser2 interface are also supported that are used on working with Internet Explorer browser instances. The work is executed using the OleObject property. The WebBrowser/IWebBrowser2 description is presented in MSDN.

Navigation may result in various errors in the component, which cause issues with correct displaying of a web page. The cause of it is that WebBrowser uses core of outdated web browser Internet Explorer 7.0. To solve the problem, apply the method described in the Internet Feature Controls (MSDN) article. In the registry key [HKEY_LOCAL_MACHINE (or HKEY_CURRENT_USER)\Software\Microsoft\Internet Explorer\Main\FeatureControl\FEATURE_BROWSER_EMULATION] create the REG_DWORD parameter named as the started application (in case of Foresight Analytics Platform startup - it is a parameter named studio.exe or pp.exe) and set the value corresponding to the required version of Internet Explorer (values are given in the table specified in the link). After this the component uses emulation of more recent version of the Internet Explorer browser that will help to avoid errors linked to different browser versions.

Example

Properties of the WebBrowserBox Component

  Property name Brief description
Align The Align property determines behavior of the component when its parent component is resized.
AllowDrag The AllowDrag property determines whether an object can be dragged from the component.
AllowDrop The AllowDrop property determines whether the component can accept a dragged object.
Anchors The Anchors property returns settings that determine the percentage of the size change for the current component when the parent component is resized.
BorderStyle The BorderStyle property determines a component border style.
Brush The Brush property determines the brush that is used to fill component area.
ClientHeight The ClientHeight property is used to receive or specify the height of the component’s client area.
ClientWidth The ClientWidth property is used to receive or specify the width of the component’s client area.
Color The Color property determines a component background color.
ComponentCount The ComponentCount property returns the number of child components.
Components The Components property returns the child component.
Cursor The Cursor property determines the look of the cursor over the component.
Data The Data property is used to store any custom data.
DocumentText The DocumentText property determines the HTML code of a page loaded to the component.
Enabled The Enabled property determines whether the component is available for the user.
Focused The Focused property returns True if the focus is set on the component.
Font The Font property determines the set of characteristics describing the font that is used to display text.
Height The Height property determines component height.
HelpContext The HelpContext property determines a unique index for the context help section for this component.
Hint The Hint property determines a component tooltip text.
Left The Left property determines the coordinate of the left border of the component.
Name The Name property determines a component name.
OleObject The OleObject property returns the web page loaded to the component as the OLE object.
Parent The Parent property determines a parent component.
ParentColor The ParentColor property determines whether the component inherits the color of the parent component.
ParentFont The ParentFont property determines whether the component uses the font of the parent component.
ParentShowHint The ParentShowHint property determines whether a tooltip is displayed.
PopupMenu The PopupMenu property determines the context menu opened by clicking the component with the additional mouse button.
Scrolls The Scrolls property returns parameters of component's scrollbars.
ShowHint The ShowHint property enables and disables showing a component tooltip.
TabOrder The TabOrder property determines the component position in the tab order.
TabStop The TabStop property determines whether the component is focused when the TAB key is pressed.
Tag The Tag property is not used by the compiler. The user can change the value of the Tag property and use it as he wishes.
Text The Text property determines the row identifying a component for the user.
Top The Top property determines the coordinate of the top border of the component.
Visible The Visible property determines visibility of the component during execution.
Width The Width property determines component width.

Methods of the WebBrowserBox Component

  Method name Brief description
BringToFront The BringToFront method brings a component to front.
ClientToScreen The ClientToScreen method converts the coordinates of a point specified relative to the component coordinate system into screen coordinates.
DoDragDrop The DoDragDrop method enables to start dragging operation.
GetImage The GetImage method returns the image of the component with all the child components.
Navigate The Navigate method loads a web page to the component, which URL is passed as an input parameter.
Refresh The Refresh method refreshes the loaded web page.
ScreenToClient The ScreenToClient method converts screen coordinates of a point into coordinates specified relative to the component coordinate system.
SendToBack The SendToBack method sends a component to back.
SetFocus The SetFocus method sets focus to this component.

Events of the WebBrowserBox Component

  Event name Brief description
OnBeforeNavigate2 The OnBeforeNavigate2 event occurs before navigating to a web page.
OnBeginDrag The OnBeginDrag event occurs for a component when the user starts to drag an object from the component.
OnClick The OnClick event occurs if the user clicks the component area.
OnDblClick The OnDblClick event occurs if the user double-clicks the component area.
OnDocumentComplete The OnDocumentComplete event occurs after loading a web page.
OnDragDrop The OnDragDrop event occurs for the component if the user drops a dragged object over it.
OnDragEnter The OnDragEnter event occurs when a dragged object crosses the borders of this component.
OnDragLeave The OnDragLeave event occurs when a dragged object leaves the borders of this component.
OnDragOver The OnDragOver event occurs for the component when the user drags an object over it.
OnEnter The OnEnter event occurs when the component receives focus.
OnExit The OnExit event occurs when the component loses focus.
OnHScroll The OnHScroll event occurs when horizontal scrollbar slider changes its position.
OnKeyDown The OnKeyDown event occurs if the component is focused and a keyboard key is pressed.
OnKeyPress The OnKeyPress event occurs if the component is focused when the user presses a character key.
OnKeyPreview The OnKeyPreview event occurs prior to each event related to key pressing.
OnKeyUp The OnKeyUp event occurs if the component is focused and the user releases any button previously pressed.
OnMouseDown The OnMouseDown event occurs if the pointer is in component's area and a mouse key is pressed.
OnMouseEnter The OnMouseEnter event occurs when mouse cursor enters the component area.
OnMouseHover The OnMouseHover event occurs when mouse cursor is held in the component area.
OnMouseLeave The OnMouseLeave event occurs when mouse cursor leaves the component area.
OnMouseMove The OnMouseMove event occurs on moving the cursor over component.
OnMouseUp The OnMouseUp event occurs on releasing mouse button when the cursor is in component area.
OnMouseWheel The OnMouseWheel event occurs if the component is focused when the mouse wheel is rotated.
OnNavigateComplete2 The OnNavigateComplete2 event occurs after navigating to a new web page.
OnVScroll The OnVScroll event occurs when vertical scrollbar slider changes its position.

See also:

Additional Components