CefSharp.OffScreen

BitmapBuffer contains a byte[] used to store the Bitmap generated from and associated methods for updating that buffer and creating a from the actaual Buffer

Number of bytes

Width

Height

Dirty Rect - unified region containing th

Locking object used to syncronise access to the underlying buffer

Create a new instance of BitmapBuffer

Reference to the bitmapLock, a shared lock object is expected

Get the byte[] array that represents the Bitmap

Copy data from the unmanaged buffer (IntPtr) into our managed buffer. Locks BitmapLock before performing any update

width height pointer to unmanaged buffer (void*) rectangle to be updated

Creates a new Bitmap given with the current Width/Height and then copies the buffer that represents the bitmap. Locks before creating the

A new bitmap

Initialization settings. Many of these and other settings can also configured using command-line switches.

Intialize with default values

Enables Audio - by default audio is muted in the OffScreen implementatio. This removes the mute-audio command line flag

An offscreen instance of Chromium that you can use to take snapshots or evaluate JavaScript.

The managed cef browser adapter

Size of the Chromium viewport. This must be set to something other than 0x0 otherwise Chromium will not render, and the ScreenshotAsync task will deadlock.

Flag to guard the creation of the underlying offscreen browser - only one instance can be created

Action which is called immediately before the event after the uderlying Chromium Embedded Framework (CEF) browser has been created.

Gets a value indicating whether this instance is disposed.

if this instance is disposed; otherwise, .

A flag that indicates whether the WebBrowser is initialized (true) or not (false).

true if this instance is browser initialized; otherwise, false.

A flag that indicates whether the control is currently loading one or more web pages (true) or not (false).

true if this instance is loading; otherwise, false. In the WPF control, this property is implemented as a Dependency Property and fully supports data binding.

The text that will be displayed as a ToolTip

The tooltip text.

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).

The address. In the WPF control, this property is implemented as a Dependency Property and fully supports data binding.

A flag that indicates whether the state of the control current supports the GoBack action (true) or not (false).

true if this instance can go back; otherwise, false. In the WPF control, this property is implemented as a Dependency Property and fully supports data binding.

A flag that indicates whether the state of the control currently supports the GoForward action (true) or not (false).

true if this instance can go forward; otherwise, false. In the WPF control, this property is implemented as a Dependency Property and fully supports data binding.

Gets the request context.

The request context.

Implement and assign to handle events related to browser rendering.

The render handler.

Implement to handle events related to accessibility.

The accessibility handler.

Event called after the underlying CEF browser instance has been created. 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 you're running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).

Occurs when the browser 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 you're running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).

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 you're running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).

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.

Used by as the event happens before the bitmap buffer is updated. We do this to allow users to mark to true and stop the buffer from being updated.

Create a new OffScreen Chromium Browser. If you use = true then you must set to false and call after the objects are registered. The underlying Chromium Embedded Framework(CEF) Browser is created asynchronouly, to subscribe to the event it is recommended that you set to false, subscribe to the event and then call to ensure you are subscribe to the event before it's fired (Issue https://github.com/cefsharp/CefSharp/issues/3552).

html string to be initially loaded in the browser. The browser settings to use. If null, the default settings are used. See for more details. Defaults to null automatically create the underlying Browser Use as an alternative to the event. If the underlying Chromium Embedded Framework (CEF) browser is created successfully, this action is guranteed to be called after the browser created where as the event may be called before you have a chance to subscribe to the event as the CEF Browser is created async. (Issue https://github.com/cefsharp/CefSharp/issues/3552). For those using or then this must be true, for those using this can be false. Lower memory usage when false. Defaults to true for backwards compatability. Cef::Initialize() failed

Initial address (url) to load The browser settings to use. If null, the default settings are used. See for more details. Defaults to null automatically create the underlying Browser Use as an alternative to the event. If the underlying Chromium Embedded Framework (CEF) browser is created successfully, this action is guranteed to be called after the browser created where as the event may be called before you have a chance to subscribe to the event as the CEF Browser is created async. (Issue https://github.com/cefsharp/CefSharp/issues/3552). For those using or then this must be true, for those using this can be false. Lower memory usage when false. Defaults to true for backwards compatability. Cef::Initialize() failed

Finalizes an instance of the class.

Releases all resources used by the object

Releases unmanaged and - optionally - managed resources for the

to release both managed and unmanaged resources; to release only unmanaged resources.

Create the underlying browser. The instance address, browser settings and request context will be used.

Window information used when creating the browser Browser initialization settings An instance of the underlying offscreen browser has already been created, this method can only be called once.

Create the underlying CEF browser. The address and request context passed into the constructor will be used. If a delegate was passed into the constructor it will not be called as this method overrides that value internally.

Window information used when creating the browser Browser initialization settings An instance of the underlying offscreen browser has already been created, this method can only be called once. A that represents the creation of the underlying CEF browser ( instance. When the task completes then the CEF Browser will have been created and you can start performing basic tasks. Note that the control's event will be invoked after this task completes.

Get/set the size of the Chromium viewport, in pixels. This also changes the size of the next rendered bitmap.

The size.

Device scale factor. Specifies the ratio between physical and logical pixels.

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 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.

Choose which bitmap to retrieve, choose for a merged bitmap. Bitmap.

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.

Ignore existing bitmap (if any) and return the next available bitmap Choose which bitmap to retrieve, choose for a merged bitmap. Task<Bitmap>.

Capture page screenshot.

Image compression format (defaults to png). Compression quality from range [0..100] (jpeg only). view port to capture, if not null the browser will be resized if the requested width/height are larger than the current browser . A task that can be awaited to obtain the screenshot as a byte[].

Resize the browser

width height device scale factor A task that can be awaited and will resolve when the desired size is achieved. The current implementation is fairly symplistic, it simply resizes the browser and resolves the task when the browser starts painting at the desired size.

Waits for the page rendering to be idle for . Rendering is considered to be idle when no events have occured for . This is useful for scenarios like taking a screen shot.

optional idleTime in miliseconds, default to 500ms optional timeout, if not specified defaults to thirty(30) seconds. optional CancellationToken Task that resolves when page rendering has been idle for

The javascript object repository, one repository per ChromiumWebBrowser instance.

Has Focus - Always False

returns false

Returns the current CEF Browser Instance

browser instance or null

Gets the screen information (scale factor).

ScreenInfo.

Gets the screen information (scale factor).

ScreenInfo.

Gets the view rect (width, height)

ViewRect.

Gets the view rect (width, height)

ViewRect.

Called to retrieve the translation from view coordinates to actual screen coordinates.

x y screen x screen y Return true if the screen coordinates were provided.

Called to retrieve the translation from view coordinates to actual screen coordinates.

x y screen x screen y Return true if the screen coordinates were provided.

Called when an element has been rendered to the shared texture handle. This method is only called when is set to true

indicates whether the element is the view or the popup widget. contains the set of rectangles in pixel coordinates that need to be repainted is the handle for a D3D11 Texture2D that can be accessed via ID3D11Device using the OpenSharedResource method.

Called when an element should be painted. (Invoked from CefRenderHandler.OnPaint)

indicates whether the element is the view or the popup widget. contains the set of rectangles in pixel coordinates that need to be repainted The bitmap will be will be width * height *4 bytes in size and represents a BGRA image with an upper-left origin width height

Called when the browser's cursor has changed. .

If type is Custom then customCursorInfo will be populated with the custom cursor information cursor type custom cursor Information

Starts dragging.

The drag data. The mask. The x. The y. true if XXXX, false otherwise.

Sets the popup is open.

if set to true [show].

Called when the browser wants to move or resize the popup widget.

contains the new location and size in view coordinates.

Sets the address.

The instance containing the event data.

Sets the title.

The instance containing the event data.

Sets the tooltip text.

The tooltip text.

Creates a new bitmap with the dimensions of firstBitmap, then draws the firstBitmap, then overlays the secondBitmap

First bitmap, this will be the first image drawn Second bitmap, this image will be drawn on the first Position of the second bitmap The merged bitmap, size of firstBitmap

Used as workaround for issue https://github.com/cefsharp/CefSharp/issues/3021

The browser initialized - boolean represented as 0 (false) and 1(true) as we use Interlocker to increment/reset

The value for disposal, if it's 1 (one) then this instance is either disposed or in the process of getting disposed

The browser

Initial browser load task complection source

Initial browser load action

Get access to the core instance. Maybe null if the underlying CEF Browser has not yet been created or if this control has been disposed. Check before accessing.

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

Implement and assign to handle dialog events.

The dialog handler.

Implement and assign to handle events related to JavaScript Dialogs.

The js dialog handler.

Implement and assign to handle events related to key press.

The keyboard handler.

Implement and assign to handle events related to browser requests.

The request handler.

Implement and assign to handle events related to downloading files.

The download handler.

Implement and assign to handle events related to browser load status.

The load handler.

Implement and assign to handle events related to popups.

The life span handler.

Implement and assign to handle events related to browser display state.

The display handler.

Implement and assign to handle events related to the browser context menu

The menu handler.

Implement and assign to handle messages from the render process.

The render process message handler.

Implement to handle events related to find results.

The find handler.

Implement to handle audio events.

Implement to handle frame events.

Implement to handle events related to permission requests.

The for this ChromiumWebBrowser.

The focus handler. If you need customized focus handling behavior for WinForms, the suggested best practice would be to inherit from DefaultFocusHandler and try to avoid needing to override the logic in OnGotFocus. The implementation in DefaultFocusHandler relies on very detailed behavior of how WinForms and Windows interact during window activation.

Implement and assign to handle events related to dragging.

The drag handler.

Implement and control the loading of resources

The resource handler factory.

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.

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.

Whilst this may seem like a logical place to execute js, it's called before the DOM has been loaded, implement as it's called when the underlying V8Context is created

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.

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.

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 you're running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).

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 you're running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).

Event handler that will get called when the message that originates from CefSharp.PostMessage

A flag that indicates whether the WebBrowser is initialized (true) or not (false).

true if this instance is browser initialized; otherwise, false.

Handles the event.

The instance containing the event data.

Handles the event.

The instance containing the event data.

Handles the event.

The instance containing the event data.

Handles the event.

The instance containing the event data.

Handles the event.

The instance containing the event data.

Gets or sets a value indicating whether this instance has parent.

true if this instance has parent; otherwise, false.

Used by CefSharp.Puppeteer to associate a single DevToolsContext with a ChromiumWebBrowser instance.

Gets the browser adapter.

The browser adapter.

Sets the loading state change.

The instance containing the event data.

Called when [after browser created].

The browser.

Sets the loading state change.

The instance containing the event data.

Sets the handler references to null. Where required also calls Dispose().

Check is browser is initialized

true if browser is initialized

Throw exception if browser not initialized.

Thrown when an exception error condition occurs.

Throw exception if disposed.

Thrown when a supplied object has been disposed.

Default implementation of , this class handles Offscreen Rendering (OSR). Upstream documentation at http://magpcss.org/ceforum/apidocs3/projects/(default)/CefRenderHandler.html

Need a lock because the caller may be asking for the bitmap while Chromium async rendering has returned on another thread.

Gets or sets a value indicating whether the popup is open.

true if popup is opened; otherwise, false.

Contains the last bitmap buffer. Direct access to the underlying buffer - there is no locking when trying to access directly, use where appropriate.

The bitmap.

The popup Bitmap.

Gets the size of the popup.

Gets the popup position.

Create a new instance of DefaultRenderHadler

reference to the ChromiumWebBrowser

Dispose of this instance.

Called to allow the client to return a ScreenInfo object with appropriate values. If null is returned then the rectangle from GetViewRect will be used. If the rectangle is still empty or invalid popups may not be drawn correctly.

Return null if no screenInfo structure is provided.

Called to retrieve the view rectangle which is relative to screen coordinates. This method must always provide a non-empty rectangle.

Return a ViewRect strict containing the rectangle.

Called to retrieve the translation from view coordinates to actual screen coordinates.

x y screen x screen y Return true if the screen coordinates were provided.

Called when an element has been rendered to the shared texture handle. This method is only called when is set to true

Called when an element should be painted. Pixel values passed to this method are scaled relative to view coordinates based on the value of returned from . This method is only called when is set to false. Called on the CEF UI Thread

Called when the browser's cursor has changed.

If type is Custom then customCursorInfo will be populated with the custom cursor information cursor type custom cursor Information

Called when the user starts dragging content in the web view. Contextual information about the dragged content is supplied by dragData. OS APIs that run a system message loop may be used within the StartDragging call. Don't call any of the IBrowserHost.DragSource*Ended* methods after returning false. Return true to handle the drag operation. Call and either synchronously or asynchronously to inform the web view that the drag operation has ended.

drag data operation mask combined x and y provide the drag start location in screen coordinates combined x and y provide the drag start location in screen coordinates Return false to abort the drag operation.

Called when the web view wants to update the mouse cursor during a drag & drop operation.

describes the allowed operation (none, move, copy, link).

Called when the browser wants to show or hide the popup widget.

The popup should be shown if show is true and hidden if show is false.

Called when the browser wants to move or resize the popup widget.

contains the new location and size in view coordinates.

Called when the IME composition range has changed.

is the range of characters that have been selected is the bounds of each character in view coordinates.

Called when an on-screen keyboard should be shown or hidden for the specified browser.

the browser specifies what kind of keyboard should be opened. If , any existing keyboard for this browser should be hidden.

Implement this interface to handle Offscreen Rendering (OSR). Upstream documentation at http://magpcss.org/ceforum/apidocs3/projects/(default)/CefRenderHandler.html

Return null if no screenInfo structure is provided.

Called to retrieve the view rectangle which is relative to screen coordinates. This method must always provide a non-empty rectangle.

Return a ViewRect strict containing the rectangle.

Called to retrieve the translation from view coordinates to actual screen coordinates.

x y screen x screen y Return true if the screen coordinates were provided.

Called when an element has been rendered to the shared texture handle. This method is only called when is set to true

Called when the browser's cursor has changed.

If type is Custom then customCursorInfo will be populated with the custom cursor information cursor type custom cursor Information

Called when the web view wants to update the mouse cursor during a drag & drop operation.

describes the allowed operation (none, move, copy, link).

Called when the browser wants to show or hide the popup widget.

The popup should be shown if show is true and hidden if show is false.

Called when the browser wants to move or resize the popup widget.

contains the new location and size in view coordinates.

Called when the IME composition range has changed.

is the range of characters that have been selected is the bounds of each character in view coordinates.

Called when an on-screen keyboard should be shown or hidden for the specified browser.

the browser specifies what kind of keyboard should be opened. If , any existing keyboard for this browser should be hidden.

Event arguments to the OnPaint event handler. Pixel values are scaled relative to view coordinates based on the value of ScreenInfo.DeviceScaleFactor returned from .

Gets or sets a value indicating whether the event is handled.

Indicates whether the element is the view or the popup widge

Width

Height

contains the pixel data for the whole image. Will be width * height * 4 bytes in size and represents a BGRA image with an upper-left origin

Contains a rectangle in pixel coordinates that needs to be repainted.

Creates a new OnPaint event arg

is popup dirty rect if enabled buffer handle (back buffer) width height

Represents the popup blending in the main bitmap.

The main bitmap and popup bitmap will be merged together (Popup bitmap overlayed on top of the main bitmap).

Retrieve the main bitmap

Retrieve the popup bitmap