Click or drag to resize

CefSharp Namespace

Version 94.4.20
Interfaces, enums, structs and classes that make up the core API interface
Classes
  ClassDescription
Public classAddressChangedEventArgs
Event arguments for the AddressChanged event handler.
Public classAsyncExtensions
Async extensions for different interfaces
Public classBindingOptions
Javascript binding options
Public classBrowserSettings
Interface representing browser initialization settings.
Public classByteArrayResourceHandler
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
Public classCef
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.
Public classCefCustomScheme
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)
Public classCefLibraryHandle
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
Public classCefRuntime
CefRuntime - Used to simplify loading of the CefSharp architecture specific resources. Typical use case would be when you are targeting AnyCPU
Public classCefSettingsBase
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.
Public classCefSharpSettings
Use this static class to configure some CefSharp specific settings like WcfTimeout
Public classConsoleMessageEventArgs
Event arguments for the ConsoleMessage event handler set up in IWebBrowser.
Public classCookie
Class used to Represent a cookie. The built in .Net Cookie class isn't used as some of it's properties have internal setters
Public classDefaultApp
Default implementation of IApp which represents the CefApp class.
Public classDependencyChecker
DependencyChecker provides a known list of Cef/CefSharp dependencies and provides helper methods to check for their existance.
Public classDevToolsExtensions
Extensions for accessing DevTools through IBrowserHost
Public classDomNode
Represents a node in the browser's DOM.
Public classDownloadItem
Class used to represent a download item.
Public classDragData
Used to represent Drag Data.
Public classFileResourceHandler
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
Public classFrameLoadEndEventArgs
Event arguments to the FrameLoadEnd event handler set up in IWebBrowser.
Public classFrameLoadStartEventArgs
Event arguments to the FrameLoadStart event handler set up in IWebBrowser.
Public classJavascriptBindingExtensions
Javascript binding extension methods
Public classJavascriptException
Javascript exception
Public classJavascriptIgnoreAttribute
JavascriptIgnoreAttribute - Methods and Properties marked with this attribute will be excluded from Javascript Binding
Public classJavascriptMessageReceivedEventArgs
Calling CefSharp.PostMessage in Javascript triggers the JavascriptMessageReceived This event args contains the frame, browser and message corrisponding to that call
Public classJavascriptResponse
Javascript Response
Public classJavascriptStackFrame
A Javascript(V8) stack frame
Public classLoadErrorEventArgs
Event arguments to the LoadError event handler set up in IWebBrowser.
Public classLoadingStateChangedEventArgs
Event arguments to the LoadingStateChanged event handler set up in IWebBrowser.
Public classLoadUrlAsyncResponse
Public classManagedCefBrowserAdapter
Create IBrowserAdapter instance via Create(IWebBrowserInternal, Boolean) This is the primary object for bridging the ChromiumWebBrowser implementation and VC++
Public classNativeMethodWrapper
Native static methods for low level operations, memory copy Avoids having to P/Invoke as we can call the C++ API directly.
Public classNavigationEntry
Represents an entry in navigation history.
Public classPdfPrintSettings
Print to Pdf Settings
Public classPostData
Class used to represent post data for a web request. The methods of this class may be called on any thread.
Public classPostDataElement
Class used to represent a single element in the request post data. The methods of this class may be called on any thread.
Public classPostDataExtensions
Post Data extension methods - Makes accessing post data easier
Public classProxyOptions
Proxy options
Public classRequest
Class used to represent a web request. The methods of this class may be called on any thread.
Public classRequestContext
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.
Public classRequestContextBuilder
Fluent style builder for creating IRequestContext instances.
Public classRequestContextExtensions
RequestContext extensions.
Public classRequestContextSettings
RequestContext Settings
Public classResourceHandler
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.
Public classResourceRequestHandlerFactory
Default implementation of IResourceRequestHandlerFactory it's used internally for the LoadHtml implementation - basically a resource handler is registered for a specific Url.
Public classResourceRequestHandlerFactoryItem
A resource request handler factory item.
Public classSslStatus
Class representing the SSL information for a navigation entry.
Public classStatusMessageEventArgs
Event arguments to the StatusMessage event handler set up in IWebBrowser.
Public classTaskCompletionCallback
Provides a callback implementation of ICompletionCallback.
Public classTaskCookieVisitor
Cookie Visitor implementation that uses a TaskCompletionSource to return a List of cookies
Public classTaskDeleteCookiesCallback
Provides a callback implementation of IDeleteCookiesCallback.
Public classTaskNavigationEntryVisitor
Public classTaskPrintToPdfCallback
Provides a callback implementation of IPrintToPdfCallback.
Public classTaskResolveCallback
Provides a callback implementation of IResolveCallback.
Public classTaskSetCookieCallback
Provides a callback implementation of ISetCookieCallback.
Public classTaskStringVisitor
Public classTaskWebPluginInfoVisitor
Provides a visitor implementation of IWebPluginInfoVisitor
Public classTitleChangedEventArgs
Event arguments to the TitleChanged event handler.
Public classUrlParts
Public classUrlRequest
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.
Public classUrlRequestClient
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.
Public classWebBrowserExtensions
WebBrowser extensions - These methods make performing common tasks easier.
Public classWebBrowserExtensionsEx
Extended WebBrowserExtensions
Public classWebPluginInfo
Information about a specific web plugin.
Public classWindowInfo
Class representing window information.
Structures
  StructureDescription
Public structureDraggableRegion
Representing a draggable region.
Public structureKeyEvent
Class representing a a keyboard event.
Public structureMouseEvent
Struct representing a mouse event.
Public structureResolveCallbackResult
IP Address solution callback result
Interfaces
  InterfaceDescription
Public interfaceIAccessibilityHandler
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.
Public interfaceIApp
Implement this interface to provide handler implementations. Methods will be called by the process and/or thread indicated.
Public interfaceIAudioHandler
Implement this interface to handle audio events All methods will be called on the CEF UI thread
Public interfaceIAuthCallback
Callback interface used for asynchronous continuation of authentication requests.
Public interfaceIBeforeDownloadCallback
Callback interface used to asynchronously continue a download.
Public interfaceIBrowser
CefSharp interface for CefBrowser.
Public interfaceIBrowserHost
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.
Public interfaceIBrowserProcessHandler
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. .
Public interfaceIBrowserSettings
Interface representing browser initialization settings.
Public interfaceICallback
Generic callback interface used for asynchronous continuation.
Public interfaceICompletionCallback
Generic callback interface used for asynchronous completion.
Public interfaceIContextMenuHandler
Implement this interface to handle context menu events.
Public interfaceIContextMenuParams
Wrapper for the CefContextMenuParams
Public interfaceICookieAccessFilter
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.
Public interfaceICookieManager
Used for managing cookies. The methods may be called on any thread unless otherwise indicated.
Public interfaceICookieVisitor
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.
Public interfaceIDeleteCookiesCallback
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
Public interfaceIDialogHandler
Implement this interface to handle dialog events. The methods of this class will be called on the CEF UI thread.
Public interfaceIDisplayHandler
Handle events related to browser display state.
Public interfaceIDomNode
Represents the tag name and attribute data belonging to a node in the browser's DOM.
Public interfaceIDownloadHandler
Class used to handle file downloads. The methods of this class will called on the CEF UI thread.
Public interfaceIDownloadItemCallback
Callback interface used to asynchronously cancel a download.
Public interfaceIDragData
Used to represent drag data.
Public interfaceIDragHandler
Implement this interface to handle events related to dragging. The methods of this class will be called on the UI thread.
Public interfaceIExtension
Object representing an extension. Methods may be called on any thread unless otherwise indicated.
Public interfaceIExtensionHandler
Implement this interface to handle events related to browser extensions. The methods of this class will be called on the CEF UI thread. See LoadExtension(String, String, IExtensionHandler) for information about extension loading.
Public interfaceIFileDialogCallback
Callback interface for asynchronous continuation of file dialog requests.
Public interfaceIFindHandler
Implement this interface to handle events related to find results. The methods of this class will be called on the CEF UI thread.
Public interfaceIFocusHandler
Implement this interface to handle events related to focus. The methods of this class will be called on the CEF UI thread.
Public interfaceIFrame
This interface represents a CefFrame object (i.e. a HTML frame)
Public interfaceIFrameHandler
Implement this interface to handle frame events All methods will be called on the CEF UI thread
Public interfaceIGetExtensionResourceCallback
Callback interface used for asynchronous continuation of GetExtensionResource(IExtension, IBrowser, String, IGetExtensionResourceCallback).
Public interfaceIImage
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.
Public interfaceIJavascriptCallback
Javascript callback interface
Public interfaceIJavascriptObjectRepository
Javascript object repository, object are registered for binding One repository per ChromiumWebBrowser instance
Public interfaceIJsDialogCallback
Callback interface used for asynchronous continuation of JavaScript dialog requests.
Public interfaceIJsDialogHandler
Implement this interface to handle events related to JavaScript dialogs. The methods of this class will be called on the CEF UI thread.
Public interfaceIKeyboardHandler
Implement this interface to handle events related to keyboard input.
Public interfaceILifeSpanHandler
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.
Public interfaceILoadHandler
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.
Public interfaceIMenuModel
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.
Public interfaceINavigationEntryVisitor
Callback interface for IBrowserHost.GetNavigationEntries. The methods of this class will be called on the CEF UI thread.
Public interfaceIPopupFeatures
Class representing popup window features.
Public interfaceIPostData
Class used to represent post data for a web request. The methods of this class may be called on any thread.
Public interfaceIPostDataElement
Class used to represent a single element in the request post data. The methods of this class may be called on any thread.
Public interfaceIPrintToPdfCallback
Callback interface for PrintToPdf(String, PdfPrintSettings, IPrintToPdfCallback). The methods of this interface will be called on the CEF UI thread.
Public interfaceIRegistration
Generic callback interface used for managing the lifespan of a registration.
Public interfaceIRenderProcessMessageHandler
Messages sent by the render process can be handled by implementing this interface.
Public interfaceIRequest
Class used to represent a web request. The methods of this class may be called on any thread.
Public interfaceIRequestCallback
Callback interface used for asynchronous continuation of url requests.
Public interfaceIRequestContext
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.
Public interfaceIRequestContextHandler
Implement this interface to provide handler implementations. The handler instance will not be released until all objects related to the context have been destroyed. Implement this interface to cancel loading of specific plugins
Public interfaceIRequestHandler
Implement this interface to handle events related to browser requests. The methods of this class will be called on the thread indicated.
Public interfaceIResolveCallback
Callback interface for ResolveHostAsync(Uri)
Public interfaceIResourceHandler
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.
Public interfaceIResourceRequestHandler
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.
Public interfaceIResourceRequestHandlerFactory
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.
Public interfaceIResponse
Class used to represent a web response. The methods of this class may be called on any thread.
Public interfaceIResponseFilter
Implement this interface to filter resource response content. The methods of this class will be called on the CEF IO thread.
Public interfaceIRunContextMenuCallback
Callback interface used for continuation of custom context menu display.
Public interfaceISchemeHandlerFactory
Class that creates IResourceHandler instances for handling scheme requests. The methods of this class will always be called on the CEF IO thread.
Public interfaceISchemeRegistrar
Manages custom scheme registrations.
Public interfaceISelectClientCertificateCallback
Callback interface used to select a client certificate for authentication.
Public interfaceISetCookieCallback
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
Public interfaceISslInfo
Class representing SSL information.
Public interfaceIStringVisitor
Implement this interface to receive string values asynchronously.
Public interfaceIUrlRequest
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.
Public interfaceIUrlRequestClient
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.
Public interfaceIValue
Interface representing CefValue.
Public interfaceIWebBrowser
ChromiumWebBrowser implementations implement this interface. Can be cast to the concrete implementation to access UI specific features.
Public interfaceIWebPluginInfoVisitor
Interface to implement for visiting web plugin information. The methods of this class will be called on the CEF UI thread, which by default is not the same as your application UI
Public interfaceIWindowInfo
Class representing window information.
Enumerations
  EnumerationDescription
Public enumerationCefErrorCode
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).
Public enumerationCefEventFlags
Supported event bit flags.
Public enumerationCefFileDialogFlags
FileDialog Flags
Public enumerationCefFileDialogMode
CefFileDialogMode (Based on cef_file_dialog_mode_t)
Public enumerationCefFocusSource
Focus Source
Public enumerationCefJsDialogType
Supported JavaScript dialog types.
Public enumerationCefMenuCommand
Public enumerationCefPdfPrintMarginType
Margin type for PDF printing.
Public enumerationCefReturnValue
Return value types.
Public enumerationCefState
Represents the state of a setting.
Public enumerationCefTerminationStatus
Process termination status values.
Public enumerationCefThreadIds
Managed enum for cef_thread_id_t/CefThreadId
Public enumerationCertStatus
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.
Public enumerationContextMenuEditState
Supported context menu edit state bit flags.
Public enumerationContextMenuMediaState
Supported context menu media state bit flags.
Public enumerationContextMenuMediaType
Supported context menu media types.
Public enumerationContextMenuType
ContextMenuType
Public enumerationFilterStatus
Return values for IResponseFilter
Public enumerationKeyEventType
Values that represent key event types.
Public enumerationKeyType
KeyType Enum. Maps to https://magpcss.org/ceforum/apidocs3/projects/(default)/cef_key_event_type_t.html
Public enumerationLogSeverity
LogSeverity
Public enumerationMenuItemType
Supported menu item types.
Public enumerationMouseButtonType
Values that represent mouse button types.
Public enumerationPaintElementType
Paint element types.
Public enumerationPluginPolicy
Plugin policies supported by IPluginHandler.OnBeforePluginLoad.
Public enumerationPostDataElementType
Post data elements may represent either bytes or files.
Public enumerationReferrerPolicy
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.
Public enumerationResourceType
Resource type for a request.
Public enumerationSslContentStatus
Supported SSL content status flags. See content/public/common/ssl_status.h for more information.
Public enumerationSslVersion
Supported SSL version values. See net/ssl/ssl_connection_status_flags.h for more information.
Public enumerationTransitionType
Transition type for a request. Made up of one source value and 0 or more qualifiers.
Public enumerationUrlRequestFlags
Flags used to customize the behavior of CefURLRequest.
Public enumerationUrlRequestStatus
Flags that represent CefURLRequest status.
Public enumerationWindowOpenDisposition
The manner in which a link click should be opened.