AbstractCefSettings Class |
Namespace: CefSharp
The AbstractCefSettings type exposes the following members.
Name | Description | |
---|---|---|
AbstractCefSettings |
Default Constructor
|
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.
| |
ApplicationClientIdForFileScanning |
GUID string used for identifying the application. This is passed to the
system AV function for scanning downloaded files. By default, the GUID
will be an empty string and the file will be treated as an untrusted
file when the GUID is empty.
| |
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.
| |
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. Also configurable using the
"browser-subprocess-path" command-line switch. Default is CefSharp.BrowserSubprocess.exe
| |
CachePath |
The location where data for the global browser cache will be stored on disk.
In non-empty this must be either equal to or a child directory of CefSettings.RootCachePath
(if RootCachePath is empty it will default to this value).
If empty then browsers will be created in "incognito mode" where in-memory caches are used
for storage and no data is persisted to disk. 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 RequestContextSettings.CachePath value.
| |
CefCommandLineArgs |
Add custom command line argumens to this collection, they will be
added in OnBeforeCommandLineProcessing.
| |
CefCustomSchemes |
Add Customs schemes to this collection
| |
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
| |
EnableNetSecurityExpiration |
Set to true to enable date-based expiration of built in network security information (i.e. certificate transparency logs,
HSTS preloading and pinning information). Enabling this option improves network security but may cause HTTPS load failures when
using CEF binaries built more than 10 weeks in the past. See https://www.certificate-transparency.org/ and
https://www.chromium.org/hsts for details. Can be set globally using the CefSettings.EnableNetSecurityExpiration value.
| |
Extensions |
List of all V8Extensions to be registered using CefRegisterExtension
in the render process.
| |
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.
| |
IgnoreCertificateErrors |
Set to true in order to completely ignore SSL certificate errors.
This is NOT recommended.
| |
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. 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.
Also configurable using the "locales-dir-path" command-line switch.
| |
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 and Linux a "debug.log"
file will be written in the main executable 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. When set to [!:CefSharp.LogSeverity.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".
| |
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. This option is only supported on
Windows. The default value is true
| |
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 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.
| |
PersistUserPreferences |
To persist user preferences as a JSON file in the cache path directory set
this value to true. A CachePath value must also be specified
to enable this feature. Also configurable using the
"persist-user-preferences" command-line switch. Can be overridden for
individual RequestContext instances via the
RequestContextSettings.PersistUserPreferences value.
| |
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. Also configurable using the "resources-dir-path" command-line
switch.
| |
RootCachePath |
The root directory that all CefSettings.CachePath and RequestContextSettings.CachePath values
must have in common. If this value is empty and CefSettings.CachePath is non-empty then this
value will default to the CefSettings.CachePath value. Failure to set this value correctly
may result in the sandbox blocking read/write access to the CachePath directory.
NOTE: CefSharp does not implement the CHROMIUM SANDBOX.
A non-empty RootCachePath can be used in conjuncation with an empty CefSettings.CachePath
in instances where you would like browsers attached to the Global RequestContext (the default)
created in "incognito mode" and instances created with a custom RequestContext using a disk based cache.
| |
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.
| |
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.
| |
UserDataPath |
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).
| |
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.
|
Name | Description | |
---|---|---|
DisableGpuAcceleration |
Set command line argument to disable GPU Acceleration, this will disable WebGL.
| |
Dispose | Releases all resources used by the AbstractCefSettings | |
Dispose(Boolean) | Releases the unmanaged resources used by the AbstractCefSettings and optionally releases the managed resources | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | (Overrides ObjectFinalize.) | |
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.) | |
RegisterExtension |
Register a new V8 extension with the specified JavaScript extension code
| |
RegisterScheme |
Registers a custom scheme using the provided settings.
| |
SetOffScreenRenderingBestPerformanceArgs |
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.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) |