WebBrowser

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Control
  • WebBrowser

Represents a web browser control that enables the user to navigate web pages inside a form or a page.

C#

public class WebBrowser : Control

VB.NET

Public Class WebBrowser
    Inherits Control

Constructors

WebBrowser()

Initializes a new instance of the WebBrowser class.

WebBrowser(url, onDocumentCompleted)

Initializes a new instance of the WebBrowser class with a URL as a string and an event handler for the DocumentCompleted event.

Name	Type	Description
url	String	The URL of the webpage to be loaded in the WebBrowser as a string.
onDocumentCompleted	Action<Object, WebBrowserDocumentCompletedEventArgs>	An Action delegate to handle the DocumentCompleted event. Can be null.

WebBrowser(location, size, onDocumentCompleted)

Initializes a new instance of the WebBrowser class with a specified location and size.

Name	Type	Description
location	Point	The location of the WebBrowser on its parent control.
size	Size	The size of the WebBrowser.
onDocumentCompleted	Action<Object, WebBrowserDocumentCompletedEventArgs>	An Action delegate to handle the DocumentCompleted event. Can be null.

WebBrowser(url, location, size, onDocumentCompleted)

Initializes a new instance of the WebBrowser class with the specified settings.

Name	Type	Description
url	String	The URL of the webpage to be loaded in the WebBrowser as a string.
location	Point	The location of the WebBrowser on its parent control.
size	Size	The size of the WebBrowser.
onDocumentCompleted	Action<Object, WebBrowserDocumentCompletedEventArgs>	An Action delegate to handle the DocumentCompleted event. Can be null.

Properties

BorderStyle

BorderStyle: Indicates the border style for the control. (Default: Solid)

DefaultSize

Size: The default Size of the control.

ScrollBarsEnabled

Boolean: Returns or sets a value indicating whether scroll bars are displayed in the WebBrowser control. (Default: True)

Url

Uri: Returns or sets the URL of the current document. (Default: null)

Throws:

• ArgumentException The specified value when setting this property is not an absolute URI. For more information, see IsAbsoluteUri.

Methods

GoBack()

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

Due to IFrame security constraints, this method will not work when the source of the IFrame content is from a different domain.

GoForward()

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

Due to IFrame security constraints, this method will not work when the source of the IFrame content is from a different domain.

Navigate(url)

Loads the document at the location indicated by the specified Uri into the WebBrowser control.

Parameter	Type	Description
url	Uri	A Uri representing the URL of the document to load.

Throws:

• ArgumentException The url parameter value does not represent an absolute URI. For more information, see IsAbsoluteUri.

Navigate(url)

Loads the document at the specified Uniform Resource Locator (URL) into the WebBrowser control.

Parameter	Type	Description
url	String	The URL of the document to load.

OnDocumentCompleted(e)

Fires the DocumentCompleted event.

Parameter	Type	Description
e	WebBrowserDocumentCompletedEventArgs	A WebBrowserDocumentCompletedEventArgs that contains the event data.

OnWebEvent(e)

Processes the event from the client.

Parameter	Type	Description
e	WisejEventArgs	Event arguments.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

Events

DocumentCompleted

WebBrowserDocumentCompletedEventHandler Fired when the WebBrowser control finishes loading a web page.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IBindableComponent	Bindable components implement this interface.
IDropTarget	Controls that support drag & drop operations implement this interface.
IWisejComponent	All wisej components implement this interface.
IWisejControl	All wisej controls derived from the Control class must implement this interface.
IWisejSerializable	Allows an object to serialize itself.