Click or drag to resize
Cef Class
Version 63.0.0

[Missing <summary> documentation for "T:CefSharp.Cef"]

Inheritance Hierarchy
SystemObject
  CefSharpCef

Namespace: CefSharp
Assembly: CefSharp.Core (in CefSharp.Core.dll) Version: 63.0.0.0
Syntax
public sealed class Cef

The Cef type exposes the following members.

Constructors
  NameDescription
Public methodCef
Initializes a new instance of the Cef class
Top
Properties
  NameDescription
Public propertyStatic memberCefCommitHash
Gets a value that indicates the Git Hash for CEF version currently being used.
Public propertyStatic memberCefSharpVersion
Gets a value that indicates the version of CefSharp currently being used.
Public propertyStatic memberCefVersion
Gets a value that indicates the CEF version currently being used.
Public propertyStatic memberChromiumVersion
Gets a value that indicates the Chromium version currently being used.
Public propertyStatic memberCrashReportingEnabled
Public propertyStatic memberFileThreadTaskFactory
Public propertyStatic memberIOThreadTaskFactory
Public propertyStatic memberIsInitialized
Gets a value that indicates whether CefSharp is initialized.
Public propertyStatic memberUIThreadTaskFactory
Top
Methods
  NameDescription
Public methodStatic memberAddCrossOriginWhitelistEntry
Add an entry to the cross-origin whitelist.
Public methodStatic memberAddDisposable
Public methodStatic memberClearCrossOriginWhitelist
Remove all entries from the cross-origin access whitelist.
Public methodStatic memberClearSchemeHandlerFactories
Clear all registered scheme handler factories.
Public methodStatic memberCurrentlyOnThread
Returns true if called on the specified CEF thread.
Public methodStatic memberDoMessageLoopWork
Perform a single iteration of CEF message loop processing.This function is provided for cases where the CEF message loop must be integrated into an existing application message loop. Use of this function is not recommended for most users; use CefSettings.MultiThreadedMessageLoop if possible (the deault). When using this function care must be taken to balance performance against excessive CPU usage. It is recommended to enable the CefSettings.ExternalMessagePump option when using this function so that IBrowserProcessHandler.OnScheduleMessagePumpWork() callbacks can facilitate the scheduling process. This function should only be called on the main application thread and only if Cef.Initialize() is called with a CefSettings.MultiThreadedMessageLoop value of false. This function will not block.
Public methodStatic memberEnableHighDPISupport
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.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodStatic memberExecuteProcess
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).
Public methodStatic memberGetGeolocation
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.
Public methodStatic memberGetGeolocationAsync
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.
Public methodStatic memberGetGlobalCookieManager
Returns the global cookie manager.
Public methodStatic memberGetGlobalRequestContext
Gets the Global Request Context. Make sure to Dispose of this object when finished.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodStatic memberGetPlugins
Async returns a list containing Plugin Information (Wrapper around CefVisitWebPluginInfo)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberInitialize
Initializes CefSharp with the default settings. This function can only be called once, subsiquent calls will result in an Exception. It's important to note that Initialize and Shutdown MUST be called on your main applicaiton thread (Typically the UI thead). If you call them on different threads, your application will hang. See the documentation for Cef.Shutdown() for more details.
Public methodStatic memberInitialize(CefSettings)
Initializes CefSharp with user-provided settings. It's important to note that Initialize and Shutdown MUST be called on your main applicaiton thread (Typically the UI thead). If you call them on different threads, your application will hang. See the documentation for Cef.Shutdown() for more details.
Public methodStatic memberInitialize(CefSettings, Boolean, IBrowserProcessHandler)
Initializes CefSharp with user-provided settings. It's important to note that Initialize/Shutdown MUST be called on your main applicaiton thread (Typically the UI thead). If you call them on different threads, your application will hang. See the documentation for Cef.Shutdown() for more details.
Public methodStatic memberQuitMessageLoop
Quit the CEF message loop that was started by calling Cef.RunMessageLoop(). This function should only be called on the main application thread and only if Cef.RunMessageLoop() was used.
Public methodStatic memberRefreshWebPlugins
Cause the plugin list to refresh the next time it is accessed regardless of whether it has already been loaded.
Public methodStatic memberRegisterWidevineCdm
Register the Widevine CDM plugin. The client application is responsible for downloading an appropriate platform-specific CDM binary distribution from Google, extracting the contents, and building the required directory structure on the local machine. The [!:IBrowserHost.StartDownload] method class can be used to implement this functionality in CefSharp. Contact Google via https://www.widevine.com/contact.html for details on CDM download. path is a directory that must contain the following files: 1. manifest.json file from the CDM binary distribution (see below). 2. widevinecdm file from the CDM binary distribution (e.g. widevinecdm.dll on Windows). 3. widevidecdmadapter file from the CEF binary distribution (e.g. widevinecdmadapter.dll on Windows). If any of these files are missing or if the manifest file has incorrect contents the registration will fail and callback will receive an ErrorCode value of [!:CdmRegistrationErrorCode.IncorrectContents]. The manifest.json file must contain the following keys: A. "os": Supported OS (e.g. "mac", "win" or "linux"). B. "arch": Supported architecture (e.g. "ia32" or "x64"). C. "x-cdm-module-versions": Module API version (e.g. "4"). D. "x-cdm-interface-versions": Interface API version (e.g. "8"). E. "x-cdm-host-versions": Host API version (e.g. "8"). F. "version": CDM version (e.g. "1.4.8.903"). G. "x-cdm-codecs": List of supported codecs (e.g. "vp8,vp9.0,avc1"). A through E are used to verify compatibility with the current Chromium version. If the CDM is not compatible the registration will fail and callback will receive an ErrorCode value of [!:CdmRegistrationErrorCode.Incompatible]. If registration is not supported at the time that Cef.RegisterWidevineCdm() is called then callback will receive an ErrorCode value of [!:CdmRegistrationErrorCode.NotSupported].
Public methodStatic memberRegisterWidevineCdmAsync
Register the Widevine CDM plugin. See RegisterWidevineCdm(String, IRegisterCdmCallback) for more details.
Public methodStatic memberRemoveCrossOriginWhitelistEntry
Remove entry from cross-origin whitelist
Public methodStatic memberRemoveDisposable
Public methodStatic memberRunMessageLoop
Run the CEF message loop. Use this function instead of an application- provided message loop to get the best balance between performance and CPU usage. This function should only be called on the main application thread and only if Cef.Initialize() is called with a CefSettings.MultiThreadedMessageLoop value of false. This function will block until a quit message is received by the system.
Public methodStatic memberSetCrashKeyValue
Sets or clears a specific key-value pair from the crash metadata.
Public methodStatic memberShutdown
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 method should be called on the main application thread to shut down the CEF browser process before the application exits. If you are Using CefSharp.OffScreen then you must call this explicitly before your application exits or it will hang. This method must be called on the same thread as Initialize. If you don't call Shutdown explicitly then CefSharp.Wpf and CefSharp.WinForms versions will do their best to call Shutdown for you, if your application is having trouble closing then call thus explicitly.
Public methodStatic memberShutdownWithoutChecks
This method should only be used by advanced users, if your unsure then use Cef.Shutdown(). This function should be called on the main application thread to shut down the CEF browser process before the application exits. This method simply obtains a lock and calls the native CefShutdown method, only IsInitialized is checked. All ChromiumWebBrowser instances MUST be Disposed of before calling this method. If calling this method results in a crash or hangs then you're likely hanging on to some unmanaged resources or haven't closed all of your browser instances
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodStatic memberUnregisterInternalWebPlugin
Unregister an internal plugin. This may be undone the next time RefreshWebPlugins() is called.
Public methodStatic memberVisitWebPluginInfo
Visit web plugin information. Can be called on any thread in the browser process.
Top
See Also