ChromiumWebBrowser Class |
Namespace: CefSharp.OffScreen
The ChromiumWebBrowser type exposes the following members.
Name | Description | |
---|---|---|
ChromiumWebBrowser |
Create a new OffScreen Chromium Browser
|
Name | Description | |
---|---|---|
Address |
The address (URL) which the browser control is currently displaying.
Will automatically be updated as the user navigates to another page (e.g. by clicking on a link).
| |
Bitmap |
Contains the last rendering from Chromium. Direct access
to the underlying Bitmap - there is no locking when trying
to access directly, use BitmapLock where appropriate.
A new bitmap is only created when it's size changes, otherwise
the back buffer for the bitmap is constantly updated.
Read the InvokeRenderAsync(BitmapInfo) doco for more info.
| |
BitmapFactory |
Gets or sets the bitmap factory.
| |
BrowserSettings |
Gets the browser settings.
| |
CanExecuteJavascriptInMainFrame |
A flag that indicates if you can execute javascript in the main frame.
Flag is set to true in IRenderProcessMessageHandler.OnContextCreated.
and false in IRenderProcessMessageHandler.OnContextReleased
| |
CanGoBack |
A flag that indicates whether the state of the control current supports the GoBack action (true) or not (false).
| |
CanGoForward |
A flag that indicates whether the state of the control currently supports the GoForward action (true) or not (false).
| |
DialogHandler |
Implement IDialogHandler and assign to handle dialog events.
| |
DisplayHandler |
Implement IDisplayHandler and assign to handle events related to browser display state.
| |
DownloadHandler |
Implement IDownloadHandler and assign to handle events related to downloading files.
| |
DragHandler |
Implement IDragHandler and assign to handle events related to dragging.
| |
FindHandler |
Implement IFindHandler to handle events related to find results.
| |
FocusHandler |
Implement IFocusHandler and assign to handle events related to the browser component's focus
| |
GeolocationHandler |
Implement IGeolocationHandler and assign to handle requests for permission to use geolocation.
| |
IsBrowserInitialized |
A flag that indicates whether the WebBrowser is initialized (true) or not (false).
| |
IsLoading |
A flag that indicates whether the control is currently loading one or more web pages (true) or not (false).
| |
JavascriptObjectRepository | ||
JsDialogHandler |
Implement IJsDialogHandler and assign to handle events related to JavaScript Dialogs.
| |
KeyboardHandler |
Implement IKeyboardHandler and assign to handle events related to key press.
| |
LifeSpanHandler |
Implement ILifeSpanHandler and assign to handle events related to popups.
| |
LoadHandler |
Implement ILoadHandler and assign to handle events related to browser load status.
| |
MenuHandler |
Implement IContextMenuHandler and assign to handle events related to the browser context menu
| |
Popup |
The popup Bitmap.
| |
PopupOpen |
Gets or sets a value indicating whether the popup is open.
| |
PopupPosition |
Gets the popup position.
| |
PopupSize |
Gets the size of the popup.
| |
RenderProcessMessageHandler |
Implement IRenderProcessMessageHandler and assign to handle messages from the render process.
| |
RequestContext |
Gets the request context.
| |
RequestHandler |
Implement IRequestHandler and assign to handle events related to browser requests.
| |
ResourceHandlerFactory |
Implement IResourceHandlerFactory and control the loading of resources
| |
Size |
Get/set the size of the Chromium viewport, in pixels.
This also changes the size of the next rendered bitmap.
| |
TooltipText |
The text that will be displayed as a ToolTip
|
Name | Description | |
---|---|---|
CreateBrowser |
Create the underlying browser. The instance address, browser settings and request context will be used.
| |
Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
| |
Dispose(Boolean) |
Releases unmanaged and - optionally - managed resources.
| |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize |
Finalizes an instance of the ChromiumWebBrowser class.
(Overrides ObjectFinalize.) | |
GetBrowser |
Returns the current CEF Browser Instance
| |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetScreenInfo |
Gets the screen information (scale factor).
| |
GetScreenPoint |
Called to retrieve the translation from view coordinates to actual screen coordinates.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetViewRect |
Gets the view rect (width, height)
| |
InvokeRenderAsync | ||
Load |
Loads the specified URL.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnImeCompositionRangeChanged | ||
RegisterAsyncJsObject | Asynchronously registers a Javascript object in this specific browser instance. Only methods of the object will be availabe. | |
RegisterJsObject |
Registers a Javascript object in this specific browser instance.
| |
ScreenshotAsync |
Starts a task that waits for the next rendering from Chrome.
Chrome also renders the page loading, so if you want to see a complete rendering,
only start this task once your page is loaded (which you can detect via FrameLoadEnd
or your own heuristics based on evaluating JavaScript).
It is your responsibility to dispose the returned Bitmap.
The bitmap size is determined by the Size property set earlier.
| |
ScreenshotOrNull | Obsolete.
Immediately returns a copy of the last rendering from Chrome,
or null if no rendering has occurred yet.
Chrome also renders the page loading, so if you want to see a complete rendering,
only start this task once your page is loaded (which you can detect via LoadingStateChanged/FrameLoadEnd
or your own heuristics based on evaluating JavaScript).
It is your responsibility to dispose the returned Bitmap.
The bitmap size is determined by the Size property set earlier.
| |
SetCursor |
Sets the cursor.
| |
SetPopupIsOpen | ||
SetPopupSizeAndPosition |
Sets the popup size and position.
| |
StartDragging |
Starts dragging.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
UpdateDragCursor |
Name | Description | |
---|---|---|
AddressChanged |
Occurs when [address changed].
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
(The exception to this is when your running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
| |
BrowserInitialized |
Occurs when [browser initialized].
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
(The exception to this is when your running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
| |
ConsoleMessage |
Event handler for receiving Javascript console messages being sent from web pages.
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
(The exception to this is when your running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
| |
FrameLoadEnd |
Event handler that will get called when the browser is done loading a frame. Multiple frames may be loading at the same
time. Sub-frames may start or continue loading after the main frame load has ended. This method will always be called
for all frames irrespective of whether the request completes successfully.
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
| |
FrameLoadStart |
Event handler that will get called when the browser begins loading a frame. Multiple frames may be loading at the same
time. Sub-frames may start or continue loading after the main frame load has ended. This method may not be called for a
particular frame if the load request for that frame fails. For notification of overall browser load status use
OnLoadingStateChange instead.
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
| |
LoadError |
Event handler that will get called when the resource load for a navigation fails or is canceled.
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
| |
LoadingStateChanged |
Event handler that will get called when the Loading state has changed.
This event will be fired twice. Once when loading is initiated either programmatically or
by user action, and once when loading is terminated due to completion, cancellation of failure.
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
| |
NewScreenshot | Obsolete.
Fired by a separate thread when Chrome has re-rendered.
This means that a Bitmap will be returned by ScreenshotOrNull().
| |
OnPaint |
Fired on the CEF UI thread, which by default is not the same as your application main thread.
Called when an element should be painted. Pixel values passed to this method are scaled relative to view coordinates
based on the value of ScreenInfo.DeviceScaleFactor returned from GetScreenInfo. |type| indicates whether the element
is the view or the popup widget. |buffer| contains the pixel data for the whole image. |dirtyRects| contains the set
of rectangles in pixel coordinates that need to be repainted. |buffer| will be |width|*|height|*4 bytes in size and
represents a BGRA image with an upper-left origin.
| |
StatusMessage |
Event handler for changes to the status message.
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
(The exception to this is when your running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
| |
TitleChanged |
Occurs when [title changed].
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
(The exception to this is when your running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
|
Name | Description | |
---|---|---|
BitmapLock |
Need a lock because the caller may be asking for the bitmap
while Chromium async rendering has returned on another thread.
|
Name | Description | |
---|---|---|
AddWordToDictionary |
Add the specified word to the spelling dictionary.
(Defined by WebBrowserExtensions.) | |
Back |
Navigates back, must check CanGoBack before calling this method.
(Defined by WebBrowserExtensions.) | |
CloseDevTools |
Explicitly close the developer tools window if one exists for this browser instance.
(Defined by WebBrowserExtensions.) | |
Copy |
Execute Copy on the focused frame
(Defined by WebBrowserExtensions.) | |
Cut |
Execute Cut on the focused frame
(Defined by WebBrowserExtensions.) | |
Delete |
Execute Delete on the focused frame
(Defined by WebBrowserExtensions.) | |
EvaluateScriptAsync(String, NullableTimeSpan) | Overloaded. (Defined by WebBrowserExtensions.) | |
EvaluateScriptAsync(String, Object) | Overloaded.
Evaluate some Javascript code in the context of this WebBrowser. The script will be executed asynchronously and the
method returns a Task encapsulating the response from the Javascript
This simple helper extension will encapsulate params in single quotes (unless int, uint, etc)
(Defined by WebBrowserExtensions.) | |
EvaluateScriptAsync(NullableTimeSpan, String, Object) | Overloaded.
Evaluate some Javascript code in the context of this WebBrowser using the specified timeout. The script will be executed asynchronously and the
method returns a Task encapsulating the response from the Javascript
This simple helper extension will encapsulate params in single quotes (unless int, uint, etc)
(Defined by WebBrowserExtensions.) | |
ExecuteScriptAsync(String) | Overloaded.
Execute some Javascript code in the context of this WebBrowser. As the method name implies, the script will be
executed asynchronously, and the method therefore returns before the script has actually been executed.
(Defined by WebBrowserExtensions.) | |
ExecuteScriptAsync(String, Object) | Overloaded.
Execute some Javascript code in the context of this WebBrowser. As the method name implies, the script will be
executed asynchronously, and the method therefore returns before the script has actually been executed.
This simple helper extension will encapsulate params in single quotes (unless int, uint, etc)
(Defined by WebBrowserExtensions.) | |
Find |
Search for text within the current page.
(Defined by WebBrowserExtensions.) | |
Forward |
Navigates forward, must check CanGoForward before calling this method.
(Defined by WebBrowserExtensions.) | |
GetBrowserHost |
Shortcut method to get the browser IBrowserHost
(Defined by WebBrowserExtensions.) | |
GetFocusedFrame |
Returns the focused frame for the browser window.
(Defined by WebBrowserExtensions.) | |
GetMainFrame |
Returns the main (top-level) frame for the browser window.
(Defined by WebBrowserExtensions.) | |
GetSourceAsync |
Retrieve the main frame's HTML source using a TaskTResult.
(Defined by WebBrowserExtensions.) | |
GetTextAsync |
Retrieve the main frame's display text using a TaskTResult.
(Defined by WebBrowserExtensions.) | |
GetZoomLevelAsync |
Asynchronously gets the current Zoom Level.
(Defined by WebBrowserExtensions.) | |
LoadHtml(String, String) | Overloaded.
Registers and loads a ResourceHandler that represents the HTML content.
(Defined by WebBrowserExtensions.) | |
LoadHtml(String, Boolean) | Overloaded.
Loads html as Data Uri
See https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs for details
If base64Encode is false then html will be Uri encoded
(Defined by WebBrowserExtensions.) | |
LoadHtml(String, String, Encoding, Boolean) | Overloaded.
Registers and loads a ResourceHandler that represents the HTML content.
(Defined by WebBrowserExtensions.) | |
LoadString |
Load the string contents with the specified dummy url. Web security restrictions may not behave as expected.
(Defined by WebBrowserExtensions.) | |
LoadUrlWithPostData |
Loads
Creates a new instance of IRequest with the specified Url and Method = POST
(Defined by WebBrowserExtensions.) | |
Paste |
Execute Paste on the focused frame
(Defined by WebBrowserExtensions.) | |
Opens a Print Dialog which if used (can be user cancelled) will print the browser contents.
(Defined by WebBrowserExtensions.) | ||
PrintToPdfAsync |
Asynchronously prints the current browser contents to the PDF file specified.
The caller is responsible for deleting the file when done.
(Defined by WebBrowserExtensions.) | |
Redo |
Execute Redo on the focused frame
(Defined by WebBrowserExtensions.) | |
RegisterResourceHandler |
Register a ResourceHandler. Can only be used when browser.ResourceHandlerFactory is an instance of DefaultResourceHandlerFactory
(Defined by WebBrowserExtensions.) | |
Reload | Overloaded.
Reloads the page being displayed. This method will use data from the browser's cache, if available.
(Defined by WebBrowserExtensions.) | |
Reload(Boolean) | Overloaded.
Reloads the page being displayed, optionally ignoring the cache (which means the whole page including all .css, .js
etc. resources will be re-fetched).
(Defined by WebBrowserExtensions.) | |
ReplaceMisspelling |
If a misspelled word is currently selected in an editable node calling
this method will replace it with the specified word.
(Defined by WebBrowserExtensions.) | |
SelectAll |
Execute SelectAll on the focused frame
(Defined by WebBrowserExtensions.) | |
SendMouseWheelEvent | (Defined by WebBrowserExtensions.) | |
SetAsPopup | (Defined by WebBrowserExtensions.) | |
SetZoomLevel |
Change the ZoomLevel to the specified value. Can be set to 0.0 to clear the zoom level.
(Defined by WebBrowserExtensions.) | |
ShowDevTools |
Open developer tools in its own window.
(Defined by WebBrowserExtensions.) | |
Stop |
Stops loading the current page.
(Defined by WebBrowserExtensions.) | |
StopFinding |
Cancel all searches that are currently going on.
(Defined by WebBrowserExtensions.) | |
ThrowExceptionIfBrowserNotInitialized | (Defined by WebBrowserExtensions.) | |
Undo |
Execute Undo on the focused frame
(Defined by WebBrowserExtensions.) | |
UnRegisterResourceHandler |
Unregister a ResourceHandler. Can only be used when browser.ResourceHandlerFactory is an instance of DefaultResourceHandlerFactory
(Defined by WebBrowserExtensions.) | |
ViewSource |
Opens up a new program window (using the default text editor) where the source code of the currently displayed web
page is shown.
(Defined by WebBrowserExtensions.) |