[This is preliminary documentation and is subject to change.]
The CefSettings type exposes the following members.Constructors
Name | Description | |
---|---|---|
CefSettings | Initializes a new instance of the CefSettings class |
Methods
Name | Description | |
---|---|---|
Equals | (Inherited from Object.) | |
Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
GetHashCode |
Serves as a hash function for a particular type.
(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.) | |
ToString | (Inherited from Object.) |
Properties
Name | Description | |
---|---|---|
BackgroundColor |
Opaque background color used for accelerated content. By default the
background color will be white. 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.
| |
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
CefExecuteProcess() for details. Also configurable using the
"browser-subprocess-path" command-line switch.
| |
CachePath |
The location where cache data will be stored on disk. If empty an in-memory
cache will be used for some features and a temporary disk cache for others.
HTML5 databases such as localStorage will only persist across sessions if a
cache path is specified.
| |
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 via the
CefApp::OnBeforeCommandLineProcessing() method.
| |
ContextSafetyImplementation |
By default CEF V8 references will be invalidated (the IsValid() method will
return false) after the owning context has been released. This reduces the
need for external record keeping and avoids crashes due to the use of V8
references after the associated context has been released.
CEF currently offers two context safety implementations with different
performance characteristics. The default implementation (value of 0) uses a
map of hash values and should provide better performance in situations with
a small number contexts. The alternate implementation (value of 1) uses a
hidden value attached to each context and should provide better performance
in situations with a large number of contexts.
If you need better performance in the creation of V8 references and you
plan to manually track context lifespan you can disable context safety by
specifying a value of -1.
Also configurable using the "context-safety-implementation" command-line
switch.
| |
IgnoreCertificateErrors |
Set to true (1) to ignore errors related to invalid SSL certificates.
Enabling this setting can lead to potential security vulnerabilities like
"man in the middle" attacks. Applications that load content from the
internet should not enable this setting. Also configurable using the
"ignore-certificate-errors" command-line switch.
| |
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.
| |
Locale |
The locale string that will be passed to WebKit. If empty the default
locale of "en-US" will be used. This value is ignored on Linux where locale
is determined using environment variable parsing with the precedence order:
LANGUAGE, LC_ALL, LC_MESSAGES and LANG. Also configurable using the "lang"
command-line switch.
| |
LocalesDirPath |
The fully qualified path for the locales directory. If this value is empty
the locales directory must be located in the module directory. This value
is ignored on Mac OS X where pack files are always loaded from the app
bundle resource directory. Also configurable using the "locales-dir-path"
command-line switch.
| |
LogFile |
The directory and file name to use for the debug log. If empty, the
default name of "debug.log" will be used and the file will be written
to the application directory. Also configurable using the "log-file"
command-line switch.
| |
LogSeverity |
The log severity. Only messages of this severity level or higher will be
logged. Also configurable using the "log-severity" command-line switch with
a value of "verbose", "info", "warning", "error", "error-report" or
"disable".
| |
MultiThreadedMessageLoop |
Set to true to have the browser process message loop run in a separate
thread. If false than the CefDoMessageLoopWork() function must be
called from your application message loop.
| |
NoSandbox |
Set to true to disable the sandbox for sub-processes. See
cef_sandbox_win.h for requirements to enable the sandbox on Windows. Also
configurable using the "no-sandbox" command-line switch.
| |
PackLoadingDisabled |
Set to true to disable loading of pack files for resources and locales.
A resource bundle handler must be provided for the browser and render
processes via CefApp::GetResourceBundleHandler() if loading of pack files
is disabled. Also configurable using the "disable-pack-loading" command-
line switch.
| |
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 |cache_path| value must also be specified to
enable this feature. Also configurable using the "persist-session-cookies"
command-line switch.
| |
ProductVersion |
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 "product-version" command-line switch.
| |
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.
| |
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 on Windows/Linux or the app bundle Resources directory
on Mac OS X. Also configurable using the "resources-dir-path" command-line
switch.
| |
SingleProcess |
Set to true to use a single process for the browser and renderer. This
run mode is not officially supported by Chromium and is less stable than
the multi-process default. Also configurable using the "single-process"
command-line switch.
| |
UncaughtExceptionStackSize |
The number of stack trace frames to capture for uncaught exceptions.
Specify a positive value to enable the CefV8ContextHandler::
OnUncaughtException() callback. Specify 0 (default value) and
OnUncaughtException() will not be called. Also configurable using the
"uncaught-exception-stack-size" command-line switch.
| |
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.
| |
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.
|
See Also