Click or drag to resize
CefSharp Namespace
Version 63.0.0

[Missing <summary> documentation for "N:CefSharp"]

Classes
  ClassDescription
Public classAddressChangedEventArgs
Event arguments for the AddressChanged event handler.
Public classAssemblyInfo
Public classAsyncExtensions
Async extensions for different interfaces
Public classBindingOptions
Javascript binding options
Public classBrowserSettings
Browser initialization settings. Specify NULL or 0 to get the recommended default values. The consequences of using custom values may not be well tested. Many of these and other settings can also configured using command- line switches.
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 classCdmRegistration
Represents the response to an attempt to register the Widevine Content Decryption Module (CDM)
Public classCef
Public classCefCustomScheme
Used in conjunction with CefSettings.RegisterScheme to register a scheme. You can register your own custom scheme e.g. custom:// or use an existing scheme e.g. http://
Public classCefExtension
Represents a new V8 extension to be registered.
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 classCefSettings
Initialization settings. Many of these and other settings can also configured using command-line switches.
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 classCookieManager
Public classDefaultResourceHandlerFactory
Default implementation of IResourceHandlerFactory it's used internally for the LoadHtml implementation - basically a resource handler is registered for a specific Url.
Public classDefaultResourceHandlerFactoryItem
Public classDependencyChecker
DependencyChecker provides a known list of Cef/CefSharp dependencies and provides helper methods to check for their existance.
Public classDomNode
Represents a node in the browser's DOM.
Public classDownloadItem
Class used to represent a download item.
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 classGeoposition
Structure representing geoposition information. The properties of this structure correspond to those of the JavaScript Position object although their types may differ.
Public classIsBrowserInitializedChangedEventArgs
Event arguments for the IsBrowserInitializedChanged event handler.
Public classJavascriptIgnoreAttribute
JavascriptIgnoreAttribute - Methods and Properties marked with this attribute will be excluded from Javascript Binding
Public classJavascriptResponse
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 classManagedCefBrowserAdapter
Public classNativeMethodWrapper
Public classNavigationEntry
Represents an entry in navigation history.
Public classOnPaintEventArgs
Event arguments to the OnPaint event handler.
Public classPdfPrintSettings
Print to Pdf Settings
Public classPopupFeatures
Class representing popup window features.
Public classPostDataExtensions
Public classProxyOptions
Public classRequestContext
A request context provides request handling for a set of related browser objects. A request context is specified when creating a new browser object via the CefBrowserHost static factory methods. 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. When running in single-process mode there is only a single render process (the main process) and so all browsers created in single-process mode will share the same request context. This will be the first request context passed into a CefBrowserHost static factory method and all other request context objects will be ignored.
Public classRequestContextSettings
RequestContextSettings
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 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
Public classTaskCookieVisitor
Cookie Visitor implementation that uses a TaskCompletionSource to return a List of cookies
Public classTaskDeleteCookiesCallback
Provides a callback implementation of IDeleteCookiesCallback.
Public classTaskGetGeolocationCallback
Provides a callback implementation of IGetGeolocationCallback for use with geo positioning
Public classTaskNavigationEntryVisitor
A INavigationEntryVisitor that uses a TaskCompletionSource to simplify things
Public classTaskPrintToPdfCallback
Public classTaskRegisterCdmCallback
Provides a callback implementation of IRegisterCdmCallback for use with asynchronous Widevine CDM registration.
Public classTaskResolveCallback
Public classTaskSetCookieCallback
Provides a callback implementation of ISetCookieCallback.
Public classTaskStringVisitor
A IStringVisitor that uses a TaskCompletionSource to simplify things
Public classTaskWebPluginInfoVisitor
Public classTitleChangedEventArgs
Event arguments to the TitleChanged event handler.
Public classWebBrowserExtensions
Public classWebPluginInfo
Information about a specific web plugin.
Public classWindowInfo
Structures
  StructureDescription
Public structureCompositionUnderline
Represents an IME composition underline.
Public structureDraggableRegion
Representing a draggable region.
Public structureKeyEvent
Class representing a a keyboard event.
Public structureMouseEvent
Struct representing a mouse event.
Public structureRange
Represents a range
Public structureRect
Represents a rectangle
Public structureResolveCallbackResult
Public structureResourceHandlerWrapper
Interfaces
  InterfaceDescription
Public interfaceIAuthCallback
Callback interface used for asynchronous continuation of authentication requests.
Public interfaceIBeforeDownloadCallback
Callback interface used to asynchronously continue a download.
Public interfaceIBitmapFactory
Factory class used to generate a BitmapInfo object for OSR rendering (WPF and OffScreen projects) Implement this interface if you wish to render the underlying Bitmap to a custom type e.g. a GDI Bitmap in the WPF Control
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 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 asnychronously 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 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 interfaceIGeolocationCallback
Callback interface used for asynchronous continuation of geolocation permission requests.
Public interfaceIGeolocationHandler
Implement this interface to handle events related to geolocation permission requests. The methods of this class will be called on the CEF UI thread.
Public interfaceIGetGeolocationCallback
Implement this interface to receive geolocation updates. The methods of this class will be called on the CEF UI thread.
Public interfaceIJavascriptCallback
Public interfaceIJavascriptObjectRepository
Javascript object repository, object are registered for binding One repository per ChromiumWebBrowser instance
Public interfaceIJsDialogCallback
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
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 interfaceIRegisterCdmCallback
Content Decryption Module (CDM) registration callback used for asynchronous completion.
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
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
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 keywoard to existing methods e.g. ProcessRequestAsync.
Public interfaceIResourceHandlerFactory
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 DefaultResourceHandlerFactory 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
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 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 asnychronously 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 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
Enumerations
  EnumerationDescription
Public enumerationCdmRegistrationErrorCode
Lists the errors that can be reported during Widevine Content Decryption Module (CDM) registration.
Public enumerationCefErrorCode
Lists some of the error codes that can be reported by CEF. 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 enumerationCefFileDialogMode
CefFileDialogMode (Based on cef_file_dialog_mode_t)
Public enumerationCefFocusSource
Focus Source
Public enumerationCefGeoPositionErrorCode
Geoposition error codes.
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 enumerationCursorType
Cursor type values.
Public enumerationDragOperationsMask
"Verb" of a drag-and-drop operation as negotiated between the source and destination.
Public enumerationFilterStatus
Return values for IResponseFilter
Public enumerationKeyEventType
Public enumerationKeyType
Public enumerationLogSeverity
Public enumerationMenuItemType
Public enumerationMouseButtonType
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
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.