WebBrowserExtended Class

Definition

Represents the UII extended web browser control.

public ref class WebBrowserExtended : System::Windows::Forms::UserControl, Microsoft::Uii::Csr::Browser::Web::IWebBrowser
[System.Drawing.ToolboxBitmap(typeof(Microsoft.Uii.Csr.Browser.Web.WebBrowserExtended), "ie.ico")]
public class WebBrowserExtended : System.Windows.Forms.UserControl, Microsoft.Uii.Csr.Browser.Web.IWebBrowser
[<System.Drawing.ToolboxBitmap(typeof(Microsoft.Uii.Csr.Browser.Web.WebBrowserExtended), "ie.ico")>]
type WebBrowserExtended = class
    inherit UserControl
    interface IWebBrowser
Public Class WebBrowserExtended
Inherits UserControl
Implements IWebBrowser
Inheritance
WebBrowserExtended
Attributes
Implements

Remarks

Differs from the System.Windows.Forms.WebBrowser control in that a separate iexplore.exe process is launched, hosted, and managed by the control. Advantage is multiple instances of the same web browser application will not share in-memory cookies or authentication state.

Constructors

WebBrowserExtended()

Initializes an instance of the WebBrowserExtended class using the background Internet Explorer process using dynamic window positioning technique.

WebBrowserExtended(Boolean)

Initializes an instance of the WebBrowserExtended control.

WebBrowserExtended(Boolean, Boolean, Boolean)

Initializes an instance of the WebBrowserExtended control.

Properties

Document

Gets an mshtml.HTMLDocument (an RCW) representing the web page currently displayed in the WebBrowserExtended control.

HostOnTop

Gets a Boolean value that specifies whether the host is on top.

IEFrameHandle

Gets the handle of started browser window.

isAppClosing

Gets or sets a Boolean value that specifies whether the application is closing.

IsBusy

Gets a value that specifies whether the WebBrowser control is currently loading a new document.

IsOffline

Gets a value that specifies whether the WebBrowser control is in offline mode.

MainWindow

Gets or sets the top-level window handle of the WebBrowser.

ReadyState

Gets a value that specifies the current state of the WebBrowser control.

StatusText

Gets the status text of the WebBrowser control.

Url

Gets or sets the URL of the current document.

Version

Gets the version of Internet Explorer installed.

WebBrowser

Gets the IWebBrowser2 object instance contained within this control.

WebBrowserExtendedState

Gets the current state of the WebBrowserExtended control.

Methods

Activate()

For internal Use

AttachHandler(WebBrowserEvent, Delegate)
AttachIE()

Internal Use only.

AttachListenersForWindowPositioning(TabItem)

Attaches to events on the specified tabItem and parent tabControl to support window positioning. Multiple invocations with the same tabItem will have the same effect as a single invocation. If window positioning is not configured, this method will have no effect.

AttachListenersForWindowPositioning(TabPage)

Attaches to events on the specified tabPage and parent tabControl to support window positioning. Multiple invocations with the same tabPage will have the same effect as a single invocation. If window positioning is not configured, this method will have no effect.

ClearCache()

Clears the Temporary Internet Files cache

CloseBrowser()

Closes the hosted instance of Internet Explorer.

DetachAllListenersForWindowPositioning()

Detaches any previously attached events that support window positioning. If window positioning is not configured, this method will have no effect.

DetachAllListenersForWpfWindowPositioning()

Detaches any previously attached events that support window positioning. If window positioning is not configured, this method will have no effect.

DetachIE()

Internal Use only.

Dispose(Boolean)

Clean up any resources being used.

GoBack()

Navigates the WebBrowser control to the previous page in the navigation history, if one is available.

GoForward()

Navigates the WebBrowser control to the next page in the navigation history, if one is available.

GoHome()

Navigates the WebBrowser control to the home page of the current user.

HidePositionedWindow()

Hides the positioned window. If window positioning is not configured, this method will have no effect.

Navigate(String)

Loads the document at the specified Uniform Resource Locator (URL) into the WebBrowser control, replacing the previous document. This overload starts the browser when necessary.

Navigate(String, String, Byte[], String)

Loads the document at the specified Uniform Resource Locator (URL) into the WebBrowser control, requesting it using the specified HTTP data and replacing the contents of the Web page frame with the specified name. This overload starts the browser when necessary. When browser has not been started, that is when WebBrowserExtendedState != BrowserAcquired, all parameters except urlString are disregarded.

OnPaint(Object, PaintEventArgs)

Called when [paint].

OnVisibleChanged(Object, EventArgs)

Called when [visible changed].

Refresh()

Reloads the document currently displayed in the WebBrowser control by checking the server for an updated version.

Refresh(WebBrowserRefreshOption)

Reloads the document currently displayed in the WebBrowser control using the specified refresh options.

RemoveHandler(WebBrowserEvent, Delegate)
ShowAndActivateDeckPositionedWindow()

Shows and activates (sizes and positions) the positioned window. If window positioning is not configured, this method will have no effect.

ShowAndActivatePositionedWindow()

Shows and activates (sizes and positions) the positioned window. If window positioning is not configured, this method will have no effect.

Stop()

Cancels any pending navigation and stops any dynamic page elements, such as background sounds and animations.

Events

BeforeNavigate

Fires when BeforeNavigate2(Object, Object, Object, Object, Object, Object, Boolean) event fires.

BeforeNavigate_

Fires before navigation occurs in the given object (on either a window or frameset element). (deprecated)

BeforeNavigate2

Fires before navigation occurs in the given object (on either a window element or a frameset element).

BeforeNewWindow

Fires when NewWindow2(Object, Boolean)and NewWindow3(Object, Boolean, UInt32, String, String) events fire.

BrowserObjectAppeared

Fires when the browser process object (IWebBrowser2) appears, providing an opportunity to manipulate its properties.

BrowserProcessExited

Fires when the hosted browser process exits when the WebBrowserExtended control is still valid (not disposed).

ClientToHostWindow

Fires to request that the client window size is converted to the host window size.

CommandStateChange

Fires when the enabled state of a command changes.

DocumentComplete

Fires when a document is completely loaded and initialized.

DocumentCompleted

Same as DocumentComplete, included for backward compatibility

DownloadBegin

Fires when a navigation operation begins.

DownloadComplete

Fires when a navigation operation finishes, is halted, or fails.

DownloadCompleted

Same as DownloadComplete, included for backward compatibility.

DownloadStarted

Same as DownloadBegin, included for backward compatibility.

FileDownload

Fires to indicate that a file download is about to occur. If a file download dialog box can be displayed, this event fires prior to the appearance of the dialog box.

FrameBeforeNavigate

Fires before navigation occurs in the given object (on either a window or frameset element). (deprecated)

FrameNavigateComplete

Fires after a navigation to a link is completed on either a window element or a frameSet element. (deprecated)

FrameNewWindow

Fires when a new window is to be created. (deprecated)

NavigateComplete

Fires after a navigation to a link is completed on either a window element or a frameSet element. (deprecated)

NavigateComplete2

Fires after a navigation to a link is completed on a window element or a frameSet element.

Navigated

Same as NavigateComplete2, included for backward compatibility

NavigateError

Fires when an error occurs during navigation.

NewWindow

Fires when a new window is to be created. (deprecated)

NewWindow2

Fires when a new window is to be created.

NewWindow3

Raised when a new window is to be created. Extends NewWindow2 with additional information about the new window. Available in WinXP SP2 and later.

OnFullScreen

Fires when the FullScreenproperty is changed.

OnMenuBar

Fires when the MenuBar property is changed.

OnQuit
Obsolete.

Fires before the Internet Explorer application quits. (deprecated)

OnStatusBar

Fires when the StatusBar property is changed.

OnTheaterMode

Fires when the TheaterMode property is changed.

OnToolBar

Fires when the ToolBarproperty is changed.

OnVisible

Fires when the Visible property of the object is changed.

PageLoadComplete

Fires when the browser object has finished downloading the entire page.

PrintTemplateInstantiation

Fires when a print template is instantiated.

PrintTemplateTeardown

Fires when a print template is instantiated.

PrivacyImpactedStateChange

Fired when an event occurs that impacts privacy, or when a user navigates away from a URL that has impacted privacy.

ProgressChange

Fires when the progress of a download operation is updated on the object.

PropertyChange

Fires when the IWebBrowser2::PutProperty method of the object changes the value of a property.

Quit

Fires before the Internet Explorer application quits.

SetPhishingFilterStatus

Fires to indicate the progress and status of Microsoft Phishing Filter analysis of the current webpage.

SetSecureLockIcon

Fires when there is a change in encryption level.

StatusTextChange

Fires when the status bar text of the object has changed.

TitleChange

Fires when the status bar text of the object has changed.

UpdatePageStatus

Not implemented.

WindowClosing

Fires when the window of the object is about to be closed by script.

WindowSetHeight

Fires when the object changes its height.

WindowSetLeft

Fires when the object changes its left position.

WindowSetResizable

Fires to indicate whether the host window should allow resizing of the object.

WindowSetTop

Fires when the object changes its top position.

WindowSetWidth

Fires when the object changes its width

WindowStateChanged

Fires when the visibility state of a content window, such as the browser window or a tab, changes.

Applies to