DotNetBrowser  1.14
Public Member Functions | Protected Member Functions | Properties | Events | List of all members
DotNetBrowser.WinForms.WinFormsBrowserView Class Reference

WinForms implementation of the BrowserView interface. More...

Inherits Panel, DotNetBrowser.BrowserView, DotNetBrowser.UIComponent, IBrowserWatcher, and IBrowserProperties.

Public Member Functions

 WinFormsBrowserView ()
 Constructs a new WinFormsBrowserView component based on a new browser instance. More...
 
 WinFormsBrowserView (Browser browser)
 Constructs a new WinFormsBrowserView component based on passed browser instance. More...
 
UIComponent GetComponent ()
 Returns UIComponent instance that can be embedded into application GUI. More...
 
Image GetImage ()
 Returns image representation of the currently loaded and displayed web page. More...
 
void UpdateSize (int width, int height)
 Updates size of the this view. More...
 
void SetKeyFilter (KeyFilter keyFilter)
 Configures KeyFilter for this view. More...
 
double GetDeviceScaleFactor ()
 Returns device scale factor that is used to render this view. More...
 
new void Dispose ()
 Disposes current view. More...
 
BrowserView GetInnerView ()
 Gets view instance that can be embedded into application GUI. More...
 

Protected Member Functions

override void Dispose (bool disposing)
 Disposes current view. More...
 

Properties

new KeyPressEventHandler KeyPress
 Occurs when a key is pressed while the control has focus. More...
 
new MouseEventHandler MouseWheel
 Occurs when a mouse wheel is rotated while the control has focus. More...
 
new bool IsDisposed [get]
 Gets true when the current view instance is disposed. More...
 
bool Focused [set]
 Sets focus or unfocus to the view. Unfocus available only for BrowserType.HEAVYWEIGHT view. More...
 
Browser Browser [get]
 Browser instance associated with the current view. More...
 
EventHandler Load
 Occurs before the control becomes visible for the first time. More...
 
BrowserType BrowserType [get, set]
 Gets or sets rendering type for browser that will use for constructs a new WPFBrowserView component based on a new browser instance. Uses for create a new browser instance only. More...
 
string URL [get, set]
 Gets or sets the current Url. More...
 
double ZoomLevel [get, set]
 Gets or sets zoom level for the currently loaded web page. Zoom level is configured for each domain separately. For example, if you load the www.a.com web page and set zoom level to 2.5, then load the www.b.org web page, the zoom level for www.b.org web page will be reset to default value. When you load the www.a.com web page again, its zoom level will be restored to 2.5 automatically. More...
 
bool AudioMuted [get, set]
 Gets or sets mutes all audio output for this Browser instance. True when audio output must be muted, false otherwise. More...
 
string AcceptLanguage [get, set]
 Gets or sets a string that represents accept language for this Browser instance and all Browser instances with the same BrowserContext. More...
 
BrowserPreferences Preferences [get, set]
 Browser's preferences. More...
 
IInputSimulator InputSimulator [get]
 Returns input simulation controller instance. More...
 
IBackForwardNavigator BackForwardNavigator [get]
 Returns back-forward navigation controller instance. More...
 
- Properties inherited from DotNetBrowser.BrowserView
Browser Browser [get]
 Returns Browser instance associated with the current container. More...
 
bool IsDisposed [get]
 Gets a value indicating whether the current view has been disposed of. More...
 
IInputSimulator InputSimulator [get]
 Returns input simulation controller instance. More...
 
IBackForwardNavigator BackForwardNavigator [get]
 Returns back-forward navigation controller instance. More...
 
bool Focused [set]
 Sets focus or unfocus to the current view. Unfocus available only for BrowserType.HEAVYWEIGHT view. More...
 

Events

FinishLoadingFrameHandler FinishLoadingFrameEvent
 An event that indicates that frame loading process has been finished. More...
 
StartLoadingFrameHandler StartLoadingFrameEvent
 An event that indicates that frame loading process has been started. More...
 
FailLoadingFrameHandler FailLoadingFrameEvent
 An event that indicates that frame loading process has been failed. More...
 
ProvisionalLoadingFrameHandler ProvisionalLoadingFrameEvent
 An event that indicates that provisional load for a specified frame was successfully committed. More...
 
DocumentLoadedInFrameHandler DocumentLoadedInFrameEvent
 An event that indicates that frame with a document is loaded. More...
 
DocumentLoadedInMainFrameHandler DocumentLoadedInMainFrameEvent
 An event that indicates that main frame with a document is loaded. More...
 
RenderCreatedHandler RenderCreatedEvent
 An event that indicates that the render process is gone or created. More...
 
RenderCreatedHandler RenderGoneEvent
 An event that indicates that the render process is gone. More...
 
RenderCreatedHandler RenderResponsiveEvent
 An event that indicates that the render process is no longer hung. More...
 
RenderCreatedHandler RenderUnresponsiveEvent
 An event that indicates that the render process is hung. More...
 
StatusEventHandler StatusChangedEvent
 An event that indicates that the status has been changed. More...
 
TitleChangedHandler TitleChangedEvent
 An event that indicates that the title of a document in main frame has been changed. More...
 
ConsoleMessageHandler ConsoleMessageEvent
 An event that indicates that the message was added to the console. More...
 
DragDropHandler DragEnterEvent
 An event that indicates that the object is dragged into the browser's bounds. More...
 
DragDropHandler DragExitEvent
 An event that indicates that the object is dragged out of the browser's bounds. More...
 
DragDropHandler DropEvent
 An event that indicates when a drag-and-drop operation is completed. More...
 
GestureEventHandler GestureEvent
 An event that indicates when the gesture status has been changed. More...
 
DisposeEventHandler DisposeEvent
 An event that indicates that browser instance disposed. More...
 
ScriptContextCreatedHandler ScriptContextCreated
 An event that indicates that JavaScript context has been created. The event is invoked synchronously blocking JavaScript execution. Don't block current method execution for too long to avoid web page loading and displaying performance. More...
 
ScriptContextDestroyedHandler ScriptContextDestroyed
 An event that indicates that JavaScript context has been destroyed. The event is invoked synchronously blocking JavaScript execution. Don't block current method execution for too long to avoid web page loading and displaying performance. More...
 

Detailed Description

WinForms implementation of the BrowserView interface.

Constructor & Destructor Documentation

DotNetBrowser.WinForms.WinFormsBrowserView.WinFormsBrowserView ( )

Constructs a new WinFormsBrowserView component based on a new browser instance.

DotNetBrowser.WinForms.WinFormsBrowserView.WinFormsBrowserView ( Browser  browser)

Constructs a new WinFormsBrowserView component based on passed browser instance.

Parameters
browserThe Browser instance associated with the current view.
Exceptions
ArgumentNullExceptionwhen browser is null.

Member Function Documentation

new void DotNetBrowser.WinForms.WinFormsBrowserView.Dispose ( )

Disposes current view.

override void DotNetBrowser.WinForms.WinFormsBrowserView.Dispose ( bool  disposing)
protected

Disposes current view.

UIComponent DotNetBrowser.WinForms.WinFormsBrowserView.GetComponent ( )

Returns UIComponent instance that can be embedded into application GUI.

Returns
UIComponent instance.

Implements DotNetBrowser.BrowserView.

double DotNetBrowser.WinForms.WinFormsBrowserView.GetDeviceScaleFactor ( )

Returns device scale factor that is used to render this view.

Returns
The device scale factor.

Implements DotNetBrowser.BrowserView.

Image DotNetBrowser.WinForms.WinFormsBrowserView.GetImage ( )

Returns image representation of the currently loaded and displayed web page.

Returns
The drawing.Image instance or null if web page is not loaded or not displayed.

Implements DotNetBrowser.BrowserView.

BrowserView DotNetBrowser.WinForms.WinFormsBrowserView.GetInnerView ( )

Gets view instance that can be embedded into application GUI.

void DotNetBrowser.WinForms.WinFormsBrowserView.SetKeyFilter ( KeyFilter  keyFilter)

Configures KeyFilter for this view.

Parameters
keyFilterThe KeyFilter instance.

Implements DotNetBrowser.BrowserView.

void DotNetBrowser.WinForms.WinFormsBrowserView.UpdateSize ( int  width,
int  height 
)

Updates size of the this view.

Parameters
widthNew width in pixels.
heightNew height in pixels.

Implements DotNetBrowser.BrowserView.

Property Documentation

string DotNetBrowser.WinForms.WinFormsBrowserView.AcceptLanguage
getset

Gets or sets a string that represents accept language for this Browser instance and all Browser instances with the same BrowserContext.

Exceptions
ArgumentNullExceptionwhen value set null.
ArgumentExceptionwhen value set empty.
bool DotNetBrowser.WinForms.WinFormsBrowserView.AudioMuted
getset

Gets or sets mutes all audio output for this Browser instance. True when audio output must be muted, false otherwise.

IBackForwardNavigator DotNetBrowser.WinForms.WinFormsBrowserView.BackForwardNavigator
get

Returns back-forward navigation controller instance.

Browser DotNetBrowser.WinForms.WinFormsBrowserView.Browser
get

Browser instance associated with the current view.

BrowserType DotNetBrowser.WinForms.WinFormsBrowserView.BrowserType
getset

Gets or sets rendering type for browser that will use for constructs a new WPFBrowserView component based on a new browser instance. Uses for create a new browser instance only.

Exceptions
InvalidOperationExceptionif the value is set when a browser instance has already been created
bool DotNetBrowser.WinForms.WinFormsBrowserView.Focused
set

Sets focus or unfocus to the view. Unfocus available only for BrowserType.HEAVYWEIGHT view.

IInputSimulator DotNetBrowser.WinForms.WinFormsBrowserView.InputSimulator
get

Returns input simulation controller instance.

new bool DotNetBrowser.WinForms.WinFormsBrowserView.IsDisposed
get

Gets true when the current view instance is disposed.

new KeyPressEventHandler DotNetBrowser.WinForms.WinFormsBrowserView.KeyPress
addremove

Occurs when a key is pressed while the control has focus.

EventHandler DotNetBrowser.WinForms.WinFormsBrowserView.Load
addremove

Occurs before the control becomes visible for the first time.

new MouseEventHandler DotNetBrowser.WinForms.WinFormsBrowserView.MouseWheel
addremove

Occurs when a mouse wheel is rotated while the control has focus.

BrowserPreferences DotNetBrowser.WinForms.WinFormsBrowserView.Preferences
getset

Browser's preferences.

string DotNetBrowser.WinForms.WinFormsBrowserView.URL
getset

Gets or sets the current Url.

double DotNetBrowser.WinForms.WinFormsBrowserView.ZoomLevel
getset

Gets or sets zoom level for the currently loaded web page. Zoom level is configured for each domain separately. For example, if you load the www.a.com web page and set zoom level to 2.5, then load the www.b.org web page, the zoom level for www.b.org web page will be reset to default value. When you load the www.a.com web page again, its zoom level will be restored to 2.5 automatically.

This property asynchronously.

  • To zoom in use the positive zoom level. For example, 2.0, 1.5.
  • To zoom out use the negative zoom level. For example, -1.0, -2.5.

Event Documentation

ConsoleMessageHandler DotNetBrowser.WinForms.WinFormsBrowserView.ConsoleMessageEvent

An event that indicates that the message was added to the console.

DisposeEventHandler DotNetBrowser.WinForms.WinFormsBrowserView.DisposeEvent

An event that indicates that browser instance disposed.

DocumentLoadedInFrameHandler DotNetBrowser.WinForms.WinFormsBrowserView.DocumentLoadedInFrameEvent

An event that indicates that frame with a document is loaded.

DocumentLoadedInMainFrameHandler DotNetBrowser.WinForms.WinFormsBrowserView.DocumentLoadedInMainFrameEvent

An event that indicates that main frame with a document is loaded.

DragDropHandler DotNetBrowser.WinForms.WinFormsBrowserView.DragEnterEvent

An event that indicates that the object is dragged into the browser's bounds.

DragDropHandler DotNetBrowser.WinForms.WinFormsBrowserView.DragExitEvent

An event that indicates that the object is dragged out of the browser's bounds.

DragDropHandler DotNetBrowser.WinForms.WinFormsBrowserView.DropEvent

An event that indicates when a drag-and-drop operation is completed.

FailLoadingFrameHandler DotNetBrowser.WinForms.WinFormsBrowserView.FailLoadingFrameEvent

An event that indicates that frame loading process has been failed.

FinishLoadingFrameHandler DotNetBrowser.WinForms.WinFormsBrowserView.FinishLoadingFrameEvent

An event that indicates that frame loading process has been finished.

GestureEventHandler DotNetBrowser.WinForms.WinFormsBrowserView.GestureEvent

An event that indicates when the gesture status has been changed.

ProvisionalLoadingFrameHandler DotNetBrowser.WinForms.WinFormsBrowserView.ProvisionalLoadingFrameEvent

An event that indicates that provisional load for a specified frame was successfully committed.

RenderCreatedHandler DotNetBrowser.WinForms.WinFormsBrowserView.RenderCreatedEvent

An event that indicates that the render process is gone or created.

RenderCreatedHandler DotNetBrowser.WinForms.WinFormsBrowserView.RenderGoneEvent

An event that indicates that the render process is gone.

RenderCreatedHandler DotNetBrowser.WinForms.WinFormsBrowserView.RenderResponsiveEvent

An event that indicates that the render process is no longer hung.

RenderCreatedHandler DotNetBrowser.WinForms.WinFormsBrowserView.RenderUnresponsiveEvent

An event that indicates that the render process is hung.

ScriptContextCreatedHandler DotNetBrowser.WinForms.WinFormsBrowserView.ScriptContextCreated

An event that indicates that JavaScript context has been created. The event is invoked synchronously blocking JavaScript execution. Don't block current method execution for too long to avoid web page loading and displaying performance.

ScriptContextDestroyedHandler DotNetBrowser.WinForms.WinFormsBrowserView.ScriptContextDestroyed

An event that indicates that JavaScript context has been destroyed. The event is invoked synchronously blocking JavaScript execution. Don't block current method execution for too long to avoid web page loading and displaying performance.

StartLoadingFrameHandler DotNetBrowser.WinForms.WinFormsBrowserView.StartLoadingFrameEvent

An event that indicates that frame loading process has been started.

StatusEventHandler DotNetBrowser.WinForms.WinFormsBrowserView.StatusChangedEvent

An event that indicates that the status has been changed.

TitleChangedHandler DotNetBrowser.WinForms.WinFormsBrowserView.TitleChangedEvent

An event that indicates that the title of a document in main frame has been changed.