ChromiumWebBrowser
Get or set a value indicating whether the find toolbar is displayed.
Get or set a value indicating whether the close button is displayed.
Get or set the state of the match case button.
Sets the text in the find box and performs a search.
The text in the find box.
Setting the text clears any previous search results currently displayed.
Sets input focus to the find box.
Gets or sets the starting point of text selected in the find box.
Gets or sets the number of characters selected in the find box.
Represents a dynamic javascript property in the render process
to be added to a JSObject.
Called if a script attempts to get the value of
this dynamic property. It's up to the
application to decide how to handle the request. See also
description of CfrV8AccessorGetEventArgs.
If the application does not subscribe to this event, the
default action will be to return «undefined».
Called if a script attempts to set the value of
this dynamic property. It's up to the
application to decide how to handle the request. See also
description of CfrV8AccessorSetEventArgs.
If the application does not subscribe to this event, the
default action will be to silently ignore the request.
Creates a new dynamic javascript property to be added to a JSObject.
Creates a new dynamic javascript property to be added to a JSObject.
Represents a javascript function in the render process to be added as
a property to a browser frame's global object or to a JSObject.
Javascript callback event for this function.
Creates a new javascript function to be added as a property
to a browser frame's global object or to a child object.
Creates a new javascript function to be added as a property
to a browser frame's global object or to a child object.
Windows Forms webbrowser control based on ChromiumFX.
The CfxBrowserSettings applied for new instances of ChromiumWebBrowser.
Any changes to these settings will only apply to new browsers,
leaving already created browsers unaffected.
Provides an opportunity to change initialization settings
and subscribe to browser process handler events.
Provides an opportunity to view and/or modify command-line arguments before
processing by CEF and Chromium. The |ProcessType| value will be NULL for
the browser process. Do not keep a reference to the CfxCommandLine
object passed to this function. The CfxSettings.CommandLineArgsDisabled
value can be used to start with an NULL command-line object. Any values
specified in CfxSettings that equate to command-line arguments will be set
before this function is called. Be cautious when using this function to
modify command-line arguments for non-browser processes as this may result
in undefined behavior including crashes.
Provides an opportunity to register custom schemes. Do not keep a reference
to the |Registrar| object. This function is called on the main thread for
each process and the registered schemes should be the same across all
processes.
For each new render process created, provides an opportunity to subscribe
to CfrRenderProcessHandler remote callback events.
Initialize the ChromiumWebBrowser and ChromiumFX libraries.
The application can change initialization settings by handling
the OnBeforeCfxInitialize event.
This function should be called on the main application thread to shut down
the CEF browser process before the application exits.
The CfxBrowserProcessHandler for this browser process.
Do not access this property before calling ChromiumWebBrowser.Initialize()
Returns the ChromiumWebBrowser object associated with the given CfxBrowser, or null
if the CfxBrowser is not associated with any ChromiumWebBrowser object.
Returns the CfxBrowser object for this ChromiumWebBrowser.
Might be null if the browser has not yet been created.
Wait for the BrowserCreated event before accessing this property.
Returns the CfxBrowserHost object for this ChromiumWebBrowser.
Might be null if the browser has not yet been created.
Wait for the BrowserCreated event before accessing this property.
The invoke mode for this browser. See also JSInvokeMode.
Changes to the invoke mode will be effective after the next
time the browser creates a V8 context. If this is set to
"Inherit", then "Invoke" will be assumed. The invoke mode
also applies to VisitDom and EvaluateJavascript.
Indicates whether render process callbacks on this browser
will be executed on the thread that owns the
browser's underlying window handle.
Depends on the invoke mode. If the invoke mode is set to
"Inherit", then "Invoke" will be assumed.
Creates a ChromiumWebBrowser object with about:blank as initial URL.
The underlying CfxBrowser is created immediately with the
default CfxRequestContext.
Creates a ChromiumWebBrowser object with about:blank as initial URL.
If createImmediately is true, then the underlying CfxBrowser is
created immediately with the default CfxRequestContext.
Creates a ChromiumWebBrowser object with the given initial URL.
The underlying CfxBrowser is created immediately with the
default CfxRequestContext.
Creates a ChromiumWebBrowser object with the given initial URL.
If createImmediately is true, then the underlying CfxBrowser is
created immediately with the default CfxRequestContext.
Creates the underlying CfxBrowser with the default CfxRequestContext.
This method should only be called if this ChromiumWebBrowser
was instanciated with createImmediately == false.
Creates the underlying CfxBrowser with the default CfxRequestContext
and the given initial URL.
This method should only be called if this ChromiumWebBrowser
was instanciated with createImmediately == false.
Creates the underlying CfxBrowser with the given
CfxRequestContext and initial URL.
This method should only be called if this ChromiumWebBrowser
was instanciated with createImmediately == false.
Creates the underlying CfxBrowser with the given CfxRequestContext.
This method should only be called if this ChromiumWebBrowser
was instanciated with createImmediately == false.
Returns the context menu handler for this browser. If this is never accessed the default
implementation will be used.
Returns the life span handler for this browser.
Returns the load handler for this browser.
Returns the request handler for this browser.
Do not set the return value in the GetResourceHandler event for URLs
with associated WebResources (see also SetWebResource).
Returns the display handler for this browser.
Returns the download handler for this browser. If this is never accessed
downloads will not be allowed.
Returns the drag handler for this browser.
Returns the dialog handler for this browser. If this is never accessed the default
implementation will be used.
Returns the find handler for this browser.
Returns the focus handler for this browser.
Returns the geolocation handler for this browser. If this is never accessed
geolocation access will be denied by default.
Returns the js dialog handler for this browser. If this is never accessed the default
implementation will be used.
Returns the keyboard handler for this browser.
Returns the URL currently loaded in the main frame.
Returns true if the browser is currently loading.
Returns true if the browser can navigate backwards.
Returns true if the browser can navigate forwards.
Navigate backwards.
Navigate forwards.
Load the specified |url| into the main frame.
Load the contents of |stringVal| with the specified dummy |url|. |url|
should have a standard scheme (for example, http scheme) or behaviors like
link clicks and web security restrictions may not behave as expected.
Load the contents of |stringVal| with dummy url about:blank.
Search for |searchText|. |forward| indicates whether to search forward or
backward within the page. |matchCase| indicates whether the search should
be case-sensitive.
Returns the identifier for this find operation (see also CfxFindHandler),
or -1 if the browser has not yet been created.
Search for |searchText|. |forward| indicates whether to search forward or
backward within the page. The search will be case-insensitive.
Returns the identifier for this find operation (see also CfxFindHandler),
or -1 if the browser has not yet been created.
Search for |searchText|. The search will be forward and case-insensitive.
Returns the identifier for this find operation (see also CfxFindHandler),
or -1 if the browser has not yet been created.
Get the find toolbar of this browser window.
Execute a string of javascript code in the browser's main frame.
Execution is asynchronous, this function returns immediately.
Returns false if the browser has not yet been created.
Execute a string of javascript code in the browser's main frame. The |scriptUrl|
parameter is the URL where the script in question can be found, if any. The
renderer may request this URL to show the developer the source of the
error. The |startLine| parameter is the base line number to use for error
reporting.
Execution is asynchronous, this function returns immediately.
Returns false if the browser has not yet been created.
Special Invoke for framework callbacks from the render process.
Maintains the thread in the context of the calling remote thread.
Use this instead of invoke when the following conditions are meat:
1) The current thread is executing in the scope of a framework
callback event from the render process (ex. CfrTask.Execute).
2) You need to Invoke on the webbrowser control and
3) The invoked code needs to call into the render process.
Special Invoke for framework callbacks from the render process.
Maintains the thread within the context of the calling remote thread.
Use this instead of invoke when the following conditions are meat:
1) The current thread is executing in the scope of a framework
callback event from the render process (ex. CfrTask.Execute).
2) You need to Invoke on the webbrowser control and
3) The invoked code needs to call into the render process.
Evaluate a string of javascript code in the browser's main frame.
Evaluation is done asynchronously in the render process.
Returns false if the remote browser is currently unavailable.
If this function returns false, then |callback| will not be called. Otherwise,
|callback| will be called asynchronously in the context of the render thread and,
if RemoteCallbackInvokeMode is set to Invoke, on the thread that owns the
browser's underlying window handle.
Use with care:
The callback may never be called if the render process gets killed prematurely.
On success the CfrV8Value argument of the callback will be set to the return value
of the evaluated script, if any. On failure the CfrV8Exception argument of the callback
will be set to the exception thrown by the evaluated script, if any.
Do not block the callback since it blocks the render thread.
*** WARNING ***
In CEF 3.2623 and higher, the return value of the evaluation
seems to be broken in some cases (see also issue #65).
Evaluate a string of javascript code in the browser's main frame.
Evaluation is done asynchronously in the render process.
Returns false if the remote browser is currently unavailable.
If this function returns false, then |callback| will not be called. Otherwise,
|callback| will be called asynchronously in the context of the render thread.
If |invokeMode| is set to Invoke, |callback| will be called on the thread that
owns the browser's underlying window handle. If |invokeMode| is set to Inherit,
|callback| will be called according to RemoteCallbackInvokeMode.
Use with care:
The callback may never be called if the render process gets killed prematurely.
On success the CfrV8Value argument of the callback will be set to the return value
of the evaluated script, if any. On failure the CfrV8Exception argument of the callback
will be set to the exception thrown by the evaluated script, if any.
Do not block the callback since it blocks the render thread.
*** WARNING ***
In CEF 3.2623 and higher, the return value of the evaluation
seems to be broken in some cases (see also issue #65).
Represents the main frame's global javascript object (window).
Any changes to the global object's properties will be available
after the next time a V8 context is created in the render process
for the main frame of this browser.
Represents a named frame's global javascript object (window).
Any changes to the global object's properties will be available
after the next time a V8 context is created in the render process
of this browser for a frame with this name.
Visit the DOM in the remote browser's main frame.
Returns false if the remote browser is currently unavailable.
If this function returns false, then |callback| will not be called. Otherwise,
|callback| will be called according to the InvokeMode setting.
The document object passed to the callback represents a snapshot
of the DOM at the time the callback is executed.
DOM objects are only valid for the scope of the callback. Do not
keep references to or attempt to access any DOM objects outside the scope
of the callback.
Use with care:
The callback may never be called if the render process gets killed prematurely.
Do not keep a reference to the remote DOM or remote browser object after returning from the callback.
Do not block the callback since it blocks the renderer thread.
Explicitly Dispose() all CfrDomNode objects, otherwise the render process may become unstable and crash.
Called immediately after the V8 context for a frame has been created. To
retrieve the JavaScript 'window' object use the
CfrV8Context.GetGlobal() function. V8 handles can only be accessed
from the thread on which they are created. A task runner for posting tasks
on the associated thread can be retrieved via the
CfrV8Context.GetTaskRunner() function.
All javascript properties/functions defined through GlobalObject or GlobalObjectForFrame
are made available before this event is executed.
If RemoteCallbackInvokeMode is set to Invoke, then this event is executed on the
thread that owns the browser's underlying window handle.
See also the original CEF documentation in
cef/include/capi/cef_render_process_handler_capi.h.
Set a resource to be used for the specified URL.
Note that these resources are kept in the memory.
If you need to handle a lot of custom web resources,
subscribing to RequestHandler.GetResourceHandler
and loading from disk on demand
might be a better choice.
Remove a resource previously set for the specified URL.
Raised after the CfxBrowser object for this WebBrowser has been created.
The event is executed on the thread that owns this browser control's
underlying window handle.
Called after a remote browser has been created. When browsing cross-origin a new
browser will be created before the old browser is destroyed.
Applications may keep a reference to the CfrBrowser object outside the scope
of this event, but you have to be aware that those objects become invalid as soon
as the framework swaps render processes and/or recreates browsers.
Represents a javascript object in the render process to be added as
a property to a browser frame's global object or to another JSObject.
Creates a new javascript object to be added as a property
to a browser frame's global object or a child object.
Creates a new javascript object to be added as a property
to a browser frame's global object or a child object.
Adds the specified javascript property to this object.
Determines whether this javascript object contains a property with the specified name.
Gets a collection containing the property names in this javascript object.
Removes the property with the specified name from this javascript object.
Gets the property with the specified name.
Gets a collection containing the properties in this javascript object.
Gets or sets the property with the specified name.
Not supported.
Removes all properties from this javascript object.
Not supported.
Not supported.
Gets the number of properties contained in this javascript object.
Always false.
Not supported.
Returns an enumerator that iterates through the properties in this javascript object.
Returns an enumerator that iterates through the properties in this javascript object.
Add a javascript function as a property to this object.
Add a javascript function as a property to this object.
Add another javascript object as a property to this object.
Add another javascript object as a property to this object.
Add a dynamic javascript property to this object.
Add a dynamic javascript property to this object.
The type of a javascript property.
Modes for the JSProperty.InvokeMode property.
Inherit from parent object. This is the default mode
for javascript properties.
Callbacks from the render process are executed on the
thread that owns the browser's underlying window handle
within the context of the calling remote thread.
This is the default mode for the webbrowser object.
Callback from the render process are executed on the
worker thread which marshals the callback.
Represents a javascript property in the render process to be added to
a browser frame's global object or to a child object.
The type of this property.
The invoke mode for this property. See also JSInvokeMode.
Changes to the invoke mode will be effective after the next
time the browser creates a V8 context for the target frame.
Indicates whether render process callbacks on this javascript
property will be executed on the thread that owns the
browser's underlying window handle.
Depends on the invoke mode and, if invoke mode is inherit,
also on the parent object's and/or browser's invoke mode.
The name of this property.
May be null if this property is still unbound.
The browser this javascript property or the parent javascript object belongs to.
May be null if this property or it's parent is still unbound.
The parent javascript object of this property.
May be null if this property is still unbound.
Custom web resource for registration with a
ChromiumWebBrowser control.
Creates a WebResource for registration with a
ChromiumWebBrowser control.
Creates a WebResource from the given image
for registration with a ChromiumWebBrowser control.
The mime type will be image/png
Creates a WebResource from the given image
for registration with a ChromiumWebBrowser control.
The mime type will be set according to the image format.
Creates a WebResource from the given text
for registration with a ChromiumWebBrowser control.
The mime type will be text/html