CefSharp Namespace |
[Missing <summary> documentation for "N:CefSharp"]
Class | Description | |
---|---|---|
AddressChangedEventArgs |
Event arguments for the AddressChanged event handler.
| |
AssemblyInfo | ||
BindingOptions |
Javascript binding options
| |
BrowserSettings |
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.
| |
Cef | ||
CefCustomScheme |
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://
| |
CefExtension |
Represents a new V8 extension to be registered.
| |
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
| |
CefSettings |
Initialization settings. Many of these and other settings can also configured
using command-line switches.
| |
CefSharpSettings |
Use this static class to configure some CefSharp specific settings like WcfTimeout
| |
ConsoleMessageEventArgs |
Event arguments to 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
| |
CookieManager | ||
DefaultResourceHandlerFactory |
Default implementation of IResourceHandlerFactory it's used
internally for the LoadHtml implementation - basically a resource handler is
registered for a specific Url.
| |
DependencyChecker |
DependencyChecker provides a known list of Cef/CefSharp dependencies and
provides helper methods to check for their existance.
| |
DomNode |
Represents a node in the browser's DOM.
| |
DownloadItem |
Class used to represent a download item.
| |
FrameLoadEndEventArgs |
Event arguments to the FrameLoadEnd event handler set up in IWebBrowser.
| |
FrameLoadStartEventArgs |
Event arguments to the FrameLoadStart event handler set up in IWebBrowser.
| |
Geoposition |
Structure representing geoposition information. The properties of this
structure correspond to those of the JavaScript Position object although
their types may differ.
| |
IsBrowserInitializedChangedEventArgs |
Event arguments to the IsBrowserInitializedChanged event handler.
| |
JavascriptIgnoreAttribute |
JavascriptIgnoreAttribute - Methods and Properties marked with this attribute
will be excluded from Javascript Binding
| |
JavascriptResponse | ||
LoadErrorEventArgs |
Event arguments to the LoadError event handler set up in IWebBrowser.
| |
LoadingStateChangedEventArgs |
Event arguments to the LoadingStateChanged event handler set up in IWebBrowser.
| |
ManagedCefBrowserAdapter | ||
MouseEvent |
Class representing a mouse event.
| |
NativeMethodWrapper | ||
PdfPrintSettings |
Print to Pdf Settings
| |
PopupFeatures |
Class representing popup window features.
| |
PostDataExtensions | ||
RequestContext |
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.
| |
RequestContextSettings |
RequestContextSettings
| |
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.
| |
ScriptException | ||
StatusMessageEventArgs |
Event arguments to the StatusMessage event handler set up in IWebBrowser.
| |
TaskCompletionHandler | ||
TaskCookieVisitor |
Cookie Visitor implementation that uses a TaskCompletionSource
to return a List of cookies
| |
TaskNavigationEntryVisitor |
A INavigationEntryVisitor that uses a TaskCompletionSource
to simplify things
| |
TaskPrintToPdfCallback | ||
TaskResolveCallbackHandler | ||
TaskStringVisitor |
A IStringVisitor that uses a TaskCompletionSource
to simplify things
| |
TitleChangedEventArgs |
Event arguments to the TitleChanged event handler.
| |
WebBrowserExtensions | ||
WebPluginInfo |
Information about a specific web plugin.
| |
WindowInfo |
Structure | Description | |
---|---|---|
CefDirtyRect | ||
CompositionUnderline |
Represents an IME composition underline.
| |
DraggableRegion |
Representing a draggable region.
| |
KeyEvent |
Class representing a a keyboard event.
| |
NavigationEntry |
Represents an entry in navigation history.
| |
Plugin | ||
Range |
Represents a range
| |
Rect |
Represents a rectangle
| |
ResolveCallbackResult | ||
ResourceHandlerWrapper | ||
SslStatus |
Class representing the SSL information for a navigation entry.
|
Interface | Description | |
---|---|---|
IAuthCallback |
Callback interface used for asynchronous continuation of authentication requests.
| |
IBeforeDownloadCallback |
Callback interface used to asynchronously continue a download.
| |
IBitmapFactory |
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
| |
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.
| |
ICompletionCallback |
Generic callback interface used for asynchronous completion.
| |
IContextMenuHandler |
Implement this interface to handle context menu events.
| |
IContextMenuParams |
Wrapper for the CefContextMenuParams
| |
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.
| |
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)
| |
IGeolocationCallback |
Callback interface used for asynchronous continuation of geolocation permission requests.
| |
IGeolocationHandler |
Implement this interface to handle events related to geolocation permission requests.
The methods of this class will be called on the CEF UI thread.
| |
IJavascriptCallback | ||
IJsDialogCallback | ||
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.
| |
IMenuModel | ||
INavigationEntryVisitor |
Callback interface for IBrowserHost.GetNavigationEntries.
The methods of this class will be called on the CEF UI thread.
| |
IPopupFeatures | ||
IPostData | ||
IPostDataElement | ||
IPrintToPdfCallback |
Callback interface for PrintToPdf(String, PdfPrintSettings, IPrintToPdfCallback). The methods of this interface
will be called on the CEF UI thread.
| |
IRenderProcessMessageHandler |
Messages sent by the render process can be handled by implementing this
interface.
| |
IRequest | ||
IRequestCallback | ||
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
[!:IWebBrowser.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. Implement this interface to cancel loading of specific plugins
| |
IRequestHandler |
Implement this interface to handle events related to browser requests.
The methods of this class will be called on the thread indicated.
| |
IResolveCallback | ||
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 keywoard to existing methods e.g. ProcessRequestAsync.
| |
IResourceHandlerFactory |
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.
| |
IResponse | ||
IResponseFilter | ||
IRunContextMenuCallback | ||
ISchemeHandlerFactory |
Class that creates IResourceHandler instances for handling scheme requests.
The methods of this class will always be called on the CEF IO thread.
| |
ISelectClientCertificateCallback |
Callback interface used to select a client certificate for authentication.
| |
ISslInfo | ||
IStringVisitor |
Implement this interface to receive string values asynchronously.
| |
ITaskScheduler | ||
IWebBrowser |
ChromiumWebBrowser implementations implement this interface. Can be cast to
the concrete implementation to access UI specific features.
| |
IWindowInfo |
Enumeration | Description | |
---|---|---|
CefCursorType |
Cursor type values.
| |
CefErrorCode |
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).
| |
CefEventFlags |
Supported event bit flags.
| |
CefFileDialogMode |
CefFileDialogMode (Based on cef_file_dialog_mode_t)
| |
CefFocusSource |
Focus Source
| |
CefGeoPositionErrorCode |
Geoposition error codes.
| |
CefJsDialogType |
Supported JavaScript dialog types.
| |
CefMenuCommand | ||
CefPdfPrintMarginType |
Margin type for PDF printing.
| |
CefReturnValue |
Return value types.
| |
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.
| |
ContextMenuMediaType |
Supported context menu media types.
| |
ContextMenuType | ||
DragOperationsMask |
"Verb" of a drag-and-drop operation as negotiated between the source and destination.
| |
FilterStatus |
Return values for IResponseFilter
| |
KeyEventType | ||
KeyType | ||
LogSeverity | ||
MenuItemType | ||
MouseButtonType | ||
PaintElementType |
Paint element types.
| |
PluginPolicy |
Plugin policies supported by IPluginHandler.OnBeforePluginLoad.
| |
PostDataElementType |
Post data elements may represent either bytes or files.
| |
ReferrerPolicy | ||
ResourceHandlerType | ||
ResourceType |
Resource type for a request.
| |
ResponseAction | ||
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.
| |
UrlRequestStatus |
Flags that represent CefURLRequest status.
| |
WindowOpenDisposition |
The manner in which a link click should be opened.
|