"CefSharp.Core"
Creates a detailed expection string from a provided Cef V8 exception.
The exception which will be used as base for the message
Assigns the provided cef_string_t object from the given .NET string.
The cef_string_t that should be updated.
The .NET string whose value should be used to update cefStr.
Converts a .NET List of strings to native (unmanaged) format.
The List of strings that should be converted.
An unmanaged representation of the provided List of strings, or an empty List if the input is a nullptr.
Converts a .NET string to native (unmanaged) format. Note that this method does not allocate a new copy of the
The string that should be converted.
An unmanaged representation of the provided string, or an empty string if the input string is a nullptr.
Converts an unmanaged vector of strings to a (managed) .NET List of strings.
The vector of strings that should be converted.
A .NET List of strings.
Converts an unmanaged string to a (managed) .NET string.
The string that should be converted.
A .NET string.
Converts an unmanaged string to a (managed) .NET string.
The string that should be converted.
A .NET string.
Request a one-time geolocation update.
This function bypasses any user permission checks so should only be
used by code that is allowed to access location information.
Returns 'best available' location info or, if the location update failed, with error info.
Call during process startup to enable High-DPI support on Windows 7 or newer.
Older versions of Windows should be left DPI-unaware because they do not
support DirectWrite and GDI fonts are kerned very badly.
Force a plugin to shutdown.
Path (directory + file).
Unregister an internal plugin. This may be undone the next time RefreshWebPlugins() is called.
Path (directory + file).
Remove a plugin path (directory + file). This change may not take affect until after RefreshWebPlugins() is called.
Path (directory + file).
Cause the plugin list to refresh the next time it is accessed regardless of whether it has already been loaded.
Add a plugin directory. This change may not take affect until after CefRefreshWebPlugins() is called.
Directory.
Add a plugin path (directory + file). This change may not take affect until after RefreshWebPlugins() is called.
Path (directory + file).
Async returns a list containing Plugin Information
(Wrapper around CefVisitWebPluginInfo)
The Task will be cancelled and a TaskCanceledException throw
if the Task does not complete within 2000ms
Documentation for CefWebPluginInfoVisitor.Visit states
`This method may never be called if no plugins are found.`
hence the Task cancelled timeout
Returns List of structs.
Clear all registered scheme handler factories.
Returns false on error.
Shuts down CefSharp and the underlying CEF infrastructure. This method is safe to call multiple times; it will only
shut down CEF on the first call (all subsequent calls will be ignored).
This function should be called on the main application thread to shut down the CEF browser process before the application exits.
Returns the global cookie manager.
Remove all entries from the cross-origin access whitelist.
Remove all entries from the cross-origin access whitelist. Returns false if
the whitelist cannot be accessed.
Remove entry from cross-origin whitelist
The origin allowed to be accessed by the target protocol/domain.
The target protocol allowed to access the source origin.
The optional target domain allowed to access the source origin.
If set to true would allow a blah.example.com if the
was set to example.com
Remove an entry from the cross-origin access whitelist. Returns false if
is invalid or the whitelist cannot be accessed.
Add an entry to the cross-origin whitelist.
The origin allowed to be accessed by the target protocol/domain.
The target protocol allowed to access the source origin.
The optional target domain allowed to access the source origin.
If set to true would allow a blah.example.com if the
was set to example.com
The same-origin policy restricts how scripts hosted from different origins
(scheme + domain + port) can communicate. By default, scripts can only access
resources with the same origin. Scripts hosted on the HTTP and HTTPS schemes
(but no other schemes) can use the "Access-Control-Allow-Origin" header to
allow cross-origin requests. For example, https://source.example.com can make
XMLHttpRequest requests on http://target.example.com if the
http://target.example.com request returns an "Access-Control-Allow-Origin:
https://source.example.com" response header.
Scripts in separate frames or iframes and hosted from the same protocol and
domain suffix can execute cross-origin JavaScript if both pages set the
document.domain value to the same domain suffix. For example,
scheme://foo.example.com and scheme://bar.example.com can communicate using
JavaScript if both domains set document.domain="example.com".
This method is used to allow access to origins that would otherwise violate
the same-origin policy. Scripts hosted underneath the fully qualified
URL (like http://www.example.com) will be allowed access to
all resources hosted on the specified and .
If is non-empty and if false only
exact domain matches will be allowed. If contains a top-
level domain component (like "example.com") and is
true sub-domain matches will be allowed. If is empty and
if true all domains and IP addresses will be
allowed.
This method cannot be used to bypass the restrictions on local or display
isolated schemes. See the comments on for more
information.
This function may be called on any thread. Returns false if
is invalid or the whitelist cannot be accessed.
This function should be called from the application entry point function to execute a secondary process.
It can be used to run secondary processes from the browser client executable (default behavior) or
from a separate executable specified by the CefSettings.browser_subprocess_path value.
If called for the browser process (identified by no "type" command-line value) it will return immediately with a value of -1.
If called for a recognized secondary process it will block until the process should exit and then return the process exit code.
The |application| parameter may be empty. The |windows_sandbox_info| parameter is only used on Windows and may be NULL (see cef_sandbox_win.h for details).
Perform a single iteration of CEF message loop processing. This function is
used to integrate the CEF message loop into an existing application message
loop. Care must be taken to balance performance against excessive CPU usage.
This function should only be called on the main application thread and only
if CefInitialize() is called with a CefSettings.multi_threaded_message_loop
value of false. This function will not block.
Initializes CefSharp with user-provided settings.
This function should be called on the main application thread to initialize the CEF browser process.
CefSharp configuration settings.
When the Current AppDomain (relative to the thread called on)
Exits(ProcessExit event) then Shudown will be called.
Check that all relevant dependencies avaliable, throws exception if any are missing
true if successful; otherwise, false.
Initializes CefSharp with user-provided settings.
This function should be called on the main application thread to initialize the CEF browser process.
CefSharp configuration settings.
true if successful; otherwise, false.
Initializes CefSharp with the default settings.
This function should be called on the main application thread to initialize the CEF browser process.
true if successful; otherwise, false.
Gets a value that indicates the Git Hash for CEF version currently being used.
The Git Commit Hash
Gets a value that indicates the Chromium version currently being used.
The Chromium version.
Gets a value that indicates the CEF version currently being used.
The CEF Version
Gets a value that indicates the version of CefSharp currently being used.
The CefSharp version.
Gets a value that indicates whether CefSharp is initialized.
true if CefSharp is initialized; otherwise, false.
Called on the browser process UI thread immediately after the CEF context has been initialized.
Disable Surfaces so internal PDF viewer works for OSR
https://bitbucket.org/chromiumembedded/cef/issues/1689
Set command line arguments for best OSR (Offscreen and WPF) Rendering performance
This will disable WebGL, look at the source to determine which flags best suite
your requirements.
Registers an extension with the provided settings.
The CefExtension that contains the extension code.
Registers a custom scheme using the provided settings.
The CefCustomScheme which provides the details about the scheme.
If true a message will be sent from the render subprocess to the
browser when a DOM node (or no node) gets focus. The default is
false.
Comma delimited ordered list of language codes without any whitespace that
will be used in the "Accept-Language" HTTP header. May be set globally
using the CefSettings.AcceptLanguageList value. If both values are
empty then "en-US,en" will be used.
The number of stack trace frames to capture for uncaught exceptions.
Specify a positive value to enable the CefRenderProcessHandler::
OnUncaughtException() callback. Specify 0 (default value) and
OnUncaughtException() will not be called. Also configurable using the
"uncaught-exception-stack-size" command-line switch.
Custom flags that will be used when initializing the V8 JavaScript engine.
The consequences of using custom flags may not be well tested. Also
configurable using the "js-flags" command-line switch.
Set to true in order to completely ignore SSL certificate errors.
This is NOT recommended.
The location where user data such as spell checking dictionary files will
be stored on disk. If empty then the default platform-specific user data
directory will be used ("~/.cef_user_data" directory on Linux,
"~/Library/Application Support/CEF/User Data" directory on Mac OS X,
"Local Settings\Application Data\CEF\User Data" directory under the user
profile directory on Windows).
Gets the CefBrowserWrapper instance
Gets the current instance or null
Gets the CefBrowserWrapper instance
Gets the current instance or null
The maximum rate in frames per second (fps) that CefRenderHandler::OnPaint
will be called for a windowless browser. The actual fps may be lower if
the browser cannot generate frames at the requested rate. The minimum
value is 1 and the maximum value is 60 (default 30). This value can also be
changed dynamically via IBrowserHost.SetWindowlessFrameRate.
Comma delimited ordered list of language codes without any whitespace that
will be used in the "Accept-Language" HTTP header. May be overridden on a
per-browser basis using the CefBrowserSettings.AcceptLanguageList value.
If both values are empty then "en-US,en" will be used. Can be overridden
for individual RequestContext instances via the
RequestContextSettings.AcceptLanguageList value.
Opaque background color used for the browser before a document is loaded
and when no document color is specified. By default the background color
will be the same as CefSettings.background_color. Only the RGB compontents
of the specified value will be used. The alpha component must greater than
0 to enable use of the background color but will be otherwise ignored.
Controls whether WebGL can be used. Note that WebGL requires hardware
support and may not work on all systems even when enabled. Also
configurable using the "disable-webgl" command-line switch.
Controls whether the application cache can be used. Also configurable using
the "disable-application-cache" command-line switch.
Controls whether databases can be used. Also configurable using the
"disable-databases" command-line switch.
Controls whether local storage can be used. Also configurable using the
"disable-local-storage" command-line switch.
Controls whether the tab key can advance focus to links. Also configurable
using the "disable-tab-to-links" command-line switch.
Controls whether text areas can be resized. Also configurable using the
"disable-text-area-resize" command-line switch.
Controls whether standalone images will be shrunk to fit the page. Also
configurable using the "image-shrink-standalone-to-fit" command-line
switch.
Controls whether image URLs will be loaded from the network. A cached image
will still be rendered if requested. Also configurable using the
"disable-image-loading" command-line switch.
Controls whether web security restrictions (same-origin policy) will be
enforced. Disabling this setting is not recommend as it will allow risky
security behavior such as cross-site scripting (XSS). Also configurable
using the "disable-web-security" command-line switch.
Controls whether file URLs will have access to other file URLs. Also
configurable using the "allow-access-from-files" command-line switch.
Controls whether file URLs will have access to all URLs. Also configurable
using the "allow-universal-access-from-files" command-line switch.
Controls whether any plugins will be loaded. Also configurable using the
"disable-plugins" command-line switch.
Controls whether the caret position will be drawn. Also configurable using
the "enable-caret-browsing" command-line switch.
Controls whether DOM pasting is supported in the editor via
execCommand("paste"). The |javascript_access_clipboard| setting must also
be enabled. Also configurable using the "disable-javascript-dom-paste"
command-line switch.
Controls whether JavaScript can access the clipboard. Also configurable
using the "disable-javascript-access-clipboard" command-line switch.
Controls whether JavaScript can be used to close windows that were not
opened via JavaScript. JavaScript can still be used to close windows that
were opened via JavaScript. Also configurable using the
"disable-javascript-close-windows" command-line switch.
Controls whether JavaScript can be used for opening windows. Also
configurable using the "disable-javascript-open-windows" command-line
switch.
Controls whether JavaScript can be executed. Also configurable using the
"disable-javascript" command-line switch.
Controls the loading of fonts from remote sources. Also configurable using
the "disable-remote-fonts" command-line switch.
Default encoding for Web content. If empty "ISO-8859-1" will be used. Also
configurable using the "default-encoding" command-line switch.
Browser initialization settings. Specify NULL or 0 to get the recommended
default values. The consequences of using custom values may not be well
tested. Many of these and other settings can also configured using command-
line switches.
A request context provides request handling for a set of related browser objects.
A request context is specified when creating a new browser object via the CefBrowserHost
static factory methods. Browser objects with different request contexts will never be
hosted in the same render process. Browser objects with the same request context may or
may not be hosted in the same render process depending on the process model.
Browser objects created indirectly via the JavaScript window.open function or targeted
links will share the same render process and the same request context as the source browser.
When running in single-process mode there is only a single render process (the main process)
and so all browsers created in single-process mode will share the same request context.
This will be the first request context passed into a CefBrowserHost static factory method
and all other request context objects will be ignored.
Constructor that accepts IBrowser, IFrame, IRequest in order to be the CefSharp
lifetime management container (i.e. calling .Dispose at the correct time) on
managed objects that contain MCefRefPtrs.
RequestContextSettings
Load the request represented by the |request| object.