Cef |
Initialization settings. Many of these and other settings can also configured
using command-line switches.
Inheritance HierarchyNamespace: CefSharp.OffScreen
Assembly: CefSharp.OffScreen (in CefSharp.OffScreen.dll) Version: 129.0.110.0 (129.0.110.0)
SyntaxThe CefSettings type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CefSettings | Intialize with default values |
Properties| Name | Description | |
|---|---|---|
 | AcceptLanguageList |
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.
(Inherited from CefSettingsBase) |
| BackgroundColor |
Background color used for the browser before a document is loaded and when no document color is specified. The alpha
component must be either fully opaque (0xFF) or fully transparent (0x00). If the alpha component is fully opaque then the RGB
components will be used as the background color. If the alpha component is fully transparent for a WinForms browser then the
default value of opaque white be used. If the alpha component is fully transparent for a windowless (WPF/OffScreen) browser
then transparent painting will be enabled.
(Inherited from CefSettingsBase) |
| BrowserSubprocessPath |
The path to a separate executable that will be launched for sub-processes. By default the browser process executable is used.
See the comments on Cef.ExecuteProcess() for details. If this value is non-empty then it must be an absolute path.
Also configurable using the "browser-subprocess-path" command-line switch.
Defaults to using the provided CefSharp.BrowserSubprocess.exe instance
(Inherited from CefSettingsBase) |
| CachePath |
The directory where data for the global browser cache will be stored on disk.
If this value is non-empty then it must be an absolute path that is either equal to or a child directory
of RootCachePath. If this value is empty then browsers will be created in "incognito mode"
where in-memory caches are used for storage and no profile-specific data is persisted to disk
(installation-specific data will still be persisted in RootCachePath). HTML5 databases
such as localStorage will only persist across sessions if a cache path is specified.
Can be overridden for individual RequestContext instances via the CachePath value.
Any child directory value will be ignored and the "default" profile (also a child directory) will be used
instead.
(Inherited from CefSettingsBase) |
| CefCommandLineArgs |
Add custom command line argumens to this collection, they will be added in OnBeforeCommandLineProcessing. The
CefSettings.CommandLineArgsDisabled value can be used to start with an empty command-line object. Any values specified in
CefSettings that equate to command-line arguments will be set before this method is called.
(Inherited from CefSettingsBase) |
| CefCustomSchemes |
Add Customs schemes to this collection.
(Inherited from CefSettingsBase) |
| CommandLineArgsDisabled |
Set to true to disable configuration of browser process features using standard CEF and Chromium command-line arguments.
Configuration can still be specified using CEF data structures or by adding to CefCommandLineArgs.
(Inherited from CefSettingsBase) |
| CookieableSchemesExcludeDefaults |
If CookieableSchemesExcludeDefaults is false the
default schemes ("http", "https", "ws" and "wss") will also be supported.
Specifying a CookieableSchemesList value and setting
CookieableSchemesExcludeDefaults to true will disable all loading
and saving of cookies for this manager. Can be overridden
for individual RequestContext instances via the
RequestContextSettings.CookieableSchemesList and
RequestContextSettings.CookieableSchemesExcludeDefaults values.
(Inherited from CefSettingsBase) |
| CookieableSchemesList |
Comma delimited list of schemes supported by the associated
ICookieManager. If CookieableSchemesExcludeDefaults is false the
default schemes ("http", "https", "ws" and "wss") will also be supported.
Specifying a CookieableSchemesList value and setting
CookieableSchemesExcludeDefaults to true will disable all loading
and saving of cookies for this manager. Can be overridden
for individual RequestContext instances via the
RequestContextSettings.CookieableSchemesList and
RequestContextSettings.CookieableSchemesExcludeDefaults values.
(Inherited from CefSettingsBase) |
| ExternalMessagePump |
Set to true to control browser process main (UI) thread message pump scheduling via the
IBrowserProcessHandler.OnScheduleMessagePumpWork callback. This option is recommended for use in combination with the
Cef.DoMessageLoopWork() function in cases where the CEF message loop must be integrated into an existing application message
loop (see additional comments and warnings on Cef.DoMessageLoopWork). Enabling this option is not recommended for most users;
leave this option disabled and use either MultiThreadedMessageLoop (the default) if possible.
(Inherited from CefSettingsBase) |
| IgnoreCertificateErrors |
Set to true in order to completely ignore SSL certificate errors. This is NOT recommended.
(Inherited from CefSettingsBase) |
| IsDisposed |
Gets a value indicating if the CefSettings has been disposed.
(Inherited from CefSettingsBase) |
| JavascriptFlags |
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.
(Inherited from CefSettingsBase) |
| Locale |
The locale string that will be passed to WebKit. If empty the default locale of "en-US" will be used. Also configurable using
the "lang" command-line switch.
(Inherited from CefSettingsBase) |
| LocalesDirPath |
The fully qualified path for the locales directory. If this value is empty the locales directory must be located in the
module directory. If this value is non-empty then it must be an absolute path. Also configurable using the "locales-dir-path"
command-line switch.
(Inherited from CefSettingsBase) |
| LogFile |
The directory and file name to use for the debug log. If empty a default log file name and location will be used. On Windows
a "debug.log" file will be written in the main executable directory. Also configurable using the"log-file" command- line
switch.
(Inherited from CefSettingsBase) |
| LogSeverity |
The log severity. Only messages of this severity level or higher will be logged. When set to
Disable no messages will be written to the log file, but Fatal messages will still be
output to stderr. Also configurable using the "log-severity" command-line switch with a value of "verbose", "info", "warning",
"error", "fatal", "error-report" or "disable".
(Inherited from CefSettingsBase) |
| MultiThreadedMessageLoop |
Set to true to have the browser process message loop run in a separate thread. If false then the CefDoMessageLoopWork()
function must be called from your application message loop. This option is only supported on Windows. The default value is
true.
(Inherited from CefSettingsBase) |
| PersistSessionCookies |
To persist session cookies (cookies without an expiry date or validity interval) by default when using the global cookie
manager set this value to true. Session cookies are generally intended to be transient and most Web browsers do not persist
them. A CachePath value must also be specified to enable this feature. Also configurable using the "persist-session-cookies"
command-line switch. Can be overridden for individual RequestContext instances via the
RequestContextSettings.PersistSessionCookies value.
(Inherited from CefSettingsBase) |
| RemoteDebuggingPort |
Set to a value between 1024 and 65535 to enable remote debugging on the specified port. For example, if 8080 is specified the
remote debugging URL will be http://localhost:8080. CEF can be remotely debugged from any CEF or Chrome browser window. Also
configurable using the "remote-debugging-port" command-line switch.
(Inherited from CefSettingsBase) |
| ResourcesDirPath |
The fully qualified path for the resources directory. If this value is empty the cef.pak and/or devtools_resources.pak files
must be located in the module directory. Also configurable using the "resources-dir-path" command-line switch.
(Inherited from CefSettingsBase) |
| RootCachePath | (Inherited from CefSettingsBase) |
| UncaughtExceptionStackSize |
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.
(Inherited from CefSettingsBase) |
| UserAgent |
Value that will be returned as the User-Agent HTTP header. If empty the default User-Agent string will be used. Also
configurable using the "user-agent" command-line switch.
(Inherited from CefSettingsBase) |
| UserAgentProduct |
Value that will be inserted as the product portion of the default User-Agent string. If empty the Chromium product version
will be used. If UserAgent is specified this value will be ignored. Also configurable using the "user-agent-product" command-
line switch.
(Inherited from CefSettingsBase) |
| WindowlessRenderingEnabled |
Set to true (1) to enable windowless (off-screen) rendering support. Do not enable this value if the application does not use
windowless rendering as it may reduce rendering performance on some systems.
(Inherited from CefSettingsBase) |
Methods| Name | Description | |
|---|---|---|
| DisableGpuAcceleration |
Set command line argument to disable GPU Acceleration. WebGL will use
software rendering
(Inherited from CefSettingsBase) |
| Dispose |
Free the unmanaged CefSettingsBase instance.
Under normal circumstances you shouldn't need to call this
The unmanaged resource will be freed after Initialize(CefSettingsBase) (or one of the overloads) is called.
(Inherited from CefSettingsBase) |
| EnableAudio | Enables Audio - by default audio is muted in the OffScreen implementatio. This removes the mute-audio command line flag |
| EnablePrintPreview |
Set command line argument to enable Print Preview See
https://github.com/chromiumembedded/cef/issues/123/add-support-for-print-preview for details.
(Inherited from CefSettingsBase) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| RegisterScheme |
Registers a custom scheme using the provided settings.
(Inherited from CefSettingsBase) |
| SetOffScreenRenderingBestPerformanceArgs |
Use software rendering and compositing (disable GPU) for increased FPS
and decreased CPU usage. This will also disable WebGL so don't use this
method if you need that capability.
(Inherited from CefSettingsBase) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
See Also