Cef |
Interfaces, enums, structs and classes that make up the core API interface
Classes| Class | Description | |
|---|---|---|
 | AcceleratedPaintInfo | Class representing accelerated paint info. |
| AddressChangedEventArgs | Event arguments for the AddressChanged event handler. |
| AsyncExtensions | Async extensions for different interfaces |
| BindingOptions | Javascript binding options |
| BrowserSettings | Interface representing browser initialization settings. |
| ByteArrayResourceHandler | ByteArrayResourceHandler is used as a placeholder class which uses native CEF implementations. CefStreamReader::CreateForData(); reads the byte array that is passed to a new instance of CefStreamResourceHandler TODO: Move this class into Handler namespace |
| Cef | Global CEF methods are exposed through this class. e.g. CefInitalize maps to Cef.Initialize CEF API Doc https://magpcss.org/ceforum/apidocs3/projects/(default)/(_globals).html This class cannot be inherited. |
| CefCustomScheme | Used in conjunction with CefSettings.RegisterScheme to register a scheme. You can register your own custom scheme e.g. custom:// if you are using a build in scheme (http/https) then you should directly register your ISchemeHandlerFactory using Cef.GetGlobalRequestContext().RegisterSchemeHandlerFactory - make sure the Global RequestContext has been initialized before doing so, you can use OnContextInitialized for notification of RequestContext initialization (Pass an IBrowserProcessHandler instance to Cef.Initialize) |
| CefLibraryHandle | CefLibraryHandle is a SafeHandle that Loads libcef.dll and relesases it when disposed/finalized Calls LoadLibraryEx with LoadLibraryFlags.LOAD_WITH_ALTERED_SEARCH_PATH Make sure to set settings.BrowserSubprocessPath and settings.LocalesDirPath |
| CefRuntime | CefRuntime - Used to simplify loading of the CefSharp architecture specific resources. Typical use case would be when you are targeting AnyCPU |
| CefSettingsBase | Initialization settings. Many of these and other settings can also configured using command-line switches. WPF/WinForms/OffScreen each have their own CefSettings implementation that sets relevant settings e.g. OffScreen starts with audio muted. |
| CefSharpSettings | Use this static class to configure some CefSharp specific settings like WcfTimeout |
| ConsoleMessageEventArgs | Event arguments for the ConsoleMessage event handler set up in IWebBrowser. |
| Cookie | Class used to Represent a cookie. The built in .Net Cookie class isn't used as some of it's properties have internal setters |
| DefaultApp | Default implementation of IApp which represents the CefApp class. |
| DependencyChecker | DependencyChecker provides a known list of Cef/CefSharp dependencies and provides helper methods to check for their existance. |
| DevToolsExtensions | Extensions for accessing DevTools through IBrowserHost |
| DomNode | Represents a node in the browser's DOM. |
| DownloadItem | Class used to represent a download item. |
| DragData | Used to represent Drag Data. |
| FileResourceHandler | FileResourceHandler is used as a placeholder class which uses native CEF implementations. CefStreamReader::CreateForFile is used to create a CefStreamReader instance which is passed to a new instance of CefStreamResourceHandler (Was previously ResourceHandlerType::File to differentiate, going for a more flexible approach now) TODO: Move this class into Handler namespace |
| FrameLoadEndEventArgs | Event arguments to the FrameLoadEnd event handler set up in IWebBrowser. |
| FrameLoadStartEventArgs | Event arguments to the FrameLoadStart event handler set up in IWebBrowser. |
| JavascriptBindingExtensions | Javascript binding extension methods |
| JavascriptException | Javascript exception |
| JavascriptIgnoreAttribute | JavascriptIgnoreAttribute - Methods and Properties marked with this attribute will be excluded from Javascript Binding |
| JavascriptMessageReceivedEventArgs | Calling CefSharp.PostMessage in Javascript triggers the JavascriptMessageReceived This event args contains the frame, browser and message corrisponding to that call |
| JavascriptResponse | Javascript Response |
| JavascriptStackFrame | A Javascript(V8) stack frame |
| LoadErrorEventArgs | Event arguments to the LoadError event handler set up in IWebBrowser. |
| LoadingStateChangedEventArgs | Event arguments to the LoadingStateChanged event handler set up in IWebBrowser. |
| LoadUrlAsyncResponse | Response returned from LoadUrlAsync(String) |
| ManagedCefBrowserAdapter | Create IBrowserAdapter instance via Create(IWebBrowserInternal, Boolean) This is the primary object for bridging the ChromiumWebBrowser implementation and VC++ |
| NativeMethodWrapper | Native static methods for low level operations, memory copy Avoids having to P/Invoke as we can call the C++ API directly. |
| NavigationEntry | Represents an entry in navigation history. |
| PdfPrintSettings | Print to Pdf Settings |
| PostData | Class used to represent post data for a web request. The methods of this class may be called on any thread. |
| PostDataElement | Class used to represent a single element in the request post data. The methods of this class may be called on any thread. |
| PostDataExtensions | Post Data extension methods - Makes accessing post data easier |
| ProxyOptions | Proxy options |
| Request | Class used to represent a web request. The methods of this class may be called on any thread. |
| RequestContext | A request context provides request handling for a set of related browser or URL request objects. A request context can be specified when creating a new browser by setting the RequestContext property (Passing in via the constructor for the OffScreen control is preferred). 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. |
| RequestContextBuilder | Fluent style builder for creating IRequestContext instances. |
| RequestContextExtensions | RequestContext extensions. |
| RequestContextSettings | RequestContext Settings |
| ResourceHandler | Default implementation of IResourceHandler. This latest implementation provides some simplification, at a minimum you only need to override ProcessRequestAsync. See the project source on GitHub for working examples. used to implement a custom request handler interface. The methods of this class will always be called on the IO thread. Static helper methods are included like FromStream and FromString that make dealing with fixed resources easy. |
| ResourceRequestHandlerFactory | Default implementation of IResourceRequestHandlerFactory it's used internally for the LoadHtml implementation - basically a resource handler is registered for a specific Url. |
| ResourceRequestHandlerFactoryItem | A resource request handler factory item. |
| SslStatus | Class representing the SSL information for a navigation entry. |
| StatusMessageEventArgs | Event arguments to the StatusMessage event handler set up in IWebBrowser. |
| TaskCompletionCallback | Provides a callback implementation of ICompletionCallback. |
| TaskCookieVisitor | Cookie Visitor implementation that uses a TaskCompletionSource to return a List of cookies |
| TaskDeleteCookiesCallback | Provides a callback implementation of IDeleteCookiesCallback. |
| TaskNavigationEntryVisitor | A INavigationEntryVisitor implementation that uses a TaskCompletionSourceTResult that allows you to call await/ContinueWith to get the list of NavigationEntries |
| TaskPrintToPdfCallback | Provides a callback implementation of IPrintToPdfCallback. |
| TaskResolveCallback | Provides a callback implementation of IResolveCallback. |
| TaskSetCookieCallback | Provides a callback implementation of ISetCookieCallback. |
| TaskStringVisitor | A IStringVisitor that uses a TaskCompletionSourceTResult that allows you to call await/ContinueWith to get the result string. |
| TitleChangedEventArgs | Event arguments to the TitleChanged event handler. |
| UrlParts | |
| UrlRequest | Class used to make a URL request. URL requests are not associated with a browser instance so no CefClient callbacks will be executed. URL requests can be created on any valid CEF thread in either the browser or render process. Once created the methods of the URL request object must be accessed on the same thread that created it. |
| UrlRequestClient | Interface that should be implemented by the CefURLRequest client. The methods of this class will be called on the same thread that created the request unless otherwise documented. |
| WaitForNavigationAsyncResponse | WaitForNavigationAsyncResponse |
| WaitForSelectorAsyncResponse | WaitForSelectorAsyncResponse |
| WebBrowserExtensions | WebBrowser extensions - These methods make performing common tasks easier. |
| WebBrowserExtensionsEx | Extended WebBrowserExtensions |
| WindowInfo | Class representing window information. |
Structures| Structure | Description | |
|---|---|---|
 | DraggableRegion | Representing a draggable region. |
| KeyEvent | Class representing a a keyboard event. |
| MouseEvent | Struct representing a mouse event. |
| ResolveCallbackResult | IP Address solution callback result |
Interfaces| Interface | Description | |
|---|---|---|
 | IAccessibilityHandler | Implement this interface to receive accessibility notification when accessibility events have been registered. It's important to note that the methods of this interface are called on a CEF UI thread, which by default is not the same as your application UI thread. |
| IApp | Implement this interface to provide handler implementations. Methods will be called by the process and/or thread indicated. |
| IAudioHandler | Implement this interface to handle audio events All methods will be called on the CEF UI thread |
| IAuthCallback | Callback interface used for asynchronous continuation of authentication requests. |
| IBeforeDownloadCallback | Callback interface used to asynchronously continue a download. |
| IBrowser | CefSharp interface for CefBrowser. |
| IBrowserHost | Interface used to represent the browser process aspects of a browser window. They may be called on any thread in that process unless otherwise indicated in the comments. |
| IBrowserProcessHandler | Implement this interface to handle events related to browser process callbacks. The methods of this class will be called on the CEF UI thread unless otherwise indicated. . |
| IBrowserSettings | Interface representing browser initialization settings. |
| ICallback | Generic callback interface used for asynchronous continuation. |
| IChromiumWebBrowserBase | Interface for common events/methods/properties for ChromiumWebBrowser and popup host implementations. |
| ICompletionCallback | Generic callback interface used for asynchronous completion. |
| IContextMenuHandler | Implement this interface to handle context menu events. |
| IContextMenuParams | Wrapper for the CefContextMenuParams |
| ICookieAccessFilter | Implement this interface to filter cookies that may be sent or received from resource requests. The methods of this class will be called on the CEF IO thread unless otherwise indicated. |
| ICookieManager | Used for managing cookies. The methods may be called on any thread unless otherwise indicated. |
| ICookieVisitor | Interface to implement for visiting cookie values. The methods of this class will always be called on the IO thread. If there are no cookies then Visit will never be called, you must implement Dispose to handle this scenario. |
| IDeleteCookiesCallback | Interface to implement to be notified of asynchronous completion via ICookieManager.DeleteCookies(). It will be executed asynchronously on the CEF IO thread after the cookie has been deleted |
| IDialogHandler | Implement this interface to handle dialog events. The methods of this class will be called on the CEF UI thread. |
| IDisplayHandler | Handle events related to browser display state. |
| IDomNode | Represents the tag name and attribute data belonging to a node in the browser's DOM. |
| IDownloadHandler | Class used to handle file downloads. The methods of this class will called on the CEF UI thread. |
| IDownloadItemCallback | Callback interface used to asynchronously cancel a download. |
| IDragData | Used to represent drag data. |
| IDragHandler | Implement this interface to handle events related to dragging. The methods of this class will be called on the UI thread. |
| IFileDialogCallback | Callback interface for asynchronous continuation of file dialog requests. |
| IFindHandler | Implement this interface to handle events related to find results. The methods of this class will be called on the CEF UI thread. |
| IFocusHandler | Implement this interface to handle events related to focus. The methods of this class will be called on the CEF UI thread. |
| IFrame | This interface represents a CefFrame object (i.e. a HTML frame) |
| IFrameHandler | Implement this interface to handle frame events All methods will be called on the CEF UI thread |
| IImage | Container for a single image represented at different scale factors. All image representations should be the same size in density independent pixel (DIP) units. For example, if the image at scale factor 1.0 is 100x100 pixels then the image at scale factor 2.0 should be 200x200 pixels -- both images will display with a DIP size of 100x100 units. The methods of this class must be called on the browser process UI thread. |
| IJavascriptCallback | Javascript callback interface |
| IJavascriptObjectRepository | Javascript object repository, object are registered for binding One repository per ChromiumWebBrowser instance |
| IJsDialogCallback | Callback interface used for asynchronous continuation of JavaScript dialog requests. |
| IJsDialogHandler | Implement this interface to handle events related to JavaScript dialogs. The methods of this class will be called on the CEF UI thread. |
| IKeyboardHandler | Implement this interface to handle events related to keyboard input. |
| ILifeSpanHandler | Implement this interface to handle events related to browser life span. The methods of this class will be called on the CEF UI thread unless otherwise indicated. |
| ILoadHandler | Implement this interface to handle events related to browser load status. The methods of this interface will be called on the CEF UI thread. Blocking in these methods will likely cause your UI to become unresponsive and/or hang. |
| IMediaAccessCallback | Callback interface used for asynchronous continuation of media access permission requests. |
| IMenuModel | Supports creation and modification of menus. See CefMenuCommand for the command ids that have default implementations. All user-defined command ids should be between UserFirst and UserFirst. The methods of this class can only be accessed on the CEF UI thread, which by default is not the same as your application UI thread. |
| INavigationEntryVisitor | Callback interface for IBrowserHost.GetNavigationEntries. The methods of this class will be called on the CEF UI thread. |
| IPermissionHandler | Implement this interface to handle events related to permission requests. It's important to note that the methods of this interface are called on a CEF UI thread, which by default is not the same as your application UI thread. |
| IPermissionPromptCallback | Callback interface used for asynchronous continuation of permission prompts. |
| IPopupFeatures | Class representing popup window features. |
| IPostData | Class used to represent post data for a web request. The methods of this class may be called on any thread. |
| IPostDataElement | Class used to represent a single element in the request post data. The methods of this class may be called on any thread. |
| IPrintToPdfCallback | Callback interface for PrintToPdf(String, PdfPrintSettings, IPrintToPdfCallback). The methods of this interface will be called on the CEF UI thread. |
| IRegistration | Generic callback interface used for managing the lifespan of a registration. |
| IRenderProcessMessageHandler | Messages sent by the render process can be handled by implementing this interface. |
| IRequest | Class used to represent a web request. The methods of this class may be called on any thread. |
| IRequestCallback | Callback interface used for asynchronous continuation of url requests. |
| IRequestContext | A request context provides request handling for a set of related browser or URL request objects. A request context can be specified when creating a new browser by setting the RequestContext property (Passing in via the constructor for the OffScreen control is preferred). 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. |
| IRequestContextHandler | Implement this interface to provide handler implementations. The handler instance will not be released until all objects related to the context have been destroyed. |
| IRequestHandler | Implement this interface to handle events related to browser requests. The methods of this class will be called on the thread indicated. |
| IResolveCallback | Callback interface for ResolveHostAsync(Uri) |
| IResourceHandler | Class used to implement a custom resource handler. The methods of this class will always be called on the CEF IO thread. Blocking the CEF IO thread will adversely affect browser performance. We suggest you execute your code in a Task (or similar). To implement async handling, spawn a new Task (or similar), keep a reference to the callback. When you have a fully populated stream, execute the callback. Once the callback Executes, GetResponseHeaders will be called where you can modify the response including headers, or even redirect to a new Url. Set your responseLength and headers Populate the dataOut stream in ReadResponse. For those looking for a sample implementation or upgrading from a previous version ResourceHandler. For those upgrading, inherit from ResourceHandler instead of IResourceHandler add the override keyword to existing methods e.g. ProcessRequestAsync. |
| IResourceRequestHandler | Implement this interface to handle events related to browser requests. The methods of this class will be called on the CEF IO thread unless otherwise indicated. |
| IResourceRequestHandlerFactory | Class that creates IResourceHandler instances for handling custom requests. The methods of this class will always be called on the CEF IO thread. This interface maps to the CefRequestHandler::GetResourceHandler method. It was split out to allow for the ResourceRequestHandlerFactory implementation that provides support for the LoadHtml extension method. |
| IResponse | Class used to represent a web response. The methods of this class may be called on any thread. |
| IResponseFilter | Implement this interface to filter resource response content. The methods of this class will be called on the CEF IO thread. |
| IRunContextMenuCallback | Callback interface used for continuation of custom context menu display. |
| ISchemeHandlerFactory | Class that creates IResourceHandler instances for handling scheme requests. The methods of this class will always be called on the CEF IO thread. |
| ISchemeRegistrar | Manages custom scheme registrations. |
| ISelectClientCertificateCallback | Callback interface used to select a client certificate for authentication. |
| ISetCookieCallback | Interface to implement to be notified of asynchronous completion via ICookieManager.SetCookie(). It will be executed asynchronously on the CEF IO thread after the cookie has been set |
| ISslInfo | Class representing SSL information. |
| IStringVisitor | Implement this interface to receive string values asynchronously. |
| IUrlRequest | Class used to make a URL request. URL requests are not associated with a browser instance so no CefClient callbacks will be executed. URL requests can be created on any valid CEF thread in either the browser or render process. Once created the methods of the URL request object must be accessed on the same thread that created it. |
| IUrlRequestClient | Interface that should be implemented by the CefURLRequest client. The methods of this class will be called on the same thread that created the request unless otherwise documented. |
| IValue | Interface representing CefValue. |
| IWebBrowser | ChromiumWebBrowser implementations implement this interface. Can be cast to the concrete implementation to access UI specific features. |
| IWindowInfo | Class representing window information. |
Enumerations| Enumeration | Description | |
|---|---|---|
 | CefErrorCode | This file contains the list of network errors. For a complete up-to-date list, see the CEF source code (cef_errorcode_t in include/internal/cef_types.h) and the Chromium source code (net/base/net_error_list.h). |
| CefEventFlags | Supported event bit flags. |
| CefFileDialogMode | CefFileDialogMode (Based on cef_file_dialog_mode_t) |
| CefFocusSource | Focus Source |
| CefJsDialogType | Supported JavaScript dialog types. |
| CefMenuCommand | |
| CefPdfPrintMarginType | Margin type for PDF printing. |
| CefReturnValue | Return value types. |
| CefRuntimeStyle | CEF supports both a Chrome runtime (based on the Chrome UI layer) and an Alloy runtime (based on the Chromium content layer). The Chrome runtime provides the full Chrome UI and browser functionality whereas the Alloy runtime provides less default browser functionality but adds additional client callbacks and support for windowless (off-screen) rendering. For additional comparative details on runtime types see https://bitbucket.org/chromiumembedded/cef/wiki/Architecture.md#markdown-header-cef3 Each runtime is composed of a bootstrap component and a style component. The style component is individually configured for each window/browser at creation time and, in combination with the Chrome bootstrap, different styles can be mixed during runtime. Windowless rendering will always use Alloy style. Windowed rendering with a default window or client-provided parent window can configure the style via CefWindowInfo.runtime_style. Windowed rendering with the Views framework can configure the style via CefWindowDelegate::GetWindowRuntimeStyle and CefBrowserViewDelegate::GetBrowserRuntimeStyle. Alloy style Windows with the Views framework can host only Alloy style BrowserViews but Chrome style Windows can host both style BrowserViews. Additionally, a Chrome style Window can host at most one Chrome style BrowserView but potentially multiple Alloy style BrowserViews. See CefWindowInfo.runtime_style documentation for any additional platform-specific limitations. |
| CefState | Represents the state of a setting. |
| CefTerminationStatus | Process termination status values. |
| CefThreadIds | Managed enum for cef_thread_id_t/CefThreadId |
| CertStatus | Supported certificate status code values. See net\cert\cert_status_flags.h for more information. CERT_STATUS_NONE is new in CEF because we use an enum while cert_status_flags.h uses a typedef and static const variables. |
| ContextMenuEditState | Supported context menu edit state bit flags. |
| ContextMenuMediaState | Supported context menu media state bit flags. These constants match their equivalents in Chromium's ContextMenuData::MediaFlags and should not be renumbered. |
| ContextMenuMediaType | Supported context menu media types. |
| ContextMenuType | ContextMenuType |
| FilterStatus | Return values for IResponseFilter |
| KeyEventType | Values that represent key event types. |
| KeyType | KeyType Enum. Maps to https://magpcss.org/ceforum/apidocs3/projects/(default)/cef_key_event_type_t.html |
| LogSeverity | LogSeverity |
| MediaAccessPermissionType | Media access permissions used by OnRequestMediaAccessPermission(IWebBrowser, IBrowser, IFrame, String, MediaAccessPermissionType, IMediaAccessCallback). |
| MenuItemType | Supported menu item types. |
| MouseButtonType | Values that represent mouse button types. |
| PaintElementType | Paint element types. |
| PermissionRequestResult | Permission request results. |
| PermissionRequestType | Permission types used with OnShowPermissionPrompt(IWebBrowser, IBrowser, UInt64, String, PermissionRequestType, IPermissionPromptCallback). Some types are platform-specific or only supported with the Chrome runtime. Should be kept in sync with Chromium's permissions::RequestType type. |
| PostDataElementType | Post data elements may represent either bytes or files. |
| ReferrerPolicy | Policy for how the Referrer HTTP header value will be sent during navigation. If the `--no-referrers` command-line flag is specified then the policy value will be ignored and the Referrer value will never be sent. Must be kept synchronized with net::URLRequest::ReferrerPolicy from Chromium. |
| ResourceType | Resource type for a request. |
| SslContentStatus | Supported SSL content status flags. See content/public/common/ssl_status.h for more information. |
| SslVersion | Supported SSL version values. See net/ssl/ssl_connection_status_flags.h for more information. |
| TransitionType | Transition type for a request. Made up of one source value and 0 or more qualifiers. |
| UrlRequestFlags | Flags used to customize the behavior of CefURLRequest. |
| UrlRequestStatus | Flags that represent CefURLRequest status. |
| WindowOpenDisposition | The manner in which a link click should be opened. |