<?xml version="1.0"?>
|
<doc>
|
<assembly>
|
<name>CefSharp</name>
|
</assembly>
|
<members>
|
<member name="T:CefSharp.AsyncExtensions">
|
<summary>
|
Async extensions for different interfaces
|
</summary>
|
</member>
|
<member name="M:CefSharp.AsyncExtensions.DeleteCookiesAsync(CefSharp.ICookieManager,System.String,System.String)">
|
<summary>
|
Deletes all cookies that matches all the provided parameters asynchronously.
|
If both <paramref name="url"/> and <paramref name="name"/> are empty, all cookies will be deleted.
|
</summary>
|
<param name="cookieManager">cookie manager</param>
|
<param name="url">The cookie URL. If an empty string is provided, any URL will be matched.</param>
|
<param name="name">The name of the cookie. If an empty string is provided, any URL will be matched.</param>
|
<returns>Returns -1 if a non-empty invalid URL is specified, or if cookies cannot be accessed;
|
otherwise, a task that represents the delete operation. The value of the TResult will be the number of cookies that were deleted or -1 if unknown.</returns>
|
</member>
|
<member name="M:CefSharp.AsyncExtensions.SetCookieAsync(CefSharp.ICookieManager,System.String,CefSharp.Cookie)">
|
<summary>
|
Sets a cookie given a valid URL and explicit user-provided cookie attributes.
|
This function expects each attribute to be well-formed. It will check for disallowed
|
characters (e.g. the ';' character is disallowed within the cookie value attribute) and will return false without setting
|
</summary>
|
<param name="cookieManager">cookie manager</param>
|
<param name="url">The cookie URL. If an empty string is provided, any URL will be matched.</param>
|
<param name="cookie">the cookie to be set</param>
|
<returns>returns false if the cookie cannot be set (e.g. if illegal charecters such as ';' are used);
|
otherwise task that represents the set operation. The value of the TResult parameter contains a bool to indicate success.</returns>
|
</member>
|
<member name="M:CefSharp.AsyncExtensions.VisitAllCookiesAsync(CefSharp.ICookieManager)">
|
<summary>
|
Visits all cookies. The returned cookies are sorted by longest path, then by earliest creation date.
|
</summary>
|
<param name="cookieManager">cookie manager</param>
|
<returns>A task that represents the VisitAllCookies operation. The value of the TResult parameter contains a List of cookies
|
or null if cookies cannot be accessed.</returns>
|
</member>
|
<member name="M:CefSharp.AsyncExtensions.VisitUrlCookiesAsync(CefSharp.ICookieManager,System.String,System.Boolean)">
|
<summary>
|
Visits a subset of the cookies. The results are filtered by the given url scheme, host, domain and path.
|
If <paramref name="includeHttpOnly"/> is true, HTTP-only cookies will also be included in the results. The returned cookies
|
are sorted by longest path, then by earliest creation date.
|
</summary>
|
<param name="cookieManager">cookie manager</param>
|
<param name="url">The URL to use for filtering a subset of the cookies available.</param>
|
<param name="includeHttpOnly">A flag that determines whether HTTP-only cookies will be shown in results.</param>
|
<returns>A task that represents the VisitUrlCookies operation. The value of the TResult parameter contains a List of cookies.
|
or null if cookies cannot be accessed.</returns>
|
</member>
|
<member name="M:CefSharp.AsyncExtensions.FlushStoreAsync(CefSharp.ICookieManager)">
|
<summary>
|
Flush the backing store (if any) to disk.
|
</summary>
|
<param name="cookieManager">cookieManager instance</param>
|
<returns>A task that represents the FlushStore operation. Result indicates if the flush completed successfully.
|
Will return false if the cookikes cannot be accessed.</returns>
|
</member>
|
<member name="M:CefSharp.AsyncExtensions.GetNavigationEntriesAsync(CefSharp.IBrowserHost,System.Boolean)">
|
<summary>
|
Retrieve a snapshot of current navigation entries
|
</summary>
|
<param name="browserHost">browserHost</param>
|
<param name="currentOnly">If true the List will only contain the current navigation entry.
|
If false the List will include all navigation entries will be included. Default is false</param>
|
</member>
|
<member name="T:CefSharp.BindingOptions">
|
<summary>
|
Javascript binding options
|
</summary>
|
</member>
|
<member name="P:CefSharp.BindingOptions.DefaultBinder">
|
<summary>
|
Set of options with the default binding
|
</summary>
|
</member>
|
<member name="P:CefSharp.BindingOptions.Binder">
|
<summary>
|
Model binder used for passing complex classes as params to methods
|
</summary>
|
</member>
|
<member name="P:CefSharp.BindingOptions.MethodInterceptor">
|
<summary>
|
Interceptor used for intercepting calls to the target object methods. For instance, can be used
|
for logging calls (from js) to .net methods.
|
</summary>
|
</member>
|
<member name="P:CefSharp.BindingOptions.PropertyInterceptor">
|
<summary>
|
Interceptor used for intercepting get/set calls to the target object property. For instance, can be used
|
for logging calls to .net property (from js)
|
</summary>
|
</member>
|
<member name="T:CefSharp.IAuthCallback">
|
<summary>
|
Callback interface used for asynchronous continuation of authentication requests.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IAuthCallback.Continue(System.String,System.String)">
|
<summary>
|
Continue the authentication request.
|
</summary>
|
<param name="username">requested username</param>
|
<param name="password">requested password</param>
|
</member>
|
<member name="M:CefSharp.IAuthCallback.Cancel">
|
<summary>
|
Cancel the authentication request.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IAuthCallback.IsDisposed">
|
<summary>
|
Gets a value indicating whether the callback has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IBeforeDownloadCallback">
|
<summary>
|
Callback interface used to asynchronously continue a download.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBeforeDownloadCallback.Continue(System.String,System.Boolean)">
|
<summary>
|
Call to continue the download.
|
</summary>
|
<param name="downloadPath">full file path for the download including the file name
|
or leave blank to use the suggested name and the default temp directory</param>
|
<param name="showDialog">Set to true if you do wish to show the default "Save As" dialog</param>
|
</member>
|
<member name="P:CefSharp.IBeforeDownloadCallback.IsDisposed">
|
<summary>
|
Gets a value indicating whether the callback has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.ICallback">
|
<summary>
|
Generic callback interface used for asynchronous continuation.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ICallback.Continue">
|
<summary>
|
Continue processing.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ICallback.Cancel">
|
<summary>
|
Cancel processing.
|
</summary>
|
</member>
|
<member name="P:CefSharp.ICallback.IsDisposed">
|
<summary>
|
Gets a value indicating whether the callback has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.ICompletionCallback">
|
<summary>
|
Generic callback interface used for asynchronous completion.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ICompletionCallback.OnComplete">
|
<summary>
|
Method that will be called once the task is complete.
|
</summary>
|
</member>
|
<member name="P:CefSharp.ICompletionCallback.IsDisposed">
|
<summary>
|
Gets a value indicating whether the callback has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IDeleteCookiesCallback">
|
<summary>
|
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
|
</summary>
|
</member>
|
<member name="M:CefSharp.IDeleteCookiesCallback.OnComplete(System.Int32)">
|
<summary>
|
Method that will be called upon completion.
|
</summary>
|
<param name="numDeleted">will be the number of cookies that were deleted or -1 if unknown.</param>
|
</member>
|
<member name="P:CefSharp.IDeleteCookiesCallback.IsDisposed">
|
<summary>
|
Gets a value indicating whether the callback has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Callback.IDevToolsMessageObserver">
|
<summary>
|
Callback interface for <see cref="M:CefSharp.IBrowserHost.AddDevToolsMessageObserver(CefSharp.Callback.IDevToolsMessageObserver)"/>.
|
The methods of this class will be called on the CEF UI thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Callback.IDevToolsMessageObserver.OnDevToolsMessage(CefSharp.IBrowser,System.IO.Stream)">
|
<summary>
|
Method that will be called on receipt of a DevTools protocol message.
|
Method result dictionaries include an "id" (int) value that identifies the
|
orginating method call sent from IBrowserHost.SendDevToolsMessage, and
|
optionally either a "result" (dictionary) or "error" (dictionary) value.
|
The "error" dictionary will contain "code" (int) and "message" (string)
|
values. Event dictionaries include a "method" (string) value and optionally
|
a "params" (dictionary) value. See the DevTools protocol documentation at
|
https://chromedevtools.github.io/devtools-protocol/ for details of
|
supported method calls and the expected "result" or "params" dictionary
|
contents. JSON dictionaries can be parsed using the CefParseJSON function
|
if desired, however be aware of performance considerations when parsing
|
large messages (some of which may exceed 1MB in size).
|
</summary>
|
<param name="browser">is the originating browser instance</param>
|
<param name="message">is a UTF8-encoded JSON dictionary representing either a method result or an event.
|
is only valid for the scope of this callback and should be copied if necessary
|
</param>
|
<returns>Return true if the message was handled or false if the message
|
should be further processed and passed to the OnDevToolsMethodResult or
|
OnDevToolsEvent methods as appropriate.</returns>
|
</member>
|
<member name="M:CefSharp.Callback.IDevToolsMessageObserver.OnDevToolsMethodResult(CefSharp.IBrowser,System.Int32,System.Boolean,System.IO.Stream)">
|
<summary>
|
Method that will be called after attempted execution of a DevTools protocol
|
</summary>
|
<param name="browser">is the originating browser instance</param>
|
<param name="messageId">is the id value that identifies the originating method call message</param>
|
<param name="success">If the method succeeded <paramref name="success"/> will be true and <paramref name="result"/> will be the
|
UTF8-encoded JSON "result" dictionary value (which may be empty).
|
If the method failed <paramref name="success"/> will be false and <paramref name="result"/> will be the UTF8-encoded
|
JSON "error" dictionary value.
|
</param>
|
<param name="result">The stream is only valid for the scope of this
|
callback and should be copied if necessary. See the OnDevToolsMessage
|
documentation for additional details on contents</param>
|
</member>
|
<member name="M:CefSharp.Callback.IDevToolsMessageObserver.OnDevToolsEvent(CefSharp.IBrowser,System.String,System.IO.Stream)">
|
<summary>
|
Method that will be called on receipt of a DevTools protocol event.
|
</summary>
|
<param name="browser">is the originating browser instance</param>
|
<param name="method">is the method value</param>
|
<param name="parameters">is the UTF8-encoded JSON "params" dictionary value (which
|
may be empty). This stream is only valid for the scope of this callback and
|
should be copied if necessary. See the OnDevToolsMessage documentation for
|
additional details on contents.
|
</param>
|
</member>
|
<member name="M:CefSharp.Callback.IDevToolsMessageObserver.OnDevToolsAgentAttached(CefSharp.IBrowser)">
|
<summary>
|
Method that will be called when the DevTools agent has attached.
|
This will generally occur in response to the first message sent while the agent is detached.
|
</summary>
|
<param name="browser">is the originating browser instance</param>
|
</member>
|
<member name="M:CefSharp.Callback.IDevToolsMessageObserver.OnDevToolsAgentDetached(CefSharp.IBrowser)">
|
<summary>
|
Method that will be called when the DevTools agent has detached.
|
Any method results that were pending before the agent became detached will not be delivered, and any active
|
event subscriptions will be canceled.
|
</summary>
|
<param name="browser">is the originating browser instance</param>
|
</member>
|
<member name="T:CefSharp.Callback.IResourceReadCallback">
|
<summary>
|
Callback for asynchronous continuation of <see cref="M:CefSharp.IResourceHandler.Read(System.IO.Stream,System.Int32@,CefSharp.Callback.IResourceReadCallback)"/>.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Callback.IResourceReadCallback.Continue(System.Int32)">
|
<summary>
|
Callback for asynchronous continuation of <see cref="M:CefSharp.IResourceHandler.Read(System.IO.Stream,System.Int32@,CefSharp.Callback.IResourceReadCallback)"/>. If bytesRead == 0
|
the response will be considered complete.
|
</summary>
|
<param name="bytesRead">
|
If bytesRead == 0 the response will be considered complete.
|
If bytesRead > 0 then <see cref="M:CefSharp.IResourceHandler.Read(System.IO.Stream,System.Int32@,CefSharp.Callback.IResourceReadCallback)"/> will be called again until the request is complete (based on either the
|
result or the expected content length). If bytesRead < 0 then the
|
request will fail and the bytesRead value will be treated as the error
|
code.
|
</param>
|
</member>
|
<member name="P:CefSharp.Callback.IResourceReadCallback.IsDisposed">
|
<summary>
|
Gets a value indicating whether the callback has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Callback.IResourceSkipCallback">
|
<summary>
|
Callback for asynchronous continuation of <see cref="M:CefSharp.IResourceHandler.Skip(System.Int64,System.Int64@,CefSharp.Callback.IResourceSkipCallback)"/>.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Callback.IResourceSkipCallback.Continue(System.Int64)">
|
<summary>
|
Callback for asynchronous continuation of Skip().
|
</summary>
|
<param name="bytesSkipped">If bytesSkipped > 0 then either Skip() will be called
|
again until the requested number of bytes have been skipped or the request will proceed.
|
If bytesSkipped <= the request will fail with ERR_REQUEST_RANGE_NOT_SATISFIABLE.</param>
|
</member>
|
<member name="P:CefSharp.Callback.IResourceSkipCallback.IsDisposed">
|
<summary>
|
Gets a value indicating whether the callback has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Callback.IRunFileDialogCallback">
|
<summary>
|
Callback interface for IBrowserHost.RunFileDialog.
|
The methods of this class will be called on the CEF UI thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Callback.IRunFileDialogCallback.OnFileDialogDismissed(System.Collections.Generic.IList{System.String})">
|
<summary>
|
Called asynchronously after the file dialog is dismissed.
|
</summary>
|
<param name="filePaths">will be a single value or a list of values depending on the dialog mode. If the selection was cancelled filePaths will be empty</param>
|
</member>
|
<member name="T:CefSharp.Callback.NoOpCompletionCallback">
|
<summary>
|
Provides a callback implementation of <see cref="T:CefSharp.ICompletionCallback"/>
|
that does nothing with complete.
|
Added to workaround a CEF bug as per https://github.com/cefsharp/CefSharp/issues/2957#issuecomment-555285400
|
</summary>
|
</member>
|
<member name="M:CefSharp.Callback.NoOpCompletionCallback.CefSharp#ICompletionCallback#OnComplete">
|
<inheritdoc/>
|
</member>
|
<member name="P:CefSharp.Callback.NoOpCompletionCallback.CefSharp#ICompletionCallback#IsDisposed">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Callback.NoOpCompletionCallback.System#IDisposable#Dispose">
|
<inheritdoc/>
|
</member>
|
<member name="T:CefSharp.IDownloadItemCallback">
|
<summary>
|
Callback interface used to asynchronously cancel a download.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IDownloadItemCallback.Cancel">
|
<summary>
|
Call to cancel the download.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IDownloadItemCallback.Pause">
|
<summary>
|
Call to pause the download.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IDownloadItemCallback.Resume">
|
<summary>
|
Call to resume the download.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IDownloadItemCallback.IsDisposed">
|
<summary>
|
Gets a value indicating whether the callback has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IFileDialogCallback">
|
<summary>
|
Callback interface for asynchronous continuation of file dialog requests.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IFileDialogCallback.Continue(System.Collections.Generic.List{System.String})">
|
<summary>
|
Continue the file selection.
|
</summary>
|
<param name="filePaths">should be a single value or a list of values depending on the dialog mode.
|
An empty value is treated the same as calling Cancel().</param>
|
</member>
|
<member name="M:CefSharp.IFileDialogCallback.Cancel">
|
<summary>
|
Cancel the file selection.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IFileDialogCallback.IsDisposed">
|
<summary>
|
Gets a value indicating whether the callback has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IGetExtensionResourceCallback">
|
<summary>
|
Callback interface used for asynchronous continuation of <see cref="M:CefSharp.IExtensionHandler.GetExtensionResource(CefSharp.IExtension,CefSharp.IBrowser,System.String,CefSharp.IGetExtensionResourceCallback)"/>.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IGetExtensionResourceCallback.Continue(System.IO.Stream)">
|
<summary>
|
Continue the request. Read the resource contents from stream.
|
</summary>
|
<param name="stream">stream to be used as response.</param>
|
</member>
|
<member name="M:CefSharp.IGetExtensionResourceCallback.Continue(System.Byte[])">
|
<summary>
|
Continue the request
|
</summary>
|
<param name="data">data to be used as response</param>
|
</member>
|
<member name="M:CefSharp.IGetExtensionResourceCallback.Cancel">
|
<summary>
|
Cancel the request.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IJavascriptCallback">
|
<summary>
|
Javascript callback interface
|
</summary>
|
</member>
|
<member name="P:CefSharp.IJavascriptCallback.Id">
|
<summary>
|
Callback Id
|
</summary>
|
</member>
|
<member name="M:CefSharp.IJavascriptCallback.ExecuteAsync(System.Object[])">
|
<summary>
|
Execute the javascript callback
|
</summary>
|
<param name="parms">param array of objects</param>
|
<returns>JavascriptResponse</returns>
|
</member>
|
<member name="M:CefSharp.IJavascriptCallback.ExecuteWithTimeoutAsync(System.Nullable{System.TimeSpan},System.Object[])">
|
<summary>
|
Execute the javascript callback
|
</summary>
|
<param name="timeout">timeout</param>
|
<param name="parms">param array of objects</param>
|
<returns>JavascriptResponse</returns>
|
</member>
|
<member name="P:CefSharp.IJavascriptCallback.CanExecute">
|
<summary>
|
Check to see if the underlying resource are still available to execute the callback
|
</summary>
|
</member>
|
<member name="P:CefSharp.IJavascriptCallback.IsDisposed">
|
<summary>
|
Gets a value indicating whether the callback has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IJsDialogCallback">
|
<summary>
|
Callback interface used for asynchronous continuation of JavaScript dialog requests.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IJsDialogCallback.Continue(System.Boolean,System.String)">
|
<summary>
|
Continue the Javascript dialog request.
|
</summary>
|
<param name="success">Set to true if the OK button was pressed.</param>
|
<param name="userInput">value should be specified for prompt dialogs.</param>
|
</member>
|
<member name="M:CefSharp.IJsDialogCallback.Continue(System.Boolean)">
|
<summary>
|
Continue the Javascript dialog request.
|
</summary>
|
<param name="success">Set to true if the OK button was pressed.</param>
|
</member>
|
<member name="P:CefSharp.IJsDialogCallback.IsDisposed">
|
<summary>
|
Gets a value indicating whether the callback has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IMediaAccessCallback">
|
<summary>
|
Callback interface used for asynchronous continuation of media access
|
permission requests.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IMediaAccessCallback.Continue(CefSharp.MediaAccessPermissionType)">
|
<summary>
|
Call to allow or deny media access. If this callback was initiated in
|
response to a getUserMedia (indicated by
|
DeviceAudioCapture and/or DeviceVideoCapture being set) then
|
<paramref name="allowedPermissions"/> must match requestedPermissions param passed to
|
<see cref="M:CefSharp.IPermissionHandler.OnRequestMediaAccessPermission(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.String,CefSharp.MediaAccessPermissionType,CefSharp.IMediaAccessCallback)"/>
|
</summary>
|
<param name="allowedPermissions">Allowed Permissions</param>
|
</member>
|
<member name="M:CefSharp.IMediaAccessCallback.Cancel">
|
<summary>
|
Cancel the media access request.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IPermissionPromptCallback">
|
<summary>
|
Callback interface used for asynchronous continuation of permission prompts.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IPermissionPromptCallback.Continue(CefSharp.PermissionRequestResult)">
|
<summary>
|
Complete the permissions request with the specified result.
|
</summary>
|
<param name="result">Permission request results.</param>
|
</member>
|
<member name="T:CefSharp.IPrintToPdfCallback">
|
<summary>
|
Callback interface for <see cref="M:CefSharp.IBrowserHost.PrintToPdf(System.String,CefSharp.PdfPrintSettings,CefSharp.IPrintToPdfCallback)"/>. The methods of this interface
|
will be called on the CEF UI thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IPrintToPdfCallback.OnPdfPrintFinished(System.String,System.Boolean)">
|
<summary>
|
Method that will be executed when the PDF printing has completed.
|
</summary>
|
<param name="path">The output path.</param>
|
<param name="ok">Will be true if the printing completed
|
successfully or false otherwise.</param>
|
</member>
|
<member name="P:CefSharp.IPrintToPdfCallback.IsDisposed">
|
<summary>
|
Gets a value indicating whether the callback has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IRequestCallback">
|
<summary>
|
Callback interface used for asynchronous continuation of url requests.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IRequestCallback.Continue(System.Boolean)">
|
<summary>
|
Continue the url request.
|
</summary>
|
<param name="allow">If is true the request will be continued, otherwise, the request will be canceled.</param>
|
</member>
|
<member name="M:CefSharp.IRequestCallback.Cancel">
|
<summary>
|
Cancel the url request.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IRequestCallback.IsDisposed">
|
<summary>
|
Gets a value indicating whether the callback has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IResolveCallback">
|
<summary>
|
Callback interface for <see cref="M:CefSharp.IRequestContext.ResolveHostAsync(System.Uri)"/>
|
</summary>
|
</member>
|
<member name="M:CefSharp.IResolveCallback.OnResolveCompleted(CefSharp.CefErrorCode,System.Collections.Generic.IList{System.String})">
|
<summary>
|
Called after the ResolveHost request has completed.
|
</summary>
|
<param name="result">The result code</param>
|
<param name="resolvedIpAddresses">will be the list of resolved IP addresses or
|
empty if the resolution failed.</param>
|
</member>
|
<member name="P:CefSharp.IResolveCallback.IsDisposed">
|
<summary>
|
Gets a value indicating whether the callback has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IRunContextMenuCallback">
|
<summary>
|
Callback interface used for continuation of custom context menu display.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IRunContextMenuCallback.Continue(CefSharp.CefMenuCommand,CefSharp.CefEventFlags)">
|
<summary>
|
Complete context menu display by selecting the specified commandId and eventFlags;
|
</summary>
|
<param name="commandId">the command Id</param>
|
<param name="eventFlags">the event flags</param>
|
</member>
|
<member name="M:CefSharp.IRunContextMenuCallback.Cancel">
|
<summary>
|
Cancel context menu display.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IRunContextMenuCallback.IsDisposed">
|
<summary>
|
Gets a value indicating whether the callback has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.ISelectClientCertificateCallback">
|
<summary>
|
Callback interface used to select a client certificate for authentication.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ISelectClientCertificateCallback.Select(System.Security.Cryptography.X509Certificates.X509Certificate2)">
|
<summary>
|
Callback interface used to select a client certificate for authentication.
|
<see langword="null"/> value means that no client certificate should be used.
|
</summary>
|
<param name="selectedCert">selected certificate</param>
|
</member>
|
<member name="P:CefSharp.ISelectClientCertificateCallback.IsDisposed">
|
<summary>
|
Gets a value indicating whether the callback has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.ISetCookieCallback">
|
<summary>
|
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
|
</summary>
|
</member>
|
<member name="M:CefSharp.ISetCookieCallback.OnComplete(System.Boolean)">
|
<summary>
|
Method that will be called upon completion.
|
</summary>
|
<param name="success">success will be true if the cookie was set successfully.</param>
|
</member>
|
<member name="P:CefSharp.ISetCookieCallback.IsDisposed">
|
<summary>
|
Gets a value indicating whether the callback has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.TaskCompletionCallback">
|
<summary>
|
Provides a callback implementation of <see cref="T:CefSharp.ICompletionCallback"/>.
|
</summary>
|
</member>
|
<member name="M:CefSharp.TaskCompletionCallback.#ctor">
|
<summary>
|
Initializes a new instance of the TaskCompletionCallback class.
|
</summary>
|
</member>
|
<member name="P:CefSharp.TaskCompletionCallback.Task">
|
<summary>
|
Task used to await this callback
|
</summary>
|
</member>
|
<member name="T:CefSharp.TaskDeleteCookiesCallback">
|
<summary>
|
Provides a callback implementation of <see cref="T:CefSharp.IDeleteCookiesCallback"/>.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TaskDeleteCookiesCallback.InvalidNoOfCookiesDeleted">
|
<summary>
|
Invalid Number of Cookies
|
</summary>
|
</member>
|
<member name="M:CefSharp.TaskDeleteCookiesCallback.#ctor">
|
<summary>
|
Initializes a new instance of the TaskDeleteCookiesCallback class.
|
</summary>
|
</member>
|
<member name="P:CefSharp.TaskDeleteCookiesCallback.Task">
|
<summary>
|
Task used to await this callback
|
</summary>
|
</member>
|
<member name="T:CefSharp.TaskPrintToPdfCallback">
|
<summary>
|
Provides a callback implementation of <see cref="T:CefSharp.IPrintToPdfCallback"/>.
|
</summary>
|
</member>
|
<member name="P:CefSharp.TaskPrintToPdfCallback.Task">
|
<summary>
|
Task used to await this callback
|
</summary>
|
</member>
|
<member name="T:CefSharp.TaskResolveCallback">
|
<summary>
|
Provides a callback implementation of <see cref="T:CefSharp.IResolveCallback"/>.
|
</summary>
|
</member>
|
<member name="M:CefSharp.TaskResolveCallback.#ctor">
|
<summary>
|
Initializes a new instance of the TaskResolveCallback class.
|
</summary>
|
</member>
|
<member name="P:CefSharp.TaskResolveCallback.Task">
|
<summary>
|
Task used to await this callback
|
</summary>
|
</member>
|
<member name="T:CefSharp.TaskSetCookieCallback">
|
<summary>
|
Provides a callback implementation of <see cref="T:CefSharp.ISetCookieCallback"/>.
|
</summary>
|
</member>
|
<member name="M:CefSharp.TaskSetCookieCallback.#ctor">
|
<summary>
|
Initializes a new instance of the TaskSetCookieCallback class.
|
</summary>
|
</member>
|
<member name="P:CefSharp.TaskSetCookieCallback.Task">
|
<summary>
|
Task used to await this callback
|
</summary>
|
</member>
|
<member name="T:CefSharp.CefCustomScheme">
|
<summary>
|
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 <see cref="T:CefSharp.ISchemeHandlerFactory"/> using
|
Cef.GetGlobalRequestContext().RegisterSchemeHandlerFactory - make sure the Global RequestContext has
|
been initialized before doing so, you can use <see cref="M:CefSharp.IBrowserProcessHandler.OnContextInitialized"/>
|
for notification of RequestContext initialization (Pass an IBrowserProcessHandler instance to Cef.Initialize)
|
</summary>
|
</member>
|
<member name="P:CefSharp.CefCustomScheme.SchemeName">
|
<summary>
|
Schema Name e.g. custom
|
</summary>
|
</member>
|
<member name="P:CefSharp.CefCustomScheme.DomainName">
|
<summary>
|
Optional Domain Name. An empty value for a standard scheme
|
will cause the factory to match all domain names. The |domain_name| value
|
will be ignored for non-standard schemes.
|
</summary>
|
</member>
|
<member name="P:CefSharp.CefCustomScheme.IsStandard">
|
<summary>
|
If true the scheme will be treated as a standard scheme.
|
Standard schemes are subject to URL canonicalization and parsing rules as
|
defined in the Common Internet Scheme Syntax RFC 1738 Section 3.1 available
|
at http://www.ietf.org/rfc/rfc1738.txt
|
|
In particular, the syntax for standard scheme URLs must be of the form:
|
<pre>
|
[scheme]://[username]:[password]@[host]:[port]/[url-path]
|
</pre>
|
Standard scheme URLs must have a host component that is a fully qualified
|
domain name as defined in Section 3.5 of RFC 1034 [13] and Section 2.1 of
|
RFC 1123. These URLs will be canonicalized to "scheme://host/path" in the
|
simplest case and "scheme://username:password@host:port/path" in the most
|
explicit case. For example, "scheme:host/path" and "scheme:///host/path"
|
will both be canonicalized to "scheme://host/path". The origin of a
|
standard scheme URL is the combination of scheme, host and port (i.e.,
|
"scheme://host:port" in the most explicit case).
|
|
For non-standard scheme URLs only the "scheme:" component is parsed and
|
canonicalized. The remainder of the URL will be passed to the handler
|
as-is. For example, "scheme:///some%20text" will remain the same.
|
Non-standard scheme URLs cannot be used as a target for form submission.
|
</summary>
|
</member>
|
<member name="P:CefSharp.CefCustomScheme.IsLocal">
|
<summary>
|
If true the scheme will be treated as local (i.e. with the
|
same security rules as those applied to "file" URLs). Normal pages cannot
|
link to or access local URLs. Also, by default, local URLs can only perform
|
XMLHttpRequest calls to the same URL (origin + path) that originated the
|
request. To allow XMLHttpRequest calls from a local URL to other URLs with
|
the same origin set the CefSettings.file_access_from_file_urls_allowed
|
value to true. To allow XMLHttpRequest calls from a local URL to all
|
origins set the CefSettings.universal_access_from_file_urls_allowed value
|
to true.
|
</summary>
|
</member>
|
<member name="P:CefSharp.CefCustomScheme.IsDisplayIsolated">
|
<summary>
|
If true the scheme will be treated as display-isolated.
|
This means that pages cannot display these URLs unless they are
|
from the same scheme. For example, pages in another origin cannot create
|
iframes or hyperlinks to URLs with this scheme.
|
</summary>
|
</member>
|
<member name="P:CefSharp.CefCustomScheme.IsSecure">
|
<summary>
|
If true the scheme will be treated with the same security
|
rules as those applied to "https" URLs. For example, loading this scheme
|
from other secure schemes will not trigger mixed content warnings.
|
</summary>
|
</member>
|
<member name="P:CefSharp.CefCustomScheme.IsCorsEnabled">
|
<summary>
|
If true the scheme can be sent CORS requests.
|
This value should be true in most cases where IsStandard is true.
|
</summary>
|
</member>
|
<member name="P:CefSharp.CefCustomScheme.IsCSPBypassing">
|
<summary>
|
If true the scheme can bypass Content-Security-Policy(CSP) checks.
|
This value should be false in most cases where IsStandard is true.
|
</summary>
|
</member>
|
<member name="P:CefSharp.CefCustomScheme.IsFetchEnabled">
|
<summary>
|
If true the scheme can perform Fetch API requests.
|
</summary>
|
</member>
|
<member name="P:CefSharp.CefCustomScheme.SchemeHandlerFactory">
|
<summary>
|
Factory Class that creates <see cref="T:CefSharp.IResourceHandler"/> instances
|
for handling scheme requests. Leave this null if you wish to manually register the
|
scheme handler with the relevant RequestContext.
|
</summary>
|
</member>
|
<member name="P:CefSharp.CefCustomScheme.Options">
|
<summary>
|
Gets the underlying scheme options that represents
|
</summary>
|
</member>
|
<member name="M:CefSharp.CefCustomScheme.#ctor">
|
<summary>
|
Creates a new CefCustomScheme.
|
</summary>
|
</member>
|
<member name="M:CefSharp.CefCustomScheme.#ctor(System.String,CefSharp.Enums.SchemeOptions)">
|
<summary>
|
Creates a new CefCustomScheme.
|
</summary>
|
<param name="schemeName">scheme name</param>
|
<param name="options">scheme options</param>
|
</member>
|
<member name="M:CefSharp.CefCustomScheme.ParseCommandLineArguments(System.Collections.Generic.IEnumerable{System.String})">
|
<summary>
|
Method used internally
|
</summary>
|
<param name="args">command line arguments</param>
|
<returns>list of scheme objects</returns>
|
</member>
|
<member name="T:CefSharp.CefLibraryHandle">
|
<summary>
|
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
|
</summary>
|
<remarks>Adapted from http://www.pinvoke.net/default.aspx/kernel32.loadlibraryex</remarks>
|
</member>
|
<member name="T:CefSharp.CefLibraryHandle.LoadLibraryFlags">
|
<summary>
|
In general not a fan of having inline classes/enums
|
In this case it's not something that I'd like to see exposed
|
as it's just a helper and outside the scope of the project
|
</summary>
|
</member>
|
<member name="M:CefSharp.CefLibraryHandle.#ctor(System.String)">
|
<summary>
|
Initializes a new instance of the CefLibraryHandle class.
|
</summary>
|
<param name="path">libcef.dll full path.</param>
|
</member>
|
<member name="P:CefSharp.CefLibraryHandle.IsInvalid">
|
<summary>
|
When overridden in a derived class, gets a value indicating whether the handle value is invalid.
|
</summary>
|
<value>
|
true if the handle value is invalid; otherwise, false.
|
</value>
|
</member>
|
<member name="M:CefSharp.CefLibraryHandle.ReleaseHandle">
|
<summary>
|
When overridden in a derived class, executes the code required to free the handle.
|
</summary>
|
<returns>
|
true if the handle is released successfully; otherwise, in the event of a catastrophic failure, false. In this case, it
|
generates a releaseHandleFailed MDA Managed Debugging Assistant.
|
</returns>
|
</member>
|
<member name="T:CefSharp.CefRuntime">
|
<summary>
|
CefRuntime - Used to simplify loading of the CefSharp architecture specific resources.
|
Typical use case would be when you are targeting AnyCPU
|
</summary>
|
</member>
|
<member name="M:CefSharp.CefRuntime.SubscribeAnyCpuAssemblyResolver(System.String)">
|
<summary>
|
When using AnyCPU the architecture specific version of CefSharp.Core.Runtime.dll
|
needs to be loaded (x64/x86).
|
This method subscribes to the <see cref="E:System.AppDomain.AssemblyResolve"/> event
|
for <see cref="P:System.AppDomain.CurrentDomain"/> and loads the CefSharp.Core.Runtime.dll
|
based on <see cref="P:System.Environment.Is64BitProcess"/>.
|
This method MUST be called before you call Cef.Initialize, create your first ChromiumWebBrowser instance, basically
|
before anything CefSharp related happens. This method is part of CefSharp.dll which is an AnyCPU library and
|
doesn't have any references to the CefSharp.Core.Runtime.dll so it's safe to use.
|
</summary>
|
<param name="basePath">
|
The path containing the x64/x86 folders which contain the CefSharp/CEF resources.
|
If null then AppDomain.CurrentDomain.SetupInformation.ApplicationBase will be used as the path.
|
(</param>
|
</member>
|
<member name="M:CefSharp.CefRuntime.UnsubscribeAnyCpuAssemblyResolver">
|
<summary>
|
Unsubscribe from the <see cref="E:System.AppDomain.AssemblyResolve"/> event
|
for <see cref="P:System.AppDomain.CurrentDomain"/> that was added in <see cref="!:UseAnyCpuAssemblyResolver"/>
|
</summary>
|
</member>
|
<member name="M:CefSharp.CefRuntime.LoadCefSharpCoreRuntimeAnyCpu(System.String)">
|
<summary>
|
When using AnyCPU the architecture specific version of CefSharp.Core.Runtime.dll
|
needs to be loaded (x64/x86).
|
This method calls <see cref="M:System.Reflection.Assembly.LoadFile(System.String)"/> to immediately load CefSharp.Core.Runtime.dll
|
based on <see cref="P:System.Environment.Is64BitProcess"/>.
|
This method MUST be called before you call Cef.Initialize, create your first ChromiumWebBrowser instance, basically
|
before anything CefSharp related happens. This method is part of CefSharp.dll which is an AnyCPU library and
|
doesn't have any references to the CefSharp.Core.Runtime.dll so it's safe to use.
|
</summary>
|
<param name="basePath">
|
The path containing the x64/x86 folders which contain the CefSharp/CEF resources.
|
If null then AppDomain.CurrentDomain.SetupInformation.ApplicationBase will be used as the path.
|
(</param>
|
</member>
|
<member name="T:CefSharp.CefSharpSettings">
|
<summary>
|
Use this static class to configure some CefSharp specific settings like WcfTimeout
|
</summary>
|
</member>
|
<member name="M:CefSharp.CefSharpSettings.#cctor">
|
<summary>
|
Set default values for CefSharpSettings
|
</summary>
|
</member>
|
<member name="P:CefSharp.CefSharpSettings.WcfEnabled">
|
<summary>
|
WCF is used by JavascriptObjectRepository.Register(isAsync: false) feature for
|
Javascript Binding. It's recomended that anyone developing a new application use
|
the JavascriptObjectRepository.Register(isAsync: true) version which communicates
|
using native Chromium IPC.
|
</summary>
|
</member>
|
<member name="P:CefSharp.CefSharpSettings.WcfTimeout">
|
<summary>
|
Change the Close timeout for the WCF channel used by the sync JSB binding.
|
The default value is currently 2 seconds. Changing this to <see cref="F:System.TimeSpan.Zero"/>
|
will result on Abort() being called on the WCF Channel Host
|
</summary>
|
</member>
|
<member name="P:CefSharp.CefSharpSettings.ShutdownOnExit">
|
<summary>
|
For the WinForms and WPF instances of ChromiumWebBrowser the relevant Application Exit event
|
is hooked and Cef.Shutdown() called by default. Set this to false to disable this behaviour.
|
This value needs to be set before the first instance of ChromiumWebBrowser is created as
|
the event handlers are hooked in the static constructor for the ChromiumWebBrowser class
|
</summary>
|
</member>
|
<member name="P:CefSharp.CefSharpSettings.SubprocessExitIfParentProcessClosed">
|
<summary>
|
CefSharp.BrowserSubprocess will monitor the parent process and exit if the parent process closes
|
before the subprocess. This currently defaults to true.
|
See https://github.com/cefsharp/CefSharp/issues/2359 for more information.
|
</summary>
|
</member>
|
<member name="P:CefSharp.CefSharpSettings.Proxy">
|
<summary>
|
The proxy options that will be used for all connections
|
|
If set before the call to Cef.Initialize, command line arguments will be set for you
|
If a username and password is provided and the IPs match authentication is done automatically
|
|
NOTE: GetAuthCredentials won't be called for a proxy server that matches the IP
|
NOTE: It isn't possble to change the proxy after the call to Cef.Initialize
|
</summary>
|
</member>
|
<member name="P:CefSharp.CefSharpSettings.ConcurrentTaskExecution">
|
<summary>
|
This influences the behavior of how methods are executed for objects registered using
|
<see cref="M:CefSharp.IJavascriptObjectRepository.Register(System.String,System.Object,System.Boolean,CefSharp.BindingOptions)"/>.
|
By default the <see cref="T:CefSharp.Internals.MethodRunnerQueue"/> queues Tasks for execution in a sequential order.
|
A single method is exeucted at a time. Setting this property to true allows for concurrent task execution.
|
Method calls are executed on <see cref="P:System.Threading.Tasks.TaskScheduler.Default"/> (ThreadPool).
|
</summary>
|
</member>
|
<member name="P:CefSharp.CefSharpSettings.FocusedNodeChangedEnabled">
|
<summary>
|
If true a message will be sent from the render subprocess to the
|
browser when a DOM node (or no node) gets focus. The default is
|
false.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Cookie">
|
<summary>
|
Class used to Represent a cookie.
|
The built in .Net Cookie class isn't used as some of it's properties have
|
internal setters
|
</summary>
|
</member>
|
<member name="P:CefSharp.Cookie.Name">
|
<summary>
|
The cookie name
|
</summary>
|
</member>
|
<member name="P:CefSharp.Cookie.Value">
|
<summary>
|
The cookie value.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Cookie.Domain">
|
<summary>
|
If domain is empty a host cookie will be created instead of a domain cookie. Domain cookies are stored with a leading "."
|
and are visible to sub-domains whereas host cookies are not.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Cookie.Path">
|
<summary>
|
Ss non-empty only URLs at or below the path will get the cookie value.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Cookie.Secure">
|
<summary>
|
If true the cookie will only be sent for HTTPS requests.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Cookie.HttpOnly">
|
<summary>
|
Ss true the cookie will only be sent for HTTP requests.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Cookie.Expires">
|
<summary>
|
Expires or null if no expiry
|
</summary>
|
</member>
|
<member name="P:CefSharp.Cookie.Creation">
|
<summary>
|
The cookie creation date. This is automatically populated by the system on cookie creation.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Cookie.LastAccess">
|
<summary>
|
The cookie last access date. This is automatically populated by the system on access.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Cookie.SameSite">
|
<summary>
|
Same site.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Cookie.Priority">
|
<summary>
|
Priority
|
</summary>
|
</member>
|
<member name="M:CefSharp.Cookie.SetCreationDate(System.Int64)">
|
<summary>
|
Used internally to set <see cref="P:CefSharp.Cookie.Creation"/>.
|
<see cref="P:CefSharp.Cookie.Creation"/> can only be set when fecting a Cookie from Chromium
|
</summary>
|
<param name="baseTime">
|
Represents a wall clock time in UTC. Values are not guaranteed to be monotonically
|
non-decreasing and are subject to large amounts of skew. Time is stored internally
|
as microseconds since the Windows epoch (1601).
|
</param>
|
<remarks>
|
Hidden from intellisense as only meant to be used internally, unfortunately
|
VC++ makes it hard to use internal classes from C#
|
</remarks>
|
</member>
|
<member name="M:CefSharp.Cookie.SetLastAccessDate(System.Int64)">
|
<summary>
|
Used internally to set <see cref="P:CefSharp.Cookie.LastAccess"/>.
|
<see cref="P:CefSharp.Cookie.LastAccess"/> can only be set when fecting a Cookie from Chromium
|
</summary>
|
<param name="baseTime">
|
Represents a wall clock time in UTC. Values are not guaranteed to be monotonically
|
non-decreasing and are subject to large amounts of skew. Time is stored internally
|
as microseconds since the Windows epoch (1601).
|
</param>
|
<remarks>
|
Hidden from intellisense as only meant to be used internally, unfortunately
|
VC++ makes it hard to use internal classes from C#
|
</remarks>
|
</member>
|
<member name="T:CefSharp.DefaultApp">
|
<summary>
|
Default implementation of <see cref="T:CefSharp.IApp"/> which represents the CefApp class.
|
</summary>
|
<seealso cref="T:CefSharp.IApp"/>
|
</member>
|
<member name="P:CefSharp.DefaultApp.BrowserProcessHandler">
|
<summary>
|
Return the handler for functionality specific to the browser process. This method is called on multiple threads.
|
</summary>
|
<value>
|
The browser process handler.
|
</value>
|
</member>
|
<member name="P:CefSharp.DefaultApp.Schemes">
|
<summary>
|
Gets or sets the schemes.
|
</summary>
|
<value>
|
The schemes.
|
</value>
|
</member>
|
<member name="M:CefSharp.DefaultApp.#ctor(CefSharp.IBrowserProcessHandler,System.Collections.Generic.IEnumerable{CefSharp.CefCustomScheme})">
|
<summary>
|
Constructor.
|
</summary>
|
<param name="browserProcessHandler">The browser process handler.</param>
|
<param name="schemes">The schemes.</param>
|
</member>
|
<member name="M:CefSharp.DefaultApp.CefSharp#IApp#OnRegisterCustomSchemes(CefSharp.ISchemeRegistrar)">
|
<summary>
|
Provides an opportunity to register custom schemes. Do not keep a reference to the <paramref name="registrar"/> object. This
|
method is called on the main thread for each process and the registered schemes should be the same across all processes.
|
|
</summary>
|
<param name="registrar">scheme registra.</param>
|
</member>
|
<member name="M:CefSharp.DefaultApp.OnRegisterCustomSchemes(CefSharp.ISchemeRegistrar)">
|
<summary>
|
Provides an opportunity to register custom schemes. Do not keep a reference to the <paramref name="registrar"/> object. This
|
method is called on the main thread for each process and the registered schemes should be the same across all processes.
|
|
</summary>
|
<param name="registrar">scheme registra.</param>
|
</member>
|
<member name="M:CefSharp.DefaultApp.Dispose(System.Boolean)">
|
<summary>
|
Releases unmanaged and managed resources
|
</summary>
|
<param name="disposing"><see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
</member>
|
<member name="M:CefSharp.DefaultApp.System#IDisposable#Dispose">
|
<inheritdoc/>
|
</member>
|
<member name="T:CefSharp.DependencyChecker">
|
<summary>
|
DependencyChecker provides a known list of Cef/CefSharp dependencies and
|
provides helper methods to check for their existance.
|
</summary>
|
</member>
|
<member name="F:CefSharp.DependencyChecker.LocalesPackFile">
|
<summary>
|
en-US Locales pak file location
|
</summary>
|
</member>
|
<member name="F:CefSharp.DependencyChecker.CefDependencies">
|
<summary>
|
List of Cef Dependencies
|
</summary>
|
</member>
|
<member name="F:CefSharp.DependencyChecker.CefResources">
|
<summary>
|
List of Cef Resources (pack files)
|
</summary>
|
</member>
|
<member name="F:CefSharp.DependencyChecker.CefOptionalDependencies">
|
<summary>
|
List of Optional CEF Dependencies
|
</summary>
|
</member>
|
<member name="F:CefSharp.DependencyChecker.CefSharpManagedDependencies">
|
<summary>
|
List of CefSharp Managed Dependencies (Those that are AnyCPU written in c#)
|
</summary>
|
</member>
|
<member name="F:CefSharp.DependencyChecker.CefSharpArchSpecificDependencies">
|
<summary>
|
List of CefSharp Arch Specific Dependencies
|
Those that are arch specific,
|
distributed as x86, x64 and ARM64 (coming soon for .Net 5.0 only)
|
</summary>
|
</member>
|
<member name="F:CefSharp.DependencyChecker.BrowserSubprocessDependencies">
|
<summary>
|
List of CefSharp.BrowserSubprocess.exe dependencies.
|
</summary>
|
</member>
|
<member name="M:CefSharp.DependencyChecker.CheckDependencies(System.Boolean,System.Boolean,System.String,System.String,System.String,System.String)">
|
<summary>
|
CheckDependencies iterates through the list of Cef and CefSharp dependencines
|
relative to the path provided and returns a list of missing ones
|
</summary>
|
<param name="checkOptional">check to see if optional dependencies are present</param>
|
<param name="packLoadingDisabled">Is loading of pack files disabled?</param>
|
<param name="path">path to check for dependencies</param>
|
<param name="resourcesDirPath">The path to the resources directory, if empty the Executing Assembly path is used.</param>
|
<param name="browserSubProcessPath">The path to a separate executable that will be launched for sub-processes.</param>
|
<param name="localePackFile">The locale pack file e.g. <see cref="F:CefSharp.DependencyChecker.LocalesPackFile"/> </param>
|
<returns>List of missing dependencies, if all present an empty List will be returned</returns>
|
</member>
|
<member name="M:CefSharp.DependencyChecker.CheckDependencies(System.Boolean,System.Boolean,System.String,System.String,System.String,System.String,System.String)">
|
<summary>
|
CheckDependencies iterates through the list of Cef and CefSharp dependencines
|
relative to the path provided and returns a list of missing ones
|
</summary>
|
<param name="checkOptional">check to see if optional dependencies are present</param>
|
<param name="packLoadingDisabled">Is loading of pack files disabled?</param>
|
<param name="managedLibPath">path to check for mangaed dependencies</param>
|
<param name="nativeLibPath">path to check for native (unmanged) dependencies</param>
|
<param name="resourcesDirPath">The path to the resources directory, if empty the Executing Assembly path is used.</param>
|
<param name="browserSubProcessPath">The path to a separate executable that will be launched for sub-processes.</param>
|
<param name="localePackFile">The locale pack file e.g. <see cref="F:CefSharp.DependencyChecker.LocalesPackFile"/> </param>
|
<returns>List of missing dependencies, if all present an empty List will be returned</returns>
|
</member>
|
<member name="M:CefSharp.DependencyChecker.CheckDependencyList(System.String,System.Collections.Generic.IEnumerable{System.String})">
|
<summary>
|
Loop through dependencies and add to the returned missing dependency list if not found.
|
</summary>
|
<param name="dir">The directory of the dependencies, or the current directory if null.</param>
|
<param name="files">The dependencies to check.</param>
|
<returns>List of missing dependencies, if all present an empty List will be returned</returns>
|
</member>
|
<member name="M:CefSharp.DependencyChecker.AssertAllDependenciesPresent(System.String,System.String,System.String,System.Boolean,System.String)">
|
<summary>
|
Checks if all Cef and CefSharp dependencies were found relative to the Executing Assembly.
|
Shortcut method that calls <see cref="M:CefSharp.DependencyChecker.CheckDependencies(System.Boolean,System.Boolean,System.String,System.String,System.String,System.String,System.String)"/>, throws an Exception if not files are missing.
|
</summary>
|
<param name="locale">The locale, if empty then en-US will be used.</param>
|
<param name="localesDirPath">The path to the locales directory, if empty locales\ will be used.</param>
|
<param name="resourcesDirPath">The path to the resources directory, if empty the Executing Assembly path is used.</param>
|
<param name="packLoadingDisabled">Is loading of pack files disabled?</param>
|
<param name="browserSubProcessPath">The path to a separate executable that will be launched for sub-processes.</param>
|
<exception cref="T:System.Exception">Throw when not all dependencies are present</exception>
|
</member>
|
<member name="T:CefSharp.DomNode">
|
<summary>
|
Represents a node in the browser's DOM.
|
</summary>
|
</member>
|
<member name="M:CefSharp.DomNode.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.String})">
|
<summary>
|
Constructor.
|
</summary>
|
<param name="tagName">Name of the tag.</param>
|
<param name="attributes">The attributes.</param>
|
</member>
|
<member name="M:CefSharp.DomNode.ToString">
|
<summary>
|
Returns a string that represents the current object.
|
</summary>
|
<returns>
|
A string that represents the current object.
|
</returns>
|
</member>
|
<member name="P:CefSharp.DomNode.Item(System.String)">
|
<summary>
|
Get the value of an attribute.
|
</summary>
|
<param name="name">The name of the attribute value to get.</param>
|
<returns>
|
The attribute value if the name exists in the DomNode's attributes. Null if the name does not exist.
|
</returns>
|
</member>
|
<member name="P:CefSharp.DomNode.TagName">
|
<summary>
|
The name of the HTML element.
|
</summary>
|
<value>
|
The name of the tag.
|
</value>
|
</member>
|
<member name="P:CefSharp.DomNode.AttributeNames">
|
<summary>
|
Get a read only list of the attribute names.
|
</summary>
|
<value>
|
A list of names of the attributes.
|
</value>
|
</member>
|
<member name="M:CefSharp.DomNode.HasAttribute(System.String)">
|
<summary>
|
Determine if the DomNode has the requested attribute.
|
</summary>
|
<param name="attributeName">The name of the attribute value.</param>
|
<returns>
|
True if the attribute exists in the DomNode, false if it does not.
|
</returns>
|
</member>
|
<member name="M:CefSharp.DomNode.GetEnumerator">
|
<summary>
|
Gets the enumerator.
|
</summary>
|
<returns>
|
The enumerator.
|
</returns>
|
</member>
|
<member name="T:CefSharp.DownloadItem">
|
<summary>
|
Class used to represent a download item.
|
</summary>
|
</member>
|
<member name="P:CefSharp.DownloadItem.IsValid">
|
<summary>
|
Returns true if this object is valid. Do not call any other methods if this function returns false.
|
</summary>
|
</member>
|
<member name="P:CefSharp.DownloadItem.IsInProgress">
|
<summary>
|
Returns true if the download is in progress.
|
</summary>
|
</member>
|
<member name="P:CefSharp.DownloadItem.IsComplete">
|
<summary>
|
Returns true if the download is complete.
|
</summary>
|
</member>
|
<member name="P:CefSharp.DownloadItem.IsCancelled">
|
<summary>
|
Returns true if the download has been canceled or interrupted.
|
</summary>
|
</member>
|
<member name="P:CefSharp.DownloadItem.CurrentSpeed">
|
<summary>
|
Returns a simple speed estimate in bytes/s.
|
</summary>
|
</member>
|
<member name="P:CefSharp.DownloadItem.PercentComplete">
|
<summary>
|
Returns the rough percent complete or -1 if the receive total size is unknown.
|
</summary>
|
</member>
|
<member name="P:CefSharp.DownloadItem.TotalBytes">
|
<summary>
|
Returns the total number of bytes.
|
</summary>
|
</member>
|
<member name="P:CefSharp.DownloadItem.ReceivedBytes">
|
<summary>
|
Returns the number of received bytes.
|
</summary>
|
</member>
|
<member name="P:CefSharp.DownloadItem.StartTime">
|
<summary>
|
Returns the time that the download started
|
</summary>
|
</member>
|
<member name="P:CefSharp.DownloadItem.EndTime">
|
<summary>
|
Returns the time that the download ended
|
</summary>
|
</member>
|
<member name="P:CefSharp.DownloadItem.FullPath">
|
<summary>
|
Returns the full path to the downloaded or downloading file.
|
</summary>
|
</member>
|
<member name="P:CefSharp.DownloadItem.Id">
|
<summary>
|
Returns the unique identifier for this download.
|
</summary>
|
</member>
|
<member name="P:CefSharp.DownloadItem.Url">
|
<summary>
|
Returns the URL.
|
</summary>
|
</member>
|
<member name="P:CefSharp.DownloadItem.OriginalUrl">
|
<summary>
|
Returns the URL as it was before any redirects.
|
</summary>
|
</member>
|
<member name="P:CefSharp.DownloadItem.SuggestedFileName">
|
<summary>
|
Returns the suggested file name.
|
</summary>
|
</member>
|
<member name="P:CefSharp.DownloadItem.ContentDisposition">
|
<summary>
|
Returns the content disposition.
|
</summary>
|
</member>
|
<member name="P:CefSharp.DownloadItem.MimeType">
|
<summary>
|
Returns the mime type.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Enums.AlphaType">
|
<summary>
|
Describes how to interpret the alpha component of a pixel.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.AlphaType.Opaque">
|
<summary>
|
No transparency. The alpha component is ignored.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.AlphaType.PreMultiplied">
|
<summary>
|
Transparency with pre-multiplied alpha component.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.AlphaType.PostMultiplied">
|
<summary>
|
Transparency with post-multiplied alpha component.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Enums.ChannelLayout">
|
<summary>
|
Enumerates the various representations of the ordering of audio channels.
|
Logged to UMA, so never reuse a value, always add new/greater ones!
|
See media\base\channel_layout.h
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.LayoutNone">
|
<summary>
|
None
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.LayoutUnsupported">
|
<summary>
|
Unsupported
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.LayoutMono">
|
<summary>
|
Front C
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.LayoutStereo">
|
<summary>
|
Front L, Front R
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout2_1">
|
<summary>
|
Front L, Front R, Back C
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.LayoutSurround">
|
<summary>
|
Front L, Front R, Front C
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout4_0">
|
<summary>
|
Front L, Front R, Front C, Back C
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout2_2">
|
<summary>
|
Front L, Front R, Side L, Side R
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.LayoutQuad">
|
<summary>
|
Front L, Front R, Back L, Back R
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout5_0">
|
<summary>
|
Front L, Front R, Front C, Side L, Side R
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout5_1">
|
<summary>
|
Front L, Front R, Front C, LFE, Side L, Side R
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout5_0Back">
|
<summary>
|
Front L, Front R, Front C, Back L, Back R
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout5_1Back">
|
<summary>
|
Front L, Front R, Front C, LFE, Back L, Back R
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout7_0">
|
<summary>
|
Front L, Front R, Front C, Side L, Side R, Back L, Back R
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout7_1">
|
<summary>
|
Front L, Front R, Front C, LFE, Side L, Side R, Back L, Back R
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout7_1Wide">
|
<summary>
|
Front L, Front R, Front C, LFE, Side L, Side R, Front LofC, Front RofC
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.LayoutStereoDownMix">
|
<summary>
|
Stereo L, Stereo R
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout2Point1">
|
<summary>
|
Stereo L, Stereo R, LFE
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout3_1">
|
<summary>
|
Stereo L, Stereo R, Front C, LFE
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout4_1">
|
<summary>
|
Stereo L, Stereo R, Front C, Rear C, LFE
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout6_0">
|
<summary>
|
Stereo L, Stereo R, Front C, Side L, Side R, Back C
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout6_0Front">
|
<summary>
|
Stereo L, Stereo R, Side L, Side R, Front LofC, Front RofC
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.LayoutHexagonal">
|
<summary>
|
Stereo L, Stereo R, Front C, Rear L, Rear R, Rear C
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout6_1">
|
<summary>
|
Stereo L, Stereo R, Front C, LFE, Side L, Side R, Rear Center
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout6_1Back">
|
<summary>
|
Stereo L, Stereo R, Front C, LFE, Back L, Back R, Rear Center
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout6_1Front">
|
<summary>
|
Stereo L, Stereo R, Side L, Side R, Front LofC, Front RofC, LFE
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout7_0Front">
|
<summary>
|
Front L, Front R, Front C, Side L, Side R, Front LofC, Front RofC
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout7_1WideBack">
|
<summary>
|
Front L, Front R, Front C, LFE, Back L, Back R, Front LofC, Front RofC
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.LayoutOctagonal">
|
<summary>
|
Front L, Front R, Front C, Side L, Side R, Rear L, Back R, Back C.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.LayoutDiscrete">
|
<summary>
|
Channels are not explicitly mapped to speakers.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.LayoutStereoKeyboardAndMic">
|
<summary>
|
Front L, Front R, Front C. Front C contains the keyboard mic audio. This
|
layout is only intended for input for WebRTC. The Front C channel
|
is stripped away in the WebRTC audio input pipeline and never seen outside
|
of that.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout4_1QuadSize">
|
<summary>
|
Front L, Front R, Side L, Side R, LFE
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.LayoutBitstream">
|
<summary>
|
Actual channel layout is specified in the bitstream and the actual channel
|
count is unknown at Chromium media pipeline level (useful for audio
|
pass-through mode).
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ChannelLayout.Layout5_1_4DownMix">
|
<summary>
|
Front L, Front R, Front C, LFE, Side L, Side R,
|
Front Height L, Front Height R, Rear Height L, Rear Height R
|
Will be represented as six channels (5.1) due to eight channel limit
|
kMaxConcurrentChannels
|
</summary>
|
</member>
|
<member name="T:CefSharp.Enums.ColorType">
|
<summary>
|
Describes how to interpret the components of a pixel.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ColorType.Rgba8888">
|
<summary>
|
RGBA with 8 bits per pixel (32bits total).
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ColorType.Bgra8888">
|
<summary>
|
BGRA with 8 bits per pixel (32bits total).
|
</summary>
|
</member>
|
<member name="T:CefSharp.Enums.CompositionUnderlineStyle">
|
<summary>
|
Composition underline style.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CompositionUnderlineStyle.Solid">
|
<summary>
|
Solid
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CompositionUnderlineStyle.Dot">
|
<summary>
|
Dot
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CompositionUnderlineStyle.Dash">
|
<summary>
|
Dash
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CompositionUnderlineStyle.None">
|
<summary>
|
None
|
</summary>
|
</member>
|
<member name="T:CefSharp.Enums.CookiePriority">
|
<summary>
|
Cookie priority values.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CookiePriority.Low">
|
<summary>
|
Low Priority
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CookiePriority.Medium">
|
<summary>
|
Medium Priority
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CookiePriority.High">
|
<summary>
|
High Priority
|
</summary>
|
</member>
|
<member name="T:CefSharp.Enums.CookieSameSite">
|
<summary>
|
Cookie same site values.
|
</summary>
|
<remarks>
|
See https://source.chromium.org/chromium/chromium/src/+/master:net/cookies/cookie_constants.h
|
</remarks>
|
</member>
|
<member name="F:CefSharp.Enums.CookieSameSite.Unspecified">
|
<summary>
|
Unspecified
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CookieSameSite.NoRestriction">
|
<summary>
|
Cookies will be sent in all contexts, i.e sending cross-origin is allowed.
|
None used to be the default value, but recent browser versions made Lax the default value to have reasonably robust defense against some classes of cross-site request forgery (CSRF) attacks.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CookieSameSite.LaxMode">
|
<summary>
|
Cookies are allowed to be sent with top-level navigations and will be sent along with GET request initiated by third party website. This is the default value in modern browsers.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CookieSameSite.StrictMode">
|
<summary>
|
Cookies will only be sent in a first-party context and not be sent along with requests initiated by third party websites.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Enums.CursorType">
|
<summary>
|
Cursor type values.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.Pointer">
|
<summary>
|
Pointer
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.Cross">
|
<summary>
|
An enum constant representing the cross option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.Hand">
|
<summary>
|
An enum constant representing the hand option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.IBeam">
|
<summary>
|
An enum constant representing the beam option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.Wait">
|
<summary>
|
An enum constant representing the wait option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.Help">
|
<summary>
|
An enum constant representing the help option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.EastResize">
|
<summary>
|
An enum constant representing the east resize option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.NorthResize">
|
<summary>
|
An enum constant representing the north resize option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.NortheastResize">
|
<summary>
|
An enum constant representing the northeast resize option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.NorthwestResize">
|
<summary>
|
An enum constant representing the northwest resize option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.SouthResize">
|
<summary>
|
An enum constant representing the south resize option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.SoutheastResize">
|
<summary>
|
An enum constant representing the southeast resize option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.SouthwestResize">
|
<summary>
|
An enum constant representing the southwest resize option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.WestResize">
|
<summary>
|
An enum constant representing the west resize option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.NorthSouthResize">
|
<summary>
|
An enum constant representing the north south resize option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.EastWestResize">
|
<summary>
|
An enum constant representing the east west resize option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.NortheastSouthwestResize">
|
<summary>
|
An enum constant representing the northeast southwest resize option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.NorthwestSoutheastResize">
|
<summary>
|
An enum constant representing the northwest southeast resize option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.ColumnResize">
|
<summary>
|
An enum constant representing the column resize option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.RowResize">
|
<summary>
|
An enum constant representing the row resize option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.MiddlePanning">
|
<summary>
|
An enum constant representing the middle panning option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.EastPanning">
|
<summary>
|
An enum constant representing the east panning option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.NorthPanning">
|
<summary>
|
An enum constant representing the north panning option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.NortheastPanning">
|
<summary>
|
An enum constant representing the northeast panning option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.NorthwestPanning">
|
<summary>
|
An enum constant representing the northwest panning option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.SouthPanning">
|
<summary>
|
An enum constant representing the south panning option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.SoutheastPanning">
|
<summary>
|
An enum constant representing the southeast panning option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.SouthwestPanning">
|
<summary>
|
An enum constant representing the southwest panning option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.WestPanning">
|
<summary>
|
An enum constant representing the west panning option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.Move">
|
<summary>
|
An enum constant representing the move option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.VerticalText">
|
<summary>
|
An enum constant representing the vertical text option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.Cell">
|
<summary>
|
An enum constant representing the cell option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.ContextMenu">
|
<summary>
|
An enum constant representing the context menu option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.Alias">
|
<summary>
|
An enum constant representing the alias option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.Progress">
|
<summary>
|
An enum constant representing the progress option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.NoDrop">
|
<summary>
|
An enum constant representing the no drop option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.Copy">
|
<summary>
|
An enum constant representing the copy option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.None">
|
<summary>
|
An enum constant representing the none option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.NotAllowed">
|
<summary>
|
An enum constant representing the not allowed option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.ZoomIn">
|
<summary>
|
An enum constant representing the zoom in option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.ZoomOut">
|
<summary>
|
An enum constant representing the zoom out option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.Grab">
|
<summary>
|
An enum constant representing the grab option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.Grabbing">
|
<summary>
|
An enum constant representing the grabbing option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.MiddlePanningVertical">
|
<summary>
|
An enum constant representing the MiddlePanningVertical option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.MiddlePanningHorizontal">
|
<summary>
|
An enum constant representing the MiddlePanningHorizontal option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.Custom">
|
<summary>
|
An enum constant representing the custom option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.DndNone">
|
<summary>
|
DndNone
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.DndMove">
|
<summary>
|
DndMove
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.DndCopy">
|
<summary>
|
DndCopy
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.CursorType.DndLink">
|
<summary>
|
DndLink
|
</summary>
|
</member>
|
<member name="T:CefSharp.Enums.DragOperationsMask">
|
<summary>
|
"Verb" of a drag-and-drop operation as negotiated between the source and destination.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.DragOperationsMask.None">
|
<summary>
|
None
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.DragOperationsMask.Copy">
|
<summary>
|
Copy
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.DragOperationsMask.Link">
|
<summary>
|
Link
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.DragOperationsMask.Generic">
|
<summary>
|
Generic
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.DragOperationsMask.Private">
|
<summary>
|
Private
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.DragOperationsMask.Move">
|
<summary>
|
Move
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.DragOperationsMask.Delete">
|
<summary>
|
Delete
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.DragOperationsMask.Every">
|
<summary>
|
Every drag operation.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Enums.PointerType">
|
<summary>
|
The device type that caused the event.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.PointerType.Touch">
|
<summary>
|
An enum constant representing the touch option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.PointerType.Mouse">
|
<summary>
|
An enum constant representing the mouse option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.PointerType.Pen">
|
<summary>
|
An enum constant representing the pen option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.PointerType.Eraser">
|
<summary>
|
An enum constant representing the eraser option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.PointerType.Unknown">
|
<summary>
|
An enum constant representing the unknown option.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Enums.SchemeOptions">
|
<summary>
|
Configuration options for registering a custom scheme.
|
These values are used when calling AddCustomScheme.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.SchemeOptions.None">
|
<summary>
|
Register scheme without options set
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.SchemeOptions.Standard">
|
<summary>
|
If Standard is set the scheme will be treated as a
|
standard scheme. Standard schemes are subject to URL canonicalization and
|
parsing rules as defined in the Common Internet Scheme Syntax RFC 1738
|
Section 3.1 available at http://www.ietf.org/rfc/rfc1738.txt
|
|
In particular, the syntax for standard scheme URLs must be of the form:
|
<pre>
|
[scheme]://[username]:[password]@[host]:[port]/[url-path]
|
</pre> Standard scheme URLs must have a host component that is a fully
|
qualified domain name as defined in Section 3.5 of RFC 1034 [13] and
|
Section 2.1 of RFC 1123. These URLs will be canonicalized to
|
"scheme://host/path" in the simplest case and
|
"scheme://username:password@host:port/path" in the most explicit case. For
|
example, "scheme:host/path" and "scheme:///host/path" will both be
|
canonicalized to "scheme://host/path". The origin of a standard scheme URL
|
is the combination of scheme, host and port (i.e., "scheme://host:port" in
|
the most explicit case).
|
|
For non-standard scheme URLs only the "scheme:" component is parsed and
|
canonicalized. The remainder of the URL will be passed to the handler as-
|
is. For example, "scheme:///some%20text" will remain the same. Non-standard
|
scheme URLs cannot be used as a target for form submission.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.SchemeOptions.Local">
|
<summary>
|
If Local is set the scheme will be treated with the same
|
security rules as those applied to "file" URLs. Normal pages cannot link to
|
or access local URLs. Also, by default, local URLs can only perform
|
XMLHttpRequest calls to the same URL (origin + path) that originated the
|
request. To allow XMLHttpRequest calls from a local URL to other URLs with
|
the same origin set the CefSettings.FileAccessFromFileUrlsAllowed
|
value to true. To allow XMLHttpRequest calls from a local URL to all
|
origins set the CefSettings.UniversalAccessFromFileUrlsAllowed value
|
to true.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.SchemeOptions.DisplayIsolated">
|
<summary>
|
If DisplayIsolated is set the scheme can only be
|
displayed from other content hosted with the same scheme. For example,
|
pages in other origins cannot create iframes or hyperlinks to URLs with the
|
scheme. For schemes that must be accessible from other schemes don't set
|
this, set CorsEnabled, and use CORS "Access-Control-Allow-Origin" headers
|
to further restrict access.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.SchemeOptions.Secure">
|
<summary>
|
If Secure is set the scheme will be treated with the same
|
security rules as those applied to "https" URLs. For example, loading this
|
scheme from other secure schemes will not trigger mixed content warnings.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.SchemeOptions.CorsEnabled">
|
<summary>
|
If CorsEnabled is set the scheme can be sent CORS requests.
|
This value should be set in most cases where Standard is set.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.SchemeOptions.CspBypassing">
|
<summary>
|
If CspBypassing is set the scheme can bypass Content-Security-Policy (CSP) checks.
|
This value should not be set in most cases where Standard is set.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.SchemeOptions.FetchEnabled">
|
<summary>
|
If FetchEnabled is set the scheme can perform Fetch API requests.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Enums.TextInputMode">
|
<summary>
|
Input mode of a virtual keyboard. These constants match their equivalents
|
in Chromium's text_input_mode.h and should not be renumbered.
|
See https://html.spec.whatwg.org/#input-modalities:-the-inputmode-attribute
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.TextInputMode.Default">
|
<summary>
|
An enum constant representing the default option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.TextInputMode.None">
|
<summary>
|
An enum constant representing the none option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.TextInputMode.Text">
|
<summary>
|
An enum constant representing the text option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.TextInputMode.Tel">
|
<summary>
|
An enum constant representing the tel option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.TextInputMode.Url">
|
<summary>
|
An enum constant representing the URL option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.TextInputMode.EMail">
|
<summary>
|
An enum constant representing the mail option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.TextInputMode.Numeric">
|
<summary>
|
An enum constant representing the numeric option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.TextInputMode.Decimal">
|
<summary>
|
An enum constant representing the decimal option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.TextInputMode.Search">
|
<summary>
|
An enum constant representing the search option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.TextInputMode.Max">
|
<summary>
|
An enum constant representing the Maximum option.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Enums.TouchEventType">
|
<summary>
|
Touch Event Type
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.TouchEventType.Released">
|
<summary>
|
An enum constant representing the released option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.TouchEventType.Pressed">
|
<summary>
|
An enum constant representing the pressed option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.TouchEventType.Moved">
|
<summary>
|
An enum constant representing the moved option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.TouchEventType.Cancelled">
|
<summary>
|
An enum constant representing the cancelled option.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Enums.ValueType">
|
<summary>
|
Value types supported by <see cref="T:CefSharp.IValue"/>
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ValueType.Invalid">
|
<summary>
|
Invalid type
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ValueType.Null">
|
<summary>
|
Null
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ValueType.Bool">
|
<summary>
|
Boolean
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ValueType.Int">
|
<summary>
|
Integer
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ValueType.Double">
|
<summary>
|
Double
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ValueType.String">
|
<summary>
|
String
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ValueType.Binary">
|
<summary>
|
Binary
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ValueType.Dictionary">
|
<summary>
|
Dictionary
|
</summary>
|
</member>
|
<member name="F:CefSharp.Enums.ValueType.List">
|
<summary>
|
List
|
</summary>
|
</member>
|
<member name="T:CefSharp.CefErrorCode">
|
<summary>
|
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).
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.None">
|
<summary>
|
No error occurred.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.IoPending">
|
<summary>
|
An asynchronous IO operation is not yet complete. This usually does not
|
indicate a fatal error. Typically this error will be generated as a
|
notification to wait for some external notification that the IO operation
|
finally completed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Failed">
|
<summary>
|
A generic failure occurred.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Aborted">
|
<summary>
|
An operation was aborted (due to user action).
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.InvalidArgument">
|
<summary>
|
An argument to the function is incorrect.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.InvalidHandle">
|
<summary>
|
The handle or file descriptor is invalid.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.FileNotFound">
|
<summary>
|
The file or directory cannot be found.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.TimedOut">
|
<summary>
|
An operation timed out.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.FileTooBig">
|
<summary>
|
The file is too large.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Unexpected">
|
<summary>
|
An unexpected error. This may be caused by a programming mistake or an
|
invalid assumption.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.AccessDenied">
|
<summary>
|
Permission to access a resource, other than the network, was denied.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.NotImplemented">
|
<summary>
|
The operation failed because of unimplemented functionality.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.InsufficientResources">
|
<summary>
|
There were not enough resources to complete the operation.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.OutOfMemory">
|
<summary>
|
Memory allocation failed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.UploadFileChanged">
|
<summary>
|
The file upload failed because the file's modification time was different
|
from the expectation.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SocketNotConnected">
|
<summary>
|
The socket is not connected.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.FileExists">
|
<summary>
|
The file already exists.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.FilePathTooLong">
|
<summary>
|
The path or file name is too long.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.FileNoSpace">
|
<summary>
|
Not enough room left on the disk.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.FileVirusInfected">
|
<summary>
|
The file has a virus.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.BlockedByClient">
|
<summary>
|
The client chose to block the request.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.NetworkChanged">
|
<summary>
|
The network changed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.BlockedByAdministrator">
|
<summary>
|
The request was blocked by the URL block list configured by the domain
|
administrator.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SocketIsConnected">
|
<summary>
|
The socket is already connected.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.UploadStreamRewindNotSupported">
|
<summary>
|
The upload failed because the upload stream needed to be re-read, due to a
|
retry or a redirect, but the upload stream doesn't support that operation.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ContextShutDown">
|
<summary>
|
The request failed because the URLRequestContext is shutting down, or has
|
been shut down.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.BlockedByResponse">
|
<summary>
|
The request failed because the response was delivered along with requirements
|
which are not met ('X-Frame-Options' and 'Content-Security-Policy' ancestor
|
checks and 'Cross-Origin-Resource-Policy' for instance).
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CleartextNotPermitted">
|
<summary>
|
The request was blocked by system policy disallowing some or all cleartext
|
requests. Used for NetworkSecurityPolicy on Android.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.BlockedByCsp">
|
<summary>
|
The request was blocked by a Content Security Policy
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.H2OrQuicRequired">
|
<summary>
|
The request was blocked because of no H/2 or QUIC session.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.BlockedByOrb">
|
<summary>
|
The request was blocked by CORB or ORB.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ConnectionClosed">
|
<summary>
|
A connection was closed (corresponding to a TCP FIN).
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ConnectionReset">
|
<summary>
|
A connection was reset (corresponding to a TCP RST).
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ConnectionRefused">
|
<summary>
|
A connection attempt was refused.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ConnectionAborted">
|
<summary>
|
A connection timed out as a result of not receiving an ACK for data sent.
|
This can include a FIN packet that did not get ACK'd.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ConnectionFailed">
|
<summary>
|
A connection attempt failed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.NameNotResolved">
|
<summary>
|
The host name could not be resolved.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.InternetDisconnected">
|
<summary>
|
The Internet connection has been lost.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslProtocolError">
|
<summary>
|
An SSL protocol error occurred.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.AddressInvalid">
|
<summary>
|
The IP address or port number is invalid (e.g., cannot connect to the IP
|
address 0 or the port 0).
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.AddressUnreachable">
|
<summary>
|
The IP address is unreachable. This usually means that there is no route to
|
the specified host or network.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslClientAuthCertNeeded">
|
<summary>
|
The server requested a client certificate for SSL client authentication.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.TunnelConnectionFailed">
|
<summary>
|
A tunnel connection through the proxy could not be established.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.NoSslVersionsEnabled">
|
<summary>
|
No SSL protocol versions are enabled.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslVersionOrCipherMismatch">
|
<summary>
|
The client and server don't support a common SSL protocol version or
|
cipher suite.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslRenegotiationRequested">
|
<summary>
|
The server requested a renegotiation (rehandshake).
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ProxyAuthUnsupported">
|
<summary>
|
The proxy requested authentication (for tunnel establishment) with an
|
unsupported method.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.BadSslClientAuthCert">
|
<summary>
|
The SSL handshake failed because of a bad or missing client certificate.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ConnectionTimedOut">
|
<summary>
|
A connection attempt timed out.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.HostResolverQueueTooLarge">
|
<summary>
|
There are too many pending DNS resolves, so a request in the queue was
|
aborted.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SocksConnectionFailed">
|
<summary>
|
Failed establishing a connection to the SOCKS proxy server for a target host.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SocksConnectionHostUnreachable">
|
<summary>
|
The SOCKS proxy server failed establishing connection to the target host
|
because that host is unreachable.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.AlpnNegotiationFailed">
|
<summary>
|
The request to negotiate an alternate protocol failed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslNoRenegotiation">
|
<summary>
|
The peer sent an SSL no_renegotiation alert message.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.WinsockUnexpectedWrittenBytes">
|
<summary>
|
Winsock sometimes reports more data written than passed. This is probably
|
due to a broken LSP.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslDecompressionFailureAlert">
|
<summary>
|
An SSL peer sent us a fatal decompression_failure alert. This typically
|
occurs when a peer selects DEFLATE compression in the mistaken belief that
|
it supports it.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslBadRecordMacAlert">
|
<summary>
|
An SSL peer sent us a fatal bad_record_mac alert. This has been observed
|
from servers with buggy DEFLATE support.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ProxyAuthRequested">
|
<summary>
|
The proxy requested authentication (for tunnel establishment).
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ProxyConnectionFailed">
|
<summary>
|
Could not create a connection to the proxy server. An error occurred
|
either in resolving its name, or in connecting a socket to it.
|
Note that this does NOT include failures during the actual "CONNECT" method
|
of an HTTP proxy.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.MandatoryProxyConfigurationFailed">
|
<summary>
|
A mandatory proxy configuration could not be used. Currently this means
|
that a mandatory PAC script could not be fetched, parsed or executed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.PreconnectMaxSocketLimit">
|
<summary>
|
We've hit the max socket limit for the socket pool while preconnecting. We
|
don't bother trying to preconnect more sockets.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslClientAuthPrivateKeyAccessDenied">
|
<summary>
|
The permission to use the SSL client certificate's private key was denied.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslClientAuthCertNoPrivateKey">
|
<summary>
|
The SSL client certificate has no private key.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ProxyCertificateInvalid">
|
<summary>
|
The certificate presented by the HTTPS Proxy was invalid.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.NameResolutionFailed">
|
<summary>
|
An error occurred when trying to do a name resolution (DNS).
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.NetworkAccessDenied">
|
<summary>
|
Permission to access the network was denied. This is used to distinguish
|
errors that were most likely caused by a firewall from other access denied
|
errors. See also ERR_ACCESS_DENIED.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.TemporarilyThrottled">
|
<summary>
|
The request throttler module cancelled this request to avoid DDOS.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.HttpsProxyTunnelResponseRedirect">
|
<summary>
|
A request to create an SSL tunnel connection through the HTTPS proxy
|
received a 302 (temporary redirect) response. The response body might
|
include a description of why the request failed.
|
|
TODO(https://crbug.com/928551): This is deprecated and should not be used by
|
new code.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslClientAuthSignatureFailed">
|
<summary>
|
We were unable to sign the CertificateVerify data of an SSL client auth
|
handshake with the client certificate's private key.
|
|
Possible causes for this include the user implicitly or explicitly
|
denying access to the private key, the private key may not be valid for
|
signing, the key may be relying on a cached handle which is no longer
|
valid, or the CSP won't allow arbitrary data to be signed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.MsgTooBig">
|
<summary>
|
The message was too large for the transport. (for example a UDP message
|
which exceeds size threshold).
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.WsProtocolError">
|
<summary>
|
Websocket protocol error. Indicates that we are terminating the connection
|
due to a malformed frame or other protocol violation.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.AddressInUse">
|
<summary>
|
Returned when attempting to bind an address that is already in use.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslHandshakeNotCompleted">
|
<summary>
|
An operation failed because the SSL handshake has not completed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslBadPeerPublicKey">
|
<summary>
|
SSL peer's public key is invalid.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslPinnedKeyNotInCertChain">
|
<summary>
|
The certificate didn't match the built-in public key pins for the host name.
|
The pins are set in net/http/transport_security_state.cc and require that
|
one of a set of public keys exist on the path from the leaf to the root.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ClientAuthCertTypeUnsupported">
|
<summary>
|
Server request for client certificate did not contain any types we support.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslDecryptErrorAlert">
|
<summary>
|
An SSL peer sent us a fatal decrypt_error alert. This typically occurs when
|
a peer could not correctly verify a signature (in CertificateVerify or
|
ServerKeyExchange) or validate a Finished message.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.WsThrottleQueueTooLarge">
|
<summary>
|
There are too many pending WebSocketJob instances, so the new job was not
|
pushed to the queue.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslServerCertChanged">
|
<summary>
|
The SSL server certificate changed in a renegotiation.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslUnrecognizedNameAlert">
|
<summary>
|
The SSL server sent us a fatal unrecognized_name alert.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SocketSetReceiveBufferSizeError">
|
<summary>
|
Failed to set the socket's receive buffer size as requested.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SocketSetSendBufferSizeError">
|
<summary>
|
Failed to set the socket's send buffer size as requested.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SocketReceiveBufferSizeUnchangeable">
|
<summary>
|
Failed to set the socket's receive buffer size as requested, despite success
|
return code from setsockopt.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SocketSendBufferSizeUnchangeable">
|
<summary>
|
Failed to set the socket's send buffer size as requested, despite success
|
return code from setsockopt.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslClientAuthCertBadFormat">
|
<summary>
|
Failed to import a client certificate from the platform store into the SSL
|
library.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ICANNNameCollision">
|
<summary>
|
Resolving a hostname to an IP address list included the IPv4 address
|
"127.0.53.53". This is a special IP address which ICANN has recommended to
|
indicate there was a name collision, and alert admins to a potential
|
problem.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslServerCertBadFormat">
|
<summary>
|
The SSL server presented a certificate which could not be decoded. This is
|
not a certificate error code as no X509Certificate object is available. This
|
error is fatal.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CtSthParsingFailed">
|
<summary>
|
Certificate Transparency: Received a signed tree head that failed to parse.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CtSthIncomplete">
|
<summary>
|
Certificate Transparency: Received a signed tree head whose JSON parsing was
|
OK but was missing some of the fields.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.UnableToReuseConnectionForProxyAuth">
|
<summary>
|
The attempt to reuse a connection to send proxy auth credentials failed
|
before the AuthController was used to generate credentials. The caller should
|
reuse the controller with a new connection. This error is only used
|
internally by the network stack.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CtConsistencyProofParsingFailed">
|
<summary>
|
Certificate Transparency: Failed to parse the received consistency proof.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslObsoleteCipher">
|
<summary>
|
The SSL server required an unsupported cipher suite that has since been
|
removed. This error will temporarily be signaled on a fallback for one or two
|
releases immediately following a cipher suite's removal, after which the
|
fallback will be removed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.WsUpgrade">
|
<summary>
|
When a WebSocket handshake is done successfully and the connection has been
|
upgraded, the URLRequest is cancelled with this error code.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ReadIfReadyNotImplemented">
|
<summary>
|
Socket ReadIfReady support is not implemented. This error should not be user
|
visible, because the normal Read() method is used as a fallback.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.NoBufferSpace">
|
<summary>
|
No socket buffer space is available.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslClientAuthNoCommonAlgorithms">
|
<summary>
|
There were no common signature algorithms between our client certificate
|
private key and the server's preferences.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.EarlyDataRejected">
|
<summary>
|
TLS 1.3 early data was rejected by the server. This will be received before
|
any data is returned from the socket. The request should be retried with
|
early data disabled.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.WrongVersionOnEarlyData">
|
<summary>
|
TLS 1.3 early data was offered, but the server responded with TLS 1.2 or
|
earlier. This is an internal error code to account for a
|
backwards-compatibility issue with early data and TLS 1.2. It will be
|
received before any data is returned from the socket. The request should be
|
retried with early data disabled.
|
|
See https://tools.ietf.org/html/rfc8446#appendix-D.3 for details.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Tls13DowngradeDetected">
|
<summary>
|
TLS 1.3 was enabled, but a lower version was negotiated and the server
|
returned a value indicating it supported TLS 1.3. This is part of a security
|
check in TLS 1.3, but it may also indicate the user is behind a buggy
|
TLS-terminating proxy which implemented TLS 1.2 incorrectly. (See
|
https://crbug.com/boringssl/226.)
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SslKeyUsageIncompatible">
|
<summary>
|
The server's certificate has a keyUsage extension incompatible with the
|
negotiated TLS key exchange method.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.InvalidEchConfigList">
|
<summary>
|
The ECHConfigList fetched over DNS cannot be parsed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.EchNotNegotiated">
|
<summary>
|
ECH was enabled, but the server was unable to decrypt the encrypted
|
ClientHello.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.EchFallbackCertificateInvalid">
|
<summary>
|
ECH was enabled, the server was unable to decrypt the encrypted ClientHello,
|
and additionally did not present a certificate valid for the public name.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CertCommonNameInvalid">
|
<summary>
|
The server responded with a certificate whose common name did not match
|
the host name. This could mean:
|
|
1. An attacker has redirected our traffic to their server and is
|
presenting a certificate for which they know the private key.
|
|
2. The server is misconfigured and responding with the wrong cert.
|
|
3. The user is on a wireless network and is being redirected to the
|
network's login page.
|
|
4. The OS has used a DNS search suffix and the server doesn't have
|
a certificate for the abbreviated name in the address bar.
|
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CertDateInvalid">
|
<summary>
|
The server responded with a certificate that, by our clock, appears to
|
either not yet be valid or to have expired. This could mean:
|
|
1. An attacker is presenting an old certificate for which they have
|
managed to obtain the private key.
|
|
2. The server is misconfigured and is not presenting a valid cert.
|
|
3. Our clock is wrong.
|
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CertAuthorityInvalid">
|
<summary>
|
The server responded with a certificate that is signed by an authority
|
we don't trust. The could mean:
|
|
1. An attacker has substituted the real certificate for a cert that
|
contains their public key and is signed by their cousin.
|
|
2. The server operator has a legitimate certificate from a CA we don't
|
know about, but should trust.
|
|
3. The server is presenting a self-signed certificate, providing no
|
defense against active attackers (but foiling passive attackers).
|
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CertContainsErrors">
|
<summary>
|
The server responded with a certificate that contains errors.
|
This error is not recoverable.
|
|
MSDN describes this error as follows:
|
"The SSL certificate contains errors."
|
NOTE: It's unclear how this differs from ERR_CERT_INVALID. For consistency,
|
use that code instead of this one from now on.
|
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CertNoRevocationMechanism">
|
<summary>
|
The certificate has no mechanism for determining if it is revoked. In
|
effect, this certificate cannot be revoked.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CertUnableToCheckRevocation">
|
<summary>
|
Revocation information for the security certificate for this site is not
|
available. This could mean:
|
|
1. An attacker has compromised the private key in the certificate and is
|
blocking our attempt to find out that the cert was revoked.
|
|
2. The certificate is unrevoked, but the revocation server is busy or
|
unavailable.
|
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CertRevoked">
|
<summary>
|
The server responded with a certificate has been revoked.
|
We have the capability to ignore this error, but it is probably not the
|
thing to do.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CertInvalid">
|
<summary>
|
The server responded with a certificate that is invalid.
|
This error is not recoverable.
|
|
MSDN describes this error as follows:
|
"The SSL certificate is invalid."
|
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CertWeakSignatureAlgorithm">
|
<summary>
|
The server responded with a certificate that is signed using a weak
|
signature algorithm.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CertNonUniqueName">
|
<summary>
|
The host name specified in the certificate is not unique.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CertWeakKey">
|
<summary>
|
The server responded with a certificate that contains a weak key (e.g.
|
a too-small RSA key).
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CertNameConstraintViolation">
|
<summary>
|
The certificate claimed DNS names that are in violation of name constraints.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CertValidityTooLong">
|
<summary>
|
The certificate's validity period is too long.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CertificateTransparencyRequired">
|
<summary>
|
Certificate Transparency was required for this connection, but the server
|
did not provide CT information that complied with the policy.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CertSymantecLegacy">
|
<summary>
|
The certificate chained to a legacy Symantec root that is no longer trusted.
|
https://g.co/chrome/symantecpkicerts
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CertKnownInterceptionBlocked">
|
<summary>
|
The certificate is known to be used for interception by an entity other
|
the device owner.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CertEnd">
|
<summary>
|
The value immediately past the last certificate error code.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.InvalidUrl">
|
<summary>
|
The URL is invalid.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.DisallowedUrlScheme">
|
<summary>
|
The scheme of the URL is disallowed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.UnknownUrlScheme">
|
<summary>
|
The scheme of the URL is unknown.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.InvalidRedirect">
|
<summary>
|
Attempting to load an URL resulted in a redirect to an invalid URL.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.TooManyRedirects">
|
<summary>
|
Attempting to load an URL resulted in too many redirects.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.UnsafeRedirect">
|
<summary>
|
Attempting to load an URL resulted in an unsafe redirect (e.g., a redirect
|
to file:// is considered unsafe).
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.UnsafePort">
|
<summary>
|
Attempting to load an URL with an unsafe port number. These are port
|
numbers that correspond to services, which are not robust to spurious input
|
that may be constructed as a result of an allowed web construct (e.g., HTTP
|
looks a lot like SMTP, so form submission to port 25 is denied).
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.InvalidResponse">
|
<summary>
|
The server's response was invalid.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.InvalidChunkedEncoding">
|
<summary>
|
Error in chunked transfer encoding.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.MethodNotSupported">
|
<summary>
|
The server did not support the request method.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.UnexpectedProxyAuth">
|
<summary>
|
The response was 407 (Proxy Authentication Required), yet we did not send
|
the request to a proxy.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.EmptyResponse">
|
<summary>
|
The server closed the connection without sending any data.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ResponseHeadersTooBig">
|
<summary>
|
The headers section of the response is too large.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.PacScriptFailed">
|
<summary>
|
The evaluation of the PAC script failed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.RequestRangeNotSatisfiable">
|
<summary>
|
The response was 416 (Requested range not satisfiable) and the server cannot
|
satisfy the range requested.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.MalformedIdentity">
|
<summary>
|
The identity used for authentication is invalid.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ContentDecodingFailed">
|
<summary>
|
Content decoding of the response body failed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.NetworkIoSuspended">
|
<summary>
|
An operation could not be completed because all network IO
|
is suspended.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SynReplyNotReceived">
|
<summary>
|
FLIP data received without receiving a SYN_REPLY on the stream.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.EncodingConversionFailed">
|
<summary>
|
Converting the response to target encoding failed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.UnrecognizedFtpDirectoryListingFormat">
|
<summary>
|
The server sent an FTP directory listing in a format we do not understand.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.NoSupportedProxies">
|
<summary>
|
There are no supported proxies in the provided list.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Http2ProtocolError">
|
<summary>
|
There is an HTTP/2 protocol error.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.InvalidAuthCredentials">
|
<summary>
|
Credentials could not be established during HTTP Authentication.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.UnsupportedAuthScheme">
|
<summary>
|
An HTTP Authentication scheme was tried which is not supported on this
|
machine.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.EncodingDetectionFailed">
|
<summary>
|
Detecting the encoding of the response failed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.MissingAuthCredentials">
|
<summary>
|
(GSSAPI) No Kerberos credentials were available during HTTP Authentication.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.UnexpectedSecurityLibraryStatus">
|
<summary>
|
An unexpected, but documented, SSPI or GSSAPI status code was returned.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.MisconfiguredAuthEnvironment">
|
<summary>
|
The environment was not set up correctly for authentication (for
|
example, no KDC could be found or the principal is unknown.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.UndocumentedSecurityLibraryStatus">
|
<summary>
|
An undocumented SSPI or GSSAPI status code was returned.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ResponseBodyTooBigToDrain">
|
<summary>
|
The HTTP response was too big to drain.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ResponseHeadersMultipleContentLength">
|
<summary>
|
The HTTP response contained multiple distinct Content-Length headers.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.IncompleteHttp2Headers">
|
<summary>
|
HTTP/2 headers have been received, but not all of them - status or version
|
headers are missing, so we're expecting additional frames to complete them.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.PacNotInDhcp">
|
<summary>
|
No PAC URL configuration could be retrieved from DHCP. This can indicate
|
either a failure to retrieve the DHCP configuration, or that there was no
|
PAC URL configured in DHCP.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ResponseHeadersMultipleContentDisposition">
|
<summary>
|
The HTTP response contained multiple Content-Disposition headers.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ResponseHeadersMultipleLocation">
|
<summary>
|
The HTTP response contained multiple Location headers.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Http2ServerRefusedStream">
|
<summary>
|
HTTP/2 server refused the request without processing, and sent either a
|
GOAWAY frame with error code NO_ERROR and Last-Stream-ID lower than the
|
stream id corresponding to the request indicating that this request has not
|
been processed yet, or a RST_STREAM frame with error code REFUSED_STREAM.
|
Client MAY retry (on a different connection). See RFC7540 Section 8.1.4.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Http2PingFailed">
|
<summary>
|
HTTP/2 server didn't respond to the PING message.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ContentLengthMismatch">
|
<summary>
|
The HTTP response body transferred fewer bytes than were advertised by the
|
Content-Length header when the connection is closed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.IncompleteChunkedEncoding">
|
<summary>
|
The HTTP response body is transferred with Chunked-Encoding, but the
|
terminating zero-length chunk was never sent when the connection is closed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.QuicProtocolError">
|
<summary>
|
There is a QUIC protocol error.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ResponseHeadersTruncated">
|
<summary>
|
The HTTP headers were truncated by an EOF.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.QuicHandshakeFailed">
|
<summary>
|
The QUIC crypto handshake failed. This means that the server was unable
|
to read any requests sent, so they may be resent.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Http2InadequateTransportSecurity">
|
<summary>
|
Transport security is inadequate for the HTTP/2 version.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Http2FlowControlError">
|
<summary>
|
The peer violated HTTP/2 flow control.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Http2FrameSizeError">
|
<summary>
|
The peer sent an improperly sized HTTP/2 frame.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Http2CompressionError">
|
<summary>
|
Decoding or encoding of compressed HTTP/2 headers failed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ProxyAuthRequestedWithNoConnection">
|
<summary>
|
Proxy Auth Requested without a valid Client Socket Handle.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Http11Required">
|
<summary>
|
HTTP_1_1_REQUIRED error code received on HTTP/2 session.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ProxyHttp11Required">
|
<summary>
|
HTTP_1_1_REQUIRED error code received on HTTP/2 session to proxy.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.PacScriptTerminated">
|
<summary>
|
The PAC script terminated fatally and must be reloaded.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.InvalidHttpResponse">
|
<summary>
|
The server was expected to return an HTTP/1.x response, but did not. Rather
|
than treat it as HTTP/0.9, this error is returned.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ContentDecodingInitFailed">
|
<summary>
|
Initializing content decoding failed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Http2RstStreamNoErrorReceived">
|
<summary>
|
Received HTTP/2 RST_STREAM frame with NO_ERROR error code. This error should
|
be handled internally by HTTP/2 code, and should not make it above the
|
SpdyStream layer.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Http2PushedStreamNotAvailable">
|
<summary>
|
The pushed stream claimed by the request is no longer available.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Http2ClaimedPushedStreamResetByServer">
|
<summary>
|
A pushed stream was claimed and later reset by the server. When this happens,
|
the request should be retried.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.TooManyRetries">
|
<summary>
|
An HTTP transaction was retried too many times due for authentication or
|
invalid certificates. This may be due to a bug in the net stack that would
|
otherwise infinite loop, or if the server or proxy continually requests fresh
|
credentials or presents a fresh invalid certificate.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Http2StreamClosed">
|
<summary>
|
Received an HTTP/2 frame on a closed stream.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Http2ClientRefusedStream">
|
<summary>
|
Client is refusing an HTTP/2 stream.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Http2PushedResponseDoesNotMatch">
|
<summary>
|
A pushed HTTP/2 stream was claimed by a request based on matching URL and
|
request headers, but the pushed response headers do not match the request.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.HttpResponseCodeFailure">
|
<summary>
|
The server returned a non-2xx HTTP response code.
|
|
Not that this error is only used by certain APIs that interpret the HTTP
|
response itself. URLRequest for instance just passes most non-2xx
|
response back as success.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.QuicCertRootNotKnown">
|
<summary>
|
The certificate presented on a QUIC connection does not chain to a known root
|
and the origin connected to is not on a list of domains where unknown roots
|
are allowed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.QuicGoawayRequestCanBeRetried">
|
<summary>
|
A GOAWAY frame has been received indicating that the request has not been
|
processed and is therefore safe to retry on a different connection.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.TooManyAcceptChRestarts">
|
<summary>
|
The ACCEPT_CH restart has been triggered too many times
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.InconsistentIpAddressSpace">
|
<summary>
|
The IP address space of the remote endpoint differed from the previous
|
observed value during the same request. Any cache entry for the affected
|
request should be invalidated.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CachedIpAddressSpaceBlockedByLocalNetworkAccessPolicy">
|
<summary>
|
The IP address space of the cached remote endpoint is blocked by local
|
network access check.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CacheMiss">
|
<summary>
|
The cache does not have the requested entry.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CacheReadFailure">
|
<summary>
|
Unable to read from the disk cache.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CacheWriteFailure">
|
<summary>
|
Unable to write to the disk cache.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CacheOperationNotSupported">
|
<summary>
|
The operation is not supported for this entry.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CacheOpenFailure">
|
<summary>
|
The disk cache is unable to open this entry.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CacheCreateFailure">
|
<summary>
|
The disk cache is unable to create this entry.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CacheRace">
|
<summary>
|
Multiple transactions are racing to create disk cache entries. This is an
|
internal error returned from the HttpCache to the HttpCacheTransaction that
|
tells the transaction to restart the entry-creation logic because the state
|
of the cache has changed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CacheChecksumReadFailure">
|
<summary>
|
The cache was unable to read a checksum record on an entry. This can be
|
returned from attempts to read from the cache. It is an internal error,
|
returned by the SimpleCache backend, but not by any URLRequest methods
|
or members.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CacheChecksumMismatch">
|
<summary>
|
The cache found an entry with an invalid checksum. This can be returned from
|
attempts to read from the cache. It is an internal error, returned by the
|
SimpleCache backend, but not by any URLRequest methods or members.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CacheLockTimeout">
|
<summary>
|
Internal error code for the HTTP cache. The cache lock timeout has fired.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CacheAuthFailureAfterRead">
|
<summary>
|
Received a challenge after the transaction has read some data, and the
|
credentials aren't available. There isn't a way to get them at that point.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CacheEntryNotSuitable">
|
<summary>
|
Internal not-quite error code for the HTTP cache. In-memory hints suggest
|
that the cache entry would not have been usable with the transaction's
|
current configuration (e.g. load flags, mode, etc.)
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CacheDoomFailure">
|
<summary>
|
The disk cache is unable to doom this entry.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CacheOpenOrCreateFailure">
|
<summary>
|
The disk cache is unable to open or create this entry.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.InsecureResponse">
|
<summary>
|
The server's response was insecure (e.g. there was a cert error).
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.NoPrivateKeyForCert">
|
<summary>
|
An attempt to import a client certificate failed, as the user's key
|
database lacked a corresponding private key.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.AddUserCertFailed">
|
<summary>
|
An error adding a certificate to the OS certificate database.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.InvalidSignedExchange">
|
<summary>
|
An error occurred while handling a signed exchange.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.InvalidWebBundle">
|
<summary>
|
An error occurred while handling a Web Bundle source.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.TrustTokenOperationFailed">
|
<summary>
|
A Trust Tokens protocol operation-executing request failed for one of a
|
number of reasons (precondition failure, internal error, bad response).
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.TrustTokenOperationSuccessWithoutSendingRequest">
|
<summary>
|
When handling a Trust Tokens protocol operation-executing request, the system
|
was able to execute the request's Trust Tokens operation without sending the
|
request to its destination: for instance, the results could have been present
|
in a local cache (for redemption) or the operation could have been diverted
|
to a local provider (for "platform-provided" issuance).
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.FtpFailed">
|
<summary>
|
A generic error for failed FTP control connection command.
|
If possible, please use or add a more specific error code.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.FtpServiceUnavailable">
|
<summary>
|
The server cannot fulfill the request at this point. This is a temporary
|
error.
|
FTP response code 421.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.FtpTransferAborted">
|
<summary>
|
The server has aborted the transfer.
|
FTP response code 426.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.FtpFileBusy">
|
<summary>
|
The file is busy, or some other temporary error condition on opening
|
the file.
|
FTP response code 450.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.FtpSyntaxError">
|
<summary>
|
Server rejected our command because of syntax errors.
|
FTP response codes 500, 501.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.FtpCommandNotSupported">
|
<summary>
|
Server does not support the command we issued.
|
FTP response codes 502, 504.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.FtpBadCommandSequence">
|
<summary>
|
Server rejected our command because we didn't issue the commands in right
|
order.
|
FTP response code 503.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Pkcs12ImportBadPassword">
|
<summary>
|
PKCS #12 import failed due to incorrect password.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Pkcs12ImportFailed">
|
<summary>
|
PKCS #12 import failed due to other error.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ImportCaCertNotCa">
|
<summary>
|
CA import failed - not a CA cert.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ImportCertAlreadyExists">
|
<summary>
|
Import failed - certificate already exists in database.
|
Note it's a little weird this is an error but reimporting a PKCS12 is ok
|
(no-op). That's how Mozilla does it, though.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ImportCaCertFailed">
|
<summary>
|
CA import failed due to some other error.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.ImportServerCertFailed">
|
<summary>
|
Server certificate import failed due to some internal error.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Pkcs12ImportInvalidMac">
|
<summary>
|
PKCS #12 import failed due to invalid MAC.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Pkcs12ImportInvalidFile">
|
<summary>
|
PKCS #12 import failed due to invalid/corrupt file.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.Pkcs12ImportUnsupported">
|
<summary>
|
PKCS #12 import failed due to unsupported features.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.KeyGenerationFailed">
|
<summary>
|
Key generation failed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.PrivateKeyExportFailed">
|
<summary>
|
Failure to export private key.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.SelfSignedCertGenerationFailed">
|
<summary>
|
Self-signed certificate generation failed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.CertDatabaseChanged">
|
<summary>
|
The certificate database changed in some way.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.DnsMalformedResponse">
|
<summary>
|
DNS resolver received a malformed response.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.DnsServerRequiresTcp">
|
<summary>
|
DNS server requires TCP
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.DnsServerFailed">
|
<summary>
|
DNS server failed. This error is returned for all of the following
|
error conditions:
|
1 - Format error - The name server was unable to interpret the query.
|
2 - Server failure - The name server was unable to process this query
|
due to a problem with the name server.
|
4 - Not Implemented - The name server does not support the requested
|
kind of query.
|
5 - Refused - The name server refuses to perform the specified
|
operation for policy reasons.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.DnsTimedOut">
|
<summary>
|
DNS transaction timed out.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.DnsCacheMiss">
|
<summary>
|
The entry was not found in cache or other local sources, for lookups where
|
only local sources were queried.
|
TODO(ericorth): Consider renaming to DNS_LOCAL_MISS or something like that as
|
the cache is not necessarily queried either.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.DnsSearchEmpty">
|
<summary>
|
Suffix search list rules prevent resolution of the given host name.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.DnsSortError">
|
<summary>
|
Failed to sort addresses according to RFC3484.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.DnsSecureResolverHostnameResolutionFailed">
|
<summary>
|
Failed to resolve the hostname of a DNS-over-HTTPS server.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.DnsNameHttpsOnly">
|
<summary>
|
DNS identified the request as disallowed for insecure connection (http/ws).
|
Error should be handled as if an HTTP redirect was received to redirect to
|
https or wss.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.DnsRequestCancelled">
|
<summary>
|
All DNS requests associated with this job have been cancelled.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefErrorCode.DnsNoMatchingSupportedAlpn">
|
<summary>
|
The hostname resolution of HTTPS record was expected to be resolved with
|
alpn values of supported protocols, but did not.
|
</summary>
|
</member>
|
<member name="T:CefSharp.CefEventFlags">
|
<summary>
|
Supported event bit flags.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefEventFlags.CommandDown">
|
<summary>
|
Mac OS-X command key.
|
</summary>
|
</member>
|
<member name="T:CefSharp.CefFileDialogMode">
|
<summary>
|
CefFileDialogMode (Based on cef_file_dialog_mode_t)
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefFileDialogMode.Open">
|
<summary>
|
Requires that the file exists before allowing the user to pick it.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefFileDialogMode.OpenMultiple">
|
<summary>
|
Like Open, but allows picking multiple files to open.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefFileDialogMode.OpenFolder">
|
<summary>
|
Like Open, but selects a folder to open.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefFileDialogMode.Save">
|
<summary>
|
Allows picking a nonexistent file, and prompts to overwrite if the file already exists.
|
</summary>
|
</member>
|
<member name="T:CefSharp.CefFocusSource">
|
<summary>
|
Focus Source
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefFocusSource.FocusSourceNavigation">
|
<summary>
|
The source is explicit navigation via the API (LoadURL(), etc).
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefFocusSource.FocusSourceSystem">
|
<summary>
|
The source is a system-generated focus event.
|
</summary>
|
</member>
|
<member name="T:CefSharp.CefJsDialogType">
|
<summary>
|
Supported JavaScript dialog types.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefJsDialogType.Alert">
|
<summary>
|
Alert Dialog
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefJsDialogType.Confirm">
|
<summary>
|
Confirm Dialog
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefJsDialogType.Prompt">
|
<summary>
|
Prompt Dialog
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefMenuCommand.CustomFirst">
|
<summary>
|
Custom menu items originating from the renderer process
|
This is the first entry
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefMenuCommand.CustomLast">
|
<summary>
|
Custom menu items originating from the renderer process
|
This is the last entry
|
</summary>
|
</member>
|
<member name="T:CefSharp.CefPdfPrintMarginType">
|
<summary>
|
Margin type for PDF printing.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefPdfPrintMarginType.Default">
|
<summary>
|
Default margins of 1cm (~0.4 inches)
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefPdfPrintMarginType.None">
|
<summary>
|
No margins.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefPdfPrintMarginType.Custom">
|
<summary>
|
Custom margins.
|
</summary>
|
</member>
|
<member name="T:CefSharp.CefReturnValue">
|
<summary>
|
Return value types.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefReturnValue.Cancel">
|
<summary>
|
Cancel immediately.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefReturnValue.Continue">
|
<summary>
|
Continue immediately.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefReturnValue.ContinueAsync">
|
<summary>
|
Continue asynchronously (usually via a callback).
|
</summary>
|
</member>
|
<member name="T:CefSharp.CefState">
|
<summary>
|
Represents the state of a setting.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefState.Default">
|
<summary>
|
Use the default state for the setting.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefState.Enabled">
|
<summary>
|
Enable or allow the setting.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefState.Disabled">
|
<summary>
|
Disable or disallow the setting.
|
</summary>
|
</member>
|
<member name="T:CefSharp.CefTerminationStatus">
|
<summary>
|
Process termination status values.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefTerminationStatus.AbnormalTermination">
|
<summary>
|
Non-zero exit status.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefTerminationStatus.ProcessWasKilled">
|
<summary>
|
SIGKILL or task manager kill.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefTerminationStatus.ProcessCrashed">
|
<summary>
|
Segmentation fault.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefTerminationStatus.OutOfMemory">
|
<summary>
|
Out of memory. Some platforms may use ProcessCrashed instead.
|
</summary>
|
</member>
|
<member name="T:CefSharp.CefThreadIds">
|
<summary>
|
Managed enum for cef_thread_id_t/CefThreadId
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefThreadIds.TID_UI">
|
<summary>
|
The CEF UI thread in the browser. In CefSharp this is by default
|
different from your main applications UI Thread
|
(e.g. WPF/WinForms UI Threads). Only when MultiThreadedMessageLoop
|
is false will this be the same as your app UI Thread.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefThreadIds.TID_FILE_BACKGROUND">
|
<summary>
|
Used for blocking tasks (e.g. file system access) where the user won't
|
notice if the task takes an arbitrarily long time to complete. All tasks
|
posted after <see cref="M:CefSharp.IBrowserProcessHandler.OnContextInitialized"/>
|
and before Cef.Shutdown() are guaranteed to run.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefThreadIds.TID_FILE_USER_VISIBLE">
|
<summary>
|
Used for blocking tasks (e.g. file system access) that affect UI or
|
responsiveness of future user interactions. Do not use if an immediate
|
response to a user interaction is expected. All tasks posted after
|
<see cref="M:CefSharp.IBrowserProcessHandler.OnContextInitialized"/> and before Cef.Shutdown()
|
are guaranteed to run.
|
Examples:
|
- Updating the UI to reflect progress on a long task.
|
- Loading data that might be shown in the UI after a future user
|
interaction.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefThreadIds.TID_FILE_USER_BLOCKING">
|
<summary>
|
Used for blocking tasks (e.g. file system access) that affect UI
|
immediately after a user interaction. All tasks posted after
|
<see cref="M:CefSharp.IBrowserProcessHandler.OnContextInitialized"/> and before Cef.Shutdown()
|
are guaranteed to run.
|
Example: Generating data shown in the UI immediately after a click.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefThreadIds.TID_PROCESS_LAUNCHER">
|
<summary>
|
Used to launch and terminate browser processes.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefThreadIds.TID_IO">
|
<summary>
|
Used to process IPC and network messages. Do not perform blocking tasks on
|
this thread. All tasks posted after <see cref="M:CefSharp.IBrowserProcessHandler.OnContextInitialized"/>
|
and before Cef.Shutdown() are guaranteed to run.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CefThreadIds.TID_RENDERER">
|
<summary>
|
The main thread in the renderer. Used for all WebKit and V8 interaction.
|
Tasks may be posted to this thread after
|
CefRenderProcessHandler::OnWebKitInitialized but are not guaranteed to
|
run before sub-process termination (sub-processes may be killed at any time
|
without warning).
|
</summary>
|
</member>
|
<member name="T:CefSharp.CertStatus">
|
<summary>
|
|
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.
|
</summary>
|
</member>
|
<member name="F:CefSharp.CertStatus.None">
|
<summary>
|
None
|
</summary>
|
</member>
|
<member name="F:CefSharp.CertStatus.CommonNameInvalid">
|
<summary>
|
CommonNameInvalid
|
</summary>
|
</member>
|
<member name="F:CefSharp.CertStatus.DateInvalid">
|
<summary>
|
DateInvalid
|
</summary>
|
</member>
|
<member name="F:CefSharp.CertStatus.AuthorityInvalid">
|
<summary>
|
AuthorityInvalid
|
</summary>
|
</member>
|
<member name="F:CefSharp.CertStatus.NoRevocation_Mechanism">
|
<summary>
|
NoRevocation_Mechanism
|
</summary>
|
</member>
|
<member name="F:CefSharp.CertStatus.UnableToCheckRevocation">
|
<summary>
|
UnableToCheckRevocation
|
</summary>
|
</member>
|
<member name="F:CefSharp.CertStatus.Revoked">
|
<summary>
|
Revoked
|
</summary>
|
</member>
|
<member name="F:CefSharp.CertStatus.Invalid">
|
<summary>
|
Invalid
|
</summary>
|
</member>
|
<member name="F:CefSharp.CertStatus.WeakSignatureAlgorithm">
|
<summary>
|
WeakSignatureAlgorithm
|
</summary>
|
</member>
|
<member name="F:CefSharp.CertStatus.NonUniqueName">
|
<summary>
|
NonUniqueName
|
</summary>
|
</member>
|
<member name="F:CefSharp.CertStatus.WeakKey">
|
<summary>
|
WeakKey
|
</summary>
|
</member>
|
<member name="F:CefSharp.CertStatus.PinnedKeyMissing">
|
<summary>
|
PinnedKeyMissing
|
</summary>
|
</member>
|
<member name="F:CefSharp.CertStatus.NameConstraintViolation">
|
<summary>
|
NameConstraintViolation
|
</summary>
|
</member>
|
<member name="F:CefSharp.CertStatus.ValidityTooLong">
|
<summary>
|
ValidityTooLong
|
</summary>
|
</member>
|
<member name="F:CefSharp.CertStatus.IsEv">
|
<summary>
|
IsEv
|
</summary>
|
</member>
|
<member name="F:CefSharp.CertStatus.RevCheckingEnabled">
|
<summary>
|
RevCheckingEnabled
|
</summary>
|
</member>
|
<member name="F:CefSharp.CertStatus.Sha1SignaturePresent">
|
<summary>
|
Sha1SignaturePresent
|
</summary>
|
</member>
|
<member name="F:CefSharp.CertStatus.CtComplianceFailed">
|
<summary>
|
CtComplianceFailed
|
</summary>
|
</member>
|
<member name="T:CefSharp.ContextMenuEditState">
|
<summary>
|
Supported context menu edit state bit flags.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuEditState.None">
|
<summary>
|
A binary constant representing the none flag.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuEditState.CanUndo">
|
<summary>
|
A binary constant representing the can undo flag.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuEditState.CanRedo">
|
<summary>
|
A binary constant representing the can redo flag.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuEditState.CanCut">
|
<summary>
|
A binary constant representing the can cut flag.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuEditState.CanCopy">
|
<summary>
|
A binary constant representing the can copy flag.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuEditState.CanPaste">
|
<summary>
|
A binary constant representing the can paste flag.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuEditState.CanDelete">
|
<summary>
|
A binary constant representing the can delete flag.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuEditState.CanSelectAll">
|
<summary>
|
A binary constant representing the can select all flag.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuEditState.CanTranslate">
|
<summary>
|
A binary constant representing the can translate flag.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuEditState.CanEditRichly">
|
<summary>
|
A binary constant representing the can edit richly flag.
|
</summary>
|
</member>
|
<member name="T:CefSharp.ContextMenuMediaState">
|
<summary>
|
Supported context menu media state bit flags. These constants match their
|
equivalents in Chromium's ContextMenuData::MediaFlags and should not be
|
renumbered.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaState.None">
|
<summary>
|
None
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaState.Error">
|
<summary>
|
Error
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaState.Paused">
|
<summary>
|
Paused
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaState.Muted">
|
<summary>
|
Muted
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaState.Loop">
|
<summary>
|
Loop
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaState.CanSave">
|
<summary>
|
CanSave
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaState.HasAudio">
|
<summary>
|
HasAudio
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaState.CanToggleControls">
|
<summary>
|
Can Toggle Controls
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaState.Controls">
|
<summary>
|
Controls
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaState.CanPrint">
|
<summary>
|
CanPrint
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaState.CanRotate">
|
<summary>
|
CanRotate
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaState.CanPictureInPicture">
|
<summary>
|
CanPictureInPicture
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaState.PictureInPicture">
|
<summary>
|
PictureInPicture
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaState.CanLoop">
|
<summary>
|
CanLoop
|
</summary>
|
</member>
|
<member name="T:CefSharp.ContextMenuMediaType">
|
<summary>
|
Supported context menu media types.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaType.None">
|
<summary>
|
No special node is in context.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaType.Image">
|
<summary>
|
An image node is selected.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaType.Video">
|
<summary>
|
A video node is selected.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaType.Audio">
|
<summary>
|
An audio node is selected.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaType.Canvas">
|
<summary>
|
An canvas node is selected
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaType.File">
|
<summary>
|
A file node is selected.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuMediaType.Plugin">
|
<summary>
|
A plugin node is selected.
|
</summary>
|
</member>
|
<member name="T:CefSharp.ContextMenuType">
|
<summary>
|
ContextMenuType
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuType.None">
|
<summary>
|
No node is selected.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuType.Page">
|
<summary>
|
The top page is selected.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuType.Frame">
|
<summary>
|
A subframe page is selected.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuType.Link">
|
<summary>
|
A link is selected.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuType.Media">
|
<summary>
|
A media node is selected.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuType.Selection">
|
<summary>
|
There is a textual or mixed selection that is selected.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ContextMenuType.Editable">
|
<summary>
|
An editable element is selected.
|
</summary>
|
</member>
|
<member name="T:CefSharp.FilterStatus">
|
<summary>
|
Return values for IResponseFilter
|
</summary>
|
</member>
|
<member name="F:CefSharp.FilterStatus.NeedMoreData">
|
<summary>
|
Some or all of the pre-filter data was read successfully but more data is
|
needed in order to continue filtering (filtered output is pending).
|
</summary>
|
</member>
|
<member name="F:CefSharp.FilterStatus.Done">
|
<summary>
|
Some or all of the pre-filter data was read successfully and all available filtered output has been written.
|
</summary>
|
</member>
|
<member name="F:CefSharp.FilterStatus.Error">
|
<summary>
|
An error occurred during filtering.
|
</summary>
|
</member>
|
<member name="T:CefSharp.KeyEventType">
|
<summary>
|
Values that represent key event types.
|
</summary>
|
</member>
|
<member name="F:CefSharp.KeyEventType.RawKeyDown">
|
<summary>
|
Notification that a key transitioned from "up" to "down".
|
</summary>
|
</member>
|
<member name="F:CefSharp.KeyEventType.KeyDown">
|
<summary>
|
Notification that a key was pressed. This does not necessarily correspond
|
to a character depending on the key and language. Use KEYEVENT_CHAR for
|
character input.
|
</summary>
|
</member>
|
<member name="F:CefSharp.KeyEventType.KeyUp">
|
<summary>
|
Notification that a key was released.
|
</summary>
|
</member>
|
<member name="F:CefSharp.KeyEventType.Char">
|
<summary>
|
Notification that a character was typed. Use this for text input. Key
|
down events may generate 0, 1, or more than one character event depending
|
on the key, locale, and operating system.
|
</summary>
|
</member>
|
<member name="T:CefSharp.KeyType">
|
<summary>
|
KeyType Enum.
|
Maps to https://magpcss.org/ceforum/apidocs3/projects/(default)/cef_key_event_type_t.html
|
</summary>
|
</member>
|
<member name="F:CefSharp.KeyType.RawKeyDown">
|
<summary>
|
Notification that a key transitioned from"up" to"down".
|
</summary>
|
</member>
|
<member name="F:CefSharp.KeyType.KeyDown">
|
<summary>
|
Notification that a key was pressed. This does not necessarily correspond to a character depending on the key and language.
|
Use <seealso cref="F:CefSharp.KeyType.Char"/> for character input.
|
</summary>
|
</member>
|
<member name="F:CefSharp.KeyType.KeyUp">
|
<summary>
|
Notification that a key was released.
|
</summary>
|
</member>
|
<member name="F:CefSharp.KeyType.Char">
|
<summary>
|
Notification that a character was typed. Use this for text input. Key
|
down events may generate 0, 1, or more than one character event depending
|
on the key, locale, and operating system.
|
</summary>
|
</member>
|
<member name="T:CefSharp.LogSeverity">
|
<summary>
|
LogSeverity
|
</summary>
|
</member>
|
<member name="F:CefSharp.LogSeverity.Default">
|
<summary>
|
Default logging (currently Info logging)
|
</summary>
|
</member>
|
<member name="F:CefSharp.LogSeverity.Verbose">
|
<summary>
|
Verbose logging.
|
</summary>
|
</member>
|
<member name="F:CefSharp.LogSeverity.Info">
|
<summary>
|
Info logging
|
</summary>
|
</member>
|
<member name="F:CefSharp.LogSeverity.Warning">
|
<summary>
|
Warning logging
|
</summary>
|
</member>
|
<member name="F:CefSharp.LogSeverity.Error">
|
<summary>
|
Error logging
|
</summary>
|
</member>
|
<member name="F:CefSharp.LogSeverity.Fatal">
|
<summary>
|
Fatal logging.
|
</summary>
|
</member>
|
<member name="F:CefSharp.LogSeverity.Disable">
|
<summary>
|
Disable logging to file for all messages, and to stderr for messages with severity less than FATAL.
|
</summary>
|
</member>
|
<member name="T:CefSharp.MediaAccessPermissionType">
|
<summary>
|
Media access permissions used by <see cref="M:CefSharp.IPermissionHandler.OnRequestMediaAccessPermission(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.String,CefSharp.MediaAccessPermissionType,CefSharp.IMediaAccessCallback)"/>.
|
</summary>
|
</member>
|
<member name="F:CefSharp.MediaAccessPermissionType.None">
|
<summary>
|
No permission.
|
</summary>
|
</member>
|
<member name="F:CefSharp.MediaAccessPermissionType.AudioCapture">
|
<summary>
|
Device audio capture permission.
|
</summary>
|
</member>
|
<member name="F:CefSharp.MediaAccessPermissionType.VideoCapture">
|
<summary>
|
Device video capture permission.
|
</summary>
|
</member>
|
<member name="F:CefSharp.MediaAccessPermissionType.DesktopAudioCapture">
|
<summary>
|
Desktop audio capture permission.
|
</summary>
|
</member>
|
<member name="F:CefSharp.MediaAccessPermissionType.DesktopVideoCapture">
|
<summary>
|
Desktop video capture permission.
|
</summary>
|
</member>
|
<member name="T:CefSharp.MenuItemType">
|
<summary>
|
Supported menu item types.
|
</summary>
|
</member>
|
<member name="F:CefSharp.MenuItemType.None">
|
<summary>
|
An enum constant representing the none option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.MenuItemType.Command">
|
<summary>
|
An enum constant representing the command option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.MenuItemType.Check">
|
<summary>
|
An enum constant representing the check option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.MenuItemType.Radio">
|
<summary>
|
An enum constant representing the radio option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.MenuItemType.Separator">
|
<summary>
|
An enum constant representing the separator option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.MenuItemType.SubMenu">
|
<summary>
|
An enum constant representing the sub menu option.
|
</summary>
|
</member>
|
<member name="T:CefSharp.MouseButtonType">
|
<summary>
|
Values that represent mouse button types.
|
</summary>
|
</member>
|
<member name="F:CefSharp.MouseButtonType.Left">
|
<summary>
|
Left Mouse Button
|
</summary>
|
</member>
|
<member name="F:CefSharp.MouseButtonType.Middle">
|
<summary>
|
Middle Mouse Button
|
</summary>
|
</member>
|
<member name="F:CefSharp.MouseButtonType.Right">
|
<summary>
|
Right Mouse Button
|
</summary>
|
</member>
|
<member name="T:CefSharp.PaintElementType">
|
<summary>
|
Paint element types.
|
</summary>
|
</member>
|
<member name="F:CefSharp.PaintElementType.View">
|
<summary>
|
An enum constant representing the view option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.PaintElementType.Popup">
|
<summary>
|
An enum constant representing the popup option.
|
</summary>
|
</member>
|
<member name="T:CefSharp.PermissionRequestResult">
|
<summary>
|
Permission request results.
|
</summary>
|
</member>
|
<member name="F:CefSharp.PermissionRequestResult.Accept">
|
<summary>
|
Accept the permission request as an explicit user action.
|
</summary>
|
</member>
|
<member name="F:CefSharp.PermissionRequestResult.Deny">
|
<summary>
|
Deny the permission request as an explicit user action.
|
</summary>
|
</member>
|
<member name="F:CefSharp.PermissionRequestResult.Dismiss">
|
<summary>
|
Dismiss the permission request as an explicit user action.
|
</summary>
|
</member>
|
<member name="F:CefSharp.PermissionRequestResult.Ignore">
|
<summary>
|
Ignore the permission request. If the prompt remains unhandled (e.g.
|
OnShowPermissionPrompt returns false and there is no default permissions
|
UI) then any related promises may remain unresolved.
|
</summary>
|
</member>
|
<member name="T:CefSharp.PermissionRequestType">
|
<summary>
|
Permission types used with <see cref="M:CefSharp.IPermissionHandler.OnShowPermissionPrompt(CefSharp.IWebBrowser,CefSharp.IBrowser,System.UInt64,System.String,CefSharp.PermissionRequestType,CefSharp.IPermissionPromptCallback)"/>.
|
Some types are platform-specific or only supported with the Chrome runtime. Should be kept
|
in sync with Chromium's permissions::RequestType type.
|
</summary>
|
</member>
|
<member name="T:CefSharp.PostDataElementType">
|
<summary>
|
Post data elements may represent either bytes or files.
|
</summary>
|
</member>
|
<member name="F:CefSharp.PostDataElementType.Empty">
|
<summary>
|
An enum constant representing the empty option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.PostDataElementType.Bytes">
|
<summary>
|
An enum constant representing the bytes option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.PostDataElementType.File">
|
<summary>
|
An enum constant representing the file option.
|
</summary>
|
</member>
|
<member name="T:CefSharp.ReferrerPolicy">
|
<summary>
|
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.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ReferrerPolicy.ClearReferrerOnTransitionFromSecureToInsecure">
|
<summary>
|
Clear the referrer header if the header value is HTTPS but the request
|
destination is HTTP. This is the default behavior.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ReferrerPolicy.Default">
|
<summary>
|
Default which is equivalent to <see cref="F:CefSharp.ReferrerPolicy.ClearReferrerOnTransitionFromSecureToInsecure"/>
|
</summary>
|
</member>
|
<member name="F:CefSharp.ReferrerPolicy.ReduceReferrerGranularityOnTransitionCrossOrigin">
|
<summary>
|
A slight variant on <see cref="F:CefSharp.ReferrerPolicy.ClearReferrerOnTransitionFromSecureToInsecure"/>:
|
If the request destination is HTTP, an HTTPS referrer will be cleared. If
|
the request's destination is cross-origin with the referrer (but does not
|
downgrade), the referrer's granularity will be stripped down to an origin
|
rather than a full URL. Same-origin requests will send the full referrer.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ReferrerPolicy.OriginOnlyOnTransitionCrossOrigin">
|
<summary>
|
Strip the referrer down to an origin when the origin of the referrer is
|
different from the destination's origin.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ReferrerPolicy.NeverClearReferrer">
|
<summary>
|
Never change the referrer.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ReferrerPolicy.Origin">
|
<summary>
|
Strip the referrer down to the origin regardless of the redirect location.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ReferrerPolicy.ClearReferrerOnTransitionCrossOrigin">
|
<summary>
|
Clear the referrer when the request's referrer is cross-origin with the
|
request's destination.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ReferrerPolicy.OriginClearOnTransitionFromSecureToInsecure">
|
<summary>
|
Strip the referrer down to the origin, but clear it entirely if the
|
referrer value is HTTPS and the destination is HTTP.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ReferrerPolicy.NoReferrer">
|
<summary>
|
Always clear the referrer regardless of the request destination.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ReferrerPolicy.LastValue">
|
<summary>
|
Always the last value in this enumeration.
|
</summary>
|
</member>
|
<member name="T:CefSharp.ResourceType">
|
<summary>
|
Resource type for a request.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.MainFrame">
|
<summary>
|
Top level page.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.SubFrame">
|
<summary>
|
Frame or iframe.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.Stylesheet">
|
<summary>
|
CSS stylesheet.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.Script">
|
<summary>
|
External script.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.Image">
|
<summary>
|
Image (jpg/gif/png/etc).
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.FontResource">
|
<summary>
|
Font.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.SubResource">
|
<summary>
|
Some other subresource. This is the default type if the actual type is unknown.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.Object">
|
<summary>
|
Object (or embed) tag for a plugin, or a resource that a plugin requested.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.Media">
|
<summary>
|
Media resource.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.Worker">
|
<summary>
|
Main resource of a dedicated worker.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.SharedWorker">
|
<summary>
|
Main resource of a shared worker.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.Prefetch">
|
<summary>
|
Explicitly requested prefetch.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.Favicon">
|
<summary>
|
Favicon.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.Xhr">
|
<summary>
|
XMLHttpRequest.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.Ping">
|
<summary>
|
A request for a ping
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.ServiceWorker">
|
<summary>
|
Main resource of a service worker.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.CspReport">
|
<summary>
|
A report of Content Security Policy violations.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.PluginResource">
|
<summary>
|
A resource that a plugin requested.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.NavigationPreLoadMainFrame">
|
<summary>
|
A main-frame service worker navigation preload request.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceType.NavigationPreLoadSubFrame">
|
<summary>
|
A sub-frame service worker navigation preload request.
|
</summary>
|
</member>
|
<member name="T:CefSharp.SslContentStatus">
|
<summary>
|
Supported SSL content status flags. See content/public/common/ssl_status.h
|
for more information.
|
</summary>
|
</member>
|
<member name="F:CefSharp.SslContentStatus.NormalContent">
|
<summary>
|
HTTP page, or HTTPS page with no insecure content..
|
</summary>
|
</member>
|
<member name="F:CefSharp.SslContentStatus.DisplayedInsecureContent">
|
<summary>
|
HTTPS page containing "displayed" HTTP resources (e.g. images, CSS).
|
</summary>
|
</member>
|
<member name="F:CefSharp.SslContentStatus.RanInsecureContent">
|
<summary>
|
HTTPS page containing "executed" HTTP resources (i.e. script)
|
</summary>
|
</member>
|
<member name="T:CefSharp.SslVersion">
|
<summary>
|
Supported SSL version values. See net/ssl/ssl_connection_status_flags.h
|
for more information.
|
</summary>
|
</member>
|
<member name="F:CefSharp.SslVersion.Unknown">
|
<summary>
|
Unknown SSL version.
|
</summary>
|
</member>
|
<member name="F:CefSharp.SslVersion.Ssl2">
|
<summary>
|
An enum constant representing the ssl 2 option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.SslVersion.Ssl3">
|
<summary>
|
An enum constant representing the ssl 3 option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.SslVersion.Tls1">
|
<summary>
|
An enum constant representing the TLS 1.0 option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.SslVersion.Tls1_1">
|
<summary>
|
An enum constant representing the TLS 1.1 option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.SslVersion.Tls1_2">
|
<summary>
|
An enum constant representing the TLS 1.2 option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.SslVersion.Tls1_3">
|
<summary>
|
An enum constant representing the TLS 1.3 option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.SslVersion.Quic">
|
<summary>
|
An enum constant representing the QUIC option.
|
</summary>
|
</member>
|
<member name="T:CefSharp.TransitionType">
|
<summary>
|
Transition type for a request. Made up of one source value and 0 or more qualifiers.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.LinkClicked">
|
<summary>
|
Source is a link click or the JavaScript window.open function. This is
|
also the default value for requests like sub-resource loads that are not navigations.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.Explicit">
|
<summary>
|
Source is some other "explicit" navigation. This is the default value for
|
navigations where the actual type is unknown. See also <see cref="F:CefSharp.TransitionType.DirectLoad"/>.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.AutoBookmark">
|
<summary>
|
User got to this page through a suggestion in the UI (for example, via the
|
destinations page). Chrome runtime only.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.AutoSubFrame">
|
<summary>
|
Source is a subframe navigation. This is any content that is automatically
|
loaded in a non-toplevel frame. For example, if a page consists of several
|
frames containing ads, those ad URLs will have this transition type.
|
The user may not even realize the content in these pages is a separate
|
frame, so may not care about the URL.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.ManualSubFrame">
|
<summary>
|
Source is a subframe navigation explicitly requested by the user that will
|
generate new navigation entries in the back/forward list. These are
|
probably more important than frames that were automatically loaded in
|
the background because the user probably cares about the fact that this
|
link was loaded.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.Generated">
|
<summary>
|
User got to this page by typing in the URL bar and selecting an entry
|
that did not look like a URL. For example, a match might have the URL
|
of a Google search result page, but appear like "Search Google for ...".
|
These are not quite the same as EXPLICIT navigations because the user
|
didn't type or see the destination URL. Chrome runtime only.
|
See also TT_KEYWORD.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.AutoToplevel">
|
<summary>
|
This is a toplevel navigation. This is any content that is automatically
|
loaded in a toplevel frame. For example, opening a tab to show the ASH
|
screen saver, opening the devtools window, opening the NTP after the safe
|
browsing warning, opening web-based dialog boxes are examples of
|
AUTO_TOPLEVEL navigations. Chrome runtime only.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.FormSubmit">
|
<summary>
|
Source is a form submission by the user. NOTE: In some situations
|
submitting a form does not result in this transition type. This can happen
|
if the form uses a script to submit the contents.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.Reload">
|
<summary>
|
Source is a "reload" of the page via the Reload function or by re-visiting
|
the same URL. NOTE: This is distinct from the concept of whether a
|
particular load uses "reload semantics" (i.e. bypasses cached data).
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.Keyword">
|
<summary>
|
The url was generated from a replaceable keyword other than the default
|
search provider. If the user types a keyword (which also applies to
|
tab-to-search) in the omnibox this qualifier is applied to the transition
|
type of the generated url. TemplateURLModel then may generate an
|
additional visit with a transition type of TT_KEYWORD_GENERATED against the
|
url 'http://' + keyword. For example, if you do a tab-to-search against
|
wikipedia the generated url has a transition qualifer of TT_KEYWORD, and
|
TemplateURLModel generates a visit for 'wikipedia.org' with a transition
|
type of TT_KEYWORD_GENERATED. Chrome runtime only.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.KeywordGenerated">
|
<summary>
|
Corresponds to a visit generated for a keyword. See description of
|
TT_KEYWORD for more details. Chrome runtime only.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.SourceMask">
|
<summary>
|
General mask defining the bits used for the source values.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.Blocked">
|
<summary>
|
Attempted to visit a URL but was blocked.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.ForwardBack">
|
<summary>
|
Used the Forward or Back function to navigate among browsing history.
|
Will be ORed to the transition type for the original load.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.DirectLoad">
|
<summary>
|
Loaded a URL directly via CreateBrowser, LoadURL or LoadRequest.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.HomePage">
|
<summary>
|
User is navigating to the home page. Chrome runtime only.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.FromApi">
|
<summary>
|
The transition originated from an external application; the exact
|
definition of this is embedder dependent. Chrome runtime and
|
extension system only.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.ChainStart">
|
<summary>
|
The beginning of a navigation chain.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.ChainEnd">
|
<summary>
|
The last transition in a redirect chain.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.ClientRedirect">
|
<summary>
|
Redirects caused by JavaScript or a meta refresh tag on the page.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.ServerRedirect">
|
<summary>
|
Redirects sent from the server by HTTP headers.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.IsRedirect">
|
<summary>
|
Used to test whether a transition involves a redirect.
|
</summary>
|
</member>
|
<member name="F:CefSharp.TransitionType.QualifierMask">
|
<summary>
|
General mask defining the bits used for the qualifiers.
|
</summary>
|
</member>
|
<member name="T:CefSharp.UrlRequestFlags">
|
<summary>
|
Flags used to customize the behavior of CefURLRequest.
|
</summary>
|
</member>
|
<member name="F:CefSharp.UrlRequestFlags.None">
|
<summary>
|
Default behavior.
|
</summary>
|
</member>
|
<member name="F:CefSharp.UrlRequestFlags.SkipCache">
|
<summary>
|
If set the cache will be skipped when handling the request. Setting this
|
value is equivalent to specifying the "Cache-Control: no-cache" request
|
header. Setting this value in combination with OnlyFromCache will
|
cause the request to fail.
|
</summary>
|
</member>
|
<member name="F:CefSharp.UrlRequestFlags.OnlyFromCache">
|
<summary>
|
If set the request will fail if it cannot be served from the cache (or some
|
equivalent local store). Setting this value is equivalent to specifying the
|
"Cache-Control: only-if-cached" request header. Setting this value in
|
combination with SkipCache or DisableCache will cause the
|
request to fail.
|
</summary>
|
</member>
|
<member name="F:CefSharp.UrlRequestFlags.DisableCache">
|
<summary>
|
If set the cache will not be used at all. Setting this value is equivalent
|
to specifying the "Cache-Control: no-store" request header. Setting this
|
value in combination with OnlyFromCache will cause the request to
|
fail.
|
</summary>
|
</member>
|
<member name="F:CefSharp.UrlRequestFlags.AllowStoredCredentials">
|
<summary>
|
If set user name, password, and cookies may be sent with the request, and
|
cookies may be saved from the response.
|
</summary>
|
</member>
|
<member name="F:CefSharp.UrlRequestFlags.ReportUploadProgress">
|
<summary>
|
If set upload progress events will be generated when a request has a body.
|
</summary>
|
</member>
|
<member name="F:CefSharp.UrlRequestFlags.NoDownloadData">
|
<summary>
|
If set the CefURLRequestClient::OnDownloadData method will not be called.
|
</summary>
|
</member>
|
<member name="F:CefSharp.UrlRequestFlags.NoRetryOn5XX">
|
<summary>
|
If set 5XX redirect errors will be propagated to the observer instead of
|
automatically re-tried. This currently only applies for requests
|
originated in the browser process.
|
</summary>
|
</member>
|
<member name="F:CefSharp.UrlRequestFlags.StopOnRedirect">
|
<summary>
|
If set 3XX responses will cause the fetch to halt immediately rather than
|
continue through the redirect.
|
</summary>
|
</member>
|
<member name="T:CefSharp.UrlRequestStatus">
|
<summary>
|
Flags that represent CefURLRequest status.
|
</summary>
|
</member>
|
<member name="F:CefSharp.UrlRequestStatus.Unknown">
|
<summary>
|
Unknown status.
|
</summary>
|
</member>
|
<member name="F:CefSharp.UrlRequestStatus.Success">
|
<summary>
|
Request succeeded.
|
</summary>
|
</member>
|
<member name="F:CefSharp.UrlRequestStatus.IoPending">
|
<summary>
|
An IO request is pending, and the caller will be informed when it is completed.
|
</summary>
|
</member>
|
<member name="F:CefSharp.UrlRequestStatus.Canceled">
|
<summary>
|
Request was canceled programatically.
|
</summary>
|
</member>
|
<member name="F:CefSharp.UrlRequestStatus.Failed">
|
<summary>
|
Request failed for some reason.
|
</summary>
|
</member>
|
<member name="T:CefSharp.WindowOpenDisposition">
|
<summary>
|
The manner in which a link click should be opened.
|
</summary>
|
</member>
|
<member name="F:CefSharp.WindowOpenDisposition.Unknown">
|
<summary>
|
An enum constant representing the unknown option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.WindowOpenDisposition.CurrentTab">
|
<summary>
|
An enum constant representing the current tab option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.WindowOpenDisposition.SingletonTab">
|
<summary>
|
Indicates that only one tab with the url should exist in the same window
|
</summary>
|
</member>
|
<member name="F:CefSharp.WindowOpenDisposition.NewForegroundTab">
|
<summary>
|
An enum constant representing the new foreground tab option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.WindowOpenDisposition.NewBackgroundTab">
|
<summary>
|
An enum constant representing the new background tab option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.WindowOpenDisposition.NewPopup">
|
<summary>
|
An enum constant representing the new popup option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.WindowOpenDisposition.NewWindow">
|
<summary>
|
An enum constant representing the new window option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.WindowOpenDisposition.SaveToDisk">
|
<summary>
|
An enum constant representing the save to disk option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.WindowOpenDisposition.OffTheRecord">
|
<summary>
|
An enum constant representing the off the record option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.WindowOpenDisposition.IgnoreAction">
|
<summary>
|
An enum constant representing the ignore action option.
|
</summary>
|
</member>
|
<member name="F:CefSharp.WindowOpenDisposition.SwitchToTab">
|
<summary>
|
Activates an existing tab containing the url, rather than navigating.
|
This is similar to SINGLETON_TAB, but searches across all windows from
|
the current profile and anonymity (instead of just the current one);
|
closes the current tab on switching if the current tab was the NTP with
|
no session history; and behaves like CURRENT_TAB instead of
|
NEW_FOREGROUND_TAB when no existing tab is found.
|
</summary>
|
</member>
|
<member name="F:CefSharp.WindowOpenDisposition.NewPictureInPicture">
|
<summary>
|
Creates a new document picture-in-picture window showing a child WebView.
|
</summary>
|
</member>
|
<member name="T:CefSharp.AddressChangedEventArgs">
|
<summary>
|
Event arguments for the AddressChanged event handler.
|
</summary>
|
</member>
|
<member name="P:CefSharp.AddressChangedEventArgs.Browser">
|
<summary>
|
Access to the underlying <see cref="T:CefSharp.IBrowser"/> object
|
</summary>
|
</member>
|
<member name="P:CefSharp.AddressChangedEventArgs.Address">
|
<summary>
|
The new address
|
</summary>
|
</member>
|
<member name="M:CefSharp.AddressChangedEventArgs.#ctor(CefSharp.IBrowser,System.String)">
|
<summary>
|
Creates a new AddressChangedEventArgs event argument.
|
</summary>
|
<param name="browser">the browser object</param>
|
<param name="address">the address</param>
|
</member>
|
<member name="T:CefSharp.ConsoleMessageEventArgs">
|
<summary>
|
Event arguments for the ConsoleMessage event handler set up in IWebBrowser.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ConsoleMessageEventArgs.#ctor(CefSharp.IBrowser,CefSharp.LogSeverity,System.String,System.String,System.Int32)">
|
<summary>
|
Creates a new ConsoleMessageEventArgs event argument.
|
</summary>
|
<param name="browser">browser</param>
|
<param name="level">level</param>
|
<param name="message">message</param>
|
<param name="source">source</param>
|
<param name="line">line number</param>
|
</member>
|
<member name="P:CefSharp.ConsoleMessageEventArgs.Browser">
|
<summary>
|
Access to the underlying <see cref="T:CefSharp.IBrowser"/> object
|
</summary>
|
</member>
|
<member name="P:CefSharp.ConsoleMessageEventArgs.Level">
|
<summary>
|
Log level
|
</summary>
|
</member>
|
<member name="P:CefSharp.ConsoleMessageEventArgs.Message">
|
<summary>
|
The message text of the console message.
|
</summary>
|
</member>
|
<member name="P:CefSharp.ConsoleMessageEventArgs.Source">
|
<summary>
|
The source of the console message.
|
</summary>
|
</member>
|
<member name="P:CefSharp.ConsoleMessageEventArgs.Line">
|
<summary>
|
The line number that generated the console message.
|
</summary>
|
</member>
|
<member name="T:CefSharp.FrameLoadEndEventArgs">
|
<summary>
|
Event arguments to the FrameLoadEnd event handler set up in IWebBrowser.
|
</summary>
|
</member>
|
<member name="M:CefSharp.FrameLoadEndEventArgs.#ctor(CefSharp.IBrowser,CefSharp.IFrame,System.Int32)">
|
<summary>
|
Creates a new FrameLoadEnd event args
|
</summary>
|
<param name="browser">browser</param>
|
<param name="frame">frame</param>
|
<param name="httpStatusCode">http statusCode</param>
|
</member>
|
<member name="P:CefSharp.FrameLoadEndEventArgs.Browser">
|
<summary>
|
The browser that contains the frame that finished loading.
|
</summary>
|
</member>
|
<member name="P:CefSharp.FrameLoadEndEventArgs.Frame">
|
<summary>
|
The frame that finished loading.
|
</summary>
|
</member>
|
<member name="P:CefSharp.FrameLoadEndEventArgs.Url">
|
<summary>
|
The URL that was loaded.
|
</summary>
|
</member>
|
<member name="P:CefSharp.FrameLoadEndEventArgs.HttpStatusCode">
|
<summary>
|
Http Status Code
|
</summary>
|
</member>
|
<member name="T:CefSharp.FrameLoadStartEventArgs">
|
<summary>
|
Event arguments to the FrameLoadStart event handler set up in IWebBrowser.
|
</summary>
|
</member>
|
<member name="M:CefSharp.FrameLoadStartEventArgs.#ctor(CefSharp.IBrowser,CefSharp.IFrame,CefSharp.TransitionType)">
|
<summary>
|
Creates a new FrameLoadStart event args
|
</summary>
|
<param name="browser">browser</param>
|
<param name="frame">frame</param>
|
<param name="transitionType"> provides information about the source of the navigation and an accurate value is only
|
available in the browser process</param>
|
</member>
|
<member name="P:CefSharp.FrameLoadStartEventArgs.Browser">
|
<summary>
|
The browser object
|
</summary>
|
</member>
|
<member name="P:CefSharp.FrameLoadStartEventArgs.Frame">
|
<summary>
|
The frame that just started loading.
|
</summary>
|
</member>
|
<member name="P:CefSharp.FrameLoadStartEventArgs.Url">
|
<summary>
|
The URL that was loaded.
|
</summary>
|
</member>
|
<member name="P:CefSharp.FrameLoadStartEventArgs.TransitionType">
|
<summary>
|
TransitionType provides information about the source of the navigation.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Event.JavascriptBindingCompleteEventArgs">
|
<summary>
|
Event arguments for the <see cref="E:CefSharp.IJavascriptObjectRepository.ObjectBoundInJavascript"/> event
|
</summary>
|
</member>
|
<member name="P:CefSharp.Event.JavascriptBindingCompleteEventArgs.ObjectRepository">
|
<summary>
|
The javascript object repository, used to register objects
|
</summary>
|
</member>
|
<member name="P:CefSharp.Event.JavascriptBindingCompleteEventArgs.ObjectName">
|
<summary>
|
Name of the object
|
</summary>
|
</member>
|
<member name="P:CefSharp.Event.JavascriptBindingCompleteEventArgs.AlreadyBound">
|
<summary>
|
Was the object already bound. The default is false for the first js call to
|
CefSharp.BindObjectAsync, and subsequently true if already bound in a given context.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Event.JavascriptBindingCompleteEventArgs.IsCached">
|
<summary>
|
Is the object cached
|
</summary>
|
</member>
|
<member name="M:CefSharp.Event.JavascriptBindingCompleteEventArgs.#ctor(CefSharp.IJavascriptObjectRepository,System.String,System.Boolean,System.Boolean)">
|
<summary>
|
JavascriptBindingCompleteEventArgs
|
</summary>
|
<param name="objectRepository">javascript object repository</param>
|
<param name="name">object name</param>
|
<param name="alreadyBound">is the object already bound</param>
|
<param name="isCached">is the object cached</param>
|
</member>
|
<member name="T:CefSharp.Event.JavascriptBindingEventArgs">
|
<summary>
|
Event arguments for the <see cref="E:CefSharp.IJavascriptObjectRepository.ResolveObject"/> event
|
</summary>
|
</member>
|
<member name="P:CefSharp.Event.JavascriptBindingEventArgs.ObjectRepository">
|
<summary>
|
The javascript object repository, used to register objects
|
</summary>
|
</member>
|
<member name="P:CefSharp.Event.JavascriptBindingEventArgs.ObjectName">
|
<summary>
|
Name of the object
|
</summary>
|
</member>
|
<member name="M:CefSharp.Event.JavascriptBindingEventArgs.#ctor(CefSharp.IJavascriptObjectRepository,System.String)">
|
<summary>
|
Constructor
|
</summary>
|
<param name="objectRepository">object repository</param>
|
<param name="name">object name</param>
|
</member>
|
<member name="T:CefSharp.Event.JavascriptBindingMultipleCompleteEventArgs">
|
<summary>
|
Event arguments for the <see cref="E:CefSharp.IJavascriptObjectRepository.ObjectsBoundInJavascript"/> event
|
</summary>
|
</member>
|
<member name="P:CefSharp.Event.JavascriptBindingMultipleCompleteEventArgs.ObjectRepository">
|
<summary>
|
The javascript object repository, used to register objects
|
</summary>
|
</member>
|
<member name="P:CefSharp.Event.JavascriptBindingMultipleCompleteEventArgs.ObjectNames">
|
<summary>
|
Name of the objects bound
|
</summary>
|
</member>
|
<member name="M:CefSharp.Event.JavascriptBindingMultipleCompleteEventArgs.#ctor(CefSharp.IJavascriptObjectRepository,System.Collections.Generic.IList{System.String})">
|
<summary>
|
JavascriptBindingMultipleCompleteEventArgs
|
</summary>
|
<param name="objectRepository">Javascript object repository</param>
|
<param name="names">object names</param>
|
</member>
|
<member name="T:CefSharp.JavascriptMessageReceivedEventArgs">
|
<summary>
|
Calling CefSharp.PostMessage in Javascript triggers the JavascriptMessageReceived
|
This event args contains the frame, browser and message corrisponding to that call
|
</summary>
|
</member>
|
<member name="P:CefSharp.JavascriptMessageReceivedEventArgs.Frame">
|
<summary>
|
The frame that called CefSharp.PostMessage in Javascript
|
</summary>
|
</member>
|
<member name="P:CefSharp.JavascriptMessageReceivedEventArgs.Browser">
|
<summary>
|
The browser that hosts the <see cref="T:CefSharp.IFrame"/>
|
</summary>
|
</member>
|
<member name="P:CefSharp.JavascriptMessageReceivedEventArgs.Message">
|
<summary>
|
Message can be a primative type or a simple object that represents a copy
|
of the data sent from the browser
|
</summary>
|
</member>
|
<member name="M:CefSharp.JavascriptMessageReceivedEventArgs.#ctor(CefSharp.IBrowser,CefSharp.IFrame,System.Object)">
|
<summary>
|
Constructor.
|
</summary>
|
<param name="browser">The browser that hosts the <see cref="T:CefSharp.IFrame"/></param>
|
<param name="frame">The frame that called CefSharp.PostMessage in Javascript.</param>
|
<param name="message">Message can be a primative type or a simple object that represents a copy of the data sent from the
|
browser.</param>
|
</member>
|
<member name="M:CefSharp.JavascriptMessageReceivedEventArgs.ConvertMessageTo``1">
|
<summary>
|
Converts the <see cref="P:CefSharp.JavascriptMessageReceivedEventArgs.Message"/> to a specific type using the
|
<see cref="T:CefSharp.ModelBinding.DefaultBinder"/> that CefSharp provides
|
</summary>
|
<typeparam name="T">Type</typeparam>
|
<returns>Type</returns>
|
</member>
|
<member name="M:CefSharp.JavascriptMessageReceivedEventArgs.SetBinder(CefSharp.ModelBinding.IBinder)">
|
<summary>
|
Provide a custom instance of <see cref="T:CefSharp.ModelBinding.IBinder"/>
|
that will be used when <see cref="M:CefSharp.JavascriptMessageReceivedEventArgs.ConvertMessageTo``1"/>
|
is called. You may wish to provide a custom instance in cases where you
|
wish to override the name conversion.
|
e.g. You wish to convert names from camelCase
|
</summary>
|
<param name="binder">binder instance</param>
|
<code>
|
JavascriptMessageReceivedEventArgs.SetBinder(new DefaultBinder(new CamelCaseJavascriptNameConverter()));
|
</code>
|
</member>
|
<member name="T:CefSharp.LoadErrorEventArgs">
|
<summary>
|
Event arguments to the LoadError event handler set up in IWebBrowser.
|
</summary>
|
</member>
|
<member name="M:CefSharp.LoadErrorEventArgs.#ctor(CefSharp.IBrowser,CefSharp.IFrame,CefSharp.CefErrorCode,System.String,System.String)">
|
<summary>
|
LoadErrorEventArgs
|
</summary>
|
<param name="browser">browser</param>
|
<param name="frame">frame</param>
|
<param name="errorCode">error code</param>
|
<param name="errorText">error text</param>
|
<param name="failedUrl">failed url</param>
|
</member>
|
<member name="P:CefSharp.LoadErrorEventArgs.Browser">
|
<summary>
|
The browser object
|
</summary>
|
</member>
|
<member name="P:CefSharp.LoadErrorEventArgs.Frame">
|
<summary>
|
The frame that failed to load.
|
</summary>
|
</member>
|
<member name="P:CefSharp.LoadErrorEventArgs.FailedUrl">
|
<summary>
|
The URL that failed to load.
|
</summary>
|
</member>
|
<member name="P:CefSharp.LoadErrorEventArgs.ErrorCode">
|
<summary>
|
The error code.
|
</summary>
|
</member>
|
<member name="P:CefSharp.LoadErrorEventArgs.ErrorText">
|
<summary>
|
The error text.
|
</summary>
|
</member>
|
<member name="T:CefSharp.LoadingStateChangedEventArgs">
|
<summary>
|
Event arguments to the LoadingStateChanged event handler set up in IWebBrowser.
|
</summary>
|
</member>
|
<member name="P:CefSharp.LoadingStateChangedEventArgs.CanGoForward">
|
<summary>
|
Returns true if the browser can navigate forwards.
|
</summary>
|
</member>
|
<member name="P:CefSharp.LoadingStateChangedEventArgs.CanGoBack">
|
<summary>
|
Returns true if the browser can navigate backwards.
|
</summary>
|
</member>
|
<member name="P:CefSharp.LoadingStateChangedEventArgs.CanReload">
|
<summary>
|
Returns true if the browser can reload.
|
</summary>
|
</member>
|
<member name="P:CefSharp.LoadingStateChangedEventArgs.IsLoading">
|
<summary>
|
Returns true if the browser is loading.
|
</summary>
|
</member>
|
<member name="P:CefSharp.LoadingStateChangedEventArgs.Browser">
|
<summary>
|
Access to the underlying <see cref="T:CefSharp.IBrowser"/> object
|
</summary>
|
</member>
|
<member name="M:CefSharp.LoadingStateChangedEventArgs.#ctor(CefSharp.IBrowser,System.Boolean,System.Boolean,System.Boolean)">
|
<summary>
|
LoadingStateChangedEventArgs
|
</summary>
|
<param name="browser">browser</param>
|
<param name="canGoBack">can go back</param>
|
<param name="canGoForward">can go forward</param>
|
<param name="isLoading">is loading</param>
|
</member>
|
<member name="T:CefSharp.StatusMessageEventArgs">
|
<summary>
|
Event arguments to the StatusMessage event handler set up in IWebBrowser.
|
</summary>
|
</member>
|
<member name="M:CefSharp.StatusMessageEventArgs.#ctor(CefSharp.IBrowser,System.String)">
|
<summary>
|
StatusMessageEventArgs
|
</summary>
|
<param name="browser">browser</param>
|
<param name="value">status message value</param>
|
</member>
|
<member name="P:CefSharp.StatusMessageEventArgs.Browser">
|
<summary>
|
The browser object
|
</summary>
|
</member>
|
<member name="P:CefSharp.StatusMessageEventArgs.Value">
|
<summary>
|
The value of the status message.
|
</summary>
|
</member>
|
<member name="T:CefSharp.TitleChangedEventArgs">
|
<summary>
|
Event arguments to the TitleChanged event handler.
|
</summary>
|
</member>
|
<member name="P:CefSharp.TitleChangedEventArgs.Browser">
|
<summary>
|
Access to the underlying <see cref="T:CefSharp.IBrowser"/> object
|
</summary>
|
</member>
|
<member name="P:CefSharp.TitleChangedEventArgs.Title">
|
<summary>
|
The new title
|
</summary>
|
</member>
|
<member name="M:CefSharp.TitleChangedEventArgs.#ctor(CefSharp.IBrowser,System.String)">
|
<summary>
|
Creates a new TitleChanged event arg
|
</summary>
|
<param name="browser">browser</param>
|
<param name="title">the new title</param>
|
</member>
|
<member name="T:CefSharp.Handler.AccessibilityHandler">
|
<summary>
|
Inherit from this class 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.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.AccessibilityHandler.CefSharp#IAccessibilityHandler#OnAccessibilityLocationChange(CefSharp.IValue)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.AccessibilityHandler.OnAccessibilityLocationChange(CefSharp.IValue)">
|
<summary>
|
Called after renderer process sends accessibility location changes to the browser process.
|
</summary>
|
<param name="value">Updated location info.</param>
|
</member>
|
<member name="M:CefSharp.Handler.AccessibilityHandler.CefSharp#IAccessibilityHandler#OnAccessibilityTreeChange(CefSharp.IValue)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.AccessibilityHandler.OnAccessibilityTreeChange(CefSharp.IValue)">
|
<summary>
|
Called after renderer process sends accessibility tree changes to the browser process.
|
</summary>
|
<param name="value">Updated tree info.</param>
|
</member>
|
<member name="T:CefSharp.Handler.AudioHandler">
|
<summary>
|
Inherit from this class to handle audio events
|
All methods will be called on the CEF UI thread
|
</summary>
|
</member>
|
<member name="P:CefSharp.Handler.AudioHandler.IsDisposed">
|
<summary>
|
Gets a value indicating this <see cref="T:CefSharp.Handler.AudioHandler"/> instance
|
has been disposed.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.AudioHandler.CefSharp#IAudioHandler#GetAudioParameters(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.Structs.AudioParameters@)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.AudioHandler.GetAudioParameters(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.Structs.AudioParameters@)">
|
<summary>
|
Called on the CEF UI thread to allow configuration of audio stream parameters.
|
Audio stream paramaters can optionally be configured by modifying <paramref name="parameters"/>
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="parameters">audio stream parameters can optionally be configured here, they are
|
pre-filled with some sensible defaults.</param>
|
<returns>Return true to proceed with audio stream capture, or false to cancel it</returns>
|
</member>
|
<member name="M:CefSharp.Handler.AudioHandler.CefSharp#IAudioHandler#OnAudioStreamStarted(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.Structs.AudioParameters,System.Int32)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.AudioHandler.OnAudioStreamStarted(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.Structs.AudioParameters,System.Int32)">
|
<summary>
|
Called on a browser audio capture thread when the browser starts streaming audio.
|
OnAudioStreamStopped will always be called after OnAudioStreamStarted; both methods may be called multiple
|
times for the same browser.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="parameters">contains the audio parameters like sample rate and channel layout.
|
Changing the param values will have no effect here.</param>
|
<param name="channels">is the number of channels</param>
|
</member>
|
<member name="M:CefSharp.Handler.AudioHandler.CefSharp#IAudioHandler#OnAudioStreamPacket(CefSharp.IWebBrowser,CefSharp.IBrowser,System.IntPtr,System.Int32,System.Int64)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.AudioHandler.OnAudioStreamPacket(CefSharp.IWebBrowser,CefSharp.IBrowser,System.IntPtr,System.Int32,System.Int64)">
|
<summary>
|
Called on the audio stream thread when a PCM packet is received for the stream.
|
Based on and the <see cref="P:CefSharp.Structs.AudioParameters.ChannelLayout"/> value passed to <see cref="M:CefSharp.Handler.AudioHandler.OnAudioStreamStarted(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.Structs.AudioParameters,System.Int32)"/>
|
you can calculate the size of the <paramref name="data"/> array in bytes.
|
</summary>
|
<param name="chromiumWebBrowser"></param>
|
<param name="browser">the browser object</param>
|
<param name="data">is an array representing the raw PCM data as a floating point type, i.e. 4-byte value(s).</param>
|
<param name="noOfFrames">is the number of frames in the PCM packet</param>
|
<param name="pts">is the presentation timestamp (in milliseconds since the Unix Epoch)
|
and represents the time at which the decompressed packet should be presented to the user</param>
|
</member>
|
<member name="M:CefSharp.Handler.AudioHandler.CefSharp#IAudioHandler#OnAudioStreamStopped(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.AudioHandler.OnAudioStreamStopped(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called on the CEF UI thread when the stream has stopped. OnAudioStreamStopped will always be called after <see cref="M:CefSharp.Handler.AudioHandler.OnAudioStreamStarted(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.Structs.AudioParameters,System.Int32)"/>;
|
both methods may be called multiple times for the same stream.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
</member>
|
<member name="M:CefSharp.Handler.AudioHandler.CefSharp#IAudioHandler#OnAudioStreamError(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.AudioHandler.OnAudioStreamError(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String)">
|
<summary>
|
Called on the CEF UI thread or audio stream thread when an error occurred. During the
|
stream creation phase this callback will be called on the UI thread while
|
in the capturing phase it will be called on the audio stream thread. The
|
stream will be stopped immediately.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="errorMessage">error message</param>
|
</member>
|
<member name="M:CefSharp.Handler.AudioHandler.Dispose(System.Boolean)">
|
<summary>
|
Releases unmanaged and managed resources
|
</summary>
|
<param name="disposing"><see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
|
</member>
|
<member name="M:CefSharp.Handler.AudioHandler.Dispose">
|
<inheritdoc />
|
</member>
|
<member name="T:CefSharp.Handler.BrowserProcessHandler">
|
<summary>
|
Inherit from this class to handle events related to browser process callbacks.
|
The methods of this class will be called on the CEF UI thread unless otherwise indicated. .
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.BrowserProcessHandler.CefSharp#IBrowserProcessHandler#OnContextInitialized">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.BrowserProcessHandler.OnContextInitialized">
|
<summary>
|
Called on the CEF UI thread immediately after the CEF context has been initialized.
|
You can now access the Global RequestContext through Cef.GetGlobalRequestContext() - this is the
|
first place you can set Preferences (e.g. proxy settings, spell check dictionaries).
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.BrowserProcessHandler.CefSharp#IBrowserProcessHandler#OnScheduleMessagePumpWork(System.Int64)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.BrowserProcessHandler.OnScheduleMessagePumpWork(System.Int64)">
|
<summary>
|
Called from any thread when work has been scheduled for the browser process
|
main (UI) thread. This callback is used in combination with CefSettings.
|
ExternalMessagePump and Cef.DoMessageLoopWork() in cases where the CEF
|
message loop must be integrated into an existing application message loop
|
(see additional comments and warnings on Cef.DoMessageLoopWork). This
|
callback should schedule a Cef.DoMessageLoopWork() call to happen on the
|
main (UI) thread.
|
</summary>
|
<param name="delay">is the requested delay in milliseconds. If
|
delay is less than or equal to 0 then the call should happen reasonably soon. If
|
delay is greater than 0 then the call should be scheduled to happen after the
|
specified delay and any currently pending scheduled call should be
|
cancelled.</param>
|
</member>
|
<member name="P:CefSharp.Handler.BrowserProcessHandler.IsDisposed">
|
<summary>
|
IsDisposed
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.BrowserProcessHandler.Dispose(System.Boolean)">
|
<summary>
|
Disposes of the resources
|
</summary>
|
<param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
|
</member>
|
<member name="M:CefSharp.Handler.BrowserProcessHandler.System#IDisposable#Dispose">
|
<inheritdoc/>
|
</member>
|
<member name="T:CefSharp.Handler.ContextMenuHandler">
|
<summary>
|
Inherit from this class to handle context menu events.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.ContextMenuHandler.CefSharp#IContextMenuHandler#OnBeforeContextMenu(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IContextMenuParams,CefSharp.IMenuModel)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.ContextMenuHandler.OnBeforeContextMenu(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IContextMenuParams,CefSharp.IMenuModel)">
|
<summary>
|
Called before a context menu is displayed. The model can be cleared to show no context menu or
|
modified to show a custom menu.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">The frame the request is coming from</param>
|
<param name="parameters">provides information about the context menu state</param>
|
<param name="model">initially contains the default context menu</param>
|
</member>
|
<member name="M:CefSharp.Handler.ContextMenuHandler.CefSharp#IContextMenuHandler#OnContextMenuCommand(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IContextMenuParams,CefSharp.CefMenuCommand,CefSharp.CefEventFlags)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.ContextMenuHandler.OnContextMenuCommand(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IContextMenuParams,CefSharp.CefMenuCommand,CefSharp.CefEventFlags)">
|
<summary>
|
Called to execute a command selected from the context menu. See
|
cef_menu_id_t for the command ids that have default implementations. All
|
user-defined command ids should be between MENU_ID_USER_FIRST and
|
MENU_ID_USER_LAST.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">The frame the request is coming from</param>
|
<param name="parameters">will have the same values as what was passed to</param>
|
<param name="commandId">menu command id</param>
|
<param name="eventFlags">event flags</param>
|
<returns>Return true if the command was handled or false for the default implementation.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ContextMenuHandler.CefSharp#IContextMenuHandler#OnContextMenuDismissed(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.ContextMenuHandler.OnContextMenuDismissed(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)">
|
<summary>
|
Called when the context menu is dismissed irregardless of whether the menu
|
was canceled or a command was selected.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">The frame the request is coming from</param>
|
</member>
|
<member name="M:CefSharp.Handler.ContextMenuHandler.CefSharp#IContextMenuHandler#RunContextMenu(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IContextMenuParams,CefSharp.IMenuModel,CefSharp.IRunContextMenuCallback)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.ContextMenuHandler.RunContextMenu(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IContextMenuParams,CefSharp.IMenuModel,CefSharp.IRunContextMenuCallback)">
|
<summary>
|
Called to allow custom display of the context menu.
|
For custom display return true and execute callback either synchronously or asynchronously with the selected command Id.
|
For default display return false. Do not keep references to parameters or model outside of this callback.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">The frame the request is coming from</param>
|
<param name="parameters">provides information about the context menu state</param>
|
<param name="model">contains the context menu model resulting from OnBeforeContextMenu</param>
|
<param name="callback">the callback to execute for custom display</param>
|
<returns>For custom display return true and execute callback either synchronously or asynchronously with the selected command ID.</returns>
|
</member>
|
<member name="T:CefSharp.Handler.CookieAccessFilter">
|
<summary>
|
Inherit from this class 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.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.CookieAccessFilter.CefSharp#ICookieAccessFilter#CanSendCookie(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.Cookie)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.CookieAccessFilter.CanSendCookie(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.Cookie)">
|
<summary>
|
Called on the CEF IO thread before a resource request is sent.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="request">the request object - cannot be modified in this callback</param>
|
<param name="cookie">the cookie object</param>
|
<returns>Return true if the specified cookie can be sent with the request or false otherwise.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.CookieAccessFilter.CefSharp#ICookieAccessFilter#CanSaveCookie(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse,CefSharp.Cookie)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.CookieAccessFilter.CanSaveCookie(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse,CefSharp.Cookie)">
|
<summary>
|
Called on the CEF IO thread after a resource response is received.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="request">the request object - cannot be modified in this callback</param>
|
<param name="response">the response object - cannot be modified in this callback</param>
|
<param name="cookie">the cookie object</param>
|
<returns>Return true if the specified cookie returned with the response can be saved or false otherwise.</returns>
|
</member>
|
<member name="T:CefSharp.Handler.DialogHandler">
|
<summary>
|
Implement this interface to handle dialog events. The methods of this class will be called on the CEF UI thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.DialogHandler.CefSharp#IDialogHandler#OnFileDialog(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefFileDialogMode,System.String,System.String,System.Collections.Generic.List{System.String},CefSharp.IFileDialogCallback)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.DialogHandler.OnFileDialog(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefFileDialogMode,System.String,System.String,System.Collections.Generic.List{System.String},CefSharp.IFileDialogCallback)">
|
<summary>
|
Runs a file chooser dialog.
|
</summary>
|
<example>
|
To test assign something like TempFileDialogHandler (from CefSharp.Example) to DialogHandler e.g.
|
<code>
|
browser.DialogHandler = new TempFileDialogHandler();
|
</code>
|
Example URL to use for file browsing http://www.cs.tut.fi/~jkorpela/forms/file.html#example
|
Simply click browse, the space next to the browse button should be populated with a randomly generated filename.
|
</example>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="mode">represents the type of dialog to display</param>
|
<param name="title">the title to be used for the dialog. It may be empty to show the default title ("Open" or "Save"
|
depending on the mode).</param>
|
<param name="defaultFilePath">is the path with optional directory and/or file name component that
|
should be initially selected in the dialog.</param>
|
<param name="acceptFilters">are used to restrict the selectable file types and may any combination of
|
(a) valid lower-cased MIME types (e.g. "text/*" or "image/*"),
|
(b) individual file extensions (e.g. ".txt" or ".png"),
|
(c) combined description and file extension delimited using "|" and ";" (e.g. "Image Types|.png;.gif;.jpg").</param>
|
<param name="callback">Callback interface for asynchronous continuation of file dialog requests.</param>
|
<returns>To display a custom dialog return true. To display the default dialog return false.</returns>
|
</member>
|
<member name="T:CefSharp.Handler.DisplayHandler">
|
<summary>
|
Handle events related to browser display state.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.CefSharp#IDisplayHandler#OnAddressChanged(CefSharp.IWebBrowser,CefSharp.AddressChangedEventArgs)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.OnAddressChanged(CefSharp.IWebBrowser,CefSharp.AddressChangedEventArgs)">
|
<summary>
|
Called when a frame's address has changed.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="addressChangedArgs">args</param>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.CefSharp#IDisplayHandler#OnAutoResize(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.Structs.Size)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.OnAutoResize(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.Structs.Size)">
|
<summary>
|
Called when auto-resize is enabled via IBrowserHost.SetAutoResizeEnabled and the contents have auto-resized.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="newSize">will be the desired size in view coordinates</param>
|
<returns>Return true if the resize was handled or false for default handling. </returns>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.CefSharp#IDisplayHandler#OnCursorChange(CefSharp.IWebBrowser,CefSharp.IBrowser,System.IntPtr,CefSharp.Enums.CursorType,CefSharp.Structs.CursorInfo)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.OnCursorChange(CefSharp.IWebBrowser,CefSharp.IBrowser,System.IntPtr,CefSharp.Enums.CursorType,CefSharp.Structs.CursorInfo)">
|
<summary>
|
Called when the browser's cursor has changed.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="cursor">If type is Custom then customCursorInfo will be populated with the custom cursor information</param>
|
<param name="type">cursor type</param>
|
<param name="customCursorInfo">custom cursor Information</param>
|
<returns>Return true if the cursor change was handled or false for default handling.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.CefSharp#IDisplayHandler#OnTitleChanged(CefSharp.IWebBrowser,CefSharp.TitleChangedEventArgs)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.OnTitleChanged(CefSharp.IWebBrowser,CefSharp.TitleChangedEventArgs)">
|
<summary>
|
Called when the page title changes.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="titleChangedArgs">args</param>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.CefSharp#IDisplayHandler#OnFaviconUrlChange(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Collections.Generic.IList{System.String})">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.OnFaviconUrlChange(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Collections.Generic.IList{System.String})">
|
<summary>
|
Called when the page icon changes.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="urls">list of urls where the favicons can be downloaded</param>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.CefSharp#IDisplayHandler#OnFullscreenModeChange(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Boolean)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.OnFullscreenModeChange(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Boolean)">
|
<summary>
|
Called when web content in the page has toggled fullscreen mode. The client is
|
responsible for resizing the browser if desired.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="fullscreen">If true the content will automatically be sized to fill the browser content area.
|
If false the content will automatically return to its original size and position.</param>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.CefSharp#IDisplayHandler#OnLoadingProgressChange(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Double)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.OnLoadingProgressChange(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Double)">
|
<summary>
|
Called when the overall page loading progress has changed
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="progress">ranges from 0.0 to 1.0.</param>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.CefSharp#IDisplayHandler#OnTooltipChanged(CefSharp.IWebBrowser,System.String@)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.OnTooltipChanged(CefSharp.IWebBrowser,System.String@)">
|
<summary>
|
Called when the browser is about to display a tooltip. text contains the
|
text that will be displayed in the tooltip. You can optionally modify text
|
and then return false to allow the browser to display the tooltip.
|
When window rendering is disabled the application is responsible for
|
drawing tooltips and the return value is ignored.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="text">the text that will be displayed in the tooltip</param>
|
<returns>To handle the display of the tooltip yourself return true otherwise return false
|
to allow the browser to display the tooltip.</returns>
|
<remarks>Only called when using Off-screen rendering (WPF and OffScreen)</remarks>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.CefSharp#IDisplayHandler#OnStatusMessage(CefSharp.IWebBrowser,CefSharp.StatusMessageEventArgs)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.OnStatusMessage(CefSharp.IWebBrowser,CefSharp.StatusMessageEventArgs)">
|
<summary>
|
Called when the browser receives a status message.
|
</summary>
|
<param name="chromiumWebBrowser">The <see cref="T:CefSharp.IWebBrowser"/> control this popup is related to.</param>
|
<param name="statusMessageArgs">args</param>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.CefSharp#IDisplayHandler#OnConsoleMessage(CefSharp.IWebBrowser,CefSharp.ConsoleMessageEventArgs)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.DisplayHandler.OnConsoleMessage(CefSharp.IWebBrowser,CefSharp.ConsoleMessageEventArgs)">
|
<summary>
|
Called to display a console message.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="consoleMessageArgs">args</param>
|
<returns>Return true to stop the message from being output to the console.</returns>
|
</member>
|
<member name="T:CefSharp.Handler.DownloadHandler">
|
<summary>
|
Class used to handle file downloads.
|
The methods of this class will called on the CEF UI thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.DownloadHandler.CefSharp#IDownloadHandler#CanDownload(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,System.String)">
|
<inheritdoc />
|
</member>
|
<member name="M:CefSharp.Handler.DownloadHandler.CanDownload(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,System.String)">
|
<summary>
|
Called before a download begins in response to a user-initiated action
|
(e.g. alt + link click or link click that returns a `Content-Disposition:
|
attachment` response from the server).
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance</param>
|
<param name="url">is the target download URL</param>
|
<param name="requestMethod">is the target method (GET, POST, etc)</param>
|
<returns>Return true to proceed with the download or false to cancel the download.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.DownloadHandler.CefSharp#IDownloadHandler#OnBeforeDownload(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.DownloadItem,CefSharp.IBeforeDownloadCallback)">
|
<summary>
|
Called before a download begins.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance</param>
|
<param name="downloadItem">Represents the file being downloaded.</param>
|
<param name="callback">Callback interface used to asynchronously continue a download.</param>
|
</member>
|
<member name="M:CefSharp.Handler.DownloadHandler.OnBeforeDownload(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.DownloadItem,CefSharp.IBeforeDownloadCallback)">
|
<summary>
|
Called before a download begins.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance</param>
|
<param name="downloadItem">Represents the file being downloaded.</param>
|
<param name="callback">Callback interface used to asynchronously continue a download.</param>
|
</member>
|
<member name="M:CefSharp.Handler.DownloadHandler.CefSharp#IDownloadHandler#OnDownloadUpdated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.DownloadItem,CefSharp.IDownloadItemCallback)">
|
<summary>
|
Called when a download's status or progress information has been updated. This may be called multiple times before and after <see cref="M:CefSharp.Handler.DownloadHandler.OnBeforeDownload(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.DownloadItem,CefSharp.IBeforeDownloadCallback)"/>.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance</param>
|
<param name="downloadItem">Represents the file being downloaded.</param>
|
<param name="callback">The callback used to Cancel/Pause/Resume the process</param>
|
</member>
|
<member name="M:CefSharp.Handler.DownloadHandler.OnDownloadUpdated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.DownloadItem,CefSharp.IDownloadItemCallback)">
|
<summary>
|
Called when a download's status or progress information has been updated. This may be called multiple times before and after <see cref="M:CefSharp.Handler.DownloadHandler.OnBeforeDownload(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.DownloadItem,CefSharp.IBeforeDownloadCallback)"/>.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance</param>
|
<param name="downloadItem">Represents the file being downloaded.</param>
|
<param name="callback">The callback used to Cancel/Pause/Resume the process</param>
|
</member>
|
<member name="T:CefSharp.Handler.DragHandler">
|
<summary>
|
Inherit from this class to handle events related to dragging.
|
The methods of this class will be called on the UI thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.DragHandler.CefSharp#IDragHandler#OnDragEnter(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IDragData,CefSharp.Enums.DragOperationsMask)">
|
<summary>
|
Called when an external drag event enters the browser window.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="dragData">contains the drag event data</param>
|
<param name="mask">represents the type of drag operation</param>
|
<returns>Return false for default drag handling behavior or true to cancel the drag event. </returns>
|
</member>
|
<member name="M:CefSharp.Handler.DragHandler.OnDragEnter(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IDragData,CefSharp.Enums.DragOperationsMask)">
|
<summary>
|
Called when an external drag event enters the browser window.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="dragData">contains the drag event data</param>
|
<param name="mask">represents the type of drag operation</param>
|
<returns>Return false for default drag handling behavior or true to cancel the drag event. </returns>
|
</member>
|
<member name="M:CefSharp.Handler.DragHandler.CefSharp#IDragHandler#OnDraggableRegionsChanged(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.Collections.Generic.IList{CefSharp.DraggableRegion})">
|
<summary>
|
Called whenever draggable regions for the browser window change.
|
These can be specified using the '-webkit-app-region: drag/no-drag' CSS-property.
|
If draggable regions are never defined in a document this method will also never be called.
|
If the last draggable region is removed from a document this method will be called with an empty IList.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">The frame</param>
|
<param name="regions">List of <see cref="T:CefSharp.DraggableRegion"/> objects or null if last region was removed.</param>
|
</member>
|
<member name="M:CefSharp.Handler.DragHandler.OnDraggableRegionsChanged(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.Collections.Generic.IList{CefSharp.DraggableRegion})">
|
<summary>
|
Called whenever draggable regions for the browser window change.
|
These can be specified using the '-webkit-app-region: drag/no-drag' CSS-property.
|
If draggable regions are never defined in a document this method will also never be called.
|
If the last draggable region is removed from a document this method will be called with an empty IList.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">The frame</param>
|
<param name="regions">List of <see cref="T:CefSharp.DraggableRegion"/> objects or null if last region was removed.</param>
|
</member>
|
<member name="T:CefSharp.Handler.ExtensionHandler">
|
<summary>
|
Implement this interface to handle events related to browser extensions.
|
The methods of this class will be called on the CEF UI thread.
|
See <see cref="M:CefSharp.IRequestContext.LoadExtension(System.String,System.String,CefSharp.IExtensionHandler)"/> for information about extension loading.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.ExtensionHandler.CefSharp#IExtensionHandler#OnExtensionLoadFailed(CefSharp.CefErrorCode)">
|
<summary>
|
Called if the <see cref="M:CefSharp.IRequestContext.LoadExtension(System.String,System.String,CefSharp.IExtensionHandler)"/> request fails.
|
</summary>
|
<param name="errorCode">error code</param>
|
</member>
|
<member name="M:CefSharp.Handler.ExtensionHandler.OnExtensionLoadFailed(CefSharp.CefErrorCode)">
|
<summary>
|
Called if the <see cref="M:CefSharp.IRequestContext.LoadExtension(System.String,System.String,CefSharp.IExtensionHandler)"/> request fails.
|
</summary>
|
<param name="errorCode">error code</param>
|
</member>
|
<member name="M:CefSharp.Handler.ExtensionHandler.CefSharp#IExtensionHandler#OnExtensionLoaded(CefSharp.IExtension)">
|
<summary>
|
Called if the <see cref="M:CefSharp.IRequestContext.LoadExtension(System.String,System.String,CefSharp.IExtensionHandler)"/> request succeeds.
|
</summary>
|
<param name="extension">is the loaded extension.</param>
|
</member>
|
<member name="M:CefSharp.Handler.ExtensionHandler.OnExtensionLoaded(CefSharp.IExtension)">
|
<summary>
|
Called if the <see cref="M:CefSharp.IRequestContext.LoadExtension(System.String,System.String,CefSharp.IExtensionHandler)"/> request succeeds.
|
</summary>
|
<param name="extension">is the loaded extension.</param>
|
</member>
|
<member name="M:CefSharp.Handler.ExtensionHandler.CefSharp#IExtensionHandler#OnExtensionUnloaded(CefSharp.IExtension)">
|
<summary>
|
Called after the IExtension.Unload request has completed.
|
</summary>
|
<param name="extension">is the unloaded extension</param>
|
</member>
|
<member name="M:CefSharp.Handler.ExtensionHandler.OnExtensionUnloaded(CefSharp.IExtension)">
|
<summary>
|
Called after the IExtension.Unload request has completed.
|
</summary>
|
<param name="extension">is the unloaded extension</param>
|
</member>
|
<member name="M:CefSharp.Handler.ExtensionHandler.CefSharp#IExtensionHandler#OnBeforeBackgroundBrowser(CefSharp.IExtension,System.String,CefSharp.IBrowserSettings)">
|
<summary>
|
Called when an extension needs a browser to host a background script specified via the "background" manifest key.
|
The browser will have no visible window and cannot be displayed. To allow creation of the browser optionally
|
modify newBrowser and settings and return false. To cancel creation of the browser
|
(and consequently cancel load of the background script) return true. Successful creation will be indicated by a call to
|
ILifeSpanHandler.OnAfterCreated, and IBrowserHost.IsBackgroundHost
|
will return true for the resulting browser. See https://developer.chrome.com/extensions/event_pages for more information
|
about extension background script usage.
|
</summary>
|
<param name="extension">is the extension that is loading the background script</param>
|
<param name="url">is an internally generated reference to an HTML page that will be used to
|
load the background script via a script src attribute</param>
|
<param name="settings">browser settings</param>
|
<returns>To cancel creation of the browser (and consequently cancel load of the background script) return true, otherwise return false.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ExtensionHandler.OnBeforeBackgroundBrowser(CefSharp.IExtension,System.String,CefSharp.IBrowserSettings)">
|
<summary>
|
Called when an extension needs a browser to host a background script specified via the "background" manifest key.
|
The browser will have no visible window and cannot be displayed. To allow creation of the browser optionally
|
modify newBrowser and settings and return false. To cancel creation of the browser
|
(and consequently cancel load of the background script) return true. Successful creation will be indicated by a call to
|
ILifeSpanHandler.OnAfterCreated, and IBrowserHost.IsBackgroundHost
|
will return true for the resulting browser. See https://developer.chrome.com/extensions/event_pages for more information
|
about extension background script usage.
|
</summary>
|
<param name="extension">is the extension that is loading the background script</param>
|
<param name="url">is an internally generated reference to an HTML page that will be used to
|
load the background script via a script src attribute</param>
|
<param name="settings">browser settings</param>
|
<returns>To cancel creation of the browser (and consequently cancel load of the background script) return true, otherwise return false.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ExtensionHandler.CefSharp#IExtensionHandler#OnBeforeBrowser(CefSharp.IExtension,CefSharp.IBrowser,CefSharp.IBrowser,System.Int32,System.String,System.Boolean,CefSharp.IWindowInfo,CefSharp.IBrowserSettings)">
|
<summary>
|
Called when an extension API (e.g. chrome.tabs.create) requests creation of a new browser.
|
Successful creation will be indicated by a call to <see cref="M:CefSharp.ILifeSpanHandler.OnAfterCreated(CefSharp.IWebBrowser,CefSharp.IBrowser)"/>.
|
</summary>
|
<param name="extension">the source of the API call</param>
|
<param name="browser">the source of the API call</param>
|
<param name="activeBrowser">may optionally be specified via the windowId property or
|
returned via the GetActiveBrowser() callback and provides the default for the new browser</param>
|
<param name="index">is the position value optionally specified via the index property</param>
|
<param name="url">is the URL that will be loaded in the browser</param>
|
<param name="active">is true if the new browser should be active when opened</param>
|
<param name="windowInfo">optionally modify if you are going to allow creation of the browser</param>
|
<param name="settings">optionally modify browser settings</param>
|
<returns>To cancel creation of the browser return true. To allow creation return false and optionally modify windowInfo and settings</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ExtensionHandler.OnBeforeBrowser(CefSharp.IExtension,CefSharp.IBrowser,CefSharp.IBrowser,System.Int32,System.String,System.Boolean,CefSharp.IWindowInfo,CefSharp.IBrowserSettings)">
|
<summary>
|
Called when an extension API (e.g. chrome.tabs.create) requests creation of a new browser.
|
Successful creation will be indicated by a call to <see cref="M:CefSharp.ILifeSpanHandler.OnAfterCreated(CefSharp.IWebBrowser,CefSharp.IBrowser)"/>.
|
</summary>
|
<param name="extension">the source of the API call</param>
|
<param name="browser">the source of the API call</param>
|
<param name="activeBrowser">may optionally be specified via the windowId property or
|
returned via the GetActiveBrowser() callback and provides the default for the new browser</param>
|
<param name="index">is the position value optionally specified via the index property</param>
|
<param name="url">is the URL that will be loaded in the browser</param>
|
<param name="active">is true if the new browser should be active when opened</param>
|
<param name="windowInfo">optionally modify if you are going to allow creation of the browser</param>
|
<param name="settings">optionally modify browser settings</param>
|
<returns>To cancel creation of the browser return true. To allow creation return false and optionally modify windowInfo and settings</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ExtensionHandler.CefSharp#IExtensionHandler#GetActiveBrowser(CefSharp.IExtension,CefSharp.IBrowser,System.Boolean)">
|
<summary>
|
Called when no tabId is specified to an extension API call that accepts a tabId parameter (e.g. chrome.tabs.*).
|
</summary>
|
<param name="extension">extension the call originates from</param>
|
<param name="browser">browser the call originates from</param>
|
<param name="includeIncognito">Incognito browsers should not be considered unless the source extension has incognito
|
access enabled, inwhich case this will be true</param>
|
<returns>Return the browser that will be acted on by the API call or return null to act on <paramref name="browser"/>.
|
The returned browser must share the same IRequestContext as <paramref name="browser"/></returns>
|
</member>
|
<member name="M:CefSharp.Handler.ExtensionHandler.GetActiveBrowser(CefSharp.IExtension,CefSharp.IBrowser,System.Boolean)">
|
<summary>
|
Called when no tabId is specified to an extension API call that accepts a tabId parameter (e.g. chrome.tabs.*).
|
</summary>
|
<param name="extension">extension the call originates from</param>
|
<param name="browser">browser the call originates from</param>
|
<param name="includeIncognito">Incognito browsers should not be considered unless the source extension has incognito
|
access enabled, inwhich case this will be true</param>
|
<returns>Return the browser that will be acted on by the API call or return null to act on <paramref name="browser"/>.
|
The returned browser must share the same IRequestContext as <paramref name="browser"/></returns>
|
</member>
|
<member name="M:CefSharp.Handler.ExtensionHandler.CefSharp#IExtensionHandler#CanAccessBrowser(CefSharp.IExtension,CefSharp.IBrowser,System.Boolean,CefSharp.IBrowser)">
|
<summary>
|
Called when the tabId associated with <paramref name="targetBrowser"/> is specified to an extension API call that accepts a tabId
|
parameter (e.g. chrome.tabs.*).
|
</summary>
|
<param name="extension">extension the call originates from</param>
|
<param name="browser">browser the call originates from</param>
|
<param name="includeIncognito">Access to incognito browsers should not be allowed unless the source extension has
|
incognito access
|
enabled, in which case this will be true.</param>
|
<param name="targetBrowser"></param>
|
<returns>Return true to allow access of false to deny access.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ExtensionHandler.CanAccessBrowser(CefSharp.IExtension,CefSharp.IBrowser,System.Boolean,CefSharp.IBrowser)">
|
<summary>
|
Called when the tabId associated with <paramref name="targetBrowser"/> is specified to an extension API call that accepts a tabId
|
parameter (e.g. chrome.tabs.*).
|
</summary>
|
<param name="extension">extension the call originates from</param>
|
<param name="browser">browser the call originates from</param>
|
<param name="includeIncognito">Access to incognito browsers should not be allowed unless the source extension has
|
incognito access
|
enabled, in which case this will be true.</param>
|
<param name="targetBrowser"></param>
|
<returns>Return true to allow access of false to deny access.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ExtensionHandler.CefSharp#IExtensionHandler#GetExtensionResource(CefSharp.IExtension,CefSharp.IBrowser,System.String,CefSharp.IGetExtensionResourceCallback)">
|
<summary>
|
Called to retrieve an extension resource that would normally be loaded from disk
|
(e.g. if a file parameter is specified to chrome.tabs.executeScript).
|
Localization substitutions will not be applied to resources handled via this method.
|
</summary>
|
<param name="extension">extension the call originates from</param>
|
<param name="browser">browser the call originates from</param>
|
<param name="file">is the requested relative file path.</param>
|
<param name="callback">callback used to handle custom resource requests</param>
|
<returns>To handle the resource request return true and execute <paramref name="callback"/> either synchronously or asynchronously.
|
For the default behavior which reads the resource from the extension directory on disk return false</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ExtensionHandler.GetExtensionResource(CefSharp.IExtension,CefSharp.IBrowser,System.String,CefSharp.IGetExtensionResourceCallback)">
|
<summary>
|
Called to retrieve an extension resource that would normally be loaded from disk
|
(e.g. if a file parameter is specified to chrome.tabs.executeScript).
|
Localization substitutions will not be applied to resources handled via this method.
|
</summary>
|
<param name="extension">extension the call originates from</param>
|
<param name="browser">browser the call originates from</param>
|
<param name="file">is the requested relative file path.</param>
|
<param name="callback">callback used to handle custom resource requests</param>
|
<returns>To handle the resource request return true and execute <paramref name="callback"/> either synchronously or asynchronously.
|
For the default behavior which reads the resource from the extension directory on disk return false</returns>
|
</member>
|
<member name="P:CefSharp.Handler.ExtensionHandler.IsDisposed">
|
<summary>
|
IsDisposed
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.ExtensionHandler.System#IDisposable#Dispose">
|
<inheritdoc/>
|
</member>
|
<member name="T:CefSharp.Handler.FindHandler">
|
<summary>
|
Implement this interface to handle events related to find results.
|
The methods of this class will be called on the CEF UI thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.FindHandler.CefSharp#IFindHandler#OnFindResult(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Int32,System.Int32,CefSharp.Structs.Rect,System.Int32,System.Boolean)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.FindHandler.OnFindResult(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Int32,System.Int32,CefSharp.Structs.Rect,System.Int32,System.Boolean)">
|
<summary>
|
Called to report find results returned by <see cref="M:CefSharp.IBrowserHost.Find(System.String,System.Boolean,System.Boolean,System.Boolean)"/>
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="identifier">is a unique incremental identifier for the currently active search.</param>
|
<param name="count">is the number of matches currently identified</param>
|
<param name="selectionRect">is the location of where the match was found (in window coordinates)</param>
|
<param name="activeMatchOrdinal">is the current position in the search results</param>
|
<param name="finalUpdate">is true if this is the last find notification.</param>
|
</member>
|
<member name="T:CefSharp.Handler.FocusHandler">
|
<summary>
|
Implement this interface to handle events related to focus.
|
The methods of this class will be called on the CEF UI thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.FocusHandler.CefSharp#IFocusHandler#OnGotFocus(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called when the browser component has received focus.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
</member>
|
<member name="M:CefSharp.Handler.FocusHandler.OnGotFocus(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called when the browser component has received focus.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
</member>
|
<member name="M:CefSharp.Handler.FocusHandler.CefSharp#IFocusHandler#OnSetFocus(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefFocusSource)">
|
<summary>
|
Called when the browser component is requesting focus.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object, do not keep a reference to this object outside of this method</param>
|
<param name="source">Indicates where the focus request is originating from.</param>
|
<returns>Return false to allow the focus to be set or true to cancel setting the focus.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.FocusHandler.OnSetFocus(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefFocusSource)">
|
<summary>
|
Called when the browser component is requesting focus.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object, do not keep a reference to this object outside of this method</param>
|
<param name="source">Indicates where the focus request is originating from.</param>
|
<returns>Return false to allow the focus to be set or true to cancel setting the focus.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.FocusHandler.CefSharp#IFocusHandler#OnTakeFocus(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Boolean)">
|
<summary>
|
Called when the browser component is about to lose focus.
|
For instance, if focus was on the last HTML element and the user pressed the TAB key.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="next">Will be true if the browser is giving focus to the next component
|
and false if the browser is giving focus to the previous component.</param>
|
</member>
|
<member name="M:CefSharp.Handler.FocusHandler.OnTakeFocus(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Boolean)">
|
<summary>
|
Called when the browser component is about to lose focus.
|
For instance, if focus was on the last HTML element and the user pressed the TAB key.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="next">Will be true if the browser is giving focus to the next component
|
and false if the browser is giving focus to the previous component.</param>
|
</member>
|
<member name="T:CefSharp.Handler.FrameHandler">
|
<summary>
|
Inherit from this class to handle frame events
|
All methods will be called on the CEF UI thread
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.FrameHandler.CefSharp#IFrameHandler#OnFrameAttached(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.Boolean)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.FrameHandler.OnFrameAttached(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.Boolean)">
|
<summary>
|
Called when a frame can begin routing commands to/from the associated
|
renderer process. Any commands that were queued have now been dispatched.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">the frame object</param>
|
<param name="reattached">will be true if the frame was re-attached after exiting the BackForwardCache.</param>
|
</member>
|
<member name="M:CefSharp.Handler.FrameHandler.CefSharp#IFrameHandler#OnFrameCreated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.FrameHandler.OnFrameCreated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)">
|
<summary>
|
Called when a new frame is created. This will be the first notification
|
that references <paramref name="frame"/>. Any commands that require transport to the
|
associated renderer process (LoadRequest, SendProcessMessage, GetSource,
|
etc.) will be queued until OnFrameAttached is called for <paramref name="frame"/>.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">the frame object</param>
|
</member>
|
<member name="M:CefSharp.Handler.FrameHandler.CefSharp#IFrameHandler#OnFrameDetached(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.FrameHandler.OnFrameDetached(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)">
|
<summary>
|
Called when a frame loses its connection to the renderer process and will
|
be destroyed. Any pending or future commands will be discarded and
|
<see cref="P:CefSharp.IFrame.IsValid"/> will now return <c>false</c> for <paramref name="frame"/>. If called after
|
<see cref="M:CefSharp.ILifeSpanHandler.OnBeforeClose(CefSharp.IWebBrowser,CefSharp.IBrowser)"/> during browser destruction then
|
<see cref="P:CefSharp.IBrowser.IsValid"/> will return <c>false</c> for <paramref name="browser"/>.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">the frame object</param>
|
</member>
|
<member name="M:CefSharp.Handler.FrameHandler.CefSharp#IFrameHandler#OnMainFrameChanged(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IFrame)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.FrameHandler.OnMainFrameChanged(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IFrame)">
|
<summary>
|
Called when the main frame changes due to one of the following:
|
- (a) initial browser creation
|
- (b) final browser destruction
|
- (c) cross-origin navigation
|
- (d) re-navigation after renderer process termination (due to crashes, etc).
|
|
<paramref name="oldFrame"/> will be <c>null</c> and <paramref name="newFrame"/> will be non-<c>null</c> when a main frame is assigned
|
to <paramref name="browser"/> for the first time.
|
<paramref name="oldFrame"/> will be non-<c>null</c> and <paramref name="newFrame"/> will be <c>null</c> when a main frame is
|
removed from <paramref name="browser"/> for the last time.
|
Both <paramref name="oldFrame"/> and <paramref name="newFrame"/> will be non-<c>null</c>for cross-origin
|
navigations or re-navigation after renderer process termination.
|
This method will be called after <see cref="M:CefSharp.Handler.FrameHandler.OnFrameCreated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)"/> for <paramref name="newFrame"/> and/or after
|
<see cref="M:CefSharp.Handler.FrameHandler.OnFrameDetached(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)"/> for <paramref name="oldFrame"/>. If called after
|
<see cref="M:CefSharp.ILifeSpanHandler.OnBeforeClose(CefSharp.IWebBrowser,CefSharp.IBrowser)"/> during browser destruction then
|
<see cref="P:CefSharp.IBrowser.IsValid"/> will return <c>false</c> for <paramref name="browser"/>.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="oldFrame">the old frame object</param>
|
<param name="newFrame">the new frame object</param>
|
</member>
|
<member name="T:CefSharp.Handler.JsDialogHandler">
|
<summary>
|
Inherit from this class to handle events related to JavaScript dialogs.
|
The methods of this class will be called on the CEF UI thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.JsDialogHandler.CefSharp#IJsDialogHandler#OnJSDialog(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,CefSharp.CefJsDialogType,System.String,System.String,CefSharp.IJsDialogCallback,System.Boolean@)">
|
<summary>
|
Called to run a JavaScript dialog.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="originUrl">originating url</param>
|
<param name="dialogType">Dialog Type</param>
|
<param name="messageText">Message Text</param>
|
<param name="defaultPromptText">value will be specified for prompt dialogs only</param>
|
<param name="callback">Callback can be executed inline or in an async fashion</param>
|
<param name="suppressMessage">Set suppressMessage to true and return false to suppress the message (suppressing messages is preferable to immediately executing the callback as this is used to detect presumably malicious behavior like spamming alert messages in onbeforeunload). Set suppressMessage to false and return false to use the default implementation (the default implementation will show one modal dialog at a time and suppress any additional dialog requests until the displayed dialog is dismissed).</param>
|
<returns>Return true if the application will use a custom dialog or if the callback has been executed immediately. Custom dialogs may be either modal or modeless. If a custom dialog is used the application must execute |callback| once the custom dialog is dismissed.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.JsDialogHandler.OnJSDialog(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,CefSharp.CefJsDialogType,System.String,System.String,CefSharp.IJsDialogCallback,System.Boolean@)">
|
<summary>
|
Called to run a JavaScript dialog.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="originUrl">originating url</param>
|
<param name="dialogType">Dialog Type</param>
|
<param name="messageText">Message Text</param>
|
<param name="defaultPromptText">value will be specified for prompt dialogs only</param>
|
<param name="callback">Callback can be executed inline or in an async fashion</param>
|
<param name="suppressMessage">Set suppressMessage to true and return false to suppress the message (suppressing messages is preferable to immediately executing the callback as this is used to detect presumably malicious behavior like spamming alert messages in onbeforeunload). Set suppressMessage to false and return false to use the default implementation (the default implementation will show one modal dialog at a time and suppress any additional dialog requests until the displayed dialog is dismissed).</param>
|
<returns>Return true if the application will use a custom dialog or if the callback has been executed immediately. Custom dialogs may be either modal or modeless. If a custom dialog is used the application must execute |callback| once the custom dialog is dismissed.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.JsDialogHandler.CefSharp#IJsDialogHandler#OnBeforeUnloadDialog(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,System.Boolean,CefSharp.IJsDialogCallback)">
|
<summary>
|
Called to run a dialog asking the user if they want to leave a page. Return false to use the default dialog implementation.
|
Return true if the application will use a custom dialog or if the callback has been executed immediately.
|
Custom dialogs may be either modal or modeless. If a custom dialog is used the application must execute <paramref name="callback"/>
|
once the custom dialog is dismissed.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="messageText">message text (optional)</param>
|
<param name="isReload">indicates a page reload</param>
|
<param name="callback">Callback can be executed inline or in an async fashion</param>
|
<returns>Return false to use the default dialog implementation otherwise return true to handle with your own custom implementation.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.JsDialogHandler.OnBeforeUnloadDialog(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,System.Boolean,CefSharp.IJsDialogCallback)">
|
<summary>
|
Called to run a dialog asking the user if they want to leave a page. Return false to use the default dialog implementation.
|
Return true if the application will use a custom dialog or if the callback has been executed immediately.
|
Custom dialogs may be either modal or modeless. If a custom dialog is used the application must execute <paramref name="callback"/>
|
once the custom dialog is dismissed.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="messageText">message text (optional)</param>
|
<param name="isReload">indicates a page reload</param>
|
<param name="callback">Callback can be executed inline or in an async fashion</param>
|
<returns>Return false to use the default dialog implementation otherwise return true to handle with your own custom implementation.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.JsDialogHandler.CefSharp#IJsDialogHandler#OnResetDialogState(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called to cancel any pending dialogs and reset any saved dialog state. Will
|
be called due to events like page navigation irregardless of whether any
|
dialogs are currently pending.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
</member>
|
<member name="M:CefSharp.Handler.JsDialogHandler.OnResetDialogState(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called to cancel any pending dialogs and reset any saved dialog state. Will
|
be called due to events like page navigation irregardless of whether any
|
dialogs are currently pending.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
</member>
|
<member name="M:CefSharp.Handler.JsDialogHandler.CefSharp#IJsDialogHandler#OnDialogClosed(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called when the default implementation dialog is closed.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
</member>
|
<member name="M:CefSharp.Handler.JsDialogHandler.OnDialogClosed(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called when the default implementation dialog is closed.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
</member>
|
<member name="T:CefSharp.Handler.KeyboardHandler">
|
<summary>
|
Inherit from this class to handle events related to keyboard input.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.KeyboardHandler.CefSharp#IKeyboardHandler#OnPreKeyEvent(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.KeyType,System.Int32,System.Int32,CefSharp.CefEventFlags,System.Boolean,System.Boolean@)">
|
<summary>
|
Called before a keyboard event is sent to the renderer.
|
Return true if the event was handled or false
|
otherwise. If the event will be handled in <see cref="M:CefSharp.Handler.KeyboardHandler.OnKeyEvent(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.KeyType,System.Int32,System.Int32,CefSharp.CefEventFlags,System.Boolean)"/> as a keyboard
|
shortcut set isKeyboardShortcut to true and return false.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance.</param>
|
<param name="type">Whether this was a key up/down/raw/etc...</param>
|
<param name="windowsKeyCode">
|
The Windows key code for the key event. This value is used by the DOM
|
specification. Sometimes it comes directly from the event (i.e. on
|
Windows) and sometimes it's determined using a mapping function. See
|
WebCore/platform/chromium/KeyboardCodes.h for the list of values.
|
</param>
|
<param name="nativeKeyCode">The native key code. On Windows this appears to be in the format of WM_KEYDOWN/WM_KEYUP/etc... lParam data.</param>
|
<param name="modifiers">What other modifier keys are currently down: Shift/Control/Alt/OS X Command/etc...</param>
|
<param name="isSystemKey">
|
Indicates whether the event is considered a "system key" event (see
|
http://msdn.microsoft.com/en-us/library/ms646286(VS.85).aspx for details).
|
</param>
|
<param name="isKeyboardShortcut">See the summary for an explanation of when to set this to true.</param>
|
<returns>Returns true if the event was handled or false otherwise.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.KeyboardHandler.OnPreKeyEvent(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.KeyType,System.Int32,System.Int32,CefSharp.CefEventFlags,System.Boolean,System.Boolean@)">
|
<summary>
|
Called before a keyboard event is sent to the renderer.
|
Return true if the event was handled or false
|
otherwise. If the event will be handled in <see cref="M:CefSharp.Handler.KeyboardHandler.OnKeyEvent(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.KeyType,System.Int32,System.Int32,CefSharp.CefEventFlags,System.Boolean)"/> as a keyboard
|
shortcut set isKeyboardShortcut to true and return false.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance.</param>
|
<param name="type">Whether this was a key up/down/raw/etc...</param>
|
<param name="windowsKeyCode">
|
The Windows key code for the key event. This value is used by the DOM
|
specification. Sometimes it comes directly from the event (i.e. on
|
Windows) and sometimes it's determined using a mapping function. See
|
WebCore/platform/chromium/KeyboardCodes.h for the list of values.
|
</param>
|
<param name="nativeKeyCode">The native key code. On Windows this appears to be in the format of WM_KEYDOWN/WM_KEYUP/etc... lParam data.</param>
|
<param name="modifiers">What other modifier keys are currently down: Shift/Control/Alt/OS X Command/etc...</param>
|
<param name="isSystemKey">
|
Indicates whether the event is considered a "system key" event (see
|
http://msdn.microsoft.com/en-us/library/ms646286(VS.85).aspx for details).
|
</param>
|
<param name="isKeyboardShortcut">See the summary for an explanation of when to set this to true.</param>
|
<returns>Returns true if the event was handled or false otherwise.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.KeyboardHandler.CefSharp#IKeyboardHandler#OnKeyEvent(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.KeyType,System.Int32,System.Int32,CefSharp.CefEventFlags,System.Boolean)">
|
<summary>
|
Called after the renderer and JavaScript in the page has had a chance to
|
handle the event. Return true if the keyboard event was handled or false otherwise.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance.</param>
|
<param name="type">Whether this was a key up/down/raw/etc...</param>
|
<param name="windowsKeyCode">
|
The Windows key code for the key event. This value is used by the DOM
|
specification. Sometimes it comes directly from the event (i.e. on
|
Windows) and sometimes it's determined using a mapping function. See
|
WebCore/platform/chromium/KeyboardCodes.h for the list of values.
|
</param>
|
<param name="nativeKeyCode">The native key code. On Windows this appears to be in the format of WM_KEYDOWN/WM_KEYUP/etc... lParam data.</param>
|
<param name="modifiers">What other modifier keys are currently down: Shift/Control/Alt/OS X Command/etc...</param>
|
<param name="isSystemKey">
|
Indicates whether the event is considered a "system key" event (see
|
http://msdn.microsoft.com/en-us/library/ms646286(VS.85).aspx for details).
|
</param>
|
<returns>Return true if the keyboard event was handled or false otherwise.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.KeyboardHandler.OnKeyEvent(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.KeyType,System.Int32,System.Int32,CefSharp.CefEventFlags,System.Boolean)">
|
<summary>
|
Called after the renderer and JavaScript in the page has had a chance to
|
handle the event. Return true if the keyboard event was handled or false otherwise.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance.</param>
|
<param name="type">Whether this was a key up/down/raw/etc...</param>
|
<param name="windowsKeyCode">
|
The Windows key code for the key event. This value is used by the DOM
|
specification. Sometimes it comes directly from the event (i.e. on
|
Windows) and sometimes it's determined using a mapping function. See
|
WebCore/platform/chromium/KeyboardCodes.h for the list of values.
|
</param>
|
<param name="nativeKeyCode">The native key code. On Windows this appears to be in the format of WM_KEYDOWN/WM_KEYUP/etc... lParam data.</param>
|
<param name="modifiers">What other modifier keys are currently down: Shift/Control/Alt/OS X Command/etc...</param>
|
<param name="isSystemKey">
|
Indicates whether the event is considered a "system key" event (see
|
http://msdn.microsoft.com/en-us/library/ms646286(VS.85).aspx for details).
|
</param>
|
<returns>Return true if the keyboard event was handled or false otherwise.</returns>
|
</member>
|
<member name="T:CefSharp.Handler.LifeSpanHandler">
|
<summary>
|
Default implementation of <see cref="T:CefSharp.ILifeSpanHandler"/>. This class provides default implementations of the methods from
|
<see cref="T:CefSharp.ILifeSpanHandler"/>, therefore providing a convenience base class for a custom implementation.
|
You need only override the methods you require.
|
IMPORTANT: <see cref="M:CefSharp.ILifeSpanHandler.DoClose(CefSharp.IWebBrowser,CefSharp.IBrowser)"/> behaviour of this implementation differs
|
from the default, the WM_CLOSE message is only sent by default for popups (return false), for the main browser
|
we return true to cancel this behaviour.
|
</summary>
|
<seealso cref="T:CefSharp.ILifeSpanHandler"/>
|
</member>
|
<member name="M:CefSharp.Handler.LifeSpanHandler.CefSharp#ILifeSpanHandler#DoClose(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.LifeSpanHandler.DoClose(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called when a browser has recieved a request to close. This may result
|
directly from a call to CefBrowserHost::CloseBrowser() or indirectly if the
|
browser is a top-level OS window created by CEF and the user attempts to
|
close the window. This method will be called after the JavaScript
|
'onunload' event has been fired. It will not be called for browsers after
|
the associated OS window has been destroyed (for those browsers it is no
|
longer possible to cancel the close).
|
|
If CEF created an OS window for the browser returning false will send an OS
|
close notification to the browser window's top-level owner (e.g. WM_CLOSE
|
on Windows). If no OS window exists (window rendering disabled) returning false
|
will cause the browser object to be destroyed immediately. Return true if
|
the browser is parented to another window and that other window needs to
|
receive close notification via some non-standard technique.
|
|
!!IMPORTANT!!: Behaviour of this implementation differs from the default,
|
the WM_CLOSE message is only sent by default for popups (return false),
|
for the main browser we return true to cancel this behaviour.
|
|
If an application provides its own top-level window it should handle OS
|
close notifications by calling CefBrowserHost::CloseBrowser(false) instead
|
of immediately closing (see the example below). This gives CEF an
|
opportunity to process the 'onbeforeunload' event and optionally cancel the
|
close before DoClose() is called.
|
|
The CefLifeSpanHandler::OnBeforeClose() method will be called immediately
|
before the browser object is destroyed. The application should only exit
|
after OnBeforeClose() has been called for all existing browsers.
|
|
If the browser represents a modal window and a custom modal loop
|
implementation was provided in CefLifeSpanHandler::RunModal() this callback
|
should be used to restore the opener window to a usable state.
|
|
By way of example consider what should happen during window close when the
|
browser is parented to an application-provided top-level OS window.
|
1. User clicks the window close button which sends an OS close
|
notification (e.g. WM_CLOSE on Windows, performClose: on OS-X and
|
"delete_event" on Linux).
|
2. Application's top-level window receives the close notification and:
|
A. Calls CefBrowserHost::CloseBrowser(false).
|
B. Cancels the window close.
|
3. JavaScript 'onbeforeunload' handler executes and shows the close
|
confirmation dialog (which can be overridden via
|
CefJSDialogHandler::OnBeforeUnloadDialog()).
|
4. User approves the close.
|
5. JavaScript 'onunload' handler executes.
|
6. Application's DoClose() handler is called. Application will:
|
A. Set a flag to indicate that the next close attempt will be allowed.
|
B. Return false.
|
7. CEF sends an OS close notification.
|
8. Application's top-level window receives the OS close notification and
|
allows the window to close based on the flag from #6B.
|
9. Browser OS window is destroyed.
|
10. Application's CefLifeSpanHandler::OnBeforeClose() handler is called and
|
the browser object is destroyed.
|
11. Application exits by calling CefQuitMessageLoop() if no other browsers
|
exist.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance - check if IsDisposed as it's possible when the browser is disposing</param>
|
<returns>For default behaviour return false</returns>
|
</member>
|
<member name="M:CefSharp.Handler.LifeSpanHandler.CefSharp#ILifeSpanHandler#OnAfterCreated(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.LifeSpanHandler.OnAfterCreated(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called after a new browser is created.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance</param>
|
</member>
|
<member name="M:CefSharp.Handler.LifeSpanHandler.CefSharp#ILifeSpanHandler#OnBeforeClose(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.LifeSpanHandler.OnBeforeClose(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called before a CefBrowser window (either the main browser for <see cref="T:CefSharp.IWebBrowser"/>,
|
or one of its children)
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance</param>
|
</member>
|
<member name="M:CefSharp.Handler.LifeSpanHandler.CefSharp#ILifeSpanHandler#OnBeforePopup(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.String,System.String,CefSharp.WindowOpenDisposition,System.Boolean,CefSharp.IPopupFeatures,CefSharp.IWindowInfo,CefSharp.IBrowserSettings,System.Boolean@,CefSharp.IWebBrowser@)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.LifeSpanHandler.OnBeforePopup(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.String,System.String,CefSharp.WindowOpenDisposition,System.Boolean,CefSharp.IPopupFeatures,CefSharp.IWindowInfo,CefSharp.IBrowserSettings,System.Boolean@,CefSharp.IWebBrowser@)">
|
<summary>
|
Called before a popup window is created. By default the popup (browser) is created in a new native window.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance that launched this popup.</param>
|
<param name="frame">The HTML frame that launched this popup.</param>
|
<param name="targetUrl">The URL of the popup content. (This may be empty/null)</param>
|
<param name="targetFrameName">The name of the popup. (This may be empty/null)</param>
|
<param name="targetDisposition">The value indicates where the user intended to
|
open the popup (e.g. current tab, new tab, etc)</param>
|
<param name="userGesture">The value will be true if the popup was opened via explicit user gesture
|
(e.g. clicking a link) or false if the popup opened automatically (e.g. via the DomContentLoaded event).</param>
|
<param name="popupFeatures"> structure contains additional information about the requested popup window</param>
|
<param name="windowInfo">window information</param>
|
<param name="browserSettings">browser settings, defaults to source browsers</param>
|
<param name="noJavascriptAccess">value indicates whether the new browser window should be scriptable
|
and in the same process as the source browser.</param>
|
<param name="newBrowser">
|
EXPERIMENTAL - Low level this allows for assigning the CefClient instance associated with the new ChromiumWebBrowser instance to the CefClient param of the CefLifeSpanHandler::OnBeforeBrowser method.
|
This allows for all the handlers, LifeSpanHandler, DisplayHandler, etc to be associated with the CefClient of the new ChromiumWebBrowser instance to be associated with the popup (browser).
|
WPF/WinForms specific code is still required to host the popup (browser) in the new ChromiumWebBrowser instance.
|
Set to null for default behaviour. If you return true (cancel popup creation) then his property **MUST** be null, an exception will be thrown otherwise.
|
</param>
|
<returns>
|
By default the popup (browser) is opened in a new native window. If you return true then creation of the popup (browser) is cancelled, no further action will occur.
|
Otherwise return false to allow creation of the popup (browser).
|
</returns>
|
<remarks>
|
If you return true and set <paramref name="newBrowser"/> to not null then an exception will be thrown as creation of the popup (browser) was cancelled.
|
WinForms - To host the popup (browser) in a TAB/Custom Window see https://github.com/cefsharp/CefSharp/wiki/General-Usage#winforms---hosting-popup-using-tab-control for an easy method.
|
WPF - For an example of hosting the popup (browser) in a custom window see https://github.com/cefsharp/CefSharp/wiki/General-Usage#wpf---hosting-popup-in-new-window-experimental
|
Same can be applied for hosting the popup in a TAB.
|
This method is still EXPERIMENTAL and will likely require upstream bug fixes in CEF (https://bitbucket.org/chromiumembedded/cef).
|
</remarks>
|
</member>
|
<member name="T:CefSharp.Handler.LoadHandler">
|
<summary>
|
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.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.LoadHandler.CefSharp#ILoadHandler#OnLoadingStateChange(CefSharp.IWebBrowser,CefSharp.LoadingStateChangedEventArgs)">
|
<summary>
|
Called when the loading state has changed. This callback will be executed twice
|
once when loading is initiated either programmatically or by user action,
|
and once when loading is terminated due to completion, cancellation of failure.
|
This method will be called on the CEF UI thread.
|
Blocking this thread will likely cause your UI to become unresponsive and/or hang.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="loadingStateChangedArgs">args</param>
|
</member>
|
<member name="M:CefSharp.Handler.LoadHandler.OnLoadingStateChange(CefSharp.IWebBrowser,CefSharp.LoadingStateChangedEventArgs)">
|
<summary>
|
Called when the loading state has changed. This callback will be executed twice
|
once when loading is initiated either programmatically or by user action,
|
and once when loading is terminated due to completion, cancellation of failure.
|
This method will be called on the CEF UI thread.
|
Blocking this thread will likely cause your UI to become unresponsive and/or hang.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="loadingStateChangedArgs">args</param>
|
</member>
|
<member name="M:CefSharp.Handler.LoadHandler.CefSharp#ILoadHandler#OnFrameLoadStart(CefSharp.IWebBrowser,CefSharp.FrameLoadStartEventArgs)">
|
<summary>
|
Called when the browser begins loading a frame.
|
The <see cref="P:CefSharp.FrameLoadEndEventArgs.Frame"/> value will never be empty
|
Check the <see cref="P:CefSharp.IFrame.IsMain"/> method to see if this frame is the main frame.
|
Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended.
|
This method may not be called for a particular frame if the load request for that frame fails.
|
For notification of overall browser load status use <see cref="M:CefSharp.Handler.LoadHandler.OnLoadingStateChange(CefSharp.IWebBrowser,CefSharp.LoadingStateChangedEventArgs)"/> instead.
|
This method will be called on the CEF UI thread.
|
Blocking this thread will likely cause your UI to become unresponsive and/or hang.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="frameLoadStartArgs">args</param>
|
<remarks>Whilst thist may seem like a logical place to execute js, it's called before the DOM has been loaded, implement
|
<see cref="M:CefSharp.IRenderProcessMessageHandler.OnContextCreated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)"/> as it's called when the underlying V8Context is created
|
(Only called for the main frame at this stage)</remarks>
|
</member>
|
<member name="M:CefSharp.Handler.LoadHandler.OnFrameLoadStart(CefSharp.IWebBrowser,CefSharp.FrameLoadStartEventArgs)">
|
<summary>
|
Called when the browser begins loading a frame.
|
The <see cref="P:CefSharp.FrameLoadEndEventArgs.Frame"/> value will never be empty
|
Check the <see cref="P:CefSharp.IFrame.IsMain"/> method to see if this frame is the main frame.
|
Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended.
|
This method may not be called for a particular frame if the load request for that frame fails.
|
For notification of overall browser load status use <see cref="M:CefSharp.Handler.LoadHandler.OnLoadingStateChange(CefSharp.IWebBrowser,CefSharp.LoadingStateChangedEventArgs)"/> instead.
|
This method will be called on the CEF UI thread.
|
Blocking this thread will likely cause your UI to become unresponsive and/or hang.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="frameLoadStartArgs">args</param>
|
<remarks>Whilst thist may seem like a logical place to execute js, it's called before the DOM has been loaded, implement
|
<see cref="M:CefSharp.IRenderProcessMessageHandler.OnContextCreated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)"/> as it's called when the underlying V8Context is created
|
(Only called for the main frame at this stage)</remarks>
|
</member>
|
<member name="M:CefSharp.Handler.LoadHandler.CefSharp#ILoadHandler#OnFrameLoadEnd(CefSharp.IWebBrowser,CefSharp.FrameLoadEndEventArgs)">
|
<summary>
|
Called when the browser is done loading a frame.
|
The <see cref="P:CefSharp.FrameLoadEndEventArgs.Frame"/> value will never be empty
|
Check the <see cref="P:CefSharp.IFrame.IsMain"/> method to see if this frame is the main frame.
|
Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended.
|
This method will always be called for all frames irrespective of whether the request completes successfully.
|
This method will be called on the CEF UI thread.
|
Blocking this thread will likely cause your UI to become unresponsive and/or hang.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="frameLoadEndArgs">args</param>
|
</member>
|
<member name="M:CefSharp.Handler.LoadHandler.OnFrameLoadEnd(CefSharp.IWebBrowser,CefSharp.FrameLoadEndEventArgs)">
|
<summary>
|
Called when the browser is done loading a frame.
|
The <see cref="P:CefSharp.FrameLoadEndEventArgs.Frame"/> value will never be empty
|
Check the <see cref="P:CefSharp.IFrame.IsMain"/> method to see if this frame is the main frame.
|
Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended.
|
This method will always be called for all frames irrespective of whether the request completes successfully.
|
This method will be called on the CEF UI thread.
|
Blocking this thread will likely cause your UI to become unresponsive and/or hang.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="frameLoadEndArgs">args</param>
|
</member>
|
<member name="M:CefSharp.Handler.LoadHandler.CefSharp#ILoadHandler#OnLoadError(CefSharp.IWebBrowser,CefSharp.LoadErrorEventArgs)">
|
<summary>
|
Called when the resource load for a navigation fails or is canceled.
|
<see cref="P:CefSharp.LoadErrorEventArgs.ErrorCode"/> is the error code number, <see cref="P:CefSharp.LoadErrorEventArgs.ErrorText"/> is the error text and
|
<see cref="P:CefSharp.LoadErrorEventArgs.FailedUrl"/> is the URL that failed to load. See net\base\net_error_list.h
|
for complete descriptions of the error codes.
|
This method will be called on the CEF UI thread.
|
Blocking this thread will likely cause your UI to become unresponsive and/or hang.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="loadErrorArgs">args</param>
|
</member>
|
<member name="M:CefSharp.Handler.LoadHandler.OnLoadError(CefSharp.IWebBrowser,CefSharp.LoadErrorEventArgs)">
|
<summary>
|
Called when the resource load for a navigation fails or is canceled.
|
<see cref="P:CefSharp.LoadErrorEventArgs.ErrorCode"/> is the error code number, <see cref="P:CefSharp.LoadErrorEventArgs.ErrorText"/> is the error text and
|
<see cref="P:CefSharp.LoadErrorEventArgs.FailedUrl"/> is the URL that failed to load. See net\base\net_error_list.h
|
for complete descriptions of the error codes.
|
This method will be called on the CEF UI thread.
|
Blocking this thread will likely cause your UI to become unresponsive and/or hang.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="loadErrorArgs">args</param>
|
</member>
|
<member name="T:CefSharp.Handler.PermissionHandler">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.PermissionHandler.CefSharp#IPermissionHandler#OnRequestMediaAccessPermission(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.String,CefSharp.MediaAccessPermissionType,CefSharp.IMediaAccessCallback)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.PermissionHandler.OnRequestMediaAccessPermission(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.String,CefSharp.MediaAccessPermissionType,CefSharp.IMediaAccessCallback)">
|
<summary>
|
Called when a page requests permission to access media.
|
With the Chrome runtime, default handling will display the
|
permission request UI.With the Alloy runtime, default handling will deny
|
the request.This method will not be called if the "--enable-media-stream"
|
command-line switch is used to grant all permissions.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">The browser object</param>
|
<param name="frame">The frame object</param>
|
<param name="requestingOrigin">is the URL origin requesting permission.</param>
|
<param name="requestedPermissions">is a combination of values that represent the requested permissions</param>
|
<param name="callback">Callback interface used for asynchronous continuation of media access.</param>
|
<returns>Return true and call CefMediaAccessCallback methods either in this method or at a later time to continue or cancel the request.
|
Return false to proceed with default handling.
|
</returns>
|
</member>
|
<member name="M:CefSharp.Handler.PermissionHandler.CefSharp#IPermissionHandler#OnShowPermissionPrompt(CefSharp.IWebBrowser,CefSharp.IBrowser,System.UInt64,System.String,CefSharp.PermissionRequestType,CefSharp.IPermissionPromptCallback)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.PermissionHandler.OnShowPermissionPrompt(CefSharp.IWebBrowser,CefSharp.IBrowser,System.UInt64,System.String,CefSharp.PermissionRequestType,CefSharp.IPermissionPromptCallback)">
|
<summary>
|
Called when a page should show a permission prompt.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">The browser object</param>
|
<param name="promptId">Uniquely identifies the prompt.</param>
|
<param name="requestingOrigin">Is the URL origin requesting permission.</param>
|
<param name="requestedPermissions">Is a combination of values from <see cref="T:CefSharp.PermissionRequestType"/> that represent the requested permissions.</param>
|
<param name="callback">Callback interface used for asynchronous continuation of permission prompts.</param>
|
<returns>Return true and call <see cref="M:CefSharp.IPermissionPromptCallback.Continue(CefSharp.PermissionRequestResult)"/> either in this method or at a later time to continue or cancel the request.
|
Return false to proceed with default handling.
|
With the Chrome runtime, default handling
|
will display the permission prompt UI. With the Alloy runtime, default
|
handling is <see cref="F:CefSharp.PermissionRequestResult.Ignore"/>.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.PermissionHandler.CefSharp#IPermissionHandler#OnDismissPermissionPrompt(CefSharp.IWebBrowser,CefSharp.IBrowser,System.UInt64,CefSharp.PermissionRequestResult)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.PermissionHandler.OnDismissPermissionPrompt(CefSharp.IWebBrowser,CefSharp.IBrowser,System.UInt64,CefSharp.PermissionRequestResult)">
|
<summary>
|
Called when a permission prompt handled via <see cref="M:CefSharp.IPermissionHandler.OnShowPermissionPrompt(CefSharp.IWebBrowser,CefSharp.IBrowser,System.UInt64,System.String,CefSharp.PermissionRequestType,CefSharp.IPermissionPromptCallback)"/> is dismissed.
|
<paramref name="result"/> will be the value passed to
|
<see cref="M:CefSharp.IPermissionPromptCallback.Continue(CefSharp.PermissionRequestResult)"/> or <see cref="F:CefSharp.PermissionRequestResult.Ignore"/> if
|
the dialog was dismissed for other reasons such as navigation, browser
|
closure, etc. This method will not be called if <see cref="M:CefSharp.IPermissionHandler.OnShowPermissionPrompt(CefSharp.IWebBrowser,CefSharp.IBrowser,System.UInt64,System.String,CefSharp.PermissionRequestType,CefSharp.IPermissionPromptCallback)"/>
|
returned false for <paramref name="promptId"/>.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">The browser object</param>
|
<param name="promptId">Will match the value that was passed to <see cref="M:CefSharp.IPermissionHandler.OnShowPermissionPrompt(CefSharp.IWebBrowser,CefSharp.IBrowser,System.UInt64,System.String,CefSharp.PermissionRequestType,CefSharp.IPermissionPromptCallback)"/>.</param>
|
<param name="result">will be the value passed to <see cref="M:CefSharp.IPermissionPromptCallback.Continue(CefSharp.PermissionRequestResult)"/> or <see cref="F:CefSharp.PermissionRequestResult.Ignore"/> if the dialog was dismissed for other reasons such as navigation, browser closure, etc. This method will not be called if <see cref="M:CefSharp.Handler.PermissionHandler.OnShowPermissionPrompt(CefSharp.IWebBrowser,CefSharp.IBrowser,System.UInt64,System.String,CefSharp.PermissionRequestType,CefSharp.IPermissionPromptCallback)"/> returned false for <paramref name="promptId"/>.</param>
|
</member>
|
<member name="T:CefSharp.Handler.RequestContextHandler">
|
<summary>
|
Implement this interface to provide handler implementations. The handler
|
instance will not be released until all objects related to the context have
|
been destroyed.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Handler.RequestContextHandler.OnInitialize(System.Action{CefSharp.IRequestContext})">
|
<summary>
|
The <see cref="T:System.Action`1"/> is executed when the RequestContext has been initialized, after the
|
preferences/proxy preferences have been set, before OnRequestContextInitialized.
|
</summary>
|
<param name="onContextInitialziedAction">action to perform on context initialize</param>
|
<returns>A <see cref="T:CefSharp.Handler.RequestContextHandler"/> instance allowing you to chain multiple AddPreference calls together </returns>
|
<remarks>Only a single action reference is maintained, multiple calls will result in the
|
previous action reference being overriden.</remarks>
|
</member>
|
<member name="M:CefSharp.Handler.RequestContextHandler.SetPreferenceOnContextInitialized(System.String,System.Object)">
|
<summary>
|
Sets the preferences when the <see cref="M:CefSharp.IRequestContextHandler.OnRequestContextInitialized(CefSharp.IRequestContext)"/>
|
method is called. If <paramref name="value"/> is null the preference will be restored
|
to its default value. Preferences set via the command-line usually cannot be modified.
|
</summary>
|
<param name="name">preference name</param>
|
<param name="value">preference value</param>
|
<returns>A <see cref="T:CefSharp.Handler.RequestContextHandler"/> instance allowing you to chain multiple AddPreference calls together </returns>
|
</member>
|
<member name="M:CefSharp.Handler.RequestContextHandler.SetProxyOnContextInitialized(System.String,System.Nullable{System.Int32})">
|
<summary>
|
Sets the proxy preferences when the <see cref="M:CefSharp.IRequestContextHandler.OnRequestContextInitialized(CefSharp.IRequestContext)"/>
|
method is called. Proxy set via the command-line usually cannot be modified.
|
</summary>
|
<param name="host">proxy host</param>
|
<param name="port">proxy port</param>
|
<returns>A <see cref="T:CefSharp.Handler.RequestContextHandler"/> instance allowing you to chain multiple AddPreference calls together </returns>
|
</member>
|
<member name="M:CefSharp.Handler.RequestContextHandler.SetProxyOnContextInitialized(System.String,System.String,System.Nullable{System.Int32})">
|
<summary>
|
Sets the proxy preferences when the <see cref="M:CefSharp.IRequestContextHandler.OnRequestContextInitialized(CefSharp.IRequestContext)"/>
|
method is called. Proxy set via the command-line usually cannot be modified.
|
</summary>
|
<param name="scheme">is the protocol of the proxy server, and is one of: 'http', 'socks', 'socks4', 'socks5'. Also note that 'socks' is equivalent to 'socks5'.</param>
|
<param name="host">proxy host</param>
|
<param name="port">proxy port</param>
|
<returns>A <see cref="T:CefSharp.Handler.RequestContextHandler"/> instance allowing you to chain multiple AddPreference calls together </returns>
|
</member>
|
<member name="M:CefSharp.Handler.RequestContextHandler.GetResourceRequestHandler(CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,System.Boolean,System.Boolean,System.String,System.Boolean@)">
|
<summary>
|
Called on the CEF IO thread before a resource request is initiated.
|
This method will not be called if the client associated with <paramref name="browser"/> returns a non-NULL value
|
from <see cref="M:CefSharp.IRequestHandler.GetResourceRequestHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,System.Boolean,System.Boolean,System.String,System.Boolean@)"/> for the same request (identified by <see cref="P:CefSharp.IRequest.Identifier"/>).
|
</summary>
|
<param name="browser">represent the source browser of the request, and may be null for requests originating from service workers.</param>
|
<param name="frame">represent the source frame of the request, and may be null for requests originating from service workers.</param>
|
<param name="request">represents the request contents and cannot be modified in this callback</param>
|
<param name="isNavigation">will be true if the resource request is a navigation</param>
|
<param name="isDownload">will be true if the resource request is a download</param>
|
<param name="requestInitiator">is the origin (scheme + domain) of the page that initiated the request</param>
|
<param name="disableDefaultHandling">Set to true to disable default handling of the request, in which case it will need to be handled via <see cref="M:CefSharp.IResourceRequestHandler.GetResourceHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)"/> or it will be canceled</param>
|
<returns>To allow the resource load to proceed with default handling return null. To specify a handler for the resource return a <see cref="T:CefSharp.IResourceRequestHandler"/> object.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.RequestContextHandler.OnRequestContextInitialized(CefSharp.IRequestContext)">
|
<summary>
|
Called immediately after the request context has been initialized.
|
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
|
thread.
|
</summary>
|
<param name="requestContext">the request context</param>
|
</member>
|
<member name="T:CefSharp.Handler.RequestHandler">
|
<summary>
|
Default implementation of <see cref="T:CefSharp.IRequestHandler"/>. This class provides default implementations of the methods from
|
<see cref="T:CefSharp.IRequestHandler"/>, therefore providing a convenience base class for any custom request handler.
|
</summary>
|
<seealso cref="T:CefSharp.IRequestHandler"/>
|
</member>
|
<member name="M:CefSharp.Handler.RequestHandler.CefSharp#IRequestHandler#OnBeforeBrowse(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,System.Boolean,System.Boolean)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.RequestHandler.OnBeforeBrowse(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,System.Boolean,System.Boolean)">
|
<summary>
|
Called before browser navigation. If the navigation is allowed <see cref="E:CefSharp.IChromiumWebBrowserBase.FrameLoadStart"/> and
|
<see cref="E:CefSharp.IChromiumWebBrowserBase.FrameLoadEnd"/>
|
will be called. If the navigation is canceled <see cref="E:CefSharp.IChromiumWebBrowserBase.LoadError"/> will be called with an ErrorCode value of
|
<see cref="F:CefSharp.CefErrorCode.Aborted"/>.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object.</param>
|
<param name="frame">The frame the request is coming from.</param>
|
<param name="request">the request object - cannot be modified in this callback.</param>
|
<param name="userGesture">The value will be true if the browser navigated via explicit user gesture (e.g. clicking a link) or
|
false if it navigated automatically (e.g. via the DomContentLoaded event).</param>
|
<param name="isRedirect">has the request been redirected.</param>
|
<returns>
|
Return true to cancel the navigation or false to allow the navigation to proceed.
|
</returns>
|
</member>
|
<member name="M:CefSharp.Handler.RequestHandler.CefSharp#IRequestHandler#OnOpenUrlFromTab(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.String,CefSharp.WindowOpenDisposition,System.Boolean)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.RequestHandler.OnOpenUrlFromTab(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.String,CefSharp.WindowOpenDisposition,System.Boolean)">
|
<summary>
|
Called on the UI thread before OnBeforeBrowse in certain limited cases where navigating a new or different browser might be
|
desirable. This includes user-initiated navigation that might open in a special way (e.g. links clicked via middle-click or
|
ctrl + left-click) and certain types of cross-origin navigation initiated from the renderer process (e.g. navigating the top-
|
level frame to/from a file URL).
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object.</param>
|
<param name="frame">The frame object.</param>
|
<param name="targetUrl">target url.</param>
|
<param name="targetDisposition">The value indicates where the user intended to navigate the browser based on standard
|
Chromium behaviors (e.g. current tab, new tab, etc).</param>
|
<param name="userGesture">The value will be true if the browser navigated via explicit user gesture (e.g. clicking a link) or
|
false if it navigated automatically (e.g. via the DomContentLoaded event).</param>
|
<returns>
|
Return true to cancel the navigation or false to allow the navigation to proceed in the source browser's top-level frame.
|
</returns>
|
</member>
|
<member name="M:CefSharp.Handler.RequestHandler.CefSharp#IRequestHandler#GetResourceRequestHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,System.Boolean,System.Boolean,System.String,System.Boolean@)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.RequestHandler.GetResourceRequestHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,System.Boolean,System.Boolean,System.String,System.Boolean@)">
|
<summary>
|
Called on the CEF IO thread before a resource request is initiated.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control.</param>
|
<param name="browser">represent the source browser of the request.</param>
|
<param name="frame">represent the source frame of the request.</param>
|
<param name="request">represents the request contents and cannot be modified in this callback.</param>
|
<param name="isNavigation">will be true if the resource request is a navigation.</param>
|
<param name="isDownload">will be true if the resource request is a download.</param>
|
<param name="requestInitiator">is the origin (scheme + domain) of the page that initiated the request.</param>
|
<param name="disableDefaultHandling">[in,out] to true to disable default handling of the request, in which case it will need
|
to be handled via <see cref="M:CefSharp.IResourceRequestHandler.GetResourceHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)"/> or it will be canceled.</param>
|
<returns>
|
To allow the resource load to proceed with default handling return null. To specify a handler for the resource return a
|
<see cref="T:CefSharp.IResourceRequestHandler"/> object. If this callback returns null the same method will be called on the associated
|
<see cref="T:CefSharp.IRequestContextHandler"/>, if any.
|
</returns>
|
</member>
|
<member name="M:CefSharp.Handler.RequestHandler.CefSharp#IRequestHandler#GetAuthCredentials(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,System.Boolean,System.String,System.Int32,System.String,System.String,CefSharp.IAuthCallback)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.RequestHandler.GetAuthCredentials(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,System.Boolean,System.String,System.Int32,System.String,System.String,CefSharp.IAuthCallback)">
|
<summary>
|
Called when the browser needs credentials from the user.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object.</param>
|
<param name="originUrl">is the origin making this authentication request.</param>
|
<param name="isProxy">indicates whether the host is a proxy server.</param>
|
<param name="host">hostname.</param>
|
<param name="port">port number.</param>
|
<param name="realm">realm.</param>
|
<param name="scheme">scheme.</param>
|
<param name="callback">Callback interface used for asynchronous continuation of authentication requests.</param>
|
<returns>
|
Return true to continue the request and call <see cref="M:CefSharp.IAuthCallback.Continue(System.String,System.String)"/> when the authentication
|
information is available. Return false to cancel the request.
|
</returns>
|
</member>
|
<member name="M:CefSharp.Handler.RequestHandler.CefSharp#IRequestHandler#OnCertificateError(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefErrorCode,System.String,CefSharp.ISslInfo,CefSharp.IRequestCallback)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.RequestHandler.OnCertificateError(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefErrorCode,System.String,CefSharp.ISslInfo,CefSharp.IRequestCallback)">
|
<summary>
|
Called to handle requests for URLs with an invalid SSL certificate. Return true and call
|
<see cref="M:CefSharp.IRequestCallback.Continue(System.Boolean)"/> either in this method or at a later time to continue or cancel the request.
|
If CefSettings.IgnoreCertificateErrors is set all invalid certificates will be accepted without calling this method.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object.</param>
|
<param name="errorCode">the error code for this invalid certificate.</param>
|
<param name="requestUrl">the url of the request for the invalid certificate.</param>
|
<param name="sslInfo">ssl certificate information.</param>
|
<param name="callback">Callback interface used for asynchronous continuation of url requests. If empty the error cannot be
|
recovered from and the request will be canceled automatically.</param>
|
<returns>
|
Return false to cancel the request immediately. Return true and use <see cref="T:CefSharp.IRequestCallback"/> to execute in an async
|
fashion.
|
</returns>
|
</member>
|
<member name="M:CefSharp.Handler.RequestHandler.CefSharp#IRequestHandler#OnSelectClientCertificate(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Boolean,System.String,System.Int32,System.Security.Cryptography.X509Certificates.X509Certificate2Collection,CefSharp.ISelectClientCertificateCallback)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.RequestHandler.OnSelectClientCertificate(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Boolean,System.String,System.Int32,System.Security.Cryptography.X509Certificates.X509Certificate2Collection,CefSharp.ISelectClientCertificateCallback)">
|
<summary>
|
Called when the browser needs user to select Client Certificate for authentication requests (eg. PKI authentication).
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object.</param>
|
<param name="isProxy">indicates whether the host is a proxy server.</param>
|
<param name="host">hostname.</param>
|
<param name="port">port number.</param>
|
<param name="certificates">List of Client certificates for selection.</param>
|
<param name="callback">Callback interface used for asynchronous continuation of client certificate selection for
|
authentication requests.</param>
|
<returns>
|
Return true to continue the request and call ISelectClientCertificateCallback.Select() with the selected certificate for
|
authentication. Return false to use the default behavior where the browser selects the first certificate from the list.
|
|
</returns>
|
</member>
|
<member name="M:CefSharp.Handler.RequestHandler.CefSharp#IRequestHandler#OnRenderViewReady(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.RequestHandler.OnRenderViewReady(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called on the CEF UI thread when the render view associated with browser is ready to receive/handle IPC messages in the
|
render process.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object.</param>
|
</member>
|
<member name="M:CefSharp.Handler.RequestHandler.CefSharp#IRequestHandler#OnRenderProcessTerminated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefTerminationStatus)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.RequestHandler.OnRenderProcessTerminated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefTerminationStatus)">
|
<summary>
|
Called when the render process terminates unexpectedly.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object.</param>
|
<param name="status">indicates how the process terminated.</param>
|
</member>
|
<member name="M:CefSharp.Handler.RequestHandler.CefSharp#IRequestHandler#OnDocumentAvailableInMainFrame(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Handler.RequestHandler.OnDocumentAvailableInMainFrame(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called on the CEF UI thread when the window.document object of the main frame has been created.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
</member>
|
<member name="T:CefSharp.Handler.ResourceRequestHandler">
|
<summary>
|
Default implementation of <see cref="T:CefSharp.IResourceRequestHandler"/>. This class provides default implementations of the methods
|
from <see cref="T:CefSharp.IResourceRequestHandler"/>, therefore providing a convenience base class for any custom resource request
|
handler.
|
</summary>
|
<seealso cref="T:CefSharp.IResourceRequestHandler"/>
|
</member>
|
<member name="M:CefSharp.Handler.ResourceRequestHandler.CefSharp#IResourceRequestHandler#GetCookieAccessFilter(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)">
|
<summary>
|
Called on the CEF IO thread before a resource request is loaded. To optionally filter cookies for the request return a
|
<see cref="T:CefSharp.ICookieAccessFilter"/> object.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="request">the request object - can be modified in this callback.</param>
|
<returns>To optionally filter cookies for the request return a ICookieAccessFilter instance otherwise return null.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ResourceRequestHandler.GetCookieAccessFilter(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)">
|
<summary>
|
Called on the CEF IO thread before a resource request is loaded. To optionally filter cookies for the request return a
|
<see cref="T:CefSharp.ICookieAccessFilter"/> object.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="request">the request object - can be modified in this callback.</param>
|
<returns>To optionally filter cookies for the request return a ICookieAccessFilter instance otherwise return null.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ResourceRequestHandler.CefSharp#IResourceRequestHandler#GetResourceHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)">
|
<summary>
|
Called on the CEF IO thread before a resource is loaded. To specify a handler for the resource return a
|
<see cref="T:CefSharp.IResourceHandler"/> object.
|
</summary>
|
<param name="chromiumWebBrowser">The browser UI control.</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="request">the request object - cannot be modified in this callback.</param>
|
<returns>
|
To allow the resource to load using the default network loader return null otherwise return an instance of
|
<see cref="T:CefSharp.IResourceHandler"/> with a valid stream.
|
</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ResourceRequestHandler.GetResourceHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)">
|
<summary>
|
Called on the CEF IO thread before a resource is loaded. To specify a handler for the resource return a
|
<see cref="T:CefSharp.IResourceHandler"/> object.
|
</summary>
|
<param name="chromiumWebBrowser">The browser UI control.</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="request">the request object - cannot be modified in this callback.</param>
|
<returns>
|
To allow the resource to load using the default network loader return null otherwise return an instance of
|
<see cref="T:CefSharp.IResourceHandler"/> with a valid stream.
|
</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ResourceRequestHandler.CefSharp#IResourceRequestHandler#GetResourceResponseFilter(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse)">
|
<summary>Called on the CEF IO thread to optionally filter resource response content.</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="request">the request object - cannot be modified in this callback.</param>
|
<param name="response">the response object - cannot be modified in this callback.</param>
|
<returns>Return an IResponseFilter to intercept this response, otherwise return null.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ResourceRequestHandler.GetResourceResponseFilter(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse)">
|
<summary>Called on the CEF IO thread to optionally filter resource response content.</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="request">the request object - cannot be modified in this callback.</param>
|
<param name="response">the response object - cannot be modified in this callback.</param>
|
<returns>Return an IResponseFilter to intercept this response, otherwise return null.</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ResourceRequestHandler.CefSharp#IResourceRequestHandler#OnBeforeResourceLoad(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IRequestCallback)">
|
<summary>
|
Called on the CEF IO thread before a resource request is loaded. To redirect or change the resource load optionally modify
|
<paramref name="request"/>. Modification of the request URL will be treated as a redirect.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="request">the request object - can be modified in this callback.</param>
|
<param name="callback">Callback interface used for asynchronous continuation of url requests.</param>
|
<returns>
|
Return <see cref="F:CefSharp.CefReturnValue.Continue"/> to continue the request immediately. Return
|
<see cref="F:CefSharp.CefReturnValue.ContinueAsync"/> and call <see cref="M:CefSharp.IRequestCallback.Continue(System.Boolean)"/> or
|
<see cref="M:CefSharp.IRequestCallback.Cancel"/> at a later time to continue or the cancel the request asynchronously. Return
|
<see cref="F:CefSharp.CefReturnValue.Cancel"/> to cancel the request immediately.
|
</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ResourceRequestHandler.OnBeforeResourceLoad(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IRequestCallback)">
|
<summary>
|
Called on the CEF IO thread before a resource request is loaded. To redirect or change the resource load optionally modify
|
<paramref name="request"/>. Modification of the request URL will be treated as a redirect.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="request">the request object - can be modified in this callback.</param>
|
<param name="callback">Callback interface used for asynchronous continuation of url requests.</param>
|
<returns>
|
Return <see cref="F:CefSharp.CefReturnValue.Continue"/> to continue the request immediately. Return
|
<see cref="F:CefSharp.CefReturnValue.ContinueAsync"/> and call <see cref="M:CefSharp.IRequestCallback.Continue(System.Boolean)"/> or
|
<see cref="M:CefSharp.IRequestCallback.Cancel"/> at a later time to continue or the cancel the request asynchronously. Return
|
<see cref="F:CefSharp.CefReturnValue.Cancel"/> to cancel the request immediately.
|
</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ResourceRequestHandler.CefSharp#IResourceRequestHandler#OnProtocolExecution(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)">
|
<summary>
|
Called on the CEF UI thread to handle requests for URLs with an unknown protocol component. SECURITY WARNING: YOU SHOULD USE
|
THIS METHOD TO ENFORCE RESTRICTIONS BASED ON SCHEME, HOST OR OTHER URL ANALYSIS BEFORE ALLOWING OS EXECUTION.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="request">the request object - cannot be modified in this callback.</param>
|
<returns>
|
return to true to attempt execution via the registered OS protocol handler, if any. Otherwise return false.
|
</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ResourceRequestHandler.OnProtocolExecution(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)">
|
<summary>
|
Called on the CEF UI thread to handle requests for URLs with an unknown protocol component. SECURITY WARNING: YOU SHOULD USE
|
THIS METHOD TO ENFORCE RESTRICTIONS BASED ON SCHEME, HOST OR OTHER URL ANALYSIS BEFORE ALLOWING OS EXECUTION.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="request">the request object - cannot be modified in this callback.</param>
|
<returns>
|
return to true to attempt execution via the registered OS protocol handler, if any. Otherwise return false.
|
</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ResourceRequestHandler.CefSharp#IResourceRequestHandler#OnResourceLoadComplete(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse,CefSharp.UrlRequestStatus,System.Int64)">
|
<summary>
|
Called on the CEF IO thread when a resource load has completed. This method will be called for all requests, including
|
requests that are aborted due to CEF shutdown or destruction of the associated browser. In cases where the associated browser
|
is destroyed this callback may arrive after the <see cref="M:CefSharp.ILifeSpanHandler.OnBeforeClose(CefSharp.IWebBrowser,CefSharp.IBrowser)"/> callback for that browser. The
|
<see cref="P:CefSharp.IFrame.IsValid"/> method can be used to test for this situation, and care
|
should be taken not to call <paramref name="browser"/> or <paramref name="frame"/> methods that modify state (like LoadURL,
|
SendProcessMessage, etc.) if the frame is invalid.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="request">the request object - cannot be modified in this callback.</param>
|
<param name="response">the response object - cannot be modified in this callback.</param>
|
<param name="status">indicates the load completion status.</param>
|
<param name="receivedContentLength">is the number of response bytes actually read.</param>
|
</member>
|
<member name="M:CefSharp.Handler.ResourceRequestHandler.OnResourceLoadComplete(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse,CefSharp.UrlRequestStatus,System.Int64)">
|
<summary>
|
Called on the CEF IO thread when a resource load has completed. This method will be called for all requests, including
|
requests that are aborted due to CEF shutdown or destruction of the associated browser. In cases where the associated browser
|
is destroyed this callback may arrive after the <see cref="M:CefSharp.ILifeSpanHandler.OnBeforeClose(CefSharp.IWebBrowser,CefSharp.IBrowser)"/> callback for that browser. The
|
<see cref="P:CefSharp.IFrame.IsValid"/> method can be used to test for this situation, and care
|
should be taken not to call <paramref name="browser"/> or <paramref name="frame"/> methods that modify state (like LoadURL,
|
SendProcessMessage, etc.) if the frame is invalid.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="request">the request object - cannot be modified in this callback.</param>
|
<param name="response">the response object - cannot be modified in this callback.</param>
|
<param name="status">indicates the load completion status.</param>
|
<param name="receivedContentLength">is the number of response bytes actually read.</param>
|
</member>
|
<member name="M:CefSharp.Handler.ResourceRequestHandler.CefSharp#IResourceRequestHandler#OnResourceRedirect(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse,System.String@)">
|
<summary>
|
Called on the CEF IO thread when a resource load is redirected. The <paramref name="request"/> parameter will contain the old
|
URL and other request-related information. The <paramref name="response"/> parameter will contain the response that resulted
|
in the redirect. The <paramref name="newUrl"/> parameter will contain the new URL and can be changed if desired.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="request">the request object - cannot be modified in this callback.</param>
|
<param name="response">the response object - cannot be modified in this callback.</param>
|
<param name="newUrl">[in,out] the new URL and can be changed if desired.</param>
|
</member>
|
<member name="M:CefSharp.Handler.ResourceRequestHandler.OnResourceRedirect(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse,System.String@)">
|
<summary>
|
Called on the CEF IO thread when a resource load is redirected. The <paramref name="request"/> parameter will contain the old
|
URL and other request-related information. The <paramref name="response"/> parameter will contain the response that resulted
|
in the redirect. The <paramref name="newUrl"/> parameter will contain the new URL and can be changed if desired.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="request">the request object - cannot be modified in this callback.</param>
|
<param name="response">the response object - cannot be modified in this callback.</param>
|
<param name="newUrl">[in,out] the new URL and can be changed if desired.</param>
|
</member>
|
<member name="M:CefSharp.Handler.ResourceRequestHandler.CefSharp#IResourceRequestHandler#OnResourceResponse(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse)">
|
<summary>
|
Called on the CEF IO thread when a resource response is received. To allow the resource load to proceed without modification
|
return false. To redirect or retry the resource load optionally modify <paramref name="request"/> and return true.
|
Modification of the request URL will be treated as a redirect. Requests handled using the default network loader cannot be
|
redirected in this callback.
|
|
WARNING: Redirecting using this method is deprecated. Use OnBeforeResourceLoad or GetResourceHandler to perform redirects.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="request">the request object.</param>
|
<param name="response">the response object - cannot be modified in this callback.</param>
|
<returns>
|
To allow the resource load to proceed without modification return false. To redirect or retry the resource load optionally
|
modify <paramref name="request"/> and return true. Modification of the request URL will be treated as a redirect. Requests
|
handled using the default network loader cannot be redirected in this callback.
|
</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ResourceRequestHandler.OnResourceResponse(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse)">
|
<summary>
|
Called on the CEF IO thread when a resource response is received. To allow the resource load to proceed without modification
|
return false. To redirect or retry the resource load optionally modify <paramref name="request"/> and return true.
|
Modification of the request URL will be treated as a redirect. Requests handled using the default network loader cannot be
|
redirected in this callback.
|
|
WARNING: Redirecting using this method is deprecated. Use OnBeforeResourceLoad or GetResourceHandler to perform redirects.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control.</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest.</param>
|
<param name="request">the request object.</param>
|
<param name="response">the response object - cannot be modified in this callback.</param>
|
<returns>
|
To allow the resource load to proceed without modification return false. To redirect or retry the resource load optionally
|
modify <paramref name="request"/> and return true. Modification of the request URL will be treated as a redirect. Requests
|
handled using the default network loader cannot be redirected in this callback.
|
</returns>
|
</member>
|
<member name="M:CefSharp.Handler.ResourceRequestHandler.Dispose">
|
<summary>
|
Called when the unmanaged resource is freed.
|
Unmanaged resources are ref counted and freed when
|
the last reference is released, this works differently
|
to .Net garbage collection.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IAccessibilityHandler">
|
<summary>
|
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.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IAccessibilityHandler.OnAccessibilityLocationChange(CefSharp.IValue)">
|
<summary>
|
Called after renderer process sends accessibility location changes to the browser process.
|
</summary>
|
<param name="value">Updated location info.</param>
|
</member>
|
<member name="M:CefSharp.IAccessibilityHandler.OnAccessibilityTreeChange(CefSharp.IValue)">
|
<summary>
|
Called after renderer process sends accessibility tree changes to the browser process.
|
</summary>
|
<param name="value">Updated tree info.</param>
|
</member>
|
<member name="T:CefSharp.IAudioHandler">
|
<summary>
|
Implement this interface to handle audio events
|
All methods will be called on the CEF UI thread
|
</summary>
|
</member>
|
<member name="M:CefSharp.IAudioHandler.GetAudioParameters(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.Structs.AudioParameters@)">
|
<summary>
|
Called on the CEF UI thread to allow configuration of audio stream parameters.
|
Audio stream paramaters can optionally be configured by modifying <paramref name="parameters"/>
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="parameters">audio stream parameters can optionally be configured here, they are
|
pre-filled with some sensible defaults.</param>
|
<returns>Return true to proceed with audio stream capture, or false to cancel it</returns>
|
</member>
|
<member name="M:CefSharp.IAudioHandler.OnAudioStreamStarted(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.Structs.AudioParameters,System.Int32)">
|
<summary>
|
Called on a browser audio capture thread when the browser starts streaming audio.
|
OnAudioStreamStopped will always be called after OnAudioStreamStarted; both methods may be called multiple
|
times for the same browser.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="parameters">contains the audio parameters like sample rate and channel layout.
|
Changing the param values will have no effect here.</param>
|
<param name="channels">is the number of channels</param>
|
</member>
|
<member name="M:CefSharp.IAudioHandler.OnAudioStreamPacket(CefSharp.IWebBrowser,CefSharp.IBrowser,System.IntPtr,System.Int32,System.Int64)">
|
<summary>
|
Called on the audio stream thread when a PCM packet is received for the stream.
|
Based on and the <see cref="P:CefSharp.Structs.AudioParameters.ChannelLayout"/> value passed to <see cref="M:CefSharp.IAudioHandler.OnAudioStreamStarted(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.Structs.AudioParameters,System.Int32)"/>
|
you can calculate the size of the <paramref name="data"/> array in bytes.
|
</summary>
|
<param name="chromiumWebBrowser"></param>
|
<param name="data">is an array representing the raw PCM data as a floating point type, i.e. 4-byte value(s).</param>
|
<param name="noOfFrames">is the number of frames in the PCM packet</param>
|
<param name="pts">is the presentation timestamp (in milliseconds since the Unix Epoch)
|
and represents the time at which the decompressed packet should be presented to the user</param>
|
</member>
|
<member name="M:CefSharp.IAudioHandler.OnAudioStreamStopped(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called on the CEF UI thread when the stream has stopped. OnAudioStreamStopped will always be called after <see cref="M:CefSharp.IAudioHandler.OnAudioStreamStarted(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.Structs.AudioParameters,System.Int32)"/>;
|
both methods may be called multiple times for the same stream.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
</member>
|
<member name="M:CefSharp.IAudioHandler.OnAudioStreamError(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String)">
|
<summary>
|
Called on the CEF UI thread or audio stream thread when an error occurred. During the
|
stream creation phase this callback will be called on the UI thread while
|
in the capturing phase it will be called on the audio stream thread. The
|
stream will be stopped immediately.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="errorMessage">error message</param>
|
</member>
|
<member name="T:CefSharp.IBrowserProcessHandler">
|
<summary>
|
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. .
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserProcessHandler.OnContextInitialized">
|
<summary>
|
Called on the CEF UI thread immediately after the CEF context has been initialized.
|
You can now access the Global RequestContext through Cef.GetGlobalRequestContext() - this is the
|
first place you can set Preferences (e.g. proxy settings, spell check dictionaries).
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserProcessHandler.OnScheduleMessagePumpWork(System.Int64)">
|
<summary>
|
Called from any thread when work has been scheduled for the browser process
|
main (UI) thread. This callback is used in combination with CefSettings.
|
ExternalMessagePump and Cef.DoMessageLoopWork() in cases where the CEF
|
message loop must be integrated into an existing application message loop
|
(see additional comments and warnings on Cef.DoMessageLoopWork). This
|
callback should schedule a Cef.DoMessageLoopWork() call to happen on the
|
main (UI) thread.
|
</summary>
|
<param name="delay">is the requested delay in milliseconds. If
|
delay is less than or equal to 0 then the call should happen reasonably soon. If
|
delay is greater than 0 then the call should be scheduled to happen after the
|
specified delay and any currently pending scheduled call should be
|
cancelled.</param>
|
</member>
|
<member name="T:CefSharp.IContextMenuHandler">
|
<summary>
|
Implement this interface to handle context menu events.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IContextMenuHandler.OnBeforeContextMenu(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IContextMenuParams,CefSharp.IMenuModel)">
|
<summary>
|
Called before a context menu is displayed. The model can be cleared to show no context menu or
|
modified to show a custom menu.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">The frame the request is coming from</param>
|
<param name="parameters">provides information about the context menu state</param>
|
<param name="model">initially contains the default context menu</param>
|
</member>
|
<member name="M:CefSharp.IContextMenuHandler.OnContextMenuCommand(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IContextMenuParams,CefSharp.CefMenuCommand,CefSharp.CefEventFlags)">
|
<summary>
|
Called to execute a command selected from the context menu. See
|
cef_menu_id_t for the command ids that have default implementations. All
|
user-defined command ids should be between MENU_ID_USER_FIRST and
|
MENU_ID_USER_LAST.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">The frame the request is coming from</param>
|
<param name="parameters">will have the same values as what was passed to</param>
|
<param name="commandId">menu command id</param>
|
<param name="eventFlags">event flags</param>
|
<returns>Return true if the command was handled or false for the default implementation.</returns>
|
</member>
|
<member name="M:CefSharp.IContextMenuHandler.OnContextMenuDismissed(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)">
|
<summary>
|
Called when the context menu is dismissed irregardless of whether the menu
|
was canceled or a command was selected.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">The frame the request is coming from</param>
|
</member>
|
<member name="M:CefSharp.IContextMenuHandler.RunContextMenu(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IContextMenuParams,CefSharp.IMenuModel,CefSharp.IRunContextMenuCallback)">
|
<summary>
|
Called to allow custom display of the context menu.
|
For custom display return true and execute callback either synchronously or asynchronously with the selected command Id.
|
For default display return false. Do not keep references to parameters or model outside of this callback.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">The frame the request is coming from</param>
|
<param name="parameters">provides information about the context menu state</param>
|
<param name="model">contains the context menu model resulting from OnBeforeContextMenu</param>
|
<param name="callback">the callback to execute for custom display</param>
|
<returns>For custom display return true and execute callback either synchronously or asynchronously with the selected command ID.</returns>
|
</member>
|
<member name="T:CefSharp.ICookieAccessFilter">
|
<summary>
|
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.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ICookieAccessFilter.CanSendCookie(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.Cookie)">
|
<summary>
|
Called on the CEF IO thread before a resource request is sent.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="request">the request object - cannot be modified in this callback</param>
|
<param name="cookie">the cookie object</param>
|
<returns>Return true if the specified cookie can be sent with the request or false otherwise.</returns>
|
</member>
|
<member name="M:CefSharp.ICookieAccessFilter.CanSaveCookie(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse,CefSharp.Cookie)">
|
<summary>
|
Called on the CEF IO thread after a resource response is received.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="request">the request object - cannot be modified in this callback</param>
|
<param name="response">the response object - cannot be modified in this callback</param>
|
<param name="cookie">the cookie object</param>
|
<returns>Return true if the specified cookie returned with the response can be saved or false otherwise.</returns>
|
</member>
|
<member name="T:CefSharp.IDialogHandler">
|
<summary>
|
Implement this interface to handle dialog events. The methods of this class will be called on the CEF UI thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IDialogHandler.OnFileDialog(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefFileDialogMode,System.String,System.String,System.Collections.Generic.List{System.String},CefSharp.IFileDialogCallback)">
|
<summary>
|
Runs a file chooser dialog.
|
</summary>
|
<example>
|
To test assign something like TempFileDialogHandler (from CefSharp.Example) to DialogHandler e.g.
|
<code>
|
browser.DialogHandler = new TempFileDialogHandler();
|
</code>
|
Example URL to use for file browsing http://www.cs.tut.fi/~jkorpela/forms/file.html#example
|
Simply click browse, the space next to the browse button should be populated with a randomly generated filename.
|
</example>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="mode">represents the type of dialog to display</param>
|
<param name="title">the title to be used for the dialog. It may be empty to show the default title ("Open" or "Save"
|
depending on the mode).</param>
|
<param name="defaultFilePath">is the path with optional directory and/or file name component that
|
should be initially selected in the dialog.</param>
|
<param name="acceptFilters">are used to restrict the selectable file types and may any combination of
|
(a) valid lower-cased MIME types (e.g. "text/*" or "image/*"),
|
(b) individual file extensions (e.g. ".txt" or ".png"),
|
(c) combined description and file extension delimited using "|" and ";" (e.g. "Image Types|.png;.gif;.jpg").</param>
|
<param name="callback">Callback interface for asynchronous continuation of file dialog requests.</param>
|
<returns>To display a custom dialog return true. To display the default dialog return false.</returns>
|
</member>
|
<member name="T:CefSharp.IDisplayHandler">
|
<summary>
|
Handle events related to browser display state.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IDisplayHandler.OnAddressChanged(CefSharp.IWebBrowser,CefSharp.AddressChangedEventArgs)">
|
<summary>
|
Called when a frame's address has changed.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="addressChangedArgs">args</param>
|
</member>
|
<member name="M:CefSharp.IDisplayHandler.OnAutoResize(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.Structs.Size)">
|
<summary>
|
Called when auto-resize is enabled via IBrowserHost.SetAutoResizeEnabled and the contents have auto-resized.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="newSize">will be the desired size in view coordinates</param>
|
<returns>Return true if the resize was handled or false for default handling. </returns>
|
</member>
|
<member name="M:CefSharp.IDisplayHandler.OnCursorChange(CefSharp.IWebBrowser,CefSharp.IBrowser,System.IntPtr,CefSharp.Enums.CursorType,CefSharp.Structs.CursorInfo)">
|
<summary>
|
Called when the browser's cursor has changed. .
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="cursor">If type is Custom then customCursorInfo will be populated with the custom cursor information</param>
|
<param name="type">cursor type</param>
|
<param name="customCursorInfo">custom cursor Information</param>
|
<returns>Return true if the cursor change was handled or false for default handling.</returns>
|
</member>
|
<member name="M:CefSharp.IDisplayHandler.OnTitleChanged(CefSharp.IWebBrowser,CefSharp.TitleChangedEventArgs)">
|
<summary>
|
Called when the page title changes.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="titleChangedArgs">args</param>
|
</member>
|
<member name="M:CefSharp.IDisplayHandler.OnFaviconUrlChange(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Collections.Generic.IList{System.String})">
|
<summary>
|
Called when the page icon changes.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="urls">list of urls where the favicons can be downloaded</param>
|
</member>
|
<member name="M:CefSharp.IDisplayHandler.OnFullscreenModeChange(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Boolean)">
|
<summary>
|
Called when web content in the page has toggled fullscreen mode. The client is
|
responsible for resizing the browser if desired.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="fullscreen">If true the content will automatically be sized to fill the browser content area.
|
If false the content will automatically return to its original size and position.</param>
|
</member>
|
<member name="M:CefSharp.IDisplayHandler.OnLoadingProgressChange(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Double)">
|
<summary>
|
Called when the overall page loading progress has changed
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="progress">ranges from 0.0 to 1.0.</param>
|
</member>
|
<member name="M:CefSharp.IDisplayHandler.OnTooltipChanged(CefSharp.IWebBrowser,System.String@)">
|
<summary>
|
Called when the browser is about to display a tooltip. text contains the
|
text that will be displayed in the tooltip. You can optionally modify text
|
and then return false to allow the browser to display the tooltip.
|
When window rendering is disabled the application is responsible for
|
drawing tooltips and the return value is ignored.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="text">the text that will be displayed in the tooltip</param>
|
<returns>To handle the display of the tooltip yourself return true otherwise return false
|
to allow the browser to display the tooltip.</returns>
|
<remarks>Only called when using Off-screen rendering (WPF and OffScreen)</remarks>
|
</member>
|
<member name="M:CefSharp.IDisplayHandler.OnStatusMessage(CefSharp.IWebBrowser,CefSharp.StatusMessageEventArgs)">
|
<summary>
|
Called when the browser receives a status message.
|
</summary>
|
<param name="chromiumWebBrowser">The <see cref="T:CefSharp.IWebBrowser"/> control this popup is related to.</param>
|
<param name="statusMessageArgs">args</param>
|
</member>
|
<member name="M:CefSharp.IDisplayHandler.OnConsoleMessage(CefSharp.IWebBrowser,CefSharp.ConsoleMessageEventArgs)">
|
<summary>
|
Called to display a console message.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="consoleMessageArgs">args</param>
|
<returns>Return true to stop the message from being output to the console.</returns>
|
</member>
|
<member name="T:CefSharp.IDownloadHandler">
|
<summary>
|
Class used to handle file downloads.
|
The methods of this class will called on the CEF UI thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IDownloadHandler.CanDownload(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,System.String)">
|
<summary>
|
Called before a download begins in response to a user-initiated action
|
(e.g. alt + link click or link click that returns a `Content-Disposition:
|
attachment` response from the server).
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance</param>
|
<param name="url">is the target download URL</param>
|
<param name="requestMethod">is the target method (GET, POST, etc)</param>
|
<returns>Return true to proceed with the download or false to cancel the download.</returns>
|
</member>
|
<member name="M:CefSharp.IDownloadHandler.OnBeforeDownload(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.DownloadItem,CefSharp.IBeforeDownloadCallback)">
|
<summary>
|
Called before a download begins.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance</param>
|
<param name="downloadItem">Represents the file being downloaded.</param>
|
<param name="callback">Callback interface used to asynchronously continue a download.</param>
|
</member>
|
<member name="M:CefSharp.IDownloadHandler.OnDownloadUpdated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.DownloadItem,CefSharp.IDownloadItemCallback)">
|
<summary>
|
Called when a download's status or progress information has been updated. This may be called multiple times before and after <see cref="M:CefSharp.IDownloadHandler.OnBeforeDownload(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.DownloadItem,CefSharp.IBeforeDownloadCallback)"/>.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance</param>
|
<param name="downloadItem">Represents the file being downloaded.</param>
|
<param name="callback">The callback used to Cancel/Pause/Resume the process</param>
|
</member>
|
<member name="T:CefSharp.IDragHandler">
|
<summary>
|
Implement this interface to handle events related to dragging.
|
The methods of this class will be called on the UI thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IDragHandler.OnDragEnter(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IDragData,CefSharp.Enums.DragOperationsMask)">
|
<summary>
|
Called when an external drag event enters the browser window.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="dragData">contains the drag event data</param>
|
<param name="mask">represents the type of drag operation</param>
|
<returns>Return false for default drag handling behavior or true to cancel the drag event. </returns>
|
</member>
|
<member name="M:CefSharp.IDragHandler.OnDraggableRegionsChanged(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.Collections.Generic.IList{CefSharp.DraggableRegion})">
|
<summary>
|
Called whenever draggable regions for the browser window change.
|
These can be specified using the '-webkit-app-region: drag/no-drag' CSS-property.
|
If draggable regions are never defined in a document this method will also never be called.
|
If the last draggable region is removed from a document this method will be called with an empty IList.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">The frame</param>
|
<param name="regions">List of <see cref="T:CefSharp.DraggableRegion"/> objects or null if last region was removed.</param>
|
</member>
|
<member name="T:CefSharp.IExtensionHandler">
|
<summary>
|
Implement this interface to handle events related to browser extensions.
|
The methods of this class will be called on the CEF UI thread.
|
See <see cref="M:CefSharp.IRequestContext.LoadExtension(System.String,System.String,CefSharp.IExtensionHandler)"/> for information about extension loading.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IExtensionHandler.OnExtensionLoadFailed(CefSharp.CefErrorCode)">
|
<summary>
|
Called if the <see cref="M:CefSharp.IRequestContext.LoadExtension(System.String,System.String,CefSharp.IExtensionHandler)"/> request fails.
|
</summary>
|
<param name="errorCode">error code</param>
|
</member>
|
<member name="M:CefSharp.IExtensionHandler.OnExtensionLoaded(CefSharp.IExtension)">
|
<summary>
|
Called if the <see cref="M:CefSharp.IRequestContext.LoadExtension(System.String,System.String,CefSharp.IExtensionHandler)"/> request succeeds.
|
</summary>
|
<param name="extension">is the loaded extension.</param>
|
</member>
|
<member name="M:CefSharp.IExtensionHandler.OnExtensionUnloaded(CefSharp.IExtension)">
|
<summary>
|
Called after the IExtension.Unload request has completed.
|
</summary>
|
<param name="extension">is the unloaded extension</param>
|
</member>
|
<member name="M:CefSharp.IExtensionHandler.OnBeforeBackgroundBrowser(CefSharp.IExtension,System.String,CefSharp.IBrowserSettings)">
|
<summary>
|
Called when an extension needs a browser to host a background script specified via the "background" manifest key.
|
The browser will have no visible window and cannot be displayed. To allow creation of the browser optionally
|
modify newBrowser and settings and return false. To cancel creation of the browser
|
(and consequently cancel load of the background script) return true. Successful creation will be indicated by a call to
|
ILifeSpanHandler.OnAfterCreated, and IBrowserHost.IsBackgroundHost
|
will return true for the resulting browser. See https://developer.chrome.com/extensions/event_pages for more information
|
about extension background script usage.
|
</summary>
|
<param name="extension">is the extension that is loading the background script</param>
|
<param name="url">is an internally generated reference to an HTML page that will be used to
|
load the background script via a script src attribute</param>
|
<param name="settings">browser settings</param>
|
<returns>To cancel creation of the browser (and consequently cancel load of the background script) return true, otherwise return false.</returns>
|
</member>
|
<member name="M:CefSharp.IExtensionHandler.OnBeforeBrowser(CefSharp.IExtension,CefSharp.IBrowser,CefSharp.IBrowser,System.Int32,System.String,System.Boolean,CefSharp.IWindowInfo,CefSharp.IBrowserSettings)">
|
<summary>
|
Called when an extension API (e.g. chrome.tabs.create) requests creation of a new browser.
|
Successful creation will be indicated by a call to <see cref="M:CefSharp.ILifeSpanHandler.OnAfterCreated(CefSharp.IWebBrowser,CefSharp.IBrowser)"/>.
|
</summary>
|
<param name="extension">the source of the API call</param>
|
<param name="browser">the source of the API call</param>
|
<param name="activeBrowser">may optionally be specified via the windowId property or
|
returned via the GetActiveBrowser() callback and provides the default for the new browser</param>
|
<param name="index">is the position value optionally specified via the index property</param>
|
<param name="url">is the URL that will be loaded in the browser</param>
|
<param name="active">is true if the new browser should be active when opened</param>
|
<param name="windowInfo">optionally modify if you are going to allow creation of the browser</param>
|
<param name="settings">optionally modify browser settings</param>
|
<returns>To cancel creation of the browser return true. To allow creation return false and optionally modify windowInfo and settings</returns>
|
</member>
|
<member name="M:CefSharp.IExtensionHandler.GetActiveBrowser(CefSharp.IExtension,CefSharp.IBrowser,System.Boolean)">
|
<summary>
|
Called when no tabId is specified to an extension API call that accepts a tabId parameter (e.g. chrome.tabs.*).
|
</summary>
|
<param name="extension">extension the call originates from</param>
|
<param name="browser">browser the call originates from</param>
|
<param name="includeIncognito">Incognito browsers should not be considered unless the source extension has incognito
|
access enabled, inwhich case this will be true</param>
|
<returns>Return the browser that will be acted on by the API call or return null to act on <paramref name="browser"/>.
|
The returned browser must share the same IRequestContext as <paramref name="browser"/></returns>
|
</member>
|
<member name="M:CefSharp.IExtensionHandler.CanAccessBrowser(CefSharp.IExtension,CefSharp.IBrowser,System.Boolean,CefSharp.IBrowser)">
|
<summary>
|
Called when the tabId associated with <paramref name="targetBrowser"/> is specified to an extension API call that accepts a tabId
|
parameter (e.g. chrome.tabs.*).
|
</summary>
|
<param name="extension">extension the call originates from</param>
|
<param name="browser">browser the call originates from</param>
|
<param name="includeIncognito">Access to incognito browsers should not be allowed unless the source extension has
|
incognito access
|
enabled, in which case this will be true.</param>
|
<param name="targetBrowser"></param>
|
<returns>Return true to allow access of false to deny access.</returns>
|
</member>
|
<member name="M:CefSharp.IExtensionHandler.GetExtensionResource(CefSharp.IExtension,CefSharp.IBrowser,System.String,CefSharp.IGetExtensionResourceCallback)">
|
<summary>
|
Called to retrieve an extension resource that would normally be loaded from disk
|
(e.g. if a file parameter is specified to chrome.tabs.executeScript).
|
Localization substitutions will not be applied to resources handled via this method.
|
</summary>
|
<param name="extension">extension the call originates from</param>
|
<param name="browser">browser the call originates from</param>
|
<param name="file">is the requested relative file path.</param>
|
<param name="callback">callback used to handle custom resource requests</param>
|
<returns>To handle the resource request return true and execute <paramref name="callback"/> either synchronously or asynchronously.
|
For the default behavior which reads the resource from the extension directory on disk return false</returns>
|
</member>
|
<member name="T:CefSharp.IFindHandler">
|
<summary>
|
Implement this interface to handle events related to find results.
|
The methods of this class will be called on the CEF UI thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IFindHandler.OnFindResult(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Int32,System.Int32,CefSharp.Structs.Rect,System.Int32,System.Boolean)">
|
<summary>
|
Called to report find results returned by <see cref="M:CefSharp.IBrowserHost.Find(System.String,System.Boolean,System.Boolean,System.Boolean)"/>
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="identifier">is a unique incremental identifier for the currently active search.</param>
|
<param name="count">is the number of matches currently identified</param>
|
<param name="selectionRect">is the location of where the match was found (in window coordinates)</param>
|
<param name="activeMatchOrdinal">is the current position in the search results</param>
|
<param name="finalUpdate">is true if this is the last find notification.</param>
|
</member>
|
<member name="T:CefSharp.IFocusHandler">
|
<summary>
|
Implement this interface to handle events related to focus.
|
The methods of this class will be called on the CEF UI thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IFocusHandler.OnGotFocus(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called when the browser component has received focus.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
</member>
|
<member name="M:CefSharp.IFocusHandler.OnSetFocus(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefFocusSource)">
|
<summary>
|
Called when the browser component is requesting focus.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object, do not keep a reference to this object outside of this method</param>
|
<param name="source">Indicates where the focus request is originating from.</param>
|
<returns>Return false to allow the focus to be set or true to cancel setting the focus.</returns>
|
</member>
|
<member name="M:CefSharp.IFocusHandler.OnTakeFocus(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Boolean)">
|
<summary>
|
Called when the browser component is about to lose focus.
|
For instance, if focus was on the last HTML element and the user pressed the TAB key.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="next">Will be true if the browser is giving focus to the next component
|
and false if the browser is giving focus to the previous component.</param>
|
</member>
|
<member name="T:CefSharp.IFrameHandler">
|
<summary>
|
Implement this interface to handle frame events
|
All methods will be called on the CEF UI thread
|
</summary>
|
</member>
|
<member name="M:CefSharp.IFrameHandler.OnFrameAttached(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.Boolean)">
|
<summary>
|
Called when a frame can begin routing commands to/from the associated
|
renderer process. Any commands that were queued have now been dispatched.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">the frame object</param>
|
<param name="reattached">will be true if the frame was re-attached after exiting the BackForwardCache.</param>
|
</member>
|
<member name="M:CefSharp.IFrameHandler.OnFrameCreated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)">
|
<summary>
|
Called when a new frame is created. This will be the first notification
|
that references <paramref name="frame"/>. Any commands that require transport to the
|
associated renderer process (LoadRequest, SendProcessMessage, GetSource,
|
etc.) will be queued until OnFrameAttached is called for <paramref name="frame"/>.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">the frame object</param>
|
</member>
|
<member name="M:CefSharp.IFrameHandler.OnFrameDetached(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)">
|
<summary>
|
Called when a frame loses its connection to the renderer process and will
|
be destroyed. Any pending or future commands will be discarded and
|
<see cref="P:CefSharp.IFrame.IsValid"/> will now return <c>false</c> for <paramref name="frame"/>. If called after
|
<see cref="M:CefSharp.ILifeSpanHandler.OnBeforeClose(CefSharp.IWebBrowser,CefSharp.IBrowser)"/> during browser destruction then
|
<see cref="P:CefSharp.IBrowser.IsValid"/> will return <c>false</c> for <paramref name="browser"/>.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">the frame object</param>
|
</member>
|
<member name="M:CefSharp.IFrameHandler.OnMainFrameChanged(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IFrame)">
|
<summary>
|
Called when the main frame changes due to one of the following:
|
- (a) initial browser creation
|
- (b) final browser destruction
|
- (c) cross-origin navigation
|
- (d) re-navigation after renderer process termination (due to crashes, etc).
|
|
<paramref name="oldFrame"/> will be <c>null</c> and <paramref name="newFrame"/> will be non-<c>null</c> when a main frame is assigned
|
to <paramref name="browser"/> for the first time.
|
<paramref name="oldFrame"/> will be non-<c>null</c> and <paramref name="newFrame"/> will be <c>null</c> when a main frame is
|
removed from <paramref name="browser"/> for the last time.
|
Both <paramref name="oldFrame"/> and <paramref name="newFrame"/> will be non-<c>null</c>for cross-origin
|
navigations or re-navigation after renderer process termination.
|
This method will be called after <see cref="M:CefSharp.IFrameHandler.OnFrameCreated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)"/> for <paramref name="newFrame"/> and/or after
|
<see cref="M:CefSharp.IFrameHandler.OnFrameDetached(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)"/> for <paramref name="oldFrame"/>. If called after
|
<see cref="M:CefSharp.ILifeSpanHandler.OnBeforeClose(CefSharp.IWebBrowser,CefSharp.IBrowser)"/> during browser destruction then
|
<see cref="P:CefSharp.IBrowser.IsValid"/> will return <c>false</c> for <paramref name="browser"/>.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="oldFrame">the old frame object</param>
|
<param name="newFrame">the new frame object</param>
|
</member>
|
<member name="T:CefSharp.IJsDialogHandler">
|
<summary>
|
Implement this interface to handle events related to JavaScript dialogs.
|
The methods of this class will be called on the CEF UI thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IJsDialogHandler.OnJSDialog(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,CefSharp.CefJsDialogType,System.String,System.String,CefSharp.IJsDialogCallback,System.Boolean@)">
|
<summary>
|
Called to run a JavaScript dialog.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="originUrl">originating url</param>
|
<param name="dialogType">Dialog Type</param>
|
<param name="messageText">Message Text</param>
|
<param name="defaultPromptText">value will be specified for prompt dialogs only</param>
|
<param name="callback">Callback can be executed inline or in an async fashion</param>
|
<param name="suppressMessage">Set suppressMessage to true and return false to suppress the message (suppressing messages is preferable to immediately executing the callback as this is used to detect presumably malicious behavior like spamming alert messages in onbeforeunload). Set suppressMessage to false and return false to use the default implementation (the default implementation will show one modal dialog at a time and suppress any additional dialog requests until the displayed dialog is dismissed).</param>
|
<returns>Return true if the application will use a custom dialog or if the callback has been executed immediately. Custom dialogs may be either modal or modeless. If a custom dialog is used the application must execute |callback| once the custom dialog is dismissed.</returns>
|
</member>
|
<member name="M:CefSharp.IJsDialogHandler.OnBeforeUnloadDialog(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,System.Boolean,CefSharp.IJsDialogCallback)">
|
<summary>
|
Called to run a dialog asking the user if they want to leave a page. Return false to use the default dialog implementation.
|
Return true if the application will use a custom dialog or if the callback has been executed immediately.
|
Custom dialogs may be either modal or modeless. If a custom dialog is used the application must execute <paramref name="callback"/>
|
once the custom dialog is dismissed.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="messageText">message text (optional)</param>
|
<param name="isReload">indicates a page reload</param>
|
<param name="callback">Callback can be executed inline or in an async fashion</param>
|
<returns>Return false to use the default dialog implementation otherwise return true to handle with your own custom implementation.</returns>
|
</member>
|
<member name="M:CefSharp.IJsDialogHandler.OnResetDialogState(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called to cancel any pending dialogs and reset any saved dialog state. Will
|
be called due to events like page navigation irregardless of whether any
|
dialogs are currently pending.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
</member>
|
<member name="M:CefSharp.IJsDialogHandler.OnDialogClosed(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called when the dialog is closed.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
</member>
|
<member name="T:CefSharp.IKeyboardHandler">
|
<summary>
|
Implement this interface to handle events related to keyboard input.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IKeyboardHandler.OnPreKeyEvent(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.KeyType,System.Int32,System.Int32,CefSharp.CefEventFlags,System.Boolean,System.Boolean@)">
|
<summary>
|
Called before a keyboard event is sent to the renderer.
|
Return true if the event was handled or false
|
otherwise. If the event will be handled in <see cref="M:CefSharp.IKeyboardHandler.OnKeyEvent(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.KeyType,System.Int32,System.Int32,CefSharp.CefEventFlags,System.Boolean)"/> as a keyboard
|
shortcut set isKeyboardShortcut to true and return false.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance.</param>
|
<param name="type">Whether this was a key up/down/raw/etc...</param>
|
<param name="windowsKeyCode">
|
The Windows key code for the key event. This value is used by the DOM
|
specification. Sometimes it comes directly from the event (i.e. on
|
Windows) and sometimes it's determined using a mapping function. See
|
WebCore/platform/chromium/KeyboardCodes.h for the list of values.
|
</param>
|
<param name="nativeKeyCode">The native key code. On Windows this appears to be in the format of WM_KEYDOWN/WM_KEYUP/etc... lParam data.</param>
|
<param name="modifiers">What other modifier keys are currently down: Shift/Control/Alt/OS X Command/etc...</param>
|
<param name="isSystemKey">
|
Indicates whether the event is considered a "system key" event (see
|
http://msdn.microsoft.com/en-us/library/ms646286(VS.85).aspx for details).
|
</param>
|
<param name="isKeyboardShortcut">See the summary for an explanation of when to set this to true.</param>
|
<returns>Returns true if the event was handled or false otherwise.</returns>
|
</member>
|
<member name="M:CefSharp.IKeyboardHandler.OnKeyEvent(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.KeyType,System.Int32,System.Int32,CefSharp.CefEventFlags,System.Boolean)">
|
<summary>
|
Called after the renderer and JavaScript in the page has had a chance to
|
handle the event. Return true if the keyboard event was handled or false otherwise.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance.</param>
|
<param name="type">Whether this was a key up/down/raw/etc...</param>
|
<param name="windowsKeyCode">
|
The Windows key code for the key event. This value is used by the DOM
|
specification. Sometimes it comes directly from the event (i.e. on
|
Windows) and sometimes it's determined using a mapping function. See
|
WebCore/platform/chromium/KeyboardCodes.h for the list of values.
|
</param>
|
<param name="nativeKeyCode">The native key code. On Windows this appears to be in the format of WM_KEYDOWN/WM_KEYUP/etc... lParam data.</param>
|
<param name="modifiers">What other modifier keys are currently down: Shift/Control/Alt/OS X Command/etc...</param>
|
<param name="isSystemKey">
|
Indicates whether the event is considered a "system key" event (see
|
http://msdn.microsoft.com/en-us/library/ms646286(VS.85).aspx for details).
|
</param>
|
<returns>Return true if the keyboard event was handled or false otherwise.</returns>
|
</member>
|
<member name="T:CefSharp.ILifeSpanHandler">
|
<summary>
|
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.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ILifeSpanHandler.OnBeforePopup(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.String,System.String,CefSharp.WindowOpenDisposition,System.Boolean,CefSharp.IPopupFeatures,CefSharp.IWindowInfo,CefSharp.IBrowserSettings,System.Boolean@,CefSharp.IWebBrowser@)">
|
<summary>
|
Called before a popup window is created. By default the popup (browser) is created in a new native window.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance that launched this popup.</param>
|
<param name="frame">The HTML frame that launched this popup.</param>
|
<param name="targetUrl">The URL of the popup content. (This may be empty/null)</param>
|
<param name="targetFrameName">The name of the popup. (This may be empty/null)</param>
|
<param name="targetDisposition">The value indicates where the user intended to
|
open the popup (e.g. current tab, new tab, etc)</param>
|
<param name="userGesture">The value will be true if the popup was opened via explicit user gesture
|
(e.g. clicking a link) or false if the popup opened automatically (e.g. via the DomContentLoaded event).</param>
|
<param name="popupFeatures"> structure contains additional information about the requested popup window</param>
|
<param name="windowInfo">window information</param>
|
<param name="browserSettings">browser settings, defaults to source browsers</param>
|
<param name="noJavascriptAccess">value indicates whether the new browser window should be scriptable
|
and in the same process as the source browser.</param>
|
<param name="newBrowser">
|
EXPERIMENTAL - Low level this allows for assigning the CefClient instance associated with the new ChromiumWebBrowser instance to the CefClient param of the CefLifeSpanHandler::OnBeforeBrowser method.
|
This allows for all the handlers, LifeSpanHandler, DisplayHandler, etc to be associated with the CefClient of the new ChromiumWebBrowser instance to be associated with the popup (browser).
|
WPF/WinForms specific code is still required to host the popup (browser) in the new ChromiumWebBrowser instance.
|
Set to null for default behaviour. If you return true (cancel popup creation) then his property **MUST** be null, an exception will be thrown otherwise.
|
</param>
|
<returns>
|
By default the popup (browser) is opened in a new native window. If you return true then creation of the popup (browser) is cancelled, no further action will occur.
|
Otherwise return false to allow creation of the popup (browser).
|
</returns>
|
<remarks>
|
If you return true and set <paramref name="newBrowser"/> to not null then an exception will be thrown as creation of the popup (browser) was cancelled.
|
WinForms - To host the popup (browser) in a TAB/Custom Window see https://github.com/cefsharp/CefSharp/wiki/General-Usage#winforms---hosting-popup-using-tab-control for an easy method.
|
WPF - For an example of hosting the popup (browser) in a custom window see https://github.com/cefsharp/CefSharp/wiki/General-Usage#wpf---hosting-popup-in-new-window-experimental
|
Same can be applied for hosting the popup in a TAB.
|
This method is still EXPERIMENTAL and will likely require upstream bug fixes in CEF (https://bitbucket.org/chromiumembedded/cef).
|
</remarks>
|
</member>
|
<member name="M:CefSharp.ILifeSpanHandler.OnAfterCreated(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called after a new browser is created.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance</param>
|
</member>
|
<member name="M:CefSharp.ILifeSpanHandler.DoClose(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called when a browser has recieved a request to close. This may result
|
directly from a call to CefBrowserHost::CloseBrowser() or indirectly if the
|
browser is a top-level OS window created by CEF and the user attempts to
|
close the window. This method will be called after the JavaScript
|
'onunload' event has been fired. It will not be called for browsers after
|
the associated OS window has been destroyed (for those browsers it is no
|
longer possible to cancel the close).
|
|
If CEF created an OS window for the browser returning false will send an OS
|
close notification to the browser window's top-level owner (e.g. WM_CLOSE
|
on Windows, performClose: on OS-X and "delete_event" on Linux). If no OS
|
window exists (window rendering disabled) returning false will cause the
|
browser object to be destroyed immediately. Return true if the browser is
|
parented to another window and that other window needs to receive close
|
notification via some non-standard technique.
|
|
If an application provides its own top-level window it should handle OS
|
close notifications by calling CefBrowserHost::CloseBrowser(false) instead
|
of immediately closing (see the example below). This gives CEF an
|
opportunity to process the 'onbeforeunload' event and optionally cancel the
|
close before DoClose() is called.
|
|
The CefLifeSpanHandler::OnBeforeClose() method will be called immediately
|
before the browser object is destroyed. The application should only exit
|
after OnBeforeClose() has been called for all existing browsers.
|
|
If the browser represents a modal window and a custom modal loop
|
implementation was provided in CefLifeSpanHandler::RunModal() this callback
|
should be used to restore the opener window to a usable state.
|
|
By way of example consider what should happen during window close when the
|
browser is parented to an application-provided top-level OS window.
|
1. User clicks the window close button which sends an OS close
|
notification (e.g. WM_CLOSE on Windows, performClose: on OS-X and
|
"delete_event" on Linux).
|
2. Application's top-level window receives the close notification and:
|
A. Calls CefBrowserHost::CloseBrowser(false).
|
B. Cancels the window close.
|
3. JavaScript 'onbeforeunload' handler executes and shows the close
|
confirmation dialog (which can be overridden via
|
CefJSDialogHandler::OnBeforeUnloadDialog()).
|
4. User approves the close.
|
5. JavaScript 'onunload' handler executes.
|
6. Application's DoClose() handler is called. Application will:
|
A. Set a flag to indicate that the next close attempt will be allowed.
|
B. Return false.
|
7. CEF sends an OS close notification.
|
8. Application's top-level window receives the OS close notification and
|
allows the window to close based on the flag from #6B.
|
9. Browser OS window is destroyed.
|
10. Application's CefLifeSpanHandler::OnBeforeClose() handler is called and
|
the browser object is destroyed.
|
11. Application exits by calling CefQuitMessageLoop() if no other browsers
|
exist.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance - check if IsDisposed as it's possible when the browser is disposing</param>
|
<returns>For default behaviour return false</returns>
|
</member>
|
<member name="M:CefSharp.ILifeSpanHandler.OnBeforeClose(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called before a CefBrowser window (either the main browser for <see cref="T:CefSharp.IWebBrowser"/>,
|
or one of its children)
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">The browser instance</param>
|
</member>
|
<member name="T:CefSharp.ILoadHandler">
|
<summary>
|
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.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ILoadHandler.OnLoadingStateChange(CefSharp.IWebBrowser,CefSharp.LoadingStateChangedEventArgs)">
|
<summary>
|
Called when the loading state has changed. This callback will be executed twice
|
once when loading is initiated either programmatically or by user action,
|
and once when loading is terminated due to completion, cancellation of failure.
|
This method will be called on the CEF UI thread.
|
Blocking this thread will likely cause your UI to become unresponsive and/or hang.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="loadingStateChangedArgs">args</param>
|
</member>
|
<member name="M:CefSharp.ILoadHandler.OnFrameLoadStart(CefSharp.IWebBrowser,CefSharp.FrameLoadStartEventArgs)">
|
<summary>
|
Called when the browser begins loading a frame.
|
The <see cref="P:CefSharp.FrameLoadEndEventArgs.Frame"/> value will never be empty
|
Check the <see cref="P:CefSharp.IFrame.IsMain"/> method to see if this frame is the main frame.
|
Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended.
|
This method may not be called for a particular frame if the load request for that frame fails.
|
For notification of overall browser load status use <see cref="M:CefSharp.ILoadHandler.OnLoadingStateChange(CefSharp.IWebBrowser,CefSharp.LoadingStateChangedEventArgs)"/> instead.
|
This method will be called on the CEF UI thread.
|
Blocking this thread will likely cause your UI to become unresponsive and/or hang.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="frameLoadStartArgs">args</param>
|
<remarks>Whilst thist may seem like a logical place to execute js, it's called before the DOM has been loaded, implement
|
<see cref="M:CefSharp.IRenderProcessMessageHandler.OnContextCreated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)"/> as it's called when the underlying V8Context is created
|
(Only called for the main frame at this stage)</remarks>
|
</member>
|
<member name="M:CefSharp.ILoadHandler.OnFrameLoadEnd(CefSharp.IWebBrowser,CefSharp.FrameLoadEndEventArgs)">
|
<summary>
|
Called when the browser is done loading a frame.
|
The <see cref="P:CefSharp.FrameLoadEndEventArgs.Frame"/> value will never be empty
|
Check the <see cref="P:CefSharp.IFrame.IsMain"/> method to see if this frame is the main frame.
|
Multiple frames may be loading at the same time. Sub-frames may start or continue loading after the main frame load has ended.
|
This method will always be called for all frames irrespective of whether the request completes successfully.
|
This method will be called on the CEF UI thread.
|
Blocking this thread will likely cause your UI to become unresponsive and/or hang.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="frameLoadEndArgs">args</param>
|
</member>
|
<member name="M:CefSharp.ILoadHandler.OnLoadError(CefSharp.IWebBrowser,CefSharp.LoadErrorEventArgs)">
|
<summary>
|
Called when the resource load for a navigation fails or is canceled.
|
<see cref="P:CefSharp.LoadErrorEventArgs.ErrorCode"/> is the error code number, <see cref="P:CefSharp.LoadErrorEventArgs.ErrorText"/> is the error text and
|
<see cref="P:CefSharp.LoadErrorEventArgs.FailedUrl"/> is the URL that failed to load. See net\base\net_error_list.h
|
for complete descriptions of the error codes.
|
This method will be called on the CEF UI thread.
|
Blocking this thread will likely cause your UI to become unresponsive and/or hang.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="loadErrorArgs">args</param>
|
</member>
|
<member name="T:CefSharp.IPermissionHandler">
|
<summary>
|
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.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IPermissionHandler.OnRequestMediaAccessPermission(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.String,CefSharp.MediaAccessPermissionType,CefSharp.IMediaAccessCallback)">
|
<summary>
|
Called when a page requests permission to access media.
|
With the Chrome runtime, default handling will display the
|
permission request UI.With the Alloy runtime, default handling will deny
|
the request.This method will not be called if the "--enable-media-stream"
|
command-line switch is used to grant all permissions.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">The browser object</param>
|
<param name="frame">The frame object</param>
|
<param name="requestingOrigin">is the URL origin requesting permission.</param>
|
<param name="requestedPermissions">is a combination of values that represent the requested permissions</param>
|
<param name="callback">Callback interface used for asynchronous continuation of media access.</param>
|
<returns>Return true and call CefMediaAccessCallback methods either in this method or at a later time to continue or cancel the request.
|
Return false to proceed with default handling.
|
</returns>
|
</member>
|
<member name="M:CefSharp.IPermissionHandler.OnShowPermissionPrompt(CefSharp.IWebBrowser,CefSharp.IBrowser,System.UInt64,System.String,CefSharp.PermissionRequestType,CefSharp.IPermissionPromptCallback)">
|
<summary>
|
Called when a page should show a permission prompt.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">The browser object</param>
|
<param name="promptId">Uniquely identifies the prompt.</param>
|
<param name="requestingOrigin">Is the URL origin requesting permission.</param>
|
<param name="requestedPermissions">Is a combination of values from <see cref="T:CefSharp.PermissionRequestType"/> that represent the requested permissions.</param>
|
<param name="callback">Callback interface used for asynchronous continuation of permission prompts.</param>
|
<returns>
|
Return true and call <see cref="M:CefSharp.IPermissionPromptCallback.Continue(CefSharp.PermissionRequestResult)"/> either in this method or at a later time to continue or cancel the request.
|
Return false to proceed with default handling.
|
With the Chrome runtime, default handling will display the permission prompt UI.
|
With the Alloy runtime, default handling is <see cref="F:CefSharp.PermissionRequestResult.Ignore"/>.
|
</returns>
|
</member>
|
<member name="M:CefSharp.IPermissionHandler.OnDismissPermissionPrompt(CefSharp.IWebBrowser,CefSharp.IBrowser,System.UInt64,CefSharp.PermissionRequestResult)">
|
<summary>
|
Called when a permission prompt handled via <see cref="M:CefSharp.IPermissionHandler.OnShowPermissionPrompt(CefSharp.IWebBrowser,CefSharp.IBrowser,System.UInt64,System.String,CefSharp.PermissionRequestType,CefSharp.IPermissionPromptCallback)"/> is dismissed.
|
<paramref name="result"/> will be the value passed to
|
<see cref="M:CefSharp.IPermissionPromptCallback.Continue(CefSharp.PermissionRequestResult)"/> or <see cref="F:CefSharp.PermissionRequestResult.Ignore"/> if
|
the dialog was dismissed for other reasons such as navigation, browser
|
closure, etc. This method will not be called if <see cref="M:CefSharp.IPermissionHandler.OnShowPermissionPrompt(CefSharp.IWebBrowser,CefSharp.IBrowser,System.UInt64,System.String,CefSharp.PermissionRequestType,CefSharp.IPermissionPromptCallback)"/>
|
returned false for <paramref name="promptId"/>.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">The browser object</param>
|
<param name="promptId">Will match the value that was passed to <see cref="M:CefSharp.IPermissionHandler.OnShowPermissionPrompt(CefSharp.IWebBrowser,CefSharp.IBrowser,System.UInt64,System.String,CefSharp.PermissionRequestType,CefSharp.IPermissionPromptCallback)"/>.</param>
|
<param name="result">will be the value passed to <see cref="M:CefSharp.IPermissionPromptCallback.Continue(CefSharp.PermissionRequestResult)"/> or <see cref="F:CefSharp.PermissionRequestResult.Ignore"/> if the dialog was dismissed for other reasons such as navigation, browser closure, etc. This method will not be called if <see cref="M:CefSharp.IPermissionHandler.OnShowPermissionPrompt(CefSharp.IWebBrowser,CefSharp.IBrowser,System.UInt64,System.String,CefSharp.PermissionRequestType,CefSharp.IPermissionPromptCallback)"/> returned false for <paramref name="promptId"/>.</param>
|
</member>
|
<member name="T:CefSharp.IRenderProcessMessageHandler">
|
<summary>
|
Messages sent by the render process can be handled by implementing this
|
interface.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IRenderProcessMessageHandler.OnContextCreated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)">
|
<summary>
|
OnContextCreated is called in the Render process immediately after a CefV8Context is created.
|
An IPC message is immediately sent to notify the context has been created (should be safe to execute javascript).
|
If the page has no javascript then no V8Context will be created and as a result this method will not be called.
|
Called for every V8Context. To determine if V8Context is from Main frame check <see cref="P:CefSharp.IFrame.IsMain"/>
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">The browser object</param>
|
<param name="frame">The frame.</param>
|
</member>
|
<member name="M:CefSharp.IRenderProcessMessageHandler.OnContextReleased(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)">
|
<summary>
|
OnContextReleased is called in the Render process immediately before the CefV8Context is released.
|
An IPC message is immediately sent to notify the context has been released (cannot execute javascript this point).
|
If the page had no javascript then the context would not have been created and as a result this method will not be called.
|
Called for every V8Context. To determine if V8Context is from Main frame check <see cref="P:CefSharp.IFrame.IsMain"/>
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">The browser object</param>
|
<param name="frame">The frame.</param>
|
</member>
|
<member name="M:CefSharp.IRenderProcessMessageHandler.OnFocusedNodeChanged(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IDomNode)">
|
<summary>
|
Invoked when an element in the UI gains focus (or possibly no
|
element gains focus; i.e. an element lost focus).
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">The browser object</param>
|
<param name="frame">The frame object</param>
|
<param name="node">An object with information about the node (if any) that has focus.</param>
|
</member>
|
<member name="M:CefSharp.IRenderProcessMessageHandler.OnUncaughtException(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.JavascriptException)">
|
<summary>
|
OnUncaughtException is called for global uncaught exceptions in a frame. Execution of this callback is disabled by default.
|
To enable set CefSettings.UncaughtExceptionStackSize > 0.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">The browser object</param>
|
<param name="frame">The frame</param>
|
<param name="exception">The exception object with the message and stacktrace.</param>
|
</member>
|
<member name="T:CefSharp.IRequestContextHandler">
|
<summary>
|
Implement this interface to provide handler implementations. The handler
|
instance will not be released until all objects related to the context have
|
been destroyed.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IRequestContextHandler.OnRequestContextInitialized(CefSharp.IRequestContext)">
|
<summary>
|
Called immediately after the request context has been initialized.
|
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
|
thread.
|
</summary>
|
<param name="requestContext">the request context</param>
|
</member>
|
<member name="M:CefSharp.IRequestContextHandler.GetResourceRequestHandler(CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,System.Boolean,System.Boolean,System.String,System.Boolean@)">
|
<summary>
|
Called on the CEF IO thread before a resource request is initiated.
|
This method will not be called if the client associated with <paramref name="browser"/> returns a non-NULL value
|
from <see cref="M:CefSharp.IRequestHandler.GetResourceRequestHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,System.Boolean,System.Boolean,System.String,System.Boolean@)"/> for the same request (identified by <see cref="P:CefSharp.IRequest.Identifier"/>).
|
</summary>
|
<param name="browser">represent the source browser of the request, and may be null for requests originating from service workers.</param>
|
<param name="frame">represent the source frame of the request, and may be null for requests originating from service workers.</param>
|
<param name="request">represents the request contents and cannot be modified in this callback</param>
|
<param name="isNavigation">will be true if the resource request is a navigation</param>
|
<param name="isDownload">will be true if the resource request is a download</param>
|
<param name="requestInitiator">is the origin (scheme + domain) of the page that initiated the request</param>
|
<param name="disableDefaultHandling">Set to true to disable default handling of the request, in which case it will need to be handled via <see cref="M:CefSharp.IResourceRequestHandler.GetResourceHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)"/> or it will be canceled</param>
|
<returns>To allow the resource load to proceed with default handling return null. To specify a handler for the resource return a <see cref="T:CefSharp.IResourceRequestHandler"/> object.</returns>
|
</member>
|
<member name="T:CefSharp.IRequestHandler">
|
<summary>
|
Implement this interface to handle events related to browser requests.
|
The methods of this class will be called on the thread indicated.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IRequestHandler.OnBeforeBrowse(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,System.Boolean,System.Boolean)">
|
<summary>
|
Called before browser navigation.
|
If the navigation is allowed <see cref="E:CefSharp.IChromiumWebBrowserBase.FrameLoadStart"/> and <see cref="E:CefSharp.IChromiumWebBrowserBase.FrameLoadEnd"/>
|
will be called. If the navigation is canceled <see cref="E:CefSharp.IChromiumWebBrowserBase.LoadError"/> will be called with an ErrorCode
|
value of <see cref="F:CefSharp.CefErrorCode.Aborted"/>.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">The frame the request is coming from</param>
|
<param name="request">the request object - cannot be modified in this callback</param>
|
<param name="userGesture">The value will be true if the browser navigated via explicit user gesture
|
(e.g. clicking a link) or false if it navigated automatically (e.g. via the DomContentLoaded event).</param>
|
<param name="isRedirect">has the request been redirected</param>
|
<returns>Return true to cancel the navigation or false to allow the navigation to proceed.</returns>
|
</member>
|
<member name="M:CefSharp.IRequestHandler.OnDocumentAvailableInMainFrame(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called on the CEF UI thread when the window.document object of the main frame has been created.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
</member>
|
<member name="M:CefSharp.IRequestHandler.OnOpenUrlFromTab(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.String,CefSharp.WindowOpenDisposition,System.Boolean)">
|
<summary>
|
Called on the UI thread before OnBeforeBrowse in certain limited cases
|
where navigating a new or different browser might be desirable. This
|
includes user-initiated navigation that might open in a special way (e.g.
|
links clicked via middle-click or ctrl + left-click) and certain types of
|
cross-origin navigation initiated from the renderer process (e.g.
|
navigating the top-level frame to/from a file URL).
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="frame">The frame object</param>
|
<param name="targetUrl">target url</param>
|
<param name="targetDisposition">The value indicates where the user intended to navigate the browser based
|
on standard Chromium behaviors (e.g. current tab, new tab, etc). </param>
|
<param name="userGesture">The value will be true if the browser navigated via explicit user gesture
|
(e.g. clicking a link) or false if it navigated automatically (e.g. via the DomContentLoaded event).</param>
|
<returns>Return true to cancel the navigation or false to allow the navigation
|
to proceed in the source browser's top-level frame.</returns>
|
</member>
|
<member name="M:CefSharp.IRequestHandler.GetResourceRequestHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,System.Boolean,System.Boolean,System.String,System.Boolean@)">
|
<summary>
|
Called on the CEF IO thread before a resource request is initiated.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">represent the source browser of the request</param>
|
<param name="frame">represent the source frame of the request</param>
|
<param name="request">represents the request contents and cannot be modified in this callback</param>
|
<param name="isNavigation">will be true if the resource request is a navigation</param>
|
<param name="isDownload">will be true if the resource request is a download</param>
|
<param name="requestInitiator">is the origin (scheme + domain) of the page that initiated the request</param>
|
<param name="disableDefaultHandling">to true to disable default handling of the request, in which case it will need to be handled via <see cref="M:CefSharp.IResourceRequestHandler.GetResourceHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)"/> or it will be canceled</param>
|
<returns>To allow the resource load to proceed with default handling return null. To specify a handler for the resource return a <see cref="T:CefSharp.IResourceRequestHandler"/> object. If this callback returns null the same method will be called on the associated <see cref="T:CefSharp.IRequestContextHandler"/>, if any</returns>
|
</member>
|
<member name="M:CefSharp.IRequestHandler.GetAuthCredentials(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,System.Boolean,System.String,System.Int32,System.String,System.String,CefSharp.IAuthCallback)">
|
<summary>
|
Called when the browser needs credentials from the user.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="originUrl">is the origin making this authentication request</param>
|
<param name="isProxy">indicates whether the host is a proxy server</param>
|
<param name="host">hostname</param>
|
<param name="port">port number</param>
|
<param name="realm">realm</param>
|
<param name="scheme">scheme</param>
|
<param name="callback">Callback interface used for asynchronous continuation of authentication requests.</param>
|
<returns>Return true to continue the request and call <see cref="M:CefSharp.IAuthCallback.Continue(System.String,System.String)"/> when the authentication information is available. Return false to cancel the request. </returns>
|
</member>
|
<member name="M:CefSharp.IRequestHandler.OnCertificateError(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefErrorCode,System.String,CefSharp.ISslInfo,CefSharp.IRequestCallback)">
|
<summary>
|
Called to handle requests for URLs with an invalid SSL certificate.
|
Return true and call <see cref="M:CefSharp.IRequestCallback.Continue(System.Boolean)"/> either
|
in this method or at a later time to continue or cancel the request.
|
If CefSettings.IgnoreCertificateErrors is set all invalid certificates
|
will be accepted without calling this method.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="errorCode">the error code for this invalid certificate</param>
|
<param name="requestUrl">the url of the request for the invalid certificate</param>
|
<param name="sslInfo">ssl certificate information</param>
|
<param name="callback">Callback interface used for asynchronous continuation of url requests.
|
If empty the error cannot be recovered from and the request will be canceled automatically.</param>
|
<returns>Return false to cancel the request immediately. Return true and use <see cref="T:CefSharp.IRequestCallback"/> to
|
execute in an async fashion.</returns>
|
</member>
|
<member name="M:CefSharp.IRequestHandler.OnSelectClientCertificate(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Boolean,System.String,System.Int32,System.Security.Cryptography.X509Certificates.X509Certificate2Collection,CefSharp.ISelectClientCertificateCallback)">
|
<summary>
|
Called when the browser needs user to select Client Certificate for authentication requests (eg. PKI authentication).
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="isProxy">indicates whether the host is a proxy server</param>
|
<param name="host">hostname</param>
|
<param name="port">port number</param>
|
<param name="certificates">List of Client certificates for selection</param>
|
<param name="callback">Callback interface used for asynchronous continuation of client certificate selection for authentication requests.</param>
|
<returns>Return true to continue the request and call ISelectClientCertificateCallback.Select() with the selected certificate for authentication.
|
Return false to use the default behavior where the browser selects the first certificate from the list. </returns>
|
</member>
|
<member name="M:CefSharp.IRequestHandler.OnRenderViewReady(CefSharp.IWebBrowser,CefSharp.IBrowser)">
|
<summary>
|
Called on the CEF UI thread when the render view associated
|
with browser is ready to receive/handle IPC messages in the render
|
process.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
</member>
|
<member name="M:CefSharp.IRequestHandler.OnRenderProcessTerminated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefTerminationStatus)">
|
<summary>
|
Called when the render process terminates unexpectedly.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object</param>
|
<param name="status">indicates how the process terminated.</param>
|
</member>
|
<member name="T:CefSharp.IResourceHandler">
|
<summary>
|
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 <see cref="T:CefSharp.ResourceHandler"/>. For those upgrading, inherit from ResourceHandler instead of IResourceHandler
|
add the override keyword to existing methods e.g. ProcessRequestAsync.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IResourceHandler.Open(CefSharp.IRequest,System.Boolean@,CefSharp.ICallback)">
|
<summary>
|
Open the response stream.
|
- To handle the request immediately set <paramref name="handleRequest"/> to true and return true.
|
- To decide at a later time set <paramref name="handleRequest"/> to false, return true, and execute <paramref name="callback"/>
|
to continue or cancel the request.
|
- To cancel the request immediately set <paramref name="handleRequest"/> to true and return false.
|
This method will be called in sequence but not from a dedicated thread.
|
For backwards compatibility set <paramref name="handleRequest"/> to false and return false and the <see cref="M:CefSharp.IResourceHandler.ProcessRequest(CefSharp.IRequest,CefSharp.ICallback)"/> method
|
will be called.
|
</summary>
|
<param name="request">request </param>
|
<param name="handleRequest">see main summary</param>
|
<param name="callback">callback </param>
|
<returns>see main summary</returns>
|
</member>
|
<member name="M:CefSharp.IResourceHandler.ProcessRequest(CefSharp.IRequest,CefSharp.ICallback)">
|
<summary>
|
Begin processing the request.
|
</summary>
|
<param name="request">The request object.</param>
|
<param name="callback">The callback used to Continue or Cancel the request (async).</param>
|
<returns>To handle the request return true and call
|
<see cref="M:CefSharp.ICallback.Continue"/> once the response header information is available
|
<see cref="M:CefSharp.ICallback.Continue"/> can also be called from inside this method if
|
header information is available immediately).
|
To cancel the request return false.</returns>
|
</member>
|
<member name="M:CefSharp.IResourceHandler.GetResponseHeaders(CefSharp.IResponse,System.Int64@,System.String@)">
|
<summary>
|
Retrieve response header information. If the response length is not known
|
set <paramref name="responseLength"/> to -1 and ReadResponse() will be called until it
|
returns false. If the response length is known set <paramref name="responseLength"/>
|
to a positive value and ReadResponse() will be called until it returns
|
false or the specified number of bytes have been read.
|
|
It is also possible to set <paramref name="response"/> to a redirect http status code
|
and pass the new URL via a Location header. Likewise with <paramref name="redirectUrl"/> it
|
is valid to set a relative or fully qualified URL as the Location header
|
value. If an error occured while setting up the request you can call
|
<see cref="P:CefSharp.IResponse.ErrorCode"/> on <paramref name="response"/> to indicate the error condition.
|
</summary>
|
<param name="response">Use the response object to set the mime type, http status code and other optional header values.</param>
|
<param name="responseLength">If the response length is not known set responseLength to -1</param>
|
<param name="redirectUrl">To redirect the request to a new URL set this to the new URL. Can be either a relative or fully qualified URL.</param>
|
</member>
|
<member name="M:CefSharp.IResourceHandler.Skip(System.Int64,System.Int64@,CefSharp.Callback.IResourceSkipCallback)">
|
<summary>
|
Skip response data when requested by a Range header.
|
Skip over and discard bytesToSkip bytes of response data.
|
- If data is available immediately set bytesSkipped to the number of of bytes skipped and return true.
|
- To read the data at a later time set bytesSkipped to 0, return true and execute callback when the data is available.
|
- To indicate failure set bytesSkipped to < 0 (e.g. -2 for ERR_FAILED) and return false.
|
This method will be called in sequence but not from a dedicated thread.
|
</summary>
|
<param name="bytesToSkip">number of bytes to be skipped</param>
|
<param name="bytesSkipped">
|
If data is available immediately set bytesSkipped to the number of of bytes skipped and return true.
|
To read the data at a later time set bytesSkipped to 0, return true and execute callback when the data is available.
|
</param>
|
<param name="callback">To read the data at a later time set bytesSkipped to 0,
|
return true and execute callback when the data is available.</param>
|
<returns>See summary</returns>
|
</member>
|
<member name="M:CefSharp.IResourceHandler.Read(System.IO.Stream,System.Int32@,CefSharp.Callback.IResourceReadCallback)">
|
<summary>
|
Read response data. If data is available immediately copy up to
|
dataOut.Length bytes into dataOut, set bytesRead to the number of
|
bytes copied, and return true. To read the data at a later time keep a
|
pointer to dataOut, set bytesRead to 0, return true and execute
|
callback when the data is available (dataOut will remain valid until
|
the callback is executed). To indicate response completion set bytesRead
|
to 0 and return false. To indicate failure set bytesRead to < 0 (e.g. -2
|
for ERR_FAILED) and return false. This method will be called in sequence
|
but not from a dedicated thread.
|
|
For backwards compatibility set bytesRead to -1 and return false and the ReadResponse method will be called.
|
</summary>
|
<param name="dataOut">If data is available immediately copy up to <see cref="P:System.IO.Stream.Length"/> bytes into dataOut.</param>
|
<param name="bytesRead">To indicate response completion set bytesRead to 0 and return false.</param>
|
<param name="callback">set <paramref name="bytesRead"/> to 0, return true and execute callback when the data is available
|
(dataOut will remain valid until the callback is executed). If you have no need
|
of the callback then Dispose of it immediately.</param>
|
<returns>return true or false depending on the criteria, see summary.</returns>
|
</member>
|
<member name="M:CefSharp.IResourceHandler.ReadResponse(System.IO.Stream,System.Int32@,CefSharp.ICallback)">
|
<summary>
|
Read response data. If data is available immediately copy to
|
dataOut, set bytesRead to the number of bytes copied, and return true.
|
To read the data at a later time set bytesRead to 0, return true and call ICallback.Continue() when the
|
data is available. To indicate response completion return false.
|
</summary>
|
<param name="dataOut">Stream to write to</param>
|
<param name="bytesRead">Number of bytes copied to the stream</param>
|
<param name="callback">The callback used to Continue or Cancel the request (async).</param>
|
<returns>If data is available immediately copy to dataOut, set bytesRead to the number of bytes copied,
|
and return true.To indicate response completion return false.</returns>
|
<remarks>Depending on this size of your response this method may be called multiple times</remarks>
|
</member>
|
<member name="M:CefSharp.IResourceHandler.Cancel">
|
<summary>
|
Request processing has been canceled.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IResourceRequestHandler">
|
<summary>
|
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.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IResourceRequestHandler.GetCookieAccessFilter(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)">
|
<summary>
|
Called on the CEF IO thread before a resource request is loaded.
|
To optionally filter cookies for the request return a <see cref="T:CefSharp.ICookieAccessFilter"/> object.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="request">the request object - can be modified in this callback.</param>
|
<returns>To optionally filter cookies for the request return a ICookieAccessFilter instance otherwise return null.</returns>
|
</member>
|
<member name="M:CefSharp.IResourceRequestHandler.OnBeforeResourceLoad(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IRequestCallback)">
|
<summary>
|
Called on the CEF IO thread before a resource request is loaded.
|
To redirect or change the resource load optionally modify <paramref name="request"/>.
|
Modification of the request URL will be treated as a redirect
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="request">the request object - can be modified in this callback.</param>
|
<param name="callback">Callback interface used for asynchronous continuation of url requests.</param>
|
<returns>
|
Return <see cref="F:CefSharp.CefReturnValue.Continue"/> to continue the request immediately.
|
Return <see cref="F:CefSharp.CefReturnValue.ContinueAsync"/> and call <see cref="M:CefSharp.IRequestCallback.Continue(System.Boolean)"/> or <see cref="M:CefSharp.IRequestCallback.Cancel"/> at a later time to continue or the cancel the request asynchronously.
|
Return <see cref="F:CefSharp.CefReturnValue.Cancel"/> to cancel the request immediately.
|
</returns>
|
</member>
|
<member name="M:CefSharp.IResourceRequestHandler.GetResourceHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)">
|
<summary>
|
Called on the CEF IO thread before a resource is loaded. To specify a handler for the resource return a <see cref="T:CefSharp.IResourceHandler"/> object
|
</summary>
|
<param name="chromiumWebBrowser">The browser UI control</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="request">the request object - cannot be modified in this callback</param>
|
<returns>To allow the resource to load using the default network loader return null otherwise return an instance of <see cref="T:CefSharp.IResourceHandler"/> with a valid stream</returns>
|
</member>
|
<member name="M:CefSharp.IResourceRequestHandler.OnResourceRedirect(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse,System.String@)">
|
<summary>
|
Called on the CEF IO thread when a resource load is redirected.
|
The <paramref name="request"/> parameter will contain the old URL and other request-related information.
|
The <paramref name="response"/> parameter will contain the response that resulted in the
|
redirect. The <paramref name="newUrl"/> parameter will contain the new URL and can be changed if desired.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="request">the request object - cannot be modified in this callback</param>
|
<param name="response">the response object - cannot be modified in this callback</param>
|
<param name="newUrl">the new URL and can be changed if desired</param>
|
</member>
|
<member name="M:CefSharp.IResourceRequestHandler.OnResourceResponse(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse)">
|
<summary>
|
Called on the CEF IO thread when a resource response is received.
|
To allow the resource load to proceed without modification return false. To redirect or
|
retry the resource load optionally modify <paramref name="request"/> and return true.
|
Modification of the request URL will be treated as a redirect. Requests
|
handled using the default network loader cannot be redirected in this
|
callback.
|
|
WARNING: Redirecting using this method is deprecated. Use
|
OnBeforeResourceLoad or GetResourceHandler to perform redirects.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="request">the request object</param>
|
<param name="response">the response object - cannot be modified in this callback</param>
|
<returns>
|
To allow the resource load to proceed without modification return false. To redirect or
|
retry the resource load optionally modify <paramref name="request"/> and return true.
|
Modification of the request URL will be treated as a redirect.
|
Requests handled using the default network loader cannot be redirected in this callback.
|
</returns>
|
</member>
|
<member name="M:CefSharp.IResourceRequestHandler.GetResourceResponseFilter(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse)">
|
<summary>
|
Called on the CEF IO thread to optionally filter resource response content.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="request">the request object - cannot be modified in this callback</param>
|
<param name="response">the response object - cannot be modified in this callback</param>
|
<returns>Return an IResponseFilter to intercept this response, otherwise return null</returns>
|
</member>
|
<member name="M:CefSharp.IResourceRequestHandler.OnResourceLoadComplete(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse,CefSharp.UrlRequestStatus,System.Int64)">
|
<summary>
|
Called on the CEF IO thread when a resource load has completed.
|
This method will be called for all requests, including requests that are
|
aborted due to CEF shutdown or destruction of the associated browser. In
|
cases where the associated browser is destroyed this callback may arrive
|
after the <see cref="M:CefSharp.ILifeSpanHandler.OnBeforeClose(CefSharp.IWebBrowser,CefSharp.IBrowser)"/> callback for that browser. The
|
<see cref="P:CefSharp.IFrame.IsValid"/> method can be used to test for this situation, and care
|
should be taken not to call <paramref name="browser"/> or <paramref name="frame"/> methods that modify state
|
(like LoadURL, SendProcessMessage, etc.) if the frame is invalid.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="request">the request object - cannot be modified in this callback</param>
|
<param name="response">the response object - cannot be modified in this callback</param>
|
<param name="status">indicates the load completion status</param>
|
<param name="receivedContentLength">is the number of response bytes actually read.</param>
|
</member>
|
<member name="M:CefSharp.IResourceRequestHandler.OnProtocolExecution(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)">
|
<summary>
|
Called on the CEF UI thread to handle requests for URLs with an unknown protocol component.
|
SECURITY WARNING: YOU SHOULD USE THIS METHOD TO ENFORCE RESTRICTIONS BASED ON SCHEME, HOST OR OTHER URL ANALYSIS BEFORE ALLOWING OS EXECUTION.
|
</summary>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser control</param>
|
<param name="browser">the browser object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="frame">the frame object - may be null if originating from ServiceWorker or CefURLRequest</param>
|
<param name="request">the request object - cannot be modified in this callback</param>
|
<returns>return to true to attempt execution via the registered OS protocol handler, if any. Otherwise return false.</returns>
|
</member>
|
<member name="T:CefSharp.IApp">
|
<summary>
|
Implement this interface to provide handler implementations.
|
Methods will be called by the process and/or thread indicated.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IApp.BrowserProcessHandler">
|
<summary>
|
Return the handler for functionality specific to the browser process.
|
This method is called on multiple threads.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IApp.OnRegisterCustomSchemes(CefSharp.ISchemeRegistrar)">
|
<summary>
|
Provides an opportunity to register custom schemes. Do not keep a reference to the <paramref name="registrar"/> object.
|
This method is called on the main thread for each process and the registered schemes should be the same across all processes.
|
</summary>
|
<param name="registrar">scheme registra</param>
|
</member>
|
<member name="T:CefSharp.IBrowser">
|
<summary>
|
CefSharp interface for CefBrowser.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowser.IsValid">
|
<summary>
|
Returns True if this object is currently valid. This will return false after
|
<see cref="M:CefSharp.ILifeSpanHandler.OnBeforeClose(CefSharp.IWebBrowser,CefSharp.IBrowser)"/> is called.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowser.GetHost">
|
<summary>
|
Returns the browser host object. This method can only be called in the browser process.
|
</summary>
|
<returns>the browser host object</returns>
|
</member>
|
<member name="P:CefSharp.IBrowser.CanGoBack">
|
<summary>
|
Returns true if the browser can navigate backwards.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowser.GoBack">
|
<summary>
|
Navigate backwards.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowser.CanGoForward">
|
<summary>
|
Returns true if the browser can navigate forwards.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowser.GoForward">
|
<summary>
|
Navigate forwards.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowser.IsLoading">
|
<summary>
|
Returns true if the browser is currently loading.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowser.CloseBrowser(System.Boolean)">
|
<summary>
|
Request that the browser close. The JavaScript 'onbeforeunload' event will be fired.
|
</summary>
|
<param name="forceClose">
|
If forceClose is false the event handler, if any, will be allowed to prompt the user and the
|
user can optionally cancel the close. If forceClose is true the prompt will not be displayed
|
and the close will proceed. Results in a call to <see cref="M:CefSharp.ILifeSpanHandler.DoClose(CefSharp.IWebBrowser,CefSharp.IBrowser)"/> if
|
the event handler allows the close or if forceClose is true
|
See <see cref="M:CefSharp.ILifeSpanHandler.DoClose(CefSharp.IWebBrowser,CefSharp.IBrowser)"/> documentation for additional usage information.
|
</param>
|
</member>
|
<member name="M:CefSharp.IBrowser.Reload(System.Boolean)">
|
<summary>
|
Reload the current page.
|
</summary>
|
<param name="ignoreCache">
|
<c>true</c> a reload is performed ignoring browser cache; <c>false</c> a reload is
|
performed using files from the browser cache, if available.
|
</param>
|
</member>
|
<member name="M:CefSharp.IBrowser.StopLoad">
|
<summary>
|
Stop loading the page.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowser.Identifier">
|
<summary>
|
Returns the globally unique identifier for this browser.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowser.IsSame(CefSharp.IBrowser)">
|
<summary>
|
Returns true if this object is pointing to the same handle as that object.
|
</summary>
|
<param name="that">compare browser instances</param>
|
<returns>returns true if the same instance</returns>
|
</member>
|
<member name="P:CefSharp.IBrowser.IsPopup">
|
<summary>
|
Returns true if the window is a popup window.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowser.HasDocument">
|
<summary>
|
Returns true if a document has been loaded in the browser.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowser.MainFrame">
|
<summary>
|
Returns the main (top-level) frame for the browser window.
|
Returns null if there is currently no MainFrame.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowser.FocusedFrame">
|
<summary>
|
Returns the focused frame for the browser window or null.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowser.GetFrame(System.Int64)">
|
<summary>
|
Returns the frame with the specified identifier, or NULL if not found.
|
</summary>
|
<param name="identifier">identifier</param>
|
<returns>frame or null</returns>
|
</member>
|
<member name="M:CefSharp.IBrowser.GetFrame(System.String)">
|
<summary>
|
Returns the frame with the specified name, or NULL if not found.
|
</summary>
|
<param name="name">name of frame</param>
|
<returns>frame or null</returns>
|
</member>
|
<member name="M:CefSharp.IBrowser.GetFrameCount">
|
<summary>
|
Returns the number of frames that currently exist.
|
</summary>
|
<returns>the number of frames</returns>
|
</member>
|
<member name="M:CefSharp.IBrowser.GetFrameIdentifiers">
|
<summary>
|
Returns the identifiers of all existing frames.
|
</summary>
|
<returns>list of frame identifiers</returns>
|
</member>
|
<member name="M:CefSharp.IBrowser.GetFrameNames">
|
<summary>
|
Returns the names of all existing frames.
|
</summary>
|
<returns>frame names</returns>
|
</member>
|
<member name="P:CefSharp.IBrowser.IsDisposed">
|
<summary>
|
Gets a value indicating whether the browser has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IBrowserHost">
|
<summary>
|
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.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.AddWordToDictionary(System.String)">
|
<summary>
|
Add the specified word to the spelling dictionary.
|
</summary>
|
<param name="word">custom word to be added to dictionary</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.CloseBrowser(System.Boolean)">
|
<summary>
|
Request that the browser close. The JavaScript 'onbeforeunload' event will be fired.
|
</summary>
|
<param name="forceClose">
|
If forceClose is false the event handler, if any, will be allowed to prompt the user and the
|
user can optionally cancel the close. If forceClose is true the prompt will not be displayed
|
and the close will proceed. Results in a call to <see cref="M:CefSharp.ILifeSpanHandler.DoClose(CefSharp.IWebBrowser,CefSharp.IBrowser)"/> if
|
the event handler allows the close or if forceClose is true
|
See <see cref="M:CefSharp.ILifeSpanHandler.DoClose(CefSharp.IWebBrowser,CefSharp.IBrowser)"/> documentation for additional usage information.
|
</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.TryCloseBrowser">
|
<summary>
|
Helper for closing a browser. Call this method from the top-level window close handler. Internally this calls CloseBrowser(false) if the close has not yet been initiated. This method returns false while the close is pending and true after the close has completed.
|
See <see cref="M:CefSharp.IBrowserHost.CloseBrowser(System.Boolean)"/> and <see cref="M:CefSharp.ILifeSpanHandler.DoClose(CefSharp.IWebBrowser,CefSharp.IBrowser)"/> documentation for additional usage information. This method must be called on the CEF UI thread.
|
</summary>
|
<returns>
|
This method returns false while the close is pending and true after the close has completed
|
</returns>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.CloseDevTools">
|
<summary>
|
Explicitly close the developer tools window if one exists for this browser instance.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserHost.HasDevTools">
|
<summary>
|
Returns true if this browser currently has an associated DevTools browser.
|
Must be called on the CEF UI thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.SendDevToolsMessage(System.String)">
|
<summary>
|
Send a method call message over the DevTools protocol. <paramref name="messageAsJson"/> must be a
|
UTF8-encoded JSON dictionary that contains "id" (int), "method" (string)
|
and "params" (dictionary, optional) values. See the DevTools protocol
|
documentation at https://chromedevtools.github.io/devtools-protocol/ for
|
details of supported methods and the expected "params" dictionary contents.
|
<paramref name="messageAsJson"/> will be copied if necessary. This method will return true if
|
called on the CEF UI thread and the message was successfully submitted for
|
validation, otherwise false. Validation will be applied asynchronously and
|
any messages that fail due to formatting errors or missing parameters may
|
be discarded without notification. Prefer ExecuteDevToolsMethod if a more
|
structured approach to message formatting is desired.
|
|
Every valid method call will result in an asynchronous method result or
|
error message that references the sent message "id". Event messages are
|
received while notifications are enabled (for example, between method calls
|
for "Page.enable" and "Page.disable"). All received messages will be
|
delivered to the observer(s) registered with AddDevToolsMessageObserver.
|
See <see cref="M:CefSharp.Callback.IDevToolsMessageObserver.OnDevToolsMessage(CefSharp.IBrowser,System.IO.Stream)"/> documentation for details
|
of received message contents.
|
|
Usage of the SendDevToolsMessage, ExecuteDevToolsMethod and
|
AddDevToolsMessageObserver methods does not require an active DevTools
|
front-end or remote-debugging session. Other active DevTools sessions will
|
continue to function independently. However, any modification of global
|
browser state by one session may not be reflected in the UI of other
|
sessions.
|
|
Communication with the DevTools front-end (when displayed) can be logged
|
for development purposes by passing the
|
`--devtools-protocol-log-file=<path>` command-line flag.
|
</summary>
|
<param name="messageAsJson">must be a UTF8-encoded JSON dictionary that contains "id" (int), "method" (string)
|
and "params" (dictionary, optional) values. See comments above for further details.</param>
|
<returns>returns true if called on the CEF UI thread and the message was successfully submitted for
|
validation, otherwise false.</returns>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.ExecuteDevToolsMethod(System.Int32,System.String,System.String)">
|
<summary>
|
Execute a method call over the DevTools protocol. This is a more structured
|
version of SendDevToolsMessage.
|
See the DevTools protocol documentation at https://chromedevtools.github.io/devtools-protocol/ for details
|
of supported methods and the expected <paramref name="paramsAsJson"/> dictionary contents.
|
See the SendDevToolsMessage documentation for additional usage information.
|
</summary>
|
<param name="messageId">is an incremental number that uniquely identifies the message (pass 0 to have the next number assigned
|
automatically based on previous values)</param>
|
<param name="method">is the method name</param>
|
<param name="paramsAsJson">are the method parameters represented as a JSON string,
|
which may be empty.</param>
|
<returns>return the assigned message Id if called on the CEF UI thread and the message was
|
successfully submitted for validation, otherwise 0</returns>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.ExecuteDevToolsMethod(System.Int32,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
|
<summary>
|
Execute a method call over the DevTools protocol. This is a more structured
|
version of SendDevToolsMessage.
|
See the DevTools protocol documentation at https://chromedevtools.github.io/devtools-protocol/ for details
|
of supported methods and the expected <paramref name="parameters"/> dictionary contents.
|
See the SendDevToolsMessage documentation for additional usage information.
|
</summary>
|
<param name="messageId">is an incremental number that uniquely identifies the message (pass 0 to have the next number assigned
|
automatically based on previous values)</param>
|
<param name="method">is the method name</param>
|
<param name="parameters">are the method parameters represented as a dictionary,
|
which may be empty.</param>
|
<returns>return the assigned message Id if called on the CEF UI thread and the message was
|
successfully submitted for validation, otherwise 0</returns>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.GetNextDevToolsMessageId">
|
<summary>
|
Returns the next unique message id which can be used in <see cref="M:CefSharp.IBrowserHost.ExecuteDevToolsMethod(System.Int32,System.String,System.String)"/> or
|
<see cref="M:CefSharp.IBrowserHost.ExecuteDevToolsMethod(System.Int32,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})"/>.
|
</summary>
|
<returns>The next unique message id.</returns>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.AddDevToolsMessageObserver(CefSharp.Callback.IDevToolsMessageObserver)">
|
<summary>
|
Add an observer for DevTools protocol messages (method results and events).
|
The observer will remain registered until the returned Registration object
|
is destroyed. See the SendDevToolsMessage documentation for additional
|
usage information.
|
</summary>
|
<param name="observer">DevTools observer</param>
|
<returns>The observer will remain registered until the returned IRegistration object is Disposed.</returns>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.DragTargetDragEnter(CefSharp.IDragData,CefSharp.MouseEvent,CefSharp.Enums.DragOperationsMask)">
|
<summary>
|
Call this method when the user drags the mouse into the web view (before calling <see cref="M:CefSharp.IBrowserHost.DragTargetDragOver(CefSharp.MouseEvent,CefSharp.Enums.DragOperationsMask)"/>/<see cref="M:CefSharp.IBrowserHost.DragTargetDragLeave"/>/<see cref="M:CefSharp.IBrowserHost.DragTargetDragDrop(CefSharp.MouseEvent)"/>).
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.DragTargetDragOver(CefSharp.MouseEvent,CefSharp.Enums.DragOperationsMask)">
|
<summary>
|
Call this method each time the mouse is moved across the web view during a drag operation (after calling <see cref="M:CefSharp.IBrowserHost.DragTargetDragEnter(CefSharp.IDragData,CefSharp.MouseEvent,CefSharp.Enums.DragOperationsMask)"/> and before calling <see cref="M:CefSharp.IBrowserHost.DragTargetDragLeave"/>/<see cref="M:CefSharp.IBrowserHost.DragTargetDragDrop(CefSharp.MouseEvent)"/>).
|
This method is only used when window rendering is disabled.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.DragTargetDragDrop(CefSharp.MouseEvent)">
|
<summary>
|
Call this method when the user completes the drag operation by dropping the object onto the web view (after calling <see cref="M:CefSharp.IBrowserHost.DragTargetDragEnter(CefSharp.IDragData,CefSharp.MouseEvent,CefSharp.Enums.DragOperationsMask)"/>).
|
The object being dropped is <see cref="T:CefSharp.IDragData"/>, given as an argument to the previous <see cref="M:CefSharp.IBrowserHost.DragTargetDragEnter(CefSharp.IDragData,CefSharp.MouseEvent,CefSharp.Enums.DragOperationsMask)"/> call.
|
This method is only used when window rendering is disabled.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.DragSourceEndedAt(System.Int32,System.Int32,CefSharp.Enums.DragOperationsMask)">
|
<summary>
|
Call this method when the drag operation started by a <see cref="M:CefSharp.Internals.IRenderWebBrowser.StartDragging(CefSharp.IDragData,CefSharp.Enums.DragOperationsMask,System.Int32,System.Int32)"/> call has ended either in a drop or by being cancelled.
|
If the web view is both the drag source and the drag target then all DragTarget* methods should be called before DragSource* methods.
|
This method is only used when window rendering is disabled.
|
</summary>
|
<param name="x">x mouse coordinate relative to the upper-left corner of the view.</param>
|
<param name="y">y mouse coordinate relative to the upper-left corner of the view.</param>
|
<param name="op">Drag Operations mask</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.DragTargetDragLeave">
|
<summary>
|
Call this method when the user drags the mouse out of the web view (after calling <see cref="M:CefSharp.IBrowserHost.DragTargetDragEnter(CefSharp.IDragData,CefSharp.MouseEvent,CefSharp.Enums.DragOperationsMask)"/>).
|
This method is only used when window rendering is disabled.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.DragSourceSystemDragEnded">
|
<summary>
|
Call this method when the drag operation started by a <see cref="M:CefSharp.Internals.IRenderWebBrowser.StartDragging(CefSharp.IDragData,CefSharp.Enums.DragOperationsMask,System.Int32,System.Int32)"/> call has completed.
|
This method may be called immediately without first calling DragSourceEndedAt to cancel a drag operation.
|
If the web view is both the drag source and the drag target then all DragTarget* methods should be called before DragSource* mthods.
|
This method is only used when window rendering is disabled.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.Find(System.String,System.Boolean,System.Boolean,System.Boolean)">
|
<summary>
|
Search for <paramref name="searchText"/>.
|
</summary>
|
<param name="searchText">text to search for</param>
|
<param name="forward">indicates whether to search forward or backward within the page</param>
|
<param name="matchCase">indicates whether the search should be case-sensitive</param>
|
<param name="findNext">indicates whether this is the first request or a follow-up</param>
|
<remarks>The <see cref="T:CefSharp.IFindHandler"/> instance, if any, will be called to report find results.</remarks>
|
</member>
|
<member name="P:CefSharp.IBrowserHost.Extension">
|
<summary>
|
Returns the extension hosted in this browser or null if no extension is hosted. See <see cref="M:CefSharp.IRequestContext.LoadExtension(System.String,System.String,CefSharp.IExtensionHandler)"/> for details.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.GetOpenerWindowHandle">
|
<summary>
|
Retrieve the window handle of the browser that opened this browser.
|
</summary>
|
<returns>The handler</returns>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.GetWindowHandle">
|
<summary>
|
Retrieve the window handle for this browser.
|
</summary>
|
<returns>The handler</returns>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.GetZoomLevel">
|
<summary>
|
Gets the current zoom level. The default zoom level is 0.0. This method can only be called on the CEF UI thread.
|
</summary>
|
<returns>zoom level (default is 0.0)</returns>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.GetZoomLevelAsync">
|
<summary>
|
Get the current zoom level. The default zoom level is 0.0. This method executes GetZoomLevel on the CEF UI thread
|
in an async fashion.
|
</summary>
|
<returns> a <see cref="T:System.Threading.Tasks.Task`1"/> that when executed returns the zoom level as a double.</returns>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.Invalidate(CefSharp.PaintElementType)">
|
<summary>
|
Invalidate the view. The browser will call CefRenderHandler::OnPaint asynchronously.
|
This method is only used when window rendering is disabled (OSR).
|
</summary>
|
<param name="type">indicates which surface to re-paint either View or Popup.</param>
|
</member>
|
<member name="P:CefSharp.IBrowserHost.IsBackgroundHost">
|
<summary>
|
Returns true if this browser is hosting an extension background script. Background hosts do not have a window and are not displayable.
|
See <see cref="M:CefSharp.IRequestContext.LoadExtension(System.String,System.String,CefSharp.IExtensionHandler)"/> for details.
|
</summary>
|
<returns>Returns true if this browser is hosting an extension background script.</returns>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.ImeSetComposition(System.String,CefSharp.Structs.CompositionUnderline[],System.Nullable{CefSharp.Structs.Range},System.Nullable{CefSharp.Structs.Range})">
|
<summary>
|
Begins a new composition or updates the existing composition. Blink has a
|
special node (a composition node) that allows the input method to change
|
text without affecting other DOM nodes.
|
|
This method may be called multiple times as the composition changes. When
|
the client is done making changes the composition should either be canceled
|
or completed. To cancel the composition call ImeCancelComposition. To
|
complete the composition call either ImeCommitText or
|
ImeFinishComposingText. Completion is usually signaled when:
|
The client receives a WM_IME_COMPOSITION message with a GCS_RESULTSTR
|
flag (on Windows).
|
This method is only used when window rendering is disabled. (WPF and OffScreen)
|
</summary>
|
<param name="text">is the optional text that
|
will be inserted into the composition node</param>
|
<param name="underlines">is an optional set
|
of ranges that will be underlined in the resulting text.</param>
|
<param name="replacementRange">is an optional range of the existing text that will be replaced. (MAC OSX ONLY)</param>
|
<param name="selectionRange"> is an optional range of the resulting text that
|
will be selected after insertion or replacement. </param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.ImeCommitText(System.String,System.Nullable{CefSharp.Structs.Range},System.Int32)">
|
<summary>
|
Completes the existing composition by optionally inserting the specified
|
text into the composition node.
|
This method is only used when window rendering is disabled. (WPF and OffScreen)
|
</summary>
|
<param name="text">text that will be committed</param>
|
<param name="replacementRange">is an optional range of the existing text that will be replaced. (MAC OSX ONLY)</param>
|
<param name="relativeCursorPos">is where the cursor will be positioned relative to the current cursor position. (MAC OSX ONLY)</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.ImeFinishComposingText(System.Boolean)">
|
<summary>
|
Completes the existing composition by applying the current composition node
|
contents. See comments on ImeSetComposition for usage.
|
This method is only used when window rendering is disabled. (WPF and OffScreen)
|
</summary>
|
<param name="keepSelection">If keepSelection is false the current selection, if any, will be discarded.</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.ImeCancelComposition">
|
<summary>
|
Cancels the existing composition and discards the composition node
|
contents without applying them. See comments on ImeSetComposition for
|
usage.
|
This method is only used when window rendering is disabled. (WPF and OffScreen)
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.NotifyMoveOrResizeStarted">
|
<summary>
|
Notify the browser that the window hosting it is about to be moved or resized.
|
This will dismiss any existing popups (dropdowns).
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.NotifyScreenInfoChanged">
|
<summary>
|
Send a notification to the browser that the screen info has changed.
|
The browser will then call CefRenderHandler::GetScreenInfo to update the screen information with the new values.
|
This simulates moving the webview window from one display to another, or changing the properties of the current display.
|
This method is only used when window rendering is disabled.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.Print">
|
<summary>
|
Print the current browser contents.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.PrintToPdf(System.String,CefSharp.PdfPrintSettings,CefSharp.IPrintToPdfCallback)">
|
<summary>
|
Asynchronously prints the current browser contents to the Pdf file specified.
|
The caller is responsible for deleting the file when done.
|
</summary>
|
<param name="path">Output file location.</param>
|
<param name="settings">Print Settings, can be null</param>
|
<param name="callback">Callback executed when printing complete</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.ReplaceMisspelling(System.String)">
|
<summary>
|
If a misspelled word is currently selected in an editable node calling this method will replace it with the specified word.
|
</summary>
|
<param name="word">word to be replaced</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.RunFileDialog(CefSharp.CefFileDialogMode,System.String,System.String,System.Collections.Generic.IList{System.String},CefSharp.Callback.IRunFileDialogCallback)">
|
<summary>
|
Call to run a file chooser dialog. Only a single file chooser dialog may be pending at any given time.
|
The dialog will be initiated asynchronously on the CEF UI thread.
|
</summary>
|
<param name="mode">represents the type of dialog to display</param>
|
<param name="title">to the title to be used for the dialog and may be empty to show the default title ("Open" or "Save" depending on the mode)</param>
|
<param name="defaultFilePath">is the path with optional directory and/or file name component that will be initially selected in the dialog</param>
|
<param name="acceptFilters">are used to restrict the selectable file types and may any combination of (a) valid lower-cased MIME types (e.g. "text/*" or "image/*"), (b) individual file extensions (e.g. ".txt" or ".png"), or (c) combined description and file extension delimited using "|" and ";" (e.g. "Image Types|.png;.gif;.jpg")</param>
|
<param name="callback">will be executed after the dialog is dismissed or immediately if another dialog is already pending.</param>
|
</member>
|
<member name="P:CefSharp.IBrowserHost.RequestContext">
|
<summary>
|
Returns the request context for this browser.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.SendExternalBeginFrame">
|
<summary>
|
Issue a BeginFrame request to Chromium.
|
Only valid when <see cref="P:CefSharp.IWindowInfo.ExternalBeginFrameEnabled"/> is set to true.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.SendCaptureLostEvent">
|
<summary>
|
Send a capture lost event to the browser.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.SendFocusEvent(System.Boolean)">
|
<summary>
|
Send a focus event to the browser. . (Used for OSR Rendering e.g. WPF or OffScreen)
|
</summary>
|
<param name="setFocus">set focus</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.SendKeyEvent(CefSharp.KeyEvent)">
|
<summary>
|
Send a key event to the browser.
|
</summary>
|
<param name="keyEvent">represents keyboard event</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.SendKeyEvent(System.Int32,System.Int32,System.Int32)">
|
<summary>
|
Send key event to browser based on operating system message
|
</summary>
|
<param name="message">message</param>
|
<param name="wParam">wParam</param>
|
<param name="lParam">lParam</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.SendMouseClickEvent(CefSharp.MouseEvent,CefSharp.MouseButtonType,System.Boolean,System.Int32)">
|
<summary>
|
Send a mouse click event to the browser.
|
</summary>
|
<param name="mouseEvent">mouse event - x, y and modifiers</param>
|
<param name="mouseButtonType">Mouse ButtonType</param>
|
<param name="mouseUp">mouse up</param>
|
<param name="clickCount">click count</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.SendMouseWheelEvent(CefSharp.MouseEvent,System.Int32,System.Int32)">
|
<summary>
|
Send a mouse wheel event to the browser.
|
</summary>
|
<param name="mouseEvent">mouse event - x, y and modifiers</param>
|
<param name="deltaX">Movement delta for X direction.</param>
|
<param name="deltaY">movement delta for Y direction.</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.SendTouchEvent(CefSharp.Structs.TouchEvent)">
|
<summary>
|
Send a touch event to the browser.
|
WPF and OffScreen browsers only
|
</summary>
|
<param name="evt">touch event</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.SetAccessibilityState(CefSharp.CefState)">
|
<summary>
|
Set accessibility state for all frames. If accessibilityState is Default then accessibility will be disabled by default
|
and the state may be further controlled with the "force-renderer-accessibility" and "disable-renderer-accessibility"
|
command-line switches. If accessibilityState is STATE_ENABLED then accessibility will be enabled.
|
If accessibilityState is STATE_DISABLED then accessibility will be completely disabled. For windowed browsers
|
accessibility will be enabled in Complete mode (which corresponds to kAccessibilityModeComplete in Chromium).
|
In this mode all platform accessibility objects will be created and managed by Chromium's internal implementation.
|
The client needs only to detect the screen reader and call this method appropriately. For example, on Windows the
|
client can handle WM_GETOBJECT with OBJID_CLIENT to detect accessibility readers. For windowless browsers accessibility
|
will be enabled in TreeOnly mode (which corresponds to kAccessibilityModeWebContentsOnly in Chromium). In this mode
|
renderer accessibility is enabled, the full tree is computed, and events are passed to IAccessibiltyHandler,
|
but platform accessibility objects are not created. The client may implement platform accessibility objects using
|
IAccessibiltyHandler callbacks if desired.
|
</summary>
|
<param name="accessibilityState">may be default, enabled or disabled.</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.SetAutoResizeEnabled(System.Boolean,CefSharp.Structs.Size,CefSharp.Structs.Size)">
|
<summary>
|
Enable notifications of auto resize via IDisplayHandler.OnAutoResize. Notifications are disabled by default.
|
</summary>
|
<param name="enabled">enable auto resize</param>
|
<param name="minSize">minimum size</param>
|
<param name="maxSize">maximum size</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.SetFocus(System.Boolean)">
|
<summary>
|
Set whether the browser is focused. (Used for Normal Rendering e.g. WinForms)
|
</summary>
|
<param name="focus">set focus</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.SetZoomLevel(System.Double)">
|
<summary>
|
Change the zoom level to the specified value. Specify 0.0 to reset the zoom level.
|
If called on the CEF UI thread the change will be applied immediately.
|
Otherwise, the change will be applied asynchronously on the UI thread.
|
</summary>
|
<param name="zoomLevel">zoom level</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.ShowDevTools(CefSharp.IWindowInfo,System.Int32,System.Int32)">
|
<summary>
|
Open developer tools in its own window. If inspectElementAtX and/or inspectElementAtY are specified then
|
the element at the specified (x,y) location will be inspected.
|
</summary>
|
<param name="windowInfo">window info used for showing dev tools</param>
|
<param name="inspectElementAtX">x coordinate (used for inspectElement)</param>
|
<param name="inspectElementAtY">y coordinate (used for inspectElement)</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.StartDownload(System.String)">
|
<summary>
|
Download the file at url using <see cref="T:CefSharp.IDownloadHandler"/>.
|
</summary>
|
<param name="url">url to download</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.StopFinding(System.Boolean)">
|
<summary>
|
Cancel all searches that are currently going on.
|
</summary>
|
<param name="clearSelection">clear the selection</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.SendMouseMoveEvent(CefSharp.MouseEvent,System.Boolean)">
|
<summary>
|
Send a mouse move event to the browser, coordinates,
|
</summary>
|
<param name="mouseEvent">mouse information, x and y values are relative to upper-left corner of view</param>
|
<param name="mouseLeave">mouse leave</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.WasHidden(System.Boolean)">
|
<summary>
|
Notify the browser that it has been hidden or shown.
|
Layouting and rendering notification will stop when the browser is hidden.
|
This method is only used when window rendering is disabled (WPF/OffScreen).
|
</summary>
|
<param name="hidden">if true the browser will be notified that it was hidden.</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.WasResized">
|
<summary>
|
Notify the browser that the widget has been resized.
|
The browser will first call CefRenderHandler::GetViewRect to get the new size and then call CefRenderHandler::OnPaint asynchronously with the updated regions.
|
This method is only used when window rendering is disabled.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.GetNavigationEntries(CefSharp.INavigationEntryVisitor,System.Boolean)">
|
<summary>
|
Retrieve a snapshot of current navigation entries as values sent to the
|
specified visitor.
|
</summary>
|
<param name="visitor">visitor</param>
|
<param name="currentOnly">If true only the current navigation
|
entry will be sent, otherwise all navigation entries will be sent.</param>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.GetVisibleNavigationEntry">
|
<summary>
|
Returns the current visible navigation entry for this browser. This method
|
can only be called on the CEF UI thread which by default is not the same
|
as your application UI thread.
|
</summary>
|
<returns>the current navigation entry</returns>
|
</member>
|
<member name="P:CefSharp.IBrowserHost.WindowlessFrameRate">
|
<summary>
|
Gets/sets the maximum rate in frames per second (fps) that CefRenderHandler::
|
OnPaint will be called for a windowless browser. The actual fps may be
|
lower if the browser cannot generate frames at the requested rate. The
|
minimum value is 1 and the maximum value is 60 (default 30). This method
|
can only be called on the UI thread. Can also be set at browser creation
|
via BrowserSettings.WindowlessFrameRate.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserHost.WindowRenderingDisabled">
|
<summary>
|
Returns true if window rendering is disabled.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserHost.SetAudioMuted(System.Boolean)">
|
<summary>
|
Set whether the browser's audio is muted.
|
</summary>
|
<param name="mute">true or false</param>
|
</member>
|
<member name="P:CefSharp.IBrowserHost.IsAudioMuted">
|
<summary>
|
Returns true if the browser's audio is muted.
|
This method can only be called on the CEF UI thread.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserHost.IsDisposed">
|
<summary>
|
Gets a value indicating whether the browserHost has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IBrowserSettings">
|
<summary>
|
Interface representing browser initialization settings.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.StandardFontFamily">
|
<summary>
|
StandardFontFamily
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.FixedFontFamily">
|
<summary>
|
FixedFontFamily
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.SerifFontFamily">
|
<summary>
|
SerifFontFamily
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.SansSerifFontFamily">
|
<summary>
|
SansSerifFontFamily
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.CursiveFontFamily">
|
<summary>
|
CursiveFontFamily
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.FantasyFontFamily">
|
<summary>
|
FantasyFontFamily
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.DefaultFontSize">
|
<summary>
|
DefaultFontSize
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.DefaultFixedFontSize">
|
<summary>
|
DefaultFixedFontSize
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.MinimumFontSize">
|
<summary>
|
MinimumFontSize
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.MinimumLogicalFontSize">
|
<summary>
|
MinimumLogicalFontSize
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.DefaultEncoding">
|
<summary>
|
Default encoding for Web content. If empty "ISO-8859-1" will be used. Also
|
configurable using the "default-encoding" command-line switch.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.RemoteFonts">
|
<summary>
|
Controls the loading of fonts from remote sources. Also configurable using
|
the "disable-remote-fonts" command-line switch.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.Javascript">
|
<summary>
|
Controls whether JavaScript can be executed. (Used to Enable/Disable javascript)
|
Also configurable using the "disable-javascript" command-line switch.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.JavascriptCloseWindows">
|
<summary>
|
Controls whether JavaScript can be used to close windows that were not
|
opened via JavaScript. JavaScript can still be used to close windows that
|
were opened via JavaScript. Also configurable using the
|
"disable-javascript-close-windows" command-line switch.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.JavascriptAccessClipboard">
|
<summary>
|
Controls whether JavaScript can access the clipboard. Also configurable
|
using the "disable-javascript-access-clipboard" command-line switch.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.JavascriptDomPaste">
|
<summary>
|
Controls whether DOM pasting is supported in the editor via
|
execCommand("paste"). The |javascript_access_clipboard| setting must also
|
be enabled. Also configurable using the "disable-javascript-dom-paste"
|
command-line switch.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.ImageLoading">
|
<summary>
|
Controls whether image URLs will be loaded from the network. A cached image
|
will still be rendered if requested. Also configurable using the
|
"disable-image-loading" command-line switch.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.ImageShrinkStandaloneToFit">
|
<summary>
|
Controls whether standalone images will be shrunk to fit the page. Also
|
configurable using the "image-shrink-standalone-to-fit" command-line
|
switch.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.TextAreaResize">
|
<summary>
|
Controls whether text areas can be resized. Also configurable using the
|
"disable-text-area-resize" command-line switch.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.TabToLinks">
|
<summary>
|
Controls whether the tab key can advance focus to links. Also configurable
|
using the "disable-tab-to-links" command-line switch.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.LocalStorage">
|
<summary>
|
Controls whether local storage can be used. Also configurable using the
|
"disable-local-storage" command-line switch.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.Databases">
|
<summary>
|
Controls whether databases can be used. Also configurable using the
|
"disable-databases" command-line switch.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.WebGl">
|
<summary>
|
Controls whether WebGL can be used. Note that WebGL requires hardware
|
support and may not work on all systems even when enabled. Also
|
configurable using the "disable-webgl" command-line switch.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.BackgroundColor">
|
<summary>
|
Opaque background color used for the browser before a document is loaded
|
and when no document color is specified. By default the background color
|
will be the same as CefSettings.BackgroundColor. Only the RGB compontents
|
of the specified value will be used. The alpha component must greater than
|
0 to enable use of the background color but will be otherwise ignored.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.AcceptLanguageList">
|
<summary>
|
Comma delimited ordered list of language codes without any whitespace that
|
will be used in the "Accept-Language" HTTP header. May be overridden on a
|
per-browser basis using the CefBrowserSettings.AcceptLanguageList value.
|
If both values are empty then "en-US,en" will be used. Can be overridden
|
for individual RequestContext instances via the
|
RequestContextSettings.AcceptLanguageList value.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.WindowlessFrameRate">
|
<summary>
|
The maximum rate in frames per second (fps) that CefRenderHandler::OnPaint
|
will be called for a windowless browser. The actual fps may be lower if
|
the browser cannot generate frames at the requested rate. The minimum
|
value is 1 and the maximum value is 60 (default 30). This value can also be
|
changed dynamically via IBrowserHost.SetWindowlessFrameRate.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.IsDisposed">
|
<summary>
|
Gets a value indicating if the browser settings has been disposed.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IBrowserSettings.AutoDispose">
|
<summary>
|
Gets a value indicating if the browser settings instance was created internally by CefSharp.
|
Instances created by CefSharp will be Disposed of after use. To control the lifespan yourself
|
create an set BrowserSettings yourself.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IBrowserSettings.UnWrap">
|
<summary>
|
Used internally to get the underlying <see cref="T:CefSharp.IBrowserSettings"/> instance.
|
Unlikely you'll use this yourself.
|
</summary>
|
<returns>the inner most instance</returns>
|
</member>
|
<member name="T:CefSharp.IChromiumWebBrowserBase">
|
<summary>
|
Interface for common events/methods/properties for ChromiumWebBrowser and popup host implementations.
|
</summary>
|
<seealso cref="T:System.IDisposable" />
|
</member>
|
<member name="E:CefSharp.IChromiumWebBrowserBase.ConsoleMessage">
|
<summary>
|
Event handler for receiving Javascript console messages being sent from web pages.
|
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
|
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
|
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
|
(The exception to this is when you're running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
|
</summary>
|
</member>
|
<member name="E:CefSharp.IChromiumWebBrowserBase.StatusMessage">
|
<summary>
|
Event handler for changes to the status message.
|
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
|
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.
|
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
|
(The exception to this is when you're running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
|
</summary>
|
</member>
|
<member name="E:CefSharp.IChromiumWebBrowserBase.FrameLoadStart">
|
<summary>
|
Event handler that will get called when the browser begins loading a frame. Multiple frames may be loading at the same
|
time. Sub-frames may start or continue loading after the main frame load has ended. This method may not be called for a
|
particular frame if the load request for that frame fails. For notification of overall browser load status use
|
OnLoadingStateChange instead.
|
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
|
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
|
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
|
</summary>
|
<remarks>Whilst this may seem like a logical place to execute js, it's called before the DOM has been loaded, implement
|
<see cref="M:CefSharp.IRenderProcessMessageHandler.OnContextCreated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)"/> as it's called when the underlying V8Context is created
|
</remarks>
|
</member>
|
<member name="E:CefSharp.IChromiumWebBrowserBase.FrameLoadEnd">
|
<summary>
|
Event handler that will get called when the browser is done loading a frame. Multiple frames may be loading at the same
|
time. Sub-frames may start or continue loading after the main frame load has ended. This method will always be called
|
for all frames irrespective of whether the request completes successfully.
|
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
|
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
|
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
|
</summary>
|
</member>
|
<member name="E:CefSharp.IChromiumWebBrowserBase.LoadError">
|
<summary>
|
Event handler that will get called when the resource load for a navigation fails or is canceled.
|
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
|
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
|
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
|
</summary>
|
</member>
|
<member name="E:CefSharp.IChromiumWebBrowserBase.LoadingStateChanged">
|
<summary>
|
Event handler that will get called when the Loading state has changed.
|
This event will be fired twice. Once when loading is initiated either programmatically or
|
by user action, and once when loading is terminated due to completion, cancellation of failure.
|
It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
|
thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
|
To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IChromiumWebBrowserBase.LoadUrl(System.String)">
|
<summary>
|
Loads the specified <paramref name="url"/> in the Main Frame.
|
Same as calling <see cref="M:CefSharp.IWebBrowser.Load(System.String)"/>
|
</summary>
|
<param name="url">The URL to be loaded.</param>
|
<remarks>
|
This is exactly the same as calling Load(string), it was added
|
as the method name is more meaningful and easier to discover
|
via Intellisense.
|
</remarks>
|
</member>
|
<member name="M:CefSharp.IChromiumWebBrowserBase.LoadUrlAsync(System.String)">
|
<summary>
|
Load the <paramref name="url"/> in the main frame of the browser
|
</summary>
|
<param name="url">url to load</param>
|
<returns>
|
A <see cref="T:System.Threading.Tasks.Task`1"/> that can be awaited to load the <paramref name="url"/> and return the HttpStatusCode and <see cref="T:CefSharp.CefErrorCode"/>.
|
A HttpStatusCode equal to 200 and <see cref="F:CefSharp.CefErrorCode.None"/> is considered a success.
|
</returns>
|
</member>
|
<member name="M:CefSharp.IChromiumWebBrowserBase.WaitForNavigationAsync(System.Nullable{System.TimeSpan},System.Threading.CancellationToken)">
|
<summary>
|
This resolves when the browser navigates to a new URL or reloads.
|
It is useful for when you run code which will indirectly cause the browser to navigate.
|
A common use case would be when executing javascript that results in a navigation. e.g. clicks a link
|
This must be called before executing the action that navigates the browser. It may not resolve correctly
|
if called after.
|
</summary>
|
<remarks>
|
Usage of the <c>History API</c> <see href="https://developer.mozilla.org/en-US/docs/Web/API/History_API"/> to change the URL is considered a navigation
|
</remarks>
|
<param name="timeout">optional timeout, if not specified defaults to five(5) seconds.</param>
|
<param name="cancellationToken">optional CancellationToken</param>
|
<returns>Task which resolves when <see cref="E:CefSharp.IChromiumWebBrowserBase.LoadingStateChanged"/> has been called with <see cref="P:CefSharp.LoadingStateChangedEventArgs.IsLoading"/> false.
|
or when <see cref="E:CefSharp.IChromiumWebBrowserBase.LoadError"/> is called to signify a load failure.
|
</returns>
|
<example>
|
<code>
|
<![CDATA[
|
string script = "document.getElementsByTagName('a')[0].click();";
|
await Task.WhenAll(
|
chromiumWebBrowser.WaitForNavigationAsync(),
|
chromiumWebBrowser.EvaluateScriptAsync(jsScript3));
|
]]>
|
</code>
|
</example>
|
</member>
|
<member name="P:CefSharp.IChromiumWebBrowserBase.IsBrowserInitialized">
|
<summary>
|
A flag that indicates whether the WebBrowser is initialized (true) or not (false).
|
</summary>
|
<value><c>true</c> if this instance is browser initialized; otherwise, <c>false</c>.</value>
|
<remarks>In the WPF control there are two IsBrowserInitialized properties, the ChromiumWebBrowser.IsBrowserInitialized
|
property is implemented as a Dependency Property and fully supports data binding. This property
|
can only be called from the UI Thread. The explicit IWebBrowser.IsBrowserInitialized interface implementation that
|
can be called from any Thread.</remarks>
|
</member>
|
<member name="P:CefSharp.IChromiumWebBrowserBase.IsDisposed">
|
<summary>
|
A flag that indicates whether the WebBrowser has been disposed (<see langword="true" />) or not (<see langword="false" />)
|
</summary>
|
<value><see langword="true" /> if this instance is disposed; otherwise, <see langword="false" /></value>
|
</member>
|
<member name="P:CefSharp.IChromiumWebBrowserBase.IsLoading">
|
<summary>
|
A flag that indicates whether the control is currently loading one or more web pages (true) or not (false).
|
</summary>
|
<value><c>true</c> if this instance is loading; otherwise, <c>false</c>.</value>
|
<remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
|
binding.</remarks>
|
</member>
|
<member name="P:CefSharp.IChromiumWebBrowserBase.CanGoBack">
|
<summary>
|
A flag that indicates whether the state of the control current supports the GoBack action (true) or not (false).
|
</summary>
|
<value><c>true</c> if this instance can go back; otherwise, <c>false</c>.</value>
|
<remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
|
binding.</remarks>
|
</member>
|
<member name="P:CefSharp.IChromiumWebBrowserBase.CanGoForward">
|
<summary>
|
A flag that indicates whether the state of the control currently supports the GoForward action (true) or not (false).
|
</summary>
|
<value><c>true</c> if this instance can go forward; otherwise, <c>false</c>.</value>
|
<remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
|
binding.</remarks>
|
</member>
|
<member name="P:CefSharp.IChromiumWebBrowserBase.Address">
|
<summary>
|
The address (URL) which the browser control is currently displaying.
|
Will automatically be updated as the user navigates to another page (e.g. by clicking on a link).
|
</summary>
|
<value>The address.</value>
|
<remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
|
binding.</remarks>
|
</member>
|
<member name="M:CefSharp.IChromiumWebBrowserBase.Focus">
|
<summary>
|
Attempts to give focus to the IWebBrowser control.
|
</summary>
|
<returns><c>true</c> if keyboard focus and logical focus were set to this element; <c>false</c> if only logical focus
|
was set to this element, or if the call to this method did not force the focus to change.</returns>
|
</member>
|
<member name="P:CefSharp.IChromiumWebBrowserBase.BrowserCore">
|
<summary>
|
Returns the current IBrowser Instance or null.
|
<see cref="T:CefSharp.IBrowser"/> is the the underlying CefBrowser
|
instance and provides access to frames/browserhost etc.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IContextMenuParams">
|
<summary>
|
Wrapper for the CefContextMenuParams
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.YCoord">
|
<summary>
|
Returns the Y coordinate of the mouse where the context menu was invoked.
|
Coords are relative to the associated RenderView's origin.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.XCoord">
|
<summary>
|
Returns the X coordinate of the mouse where the context menu was invoked.
|
Coords are relative to the associated RenderView's origin.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.TypeFlags">
|
<summary>
|
Returns flags representing the type of node that the context menu was invoked on.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.LinkUrl">
|
<summary>
|
Returns the URL of the link, if any, that encloses the node that the
|
context menu was invoked on.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.UnfilteredLinkUrl">
|
<summary>
|
Returns the link URL, if any, to be used ONLY for "copy link address". We
|
don't validate this field in the frontend process.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.SourceUrl">
|
<summary>
|
Returns the source URL, if any, for the element that the context menu was
|
invoked on. Example of elements with source URLs are img, audio, and video.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.HasImageContents">
|
<summary>
|
Returns true if the context menu was invoked on an image which has
|
non-empty contents.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.PageUrl">
|
<summary>
|
Returns the URL of the top level page that the context menu was invoked on.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.FrameUrl">
|
<summary>
|
Returns the URL of the subframe that the context menu was invoked on.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.FrameCharset">
|
<summary>
|
Returns the character encoding of the subframe that the context menu was
|
invoked on.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.MediaType">
|
<summary>
|
Returns the type of context node that the context menu was invoked on.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.MediaStateFlags">
|
<summary>
|
Returns flags representing the actions supported by the media element, if
|
any, that the context menu was invoked on.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.SelectionText">
|
<summary>
|
Returns the text of the selection, if any, that the context menu was
|
invoked on.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.MisspelledWord">
|
<summary>
|
Returns the text of the misspelled word, if any, that the context menu was
|
invoked on.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.DictionarySuggestions">
|
<summary>
|
Returns a list of strings from the spell check service for the misspelled word if there is one.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.IsEditable">
|
<summary>
|
Returns true if the context menu was invoked on an editable node.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.IsSpellCheckEnabled">
|
<summary>
|
Returns true if the context menu was invoked on an editable node where
|
spell-check is enabled.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.EditStateFlags">
|
<summary>
|
Returns flags representing the actions supported by the editable node, if
|
any, that the context menu was invoked on.
|
</summary>
|
<returns>Returns ContextMenuEditState as flags</returns>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.IsCustomMenu">
|
<summary>
|
Returns true if the context menu contains items specified by the renderer
|
process.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IContextMenuParams.IsDisposed">
|
<summary>
|
Gets a value indicating whether the object has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.ICookieManager">
|
<summary>
|
Used for managing cookies. The methods may be called on any thread unless otherwise indicated.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ICookieManager.DeleteCookies(System.String,System.String,CefSharp.IDeleteCookiesCallback)">
|
<summary>
|
Delete all cookies that match the specified parameters.
|
If both <paramref name="url"/> and <paramref name="name"/> values are specified all host and domain cookies matching both will be deleted.
|
If only <paramref name="url"/> is specified all host cookies (but not domain cookies) irrespective of path will be deleted.
|
If <paramref name="url"/> is empty all cookies for all hosts and domains will be deleted.
|
Cookies can alternately be deleted using the Visit*Cookies() methods.
|
</summary>
|
<param name="url">The cookie URL.</param>
|
<param name="name">The name of the cookie.</param>
|
<param name="callback">If non-NULL it will be executed asynchronously on the CEF UI thread after the cookies have been deleted.</param>
|
<returns>Returns false if a non-empty invalid URL is specified or if cookies cannot be accessed; otherwise, true.</returns>
|
</member>
|
<member name="M:CefSharp.ICookieManager.SetCookie(System.String,CefSharp.Cookie,CefSharp.ISetCookieCallback)">
|
<summary>
|
Sets a cookie given a valid URL and explicit user-provided cookie attributes. This function expects each attribute to be well-formed. It will check for disallowed
|
characters (e.g. the ';' character is disallowed within the cookie value attribute) and fail without setting the cookie if such characters are found.
|
This method will be executed on the CEF UI thread in an async fashion, to be notified upon completion implement <see cref="T:CefSharp.ISetCookieCallback"/>
|
and pass in as <paramref name="callback"/>
|
</summary>
|
<param name="url">The cookie URL</param>
|
<param name="cookie">The cookie</param>
|
<param name="callback">If non-NULL it will be executed asynchronously on the CEF UI thread after the cookie has been set.</param>
|
<returns>Returns false if an invalid URL is specified or if cookies cannot be accessed.</returns>
|
</member>
|
<member name="M:CefSharp.ICookieManager.VisitAllCookies(CefSharp.ICookieVisitor)">
|
<summary>
|
Visit all cookies on the UI thread. The returned cookies are ordered by longest path, then by earliest creation date.
|
</summary>
|
<param name="visitor">A user-provided Cookie Visitor implementation.</param>
|
<returns>Returns false if cookies cannot be accessed; otherwise, true.</returns>
|
</member>
|
<member name="M:CefSharp.ICookieManager.VisitUrlCookies(System.String,System.Boolean,CefSharp.ICookieVisitor)">
|
<summary>
|
Visit a subset of cookies on the CEF UI thread.
|
The results are filtered by the given url scheme, host, domain and path.
|
The returned cookies are ordered by longest path, then by earliest creation date.
|
</summary>
|
<param name="url">The URL to use for filtering a subset of the cookies available.</param>
|
<param name="includeHttpOnly">If true HTTP-only cookies will also be included in the results.</param>
|
<param name="visitor">A user-provided Cookie Visitor implementation.</param>
|
<returns>Returns false if cookies cannot be accessed; otherwise, true.</returns>
|
</member>
|
<member name="M:CefSharp.ICookieManager.FlushStore(CefSharp.ICompletionCallback)">
|
<summary>
|
Flush the backing store (if any) to disk
|
This method will be executed on the CEF UI thread in an async fashion, to be notified upon completion implement <see cref="T:CefSharp.ICompletionCallback"/>
|
and pass in as <paramref name="callback"/>
|
</summary>
|
<param name="callback">If non-NULL it will be executed asynchronously on the CEF UI thread after the flush is complete.</param>
|
<returns>Returns false if cookies cannot be accessed.</returns>
|
</member>
|
<member name="P:CefSharp.ICookieManager.IsDisposed">
|
<summary>
|
Returns true if disposed
|
</summary>
|
</member>
|
<member name="T:CefSharp.IDomNode">
|
<summary>
|
Represents the tag name and attribute data belonging to a node in the
|
browser's DOM.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IDomNode.Item(System.String)">
|
<summary>
|
Get the value of an attribute.
|
</summary>
|
<param name="attributeName">
|
The name of the attribute value to get.
|
</param>
|
<returns>
|
The attribute value if the name exists in the DomNode's attributes.
|
Null if the name does not exist.
|
</returns>
|
</member>
|
<member name="P:CefSharp.IDomNode.TagName">
|
<summary>
|
The name of the HTML element.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IDomNode.AttributeNames">
|
<summary>
|
Get a read only list of the attribute names.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IDomNode.HasAttribute(System.String)">
|
<summary>
|
Determine if the DomNode has the requested attribute.
|
</summary>
|
<param name="attributeName">
|
The name of the attribute value.
|
</param>
|
<returns>
|
True if the attribute exists in the DomNode, false if it does not.
|
</returns>
|
</member>
|
<member name="T:CefSharp.IDragData">
|
<summary>
|
Used to represent drag data.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IDragData.Clone">
|
<summary>
|
Gets a copy of the current drag data
|
</summary>
|
<returns>a clone of the current object</returns>
|
</member>
|
<member name="P:CefSharp.IDragData.IsReadOnly">
|
<summary>
|
Returns true if this object is read-only.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IDragData.FileName">
|
<summary>
|
Return the name of the file being dragged out of the browser window.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IDragData.FileNames">
|
<summary>
|
Retrieve the list of file names that are being dragged into the browser window
|
</summary>
|
</member>
|
<member name="P:CefSharp.IDragData.FragmentBaseUrl">
|
<summary>
|
Return the base URL that the fragment came from. This value is used for resolving relative URLs and may be empty.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IDragData.FragmentHtml">
|
<summary>
|
Return the text/html fragment that is being dragged.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IDragData.FragmentText">
|
<summary>
|
Return the plain text fragment that is being dragged.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IDragData.HasImage">
|
<summary>
|
Returns true if an image representation of drag data is available.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IDragData.Image">
|
<summary>
|
Get the image representation of drag data.
|
May return NULL if no image representation is available.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IDragData.ImageHotspot">
|
<summary>
|
Get the image hotspot (drag start location relative to image dimensions).
|
</summary>
|
</member>
|
<member name="P:CefSharp.IDragData.LinkMetaData">
|
<summary>
|
Return the metadata, if any, associated with the link being dragged.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IDragData.LinkTitle">
|
<summary>
|
Return the title associated with the link being dragged.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IDragData.LinkUrl">
|
<summary>
|
Return the link URL that is being dragged.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IDragData.IsFile">
|
<summary>
|
Returns true if the drag data is a file.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IDragData.IsFragment">
|
<summary>
|
Returns true if the drag data is a text or html fragment.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IDragData.IsLink">
|
<summary>
|
Returns true if the drag data is a link
|
</summary>
|
</member>
|
<member name="M:CefSharp.IDragData.AddFile(System.String,System.String)">
|
<summary>
|
Add a file that is being dragged into the webview.
|
</summary>
|
<param name="path">File Path</param>
|
<param name="displayName">Optional Display Name</param>
|
</member>
|
<member name="M:CefSharp.IDragData.ResetFileContents">
|
<summary>
|
Reset the file contents. You should do this before calling
|
CefBrowserHost::DragTargetDragEnter as the web view does not allow us to
|
drag in this kind of data.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IDragData.GetFileContents(System.IO.Stream)">
|
<summary>
|
Write the contents of the file being dragged out of the web view into the provided <see cref="T:System.IO.Stream"/>
|
For a suggested filename check the <see cref="P:CefSharp.IDragData.FileName"/> property
|
</summary>
|
<param name="stream">Stream data is to be written to. If null this method will return the
|
size of the file contents in bytes.</param>
|
<returns>Returns the number of bytes written to the stream</returns>
|
</member>
|
<member name="M:CefSharp.IDragData.ClearFilenames">
|
<summary>
|
Clear list of filenames.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IDragData.IsDisposed">
|
<summary>
|
Gets a value indicating whether the object has been disposed of.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IExtension">
|
<summary>
|
Object representing an extension. Methods may be called on any thread unless otherwise indicated.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IExtension.Identifier">
|
<summary>
|
Returns the unique extension identifier. This is calculated based on the
|
extension public key, if available, or on the extension path. See
|
https://developer.chrome.com/extensions/manifest/key for details.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IExtension.Path">
|
<summary>
|
Returns the absolute path to the extension directory on disk. This value
|
will be prefixed with PK_DIR_RESOURCES if a relative path was passed to
|
IRequestContext.LoadExtension.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IExtension.Manifest">
|
<summary>
|
Returns the extension manifest contents as a CefDictionaryValue object. See
|
https://developer.chrome.com/extensions/manifest for details.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IExtension.IsSame(CefSharp.IExtension)">
|
<summary>
|
Returns true if this object is the same extension as that object.
|
Extensions are considered the same if identifier, path and loader context
|
match.
|
</summary>
|
<param name="that">extension to compare</param>
|
<returns>return true if the same extension</returns>
|
</member>
|
<member name="P:CefSharp.IExtension.LoaderContext">
|
<summary>
|
Returns the request context that loaded this extension. Will return NULL
|
for internal extensions or if the extension has been unloaded. See the
|
CefRequestContext::LoadExtension documentation for more information about
|
loader contexts. Must be called on the CEF UI thread.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IExtension.IsLoaded">
|
<summary>
|
Returns true if this extension is currently loaded. Must be called on the
|
CEF UI thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IExtension.Unload">
|
<summary>
|
Unload this extension if it is not an internal extension and is currently
|
loaded. Will result in a call to IExtensionHandler.OnExtensionUnloaded
|
on success.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IFrame">
|
<summary>
|
This interface represents a CefFrame object (i.e. a HTML frame)
|
</summary>
|
</member>
|
<member name="P:CefSharp.IFrame.IsValid">
|
<summary>
|
True if this object is currently attached to a valid frame.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IFrame.Undo">
|
<summary>
|
Execute undo in this frame.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IFrame.Redo">
|
<summary>
|
Execute redo in this frame.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IFrame.Cut">
|
<summary>
|
Execute cut in this frame.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IFrame.Copy">
|
<summary>
|
Execute copy in this frame.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IFrame.Paste">
|
<summary>
|
Execute paste in this frame.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IFrame.Delete">
|
<summary>
|
Execute delete in this frame.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IFrame.SelectAll">
|
<summary>
|
Execute select all in this frame.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IFrame.ViewSource">
|
<summary>
|
Save this frame's HTML source to a temporary file and open it in the
|
default text viewing application. This method can only be called from the
|
browser process.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IFrame.GetSourceAsync">
|
<summary>
|
Retrieve this frame's HTML source as a string sent to the specified visitor.
|
</summary>
|
<returns>
|
a <see cref="T:System.Threading.Tasks.Task`1"/> that when executed returns this frame's HTML source as a string.
|
</returns>
|
</member>
|
<member name="M:CefSharp.IFrame.GetSource(CefSharp.IStringVisitor)">
|
<summary>
|
Retrieve this frame's HTML source as a string sent to the specified visitor.
|
Use the <see cref="M:CefSharp.IFrame.GetSourceAsync"/> method for a Task based async wrapper
|
</summary>
|
<param name="visitor">visitor will receive string values asynchronously</param>
|
</member>
|
<member name="M:CefSharp.IFrame.GetTextAsync">
|
<summary>
|
Retrieve this frame's display text as a string sent to the specified visitor.
|
</summary>
|
<returns>
|
a <see cref="T:System.Threading.Tasks.Task`1"/> that when executed returns the frame's display text as a string.
|
</returns>
|
</member>
|
<member name="M:CefSharp.IFrame.GetText(CefSharp.IStringVisitor)">
|
<summary>
|
Retrieve this frame's display text as a string sent to the specified visitor.
|
Use the <see cref="M:CefSharp.IFrame.GetTextAsync"/> method for a Task based async wrapper
|
</summary>
|
<param name="visitor">visitor will receive string values asynchronously</param>
|
</member>
|
<member name="M:CefSharp.IFrame.LoadRequest(CefSharp.IRequest)">
|
<summary>
|
Load the custom request.
|
WARNING: This method will fail with "bad IPC message" reason
|
INVALID_INITIATOR_ORIGIN (213) unless you first navigate to the
|
request origin using some other mechanism (LoadURL, link click, etc).
|
</summary>
|
<param name="request">request to be loaded in the frame</param>
|
</member>
|
<member name="M:CefSharp.IFrame.LoadUrl(System.String)">
|
<summary>
|
Load the specified url.
|
</summary>
|
<param name="url">url to be loaded in the frame</param>
|
</member>
|
<member name="M:CefSharp.IFrame.ExecuteJavaScriptAsync(System.String,System.String,System.Int32)">
|
<summary>
|
Execute a string of JavaScript code in this frame.
|
</summary>
|
<param name="code">Javascript to execute</param>
|
<param name="scriptUrl">is the URL where the script in question can be found, if any.
|
The renderer may request this URL to show the developer the source of the error.</param>
|
<param name="startLine">is the base line number to use for error reporting.</param>
|
</member>
|
<member name="M:CefSharp.IFrame.EvaluateScriptAsync(System.String,System.String,System.Int32,System.Nullable{System.TimeSpan},System.Boolean)">
|
<summary>
|
Execute some Javascript code in the context of this WebBrowser, and return the result of the evaluation
|
in an Async fashion
|
</summary>
|
<param name="script">The Javascript code that should be executed.</param>
|
<param name="scriptUrl">is the URL where the script in question can be found, if any.</param>
|
<param name="startLine">is the base line number to use for error reporting.</param>
|
<param name="timeout">The timeout after which the Javascript code execution should be aborted.</param>
|
<param name="useImmediatelyInvokedFuncExpression">When true the script is wrapped in a self executing function.
|
Make sure to use a return statement in your javascript. e.g. (function () { return 42; })();
|
When false don't include a return statement e.g. 42;
|
</param>
|
<returns>A Task that can be awaited to perform the script execution</returns>
|
</member>
|
<member name="P:CefSharp.IFrame.IsMain">
|
<summary>
|
Returns true if this is the main (top-level) frame.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IFrame.IsFocused">
|
<summary>
|
Returns true if this is the focused frame.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IFrame.Name">
|
<summary>
|
Returns the name for this frame. If the frame has an assigned name (for
|
example, set via the iframe "name" attribute) then that value will be
|
returned. Otherwise a unique name will be constructed based on the frame
|
parent hierarchy. The main (top-level) frame will always have an empty name
|
value.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IFrame.Identifier">
|
<summary>
|
Returns the globally unique identifier for this frame or < 0 if the underlying frame does not yet exist.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IFrame.Parent">
|
<summary>
|
Returns the parent of this frame or NULL if this is the main (top-level) frame.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IFrame.Url">
|
<summary>
|
Returns the URL currently loaded in this frame.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IFrame.Browser">
|
<summary>
|
Returns the browser that this frame belongs to.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IFrame.IsDisposed">
|
<summary>
|
Gets a value indicating whether the frame has been disposed of.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IFrame.CreateRequest(System.Boolean)">
|
<summary>
|
Create a custom request for use with <see cref="M:CefSharp.IFrame.LoadRequest(CefSharp.IRequest)"/>
|
</summary>
|
<param name="initializePostData">Initialize the PostData object when creating this request</param>
|
<returns>A new instance of the request</returns>
|
</member>
|
<member name="M:CefSharp.IFrame.CreateUrlRequest(CefSharp.IRequest,CefSharp.IUrlRequestClient)">
|
<summary>
|
Create a new URL request that will be treated as originating from this frame
|
and the associated browser. This request may be intercepted by the client via
|
<see cref="T:CefSharp.IResourceRequestHandler"/> or <see cref="T:CefSharp.ISchemeHandlerFactory"/>.
|
Use IUrlRequest.Create instead if you do not want the request to have
|
this association, in which case it may be handled differently (see documentation on that method).
|
|
Requests may originate from both the browser process and the render process.
|
For requests originating from the browser process: - POST data may only contain a single element
|
of type PDE_TYPE_FILE or PDE_TYPE_BYTES.
|
For requests originating from the render process: - POST data may only contain a single element of type PDE_TYPE_BYTES.
|
- If the response contains Content-Disposition or Mime-Type header values that would not normally be rendered then
|
the response may receive special handling inside the browser
|
for example, via the file download code path instead of the URL request code path).
|
|
The request object will be marked as read-only after calling this method.
|
</summary>
|
<param name="request">the web request</param>
|
<param name="client">the client</param>
|
</member>
|
<member name="T:CefSharp.IImage">
|
<summary>
|
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.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IImage.GetAsBitmap(System.Single,CefSharp.Enums.ColorType,CefSharp.Enums.AlphaType,System.Int32@,System.Int32@)">
|
<summary>
|
Returns the bitmap representation that most closely matches scaleFactor.
|
</summary>
|
<param name="scaleFactor">scale factor</param>
|
<param name="colorType">color type</param>
|
<param name="alphaType">alpha type</param>
|
<param name="pixelWidth">pixel width</param>
|
<param name="pixelHeight">pixel height</param>
|
<returns>A stream represending the bitmap or null.</returns>
|
</member>
|
<member name="M:CefSharp.IImage.GetAsJPEG(System.Single,System.Int32,System.Int32@,System.Int32@)">
|
<summary>
|
Returns the JPEG representation that most closely matches scaleFactor.
|
</summary>
|
<param name="scaleFactor">scale factor</param>
|
<param name="quality">image quality</param>
|
<param name="pixelWidth">pixel width</param>
|
<param name="pixelHeight">pixel height</param>
|
<returns>A stream representing the JPEG or null.</returns>
|
</member>
|
<member name="M:CefSharp.IImage.GetAsPNG(System.Single,System.Boolean,System.Int32@,System.Int32@)">
|
<summary>
|
Returns the PNG representation that most closely matches scaleFactor.
|
</summary>
|
<param name="scaleFactor">scale factor</param>
|
<param name="withTransparency">is the PNG transparent</param>
|
<param name="pixelWidth">pixel width</param>
|
<param name="pixelHeight">pixel height</param>
|
<returns>A stream represending the PNG or null.</returns>
|
</member>
|
<member name="M:CefSharp.IImage.GetRepresentationInfo(System.Single,System.Single@,System.Int32@,System.Int32@)">
|
<summary>
|
Returns information for the representation that most closely matches scaleFactor.
|
</summary>
|
<param name="scaleFactor">scale factor</param>
|
<param name="actualScaleFactor">actual scale factor</param>
|
<param name="pixelWidth">pixel width</param>
|
<param name="pixelHeight">pixel height</param>
|
<returns>return if information found for scale factor</returns>
|
</member>
|
<member name="P:CefSharp.IImage.Height">
|
<summary>
|
Returns the image height in density independent pixel(DIP) units.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IImage.HasRepresentation(System.Single)">
|
<summary>
|
Returns true if this image contains a representation for scaleFactor.
|
</summary>
|
<param name="scaleFactor"></param>
|
<returns></returns>
|
</member>
|
<member name="P:CefSharp.IImage.IsEmpty">
|
<summary>
|
Returns true if this Image is empty.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IImage.IsSame(CefSharp.IImage)">
|
<summary>
|
Returns true if this Image and that Image share the same underlying storage.
|
</summary>
|
<param name="that">image to compare</param>
|
<returns>returns true if share same underlying storage</returns>
|
</member>
|
<member name="M:CefSharp.IImage.RemoveRepresentation(System.Single)">
|
<summary>
|
Removes the representation for scaleFactor.
|
</summary>
|
<param name="scaleFactor"></param>
|
<returns>true for success</returns>
|
</member>
|
<member name="P:CefSharp.IImage.Width">
|
<summary>
|
Returns the image width in density independent pixel(DIP) units.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IJavascriptObjectRepository">
|
<summary>
|
Javascript object repository, object are registered for binding
|
One repository per ChromiumWebBrowser instance
|
</summary>
|
</member>
|
<member name="P:CefSharp.IJavascriptObjectRepository.Settings">
|
<summary>
|
Javascript Binding Settings
|
</summary>
|
</member>
|
<member name="P:CefSharp.IJavascriptObjectRepository.NameConverter">
|
<summary>
|
Converted .Net method/property/field names to the name that
|
will be used in Javasript. Used for when .Net naming conventions
|
differ from Javascript naming conventions.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IJavascriptObjectRepository.Register(System.String,System.Object,System.Boolean,CefSharp.BindingOptions)">
|
<param name="options">binding options, by default method/property names are camelCased, you can control this
|
and other advanced options though this class.</param>
|
</member>
|
<member name="M:CefSharp.IJavascriptObjectRepository.UnRegisterAll">
|
<summary>
|
UnRegister all the currently bound objects from the repository. If you unregister an object that is currently
|
bound in JavaScript then the method/property calls will fail.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IJavascriptObjectRepository.UnRegister(System.String)">
|
<summary>
|
UnRegister a bound object from the repository. If you unregister an object that is currently
|
bound in JavaScript then the method/property calls will fail.
|
</summary>
|
<param name="name">object name</param>
|
<returns>returns true if the object was successfully unbound otherwise false.</returns>
|
</member>
|
<member name="P:CefSharp.IJavascriptObjectRepository.HasBoundObjects">
|
<summary>
|
Has bound objects
|
</summary>
|
</member>
|
<member name="M:CefSharp.IJavascriptObjectRepository.IsBound(System.String)">
|
<summary>
|
Is object bound
|
</summary>
|
<param name="name">name</param>
|
<returns>true if object with matching name bound</returns>
|
</member>
|
<member name="E:CefSharp.IJavascriptObjectRepository.ResolveObject">
|
<summary>
|
Event handler is called when an object with a given name is requested for binding and is not yet
|
registered with the repository. Use <see cref="P:CefSharp.Event.JavascriptBindingEventArgs.ObjectRepository"/>
|
to register objects (using
|
</summary>
|
</member>
|
<member name="E:CefSharp.IJavascriptObjectRepository.ObjectBoundInJavascript">
|
<summary>
|
Event handler is triggered when a object has been successfully bound in javascript
|
</summary>
|
</member>
|
<member name="E:CefSharp.IJavascriptObjectRepository.ObjectsBoundInJavascript">
|
<summary>
|
Event handler is triggered when multiple objects has been successfully bound in javascript, this event only
|
contains the names of objects successfully bound.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IMenuModel">
|
<summary>
|
Supports creation and modification of menus. See <see cref="T:CefSharp.CefMenuCommand"/> for the command ids that have default implementations.
|
All user-defined command ids should be between <see cref="F:CefSharp.CefMenuCommand.UserFirst"/> and <see cref="F:CefSharp.CefMenuCommand.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.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IMenuModel.Count">
|
<summary>
|
Returns the number of items in this menu.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IMenuModel.Clear">
|
<summary>
|
Remove all menu items. Can be used to disable the context menu. Returns true on success.
|
</summary>
|
<returns>Returns true on success</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.GetLabelAt(System.Int32)">
|
<summary>
|
Returns the label at the specified index or empty if not found due to
|
invalid range or the index being a separator.
|
</summary>
|
<param name="index">specified index</param>
|
<returns>Label or empty if not found due to invalid range or the index being a separator.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.GetCommandIdAt(System.Int32)">
|
<summary>
|
Returns the command id at the specified index or -1 if not found due to invalid range or the index being a separator.
|
</summary>
|
<param name="index">the index</param>
|
<returns>Command or -1 if not found due to invalid range or the index being a separator.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.Remove(CefSharp.CefMenuCommand)">
|
<summary>
|
Removes the item with the specified commandId.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<returns>Returns true on success</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.AddItem(CefSharp.CefMenuCommand,System.String)">
|
<summary>
|
Add an item to the menu.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<param name="label">the label of the item</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.AddSeparator">
|
<summary>
|
Add a separator to the menu.
|
</summary>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.AddCheckItem(CefSharp.CefMenuCommand,System.String)">
|
<summary>
|
Add a check item to the menu.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<param name="label">the label of the item</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.AddRadioItem(CefSharp.CefMenuCommand,System.String,System.Int32)">
|
<summary>
|
Add a radio item to the menu. Only a single item with the specified groupId can be checked at a time.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<param name="label">the label of the item</param>
|
<param name="groupId">the group id</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.AddSubMenu(CefSharp.CefMenuCommand,System.String)">
|
<summary>
|
Add a sub-menu to the menu. The new sub-menu is returned.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<param name="label">the label of the item</param>
|
<returns>Returns the newly created <see cref="T:CefSharp.IMenuModel"/>.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.InsertSeparatorAt(System.Int32)">
|
<summary>
|
Insert a separator in the menu at the specified index.
|
</summary>
|
<param name="index">index</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.InsertItemAt(System.Int32,CefSharp.CefMenuCommand,System.String)">
|
<summary>
|
Insert an item in the menu at the specified index.
|
</summary>
|
<param name="index">index</param>
|
<param name="commandId">the command Id</param>
|
<param name="label">the label of the item</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.InsertCheckItemAt(System.Int32,CefSharp.CefMenuCommand,System.String)">
|
<summary>
|
Insert a check item in the menu at the specified index.
|
</summary>
|
<param name="index">index</param>
|
<param name="commandId">the command Id</param>
|
<param name="label">the label of the item</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.InsertRadioItemAt(System.Int32,CefSharp.CefMenuCommand,System.String,System.Int32)">
|
<summary>
|
Insert a radio item in the menu at the specified index.
|
Only a single item with the specified groupId can be checked at a time.
|
</summary>
|
<param name="index">index</param>
|
<param name="commandId">the command Id</param>
|
<param name="label">the label of the item</param>
|
<param name="groupId">the group id</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.InsertSubMenuAt(System.Int32,CefSharp.CefMenuCommand,System.String)">
|
<summary>
|
Insert a sub-menu in the menu at the specified index.
|
</summary>
|
<param name="index">index</param>
|
<param name="commandId">the command Id</param>
|
<param name="label">the label of the item</param>
|
<returns>Returns the newly created <see cref="T:CefSharp.IMenuModel"/>.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.RemoveAt(System.Int32)">
|
<summary>
|
Removes the item at the specified index.
|
</summary>
|
<param name="index">index</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.GetIndexOf(CefSharp.CefMenuCommand)">
|
<summary>
|
Returns the index associated with the specified commandId or -1 if not found due to the command id not existing in the menu.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<returns>Returns the index associated with the specified commandId or -1 if not found due to the command id not existing in the menu.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.SetCommandIdAt(System.Int32,CefSharp.CefMenuCommand)">
|
<summary>
|
Sets the command id at the specified index.
|
</summary>
|
<param name="index">index</param>
|
<param name="commandId">the command Id</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.GetLabel(CefSharp.CefMenuCommand)">
|
<summary>
|
Returns the label for the specified commandId or empty if not found.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<returns>Returns the label for the specified commandId or empty if not found.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.SetLabel(CefSharp.CefMenuCommand,System.String)">
|
<summary>
|
Sets the label for the specified commandId.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<param name="label">the label</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.SetLabelAt(System.Int32,System.String)">
|
<summary>
|
Set the label at the specified index.
|
</summary>
|
<param name="index">index</param>
|
<param name="label">the label</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.GetType(CefSharp.CefMenuCommand)">
|
<summary>
|
Returns the item type for the specified commandId.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<returns>Returns the item type for the specified commandId.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.GetTypeAt(System.Int32)">
|
<summary>
|
Returns the item type at the specified index.
|
</summary>
|
<param name="index">index</param>
|
<returns>Returns the item type at the specified index.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.GetGroupId(CefSharp.CefMenuCommand)">
|
<summary>
|
Returns the group id for the specified commandId or -1 if invalid.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<returns>Returns the group id for the specified commandId or -1 if invalid.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.GetGroupIdAt(System.Int32)">
|
<summary>
|
Returns the group id at the specified index or -1 if invalid.
|
</summary>
|
<param name="index">index</param>
|
<returns>Returns the group id at the specified index or -1 if invalid.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.SetGroupId(CefSharp.CefMenuCommand,System.Int32)">
|
<summary>
|
Sets the group id for the specified commandId.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<param name="groupId">the group id</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.SetGroupIdAt(System.Int32,System.Int32)">
|
<summary>
|
Sets the group id at the specified index.
|
</summary>
|
<param name="index">index</param>
|
<param name="groupId">the group id</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.GetSubMenu(CefSharp.CefMenuCommand)">
|
<summary>
|
Returns the <see cref="T:CefSharp.IMenuModel"/> for the specified commandId or null if invalid.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<returns>Returns the <see cref="T:CefSharp.IMenuModel"/> for the specified commandId or null if invalid.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.GetSubMenuAt(System.Int32)">
|
<summary>
|
Returns the <see cref="T:CefSharp.IMenuModel"/> at the specified index or empty if invalid.
|
</summary>
|
<param name="index">index</param>
|
<returns>Returns the <see cref="T:CefSharp.IMenuModel"/> for the specified commandId or null if invalid.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.IsVisible(CefSharp.CefMenuCommand)">
|
<summary>
|
Returns true if the specified commandId is visible.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<returns>Returns true if the specified commandId is visible.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.IsVisibleAt(System.Int32)">
|
<summary>
|
Returns true if the specified index is visible.
|
</summary>
|
<param name="index">index</param>
|
<returns>Returns true if the specified index is visible.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.SetVisible(CefSharp.CefMenuCommand,System.Boolean)">
|
<summary>
|
Change the visibility of the specified commandId.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<param name="visible">visible</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.SetVisibleAt(System.Int32,System.Boolean)">
|
<summary>
|
Change the visibility at the specified index.
|
</summary>
|
<param name="index">index</param>
|
<param name="visible">visible</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.IsEnabled(CefSharp.CefMenuCommand)">
|
<summary>
|
Returns true if the specified commandId is enabled.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<returns>Returns true if the specified commandId is enabled.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.IsEnabledAt(System.Int32)">
|
<summary>
|
Returns true if the specified index is enabled.
|
</summary>
|
<param name="index">index</param>
|
<returns>Returns true if the specified index is enabled.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.SetEnabled(CefSharp.CefMenuCommand,System.Boolean)">
|
<summary>
|
Change the enabled status of the specified commandId.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<param name="enabled">is enabled</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.SetEnabledAt(System.Int32,System.Boolean)">
|
<summary>
|
Change the enabled status at the specified index.
|
</summary>
|
<param name="index">index</param>
|
<param name="enabled">is enabled</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.IsChecked(CefSharp.CefMenuCommand)">
|
<summary>
|
Returns true if the specified commandId is checked. Only applies to check and radio items.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<returns>Returns true if the specified commandId is checked. Only applies to check and radio items.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.IsCheckedAt(System.Int32)">
|
<summary>
|
Returns true if the specified index is checked. Only applies to check and radio items.
|
</summary>
|
<param name="index">index</param>
|
<returns>Returns true if the specified index is checked. Only applies to check and radio items.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.SetChecked(CefSharp.CefMenuCommand,System.Boolean)">
|
<summary>
|
Check the specified commandId. Only applies to check and radio items.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<param name="isChecked">set checked</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.SetCheckedAt(System.Int32,System.Boolean)">
|
<summary>
|
Check the specified index. Only applies to check and radio items.
|
</summary>
|
<param name="index">index</param>
|
<param name="isChecked">set checked</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.HasAccelerator(CefSharp.CefMenuCommand)">
|
<summary>
|
Returns true if the specified commandId has a keyboard accelerator assigned.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<returns>Returns true if the specified commandId has a keyboard accelerator assigned.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.HasAcceleratorAt(System.Int32)">
|
<summary>
|
Returns true if the specified index has a keyboard accelerator assigned.
|
</summary>
|
<param name="index">index</param>
|
<returns>Returns true if the specified index has a keyboard accelerator assigned.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.SetAccelerator(CefSharp.CefMenuCommand,System.Int32,System.Boolean,System.Boolean,System.Boolean)">
|
<summary>
|
Set the keyboard accelerator for the specified commandId.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<param name="keyCode">keyCode can be any key or character value. </param>
|
<param name="shiftPressed">shift key pressed</param>
|
<param name="ctrlPressed">ctrl key pressed</param>
|
<param name="altPressed">alt key pressed</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.SetAcceleratorAt(System.Int32,System.Int32,System.Boolean,System.Boolean,System.Boolean)">
|
<summary>
|
Set the keyboard accelerator at the specified index. keyCode can be any key or character value.
|
</summary>
|
<param name="index">index</param>
|
<param name="keyCode">keyCode can be any key or character value. </param>
|
<param name="shiftPressed">shift key pressed</param>
|
<param name="ctrlPressed">ctrl key pressed</param>
|
<param name="altPressed">alt key pressed</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.RemoveAccelerator(CefSharp.CefMenuCommand)">
|
<summary>
|
Remove the keyboard accelerator for the specified commandId.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.RemoveAcceleratorAt(System.Int32)">
|
<summary>
|
Remove the keyboard accelerator at the specified index.
|
</summary>
|
<param name="index">index</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.GetAccelerator(CefSharp.CefMenuCommand,System.Int32@,System.Boolean@,System.Boolean@,System.Boolean@)">
|
<summary>
|
Retrieves the keyboard accelerator for the specified commandId.
|
</summary>
|
<param name="commandId">the command Id</param>
|
<param name="keyCode">keyCode can be any key or character value. </param>
|
<param name="shiftPressed">shift key pressed</param>
|
<param name="ctrlPressed">ctrl key pressed</param>
|
<param name="altPressed">alt key pressed</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="M:CefSharp.IMenuModel.GetAcceleratorAt(System.Int32,System.Int32@,System.Boolean@,System.Boolean@,System.Boolean@)">
|
<summary>
|
Retrieves the keyboard accelerator for the specified index.
|
</summary>
|
<param name="index">index</param>
|
<param name="keyCode">keyCode can be any key or character value. </param>
|
<param name="shiftPressed">shift key pressed</param>
|
<param name="ctrlPressed">ctrl key pressed</param>
|
<param name="altPressed">alt key pressed</param>
|
<returns>Returns true on success.</returns>
|
</member>
|
<member name="T:CefSharp.Internals.BaseTimeConverter">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.BaseTimeConverter.CefSharp#Internals#IBaseTimeConverter#FromBaseTimeToDateTime(System.Int64)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.BaseTimeConverter.CefSharp#Internals#IBaseTimeConverter#FromDateTimeToBaseTime(System.DateTime)">
|
<inheritdoc/>
|
</member>
|
<member name="T:CefSharp.Internals.BrowserRefCounter">
|
<summary>
|
Tracks the number of browser instances currently open
|
The cound will be incrmented and decremented each time a CefBrowser is created/closed.
|
This includes CefBrowser popup instances.
|
</summary>
|
<remarks>
|
Roughtly based on <see cref="T:System.Threading.CountdownEvent"/>, unforeunately <see cref="M:System.Threading.CountdownEvent.AddCount(System.Int32)"/>
|
doesn't reset the internal <see cref="T:System.Threading.ManualResetEventSlim"/> when Count is aleady 0.
|
In our case it's valid to increase the number of browsers and reset the event.
|
</remarks>
|
</member>
|
<member name="F:CefSharp.Internals.BrowserRefCounter.Instance">
|
TODO: Refactor this so it's not static.
|
</member>
|
<member name="M:CefSharp.Internals.BrowserRefCounter.AppendLineToLog(System.String)">
|
<summary>
|
If logging is enabled the <paramref name="line"/> will be appended to
|
the internal log.
|
</summary>
|
<param name="line">text to append to log if logging enabled.</param>
|
</member>
|
<member name="M:CefSharp.Internals.BrowserRefCounter.CefSharp#Internals#IBrowserRefCounter#Increment(System.Type)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.BrowserRefCounter.CefSharp#Internals#IBrowserRefCounter#Decrement(System.Type)">
|
<inheritdoc/>
|
</member>
|
<member name="P:CefSharp.Internals.BrowserRefCounter.CefSharp#Internals#IBrowserRefCounter#Count">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.BrowserRefCounter.CefSharp#Internals#IBrowserRefCounter#WaitForBrowsersToClose(System.Int32)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.BrowserRefCounter.CefSharp#Internals#IBrowserRefCounter#WaitForBrowsersToClose(System.Int32,System.Threading.CancellationToken)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.BrowserRefCounter.CefSharp#Internals#IBrowserRefCounter#EnableLogging">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.BrowserRefCounter.CefSharp#Internals#IBrowserRefCounter#GetLog">
|
<inheritdoc/>
|
</member>
|
<member name="T:CefSharp.Internals.CefThread">
|
<summary>
|
To access the CEF threads we expose a TaskFactory, as this requires managed vc++ this
|
exists in CefSharp.Core it cannot be directly accessed in CefSharp.dll. When
|
Cef.Initialized is called we pass a reference to the TaskFactory here so we
|
can write methods (typically extension methods) in this assembly.
|
</summary>
|
TODO: This can likely be removed and code that depends on this can be moved
|
to CefSharp.Core and interact directly with the C++ api
|
</member>
|
<member name="P:CefSharp.Internals.CefThread.UiThreadTaskFactory">
|
<summary>
|
TaskFactory will be null before Cef.Initialize is called
|
and null after Cef.Shutdown is called.
|
</summary>
|
</member>
|
<member name="E:CefSharp.Internals.CefThread.Initialized">
|
<summary>
|
Event fired after Cef.Initialze has been called, we can now start
|
posting Tasks to the CEF UI Thread.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.CefThread.CurrentOnUiThreadDelegate">
|
<summary>
|
Delegate used to wrap the native call to CefCurrentlyOn(CefThreadId::TID_UI).
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.CefThread.CanExecuteOnUiThread">
|
<summary>
|
true if we have a reference to the UiThreadTaskFactory
|
TaskFactory, otherwise false
|
</summary>
|
<remarks>
|
The current implementation isn't thread safe, generally speaking this shouldn't be a problem
|
</remarks>
|
</member>
|
<member name="P:CefSharp.Internals.CefThread.CurrentlyOnUiThread">
|
<summary>
|
Currently on the CEF UI Thread
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.CefThread.HasShutdown">
|
<summary>
|
returns true if Cef.Shutdown been called, otherwise false.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.CefThread.ExecuteOnUiThread``1(System.Func{``0})">
|
<summary>
|
Execute the provided function on the CEF UI Thread
|
</summary>
|
<typeparam name="TResult">result</typeparam>
|
<param name="function">function</param>
|
<returns>Task{Result}</returns>
|
</member>
|
<member name="M:CefSharp.Internals.CefThread.ExecuteOnUiThread(System.Action)">
|
<summary>
|
Execute the provided action on the CEF UI Thread
|
</summary>
|
<param name="action">action</param>
|
<returns>Task</returns>
|
</member>
|
<member name="M:CefSharp.Internals.CefThread.QueueForExcutionWhenUiThreadCreated(System.Action)">
|
<summary>
|
Wait for CEF to Initialize, continuation happens on
|
the CEF UI Thraed.
|
</summary>
|
<returns>Task that can be awaited</returns>
|
</member>
|
<member name="M:CefSharp.Internals.CefThread.QueueForExcutionWhenUiThreadCreated``1(System.Func{``0})">
|
<summary>
|
Wait for CEF to Initialize, continuation happens on
|
the CEF UI Thraed.
|
</summary>
|
<returns>Task that can be awaited</returns>
|
</member>
|
<member name="M:CefSharp.Internals.CefThread.Initialize(System.Threading.Tasks.TaskFactory,System.Func{System.Boolean})">
|
<summary>
|
Called when the CEF UI Thread is a
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.CefThread.Shutdown">
|
<summary>
|
!!WARNING!! DO NOT CALL THIS YOURSELF, THIS WILL BE CALLED INTERNALLY.
|
Called when Cef.Shutdown is called to cleanup our references
|
and release any event handlers.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Internals.CefTimeUtils">
|
<summary>
|
Mapping to/from CefBaseTime
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.CefTimeUtils.UseBaseTimeConveter(CefSharp.Internals.IBaseTimeConverter)">
|
<summary>
|
Assign your own custom <see cref="T:CefSharp.Internals.IBaseTimeConverter"/> converter
|
used to convert <see cref="T:System.DateTime"/> to/from CefBaseTime
|
</summary>
|
<param name="converter">converter</param>
|
<remarks>
|
Must be called in all processes for custom conversion of DateTime
|
used by the Sync Javascript Binding (.Net 4.x only)
|
</remarks>
|
</member>
|
<member name="M:CefSharp.Internals.CefTimeUtils.FromBaseTimeToNullableDateTime(System.Int64)">
|
<summary>
|
Converts from CefBaseTime to DateTime?
|
</summary>
|
<param name="val">
|
Represents a wall clock time in UTC. Values are not guaranteed to be monotonically
|
non-decreasing and are subject to large amounts of skew. Time is stored internally
|
as microseconds since the Windows epoch (1601).
|
</param>
|
<returns>if <paramref name="val"/> is 0 then returns null otherwise returns a <see cref="T:System.DateTime"/> of <see cref="F:System.DateTimeKind.Local"/></returns>
|
</member>
|
<member name="M:CefSharp.Internals.CefTimeUtils.FromBaseTimeToDateTime(System.Int64)">
|
<summary>
|
Converts from CefBaseTime to DateTime
|
</summary>
|
<param name="val">
|
Represents a wall clock time in UTC. Values are not guaranteed to be monotonically
|
non-decreasing and are subject to large amounts of skew. Time is stored internally
|
as microseconds since the Windows epoch (1601).
|
</param>
|
<returns>returns a <see cref="T:System.DateTime"/> of <see cref="F:System.DateTimeKind.Local"/></returns>
|
</member>
|
<member name="M:CefSharp.Internals.CefTimeUtils.FromDateTimeToBaseTime(System.DateTime)">
|
<summary>
|
Converts from DateTime to CefBaseTime
|
</summary>
|
<param name="dateTime">DateTime</param>
|
<returns>
|
Represents a wall clock time in UTC. Time as microseconds since the Windows epoch (1601).
|
</returns>
|
</member>
|
<member name="T:CefSharp.Internals.CommandLineArgDictionary">
|
<summary>
|
Custom Dictionary that provides an Add(string) method for appending CEF Command line
|
args that don't have a switch value.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.CommandLineArgDictionary.Add(System.String)">
|
<summary>
|
Adds the command line argument
|
</summary>
|
<param name="arg">command line argument</param>
|
</member>
|
<member name="T:CefSharp.Internals.CommandLineArgsParser">
|
<summary>
|
Simple helper class used for checking/parsing command line arguments
|
</summary>
|
</member>
|
<member name="T:CefSharp.Internals.ConcurrentMethodRunnerQueue">
|
<summary>
|
ConcurrentMethodRunnerQueue - Async Javascript Binding methods are run
|
on the ThreadPool in parallel, when a method returns a Task
|
the we use ContinueWith to be notified of completion then
|
raise the MethodInvocationComplete event
|
</summary>
|
</member>
|
<member name="E:CefSharp.Internals.ConcurrentMethodRunnerQueue.MethodInvocationComplete">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.ConcurrentMethodRunnerQueue.#ctor(CefSharp.Internals.IJavascriptObjectRepositoryInternal)">
|
<summary>
|
Default constructor
|
</summary>
|
<param name="repository">javascript object repository</param>
|
</member>
|
<member name="M:CefSharp.Internals.ConcurrentMethodRunnerQueue.Dispose">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.ConcurrentMethodRunnerQueue.Enqueue(CefSharp.Internals.MethodInvocation)">
|
<inheritdoc/>
|
</member>
|
<member name="T:CefSharp.Internals.CookieManagerDecorator">
|
<summary>
|
CookieManager with additional checks to ensure the store is initialized.
|
Throws an exception when attempting to access the store before it's ready.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Internals.FreezableBase">
|
<summary>
|
Base classes for Feezable settings objects
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.GlobalContextInitialized.ExecuteOrEnqueue(System.Action{System.Boolean})">
|
<summary>
|
We need to be sure the CEF Global Context has been initialized before
|
we create the browser. If the CefRequestContext has already been initialzed
|
then we'll execute syncroniously. If the CefRequestContext hasn't been
|
initialized then we will continue on the CEF UI Thread.
|
https://github.com/cefsharp/CefSharp/issues/3850
|
</summary>
|
<param name="action">action to invoke</param>
|
</member>
|
<member name="T:CefSharp.Internals.HeaderNameValueCollection">
|
<summary>
|
A <see cref="T:System.Collections.Specialized.NameValueCollection"/> implementation
|
that can optionally be set to ReadOnly (used to represent the CefHeaderMap)
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.HeaderNameValueCollection.SetReadOnly">
|
<summary>
|
Set the NameValueCollection to Readonly after it's been updated
|
</summary>
|
</member>
|
<member name="T:CefSharp.Internals.IBaseTimeConverter">
|
<summary>
|
Convert to/from <see cref="T:System.DateTime"/> and CefBaseTime
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.IBaseTimeConverter.FromBaseTimeToDateTime(System.Int64)">
|
<summary>
|
Converts from CefBaseTime to DateTime
|
</summary>
|
<param name="val">
|
Represents a wall clock time in UTC. Values are not guaranteed to be monotonically
|
non-decreasing and are subject to large amounts of skew. Time is stored internally
|
as microseconds since the Windows epoch (1601).
|
</param>
|
<returns>returns a <see cref="T:System.DateTime"/></returns>
|
</member>
|
<member name="M:CefSharp.Internals.IBaseTimeConverter.FromDateTimeToBaseTime(System.DateTime)">
|
<summary>
|
Converts from DateTime to CefBaseTime
|
</summary>
|
<param name="dateTime">DateTime</param>
|
<returns>
|
Represents a wall clock time in UTC. Time as microseconds since the Windows epoch (1601).
|
</returns>
|
</member>
|
<member name="T:CefSharp.Internals.IBrowserAdapter">
|
<summary>
|
Interface used to break reference cycles in CefSharp.Core C++ code.
|
This will ALWAYS be a ManagedCefBrowserAdapter instance.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Internals.IBrowserRefCounter">
|
<summary>
|
Browser Ref counter
|
Used internally to keep track of open browser instances
|
The ref count is incremented when a browser is created,
|
and decremented when the browser has successfully closed.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.IBrowserRefCounter.Increment(System.Type)">
|
<summary>
|
Increment browser count
|
</summary>
|
<param name="type">Browser type, used for logging internally</param>
|
</member>
|
<member name="M:CefSharp.Internals.IBrowserRefCounter.Decrement(System.Type)">
|
<summary>
|
Decrement browser count
|
</summary>
|
<param name="type">Browser type, used for logging internally</param>
|
<returns>returns true if the count is 0, otherwise false</returns>
|
</member>
|
<member name="P:CefSharp.Internals.IBrowserRefCounter.Count">
|
<summary>
|
Gets the number of CefBrowser instances currently open (this includes popups)
|
</summary>
|
<value>
|
The count.
|
</value>
|
</member>
|
<member name="M:CefSharp.Internals.IBrowserRefCounter.EnableLogging">
|
<summary>
|
Enable logging
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.IBrowserRefCounter.GetLog">
|
<summary>
|
Gets the log (empty if not enabled).
|
</summary>
|
<returns>string</returns>
|
</member>
|
<member name="M:CefSharp.Internals.IBrowserRefCounter.WaitForBrowsersToClose(System.Int32)">
|
<summary>
|
Blocks until the CefBrowser count has reached 0 or the timeout has been reached
|
</summary>
|
<param name="timeoutInMiliseconds">(Optional) The timeout in miliseconds.</param>
|
</member>
|
<member name="M:CefSharp.Internals.IBrowserRefCounter.WaitForBrowsersToClose(System.Int32,System.Threading.CancellationToken)">
|
<summary>
|
Blocks until the CefBrowser count has reached 0 or the timeout has been reached
|
</summary>
|
<param name="timeoutInMiliseconds">(Optional) The timeout in miliseconds.</param>
|
<param name="cancellationToken">(Optional) The cancellation token.</param>
|
</member>
|
<member name="T:CefSharp.Internals.IJavascriptCallbackFactory">
|
<summary>
|
Interface to convert a JavascriptCallback dto to a callable implementation.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Internals.IMethodRunnerQueue">
|
<summary>
|
Run (execute) calls made from Javascript to .Net methods
|
</summary>
|
</member>
|
<member name="E:CefSharp.Internals.IMethodRunnerQueue.MethodInvocationComplete">
|
<summary>
|
Method invocation was completed.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.IMethodRunnerQueue.Enqueue(CefSharp.Internals.MethodInvocation)">
|
<summary>
|
Enqueue a method invocation
|
</summary>
|
<param name="methodInvocation">method invocation</param>
|
</member>
|
<member name="T:CefSharp.Internals.InitializeAsyncBrowserProcessHandler">
|
<summary>
|
BrowserProcessHandler implementation that takes a <see cref="T:System.Threading.Tasks.TaskCompletionSource`1"/>
|
and resolves when <see cref="M:CefSharp.Internals.InitializeAsyncBrowserProcessHandler.OnContextInitialized"/> is called.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.InitializeAsyncBrowserProcessHandler.#ctor(System.Threading.Tasks.TaskCompletionSource{System.Boolean})">
|
<summary>
|
Default constructor
|
</summary>
|
<param name="tcs">task complection source</param>
|
</member>
|
<member name="M:CefSharp.Internals.InitializeAsyncBrowserProcessHandler.OnContextInitialized">
|
<inheritdoc/>
|
</member>
|
<member name="T:CefSharp.Internals.InMemoryResourceRequestHandler">
|
<summary>
|
InMemoryResourceRequestHandler
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.InMemoryResourceRequestHandler.#ctor(System.Byte[],System.String)">
|
<summary>
|
Default constructor
|
</summary>
|
<param name="data">data</param>
|
<param name="mimeType">mime (content) type</param>
|
</member>
|
<member name="M:CefSharp.Internals.InMemoryResourceRequestHandler.Dispose">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.InMemoryResourceRequestHandler.CefSharp#IResourceRequestHandler#GetCookieAccessFilter(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.InMemoryResourceRequestHandler.CefSharp#IResourceRequestHandler#GetResourceHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.InMemoryResourceRequestHandler.CefSharp#IResourceRequestHandler#GetResourceResponseFilter(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.InMemoryResourceRequestHandler.CefSharp#IResourceRequestHandler#OnBeforeResourceLoad(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IRequestCallback)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.InMemoryResourceRequestHandler.CefSharp#IResourceRequestHandler#OnProtocolExecution(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.InMemoryResourceRequestHandler.CefSharp#IResourceRequestHandler#OnResourceLoadComplete(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse,CefSharp.UrlRequestStatus,System.Int64)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.InMemoryResourceRequestHandler.CefSharp#IResourceRequestHandler#OnResourceRedirect(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse,System.String@)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.InMemoryResourceRequestHandler.CefSharp#IResourceRequestHandler#OnResourceResponse(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,CefSharp.IResponse)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.IntPtrExtensions.CastToInt32(System.IntPtr)">
|
<summary>
|
Do an unchecked conversion from IntPtr to int
|
so overflow exceptions don't get thrown.
|
</summary>
|
<param name="intPtr">the IntPtr to cast</param>
|
<returns>a 32-bit signed integer</returns>
|
</member>
|
<member name="T:CefSharp.Internals.IRenderWebBrowser">
|
<summary>
|
IRenderWebBrowser is an internal interface used by CefSharp for the WPF/Offscreen implementation
|
The ChromiumWebBrowser instances implement this interface
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.IRenderWebBrowser.AccessibilityHandler">
|
<summary>
|
Implement <see cref="T:CefSharp.IAccessibilityHandler" /> to handle events related to accessibility.
|
</summary>
|
<value>The accessibility handler.</value>
|
</member>
|
<member name="M:CefSharp.Internals.IRenderWebBrowser.GetScreenInfo">
|
<summary>
|
Called to allow the client to return a ScreenInfo object with appropriate values.
|
If null is returned then the rectangle from GetViewRect will be used.
|
If the rectangle is still empty or invalid popups may not be drawn correctly.
|
</summary>
|
<returns>Return null if no screenInfo structure is provided.</returns>
|
</member>
|
<member name="M:CefSharp.Internals.IRenderWebBrowser.GetViewRect">
|
<summary>
|
Called to retrieve the view rectangle which is relative to screen coordinates.
|
</summary>
|
<returns>Return a ViewRect strict containing the rectangle or null. If the rectangle is
|
still empty or invalid popups may not be drawn correctly. </returns>
|
</member>
|
<member name="M:CefSharp.Internals.IRenderWebBrowser.GetScreenPoint(System.Int32,System.Int32,System.Int32@,System.Int32@)">
|
<summary>
|
Called to retrieve the translation from view coordinates to actual screen coordinates.
|
</summary>
|
<param name="viewX">x</param>
|
<param name="viewY">y</param>
|
<param name="screenX">screen x</param>
|
<param name="screenY">screen y</param>
|
<returns>Return true if the screen coordinates were provided.</returns>
|
</member>
|
<member name="M:CefSharp.Internals.IRenderWebBrowser.OnAcceleratedPaint(CefSharp.PaintElementType,CefSharp.Structs.Rect,System.IntPtr)">
|
<summary>
|
Called when an element has been rendered to the shared texture handle.
|
This method is only called when <see cref="P:CefSharp.IWindowInfo.SharedTextureEnabled"/> is set to true
|
</summary>
|
<param name="type">indicates whether the element is the view or the popup widget.</param>
|
<param name="dirtyRect">contains the set of rectangles in pixel coordinates that need to be repainted</param>
|
<param name="sharedHandle">is the handle for a D3D11 Texture2D that can be accessed via ID3D11Device using the OpenSharedResource method.</param>
|
</member>
|
<member name="M:CefSharp.Internals.IRenderWebBrowser.OnPaint(CefSharp.PaintElementType,CefSharp.Structs.Rect,System.IntPtr,System.Int32,System.Int32)">
|
<summary>
|
Called when an element should be painted. Pixel values passed to this method are scaled relative to view coordinates based on the
|
value of <see cref="P:CefSharp.Structs.ScreenInfo.DeviceScaleFactor"/> returned from <see cref="M:CefSharp.Internals.IRenderWebBrowser.GetScreenInfo"/>.
|
Called on the CEF UI Thread
|
</summary>
|
<param name="type">indicates whether the element is the view or the popup widget.</param>
|
<param name="dirtyRect">contains the set of rectangles in pixel coordinates that need to be repainted</param>
|
<param name="buffer">The bitmap will be will be width * height *4 bytes in size and represents a BGRA image with an upper-left origin</param>
|
<param name="width">width</param>
|
<param name="height">height</param>
|
</member>
|
<member name="M:CefSharp.Internals.IRenderWebBrowser.OnCursorChange(System.IntPtr,CefSharp.Enums.CursorType,CefSharp.Structs.CursorInfo)">
|
<summary>
|
Called when the browser's cursor has changed. .
|
</summary>
|
<param name="cursor">If type is Custom then customCursorInfo will be populated with the custom cursor information</param>
|
<param name="type">cursor type</param>
|
<param name="customCursorInfo">custom cursor Information</param>
|
</member>
|
<member name="M:CefSharp.Internals.IRenderWebBrowser.StartDragging(CefSharp.IDragData,CefSharp.Enums.DragOperationsMask,System.Int32,System.Int32)">
|
<summary>
|
Called when the user starts dragging content in the web view. Contextual information about the dragged content is
|
supplied by dragData. (|x|, |y|) is the drag start location in screen coordinates. OS APIs that run a system message
|
loop may be used within the StartDragging call. Return false to abort the drag operation. Don't call any of
|
CefBrowserHost::DragSource*Ended* methods after returning false. Return true to handle the drag operation.
|
Call IBrowserHost::DragSourceEndedAt and DragSourceSystemDragEnded either synchronously or asynchronously to inform
|
the web view that the drag operation has ended.
|
</summary>
|
<param name="dragData">drag data</param>
|
<param name="mask">operation mask</param>
|
<param name="x">x coordinate</param>
|
<param name="y">y coordinate</param>
|
<returns>Return false to abort the drag operation.</returns>
|
</member>
|
<member name="M:CefSharp.Internals.IRenderWebBrowser.UpdateDragCursor(CefSharp.Enums.DragOperationsMask)">
|
<summary>
|
Called when the web view wants to update the mouse cursor during a drag & drop operation.
|
</summary>
|
<param name="operation">describes the allowed operation (none, move, copy, link). </param>
|
</member>
|
<member name="M:CefSharp.Internals.IRenderWebBrowser.OnPopupShow(System.Boolean)">
|
<summary>
|
Called when the browser wants to show or hide the popup widget.
|
</summary>
|
<param name="show">The popup should be shown if show is true and hidden if show is false.</param>
|
</member>
|
<member name="M:CefSharp.Internals.IRenderWebBrowser.OnPopupSize(CefSharp.Structs.Rect)">
|
<summary>
|
Called when the browser wants to move or resize the popup widget.
|
</summary>
|
<param name="rect">contains the new location and size in view coordinates. </param>
|
</member>
|
<member name="M:CefSharp.Internals.IRenderWebBrowser.OnImeCompositionRangeChanged(CefSharp.Structs.Range,CefSharp.Structs.Rect[])">
|
<summary>
|
Called when the IME composition range has changed.
|
</summary>
|
<param name="selectedRange">is the range of characters that have been selected</param>
|
<param name="characterBounds">is the bounds of each character in view coordinates.</param>
|
</member>
|
<member name="M:CefSharp.Internals.IRenderWebBrowser.OnVirtualKeyboardRequested(CefSharp.IBrowser,CefSharp.Enums.TextInputMode)">
|
<summary>
|
Called when an on-screen keyboard should be shown or hidden for the specified browser.
|
</summary>
|
<param name="browser">the browser</param>
|
<param name="inputMode">specifies what kind of keyboard should be opened. If <see cref="F:CefSharp.Enums.TextInputMode.None"/>, any existing keyboard for this browser should be hidden.</param>
|
</member>
|
<member name="T:CefSharp.Internals.IWebBrowserInternal">
|
<summary>
|
Interface implemented by UI control that contains
|
a ManagedCefBrowserAdapter instance.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptMethod.Function">
|
<summary>
|
Gets or sets a delegate which is used to invoke the method if the member is a method.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptMethod.Id">
|
<summary>
|
Identifies the <see cref="T:CefSharp.Internals.JavascriptMethod" /> for BrowserProcess to RenderProcess communication
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptMethod.ManagedName">
|
<summary>
|
Gets or sets the name of the managed property.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptMethod.JavascriptName">
|
<summary>
|
Gets or sets the name of the property in the JavaScript runtime.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptMethod.Parameters">
|
<summary>
|
Params this method expects
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptMethod.ParameterCount">
|
<summary>
|
Number of Params this function exepects
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptMethod.ReturnType">
|
<summary>
|
The Return type of the method
|
</summary>
|
</member>
|
<member name="T:CefSharp.Internals.JavascriptObject">
|
<summary>
|
This maps the registered objects in the browser process
|
to the reflection data necessary to update the objects,
|
and mapping information to how the object/method/proprerty
|
will be exposed to JavaScript.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptObject.Id">
|
<summary>
|
Identifies the <see cref="T:CefSharp.Internals.JavascriptObject" /> for BrowserProcess to RenderProcess communication
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptObject.IsAsync">
|
<summary>
|
Indicate if this object bound as async
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptObject.Methods">
|
<summary>
|
Gets the methods of the <see cref="T:CefSharp.Internals.JavascriptObject" />.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptObject.Properties">
|
<summary>
|
Gets the properties of the <see cref="T:CefSharp.Internals.JavascriptObject" />.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptObject.RootObject">
|
<summary>
|
A javascript object is created for every object, even those that are sub objects
|
it's important we only transmit the Root Objects (top level/parent)
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptObject.Value">
|
<summary>
|
Gets or sets the value.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Internals.JavascriptObjectRepository">
|
<summary>
|
This class manages the registration of objects in the browser
|
process to be exposed to JavaScript in the renderer process.
|
Registration performs method, parameter, property type analysis
|
of the registered objects into meta-data tied to reflection data
|
for later use.
|
|
This class also is the adaptation layer between the BrowserProcessService
|
and the registered objects. This means when the renderer wants to call an
|
exposed method, get a property of an object, or
|
set a property of an object in the browser process, that this
|
class does deals with the previously created meta-data and invokes the correct
|
behavior via reflection APIs.
|
|
All of the registered objects are tracked via meta-data for the objects
|
expressed starting with the JavaScriptObject type.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Internals.JavascriptObjectRepository.AllObjects">
|
<summary>
|
CefSharp.BindObjectAsync was called from Javascript without pasing in any params
|
the <see cref="E:CefSharp.Internals.JavascriptObjectRepository.ResolveObject"/> will be called with <see cref="P:CefSharp.Event.JavascriptBindingEventArgs.ObjectName"/>
|
set to this value.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Internals.JavascriptObjectRepository.LegacyObjects">
|
<summary>
|
Legacy Javascript Binding is enabled, the <see cref="E:CefSharp.Internals.JavascriptObjectRepository.ResolveObject"/> event
|
will be called with <see cref="P:CefSharp.Event.JavascriptBindingEventArgs.ObjectName"/>
|
set to this value
|
</summary>
|
</member>
|
<member name="E:CefSharp.Internals.JavascriptObjectRepository.ResolveObject">
|
<inheritdoc/>
|
</member>
|
<member name="E:CefSharp.Internals.JavascriptObjectRepository.ObjectBoundInJavascript">
|
<inheritdoc/>
|
</member>
|
<member name="E:CefSharp.Internals.JavascriptObjectRepository.ObjectsBoundInJavascript">
|
<inheritdoc/>
|
</member>
|
<member name="F:CefSharp.Internals.JavascriptObjectRepository.objects">
|
<summary>
|
A hash from assigned object ids to the objects,
|
this is done to speed up finding the object in O(1) time
|
instead of traversing the JavaScriptRootObject tree.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Internals.JavascriptObjectRepository.nameConverter">
|
<summary>
|
Javascript Name converter
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptObjectRepository.IsBrowserInitialized">
|
<summary>
|
Has the browser this repository is associated with been initilized (set in OnAfterCreated)
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.JavascriptObjectRepository.Dispose">
|
<inheritdoc/>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptObjectRepository.HasBoundObjects">
|
<inheritdoc/>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptObjectRepository.Settings">
|
<summary>
|
Configurable settings for this repository, such as the property names CefSharp injects into the window.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptObjectRepository.NameConverter">
|
<summary>
|
Converted .Net method/property/field names to the name that
|
will be used in Javasript. Used for when .Net naming conventions
|
differ from Javascript naming conventions.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.JavascriptObjectRepository.#ctor">
|
<summary>
|
JavascriptObjectRepository
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.JavascriptObjectRepository.IsBound(System.String)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.JavascriptObjectRepository.UnRegisterAll">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.JavascriptObjectRepository.UnRegister(System.String)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.JavascriptObjectRepository.AnalyseObjectForBinding(CefSharp.Internals.JavascriptObject,System.Boolean,System.Boolean,System.Boolean)">
|
<summary>
|
Analyse the object and generate metadata which will
|
be used by the browser subprocess to interact with Cef.
|
Method is called recursively
|
</summary>
|
<param name="obj">Javascript object</param>
|
<param name="analyseMethods">Analyse methods for inclusion in metadata model</param>
|
<param name="analyseProperties">Analyse properties for inclusion in metadata model</param>
|
<param name="readPropertyValue">When analysis is done on a property, if true then get it's value for transmission over WCF</param>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptProperty.SetValue">
|
<summary>
|
Gets or sets a delegate which is used to set the property / field value in the managed object.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptProperty.GetValue">
|
<summary>
|
Gets or sets a delegate which is used to get the property / field value from the managed object.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptProperty.Id">
|
<summary>
|
Identifies the <see cref="T:CefSharp.Internals.JavascriptProperty" /> for BrowserProcess to RenderProcess communication
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptProperty.ManagedName">
|
<summary>
|
Gets or sets the name of the managed property.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptProperty.JavascriptName">
|
<summary>
|
Gets or sets the name of the property in the JavaScript runtime.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptProperty.IsComplexType">
|
<summary>
|
Gets or sets if this property represents a complex type
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptProperty.IsReadOnly">
|
<summary>
|
Gets or sets if this property is read-only
|
</summary>
|
</member>
|
<member name="P:CefSharp.Internals.JavascriptProperty.PropertyValue">
|
<summary>
|
Gets or sets the property value
|
Only primative types can be stored in this property
|
</summary>
|
</member>
|
<member name="T:CefSharp.Internals.MethodRunnerQueue">
|
<summary>
|
MethodRunnerQueue - Async Javascript Binding methods are run
|
on the ThreadPool sequentially
|
</summary>
|
</member>
|
<member name="E:CefSharp.Internals.MethodRunnerQueue.MethodInvocationComplete">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.MethodRunnerQueue.#ctor(CefSharp.Internals.IJavascriptObjectRepositoryInternal)">
|
<summary>
|
Default constructor
|
</summary>
|
<param name="repository">javascript object repository</param>
|
</member>
|
<member name="M:CefSharp.Internals.MethodRunnerQueue.Dispose">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.MethodRunnerQueue.Enqueue(CefSharp.Internals.MethodInvocation)">
|
<inheritdoc/>
|
</member>
|
<member name="T:CefSharp.Internals.MimeTypeMapping">
|
<summary>
|
Internal Mime Type Mappings.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Internals.MimeTypeMapping.CustomMappings">
|
<summary>
|
Dictionary containing our custom mimeType mapping, you can add your own file extension
|
to mimeType mappings to this dictionary.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.MimeTypeMapping.GetCustomMapping(System.String)">
|
<summary>
|
Lookup MimeType from the <see cref="F:CefSharp.Internals.MimeTypeMapping.CustomMappings"/>
|
dictionary based on file extension.
|
</summary>
|
<param name="extension">extension</param>
|
<returns>custom mimeType or application/octet-stream if no mapping found </returns>
|
</member>
|
<member name="T:CefSharp.Internals.NoFocusHandler">
|
<summary>
|
NoFocusHandler - Used when disposing of the ChromiumWebBrowser controls
|
Doesn't take focus for the main browser (leaves default behaviour for popup).
|
OnGotFocus and OnTakeFocus are both noops.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Internals.NoOpBrowserRefCounter">
|
<inheritdoc/>
|
</member>
|
<member name="P:CefSharp.Internals.NoOpBrowserRefCounter.CefSharp#Internals#IBrowserRefCounter#Count">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.NoOpBrowserRefCounter.Dispose">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.NoOpBrowserRefCounter.CefSharp#Internals#IBrowserRefCounter#EnableLogging">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.NoOpBrowserRefCounter.CefSharp#Internals#IBrowserRefCounter#GetLog">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.NoOpBrowserRefCounter.CefSharp#Internals#IBrowserRefCounter#Decrement(System.Type)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.NoOpBrowserRefCounter.CefSharp#Internals#IBrowserRefCounter#Increment(System.Type)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.NoOpBrowserRefCounter.CefSharp#Internals#IBrowserRefCounter#WaitForBrowsersToClose(System.Int32)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Internals.NoOpBrowserRefCounter.CefSharp#Internals#IBrowserRefCounter#WaitForBrowsersToClose(System.Int32,System.Threading.CancellationToken)">
|
<inheritdoc/>
|
</member>
|
<member name="T:CefSharp.Internals.ParentProcessMonitor">
|
<summary>
|
Monitor the parent process and exit if the parent process closes
|
before the subprocess. This class is used by the CefSharp.BrowserSubprocess to
|
self terminate if the parent dies without notifying it to exit.
|
See https://github.com/cefsharp/CefSharp/issues/2359 for more information.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.ParentProcessMonitor.StartMonitorTask(System.Int32)">
|
<summary>
|
Starts a long running task (spawns new thread) used to monitor the parent process
|
and calls <see cref="M:System.Diagnostics.Process.Kill"/> if the parent exits unexpectedly (usually result of a crash).
|
</summary>
|
<param name="parentProcessId">process Id of the parent application</param>
|
</member>
|
<member name="T:CefSharp.Internals.PathCheck">
|
<summary>
|
Path Validation utility class
|
</summary>
|
</member>
|
<member name="F:CefSharp.Internals.PathCheck.EnableAssert">
|
<summary>
|
Allow user to disable the assert.
|
As a temporary measure we'll allow users to disable the assert
|
as the check may not yet be 100% bulletproof.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.PathCheck.IsDirectorySeparator(System.Char)">
|
<summary>
|
True if the given character is a directory separator.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.PathCheck.AssertAbsolute(System.String,System.String)">
|
<summary>
|
Throw exception if the path provided is non-asbolute
|
CEF now explicitly requires absolute paths
|
https://github.com/chromiumembedded/cef/issues/2916
|
Empty paths are ignored
|
</summary>
|
<param name="path">path</param>
|
<param name="settingName">string to appear at the start of
|
the exception, e.g. CefSettings.BrowserSubProcessPath</param>
|
</member>
|
<member name="M:CefSharp.Internals.PathCheck.IsAbsolute(System.String)">
|
<summary>
|
Valid path is absolute, based on Chromium implementation.
|
</summary>
|
<param name="path">path</param>
|
</member>
|
<member name="T:CefSharp.Internals.PendingTaskRepository`1">
|
<summary>
|
Class to store TaskCompletionSources indexed by a unique id. There are two distinct ConcurrentDictionary
|
instances as we have some Tasks that are created from the browser process (EvaluateScriptAsync) calls, and
|
some that are created for <see cref="T:CefSharp.IJavascriptCallback"/> instances for which the Id's are created
|
in the render process.
|
</summary>
|
<typeparam name="TResult">The type of the result produced by the tasks held.</typeparam>
|
</member>
|
<member name="M:CefSharp.Internals.PendingTaskRepository`1.CreatePendingTask(System.Nullable{System.TimeSpan})">
|
<summary>
|
Creates a new pending task with a timeout.
|
</summary>
|
<param name="timeout">The maximum running time of the task.</param>
|
<returns>The unique id of the newly created pending task and the newly created <see cref="T:System.Threading.Tasks.TaskCompletionSource`1"/>.</returns>
|
</member>
|
<member name="M:CefSharp.Internals.PendingTaskRepository`1.CreateJavascriptCallbackPendingTask(System.Int64,System.Nullable{System.TimeSpan})">
|
<summary>
|
Creates a new pending task with a timeout.
|
</summary>
|
<param name="id">Id passed in from the render process</param>
|
<param name="timeout">The maximum running time of the task.</param>
|
<returns>The unique id of the newly created pending task and the newly created <see cref="T:System.Threading.Tasks.TaskCompletionSource`1"/>.</returns>
|
</member>
|
<member name="M:CefSharp.Internals.PendingTaskRepository`1.RemovePendingTask(System.Int64)">
|
<summary>
|
If a <see cref="T:System.Threading.Tasks.TaskCompletionSource`1"/> is found matching <paramref name="id"/>
|
then it is removed from the ConcurrentDictionary and returned.
|
</summary>
|
<param name="id">Unique id of the pending task.</param>
|
<returns>
|
The <see cref="T:System.Threading.Tasks.TaskCompletionSource`1"/> associated with the given id
|
or null if no matching TaskComplectionSource found.
|
</returns>
|
</member>
|
<member name="M:CefSharp.Internals.PendingTaskRepository`1.RemoveJavascriptCallbackPendingTask(System.Int64)">
|
<summary>
|
If a <see cref="T:System.Threading.Tasks.TaskCompletionSource`1"/> is found matching <paramref name="id"/>
|
then it is removed from the ConcurrentDictionary and returned.
|
</summary>
|
<param name="id">Unique id of the pending task.</param>
|
<returns>
|
The <see cref="T:System.Threading.Tasks.TaskCompletionSource`1"/> associated with the given id
|
or null if no matching TaskComplectionSource found.
|
</returns>
|
</member>
|
<member name="T:CefSharp.Internals.StringCheck">
|
<summary>
|
String validation
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.StringCheck.IsLettersAndNumbers(System.String)">
|
<summary>
|
Regex check to ensure string contains only letters, numbers and underscores.
|
</summary>
|
<param name="stringToCheck"></param>
|
<returns>false if string is invalid</returns>
|
</member>
|
<member name="M:CefSharp.Internals.StringCheck.IsFirstCharacterLowercase(System.String)">
|
<summary>
|
Return true if the first chracter of the specified string is lowercase
|
</summary>
|
<param name="str">string</param>
|
<returns>returns false if empty or null, otherwise true if first character is lowercase</returns>
|
</member>
|
<member name="T:CefSharp.Internals.TaskExtensions">
|
<summary>
|
TaskExtension based on the following
|
https://github.com/ChadBurggraf/parallel-extensions-extras/blob/master/Extensions/TaskExtrasExtensions.cs
|
https://github.com/ChadBurggraf/parallel-extensions-extras/blob/ec803e58eee28c698e44f55f49c5ad6671b1aa58/Extensions/TaskCompletionSourceExtensions.cs
|
</summary>
|
</member>
|
<member name="T:CefSharp.Internals.Tasks.LimitedConcurrencyLevelTaskScheduler">
|
<summary>
|
Provides a task scheduler that ensures a maximum concurrency level while
|
running on top of the ThreadPool.
|
</summary>
|
</member>
|
<member name="F:CefSharp.Internals.Tasks.LimitedConcurrencyLevelTaskScheduler._currentThreadIsProcessingItems">
|
<summary>Whether the current thread is processing work items.</summary>
|
</member>
|
<member name="F:CefSharp.Internals.Tasks.LimitedConcurrencyLevelTaskScheduler._tasks">
|
<summary>The list of tasks to be executed.</summary>
|
</member>
|
<member name="F:CefSharp.Internals.Tasks.LimitedConcurrencyLevelTaskScheduler._maxDegreeOfParallelism">
|
<summary>The maximum concurrency level allowed by this scheduler.</summary>
|
</member>
|
<member name="F:CefSharp.Internals.Tasks.LimitedConcurrencyLevelTaskScheduler._delegatesQueuedOrRunning">
|
<summary>Whether the scheduler is currently processing work items.</summary>
|
</member>
|
<member name="M:CefSharp.Internals.Tasks.LimitedConcurrencyLevelTaskScheduler.#ctor(System.Int32)">
|
<summary>
|
Initializes an instance of the LimitedConcurrencyLevelTaskScheduler class with the
|
specified degree of parallelism.
|
</summary>
|
<param name="maxDegreeOfParallelism">The maximum degree of parallelism provided by this scheduler.</param>
|
</member>
|
<member name="M:CefSharp.Internals.Tasks.LimitedConcurrencyLevelTaskScheduler.QueueTask(System.Threading.Tasks.Task)">
|
<summary>Queues a task to the scheduler.</summary>
|
<param name="task">The task to be queued.</param>
|
</member>
|
<member name="M:CefSharp.Internals.Tasks.LimitedConcurrencyLevelTaskScheduler.NotifyThreadPoolOfPendingWork">
|
<summary>
|
Informs the ThreadPool that there's work to be executed for this scheduler.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Internals.Tasks.LimitedConcurrencyLevelTaskScheduler.TryExecuteTaskInline(System.Threading.Tasks.Task,System.Boolean)">
|
<summary>Attempts to execute the specified task on the current thread.</summary>
|
<param name="task">The task to be executed.</param>
|
<param name="taskWasPreviouslyQueued"></param>
|
<returns>Whether the task could be executed on the current thread.</returns>
|
</member>
|
<member name="M:CefSharp.Internals.Tasks.LimitedConcurrencyLevelTaskScheduler.TryDequeue(System.Threading.Tasks.Task)">
|
<summary>Attempts to remove a previously scheduled task from the scheduler.</summary>
|
<param name="task">The task to be removed.</param>
|
<returns>Whether the task could be found and removed.</returns>
|
</member>
|
<member name="P:CefSharp.Internals.Tasks.LimitedConcurrencyLevelTaskScheduler.MaximumConcurrencyLevel">
|
<summary>Gets the maximum concurrency level supported by this scheduler.</summary>
|
</member>
|
<member name="M:CefSharp.Internals.Tasks.LimitedConcurrencyLevelTaskScheduler.GetScheduledTasks">
|
<summary>Gets an enumerable of the tasks currently scheduled on this scheduler.</summary>
|
<returns>An enumerable of the tasks currently scheduled.</returns>
|
</member>
|
<member name="T:CefSharp.Internals.Tasks.SyncContextTaskCompletionSource`1">
|
<summary>
|
TaskCompletionSource that executes it's continuation on the captured
|
<see cref="T:System.Threading.SynchronizationContext"/>. If <see cref="P:CefSharp.Internals.Tasks.SyncContextTaskCompletionSource`1.SyncContext"/> is null.
|
then the current **executing** thread will be called. e.g. The thread that
|
called <see cref="M:System.Threading.Tasks.TaskCompletionSource`1.TrySetResult(`0)"/>
|
(or other Set/Try set methods).
|
</summary>
|
<typeparam name="TResult">Result Type</typeparam>
|
</member>
|
<member name="P:CefSharp.Internals.Tasks.SyncContextTaskCompletionSource`1.SyncContext">
|
<summary>
|
Captured Sync Context
|
</summary>
|
</member>
|
<member name="T:CefSharp.Internals.TaskTimeoutExtensions">
|
<summary>
|
WaitAsync polyfills imported from .Net Runtime
|
as we don't get access to this method in older .net versions
|
</summary>
|
</member>
|
<member name="T:CefSharp.ByteArrayResourceHandler">
|
<summary>
|
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
|
</summary>
|
</member>
|
<member name="P:CefSharp.ByteArrayResourceHandler.Data">
|
<summary>
|
Underlying byte array that represents the data
|
</summary>
|
</member>
|
<member name="P:CefSharp.ByteArrayResourceHandler.MimeType">
|
<summary>
|
Gets or sets the Mime Type.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ByteArrayResourceHandler.#ctor(System.String,System.Byte[])">
|
<summary>
|
Initializes a new instance of the <see cref="T:CefSharp.ByteArrayResourceHandler"/> class.
|
</summary>
|
<param name="mimeType">mimeType</param>
|
<param name="data">byte array</param>
|
</member>
|
<member name="T:CefSharp.FileResourceHandler">
|
<summary>
|
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
|
</summary>
|
</member>
|
<member name="P:CefSharp.FileResourceHandler.FilePath">
|
<summary>
|
Path of the underlying file
|
</summary>
|
</member>
|
<member name="P:CefSharp.FileResourceHandler.MimeType">
|
<summary>
|
Gets or sets the Mime Type.
|
</summary>
|
</member>
|
<member name="M:CefSharp.FileResourceHandler.#ctor(System.String,System.String)">
|
<summary>
|
Initializes a new instance of the <see cref="T:CefSharp.FileResourceHandler"/> class.
|
</summary>
|
<param name="mimeType">mimeType</param>
|
<param name="filePath">filePath</param>
|
</member>
|
<member name="T:CefSharp.IPopupFeatures">
|
<summary>
|
Class representing popup window features.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IPopupFeatures.X">
|
<summary>
|
Gets the x coordinate.
|
</summary>
|
<value>
|
The x coordinate.
|
</value>
|
</member>
|
<member name="P:CefSharp.IPopupFeatures.Y">
|
<summary>
|
Gets the y coordinate.
|
</summary>
|
<value>
|
The y coordinate.
|
</value>
|
</member>
|
<member name="P:CefSharp.IPopupFeatures.Width">
|
<summary>
|
Gets the width.
|
</summary>
|
<value>
|
The width.
|
</value>
|
</member>
|
<member name="P:CefSharp.IPopupFeatures.Height">
|
<summary>
|
Gets the height.
|
</summary>
|
<value>
|
The height.
|
</value>
|
</member>
|
<member name="P:CefSharp.IPopupFeatures.IsPopup">
|
<summary>
|
Returns true if browser interface elements should be hidden.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IPostData">
|
<summary>
|
Class used to represent post data for a web request. The methods of this class may be called on any thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IPostData.AddElement(CefSharp.IPostDataElement)">
|
<summary>
|
Add the specified <see cref="T:CefSharp.IPostDataElement"/>.
|
</summary>
|
<param name="element">element to be added.</param>
|
<returns>Returns true if the add succeeds.</returns>
|
</member>
|
<member name="M:CefSharp.IPostData.RemoveElement(CefSharp.IPostDataElement)">
|
<summary>
|
Remove the specified <see cref="T:CefSharp.IPostDataElement"/>.
|
</summary>
|
<param name="element">element to be removed.</param>
|
<returns> Returns true if the add succeeds.</returns>
|
</member>
|
<member name="P:CefSharp.IPostData.Elements">
|
<summary>
|
Retrieve the post data elements.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IPostData.IsReadOnly">
|
<summary>
|
Returns true if this object is read-only.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IPostData.RemoveElements">
|
<summary>
|
Remove all existing post data elements.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IPostData.IsDisposed">
|
<summary>
|
Gets a value indicating whether the object has been disposed of.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IPostData.CreatePostDataElement">
|
<summary>
|
Create a new <see cref="T:CefSharp.IPostDataElement"/> instance
|
</summary>
|
<returns>PostDataElement</returns>
|
</member>
|
<member name="P:CefSharp.IPostData.HasExcludedElements">
|
<summary>
|
Returns true if the underlying POST data includes elements that are not
|
represented by this IPostData object (for example, multi-part file upload
|
data). Modifying IPostData objects with excluded elements may result in
|
the request failing.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IPostData.UnWrap">
|
<summary>
|
Used internally to get the underlying <see cref="T:CefSharp.IPostData"/> instance.
|
Unlikely you'll use this yourself.
|
</summary>
|
<returns>the inner most instance</returns>
|
</member>
|
<member name="T:CefSharp.IPostDataElement">
|
<summary>
|
Class used to represent a single element in the request post data.
|
The methods of this class may be called on any thread.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IPostDataElement.File">
|
<summary>
|
Gets or sets the file name.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IPostDataElement.IsReadOnly">
|
<summary>
|
Gets if the object is read-only.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IPostDataElement.SetToEmpty">
|
<summary>
|
Remove all contents from the post data element.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IPostDataElement.Type">
|
<summary>
|
Gets the type of this <see cref="T:CefSharp.IPostDataElement"/>.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IPostDataElement.Bytes">
|
<summary>
|
Gets or sets the bytes of this <see cref="T:CefSharp.IPostDataElement"/>.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IPostDataElement.UnWrap">
|
<summary>
|
Used internally to get the underlying <see cref="T:CefSharp.IPostDataElement"/> instance.
|
Unlikely you'll use this yourself.
|
</summary>
|
<returns>the inner most instance</returns>
|
</member>
|
<member name="T:CefSharp.IRegistration">
|
<summary>
|
Generic callback interface used for managing the lifespan of a registration.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IRequest">
|
<summary>
|
Class used to represent a web request. The methods of this class may be called on any thread.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IRequest.Flags">
|
<summary>
|
Get/Set request flags, can be used to control caching policy
|
</summary>
|
</member>
|
<member name="P:CefSharp.IRequest.Url">
|
<summary>
|
Request Url
|
</summary>
|
</member>
|
<member name="P:CefSharp.IRequest.Identifier">
|
<summary>
|
Returns the globally unique identifier for this request or 0 if not specified.
|
Can be used by <see cref="T:CefSharp.IRequestHandler"/> implementations in the browser process to track a
|
single request across multiple callbacks.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IRequest.Method">
|
<summary>
|
Request Method GET/POST etc
|
</summary>
|
</member>
|
<member name="M:CefSharp.IRequest.SetReferrer(System.String,CefSharp.ReferrerPolicy)">
|
<summary>
|
Set the referrer URL and policy. If non-empty the referrer URL must be
|
fully qualified with an HTTP or HTTPS scheme component. Any username,
|
password or ref component will be removed.
|
</summary>
|
<param name="referrerUrl">the referrer url</param>
|
<param name="policy">referrer policy</param>
|
</member>
|
<member name="P:CefSharp.IRequest.ReferrerUrl">
|
<summary>
|
Get the referrer URL.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IRequest.ResourceType">
|
<summary>
|
Get the resource type for this request.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IRequest.ReferrerPolicy">
|
<summary>
|
Get the referrer policy.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IRequest.Headers">
|
<summary>
|
Header Collection - If dealing with headers that only contain a single value then
|
it's easier to use <see cref="M:CefSharp.IRequest.SetHeaderByName(System.String,System.String,System.Boolean)"/> or <see cref="M:CefSharp.IRequest.GetHeaderByName(System.String)"/>.
|
You cannot modify the referrer using headers, use <see cref="M:CefSharp.IRequest.SetReferrer(System.String,CefSharp.ReferrerPolicy)"/>.
|
NOTE: This collection is a copy of the underlying type, to make changes, take a reference to the collection,
|
make your changes, then reassign the collection.
|
</summary>
|
<example>
|
This example shows how to modify headers, make sure you reassign the collection
|
once it's been modified.
|
<code>
|
var headers = request.Headers;
|
var userAgent = headers["User-Agent"];
|
headers["User-Agent"] = userAgent + " CefSharp";
|
request.Headers = headers;
|
</code>
|
</example>
|
</member>
|
<member name="P:CefSharp.IRequest.PostData">
|
<summary>
|
Post data
|
</summary>
|
</member>
|
<member name="P:CefSharp.IRequest.TransitionType">
|
<summary>
|
Get the transition type for this request.
|
Applies to requests that represent a main frame or sub-frame navigation.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IRequest.IsDisposed">
|
<summary>
|
Gets a value indicating whether the request has been disposed of.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IRequest.IsReadOnly">
|
<summary>
|
Returns true if this object is read-only.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IRequest.InitializePostData">
|
<summary>
|
Initialize a new instance of <see cref="T:CefSharp.IPostData"/>.
|
Make sure to check if the <see cref="P:CefSharp.IRequest.PostData"/> is null
|
before calling otherwise the existing data will be overridden.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IRequest.GetHeaderByName(System.String)">
|
<summary>
|
Returns the first header value for name or an empty string if not found.
|
Will not return the Referer value if any. Use <see cref="P:CefSharp.IRequest.Headers"/> instead if name might have multiple values.
|
</summary>
|
<param name="name">header name</param>
|
<returns>Returns the first header value for name or an empty string if not found.</returns>
|
</member>
|
<member name="M:CefSharp.IRequest.SetHeaderByName(System.String,System.String,System.Boolean)">
|
<summary>
|
Set the header name to value. The Referer value cannot be set using this method.
|
Use <see cref="M:CefSharp.IRequest.SetReferrer(System.String,CefSharp.ReferrerPolicy)"/> instead.
|
</summary>
|
<param name="name">header name</param>
|
<param name="value">new header value</param>
|
<param name="overwrite">If overwrite is true any existing values will be replaced with the new value. If overwrite is false any existing values will not be overwritten</param>
|
</member>
|
<member name="M:CefSharp.IRequest.UnWrap">
|
<summary>
|
Used internally to get the underlying <see cref="T:CefSharp.IRequest"/> instance.
|
Unlikely you'll use this yourself.
|
</summary>
|
<returns>the inner most instance</returns>
|
</member>
|
<member name="T:CefSharp.IRequestContext">
|
<summary>
|
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
|
<see cref="P:CefSharp.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.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IRequestContext.IsDisposed">
|
<summary>
|
Gets a value indicating whether the RequestContext has been disposed of.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IRequestContext.IsSame(CefSharp.IRequestContext)">
|
<summary>
|
Returns true if this object is pointing to the same context object.
|
</summary>
|
<param name="context">context to compare</param>
|
<returns>Returns true if the same</returns>
|
</member>
|
<member name="M:CefSharp.IRequestContext.IsSharingWith(CefSharp.IRequestContext)">
|
<summary>
|
Returns true if this object is sharing the same storage as the specified context.
|
</summary>
|
<param name="context">context to compare</param>
|
<returns>Returns true if same storage</returns>
|
</member>
|
<member name="P:CefSharp.IRequestContext.IsGlobal">
|
<summary>
|
Returns true if this object is the global context. The global context is
|
used by default when creating a browser or URL request with a NULL context
|
argument.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IRequestContext.GetCookieManager(CefSharp.ICompletionCallback)">
|
<summary>
|
Returns the default cookie manager for this object. This will be the global
|
cookie manager if this object is the global request context.
|
</summary>
|
<param name="callback">If callback is non-NULL it will be executed asynchronously on the CEF IO thread
|
after the manager's storage has been initialized.</param>
|
<returns>Returns the default cookie manager for this object</returns>
|
</member>
|
<member name="M:CefSharp.IRequestContext.RegisterSchemeHandlerFactory(System.String,System.String,CefSharp.ISchemeHandlerFactory)">
|
<summary>
|
Register a scheme handler factory for the specified schemeName and optional domainName.
|
An empty domainName value for a standard scheme will cause the factory to match all domain
|
names. The domainName value will be ignored for non-standard schemes. If schemeName is
|
a built-in scheme and no handler is returned by factory then the built-in scheme handler
|
factory will be called. If schemeName is a custom scheme then you must also implement the
|
CefApp::OnRegisterCustomSchemes() method in all processes. This function may be called multiple
|
times to change or remove the factory that matches the specified schemeName and optional
|
domainName.
|
</summary>
|
<param name="schemeName">Scheme Name</param>
|
<param name="domainName">Optional domain name</param>
|
<param name="factory">Scheme handler factory</param>
|
<returns>Returns false if an error occurs.</returns>
|
</member>
|
<member name="M:CefSharp.IRequestContext.ClearSchemeHandlerFactories">
|
<summary>
|
Clear all registered scheme handler factories.
|
</summary>
|
<returns>Returns false on error.</returns>
|
</member>
|
<member name="P:CefSharp.IRequestContext.CachePath">
|
<summary>
|
Returns the cache path for this object. If empty an "incognito mode"
|
in-memory cache is being used.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IRequestContext.HasPreference(System.String)">
|
<summary>
|
Returns true if a preference with the specified name exists. This method
|
must be called on the CEF UI thread.
|
</summary>
|
<param name="name">name of preference</param>
|
<returns>bool if the preference exists</returns>
|
<remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
|
<see cref="M:CefSharp.IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
|
executed on the CEF UI thread, so can be called directly.
|
When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
|
application thread will be the CEF UI thread.</remarks>
|
</member>
|
<member name="M:CefSharp.IRequestContext.GetPreference(System.String)">
|
<summary>
|
Returns the value for the preference with the specified name. Returns
|
NULL if the preference does not exist. The returned object contains a copy
|
of the underlying preference value and modifications to the returned object
|
will not modify the underlying preference value. This method must be called
|
on the CEF UI thread.
|
</summary>
|
<param name="name">preference name</param>
|
<returns>Returns the value for the preference with the specified name</returns>
|
<remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
|
<see cref="M:CefSharp.IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
|
executed on the CEF UI thread, so can be called directly.
|
When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
|
application thread will be the CEF UI thread.</remarks>
|
</member>
|
<member name="M:CefSharp.IRequestContext.GetAllPreferences(System.Boolean)">
|
<summary>
|
Returns all preferences as a dictionary. The returned
|
object contains a copy of the underlying preference values and
|
modifications to the returned object will not modify the underlying
|
preference values. This method must be called on the browser process UI
|
thread.
|
</summary>
|
<param name="includeDefaults">If true then
|
preferences currently at their default value will be included.</param>
|
<returns>Preferences (dictionary can have sub dictionaries)</returns>
|
</member>
|
<member name="M:CefSharp.IRequestContext.CanSetPreference(System.String)">
|
<summary>
|
Returns true if the preference with the specified name can be modified
|
using SetPreference. As one example preferences set via the command-line
|
usually cannot be modified. This method must be called on the CEF UI thread.
|
</summary>
|
<param name="name">preference key</param>
|
<returns>Returns true if the preference with the specified name can be modified
|
using SetPreference</returns>
|
<remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
|
<see cref="M:CefSharp.IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
|
executed on the CEF UI thread, so can be called directly.
|
When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
|
application thread will be the CEF UI thread.</remarks>
|
</member>
|
<member name="M:CefSharp.IRequestContext.SetPreference(System.String,System.Object,System.String@)">
|
<summary>
|
Set the value associated with preference name. If value is null the
|
preference will be restored to its default value. If setting the preference
|
fails then error will be populated with a detailed description of the
|
problem. This method must be called on the CEF UI thread.
|
Preferences set via the command-line usually cannot be modified.
|
</summary>
|
<param name="name">preference key</param>
|
<param name="value">preference value</param>
|
<param name="error">out error</param>
|
<returns>Returns true if the value is set successfully and false otherwise.</returns>
|
<remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
|
<see cref="M:CefSharp.IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
|
executed on the CEF UI thread, so can be called directly.
|
When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
|
application thread will be the CEF UI thread.</remarks>
|
</member>
|
<member name="M:CefSharp.IRequestContext.ClearCertificateExceptions(CefSharp.ICompletionCallback)">
|
<summary>
|
Clears all certificate exceptions that were added as part of handling
|
<see cref="M:CefSharp.IRequestHandler.OnCertificateError(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefErrorCode,System.String,CefSharp.ISslInfo,CefSharp.IRequestCallback)"/>. If you call this it is
|
recommended that you also call <see cref="M:CefSharp.IRequestContext.CloseAllConnections(CefSharp.ICompletionCallback)"/> or you risk not
|
being prompted again for server certificates if you reconnect quickly.
|
</summary>
|
<param name="callback">If is non-NULL it will be executed on the CEF UI thread after
|
completion. This param is optional</param>
|
</member>
|
<member name="M:CefSharp.IRequestContext.ClearHttpAuthCredentials(CefSharp.ICompletionCallback)">
|
<summary>
|
Clears all HTTP authentication credentials that were added as part of handling
|
<see cref="M:CefSharp.IRequestHandler.GetAuthCredentials(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,System.Boolean,System.String,System.Int32,System.String,System.String,CefSharp.IAuthCallback)"/>.
|
</summary>
|
<param name="callback">If is non-NULL it will be executed on the CEF UI thread after
|
completion. This param is optional</param>
|
</member>
|
<member name="M:CefSharp.IRequestContext.CloseAllConnections(CefSharp.ICompletionCallback)">
|
<summary>
|
Clears all active and idle connections that Chromium currently has.
|
This is only recommended if you have released all other CEF objects but
|
don't yet want to call Cef.Shutdown().
|
</summary>
|
<param name="callback">If is non-NULL it will be executed on the CEF UI thread after
|
completion. This param is optional</param>
|
</member>
|
<member name="M:CefSharp.IRequestContext.ResolveHostAsync(System.Uri)">
|
<summary>
|
Attempts to resolve origin to a list of associated IP addresses.
|
</summary>
|
<param name="origin">host name to resolve</param>
|
<returns>A task that represents the Resoolve Host operation. The value of the TResult parameter contains ResolveCallbackResult.</returns>
|
</member>
|
<member name="M:CefSharp.IRequestContext.DidLoadExtension(System.String)">
|
<summary>
|
Returns true if this context was used to load the extension identified by extensionId. Other contexts sharing the same storage will also have access to the extension (see HasExtension).
|
This method must be called on the CEF UI thread.
|
</summary>
|
<returns>Returns true if this context was used to load the extension identified by extensionId</returns>
|
</member>
|
<member name="M:CefSharp.IRequestContext.GetExtension(System.String)">
|
<summary>
|
Returns the extension matching extensionId or null if no matching extension is accessible in this context (see HasExtension).
|
This method must be called on the CEF UI thread.
|
</summary>
|
<param name="extensionId">extension Id</param>
|
<returns>Returns the extension matching extensionId or null if no matching extension is accessible in this context</returns>
|
</member>
|
<member name="M:CefSharp.IRequestContext.GetExtensions(System.Collections.Generic.IList{System.String}@)">
|
<summary>
|
Retrieve the list of all extensions that this context has access to (see HasExtension).
|
<paramref name="extensionIds"/> will be populated with the list of extension ID values.
|
This method must be called on the CEF UI thread.
|
</summary>
|
<param name="extensionIds">output a list of extensions Ids</param>
|
<returns>returns true on success otherwise false</returns>
|
</member>
|
<member name="M:CefSharp.IRequestContext.HasExtension(System.String)">
|
<summary>
|
Returns true if this context has access to the extension identified by extensionId.
|
This may not be the context that was used to load the extension (see DidLoadExtension).
|
This method must be called on the CEF UI thread.
|
</summary>
|
<param name="extensionId">extension id</param>
|
<returns>Returns true if this context has access to the extension identified by extensionId</returns>
|
</member>
|
<member name="M:CefSharp.IRequestContext.LoadExtension(System.String,System.String,CefSharp.IExtensionHandler)">
|
<summary>
|
Load an extension. If extension resources will be read from disk using the default load implementation then rootDirectoy
|
should be the absolute path to the extension resources directory and manifestJson should be null.
|
If extension resources will be provided by the client (e.g. via IRequestHandler and/or IExtensionHandler) then rootDirectory
|
should be a path component unique to the extension (if not absolute this will be internally prefixed with the PK_DIR_RESOURCES path)
|
and manifestJson should contain the contents that would otherwise be read from the "manifest.json" file on disk.
|
The loaded extension will be accessible in all contexts sharing the same storage (HasExtension returns true).
|
However, only the context on which this method was called is considered the loader (DidLoadExtension returns true) and only the
|
loader will receive IRequestContextHandler callbacks for the extension.
|
|
<see cref="M:CefSharp.IExtensionHandler.OnExtensionLoaded(CefSharp.IExtension)"/> will be called on load success or
|
<see cref="M:CefSharp.IExtensionHandler.OnExtensionLoadFailed(CefSharp.CefErrorCode)"/> will be called on load failure.
|
|
If the extension specifies a background script via the "background" manifest key then <see cref="M:CefSharp.IExtensionHandler.OnBeforeBackgroundBrowser(CefSharp.IExtension,System.String,CefSharp.IBrowserSettings)"/>
|
will be called to create the background browser. See that method for additional information about background scripts.
|
|
For visible extension views the client application should evaluate the manifest to determine the correct extension URL to load and then
|
load the extension URL in a ChromiumWebBrowser instance after the extension has loaded.
|
|
For example, the client can look for the "browser_action" manifest key as documented at https://developer.chrome.com/extensions/browserAction.
|
Extension URLs take the form "chrome-extension://<extension_id>/<path>"
|
Browsers that host extensions differ from normal browsers as follows:
|
|
- Can access chrome.* JavaScript APIs if allowed by the manifest. Visit chrome://extensions-support for the list of extension APIs currently supported by CEF.
|
- Main frame navigation to non-extension content is blocked.
|
- Pinch-zooming is disabled.
|
- <see cref="P:CefSharp.IBrowserHost.Extension"/> returns the hosted extension.
|
- CefBrowserHost::IsBackgroundHost returns true for background hosts.
|
|
See https://developer.chrome.com/extensions for extension implementation and usage documentation.
|
</summary>
|
<param name="rootDirectory">If extension resources will be read from disk using the default load implementation then rootDirectoy
|
should be the absolute path to the extension resources directory and manifestJson should be null</param>
|
<param name="manifestJson">If extension resources will be provided by the client then rootDirectory should be a path component unique to the extension
|
and manifestJson should contain the contents that would otherwise be read from the manifest.json file on disk</param>
|
<param name="handler">handle events related to browser extensions</param>
|
<remarks>
|
For extensions that load a popup you are required to query the Manifest, build a Url in the format
|
chrome-extension://{extension.Identifier}/{default_popup} with default_popup url coming from the mainfest. With the extension
|
url you then need to open a new Form/Window/Tab and create a new ChromiumWebBrowser instance to host the extension popup.
|
To load a crx file you must first unzip them to a folder and pass the path containing the extension as <paramref name="rootDirectory"/>.
|
It in theory should be possible to load a crx file in memory, passing it's manifest.json file content as <paramref name="manifestJson"/>
|
then fulfilling the resource rquests made to <see cref="M:CefSharp.IExtensionHandler.GetExtensionResource(CefSharp.IExtension,CefSharp.IBrowser,System.String,CefSharp.IGetExtensionResourceCallback)"/>.
|
</remarks>
|
</member>
|
<member name="M:CefSharp.IRequestContext.UnWrap">
|
<summary>
|
Used internally to get the underlying <see cref="T:CefSharp.IRequestContext"/> instance.
|
Unlikely you'll use this yourself.
|
</summary>
|
<returns>the inner most instance</returns>
|
</member>
|
<member name="T:CefSharp.IResourceRequestHandlerFactory">
|
<summary>
|
Class that creates <see cref="T:CefSharp.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 <see cref="T:CefSharp.ResourceRequestHandlerFactory"/> implementation that provides support
|
for the LoadHtml extension method.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IResourceRequestHandlerFactory.HasHandlers">
|
<summary>
|
Return <see langword="true"/> to have <see cref="M:CefSharp.IResourceRequestHandlerFactory.GetResourceRequestHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,System.Boolean,System.Boolean,System.String,System.Boolean@)"/>
|
called for every resource request. Otherwise return <see langword="false"/>.
|
</summary>
|
<remarks>
|
If you return <see langword="false"/> then <see cref="M:CefSharp.IResourceRequestHandlerFactory.GetResourceRequestHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,System.Boolean,System.Boolean,System.String,System.Boolean@)"/>
|
will not be called.
|
</remarks>
|
</member>
|
<member name="M:CefSharp.IResourceRequestHandlerFactory.GetResourceRequestHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,System.Boolean,System.Boolean,System.String,System.Boolean@)">
|
<summary>
|
Called on the CEF IO thread before a resource request is initiated.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">represent the source browser of the request</param>
|
<param name="frame">represent the source frame of the request</param>
|
<param name="request">represents the request contents and cannot be modified in this callback</param>
|
<param name="isNavigation">will be true if the resource request is a navigation</param>
|
<param name="isDownload">will be true if the resource request is a download</param>
|
<param name="requestInitiator">is the origin (scheme + domain) of the page that initiated the request</param>
|
<param name="disableDefaultHandling">to true to disable default handling of the request, in which case it will need to be handled via <see cref="M:CefSharp.IResourceRequestHandler.GetResourceHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)"/> or it will be canceled</param>
|
<returns>To allow the resource load to proceed with default handling return null. To specify a handler for the resource return a <see cref="T:CefSharp.IResourceRequestHandler"/> object. If this callback returns null the same method will be called on the associated <see cref="T:CefSharp.IRequestContextHandler"/>, if any</returns>
|
</member>
|
<member name="T:CefSharp.IResponse">
|
<summary>
|
Class used to represent a web response. The methods of this class may be called on any thread.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IResponse.Charset">
|
<summary>
|
Get/Set the response charset.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IResponse.MimeType">
|
<summary>
|
MimeType
|
</summary>
|
</member>
|
<member name="P:CefSharp.IResponse.Headers">
|
<summary>
|
Response Headers
|
</summary>
|
</member>
|
<member name="P:CefSharp.IResponse.IsReadOnly">
|
<summary>
|
Returns true if this object is read-only.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IResponse.ErrorCode">
|
<summary>
|
Get/set the response error code.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IResponse.StatusCode">
|
<summary>
|
The status code of the response. Unless set, the default value used is 200
|
(corresponding to HTTP status OK).
|
</summary>
|
</member>
|
<member name="P:CefSharp.IResponse.StatusText">
|
<summary>
|
Status Text
|
</summary>
|
</member>
|
<member name="M:CefSharp.IResponse.GetHeaderByName(System.String)">
|
<summary>
|
Returns the first header value for name or an empty string if not found.
|
Will not return the Referer value if any. Use <see cref="P:CefSharp.IResponse.Headers"/> instead if name might have multiple values.
|
</summary>
|
<param name="name">header name</param>
|
<returns>Returns the first header value for name or an empty string if not found.</returns>
|
</member>
|
<member name="M:CefSharp.IResponse.SetHeaderByName(System.String,System.String,System.Boolean)">
|
<summary>
|
Set the header name to value.
|
</summary>
|
<param name="name">header name</param>
|
<param name="value">new header value</param>
|
<param name="overwrite">If overwrite is true any existing values will be replaced with the new value. If overwrite is false any existing values will not be overwritten</param>
|
</member>
|
<member name="T:CefSharp.IResponseFilter">
|
<summary>
|
Implement this interface to filter resource response content.
|
The methods of this class will be called on the CEF IO thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IResponseFilter.InitFilter">
|
<summary>
|
Initialize the response filter. Will only be called a single time.
|
The filter will not be installed if this method returns false.
|
</summary>
|
<returns>The filter will not be installed if this method returns false.</returns>
|
</member>
|
<member name="M:CefSharp.IResponseFilter.Filter(System.IO.Stream,System.Int64@,System.IO.Stream,System.Int64@)">
|
<summary>
|
Called to filter a chunk of data.
|
This method will be called repeatedly until there is no more data to filter (resource response is complete),
|
dataInRead matches dataIn.Length (all available pre-filter bytes have been read), and the method
|
returns FilterStatus.Done or FilterStatus.Error.
|
</summary>
|
<param name="dataIn">is a Stream wrapping the underlying input buffer containing pre-filter data. Can be null.</param>
|
<param name="dataInRead">Set to the number of bytes that were read from dataIn</param>
|
<param name="dataOut">is a Stream wrapping the underlying output buffer that can accept filtered output data.
|
Check dataOut.Length for maximum buffer size</param>
|
<param name="dataOutWritten">Set to the number of bytes that were written into dataOut</param>
|
<returns>If some or all of the pre-filter data was read successfully but more data is needed in order
|
to continue filtering (filtered output is pending) return FilterStatus.NeedMoreData. If some or all of the pre-filter
|
data was read successfully and all available filtered output has been written return FilterStatus.Done. If an error
|
occurs during filtering return FilterStatus.Error. </returns>
|
<remarks>Do not keep a reference to the buffers(Streams) passed to this method.</remarks>
|
</member>
|
<member name="T:CefSharp.ISchemeRegistrar">
|
<summary>
|
Manages custom scheme registrations.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ISchemeRegistrar.AddCustomScheme(System.String,CefSharp.Enums.SchemeOptions)">
|
<summary>
|
Register a custom scheme. This method should not be called for the built-in
|
HTTP, HTTPS, FILE, FTP, ABOUT and DATA schemes.
|
|
See <see cref="T:CefSharp.Enums.SchemeOptions"/> for possible values for <paramref name="schemeOptions"/>
|
|
This function may be called on any thread. It should only be called once
|
per unique <paramref name="schemeName"/> value.
|
</summary>
|
<param name="schemeName">scheme name</param>
|
<param name="schemeOptions">scheme options</param>
|
<returns>If <paramref name="schemeName"/> is already registered or if an error occurs this method will return false.</returns>
|
</member>
|
<member name="T:CefSharp.ISslInfo">
|
<summary>
|
Class representing SSL information.
|
</summary>
|
</member>
|
<member name="P:CefSharp.ISslInfo.CertStatus">
|
<summary>
|
Returns a bitmask containing any and all problems verifying the server
|
certificate.
|
</summary>
|
</member>
|
<member name="P:CefSharp.ISslInfo.X509Certificate">
|
<summary>
|
Returns the X.509 certificate.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IUrlRequest">
|
<summary>
|
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.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IUrlRequest.ResponseWasCached">
|
<summary>
|
True if the response was served from the cache.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IUrlRequest.Response">
|
<summary>
|
The response, or null if no response information is available
|
</summary>
|
</member>
|
<member name="P:CefSharp.IUrlRequest.RequestStatus">
|
<summary>
|
The request status.
|
</summary>
|
</member>
|
<member name="T:CefSharp.IUrlRequestClient">
|
<summary>
|
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.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IUrlRequestClient.GetAuthCredentials(System.Boolean,System.String,System.Int32,System.String,System.String,CefSharp.IAuthCallback)">
|
<summary>
|
Called on the CEF IO thread when the browser needs credentials from the user.
|
This method will only be called for requests initiated from the browser process.
|
</summary>
|
<param name="isProxy">indicates whether the host is a proxy server.</param>
|
<param name="host">the hostname.</param>
|
<param name="port">the port number.</param>
|
<param name="realm">realm</param>
|
<param name="scheme">scheme</param>
|
<param name="callback">is a callback for authentication information</param>
|
<returns>
|
Return true to continue the request and call <see cref="M:CefSharp.IAuthCallback.Continue(System.String,System.String)"/> when the authentication information is available.
|
If the request has an associated browser/frame then returning false will result in a call to <see cref="M:CefSharp.IRequestHandler.GetAuthCredentials(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,System.Boolean,System.String,System.Int32,System.String,System.String,CefSharp.IAuthCallback)"/>
|
on the <see cref="T:CefSharp.IRequestHandler"/> associated with that browser, if any.
|
Otherwise, returning false will cancel the request immediately.
|
</returns>
|
</member>
|
<member name="M:CefSharp.IUrlRequestClient.OnDownloadData(CefSharp.IUrlRequest,System.IO.Stream)">
|
<summary>
|
Called when some part of the response is read. This method will not be called if the <see cref="F:CefSharp.UrlRequestFlags.NoDownloadData"/> flag is set on the request.
|
</summary>
|
<param name="request">request</param>
|
<param name="data">A stream containing the bytes received since the last call. Cannot be used outside the scope of this method. </param>
|
</member>
|
<member name="M:CefSharp.IUrlRequestClient.OnDownloadProgress(CefSharp.IUrlRequest,System.Int64,System.Int64)">
|
<summary>
|
Notifies the client of download progress.
|
</summary>
|
<param name="request">request</param>
|
<param name="current">denotes the number of bytes received up to the call </param>
|
<param name="total">is the expected total size of the response (or -1 if not determined).</param>
|
</member>
|
<member name="M:CefSharp.IUrlRequestClient.OnRequestComplete(CefSharp.IUrlRequest)">
|
<summary>
|
Notifies the client that the request has completed.
|
Use the <see cref="P:CefSharp.IUrlRequest.RequestStatus"/> property to determine if the
|
request was successful or not.
|
</summary>
|
<param name="request">request</param>
|
</member>
|
<member name="M:CefSharp.IUrlRequestClient.OnUploadProgress(CefSharp.IUrlRequest,System.Int64,System.Int64)">
|
<summary>
|
Notifies the client of upload progress.
|
This method will only be called if the UR_FLAG_REPORT_UPLOAD_PROGRESS flag is set on the request.
|
</summary>
|
<param name="request">request</param>
|
<param name="current">denotes the number of bytes sent so far.</param>
|
<param name="total">is the total size of uploading data (or -1 if chunked upload is enabled).</param>
|
</member>
|
<member name="T:CefSharp.IValue">
|
<summary>
|
Interface representing CefValue.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IValue.Type">
|
<summary>
|
Returns the underlying value type.
|
</summary>
|
<returns>
|
Returns the underlying value type.
|
</returns>
|
</member>
|
<member name="M:CefSharp.IValue.GetBool">
|
<summary>
|
Returns the underlying value as type bool.
|
</summary>
|
<returns>
|
Returns the underlying value as type bool.
|
</returns>
|
</member>
|
<member name="M:CefSharp.IValue.GetDouble">
|
<summary>
|
Returns the underlying value as type double.
|
</summary>
|
<returns>
|
Returns the underlying value as type double.
|
</returns>
|
</member>
|
<member name="M:CefSharp.IValue.GetInt">
|
<summary>
|
Returns the underlying value as type int.
|
</summary>
|
<returns>
|
Returns the underlying value as type int.
|
</returns>
|
</member>
|
<member name="M:CefSharp.IValue.GetString">
|
<summary>
|
Returns the underlying value as type string.
|
</summary>
|
<returns>
|
Returns the underlying value as type string.
|
</returns>
|
</member>
|
<member name="M:CefSharp.IValue.GetDictionary">
|
<summary>
|
Returns the underlying value as type dictionary.
|
</summary>
|
<returns>
|
Returns the underlying value as type dictionary.
|
</returns>
|
</member>
|
<member name="M:CefSharp.IValue.GetList">
|
<summary>
|
Returns the underlying value as type list.
|
</summary>
|
<returns>
|
Returns the underlying value as type list.
|
</returns>
|
</member>
|
<member name="M:CefSharp.IValue.GetObject">
|
<summary>
|
Returns the underlying value converted to a managed object.
|
</summary>
|
<returns>
|
Returns the underlying value converted to a managed object.
|
</returns>
|
</member>
|
<member name="T:CefSharp.IWebBrowser">
|
<summary>
|
ChromiumWebBrowser implementations implement this interface. Can be cast to
|
the concrete implementation to access UI specific features.
|
</summary>
|
</member>
|
<member name="E:CefSharp.IWebBrowser.JavascriptMessageReceived">
|
<summary>
|
Event handler that will get called when the message that originates from CefSharp.PostMessage
|
</summary>
|
</member>
|
<member name="M:CefSharp.IWebBrowser.Load(System.String)">
|
<summary>
|
Loads the specified <paramref name="url"/> in the Main Frame.
|
If <see cref="P:CefSharp.IChromiumWebBrowserBase.IsDisposed"/> is true then the method call will be ignored.
|
Same as calling <see cref="M:CefSharp.IChromiumWebBrowserBase.LoadUrl(System.String)"/>
|
</summary>
|
<param name="url">The URL to be loaded.</param>
|
</member>
|
<member name="M:CefSharp.IWebBrowser.WaitForInitialLoadAsync">
|
<summary>
|
Wait for the Browser to finish loading the initial web page.
|
</summary>
|
<returns>
|
A <see cref="T:System.Threading.Tasks.Task`1"/> that can be awaited which returns the HttpStatusCode and <see cref="T:CefSharp.CefErrorCode"/>.
|
A HttpStatusCode equal to 200 and <see cref="F:CefSharp.CefErrorCode.None"/> is considered a success.
|
</returns>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.JavascriptObjectRepository">
|
<summary>
|
The javascript object repository, one repository per ChromiumWebBrowser instance.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.DialogHandler">
|
<summary>
|
Implement <see cref="T:CefSharp.IDialogHandler" /> and assign to handle dialog events.
|
</summary>
|
<value>The dialog handler.</value>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.RequestHandler">
|
<summary>
|
Implement <see cref="T:CefSharp.IRequestHandler" /> and assign to handle events related to browser requests.
|
</summary>
|
<value>The request handler.</value>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.DisplayHandler">
|
<summary>
|
Implement <see cref="T:CefSharp.IDisplayHandler" /> and assign to handle events related to browser display state.
|
</summary>
|
<value>The display handler.</value>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.LoadHandler">
|
<summary>
|
Implement <see cref="T:CefSharp.ILoadHandler" /> and assign to handle events related to browser load status.
|
</summary>
|
<value>The load handler.</value>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.LifeSpanHandler">
|
<summary>
|
Implement <see cref="T:CefSharp.ILifeSpanHandler" /> and assign to handle events related to popups.
|
</summary>
|
<value>The life span handler.</value>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.KeyboardHandler">
|
<summary>
|
Implement <see cref="T:CefSharp.IKeyboardHandler" /> and assign to handle events related to key press.
|
</summary>
|
<value>The keyboard handler.</value>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.JsDialogHandler">
|
<summary>
|
Implement <see cref="T:CefSharp.IJsDialogHandler" /> and assign to handle events related to JavaScript Dialogs.
|
</summary>
|
<value>The js dialog handler.</value>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.DragHandler">
|
<summary>
|
Implement <see cref="T:CefSharp.IDragHandler" /> and assign to handle events related to dragging.
|
</summary>
|
<value>The drag handler.</value>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.DownloadHandler">
|
<summary>
|
Implement <see cref="T:CefSharp.IDownloadHandler" /> and assign to handle events related to downloading files.
|
</summary>
|
<value>The download handler.</value>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.MenuHandler">
|
<summary>
|
Implement <see cref="T:CefSharp.IContextMenuHandler" /> and assign to handle events related to the browser context menu
|
</summary>
|
<value>The menu handler.</value>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.FocusHandler">
|
<summary>
|
Implement <see cref="T:CefSharp.IFocusHandler" /> and assign to handle events related to the browser component's focus
|
</summary>
|
<value>The focus handler.</value>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.ResourceRequestHandlerFactory">
|
<summary>
|
Implement <see cref="T:CefSharp.IResourceRequestHandlerFactory" /> and control the loading of resources
|
</summary>
|
<value>The resource handler factory.</value>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.RenderProcessMessageHandler">
|
<summary>
|
Implement <see cref="T:CefSharp.IRenderProcessMessageHandler" /> and assign to handle messages from the render process.
|
</summary>
|
<value>The render process message handler.</value>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.FindHandler">
|
<summary>
|
Implement <see cref="T:CefSharp.IFindHandler" /> to handle events related to find results.
|
</summary>
|
<value>The find handler.</value>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.AudioHandler">
|
<summary>
|
Implement <see cref="T:CefSharp.IAudioHandler" /> to handle audio events.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.FrameHandler">
|
<summary>
|
Implement <see cref="T:CefSharp.IFrameHandler" /> to handle frame events.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.PermissionHandler">
|
<summary>
|
Implement <see cref="T:CefSharp.IPermissionHandler" /> to handle events related to permission requests.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.TooltipText">
|
<summary>
|
The text that will be displayed as a ToolTip
|
</summary>
|
<value>The tooltip text.</value>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.CanExecuteJavascriptInMainFrame">
|
<summary>
|
A flag that indicates if you can execute javascript in the main frame.
|
Flag is set to true in IRenderProcessMessageHandler.OnContextCreated.
|
and false in IRenderProcessMessageHandler.OnContextReleased
|
</summary>
|
</member>
|
<member name="P:CefSharp.IWebBrowser.RequestContext">
|
<summary>
|
Gets the custom request context assigned to this browser instance
|
If no instance was assigned this will be null and the global
|
request context will have been used for this browser.
|
You can access the global request context through Cef.GetGlobalRequestContext()
|
</summary>
|
</member>
|
<member name="M:CefSharp.IWebBrowser.GetBrowser">
|
<summary>
|
Returns the current CEF Browser Instance
|
</summary>
|
<returns>browser instance or null</returns>
|
</member>
|
<member name="M:CefSharp.IWebBrowser.TryGetBrowserCoreById(System.Int32,CefSharp.IBrowser@)">
|
<summary>
|
Try and get a reference to the <see cref="T:CefSharp.IBrowser"/> instance that matches the <paramref name="browserId"/>.
|
Primarily used for geting a reference to the <see cref="T:CefSharp.IBrowser"/> used by popups.
|
</summary>
|
<param name="browserId">browser Id</param>
|
<param name="browser">When this method returns, contains the <see cref="T:CefSharp.IBrowser"/> object reference that matches the specified <paramref name="browserId"/>, or null if no matching instance found.</param>
|
<returns>true if a <see cref="T:CefSharp.IBrowser"/> instance was found matching <paramref name="browserId"/>; otherwise, false.</returns>
|
</member>
|
<member name="M:CefSharp.IWebBrowser.GetContentSizeAsync">
|
<summary>
|
Size of scrollable area in CSS pixels
|
</summary>
|
<returns>A task that can be awaited to get the size of the scrollable area in CSS pixels.</returns>
|
</member>
|
<member name="T:CefSharp.IWindowInfo">
|
<summary>
|
Class representing window information.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IWindowInfo.X">
|
<summary>
|
X coordinate
|
</summary>
|
</member>
|
<member name="P:CefSharp.IWindowInfo.Y">
|
<summary>
|
Y coordinate
|
</summary>
|
</member>
|
<member name="P:CefSharp.IWindowInfo.Width">
|
<summary>
|
Width
|
</summary>
|
</member>
|
<member name="P:CefSharp.IWindowInfo.Height">
|
<summary>
|
Height
|
</summary>
|
</member>
|
<member name="P:CefSharp.IWindowInfo.Style">
|
<summary>
|
Window style
|
</summary>
|
</member>
|
<member name="P:CefSharp.IWindowInfo.ExStyle">
|
<summary>
|
Ex window style
|
</summary>
|
</member>
|
<member name="P:CefSharp.IWindowInfo.ParentWindowHandle">
|
<summary>
|
Parent window handle
|
</summary>
|
</member>
|
<member name="P:CefSharp.IWindowInfo.WindowlessRenderingEnabled">
|
<summary>
|
Set to true to create the browser using windowless (off-screen) rendering.
|
No window will be created for the browser and all rendering will occur via the
|
IRenderHandler interface. The <see cref="P:CefSharp.IWindowInfo.ParentWindowHandle"/> value will be used to identify monitor info
|
and to act as the parent window for dialogs, context menus, etc. If |<see cref="P:CefSharp.IWindowInfo.ParentWindowHandle"/> is not provided then the main screen monitor will be used and some functionality that requires a parent window may not function correctly.
|
In order to create windowless browsers the CefSettings.WindowlessRenderingEnabled value must be set to true.
|
Transparent painting is enabled by default but can be disabled by setting <see cref="P:CefSharp.IBrowserSettings.BackgroundColor"/> to an opaque value.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IWindowInfo.SharedTextureEnabled">
|
<summary>
|
Set to true to enable shared textures for windowless rendering. Only
|
valid if <see cref="P:CefSharp.IWindowInfo.WindowlessRenderingEnabled"/> is also set to true. Currently
|
only supported on Windows (D3D11). This feature is experimental and has many bugs
|
at the moment.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IWindowInfo.ExternalBeginFrameEnabled">
|
<summary>
|
Set to true to enable the ability to issue BeginFrame requests from the
|
client application by calling <see cref="M:CefSharp.IBrowserHost.SendExternalBeginFrame"/>.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IWindowInfo.WindowHandle">
|
<summary>
|
Handle for the new browser window. Only used with windowed rendering.
|
</summary>
|
</member>
|
<member name="P:CefSharp.IWindowInfo.WindowName">
|
<summary>
|
Window Name
|
</summary>
|
</member>
|
<member name="M:CefSharp.IWindowInfo.SetAsChild(System.IntPtr)">
|
<summary>
|
Create the browser as a child window.
|
Calls GetClientRect(Hwnd) to obtain the window bounds
|
</summary>
|
<param name="parentHandle">parent handle</param>
|
</member>
|
<member name="M:CefSharp.IWindowInfo.SetAsChild(System.IntPtr,CefSharp.Structs.Rect)">
|
<summary>
|
Create the browser as a child window.
|
</summary>
|
<param name="parentHandle">parent handle</param>
|
<param name="windowBounds">window bounds</param>
|
</member>
|
<member name="M:CefSharp.IWindowInfo.SetAsChild(System.IntPtr,System.Int32,System.Int32,System.Int32,System.Int32)">
|
<summary>
|
Create the browser as a child window.
|
</summary>
|
<param name="parentHandle">parent handle</param>
|
<param name="left">left</param>
|
<param name="top">top</param>
|
<param name="right">right</param>
|
<param name="bottom">bottom</param>
|
</member>
|
<member name="M:CefSharp.IWindowInfo.SetAsPopup(System.IntPtr,System.String)">
|
<summary>
|
Create the browser as a popup window.
|
</summary>
|
<param name="parentHandle">parent handle</param>
|
<param name="windowName">window name</param>
|
</member>
|
<member name="M:CefSharp.IWindowInfo.SetAsWindowless(System.IntPtr)">
|
<summary>
|
Create the browser using windowless (off-screen) rendering.
|
No window will be created for the browser and all rendering will occur via the CefRenderHandler interface. This window will automatically be transparent unless a colored backgrond is set in the browser settings.
|
</summary>
|
<param name="parentHandle">Value will be used to identify monitor info and to act as the parent window for dialogs, context menus, etc.
|
If not provided then the main screen monitor will be used and some functionality that requires a parent window may not function correctly.
|
In order to create windowless browsers the CefSettings.windowless_rendering_enabled value must be set to true.</param>
|
</member>
|
<member name="M:CefSharp.IWindowInfo.UnWrap">
|
<summary>
|
Used internally to get the underlying <see cref="T:CefSharp.IWindowInfo"/> instance.
|
Unlikely you'll use this yourself.
|
</summary>
|
<returns>the inner most instance</returns>
|
</member>
|
<member name="T:CefSharp.JavascriptBinding.CamelCaseJavascriptNameConverter">
|
<summary>
|
CamelCaseJavascriptNameConverter converts .Net property/method names
|
to camcel case.
|
</summary>
|
</member>
|
<member name="M:CefSharp.JavascriptBinding.CamelCaseJavascriptNameConverter.ConvertToJavascript(System.Reflection.MemberInfo)">
|
<summary>
|
Get the javascript name for the property/field/method.
|
Typically this would be based on <see cref="P:System.Reflection.MemberInfo.Name"/>
|
</summary>
|
<param name="memberInfo">property/field/method</param>
|
<returns>javascript name</returns>
|
</member>
|
<member name="M:CefSharp.JavascriptBinding.CamelCaseJavascriptNameConverter.ConvertReturnedObjectPropertyAndFieldToNameJavascript(System.Reflection.MemberInfo)">
|
<summary>
|
This method exists for backwards compatability reasons, historically
|
only the bound methods/fields/properties were converted. Objects returned
|
from a method call were not translated. To preserve this functionality
|
for upgrading users we split this into two methods. Typically thie method
|
would return the same result as <see cref="M:CefSharp.JavascriptBinding.CamelCaseJavascriptNameConverter.ConvertToJavascript(System.Reflection.MemberInfo)"/>
|
Issue #2442
|
</summary>
|
<param name="memberInfo">property/field/method</param>
|
<returns>javascript name</returns>
|
</member>
|
<member name="M:CefSharp.JavascriptBinding.CamelCaseJavascriptNameConverter.ConvertMemberInfoNameToCamelCase(System.Reflection.MemberInfo)">
|
<summary>
|
Converts the <see cref="P:System.Reflection.MemberInfo.Name"/> to CamelCase
|
</summary>
|
<param name="memberInfo">memberInfo</param>
|
<returns>camelcased name</returns>
|
</member>
|
<member name="T:CefSharp.JavascriptBinding.IJavascriptNameConverter">
|
<summary>
|
Implement this interface to have control of how the names
|
are converted when binding/executing javascript.
|
</summary>
|
</member>
|
<member name="M:CefSharp.JavascriptBinding.IJavascriptNameConverter.ConvertToJavascript(System.Reflection.MemberInfo)">
|
<summary>
|
Get the javascript name for the property/field/method.
|
Typically this would be based on <see cref="P:System.Reflection.MemberInfo.Name"/>
|
</summary>
|
<param name="memberInfo">property/field/method</param>
|
<returns>javascript name</returns>
|
</member>
|
<member name="M:CefSharp.JavascriptBinding.IJavascriptNameConverter.ConvertReturnedObjectPropertyAndFieldToNameJavascript(System.Reflection.MemberInfo)">
|
<summary>
|
This method exists for backwards compatability reasons, historically
|
only the bound methods/fields/properties were converted. Objects returned
|
from a method call were not translated. To preserve this functionality
|
for upgrading users we split this into two methods. Typically thie method
|
would return the same result as <see cref="M:CefSharp.JavascriptBinding.IJavascriptNameConverter.ConvertToJavascript(System.Reflection.MemberInfo)"/>
|
Issue #2442
|
</summary>
|
<param name="memberInfo">property/field/method</param>
|
<returns>javascript name</returns>
|
</member>
|
<member name="T:CefSharp.JavascriptBinding.JavascriptBindingSettings">
|
<summary>
|
Javascript Binding Settings
|
</summary>
|
</member>
|
<member name="P:CefSharp.JavascriptBinding.JavascriptBindingSettings.JavascriptBindingApiEnabled">
|
<summary>
|
The Javascript methods that CefSharp provides in relation to JavaScript Binding are
|
created using a Global (window) Object. Settings this property allows you to disable
|
the creation of this object. Features like EvaluateScriptAsPromiseAsync that rely on
|
the creation of this object will no longer function.
|
</summary>
|
</member>
|
<member name="P:CefSharp.JavascriptBinding.JavascriptBindingSettings.JavascriptBindingApiGlobalObjectName">
|
<summary>
|
The Javascript methods that CefSharp provides in relation to JavaScript Binding are
|
created using a Global (window) Object. Settings this property allows you to customise
|
the name of this object. If not specified then both cefSharp and CefSharp objects will
|
be created e.g. cefSharp.bindObjectAsync, CefSharp.BindObjectAsync.
|
If specified then your custom name will be used, if the name starts with a lowercase letter
|
then all the functions will be lowercase, e.g. myObjName.bindObjectAsync otherwise
|
the functions will start with a uppercase letter e.g. MyObjName.BindObjectAsync
|
</summary>
|
<remarks>
|
This object is also accessible through the window property. e.g. window.cefSharp.bindObjectAsync
|
</remarks>
|
</member>
|
<member name="P:CefSharp.JavascriptBinding.JavascriptBindingSettings.LegacyBindingEnabled">
|
<summary>
|
Objects registered using <see cref="M:CefSharp.IJavascriptObjectRepository.Register(System.String,System.Object,System.Boolean,CefSharp.BindingOptions)"/>
|
will be automatically bound when a V8Context is created. (Soon as the Javascript
|
context is created for a browser). This behaviour is like that seen with Javascript
|
Binding in version 57 and earlier.
|
</summary>
|
</member>
|
<member name="P:CefSharp.JavascriptBinding.JavascriptBindingSettings.AlwaysInterceptAsynchronously">
|
<summary>
|
When using an <see cref="T:CefSharp.ModelBinding.IAsyncMethodInterceptor"/>
|
the <see cref="M:CefSharp.ModelBinding.IAsyncMethodInterceptor.InterceptAsync(System.Func{System.Object[],System.Object},System.Object[],System.String)"/>
|
method is call for all methods (the default is to call InterceptAsync only for methods that return a Task).
|
This only applies when <see cref="P:CefSharp.BindingOptions.MethodInterceptor"/> is of type <see cref="T:CefSharp.ModelBinding.IAsyncMethodInterceptor"/>
|
</summary>
|
</member>
|
<member name="T:CefSharp.JavascriptBinding.LegacyCamelCaseJavascriptNameConverter">
|
<summary>
|
Legacy Naming converter.
|
Used by default for backwards compatability
|
Issue #2442
|
</summary>
|
</member>
|
<member name="T:CefSharp.JavascriptBindingExtensions">
|
<summary>
|
Javascript binding extension methods
|
</summary>
|
</member>
|
<member name="M:CefSharp.JavascriptBindingExtensions.EnsureObjectBoundAsync(CefSharp.IWebBrowser,System.String[])">
|
<summary>
|
Make sure an object is bound in javascript. Executes against the main frame
|
</summary>
|
<param name="browser">browser</param>
|
<param name="names">object names</param>
|
<returns>List of objects that were bound</returns>
|
</member>
|
<member name="T:CefSharp.JavascriptException">
|
<summary>
|
Javascript exception
|
</summary>
|
</member>
|
<member name="P:CefSharp.JavascriptException.Message">
|
<summary>
|
Message
|
</summary>
|
</member>
|
<member name="P:CefSharp.JavascriptException.StackTrace">
|
<summary>
|
Stack trace in javascript frames
|
</summary>
|
</member>
|
<member name="T:CefSharp.JavascriptIgnoreAttribute">
|
<summary>
|
JavascriptIgnoreAttribute - Methods and Properties marked with this attribute
|
will be excluded from Javascript Binding
|
</summary>
|
</member>
|
<member name="T:CefSharp.JavascriptResponse">
|
<summary>
|
Javascript Response
|
</summary>
|
</member>
|
<member name="P:CefSharp.JavascriptResponse.Message">
|
<summary>
|
Error message
|
</summary>
|
</member>
|
<member name="P:CefSharp.JavascriptResponse.Success">
|
<summary>
|
Was the javascript executed successfully
|
</summary>
|
</member>
|
<member name="P:CefSharp.JavascriptResponse.Result">
|
<summary>
|
Javascript response
|
</summary>
|
</member>
|
<member name="T:CefSharp.JavascriptStackFrame">
|
<summary>
|
A Javascript(V8) stack frame
|
</summary>
|
TODO: Refactor to pass params in throw constructor and make properties readonly
|
</member>
|
<member name="P:CefSharp.JavascriptStackFrame.FunctionName">
|
<summary>
|
Gets or sets the name of the function.
|
</summary>
|
<value>
|
The name of the function.
|
</value>
|
</member>
|
<member name="P:CefSharp.JavascriptStackFrame.LineNumber">
|
<summary>
|
Gets or sets the line number.
|
</summary>
|
<value>
|
The line number.
|
</value>
|
</member>
|
<member name="P:CefSharp.JavascriptStackFrame.ColumnNumber">
|
<summary>
|
Gets or sets the column number.
|
</summary>
|
<value>
|
The column number.
|
</value>
|
</member>
|
<member name="P:CefSharp.JavascriptStackFrame.SourceName">
|
<summary>
|
Gets or sets the name of the source.
|
</summary>
|
<value>
|
The name of the source.
|
</value>
|
</member>
|
<member name="T:CefSharp.Lagacy.ResourceHandler">
|
<summary>
|
Legacy ResourceHandler, will be removed when CEF removes the old code path for
|
it's CefResourceHandler implementation. This is the older and well tested variant.
|
It doesn't however support range request headers (seek).
|
</summary>
|
</member>
|
<member name="P:CefSharp.Lagacy.ResourceHandler.Charset">
|
<summary>
|
Gets or sets the Charset
|
</summary>
|
</member>
|
<member name="P:CefSharp.Lagacy.ResourceHandler.MimeType">
|
<summary>
|
Gets or sets the Mime Type.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Lagacy.ResourceHandler.Stream">
|
<summary>
|
Gets or sets the resource stream.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Lagacy.ResourceHandler.StatusCode">
|
<summary>
|
Gets or sets the http status code.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Lagacy.ResourceHandler.StatusText">
|
<summary>
|
Gets or sets the status text.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Lagacy.ResourceHandler.ResponseLength">
|
<summary>
|
Gets or sets ResponseLength, when you know the size of your
|
Stream (Response) set this property. This is optional.
|
If you use a MemoryStream and don't provide a value
|
here then it will be cast and it's size used
|
</summary>
|
</member>
|
<member name="P:CefSharp.Lagacy.ResourceHandler.Headers">
|
<summary>
|
Gets or sets the headers.
|
</summary>
|
<value>The headers.</value>
|
</member>
|
<member name="P:CefSharp.Lagacy.ResourceHandler.AutoDisposeStream">
|
<summary>
|
When true the Stream will be Disposed when
|
this instance is Disposed. The default value for
|
this property is false.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Lagacy.ResourceHandler.ErrorCode">
|
<summary>
|
If the ErrorCode is set then the response will be ignored and
|
the errorCode returned.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Lagacy.ResourceHandler.#ctor(System.String,System.IO.Stream,System.Boolean,System.String)">
|
<summary>
|
Initializes a new instance of the <see cref="T:CefSharp.Lagacy.ResourceHandler"/> class.
|
</summary>
|
<param name="mimeType">Optional mimeType defaults to <see cref="F:CefSharp.ResourceHandler.DefaultMimeType"/></param>
|
<param name="stream">Optional Stream - must be set at some point to provide a valid response</param>
|
<param name="autoDisposeStream">When true the Stream will be disposed when this instance is Diposed, you will
|
be unable to use this ResourceHandler after the Stream has been disposed</param>
|
<param name="charset">response charset</param>
|
</member>
|
<member name="M:CefSharp.Lagacy.ResourceHandler.ProcessRequestAsync(CefSharp.IRequest,CefSharp.ICallback)">
|
<summary>
|
Begin processing the request. If you have the data in memory you can execute the callback
|
immediately and return true. For Async processing you would typically spawn a Task to perform processing,
|
then return true. When the processing is complete execute callback.Continue(); In your processing Task, simply set
|
the StatusCode, StatusText, MimeType, ResponseLength and Stream
|
</summary>
|
<param name="request">The request object.</param>
|
<param name="callback">The callback used to Continue or Cancel the request (async).</param>
|
<returns>To handle the request return true and call
|
<see cref="M:CefSharp.ICallback.Continue"/> once the response header information is available
|
<see cref="M:CefSharp.ICallback.Continue"/> can also be called from inside this method if
|
header information is available immediately).
|
To cancel the request return false.</returns>
|
</member>
|
<member name="M:CefSharp.Lagacy.ResourceHandler.Cancel">
|
<summary>
|
Called if the request is cancelled
|
</summary>
|
</member>
|
<member name="M:CefSharp.Lagacy.ResourceHandler.Dispose">
|
<summary>
|
Dispose of resources here
|
</summary>
|
</member>
|
<member name="M:CefSharp.Lagacy.ResourceHandler.GetResponse(CefSharp.IResponse,System.Int64@,System.String@)">
|
<summary>
|
Populate the response stream, response length. When this method is called
|
the response should be fully populated with data.
|
It is possible to redirect to another url at this point in time.
|
NOTE: It's no longer manditory to implement this method, you can simply populate the
|
properties of this instance and they will be set by the default implementation.
|
</summary>
|
<param name="response">The response object used to set Headers, StatusCode, etc</param>
|
<param name="responseLength">length of the response</param>
|
<param name="redirectUrl">If set the request will be redirect to specified Url</param>
|
<returns>The response stream</returns>
|
</member>
|
<member name="T:CefSharp.LoadUrlAsyncResponse">
|
<summary>
|
Response returned from <see cref="M:CefSharp.IChromiumWebBrowserBase.LoadUrlAsync(System.String)"/>
|
</summary>
|
</member>
|
<member name="P:CefSharp.LoadUrlAsyncResponse.ErrorCode">
|
<summary>
|
Error Code. If the network request was made successfully this value will be <see cref="F:CefSharp.CefErrorCode.None"/>
|
(no error occured)
|
</summary>
|
</member>
|
<member name="P:CefSharp.LoadUrlAsyncResponse.HttpStatusCode">
|
<summary>
|
Http Status Code. If <see cref="P:CefSharp.LoadUrlAsyncResponse.ErrorCode"/> is not equal to <see cref="F:CefSharp.CefErrorCode.None"/>
|
then this value will be -1.
|
</summary>
|
</member>
|
<member name="P:CefSharp.LoadUrlAsyncResponse.Success">
|
<summary>
|
If <see cref="P:CefSharp.LoadUrlAsyncResponse.ErrorCode"/> is equal to <see cref="F:CefSharp.CefErrorCode.None"/> and
|
<see cref="P:CefSharp.LoadUrlAsyncResponse.HttpStatusCode"/> is equal to 200 (OK) then the main frame loaded without
|
critical error.
|
</summary>
|
</member>
|
<member name="M:CefSharp.LoadUrlAsyncResponse.#ctor(CefSharp.CefErrorCode,System.Int32)">
|
<summary>
|
Initializes a new instance of the LoadUrlAsyncResponse class.
|
</summary>
|
<param name="errorCode">CEF Error Code</param>
|
<param name="httpStatusCode">Http Status Code</param>
|
</member>
|
<member name="T:CefSharp.ModelBinding.BindingMemberInfo">
|
<summary>
|
Represents a bindable member of a type, which can be a property or a field.
|
</summary>
|
</member>
|
<member name="P:CefSharp.ModelBinding.BindingMemberInfo.Name">
|
<summary>
|
Gets the name of the property or field represented by this BindingMemberInfo.
|
</summary>
|
</member>
|
<member name="P:CefSharp.ModelBinding.BindingMemberInfo.Type">
|
<summary>
|
Gets the data type of the property or field represented by this BindingMemberInfo.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ModelBinding.BindingMemberInfo.#ctor(System.Reflection.PropertyInfo)">
|
<summary>
|
Constructs a BindingMemberInfo instance for a property.
|
</summary>
|
<param name="propertyInfo">The bindable property to represent.</param>
|
</member>
|
<member name="M:CefSharp.ModelBinding.BindingMemberInfo.#ctor(System.Reflection.FieldInfo)">
|
<summary>
|
Constructs a BindingMemberInfo instance for a field.
|
</summary>
|
<param name="fieldInfo">The bindable field to represent.</param>
|
</member>
|
<member name="M:CefSharp.ModelBinding.BindingMemberInfo.SetValue(System.Object,System.Object)">
|
<summary>
|
Sets the value from a specified object associated with the property or field represented by this BindingMemberInfo.
|
</summary>
|
<param name="destinationObject">The object whose property or field should be assigned.</param>
|
<param name="newValue">The value to assign in the specified object to this BindingMemberInfo's property or field.</param>
|
</member>
|
<member name="M:CefSharp.ModelBinding.BindingMemberInfo.Collect(System.Type)">
|
<summary>
|
Returns an enumerable sequence of bindable properties for the specified type.
|
</summary>
|
<param name="type">The type to enumerate.</param>
|
<returns>Bindable properties.</returns>
|
</member>
|
<member name="T:CefSharp.ModelBinding.DefaultBinder">
|
<summary>
|
Default binder - used as a fallback when a specific modelbinder
|
is not available.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ModelBinding.DefaultBinder.Instance">
|
<summary>
|
Static Instance of this binding that can be reused as it doesn't store any state information.
|
Uses the <see cref="T:CefSharp.JavascriptBinding.CamelCaseJavascriptNameConverter"/> naming converter
|
</summary>
|
</member>
|
<member name="M:CefSharp.ModelBinding.DefaultBinder.#ctor(CefSharp.JavascriptBinding.IJavascriptNameConverter)">
|
<summary>
|
Javascript Binder
|
</summary>
|
<param name="javascriptNameConverter">name converter</param>
|
</member>
|
<member name="M:CefSharp.ModelBinding.DefaultBinder.Bind(System.Object,System.Type)">
|
<summary>
|
Bind to the given model type
|
</summary>
|
<param name="obj">object to be converted into a model</param>
|
<param name="targetType">the target param type</param>
|
<returns>Bound model</returns>
|
</member>
|
<member name="M:CefSharp.ModelBinding.DefaultBinder.BindCollection(System.Type,System.Type,System.Object)">
|
<summary>
|
Bind collection.
|
</summary>
|
<param name="targetType">the target param type.</param>
|
<param name="objType">Type of the object.</param>
|
<param name="obj">object to be converted into a model.</param>
|
<returns>
|
An object.
|
</returns>
|
</member>
|
<member name="M:CefSharp.ModelBinding.DefaultBinder.BindObject(System.Type,System.Type,System.Object)">
|
<summary>
|
Bind object.
|
</summary>
|
<param name="targetType">the target param type.</param>
|
<param name="objType">Type of the object.</param>
|
<param name="obj">object to be converted into a model.</param>
|
<returns>
|
An object.
|
</returns>
|
</member>
|
<member name="T:CefSharp.ModelBinding.IAsyncMethodInterceptor">
|
<summary>
|
Provides the capability intercept async/sync Net method calls made from javascript as part of the
|
JavascriptBinding (JSB) implementation. One example use case is logging method calls.
|
Extends <see cref="T:CefSharp.ModelBinding.IMethodInterceptor"/> to add async support.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ModelBinding.IAsyncMethodInterceptor.InterceptAsync(System.Func{System.Object[],System.Object},System.Object[],System.String)">
|
<summary>
|
Called before an async method is invoked. You are now responsible for evaluating
|
the function and returning the result. Only methods that return a <see cref="T:System.Threading.Tasks.Task"/>
|
will call this method, other non asynchronous types will call
|
<see cref="M:CefSharp.ModelBinding.IMethodInterceptor.Intercept(System.Func{System.Object[],System.Object},System.Object[],System.String)"/>.
|
(async void method will also call Intercept as they do not return a Task).
|
</summary>
|
<param name="method">A Func that represents the method to be called</param>
|
<param name="parameters">paramaters to be passed to <paramref name="method"/></param>
|
<param name="methodName">Name of the method to be called</param>
|
<returns>A Task representing the method result</returns>
|
<example>
|
Task<object> IAsyncMethodInterceptor.InterceptAsync(Func<object[], object> method, object[] parameters, string methodName)
|
{
|
object result = method(parameters);
|
Debug.WriteLine("Called " + methodName);
|
return result;
|
}
|
</example>
|
</member>
|
<member name="T:CefSharp.ModelBinding.IBinder">
|
<summary>
|
Converts input params into complex .Net types (can also be used for type conversion).
|
This feature is similar in concept to ASP.NET MVC Model Binding.
|
Objects passed from javascript are represented as <see cref="T:System.Collections.Generic.IDictionary`2"/>
|
and arrays/lists as <see cref="T:System.Collections.Generic.IList`1"/>
|
See <see cref="T:CefSharp.ModelBinding.DefaultBinder"/> for the default implementation.
|
</summary>
|
<remarks>
|
A model binder can be specified in <see cref="P:CefSharp.BindingOptions.Binder"/> and passed into
|
<see cref="M:CefSharp.IJavascriptObjectRepository.Register(System.String,System.Object,System.Boolean,CefSharp.BindingOptions)"/>
|
</remarks>
|
</member>
|
<member name="M:CefSharp.ModelBinding.IBinder.Bind(System.Object,System.Type)">
|
<summary>
|
Bind to the given model type, can also be used for type conversion e.g. int to uint
|
</summary>
|
<param name="obj">object to be converted into a model</param>
|
<param name="targetParamType">the target param type</param>
|
<returns>if the modelType is directly assignable then do so, otherwise perform a conversion
|
or create a complex object that matches <paramref name="targetParamType"/></returns>
|
</member>
|
<member name="T:CefSharp.ModelBinding.IMethodInterceptor">
|
<summary>
|
Provides the capability intercept Net method calls made from javascript as part of the
|
JavascriptBinding (JSB) implementation. One example use case is logging method calls.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ModelBinding.IMethodInterceptor.Intercept(System.Func{System.Object[],System.Object},System.Object[],System.String)">
|
<summary>
|
Called before the method is invokved. You are now responsible for evaluating
|
the function and returning the result.
|
</summary>
|
<param name="method">A Func that represents the method to be called</param>
|
<param name="parameters">paramaters to be passed to <paramref name="method"/></param>
|
<param name="methodName">Name of the method to be called</param>
|
<returns>The method result</returns>
|
<example>
|
|
object IMethodInterceptor.Intercept(Func<object[], object> method, object[] parameters, string methodName)
|
{
|
object result = method(parameters);
|
Debug.WriteLine("Called " + methodName);
|
return result;
|
}
|
</example>
|
|
</member>
|
<member name="T:CefSharp.ModelBinding.IPropertyInterceptor">
|
<summary>
|
Provides the capability intercepting get/set property calls made from javascript as part of the
|
JavascriptBinding (JSB) implementation.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ModelBinding.IPropertyInterceptor.InterceptGet(System.Func{System.Object},System.String)">
|
<summary>
|
Called before the get property is invokved. You are now responsible for evaluating
|
the property and returning the result.
|
</summary>
|
<param name="propertyGetter">A Func that represents the property to be called</param>
|
<param name="propertName">Name of the property to be called</param>
|
<returns>The property result</returns>
|
<example>
|
<code>
|
<![CDATA[
|
public object IPropertyInterceptor.InterceptGet(Func<object> propertyGetter, string propertyName)
|
{
|
object result = propertyGetter();
|
Debug.WriteLine("InterceptGet " + propertyName);
|
return result;
|
}
|
]]>
|
</code>
|
</example>
|
</member>
|
<member name="M:CefSharp.ModelBinding.IPropertyInterceptor.InterceptSet(System.Action{System.Object},System.Object,System.String)">
|
<summary>
|
Called before the set property is invokved. You are now responsible for evaluating
|
the property.
|
</summary>
|
<param name="propertySetter">A Func that represents the property to be called</param>
|
<param name="parameter">paramater to be set to property</param>
|
<param name="propertName">Name of the property to be called</param>
|
<example>
|
<code>
|
<![CDATA[
|
public object IPropertyInterceptor.InterceptSet(Action<object> propertySetter, object parameter, string propertName)
|
{
|
Debug.WriteLine("InterceptSet " + propertName);
|
propertySetter(parameter);
|
}
|
]]>
|
</code>
|
</example>
|
</member>
|
<member name="T:CefSharp.ModelBinding.ModelBindingExtensions">
|
<summary>
|
Containing extensions for the <see cref="T:System.Type"/> object.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ModelBinding.ModelBindingExtensions.IsArray(System.Type)">
|
<summary>
|
Checks if a type is an array or not
|
</summary>
|
<param name="source">The type to check.</param>
|
<returns><see langword="true" /> if the type is an array, otherwise <see langword="false" />.</returns>
|
</member>
|
<member name="M:CefSharp.ModelBinding.ModelBindingExtensions.IsCollection(System.Type)">
|
<summary>
|
Checks if a type is an collection or not
|
</summary>
|
<param name="source">The type to check.</param>
|
<returns><see langword="true" /> if the type is a collection, otherwise <see langword="false" />.</returns>
|
</member>
|
<member name="M:CefSharp.ModelBinding.ModelBindingExtensions.IsEnumerable(System.Type)">
|
<summary>
|
Checks if a type is enumerable or not
|
</summary>
|
<param name="source">The type to check.</param>
|
<returns><see langword="true" /> if the type is an enumerable, otherwise <see langword="false" />.</returns>
|
</member>
|
<member name="T:CefSharp.NavigationEntry">
|
<summary>
|
Represents an entry in navigation history.
|
</summary>
|
</member>
|
<member name="P:CefSharp.NavigationEntry.CompletionTime">
|
<summary>
|
Returns the time for the last known successful navigation completion.
|
</summary>
|
</member>
|
<member name="P:CefSharp.NavigationEntry.DisplayUrl">
|
<summary>
|
Returns a display-friendly version of the URL.
|
</summary>
|
</member>
|
<member name="P:CefSharp.NavigationEntry.HttpStatusCode">
|
<summary>
|
Returns the HTTP status code for the last known successful navigation response.
|
</summary>
|
</member>
|
<member name="P:CefSharp.NavigationEntry.OriginalUrl">
|
<summary>
|
Returns the original URL that was entered by the user before any redirects.
|
</summary>
|
</member>
|
<member name="P:CefSharp.NavigationEntry.Title">
|
<summary>
|
Returns the title set by the page.
|
</summary>
|
</member>
|
<member name="P:CefSharp.NavigationEntry.TransitionType">
|
<summary>
|
Returns the transition type which indicates what the user did to move to this page from the previous page.
|
</summary>
|
</member>
|
<member name="P:CefSharp.NavigationEntry.Url">
|
<summary>
|
Returns the actual URL of the page.
|
</summary>
|
</member>
|
<member name="P:CefSharp.NavigationEntry.HasPostData">
|
<summary>
|
Returns true if this navigation includes post data.
|
</summary>
|
</member>
|
<member name="P:CefSharp.NavigationEntry.IsValid">
|
<summary>
|
Returns true if this object is valid.
|
</summary>
|
</member>
|
<member name="P:CefSharp.NavigationEntry.IsCurrent">
|
<summary>
|
If true if this entry is the currently loaded navigation entry
|
</summary>
|
</member>
|
<member name="P:CefSharp.NavigationEntry.SslStatus">
|
<summary>
|
Returns the SSL information for this navigation entry.
|
</summary>
|
</member>
|
<member name="M:CefSharp.NavigationEntry.#ctor(System.Boolean,System.DateTime,System.String,System.Int32,System.String,System.String,CefSharp.TransitionType,System.String,System.Boolean,System.Boolean,CefSharp.SslStatus)">
|
<summary>
|
NavigationEntry
|
</summary>
|
<param name="completionTime">completionTime</param>
|
<param name="displayUrl">displayUrl</param>
|
<param name="httpStatusCode">httpStatusCode</param>
|
<param name="originalUrl">originalUrl</param>
|
<param name="title">title</param>
|
<param name="transitionType">transitionType</param>
|
<param name="url">url</param>
|
<param name="hasPostData">hasPostData</param>
|
<param name="isValid">isValid</param>
|
<param name="isCurrent">is the current entry</param>
|
<param name="sslStatus">the ssl status</param>
|
</member>
|
<member name="T:CefSharp.PdfPrintSettings">
|
<summary>
|
Print to Pdf Settings
|
</summary>
|
</member>
|
<member name="P:CefSharp.PdfPrintSettings.Landscape">
|
<summary>
|
Set to true for landscape mode or false for portrait mode.
|
</summary>
|
</member>
|
<member name="P:CefSharp.PdfPrintSettings.PrintBackground">
|
<summary>
|
Set to true to print background graphics or false to not print
|
background graphics.
|
</summary>
|
</member>
|
<member name="P:CefSharp.PdfPrintSettings.Scale">
|
<summary>
|
The percentage to scale the PDF by before printing (e.g. .5 is 50%).
|
If this value is less than or equal to zero the default value of 1.0
|
will be used.
|
</summary>
|
</member>
|
<member name="P:CefSharp.PdfPrintSettings.PaperWidth">
|
<summary>
|
Output paper size in inches. If either of these values is less than or
|
equal to zero then the default paper size (letter, 8.5 x 11 inches) will
|
be used.
|
</summary>
|
</member>
|
<member name="P:CefSharp.PdfPrintSettings.PaperHeight">
|
<summary>
|
Output paper size in inches. If either of these values is less than or
|
equal to zero then the default paper size (letter, 8.5 x 11 inches) will
|
be used.
|
</summary>
|
</member>
|
<member name="P:CefSharp.PdfPrintSettings.PreferCssPageSize">
|
<summary>
|
Set to true to prefer page size as defined by css. Defaults to false
|
in which case the content will be scaled to fit the paper size.
|
</summary>
|
</member>
|
<member name="P:CefSharp.PdfPrintSettings.MarginType">
|
<summary>
|
Margin type.
|
</summary>
|
</member>
|
<member name="P:CefSharp.PdfPrintSettings.MarginLeft">
|
<summary>
|
Margins in inches. Only used if <see cref="P:CefSharp.PdfPrintSettings.MarginType"/> is set to
|
<see cref="F:CefSharp.CefPdfPrintMarginType.Custom"/>.
|
</summary>
|
</member>
|
<member name="P:CefSharp.PdfPrintSettings.MarginTop">
|
<summary>
|
Margins in inches. Only used if <see cref="P:CefSharp.PdfPrintSettings.MarginType"/> is set to
|
<see cref="F:CefSharp.CefPdfPrintMarginType.Custom"/>.
|
</summary>
|
</member>
|
<member name="P:CefSharp.PdfPrintSettings.MarginRight">
|
<summary>
|
Margins in inches. Only used if <see cref="P:CefSharp.PdfPrintSettings.MarginType"/> is set to
|
<see cref="F:CefSharp.CefPdfPrintMarginType.Custom"/>.
|
</summary>
|
</member>
|
<member name="P:CefSharp.PdfPrintSettings.MarginBottom">
|
<summary>
|
Margins in inches. Only used if <see cref="P:CefSharp.PdfPrintSettings.MarginType"/> is set to
|
<see cref="F:CefSharp.CefPdfPrintMarginType.Custom"/>.
|
</summary>
|
</member>
|
<member name="P:CefSharp.PdfPrintSettings.PageRanges">
|
<summary>
|
Paper ranges to print, one based, e.g. '1-5, 8, 11-13'. Pages are printed
|
in the document order, not in the order specified, and no more than once.
|
Defaults to empty string, which implies the entire document is printed.
|
The page numbers are quietly capped to actual page count of the document,
|
and ranges beyond the end of the document are ignored. If this results in
|
no pages to print, an error is reported. It is an error to specify a range
|
with start greater than end.
|
</summary>
|
</member>
|
<member name="P:CefSharp.PdfPrintSettings.DisplayHeaderFooter">
|
<summary>
|
Set to true to display the header and/or footer. Modify
|
|header_template| and/or |footer_template| to customize the display.
|
</summary>
|
</member>
|
<member name="P:CefSharp.PdfPrintSettings.HeaderTemplate">
|
<summary>
|
HTML template for the print header. Only displayed if
|
<see cref="P:CefSharp.PdfPrintSettings.DisplayHeaderFooter"/> is true. Should be valid HTML markup with
|
the following classes used to inject printing values into them:
|
|
- date: formatted print date
|
- title: document title
|
- url: document location
|
- pageNumber: current page number
|
- totalPages: total pages in the document
|
|
For example, "<span class=title></span>" would generate a span containing
|
the title.
|
</summary>
|
</member>
|
<member name="P:CefSharp.PdfPrintSettings.FooterTemplate">
|
<summary>
|
HTML template for the print footer. Only displayed if
|
<see cref="P:CefSharp.PdfPrintSettings.DisplayHeaderFooter"/> is true. Should be valid HTML markup with
|
the following classes used to inject printing values into them:
|
|
- date: formatted print date
|
- title: document title
|
- url: document location
|
- pageNumber: current page number
|
- totalPages: total pages in the document
|
|
For example, "<span class=title></span>" would generate a span containing
|
the title.
|
</summary>
|
</member>
|
<member name="P:CefSharp.PdfPrintSettings.BackgroundsEnabled">
|
<summary>
|
Set to true to print background graphics or false to not print
|
background graphics.
|
</summary>
|
</member>
|
<member name="P:CefSharp.PdfPrintSettings.HeaderFooterEnabled">
|
<summary>
|
Set to true to print headers and footers or false to not print
|
headers and footers.
|
</summary>
|
</member>
|
<member name="T:CefSharp.PostDataExtensions">
|
<summary>
|
Post Data extension methods - Makes accessing post data easier
|
</summary>
|
</member>
|
<member name="M:CefSharp.PostDataExtensions.GetCharSet(CefSharp.IRequest)">
|
<summary>
|
A convenience extension method that extracts the Character set from
|
the content-type header. Can be used in conjuncation with <see cref="M:CefSharp.PostDataExtensions.GetBody(CefSharp.IPostDataElement,System.String)"/>
|
</summary>
|
<param name="request">the request</param>
|
<returns>character set e.g. UTF-8</returns>
|
</member>
|
<member name="M:CefSharp.PostDataExtensions.GetBody(CefSharp.IPostDataElement,System.String)">
|
<summary>
|
Converts the <see cref="P:CefSharp.IPostDataElement.Bytes"/> property into a string
|
using the specified charset (Encoding) or if unable to parse then uses
|
the <see cref="P:System.Text.Encoding.Default"/>
|
</summary>
|
<param name="postDataElement">post data</param>
|
<param name="charSet">character set</param>
|
<returns>encoded string</returns>
|
</member>
|
<member name="M:CefSharp.PostDataExtensions.AddFile(CefSharp.IPostData,System.String)">
|
<summary>
|
Add a new <see cref="T:CefSharp.IPostDataElement"/> that represents the specified file
|
</summary>
|
<param name="postData">post data instance</param>
|
<param name="fileName">file name</param>
|
</member>
|
<member name="M:CefSharp.PostDataExtensions.AddData(CefSharp.IPostData,System.String,System.Text.Encoding)">
|
<summary>
|
Add a new <see cref="T:CefSharp.IPostDataElement"/> that represents the key and value
|
The data is encoded using
|
</summary>
|
<param name="postData">Post Data</param>
|
<param name="data">Data to be encoded for the post data element</param>
|
<param name="encoding">Specified Encoding. If null then <see cref="P:System.Text.Encoding.Default"/> will be used</param>
|
</member>
|
<member name="M:CefSharp.PostDataExtensions.AddData(CefSharp.IPostData,System.Byte[])">
|
<summary>
|
Add a new <see cref="T:CefSharp.IPostDataElement"/> that represents the key and value
|
</summary>
|
<param name="postData">Post Data</param>
|
<param name="bytes">byte array that represents the post data</param>
|
</member>
|
<member name="T:CefSharp.Preferences.SetPreferenceResponse">
|
<summary>
|
Response when <see cref="M:CefSharp.IRequestContext.SetPreference(System.String,System.Object,System.String@)"/>
|
is called in an async fashion
|
</summary>
|
</member>
|
<member name="P:CefSharp.Preferences.SetPreferenceResponse.Success">
|
<summary>
|
Success
|
</summary>
|
</member>
|
<member name="P:CefSharp.Preferences.SetPreferenceResponse.ErrorMessage">
|
<summary>
|
Error Message
|
</summary>
|
</member>
|
<member name="M:CefSharp.Preferences.SetPreferenceResponse.#ctor(System.Boolean,System.String)">
|
<summary>
|
Initializes a new instance of the SetPreferenceResponse class.
|
</summary>
|
<param name="success">success</param>
|
<param name="errorMessage">error message</param>
|
</member>
|
<member name="T:CefSharp.Preferences.SetProxyResponse">
|
<summary>
|
Response when either <see cref="M:CefSharp.RequestContextExtensions.SetProxyAsync(CefSharp.IRequestContext,System.String,System.Nullable{System.Int32})"/>
|
or <see cref="M:CefSharp.RequestContextExtensions.SetProxyAsync(CefSharp.IRequestContext,System.String,System.String,System.Nullable{System.Int32})"/> are called.
|
</summary>
|
</member>
|
<member name="M:CefSharp.Preferences.SetProxyResponse.#ctor(System.Boolean,System.String)">
|
<summary>
|
Initializes a new instance of the SetProxyResponse class.
|
</summary>
|
<param name="success">success</param>
|
<param name="errorMessage">error message</param>
|
</member>
|
<member name="T:CefSharp.AssemblyInfo">
|
<exclude />
|
</member>
|
<member name="T:CefSharp.ProxyOptions">
|
<summary>
|
Proxy options
|
</summary>
|
</member>
|
<member name="P:CefSharp.ProxyOptions.IP">
|
<summary>
|
The IP address for the proxy
|
</summary>
|
</member>
|
<member name="P:CefSharp.ProxyOptions.Port">
|
<summary>
|
The port for the proxy
|
</summary>
|
</member>
|
<member name="P:CefSharp.ProxyOptions.Username">
|
<summary>
|
The username for authentication
|
</summary>
|
</member>
|
<member name="P:CefSharp.ProxyOptions.Password">
|
<summary>
|
The password for authentication
|
</summary>
|
</member>
|
<member name="P:CefSharp.ProxyOptions.BypassList">
|
<summary>
|
The list of domains that shouldn't be affected by the proxy, Format: example.com;example2.com
|
</summary>
|
</member>
|
<member name="M:CefSharp.ProxyOptions.HasUsernameAndPassword">
|
<summary>
|
Checks if username and password is set
|
</summary>
|
<returns>Returns true if both username and password is set, otherwise false</returns>
|
</member>
|
<member name="M:CefSharp.ProxyOptions.#ctor(System.String,System.String,System.String,System.String,System.String)">
|
<param name="ip">The IP address for the proxy</param>
|
<param name="port">The port for the proxy</param>
|
<param name="username">The username required for authentication</param>
|
<param name="password">The password required for authentication</param>
|
<param name="bypassList">The list of domains that shouldn't be affected by the proxy, Format: example.com;example2.com</param>
|
</member>
|
<member name="T:CefSharp.RenderProcess.IRenderProcessHandler">
|
<summary>
|
Class used to implement render process callbacks.
|
The methods of this class will be called on the render process main thread (TID_RENDERER) unless otherwise indicated.
|
</summary>
|
</member>
|
<member name="M:CefSharp.RenderProcess.IRenderProcessHandler.OnContextCreated(CefSharp.IBrowser,CefSharp.IFrame,CefSharp.RenderProcess.IV8Context)">
|
<summary>
|
Called immediately after the V8 context for a frame has been created.
|
V8 handles can only be accessed from the thread on which they are created.
|
</summary>
|
<param name="browser">the browser</param>
|
<param name="frame">the frame</param>
|
<param name="context">the V8Context</param>
|
</member>
|
<member name="M:CefSharp.RenderProcess.IRenderProcessHandler.OnContextReleased(CefSharp.IBrowser,CefSharp.IFrame,CefSharp.RenderProcess.IV8Context)">
|
<summary>
|
Called immediately before the V8 context for a frame is released.
|
No references to the context should be kept after this method is called.
|
</summary>
|
<param name="browser">the browser</param>
|
<param name="frame">the frame</param>
|
<param name="context">the V8Context</param>
|
</member>
|
<member name="M:CefSharp.RenderProcess.IRenderProcessHandler.OnWebKitInitialized">
|
<summary>
|
Called after WebKit has been initialized.
|
</summary>
|
</member>
|
<member name="T:CefSharp.RenderProcess.IV8Context">
|
<summary>
|
V8 context handle.
|
V8 handles can only be accessed from the thread on which they are created.
|
Valid threads for creating a V8 handle include the render process main thread (TID_RENDERER) and WebWorker threads.
|
A task runner for posting tasks on the associated thread can be retrieved via the CefV8Context::GetTaskRunner() method.
|
</summary>
|
<remarks>
|
V8 is Google’s open source high-performance JavaScript and WebAssembly engine.
|
</remarks>
|
</member>
|
<member name="M:CefSharp.RenderProcess.IV8Context.Execute(System.String,System.String,System.Int32,CefSharp.RenderProcess.V8Exception@)">
|
<summary>
|
Execute a string of JavaScript code in this V8 context.
|
</summary>
|
<param name="code">JavaScript code to execute</param>
|
<param name="scriptUrl">Is the URL where the script in question can be found, if any</param>
|
<param name="startLine">Is the base line number to use for error reporting.</param>
|
<param name="exception">Is the exception if any.</param>
|
<returns>On success the function will return true. On failure <paramref name="exception"/> will be set to the exception, if any, and the function will return false.</returns>
|
</member>
|
<member name="T:CefSharp.RenderProcess.V8Exception">
|
<summary>
|
Class representing a V8 exception.
|
</summary>
|
<remarks>
|
V8 is Google’s open source high-performance JavaScript and WebAssembly engine.
|
</remarks>
|
</member>
|
<member name="P:CefSharp.RenderProcess.V8Exception.EndColumn">
|
<summary>
|
Returns the index within the line of the last character where the error occurred.
|
</summary>
|
<returns>Returns the index within the line of the last character where the error occurred.</returns>
|
</member>
|
<member name="P:CefSharp.RenderProcess.V8Exception.EndPosition">
|
<summary>
|
Returns the index within the script of the last character where the error occurred.
|
</summary>
|
<returns>Returns the index within the script of the last character where the error occurred.</returns>
|
</member>
|
<member name="P:CefSharp.RenderProcess.V8Exception.LineNumber">
|
<summary>
|
Returns the 1-based number of the line where the error occurred or 0 if the line number is unknown.
|
</summary>
|
<returns>Returns the 1-based number of the line where the error occurred or 0 if the line number is unknown.</returns>
|
</member>
|
<member name="P:CefSharp.RenderProcess.V8Exception.Message">
|
<summary>
|
Returns the exception message.
|
</summary>
|
<returns>Returns the exception message.</returns>
|
</member>
|
<member name="P:CefSharp.RenderProcess.V8Exception.ScriptResourceName">
|
<summary>
|
Returns the resource name for the script from where the function causing the error originates.
|
</summary>
|
<returns>Returns the resource name for the script from where the function causing the error originates.</returns>
|
</member>
|
<member name="P:CefSharp.RenderProcess.V8Exception.SourceLine">
|
<summary>
|
Returns the line of source code that the exception occurred within.
|
</summary>
|
<returns>Returns the line of source code that the exception occurred within.</returns>
|
</member>
|
<member name="P:CefSharp.RenderProcess.V8Exception.StartColumn">
|
<summary>
|
Returns the index within the line of the first character where the error occurred.
|
</summary>
|
<returns>Returns the index within the line of the first character where the error occurred.</returns>
|
</member>
|
<member name="P:CefSharp.RenderProcess.V8Exception.StartPosition">
|
<summary>
|
Returns the index within the script of the first character where the error occurred.
|
</summary>
|
<returns>Returns the index within the script of the first character where the error occurred.</returns>
|
</member>
|
<member name="M:CefSharp.RenderProcess.V8Exception.#ctor(System.Int32,System.Int32,System.Int32,System.String,System.String,System.String,System.Int32,System.Int32)">
|
<summary>
|
V8 Exception
|
</summary>
|
<param name="endColumn">index within the line of the last character where the error occurred.</param>
|
<param name="endPosition">index within the script of the last character where the error occurred.</param>
|
<param name="lineNumber">1-based number of the line where the error occurred or 0 if the line number is unknown.</param>
|
<param name="message">exception message.</param>
|
<param name="scriptResourceName">resource name for the script from where the function causing the error originates.</param>
|
<param name="sourceLine">line of source code that the exception occurred within.</param>
|
<param name="startColumn">index within the line of the first character where the error occurred.</param>
|
<param name="startPosition">index within the script of the first character where the error occurred.</param>
|
</member>
|
<member name="T:CefSharp.RequestContextExtensions">
|
<summary>
|
RequestContext extensions.
|
</summary>
|
</member>
|
<member name="F:CefSharp.RequestContextExtensions.ProxySchemes">
|
<summary>
|
Array of valid proxy schemes
|
</summary>
|
</member>
|
<member name="M:CefSharp.RequestContextExtensions.LoadExtensionFromDirectory(CefSharp.IRequestContext,System.String,CefSharp.IExtensionHandler)">
|
<summary>
|
Load an extension from the given directory. To load a crx file you must unzip it first.
|
For further details see <seealso cref="M:CefSharp.IRequestContext.LoadExtension(System.String,System.String,CefSharp.IExtensionHandler)"/>
|
</summary>
|
<param name="requestContext">request context</param>
|
<param name="rootDirectory">absolute path to the directory that contains the extension to be loaded.</param>
|
<param name="handler">handle events related to browser extensions</param>
|
</member>
|
<member name="M:CefSharp.RequestContextExtensions.LoadExtensionsFromDirectory(CefSharp.IRequestContext,System.String,CefSharp.IExtensionHandler)">
|
<summary>
|
Load extension(s) from the given directory. This methods obtains all the sub directories of <paramref name="rootDirectory"/>
|
and calls <see cref="M:CefSharp.IRequestContext.LoadExtension(System.String,System.String,CefSharp.IExtensionHandler)"/> if manifest.json
|
is found in the sub folder. To load crx file(s) you must unzip them first.
|
For further details see <seealso cref="M:CefSharp.IRequestContext.LoadExtension(System.String,System.String,CefSharp.IExtensionHandler)"/>
|
</summary>
|
<param name="requestContext">request context</param>
|
<param name="rootDirectory">absolute path to the directory that contains the extension(s) to be loaded.</param>
|
<param name="handler">handle events related to browser extensions</param>
|
</member>
|
<member name="M:CefSharp.RequestContextExtensions.GetCookieManagerAsync(CefSharp.IRequestContext)">
|
<summary>
|
Gets the cookie manager associated with the <see cref="T:CefSharp.IRequestContext"/>. Once the cookie manager
|
storage has been initialized the method will return.
|
</summary>
|
<exception cref="T:System.Exception">Thrown when an exception error condition occurs.</exception>
|
<param name="requestContext">The <see cref="T:CefSharp.IRequestContext"/> instance this method extends.</param>
|
<returns>returns <see cref="T:CefSharp.ICookieManager"/> if the store was successfully loaded otherwise null. </returns>
|
</member>
|
<member name="M:CefSharp.RequestContextExtensions.SetPreferenceAsync(CefSharp.IRequestContext,System.String,System.Object)">
|
<summary>
|
Set the value associated with preference name. If value is null the
|
preference will be restored to its default value. If setting the preference
|
fails then error will be populated with a detailed description of the
|
problem. This method must be called on the CEF UI thread.
|
Preferences set via the command-line usually cannot be modified.
|
</summary>
|
<param name="requestContext">request context</param>
|
<param name="name">preference key</param>
|
<param name="value">preference value</param>
|
<returns>returns <see cref="P:CefSharp.Preferences.SetPreferenceResponse.Success"/> true if successfull, false otherwise.</returns>
|
<remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
|
<see cref="M:CefSharp.IBrowserProcessHandler.OnContextInitialized"/> and ChromiumWebBrowser.IsBrowserInitializedChanged are both
|
executed on the CEF UI thread, so can be called directly.
|
When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
|
application thread will be the CEF UI thread.</remarks>
|
</member>
|
<member name="M:CefSharp.RequestContextExtensions.SetProxyAsync(CefSharp.IRequestContext,System.String,System.Nullable{System.Int32})">
|
<summary>
|
Sets the proxy server for the specified <see cref="T:CefSharp.IRequestContext"/>.
|
Protocol for the proxy server is http
|
</summary>
|
<param name="requestContext">request context</param>
|
<param name="host">proxy host</param>
|
<param name="port">proxy port</param>
|
<returns>returns <see cref="P:CefSharp.Preferences.SetPreferenceResponse.Success"/> true if successfull, false otherwise.</returns>
|
<remarks>Internally calls <seealso cref="M:CefSharp.IRequestContext.SetPreference(System.String,System.Object,System.String@)"/> with
|
preference 'proxy' and mode of 'fixed_servers'</remarks>
|
</member>
|
<member name="M:CefSharp.RequestContextExtensions.SetProxyAsync(CefSharp.IRequestContext,System.String,System.String,System.Nullable{System.Int32})">
|
<summary>
|
Sets the proxy server for the specified <see cref="T:CefSharp.IRequestContext"/>
|
</summary>
|
<param name="requestContext">request context</param>
|
<param name="scheme">is the protocol of the proxy server, and is one of: 'http', 'socks', 'socks4', 'socks5'. Also note that 'socks' is equivalent to 'socks5'.</param>
|
<param name="host">proxy host</param>
|
<param name="port">proxy port</param>
|
<returns>returns <see cref="P:CefSharp.Preferences.SetPreferenceResponse.Success"/> true if successfull, false otherwise.</returns>
|
<remarks>Internally calls <seealso cref="M:CefSharp.IRequestContext.SetPreference(System.String,System.Object,System.String@)"/> with
|
preference 'proxy' and mode of 'fixed_servers'</remarks>
|
</member>
|
<member name="M:CefSharp.RequestContextExtensions.SetProxy(CefSharp.IRequestContext,System.String,System.String,System.Nullable{System.Int32},System.String@)">
|
<summary>
|
Sets the proxy server for the specified <see cref="T:CefSharp.IRequestContext"/>
|
MUST be called on the CEF UI Thread
|
</summary>
|
<param name="requestContext">request context</param>
|
<param name="scheme">is the protocol of the proxy server, and is one of: 'http', 'socks', 'socks4', 'socks5'. Also note that 'socks' is equivalent to 'socks5'.</param>
|
<param name="host">proxy host</param>
|
<param name="port">proxy port</param>
|
<param name="errorMessage">error message</param>
|
<returns>returns true if successfull, false otherwise.</returns>
|
<remarks>Internally calls <seealso cref="M:CefSharp.IRequestContext.SetPreference(System.String,System.Object,System.String@)"/> with
|
preference 'proxy' and mode of 'fixed_servers'</remarks>
|
</member>
|
<member name="M:CefSharp.RequestContextExtensions.SetProxy(CefSharp.IRequestContext,System.String,System.Nullable{System.Int32},System.String@)">
|
<summary>
|
Sets the proxy server for the specified <see cref="T:CefSharp.IRequestContext"/>.
|
Protocol for the proxy server is http
|
MUST be called on the CEF UI Thread
|
</summary>
|
<param name="requestContext">request context</param>
|
<param name="host">proxy host</param>
|
<param name="port">proxy port</param>
|
<param name="errorMessage">error message</param>
|
<returns>returns true if successfull, false otherwise.</returns>
|
<remarks>Internally calls <seealso cref="M:CefSharp.IRequestContext.SetPreference(System.String,System.Object,System.String@)"/> with
|
preference 'proxy' and mode of 'fixed_servers'</remarks>
|
</member>
|
<member name="M:CefSharp.RequestContextExtensions.SetProxy(CefSharp.IRequestContext,System.String,System.String@)">
|
<summary>
|
Sets the proxy server for the specified <see cref="T:CefSharp.IRequestContext"/>.
|
Protocol for the proxy server is http
|
MUST be called on the CEF UI Thread
|
</summary>
|
<param name="requestContext">request context</param>
|
<param name="host">proxy host</param>
|
<param name="errorMessage">error message</param>
|
<returns>returns true if successfull, false otherwise.</returns>
|
<remarks>Internally calls <seealso cref="M:CefSharp.IRequestContext.SetPreference(System.String,System.Object,System.String@)"/> with
|
preference 'proxy' and mode of 'fixed_servers'</remarks>
|
</member>
|
<member name="M:CefSharp.RequestContextExtensions.GetProxyDictionary(System.String,System.String,System.Nullable{System.Int32})">
|
<summary>
|
Creates a Dictionary that can be used with <see cref="M:CefSharp.IRequestContext.SetPreference(System.String,System.Object,System.String@)"/>
|
</summary>
|
<param name="scheme">is the protocol of the proxy server, and is one of: 'http', 'socks', 'socks4', 'socks5'. Also note that 'socks' is equivalent to 'socks5'.</param>
|
<param name="host">proxy host</param>
|
<param name="port">proxy port</param>
|
<returns></returns>
|
</member>
|
<member name="M:CefSharp.RequestContextExtensions.ClearHttpAuthCredentialsAsync(CefSharp.IRequestContext)">
|
<summary>
|
Clears all HTTP authentication credentials that were added as part of handling
|
<see cref="M:CefSharp.IRequestHandler.GetAuthCredentials(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,System.Boolean,System.String,System.Int32,System.String,System.String,CefSharp.IAuthCallback)"/>.
|
</summary>
|
<param name="requestContext">request context</param>
|
<returns>A task that represents the ClearHttpAuthCredentials operation.
|
Result indicates if the credentials cleared successfully.</returns>
|
</member>
|
<member name="M:CefSharp.RequestContextExtensions.RegisterOwinSchemeHandlerFactory(CefSharp.IRequestContext,System.String,System.String,System.Func{System.Collections.Generic.IDictionary{System.String,System.Object},System.Threading.Tasks.Task})">
|
<summary>
|
Extension method to register a instance of the <see cref="T:CefSharp.SchemeHandler.OwinSchemeHandlerFactory"/> with the provided <paramref name="appFunc"/>
|
for the <paramref name="domainName"/>
|
</summary>
|
<param name="requestContext">request context</param>
|
<param name="schemeName">scheme name, e.g. http(s). If registering for a custom scheme then that scheme must be already registered.
|
It's recommended that you use https or http with a domain name rather than using a custom scheme.</param>
|
<param name="domainName">Optional domain name</param>
|
<param name="appFunc">OWIN AppFunc as defined at owin.org</param>
|
</member>
|
<member name="T:CefSharp.ResourceHandler">
|
<summary>
|
Default implementation of <see cref="T:CefSharp.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.
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceHandler.DefaultMimeType">
|
<summary>
|
MimeType to be used if none provided
|
</summary>
|
</member>
|
<member name="F:CefSharp.ResourceHandler.tempBuffer">
|
<summary>
|
We reuse a temp buffer where possible for copying the data from the stream
|
into the output stream
|
</summary>
|
</member>
|
<member name="P:CefSharp.ResourceHandler.Charset">
|
<summary>
|
Gets or sets the Charset
|
</summary>
|
</member>
|
<member name="P:CefSharp.ResourceHandler.MimeType">
|
<summary>
|
Gets or sets the Mime Type.
|
</summary>
|
</member>
|
<member name="P:CefSharp.ResourceHandler.Stream">
|
<summary>
|
Gets or sets the resource stream.
|
</summary>
|
</member>
|
<member name="P:CefSharp.ResourceHandler.StatusCode">
|
<summary>
|
Gets or sets the http status code.
|
</summary>
|
</member>
|
<member name="P:CefSharp.ResourceHandler.StatusText">
|
<summary>
|
Gets or sets the status text.
|
</summary>
|
</member>
|
<member name="P:CefSharp.ResourceHandler.ResponseLength">
|
<summary>
|
Gets or sets ResponseLength, when you know the size of your
|
Stream (Response) set this property. This is optional.
|
If you use a MemoryStream and don't provide a value
|
here then it will be cast and its size used
|
</summary>
|
</member>
|
<member name="P:CefSharp.ResourceHandler.Headers">
|
<summary>
|
Gets or sets the headers.
|
</summary>
|
<value>The headers.</value>
|
</member>
|
<member name="P:CefSharp.ResourceHandler.AutoDisposeStream">
|
<summary>
|
When true the Stream will be Disposed when
|
this instance is Disposed. The default value for
|
this property is false.
|
</summary>
|
</member>
|
<member name="P:CefSharp.ResourceHandler.ErrorCode">
|
<summary>
|
If the ErrorCode is set then the response will be ignored and
|
the errorCode returned.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ResourceHandler.#ctor(System.String,System.IO.Stream,System.Boolean,System.String)">
|
<summary>
|
Initializes a new instance of the <see cref="T:CefSharp.ResourceHandler"/> class.
|
</summary>
|
<param name="mimeType">Optional mimeType defaults to <see cref="F:CefSharp.ResourceHandler.DefaultMimeType"/></param>
|
<param name="stream">Optional Stream - must be set at some point to provide a valid response</param>
|
<param name="autoDisposeStream">When true the Stream will be disposed when this instance is Disposed, you will
|
be unable to use this ResourceHandler after the Stream has been disposed</param>
|
<param name="charset">response charset</param>
|
</member>
|
<member name="M:CefSharp.ResourceHandler.ProcessRequestAsync(CefSharp.IRequest,CefSharp.ICallback)">
|
<summary>
|
Begin processing the request. If you have the data in memory you can execute the callback
|
immediately and return true. For Async processing you would typically spawn a Task to perform processing,
|
then return true. When the processing is complete execute callback.Continue(); In your processing Task, simply set
|
the StatusCode, StatusText, MimeType, ResponseLength and Stream
|
</summary>
|
<param name="request">The request object.</param>
|
<param name="callback">The callback used to Continue or Cancel the request (async).</param>
|
<returns>To handle the request return true and call
|
<see cref="M:CefSharp.ICallback.Continue"/> once the response header information is available
|
<see cref="M:CefSharp.ICallback.Continue"/> can also be called from inside this method if
|
header information is available immediately).
|
To cancel the request return false.</returns>
|
</member>
|
<member name="M:CefSharp.ResourceHandler.FromFilePath(System.String,System.String,System.Boolean)">
|
<summary>
|
Gets the resource from the file path specified. Use the Cef.GetMimeType()
|
helper method to lookup the mimeType if required. Uses CefStreamResourceHandler for reading the data
|
</summary>
|
<param name="filePath">Location of the file.</param>
|
<param name="mimeType">The mimeType if null then text/html is used.</param>
|
<param name="autoDisposeStream">Dispose of the stream when finished with (you will only be able to serve one
|
request).</param>
|
<returns>IResourceHandler.</returns>
|
</member>
|
<member name="M:CefSharp.ResourceHandler.FromByteArray(System.Byte[],System.String,System.String)">
|
<summary>
|
Creates a IResourceHandler that represents a Byte[], uses CefStreamResourceHandler for reading the data
|
</summary>
|
<param name="data">data</param>
|
<param name="mimeType">mimeType</param>
|
<param name="charSet">response charset</param>
|
<returns>IResourceHandler</returns>
|
</member>
|
<member name="M:CefSharp.ResourceHandler.FromString(System.String,System.String)">
|
<summary>
|
Gets the resource from the string.
|
</summary>
|
<param name="text">The text.</param>
|
<param name="fileExtension">The file extension.</param>
|
<returns>ResourceHandler.</returns>
|
</member>
|
<member name="M:CefSharp.ResourceHandler.FromString(System.String,System.Text.Encoding,System.Boolean,System.String)">
|
<summary>
|
Gets a <see cref="T:CefSharp.ResourceHandler"/> that represents a string.
|
Without a Preamble, Cef will use BrowserSettings.DefaultEncoding to load the html.
|
</summary>
|
<param name="text">The html string</param>
|
<param name="encoding">Character Encoding</param>
|
<param name="includePreamble">Include encoding preamble</param>
|
<param name="mimeType">Mime Type</param>
|
<returns>ResourceHandler</returns>
|
</member>
|
<member name="M:CefSharp.ResourceHandler.ForErrorMessage(System.String,System.Net.HttpStatusCode)">
|
<summary>
|
Generates a ResourceHandler that has it's StatusCode set
|
</summary>
|
<param name="errorMessage">Body the response to be displayed</param>
|
<param name="statusCode">StatusCode</param>
|
<returns>ResourceHandler</returns>
|
</member>
|
<member name="M:CefSharp.ResourceHandler.FromStream(System.IO.Stream,System.String,System.Boolean,System.String)">
|
<summary>
|
Gets the resource from a stream.
|
</summary>
|
<param name="stream">A stream of the resource.</param>
|
<param name="mimeType">Type of MIME.</param>
|
<param name="autoDisposeStream">Dispose of the stream when finished with (you will only be able to serve one
|
request).</param>
|
<param name="charSet">response charset</param>
|
<returns>ResourceHandler.</returns>
|
</member>
|
<member name="M:CefSharp.ResourceHandler.GetMemoryStream(System.String,System.Text.Encoding,System.Boolean)">
|
<summary>
|
Gets a MemoryStream from the given string using the provided encoding
|
</summary>
|
<param name="text">string to be converted to a stream</param>
|
<param name="encoding">encoding</param>
|
<param name="includePreamble">if true a BOM will be written to the beginning of the stream</param>
|
<returns>A memory stream from the given string</returns>
|
</member>
|
<member name="M:CefSharp.ResourceHandler.GetByteArray(System.String,System.Text.Encoding,System.Boolean)">
|
<summary>
|
Gets a byteArray from the given string using the provided encoding
|
</summary>
|
<param name="text">string to be converted to a stream</param>
|
<param name="encoding">encoding</param>
|
<param name="includePreamble">if true a BOM will be written to the beginning of the stream</param>
|
<returns>A memory stream from the given string</returns>
|
</member>
|
<member name="M:CefSharp.ResourceHandler.GetMimeType(System.String)">
|
<summary>
|
Gets the MIME type of the content.
|
</summary>
|
<param name="extension">The extension.</param>
|
<returns>System.String.</returns>
|
<exception cref="T:System.ArgumentNullException">extension</exception>
|
<remarks>In most cases it's preferable to use Cef.GetMimeType(extension); instead. See https://github.com/cefsharp/CefSharp/issues/3041 for details.</remarks>
|
</member>
|
<member name="M:CefSharp.ResourceHandler.Dispose">
|
<summary>
|
Dispose of resources here
|
</summary>
|
</member>
|
<member name="T:CefSharp.ResourceRequestHandlerFactory">
|
<summary>
|
Default implementation of <see cref="T:CefSharp.IResourceRequestHandlerFactory"/> it's used
|
internally for the LoadHtml implementation - basically a resource handler is
|
registered for a specific Url.
|
</summary>
|
</member>
|
<member name="P:CefSharp.ResourceRequestHandlerFactory.Handlers">
|
<summary>
|
Resource handler thread safe dictionary
|
</summary>
|
</member>
|
<member name="M:CefSharp.ResourceRequestHandlerFactory.#ctor(System.Collections.Generic.IEqualityComparer{System.String})">
|
<summary>
|
Create a new instance of DefaultResourceHandlerFactory
|
</summary>
|
<param name="comparer">string equality comparer</param>
|
</member>
|
<member name="M:CefSharp.ResourceRequestHandlerFactory.RegisterHandler(System.String,System.Byte[],System.String,System.Boolean)">
|
<summary>
|
Register a handler for the specified Url
|
</summary>
|
<param name="url">url</param>
|
<param name="data">The data in byte[] format that will be used for the response</param>
|
<param name="mimeType">mime type</param>
|
<param name="oneTimeUse">Whether or not the handler should be used once (true) or until manually unregistered (false)</param>
|
<returns>returns true if the Url was successfully parsed into a Uri otherwise false</returns>
|
</member>
|
<member name="M:CefSharp.ResourceRequestHandlerFactory.UnregisterHandler(System.String)">
|
<summary>
|
Unregister a handler for the specified Url
|
</summary>
|
<param name="url">Url</param>
|
<returns>returns true if successfully removed</returns>
|
</member>
|
<member name="P:CefSharp.ResourceRequestHandlerFactory.CefSharp#IResourceRequestHandlerFactory#HasHandlers">
|
<summary>
|
Are there any <see cref="T:CefSharp.ResourceHandler"/>'s registered?
|
</summary>
|
</member>
|
<member name="M:CefSharp.ResourceRequestHandlerFactory.CefSharp#IResourceRequestHandlerFactory#GetResourceRequestHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,System.Boolean,System.Boolean,System.String,System.Boolean@)">
|
<inheritdoc />
|
</member>
|
<member name="M:CefSharp.ResourceRequestHandlerFactory.GetResourceRequestHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest,System.Boolean,System.Boolean,System.String,System.Boolean@)">
|
<summary>
|
Called on the CEF IO thread before a resource request is initiated.
|
</summary>
|
<param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
|
<param name="browser">represent the source browser of the request</param>
|
<param name="frame">represent the source frame of the request</param>
|
<param name="request">represents the request contents and cannot be modified in this callback</param>
|
<param name="isNavigation">will be true if the resource request is a navigation</param>
|
<param name="isDownload">will be true if the resource request is a download</param>
|
<param name="requestInitiator">is the origin (scheme + domain) of the page that initiated the request</param>
|
<param name="disableDefaultHandling">to true to disable default handling of the request, in which case it will need to be handled via <see cref="M:CefSharp.IResourceRequestHandler.GetResourceHandler(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,CefSharp.IRequest)"/> or it will be canceled</param>
|
<returns>To allow the resource load to proceed with default handling return null. To specify a handler for the resource return a <see cref="T:CefSharp.IResourceRequestHandler"/> object. If this callback returns null the same method will be called on the associated <see cref="T:CefSharp.IRequestContextHandler"/>, if any</returns>
|
</member>
|
<member name="T:CefSharp.ResourceRequestHandlerFactoryItem">
|
<summary>
|
A resource request handler factory item.
|
</summary>
|
</member>
|
<member name="P:CefSharp.ResourceRequestHandlerFactoryItem.Data">
|
<summary>
|
Data
|
</summary>
|
</member>
|
<member name="P:CefSharp.ResourceRequestHandlerFactoryItem.MimeType">
|
<summary>
|
Mime Type
|
</summary>
|
</member>
|
<member name="P:CefSharp.ResourceRequestHandlerFactoryItem.OneTimeUse">
|
<summary>
|
Whether or not the handler should be used once (true) or until manually unregistered (false)
|
</summary>
|
</member>
|
<member name="M:CefSharp.ResourceRequestHandlerFactoryItem.#ctor(System.Byte[],System.String,System.Boolean)">
|
<summary>
|
DefaultResourceHandlerFactoryItem constructor
|
</summary>
|
<param name="data">The data in byte[] format that will be used for the response</param>
|
<param name="mimeType">mime type</param>
|
<param name="oneTimeUse">Whether or not the handler should be used once (true) or until manually unregistered (false)</param>
|
</member>
|
<member name="T:CefSharp.ResponseFilter.StreamResponseFilter">
|
<summary>
|
StreamResponseFilter - copies all data from IResponseFilter.Filter
|
to the provided Stream. The <see cref="T:System.IO.Stream"/> must be writable, no data will be copied otherwise.
|
The StreamResponseFilter will release it's reference (set to null) to the <see cref="T:System.IO.Stream"/> when it's Disposed.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ResponseFilter.StreamResponseFilter.#ctor(System.IO.Stream)">
|
<summary>
|
StreamResponseFilter constructor
|
</summary>
|
<param name="stream">a writable stream</param>
|
</member>
|
<member name="M:CefSharp.ResponseFilter.StreamResponseFilter.Dispose">
|
<inheritdoc/>
|
</member>
|
<member name="T:CefSharp.SchemeHandler.FolderSchemeHandlerFactory">
|
<summary>
|
FolderSchemeHandlerFactory is a very simple scheme handler that allows you
|
to map requests for urls to a folder on your file system. For example
|
creating a setting the rootFolder to c:\projects\CefSharp\CefSharp.Example\Resources
|
registering the scheme handler
|
</summary>
|
</member>
|
<member name="F:CefSharp.SchemeHandler.FolderSchemeHandlerFactory.GetMimeTypeDelegate">
|
<summary>
|
<see cref="M:CefSharp.ResourceHandler.GetMimeType(System.String)"/> is being deprecated in favour of using
|
Chromiums native mimeType lookup which is accessible using Cef.GetMimeType, this method is however
|
not directly available as it exists in CefSharp.Core, to get around this we set
|
this static delegate with a reference to Cef.GetMimeType when Cef.Initialize is called.
|
</summary>
|
</member>
|
<member name="M:CefSharp.SchemeHandler.FolderSchemeHandlerFactory.#ctor(System.String,System.String,System.String,System.String,System.IO.FileShare)">
|
<summary>
|
Initialize a new instance of FolderSchemeHandlerFactory
|
</summary>
|
<param name="rootFolder">Root Folder where all your files exist, requests cannot be made outside of this folder</param>
|
<param name="schemeName">if not null then schemeName checking will be implemented</param>
|
<param name="hostName">if not null then hostName checking will be implemented</param>
|
<param name="defaultPage">default page if no page specified, defaults to index.html</param>
|
<param name="resourceFileShare">file share mode used to open resources, defaults to FileShare.Read</param>
|
</member>
|
<member name="M:CefSharp.SchemeHandler.FolderSchemeHandlerFactory.CefSharp#ISchemeHandlerFactory#Create(CefSharp.IBrowser,CefSharp.IFrame,System.String,CefSharp.IRequest)">
|
<summary>
|
If the file requested is within the rootFolder then a IResourceHandler reference to the file requested will be returned
|
otherwise a 404 ResourceHandler will be returned.
|
</summary>
|
<param name="browser">the browser window that originated the
|
request or null if the request did not originate from a browser window
|
(for example, if the request came from CefURLRequest).</param>
|
<param name="frame">frame that originated the request
|
or null if the request did not originate from a browser window
|
(for example, if the request came from CefURLRequest).</param>
|
<param name="schemeName">the scheme name</param>
|
<param name="request">The request. (will not contain cookie data)</param>
|
<returns>
|
A IResourceHandler
|
</returns>
|
</member>
|
<member name="M:CefSharp.SchemeHandler.FolderSchemeHandlerFactory.Create(CefSharp.IBrowser,CefSharp.IFrame,System.String,CefSharp.IRequest)">
|
<summary>
|
If the file requested is within the rootFolder then a IResourceHandler reference to the file requested will be returned
|
otherwise a 404 ResourceHandler will be returned.
|
</summary>
|
<param name="browser">the browser window that originated the
|
request or null if the request did not originate from a browser window
|
(for example, if the request came from CefURLRequest).</param>
|
<param name="frame">frame that originated the request
|
or null if the request did not originate from a browser window
|
(for example, if the request came from CefURLRequest).</param>
|
<param name="schemeName">the scheme name</param>
|
<param name="request">The request. (will not contain cookie data)</param>
|
<returns>
|
A IResourceHandler
|
</returns>
|
</member>
|
<member name="T:CefSharp.SchemeHandler.OwinResourceHandler">
|
<summary>
|
<see cref="T:CefSharp.ResourceHandler"/> implementation that uses an OWIN capable host of fulfilling requests.
|
Can be used with NancyFx or AspNet Core
|
</summary>
|
TODO:
|
- Multipart post data
|
- Cancellation Token
|
</member>
|
<member name="M:CefSharp.SchemeHandler.OwinResourceHandler.#ctor(System.Func{System.Collections.Generic.IDictionary{System.String,System.Object},System.Threading.Tasks.Task})">
|
<summary>
|
OwinResourceHandler
|
</summary>
|
<param name="appFunc">Owin pipeline func</param>
|
</member>
|
<member name="M:CefSharp.SchemeHandler.OwinResourceHandler.ProcessRequestAsync(CefSharp.IRequest,CefSharp.ICallback)">
|
<summary>
|
Read the request, then process it through the OWEN pipeline
|
then populate the response properties.
|
</summary>
|
<param name="request">request</param>
|
<param name="callback">callback</param>
|
<returns>always returns true as we'll handle all requests this handler is registered for.</returns>
|
</member>
|
<member name="T:CefSharp.SchemeHandler.OwinSchemeHandlerFactory">
|
<summary>
|
<see cref="T:CefSharp.ISchemeHandlerFactory"/> implementation that takes an OWIN AppFunc
|
and uses an <see cref="T:CefSharp.SchemeHandler.OwinResourceHandler"/> to fulfill each requests.
|
</summary>
|
</member>
|
<member name="M:CefSharp.SchemeHandler.OwinSchemeHandlerFactory.#ctor(System.Func{System.Collections.Generic.IDictionary{System.String,System.Object},System.Threading.Tasks.Task})">
|
<summary>
|
OwinSchemeHandlerFactory
|
</summary>
|
<param name="appFunc">Owin pipeline func</param>
|
</member>
|
<member name="M:CefSharp.SchemeHandler.OwinSchemeHandlerFactory.Create(CefSharp.IBrowser,CefSharp.IFrame,System.String,CefSharp.IRequest)">
|
<inheritdoc/>
|
</member>
|
<member name="T:CefSharp.ISchemeHandlerFactory">
|
<summary>
|
Class that creates <see cref="T:CefSharp.IResourceHandler"/> instances for handling scheme requests.
|
The methods of this class will always be called on the CEF IO thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ISchemeHandlerFactory.Create(CefSharp.IBrowser,CefSharp.IFrame,System.String,CefSharp.IRequest)">
|
<summary>
|
Return a new <see cref="T:CefSharp.IResourceHandler"/> instance to handle the request or an empty
|
reference to allow default handling of the request.
|
</summary>
|
<param name="browser">the browser window that originated the
|
request or null if the request did not originate from a browser window
|
(for example, if the request came from CefURLRequest).</param>
|
<param name="frame">frame that originated the request
|
or null if the request did not originate from a browser window
|
(for example, if the request came from CefURLRequest).</param>
|
<param name="schemeName">the scheme name</param>
|
<param name="request">The request. (will not contain cookie data)</param>
|
<returns>
|
Return a new <see cref="T:CefSharp.IResourceHandler"/> instance to handle the request or an empty
|
reference to allow default handling of the request
|
</returns>
|
</member>
|
<member name="T:CefSharp.SslStatus">
|
<summary>
|
Class representing the SSL information for a navigation entry.
|
</summary>
|
</member>
|
<member name="P:CefSharp.SslStatus.IsSecureConnection">
|
<summary>
|
Returns true if the status is related to a secure SSL/TLS connection.
|
</summary>
|
</member>
|
<member name="P:CefSharp.SslStatus.CertStatus">
|
<summary>
|
Returns a bitmask containing any and all problems verifying the server certificate.
|
If the certificate is valid then <see cref="F:CefSharp.CertStatus.None"/> is returned.
|
</summary>
|
</member>
|
<member name="P:CefSharp.SslStatus.SslVersion">
|
<summary>
|
Returns the SSL version used for the SSL connection.
|
</summary>
|
<returns></returns>
|
</member>
|
<member name="P:CefSharp.SslStatus.ContentStatus">
|
<summary>
|
Returns a bitmask containing the page security content status.
|
</summary>
|
</member>
|
<member name="P:CefSharp.SslStatus.X509Certificate">
|
<summary>
|
Returns the X.509 certificate.
|
</summary>
|
</member>
|
<member name="M:CefSharp.SslStatus.#ctor(System.Boolean,CefSharp.CertStatus,CefSharp.SslVersion,CefSharp.SslContentStatus,System.Security.Cryptography.X509Certificates.X509Certificate2)">
|
<summary>
|
SslStatus
|
</summary>
|
<param name="isSecureConnection">is secure</param>
|
<param name="certStatus">cert status</param>
|
<param name="sslVersion">ssl version</param>
|
<param name="contentStatus">content status</param>
|
<param name="certificate">certificate</param>
|
</member>
|
<member name="T:CefSharp.Structs.AudioParameters">
|
<summary>
|
Structure representing the audio parameters for setting up the audio handler.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.AudioParameters.ChannelLayout">
|
<summary>
|
Layout of the audio channels
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.AudioParameters.SampleRate">
|
<summary>
|
Sample rate
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.AudioParameters.FramesPerBuffer">
|
<summary>
|
Number of frames per buffer
|
</summary>
|
</member>
|
<member name="M:CefSharp.Structs.AudioParameters.#ctor(CefSharp.Enums.ChannelLayout,System.Int32,System.Int32)">
|
<summary>
|
Init with default values
|
</summary>
|
<param name="channelLayout">channel layout</param>
|
<param name="sampleRate">sample rate</param>
|
<param name="framesPerBuffer">frames per buffer</param>
|
</member>
|
<member name="T:CefSharp.Structs.CompositionUnderline">
|
<summary>
|
Represents an IME composition underline.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.CompositionUnderline.Range">
|
<summary>
|
Underline character range.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.CompositionUnderline.Color">
|
<summary>
|
Text color. 32-bit ARGB color value, not premultiplied. The color components are always
|
in a known order. Equivalent to the SkColor type.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.CompositionUnderline.BackgroundColor">
|
<summary>
|
Background color. 32-bit ARGB color value, not premultiplied. The color components are always
|
in a known order. Equivalent to the SkColor type.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.CompositionUnderline.Thick">
|
<summary>
|
true for thickunderline
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.CompositionUnderline.Style">
|
<summary>
|
Style
|
</summary>
|
</member>
|
<member name="M:CefSharp.Structs.CompositionUnderline.#ctor(CefSharp.Structs.Range,System.UInt32,System.UInt32,System.Boolean)">
|
<summary>
|
Constructor.
|
</summary>
|
<param name="range">Underline character range.</param>
|
<param name="color">Text color. 32-bit ARGB color value, not premultiplied. The color components are always in a known order.
|
Equivalent to the SkColor type.</param>
|
<param name="backGroundColor">Background color. 32-bit ARGB color value, not premultiplied. The color components are always in
|
a known order. Equivalent to the SkColor type.</param>
|
<param name="thick">True for thickunderline.</param>
|
</member>
|
<member name="M:CefSharp.Structs.CompositionUnderline.#ctor(CefSharp.Structs.Range,System.UInt32,System.UInt32,System.Boolean,CefSharp.Enums.CompositionUnderlineStyle)">
|
<summary>
|
Constructor.
|
</summary>
|
<param name="range">Underline character range.</param>
|
<param name="color">Text color. 32-bit ARGB color value, not premultiplied. The color components are always in a known order.
|
Equivalent to the SkColor type.</param>
|
<param name="backGroundColor">Background color. 32-bit ARGB color value, not premultiplied. The color components are always in
|
a known order. Equivalent to the SkColor type.</param>
|
<param name="thick">True for thickunderline.</param>
|
<param name="style">Style</param>
|
</member>
|
<member name="T:CefSharp.Structs.CursorInfo">
|
<summary>
|
Struct representing cursor information.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.CursorInfo.Buffer">
|
<summary>
|
Cursor buffer
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.CursorInfo.Hotspot">
|
<summary>
|
Hotspot
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.CursorInfo.ImageScaleFactor">
|
<summary>
|
Image scale factor
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.CursorInfo.Size">
|
<summary>
|
Size
|
</summary>
|
</member>
|
<member name="M:CefSharp.Structs.CursorInfo.#ctor(System.IntPtr,CefSharp.Structs.Point,System.Single,CefSharp.Structs.Size)">
|
<summary>
|
CursorInfo
|
</summary>
|
<param name="buffer">buffer</param>
|
<param name="hotspot">hotspot</param>
|
<param name="imageScaleFactor">image scale factor</param>
|
<param name="size">size</param>
|
</member>
|
<member name="T:CefSharp.Structs.DomRect">
|
<summary>
|
Dom Rect
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.DomRect.X">
|
<summary>
|
X coordinate
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.DomRect.Y">
|
<summary>
|
Y coordinate
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.DomRect.Width">
|
<summary>
|
Rectangle width
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.DomRect.Height">
|
<summary>
|
Rectangle height
|
</summary>
|
</member>
|
<member name="M:CefSharp.Structs.DomRect.#ctor(System.Double,System.Double,System.Double,System.Double)">
|
<summary>
|
Constructor
|
</summary>
|
<param name="x">x</param>
|
<param name="y">y</param>
|
<param name="width">width</param>
|
<param name="height">height</param>
|
</member>
|
<member name="T:CefSharp.Structs.Point">
|
<summary>
|
Class representing a point.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.Point.X">
|
<summary>
|
X coordinate
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.Point.Y">
|
<summary>
|
Y coordinate
|
</summary>
|
</member>
|
<member name="M:CefSharp.Structs.Point.#ctor(System.Int32,System.Int32)">
|
<summary>
|
Point
|
</summary>
|
<param name="x">x coordinate</param>
|
<param name="y">y coordinate</param>
|
</member>
|
<member name="T:CefSharp.Structs.Range">
|
<summary>
|
Represents a range
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.Range.From">
|
<summary>
|
From
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.Range.To">
|
<summary>
|
To
|
</summary>
|
</member>
|
<member name="M:CefSharp.Structs.Range.#ctor(System.Int32,System.Int32)">
|
<summary>
|
Range
|
</summary>
|
<param name="from">from</param>
|
<param name="to">to</param>
|
</member>
|
<member name="T:CefSharp.Structs.Rect">
|
<summary>
|
Represents a rectangle
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.Rect.X">
|
<summary>
|
X coordinate
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.Rect.Y">
|
<summary>
|
Y coordinate
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.Rect.Width">
|
<summary>
|
Width
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.Rect.Height">
|
<summary>
|
Height
|
</summary>
|
</member>
|
<member name="M:CefSharp.Structs.Rect.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
|
<summary>
|
Rect
|
</summary>
|
<param name="x">x coordinate</param>
|
<param name="y">y coordinate</param>
|
<param name="width">width</param>
|
<param name="height">height</param>
|
</member>
|
<member name="M:CefSharp.Structs.Rect.ScaleByDpi(System.Single)">
|
<summary>
|
Returns a new Rect with Scaled values
|
</summary>
|
<param name="dpi">Dpi to scale by</param>
|
<returns>New rect with scaled values</returns>
|
</member>
|
<member name="T:CefSharp.Structs.ScreenInfo">
|
<summary>
|
Class representing the virtual screen information for use when window
|
rendering is disabled.
|
</summary>
|
<remarks>
|
See also <a href="https://cs.chromium.org/chromium/src/content/public/common/screen_info.h?q=content::ScreenInfo&sq=package:chromium&g=0&l=19">Chrome Source</a>
|
</remarks>
|
</member>
|
<member name="P:CefSharp.Structs.ScreenInfo.DeviceScaleFactor">
|
<summary>
|
Device scale factor. Specifies the ratio between physical and logical pixels.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.ScreenInfo.Depth">
|
<summary>
|
The screen depth in bits per pixel.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.ScreenInfo.DepthPerComponent">
|
<summary>
|
The bits per color component. This assumes that the colors are balanced equally.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.ScreenInfo.IsMonochrome">
|
<summary>
|
This can be true for black and white printers.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.ScreenInfo.Rect">
|
<summary>
|
This is set from the rcMonitor member of MONITORINFOEX, to whit:
|
"A RECT structure that specifies the display monitor rectangle,
|
expressed in virtual-screen coordinates. Note that if the monitor
|
is not the primary display monitor, some of the rectangle's
|
coordinates may be negative values."
|
The Rect and AvailableRect properties are used to determine the
|
available surface for rendering popup views.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.ScreenInfo.AvailableRect">
|
<summary>
|
This is set from the rcWork member of MONITORINFOEX, to whit:
|
"A RECT structure that specifies the work area rectangle of the
|
display monitor that can be used by applications, expressed in
|
virtual-screen coordinates. Windows uses this rectangle to
|
maximize an application on the monitor. The rest of the area in
|
rcMonitor contains system windows such as the task bar and side
|
bars. Note that if the monitor is not the primary display monitor,
|
some of the rectangle's coordinates may be negative values".
|
|
The Rect and AvailableRect properties are used to determine the
|
available surface for rendering popup views.
|
</summary>
|
</member>
|
<member name="T:CefSharp.Structs.Size">
|
<summary>
|
Structure representing a size.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.Size.Width">
|
<summary>
|
Width
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.Size.Height">
|
<summary>
|
Height
|
</summary>
|
</member>
|
<member name="M:CefSharp.Structs.Size.#ctor(System.Int32,System.Int32)">
|
<summary>
|
Size
|
</summary>
|
<param name="width">width</param>
|
<param name="height">height</param>
|
</member>
|
<member name="T:CefSharp.Structs.TouchEvent">
|
<summary>
|
Touch Event
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.TouchEvent.Id">
|
<summary>
|
Id of a touch point. Must be unique per touch, can be any number except -1.
|
Note that a maximum of 16 concurrent touches will be tracked; touches
|
beyond that will be ignored.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.TouchEvent.X">
|
<summary>
|
X coordinate relative to the left side of the view.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.TouchEvent.Y">
|
<summary>
|
Y coordinate relative to the top side of the view.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.TouchEvent.RadiusX">
|
<summary>
|
X radius in pixels. Set to 0 if not applicable.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.TouchEvent.RadiusY">
|
<summary>
|
Y radius in pixels. Set to 0 if not applicable.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.TouchEvent.RotationAngle">
|
<summary>
|
Rotation angle in radians. Set to 0 if not applicable.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.TouchEvent.PointerType">
|
<summary>
|
The device type that caused the event.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.TouchEvent.Pressure">
|
<summary>
|
The normalized pressure of the pointer input in the range of [0,1].
|
Set to 0 if not applicable.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.TouchEvent.Type">
|
<summary>
|
The state of the touch point. Touches begin with one <see cref="F:CefSharp.Enums.TouchEventType.Pressed"/> event
|
followed by zero or more <see cref="F:CefSharp.Enums.TouchEventType.Moved"/> events and finally one
|
<see cref="F:CefSharp.Enums.TouchEventType.Released"/> or <see cref="F:CefSharp.Enums.TouchEventType.Cancelled"/> event.
|
Events not respecting this order will be ignored.
|
</summary>
|
</member>
|
<member name="P:CefSharp.Structs.TouchEvent.Modifiers">
|
<summary>
|
Bit flags describing any pressed modifier keys.
|
</summary>
|
</member>
|
<member name="T:CefSharp.DraggableRegion">
|
<summary>
|
Representing a draggable region.
|
</summary>
|
</member>
|
<member name="P:CefSharp.DraggableRegion.Width">
|
<summary>
|
Width
|
</summary>
|
</member>
|
<member name="P:CefSharp.DraggableRegion.Height">
|
<summary>
|
Height
|
</summary>
|
</member>
|
<member name="P:CefSharp.DraggableRegion.X">
|
<summary>
|
X coordinate
|
</summary>
|
</member>
|
<member name="P:CefSharp.DraggableRegion.Y">
|
<summary>
|
Y coordinate
|
</summary>
|
</member>
|
<member name="P:CefSharp.DraggableRegion.Draggable">
|
<summary>
|
Is this region draggable
|
</summary>
|
</member>
|
<member name="M:CefSharp.DraggableRegion.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)">
|
<summary>
|
Creates a new DraggableRegion
|
</summary>
|
<param name="width">width</param>
|
<param name="height">height</param>
|
<param name="x">x coordinate</param>
|
<param name="y">y coordinate</param>
|
<param name="draggable">is draggable?</param>
|
</member>
|
<member name="T:CefSharp.KeyEvent">
|
<summary>
|
Class representing a a keyboard event.
|
</summary>
|
</member>
|
<member name="P:CefSharp.KeyEvent.Type">
|
<summary>
|
The type of keyboard event.
|
</summary>
|
</member>
|
<member name="P:CefSharp.KeyEvent.Modifiers">
|
<summary>
|
Bit flags describing any pressed modifier keys. See
|
cef_event_flags_t for values.
|
</summary>
|
</member>
|
<member name="P:CefSharp.KeyEvent.WindowsKeyCode">
|
<summary>
|
The Windows key code for the key event. This value is used by the DOM
|
specification. Sometimes it comes directly from the event (i.e. on
|
Windows) and sometimes it's determined using a mapping function. See
|
WebCore/platform/chromium/KeyboardCodes.h for the list of values.
|
</summary>
|
</member>
|
<member name="P:CefSharp.KeyEvent.NativeKeyCode">
|
<summary>
|
The actual key code genenerated by the platform.
|
</summary>
|
</member>
|
<member name="P:CefSharp.KeyEvent.IsSystemKey">
|
<summary>
|
Indicates whether the event is considered a "system key" event (see
|
http://msdn.microsoft.com/en-us/library/ms646286(VS.85).aspx for details).
|
This value will always be false on non-Windows platforms.
|
</summary>
|
</member>
|
<member name="P:CefSharp.KeyEvent.FocusOnEditableField">
|
<summary>
|
True if the focus is currently on an editable field on the page. This is useful for determining if standard key events should be intercepted.
|
</summary>
|
</member>
|
<member name="T:CefSharp.MouseEvent">
|
<summary>
|
Struct representing a mouse event.
|
</summary>
|
</member>
|
<member name="P:CefSharp.MouseEvent.X">
|
<summary>
|
x coordinate - relative to upper-left corner of view
|
</summary>
|
</member>
|
<member name="P:CefSharp.MouseEvent.Y">
|
<summary>
|
y coordinate - relative to upper-left corner of view
|
</summary>
|
</member>
|
<member name="P:CefSharp.MouseEvent.Modifiers">
|
<summary>
|
Bit flags describing any pressed modifier keys.
|
</summary>
|
</member>
|
<member name="M:CefSharp.MouseEvent.#ctor(System.Int32,System.Int32,CefSharp.CefEventFlags)">
|
<summary>
|
Mouse Event
|
</summary>
|
<param name="x">x coordinate relative to the upper-left corner of the view.</param>
|
<param name="y">y coordinate relative to the upper-left corner of the view.</param>
|
<param name="modifiers">modifiers</param>
|
</member>
|
<member name="T:CefSharp.ResolveCallbackResult">
|
<summary>
|
IP Address solution callback result
|
</summary>
|
</member>
|
<member name="P:CefSharp.ResolveCallbackResult.Result">
|
<summary>
|
The result code - <see cref="F:CefSharp.CefErrorCode.None"/> on success
|
</summary>
|
</member>
|
<member name="P:CefSharp.ResolveCallbackResult.ResolvedIpAddresses">
|
<summary>
|
List of resolved IP addresses or empty if the resolution failed.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ResolveCallbackResult.#ctor(CefSharp.CefErrorCode,System.Collections.Generic.IList{System.String})">
|
<summary>
|
ResolveCallbackResult
|
</summary>
|
<param name="result">result</param>
|
<param name="resolvedIpAddresses">list of ip addresses</param>
|
</member>
|
<member name="P:CefSharp.UrlParts.Spec">
|
<summary>
|
The complete URL specification.
|
</summary>
|
</member>
|
<member name="P:CefSharp.UrlParts.Scheme">
|
<summary>
|
Scheme component not including the colon (e.g., "http").
|
</summary>
|
</member>
|
<member name="P:CefSharp.UrlParts.Username">
|
<summary>
|
User name component.
|
</summary>
|
</member>
|
<member name="P:CefSharp.UrlParts.Password">
|
<summary>
|
Password component.
|
</summary>
|
</member>
|
<member name="P:CefSharp.UrlParts.Host">
|
<summary>
|
Host component. This may be a hostname, an IPv4 address or an IPv6 literal
|
surrounded by square brackets (e.g., "[2001:db8::1]").
|
</summary>
|
</member>
|
<member name="P:CefSharp.UrlParts.Port">
|
<summary>
|
Port number component.
|
</summary>
|
</member>
|
<member name="P:CefSharp.UrlParts.Origin">
|
<summary>
|
Origin contains just the scheme, host, and port from a URL. Equivalent to
|
clearing any username and password, replacing the path with a slash, and
|
clearing everything after that. This value will be empty for non-standard
|
URLs.
|
</summary>
|
</member>
|
<member name="P:CefSharp.UrlParts.Path">
|
<summary>
|
Path component including the first slash following the host.
|
</summary>
|
</member>
|
<member name="P:CefSharp.UrlParts.Query">
|
<summary>
|
Query string component (i.e., everything following the '?').
|
</summary>
|
</member>
|
<member name="P:CefSharp.UrlParts.Fragment">
|
<summary>
|
Fragment (hash) identifier component (i.e., the string following the '#').
|
</summary>
|
</member>
|
<member name="T:CefSharp.UrlRequestClient">
|
<summary>
|
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.
|
</summary>
|
</member>
|
<member name="M:CefSharp.UrlRequestClient.CefSharp#IUrlRequestClient#GetAuthCredentials(System.Boolean,System.String,System.Int32,System.String,System.String,CefSharp.IAuthCallback)">
|
<summary>
|
Called on the CEF IO thread when the browser needs credentials from the user.
|
This method will only be called for requests initiated from the browser process.
|
</summary>
|
<param name="isProxy">indicates whether the host is a proxy server.</param>
|
<param name="host">the hostname.</param>
|
<param name="port">the port number.</param>
|
<param name="realm">realm</param>
|
<param name="scheme">scheme</param>
|
<param name="callback">is a callback for authentication information</param>
|
<returns>
|
Return true to continue the request and call <see cref="M:CefSharp.IAuthCallback.Continue(System.String,System.String)"/> when the authentication information is available.
|
If the request has an associated browser/frame then returning false will result in a call to <see cref="M:CefSharp.IRequestHandler.GetAuthCredentials(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,System.Boolean,System.String,System.Int32,System.String,System.String,CefSharp.IAuthCallback)"/>
|
on the <see cref="T:CefSharp.IRequestHandler"/> associated with that browser, if any.
|
Otherwise, returning false will cancel the request immediately.
|
</returns>
|
</member>
|
<member name="M:CefSharp.UrlRequestClient.GetAuthCredentials(System.Boolean,System.String,System.Int32,System.String,System.String,CefSharp.IAuthCallback)">
|
<summary>
|
Called on the CEF IO thread when the browser needs credentials from the user.
|
This method will only be called for requests initiated from the browser process.
|
</summary>
|
<param name="isProxy">indicates whether the host is a proxy server.</param>
|
<param name="host">the hostname.</param>
|
<param name="port">the port number.</param>
|
<param name="realm">realm</param>
|
<param name="scheme">scheme</param>
|
<param name="callback">is a callback for authentication information</param>
|
<returns>
|
Return true to continue the request and call <see cref="M:CefSharp.IAuthCallback.Continue(System.String,System.String)"/> when the authentication information is available.
|
If the request has an associated browser/frame then returning false will result in a call to <see cref="M:CefSharp.IRequestHandler.GetAuthCredentials(CefSharp.IWebBrowser,CefSharp.IBrowser,System.String,System.Boolean,System.String,System.Int32,System.String,System.String,CefSharp.IAuthCallback)"/>
|
on the <see cref="T:CefSharp.IRequestHandler"/> associated with that browser, if any.
|
Otherwise, returning false will cancel the request immediately.
|
</returns>
|
</member>
|
<member name="M:CefSharp.UrlRequestClient.CefSharp#IUrlRequestClient#OnDownloadData(CefSharp.IUrlRequest,System.IO.Stream)">
|
<summary>
|
Called when some part of the response is read. This method will not be called if the <see cref="F:CefSharp.UrlRequestFlags.NoDownloadData"/> flag is set on the request.
|
</summary>
|
<param name="request">request</param>
|
<param name="data">A stream containing the bytes received since the last call. Cannot be used outside the scope of this method. </param>
|
</member>
|
<member name="M:CefSharp.UrlRequestClient.OnDownloadData(CefSharp.IUrlRequest,System.IO.Stream)">
|
<summary>
|
Called when some part of the response is read. This method will not be called if the <see cref="F:CefSharp.UrlRequestFlags.NoDownloadData"/> flag is set on the request.
|
</summary>
|
<param name="request">request</param>
|
<param name="data">A stream containing the bytes received since the last call. Cannot be used outside the scope of this method. </param>
|
</member>
|
<member name="M:CefSharp.UrlRequestClient.CefSharp#IUrlRequestClient#OnDownloadProgress(CefSharp.IUrlRequest,System.Int64,System.Int64)">
|
<summary>
|
Notifies the client of download progress.
|
</summary>
|
<param name="request">request</param>
|
<param name="current">denotes the number of bytes received up to the call </param>
|
<param name="total">is the expected total size of the response (or -1 if not determined).</param>
|
</member>
|
<member name="M:CefSharp.UrlRequestClient.OnDownloadProgress(CefSharp.IUrlRequest,System.Int64,System.Int64)">
|
<summary>
|
Notifies the client of download progress.
|
</summary>
|
<param name="request">request</param>
|
<param name="current">denotes the number of bytes received up to the call </param>
|
<param name="total">is the expected total size of the response (or -1 if not determined).</param>
|
</member>
|
<member name="M:CefSharp.UrlRequestClient.CefSharp#IUrlRequestClient#OnRequestComplete(CefSharp.IUrlRequest)">
|
<summary>
|
Notifies the client that the request has completed.
|
Use the <see cref="P:CefSharp.IUrlRequest.RequestStatus"/> property to determine if the
|
request was successful or not.
|
</summary>
|
<param name="request">request</param>
|
</member>
|
<member name="M:CefSharp.UrlRequestClient.OnRequestComplete(CefSharp.IUrlRequest)">
|
<summary>
|
Notifies the client that the request has completed.
|
Use the <see cref="P:CefSharp.IUrlRequest.RequestStatus"/> property to determine if the
|
request was successful or not.
|
</summary>
|
<param name="request">request</param>
|
</member>
|
<member name="M:CefSharp.UrlRequestClient.CefSharp#IUrlRequestClient#OnUploadProgress(CefSharp.IUrlRequest,System.Int64,System.Int64)">
|
<summary>
|
Notifies the client of upload progress.
|
This method will only be called if the UR_FLAG_REPORT_UPLOAD_PROGRESS flag is set on the request.
|
</summary>
|
<param name="request">request</param>
|
<param name="current">denotes the number of bytes sent so far.</param>
|
<param name="total">is the total size of uploading data (or -1 if chunked upload is enabled).</param>
|
</member>
|
<member name="M:CefSharp.UrlRequestClient.OnUploadProgress(CefSharp.IUrlRequest,System.Int64,System.Int64)">
|
<summary>
|
Notifies the client of upload progress.
|
This method will only be called if the UR_FLAG_REPORT_UPLOAD_PROGRESS flag is set on the request.
|
</summary>
|
<param name="request">request</param>
|
<param name="current">denotes the number of bytes sent so far.</param>
|
<param name="total">is the total size of uploading data (or -1 if chunked upload is enabled).</param>
|
</member>
|
<member name="T:CefSharp.ICookieVisitor">
|
<summary>
|
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.
|
</summary>
|
</member>
|
<member name="M:CefSharp.ICookieVisitor.Visit(CefSharp.Cookie,System.Int32,System.Int32,System.Boolean@)">
|
<summary>
|
Method that will be called once for each cookie. This method may never be called if no cookies are found.
|
</summary>
|
<param name="cookie">cookie</param>
|
<param name="count">is the 0-based index for the current cookie.</param>
|
<param name="total">is the total number of cookies.</param>
|
<param name="deleteCookie">Set to true to delete the cookie currently being visited.</param>
|
<returns>Return false to stop visiting cookies otherwise true</returns>
|
</member>
|
<member name="T:CefSharp.INavigationEntryVisitor">
|
<summary>
|
Callback interface for IBrowserHost.GetNavigationEntries.
|
The methods of this class will be called on the CEF UI thread.
|
</summary>
|
</member>
|
<member name="M:CefSharp.INavigationEntryVisitor.Visit(CefSharp.NavigationEntry,System.Boolean,System.Int32,System.Int32)">
|
<summary>
|
Method that will be executed.
|
</summary>
|
<param name="entry">if the navigationEntry will be invalid then </param>
|
<param name="current">is true if this entry is the currently loaded navigation entry</param>
|
<param name="index">is the 0-based index of this entry</param>
|
<param name="total">is the total number of entries.</param>
|
<returns>Return true to continue visiting entries or false to stop.</returns>
|
</member>
|
<member name="T:CefSharp.IStringVisitor">
|
<summary>
|
Implement this interface to receive string values asynchronously.
|
</summary>
|
</member>
|
<member name="M:CefSharp.IStringVisitor.Visit(System.String)">
|
<summary>
|
Method that will be executed.
|
</summary>
|
<param name="str">string (result of async execution)</param>
|
</member>
|
<member name="T:CefSharp.TaskCookieVisitor">
|
<summary>
|
Cookie Visitor implementation that uses a TaskCompletionSource
|
to return a List of cookies
|
</summary>
|
</member>
|
<member name="M:CefSharp.TaskCookieVisitor.#ctor">
|
<summary>
|
Initializes a new instance of the TaskCookieVisitor class.
|
</summary>
|
</member>
|
<member name="M:CefSharp.TaskCookieVisitor.CefSharp#ICookieVisitor#Visit(CefSharp.Cookie,System.Int32,System.Int32,System.Boolean@)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.TaskCookieVisitor.System#IDisposable#Dispose">
|
<inheritdoc/>
|
</member>
|
<member name="P:CefSharp.TaskCookieVisitor.Task">
|
<summary>
|
Task that can be awaited for the result to be retrieved async
|
</summary>
|
</member>
|
<member name="T:CefSharp.TaskNavigationEntryVisitor">
|
<summary>
|
A <see cref="T:CefSharp.INavigationEntryVisitor"/> implementation that uses a <see cref="T:System.Threading.Tasks.TaskCompletionSource`1"/>
|
that allows you to call await/ContinueWith to get the list of NavigationEntries
|
</summary>
|
</member>
|
<member name="M:CefSharp.TaskNavigationEntryVisitor.#ctor">
|
<summary>
|
Initializes a new instance of the TaskNavigationEntryVisitor class.
|
</summary>
|
</member>
|
<member name="M:CefSharp.TaskNavigationEntryVisitor.CefSharp#INavigationEntryVisitor#Visit(CefSharp.NavigationEntry,System.Boolean,System.Int32,System.Int32)">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.TaskNavigationEntryVisitor.System#IDisposable#Dispose">
|
<inheritdoc/>
|
</member>
|
<member name="P:CefSharp.TaskNavigationEntryVisitor.Task">
|
<summary>
|
Task that can be awaited for the result to be retrieved async
|
</summary>
|
</member>
|
<member name="T:CefSharp.TaskStringVisitor">
|
<summary>
|
A <see cref="T:CefSharp.IStringVisitor"/> that uses a <see cref="T:System.Threading.Tasks.TaskCompletionSource`1"/>
|
that allows you to call await/ContinueWith to get the result string.
|
</summary>
|
</member>
|
<member name="M:CefSharp.TaskStringVisitor.#ctor">
|
<summary>
|
Initializes a new instance of the TaskStringVisitor class.
|
</summary>
|
</member>
|
<member name="M:CefSharp.TaskStringVisitor.CefSharp#IStringVisitor#Visit(System.String)">
|
<summary>
|
Method that will be executed.
|
</summary>
|
<param name="str">string (result of async execution)</param>
|
</member>
|
<member name="P:CefSharp.TaskStringVisitor.Task">
|
<summary>
|
Task that can be awaited for the result to be retrieved async
|
</summary>
|
</member>
|
<member name="T:CefSharp.WaitForNavigationAsyncResponse">
|
<summary>
|
WaitForNavigationAsyncResponse
|
</summary>
|
</member>
|
<member name="P:CefSharp.WaitForNavigationAsyncResponse.ErrorCode">
|
<summary>
|
Error Code. If the network request was made successfully this value will be <see cref="F:CefSharp.CefErrorCode.None"/>
|
(no error occured)
|
</summary>
|
</member>
|
<member name="P:CefSharp.WaitForNavigationAsyncResponse.HttpStatusCode">
|
<summary>
|
Http Status Code. If <see cref="P:CefSharp.WaitForNavigationAsyncResponse.ErrorCode"/> is not equal to <see cref="F:CefSharp.CefErrorCode.None"/>
|
then this value will be -1.
|
</summary>
|
</member>
|
<member name="P:CefSharp.WaitForNavigationAsyncResponse.Success">
|
<summary>
|
If <see cref="P:CefSharp.WaitForNavigationAsyncResponse.ErrorCode"/> is equal to <see cref="F:CefSharp.CefErrorCode.None"/> and
|
<see cref="P:CefSharp.WaitForNavigationAsyncResponse.HttpStatusCode"/> is equal to 200 (OK) then the main frame loaded without
|
critical error.
|
</summary>
|
</member>
|
<member name="M:CefSharp.WaitForNavigationAsyncResponse.#ctor(CefSharp.CefErrorCode,System.Int32)">
|
<summary>
|
Initializes a new instance of the WaitForNavigationAsyncResponse class.
|
</summary>
|
<param name="errorCode">CEF Error Code</param>
|
<param name="httpStatusCode">Http Status Code</param>
|
</member>
|
<member name="T:CefSharp.WaitForSelectorAsyncResponse">
|
<summary>
|
WaitForSelectorAsyncResponse
|
</summary>
|
</member>
|
<member name="P:CefSharp.WaitForSelectorAsyncResponse.ElementId">
|
<summary>
|
Element Id
|
</summary>
|
</member>
|
<member name="P:CefSharp.WaitForSelectorAsyncResponse.TagName">
|
<summary>
|
Tag Name
|
</summary>
|
</member>
|
<member name="P:CefSharp.WaitForSelectorAsyncResponse.Success">
|
<summary>
|
True if the javascript was executed successfully
|
</summary>
|
</member>
|
<member name="P:CefSharp.WaitForSelectorAsyncResponse.ErrorMessage">
|
<summary>
|
Error Message
|
</summary>
|
</member>
|
<member name="P:CefSharp.WaitForSelectorAsyncResponse.ElementAdded">
|
<summary>
|
True if the element was added to the DOM otherwise false if it was removed
|
</summary>
|
</member>
|
<member name="T:CefSharp.WebBrowserExtensions">
|
<summary>
|
WebBrowser extensions - These methods make performing common tasks easier.
|
</summary>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.RegisterJsObject(CefSharp.IWebBrowser,System.String,System.Object,CefSharp.BindingOptions)">
|
<summary>
|
Registers a Javascript object in this specific browser instance.
|
</summary>
|
<param name="webBrowser">The browser to perform the registering on.</param>
|
<param name="name">The name of the object. (e.g. "foo", if you want the object to be accessible as window.foo).</param>
|
<param name="objectToBind">The object to be made accessible to Javascript.</param>
|
<param name="options">(Optional) binding options - camelCaseJavascriptNames default to true.</param>
|
<exception cref="T:System.Exception">Browser is already initialized. RegisterJsObject must be +
|
called before the underlying CEF browser is created.</exception>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.RegisterAsyncJsObject(CefSharp.IWebBrowser,System.String,System.Object,CefSharp.BindingOptions)">
|
<summary>
|
<para>Asynchronously registers a Javascript object in this specific browser instance.</para>
|
<para>Only methods of the object will be availabe.</para>
|
</summary>
|
<param name="webBrowser">The browser to perform the registering on</param>
|
<param name="name">The name of the object. (e.g. "foo", if you want the object to be accessible as window.foo).</param>
|
<param name="objectToBind">The object to be made accessible to Javascript.</param>
|
<param name="options">binding options - camelCaseJavascriptNames default to true </param>
|
<exception cref="T:System.Exception">Browser is already initialized. RegisterJsObject must be +
|
called before the underlying CEF browser is created.</exception>
|
<remarks>The registered methods can only be called in an async way, they will all return immediately and the resulting
|
object will be a standard javascript Promise object which is usable to wait for completion or failure.</remarks>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.GetMainFrame(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Returns the main (top-level) frame for the browser window.
|
</summary>
|
<param name="browser">the ChromiumWebBrowser instance.</param>
|
<returns> the main frame. </returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.GetFocusedFrame(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Returns the focused frame for the browser window.
|
</summary>
|
<param name="browser">the ChromiumWebBrowser instance.</param>
|
<returns>the focused frame.</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Undo(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Execute Undo on the focused frame.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Undo(CefSharp.IBrowser)">
|
<summary>
|
Execute Undo on the focused frame.
|
</summary>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Redo(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Execute Redo on the focused frame.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Redo(CefSharp.IBrowser)">
|
<summary>
|
Execute Redo on the focused frame.
|
</summary>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Cut(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Execute Cut on the focused frame.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Cut(CefSharp.IBrowser)">
|
<summary>
|
Execute Cut on the focused frame.
|
</summary>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Copy(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Execute Copy on the focused frame.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Copy(CefSharp.IBrowser)">
|
<summary>
|
Execute Copy on the focused frame.
|
</summary>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Paste(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Execute Paste on the focused frame.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Paste(CefSharp.IBrowser)">
|
<summary>
|
Execute Paste on the focused frame.
|
</summary>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Delete(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Execute Delete on the focused frame.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Delete(CefSharp.IBrowser)">
|
<summary>
|
Execute Delete on the focused frame.
|
</summary>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.SelectAll(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Execute SelectAll on the focused frame.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.SelectAll(CefSharp.IBrowser)">
|
<summary>
|
Execute SelectAll on the focused frame.
|
</summary>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.ViewSource(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Opens up a new program window (using the default text editor) where the source code of the currently displayed web page is
|
shown.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.ViewSource(CefSharp.IBrowser)">
|
<summary>
|
Opens up a new program window (using the default text editor) where the source code of the currently displayed web page is
|
shown.
|
</summary>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.GetSourceAsync(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Retrieve the main frame's HTML source using a <see cref="T:System.Threading.Tasks.Task`1"/>.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<returns>
|
<see cref="T:System.Threading.Tasks.Task`1"/> that when executed returns the main frame source as a string.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.GetSourceAsync(CefSharp.IBrowser)">
|
<summary>
|
Retrieve the main frame's HTML source using a <see cref="T:System.Threading.Tasks.Task`1"/>.
|
</summary>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
<returns>
|
<see cref="T:System.Threading.Tasks.Task`1"/> that when executed returns the main frame source as a string.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.GetTextAsync(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Retrieve the main frame's display text using a <see cref="T:System.Threading.Tasks.Task`1"/>.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<returns>
|
<see cref="T:System.Threading.Tasks.Task`1"/> that when executed returns the main frame display text as a string.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.GetTextAsync(CefSharp.IBrowser)">
|
<summary>
|
Retrieve the main frame's display text using a <see cref="T:System.Threading.Tasks.Task`1"/>.
|
</summary>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
<returns>
|
<see cref="T:System.Threading.Tasks.Task`1"/> that when executed returns the main frame display text as a string.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.StartDownload(CefSharp.IChromiumWebBrowserBase,System.String)">
|
<summary>
|
Download the file at url using <see cref="T:CefSharp.IDownloadHandler"/>.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="url">url to download</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.StartDownload(CefSharp.IBrowser,System.String)">
|
<summary>
|
Download the file at url using <see cref="T:CefSharp.IDownloadHandler"/>.
|
</summary>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
<param name="url">url to download</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.LoadUrlAsync(CefSharp.IChromiumWebBrowserBase,System.String)">
|
<summary>
|
See <see cref="M:CefSharp.IChromiumWebBrowserBase.LoadUrlAsync(System.String)"/> for details
|
</summary>
|
<param name="chromiumWebBrowser">ChromiumWebBrowser instance (cannot be null)</param>
|
<summary>
|
Load the <paramref name="url"/> in the main frame of the browser
|
</summary>
|
<param name="url">url to load</param>
|
<returns>See <see cref="M:CefSharp.IChromiumWebBrowserBase.LoadUrlAsync(System.String)"/> for details</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.WaitForNavigationAsync(CefSharp.IChromiumWebBrowserBase,System.Nullable{System.TimeSpan},System.Threading.CancellationToken)">
|
<summary>
|
This resolves when the browser navigates to a new URL or reloads.
|
It is useful for when you run code which will indirectly cause the browser to navigate.
|
A common use case would be when executing javascript that results in a navigation. e.g. clicks a link
|
This must be called before executing the action that navigates the browser. It may not resolve correctly
|
if called after.
|
</summary>
|
<remarks>
|
Usage of the <c>History API</c> <see href="https://developer.mozilla.org/en-US/docs/Web/API/History_API"/> to change the URL is considered a navigation
|
</remarks>
|
<param name="chromiumWebBrowser">ChromiumWebBrowser instance (cannot be null)</param>
|
<param name="timeout">optional timeout, if not specified defaults to five(5) seconds.</param>
|
<param name="cancellationToken">optional CancellationToken</param>
|
<returns>Task which resolves when <see cref="E:CefSharp.IChromiumWebBrowserBase.LoadingStateChanged"/> has been called with <see cref="P:CefSharp.LoadingStateChangedEventArgs.IsLoading"/> false.
|
or when <see cref="E:CefSharp.IChromiumWebBrowserBase.LoadError"/> is called to signify a load failure.
|
</returns>
|
<example>
|
<code>
|
<![CDATA[
|
string script = "document.getElementsByTagName('a')[0].click();";
|
await Task.WhenAll(
|
chromiumWebBrowser.WaitForNavigationAsync(),
|
chromiumWebBrowser.EvaluateScriptAsync(script));
|
]]>
|
</code>
|
</example>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.WaitForSelectorAsync(CefSharp.IWebBrowser,System.String,System.Nullable{System.TimeSpan},System.Boolean)">
|
<summary>
|
Waits for a DOM element specified by the <paramref name="selector"/> string to be added to or removed from the DOM.
|
A simplified version of Puppeteer WaitForSelector. Uses a MutationObserver to wait for the element to become added or removed.
|
</summary>
|
<param name="chromiumWebBrowser">ChromiumWebBrowser instance (cannot be null)</param>
|
<param name="selector">querySelector for the element e.g. #idOfMyElement</param>
|
<param name="timeout">timeout</param>
|
<param name="removed">
|
(Optional) if true waits for element to be removed from the DOM. If the querySelector immediately resolves
|
to null then the element is considered removed. If false (default) waits for the element to be added to the DOM.
|
</param>
|
<returns>A Task that resolves when element specified by selector string is added to or removed from the DOM.</returns>
|
<example>
|
<code>
|
<![CDATA[
|
string script = "const newDiv = document.createElement('div'); newDiv.id = 'myElement'; document.body.append(newDiv);";
|
await Task.WhenAll(
|
browser.WaitForSelectorAsync("#myElement");,
|
chromiumWebBrowser.EvaluateScriptAsync(script));
|
]]>
|
</code>
|
</example>
|
<remarks>
|
This function is typically used in conjunction with javascript that directly or indirectly adds/removes an element from the DOM.
|
Unlike the puppeteer version navigations aren't handled internally, the method will throw a <see cref="T:System.TimeoutException"/> if a navigation
|
occurs whilst waiting to resolve.
|
</remarks>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.ExecuteScriptAsync(CefSharp.IChromiumWebBrowserBase,System.String,System.Object[])">
|
<summary>
|
Execute Javascript code in the context of this Browser. As the method name implies, the script will be executed
|
asynchronously, and the method therefore returns before the script has actually been executed. This simple helper extension
|
will encapsulate params in single quotes (unless int, uint, etc)
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="methodName">The javascript method name to execute.</param>
|
<param name="args">the arguments to be passed as params to the method. Args are encoded using
|
<see cref="P:CefSharp.WebBrowserExtensions.EncodeScriptParam"/>, you can provide a custom implementation if you require one.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.ExecuteScriptAsync(CefSharp.IBrowser,System.String,System.Object[])">
|
<summary>
|
Execute Javascript code in the context of this WebBrowser. As the method name implies, the script will be executed
|
asynchronously, and the method therefore returns before the script has actually been executed. This simple helper extension
|
will encapsulate params in single quotes (unless int, uint, etc)
|
</summary>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
<param name="methodName">The javascript method name to execute.</param>
|
<param name="args">the arguments to be passed as params to the method. Args are encoded using
|
<see cref="P:CefSharp.WebBrowserExtensions.EncodeScriptParam"/>, you can provide a custom implementation if you require one.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.ExecuteScriptAsync(CefSharp.IChromiumWebBrowserBase,System.String)">
|
<summary>
|
Execute Javascript in the context of this Browsers Main Frame. As the method name implies, the script will be executed
|
asynchronously, and the method therefore returns before the script has actually been executed.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="script">The Javascript code that should be executed.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.ExecuteScriptAsync(CefSharp.IBrowser,System.String)">
|
<summary>
|
Execute Javascript in the context of this Browser Main Frame. As the method name implies, the script will be executed
|
asynchronously, and the method therefore returns before the script has actually been executed.
|
</summary>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
<param name="script">The Javascript code that should be executed.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.ExecuteScriptAsyncWhenPageLoaded(CefSharp.IChromiumWebBrowserBase,System.String,System.Boolean)">
|
<summary>
|
Execute Javascript code in the context of this Browsers Main Frame. This extension method uses the LoadingStateChanged event. As the
|
method name implies, the script will be executed asynchronously, and the method therefore returns before the script has
|
actually been executed.
|
</summary>
|
<remarks>
|
Best effort is made to make sure the script is executed, there are likely a few edge cases where the script won't be executed,
|
if you suspect your script isn't being executed, then try executing in the LoadingStateChanged event handler to confirm that
|
it does indeed get executed.
|
</remarks>
|
<param name="webBrowser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="script">The Javascript code that should be executed.</param>
|
<param name="oneTime">(Optional) The script will only be executed on first page load, subsequent page loads will be ignored.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.LoadUrlWithPostData(CefSharp.IChromiumWebBrowserBase,System.String,System.Byte[],System.String)">
|
<summary>
|
Creates a new instance of IRequest with the specified Url and Method = POST and then calls
|
<see cref="M:CefSharp.IFrame.LoadRequest(CefSharp.IRequest)"/>.
|
</summary>
|
<param name="browser">browser this method extends</param>
|
<param name="url">url to load</param>
|
<param name="postDataBytes">post data as byte array</param>
|
<param name="contentType">(Optional) if set the Content-Type header will be set</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.LoadUrlWithPostData(CefSharp.IBrowser,System.String,System.Byte[],System.String)">
|
<summary>
|
Creates a new instance of IRequest with the specified Url and Method = POST and then calls
|
<see cref="M:CefSharp.IFrame.LoadRequest(CefSharp.IRequest)"/>.
|
</summary>
|
<param name="browser">browser this method extends</param>
|
<param name="url">url to load</param>
|
<param name="postDataBytes">post data as byte array</param>
|
<param name="contentType">(Optional) if set the Content-Type header will be set</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.LoadHtml(CefSharp.IWebBrowser,System.String,System.String)">
|
<summary>
|
Registers and loads a <see cref="T:CefSharp.ResourceHandler"/> that represents the HTML content.
|
</summary>
|
<remarks>
|
`Cef` Native `LoadHtml` is unpredictable and only works sometimes, this method wraps the provided HTML in a
|
<see cref="T:CefSharp.ResourceHandler"/> and loads the provided url using the <see cref="M:CefSharp.IWebBrowser.Load(System.String)"/> method. Defaults to using
|
<see cref="P:System.Text.Encoding.UTF8"/> for character encoding The url must start with a valid schema, other uri's such as about:blank
|
are invalid A valid example looks like http://test/page.
|
</remarks>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="html">The HTML content.</param>
|
<param name="url">The URL that will be treated as the address of the content.</param>
|
<returns>
|
returns false if the Url was not successfully parsed into a Uri.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.LoadHtml(CefSharp.IChromiumWebBrowserBase,System.String,System.Boolean)">
|
<summary>
|
Loads html as Data Uri See https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs for details If
|
base64Encode is false then html will be Uri encoded.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="html">Html to load as data uri.</param>
|
<param name="base64Encode">(Optional) if true the html string will be base64 encoded using UTF8 encoding.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.LoadHtml(CefSharp.IFrame,System.String,System.Boolean)">
|
<summary>
|
Loads html as Data Uri See https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs for details If
|
base64Encode is false then html will be Uri encoded.
|
</summary>
|
<param name="frame">The <seealso cref="T:CefSharp.IFrame"/> instance this method extends.</param>
|
<param name="html">Html to load as data uri.</param>
|
<param name="base64Encode">(Optional) if true the html string will be base64 encoded using UTF8 encoding.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.LoadHtml(CefSharp.IWebBrowser,System.String,System.String,System.Text.Encoding,System.Boolean)">
|
<summary>
|
Registers and loads a <see cref="T:CefSharp.ResourceHandler"/> that represents the HTML content.
|
</summary>
|
<remarks>
|
`Cef` Native `LoadHtml` is unpredictable and only works sometimes, this method wraps the provided HTML in a
|
<see cref="T:CefSharp.ResourceHandler"/> and loads the provided url using the <see cref="M:CefSharp.IWebBrowser.Load(System.String)"/> method.
|
</remarks>
|
<exception cref="T:System.Exception">Thrown when an exception error condition occurs.</exception>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="html">The HTML content.</param>
|
<param name="url">The URL that will be treated as the address of the content.</param>
|
<param name="encoding">Character Encoding.</param>
|
<param name="oneTimeUse">(Optional) Whether or not the handler should be used once (true) or until manually unregistered
|
(false)</param>
|
<returns>
|
returns false if the Url was not successfully parsed into a Uri.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.RegisterResourceHandler(CefSharp.IWebBrowser,System.String,System.IO.Stream,System.String,System.Boolean)">
|
<summary>
|
Register a ResourceHandler. Can only be used when browser.ResourceHandlerFactory is an instance of
|
DefaultResourceHandlerFactory.
|
</summary>
|
<exception cref="T:System.Exception">Thrown when an exception error condition occurs.</exception>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="url">the url of the resource to unregister.</param>
|
<param name="stream">Stream to be registered, the stream should not be shared with any other instances of
|
DefaultResourceHandlerFactory.</param>
|
<param name="mimeType">(Optional) the mimeType.</param>
|
<param name="oneTimeUse">(Optional) Whether or not the handler should be used once (true) or until manually unregistered
|
(false). If true the Stream will be Diposed of when finished.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.UnRegisterResourceHandler(CefSharp.IWebBrowser,System.String)">
|
<summary>
|
Unregister a ResourceHandler. Can only be used when browser.ResourceHandlerFactory is an instance of
|
DefaultResourceHandlerFactory.
|
</summary>
|
<exception cref="T:System.Exception">Thrown when an exception error condition occurs.</exception>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="url">the url of the resource to unregister.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Stop(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Stops loading the current page.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Stop(CefSharp.IBrowser)">
|
<summary>
|
Stops loading the current page.
|
</summary>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Back(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Navigates back, must check <see cref="P:CefSharp.IChromiumWebBrowserBase.CanGoBack"/> before calling this method.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Back(CefSharp.IBrowser)">
|
<summary>
|
Navigates back, must check <see cref="P:CefSharp.IBrowser.CanGoBack"/> before calling this method.
|
</summary>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Forward(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Navigates forward, must check <see cref="P:CefSharp.IChromiumWebBrowserBase.CanGoForward"/> before calling this method.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Forward(CefSharp.IBrowser)">
|
<summary>
|
Navigates forward, must check <see cref="P:CefSharp.IBrowser.CanGoForward"/> before calling this method.
|
</summary>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Reload(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Reloads the page being displayed. This method will use data from the browser's cache, if available.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Reload(CefSharp.IChromiumWebBrowserBase,System.Boolean)">
|
<summary>
|
Reloads the page being displayed, optionally ignoring the cache (which means the whole page including all .css, .js etc.
|
resources will be re-fetched).
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="ignoreCache"><c>true</c> A reload is performed ignoring browser cache; <c>false</c> A reload is performed using
|
files from the browser cache, if available.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Reload(CefSharp.IBrowser,System.Boolean)">
|
<summary>
|
Reloads the page being displayed, optionally ignoring the cache (which means the whole page including all .css, .js etc.
|
resources will be re-fetched).
|
</summary>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
<param name="ignoreCache"><c>true</c> A reload is performed ignoring browser cache; <c>false</c> A reload is performed using
|
files from the browser cache, if available.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.GetCookieManager(CefSharp.IChromiumWebBrowserBase,CefSharp.ICompletionCallback)">
|
<summary>
|
Gets the default cookie manager associated with the <see cref="T:CefSharp.IChromiumWebBrowserBase"/> instance.
|
</summary>
|
<exception cref="T:System.Exception">Thrown when an exception error condition occurs.</exception>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="callback">(Optional) If not null it will be executed asynchronously on the CEF IO thread after the manager's
|
storage has been initialized.</param>
|
<returns>
|
Cookie Manager.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.GetRequestContext(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Gets the RequestContext associated with the <see cref="T:CefSharp.IChromiumWebBrowserBase"/> instance.
|
</summary>
|
<exception cref="T:System.Exception">Thrown when an exception error condition occurs.</exception>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<returns>
|
RequestContext
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.GetZoomLevelAsync(CefSharp.IBrowser)">
|
<summary>
|
Asynchronously gets the current Zoom Level.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<returns>
|
An asynchronous result that yields the zoom level.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.GetZoomLevelAsync(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Asynchronously gets the current Zoom Level.
|
</summary>
|
<param name="browser">the ChromiumWebBrowser instance.</param>
|
<returns>
|
An asynchronous result that yields the zoom level.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.SetZoomLevel(CefSharp.IBrowser,System.Double)">
|
<summary>
|
Change the ZoomLevel to the specified value. Can be set to 0.0 to clear the zoom level.
|
</summary>
|
<remarks>
|
If called on the CEF UI thread the change will be applied immediately. Otherwise, the change will be applied asynchronously
|
on the CEF UI thread. The CEF UI thread is different to the WPF/WinForms UI Thread.
|
</remarks>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="zoomLevel">zoom level.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.SetZoomLevel(CefSharp.IChromiumWebBrowserBase,System.Double)">
|
<summary>
|
Change the ZoomLevel to the specified value. Can be set to 0.0 to clear the zoom level.
|
</summary>
|
<remarks>
|
If called on the CEF UI thread the change will be applied immediately. Otherwise, the change will be applied asynchronously
|
on the CEF UI thread. The CEF UI thread is different to the WPF/WinForms UI Thread.
|
</remarks>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="zoomLevel">zoom level.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Find(CefSharp.IBrowser,System.String,System.Boolean,System.Boolean,System.Boolean)">
|
<summary>
|
Search for text within the current page.
|
</summary>
|
<param name="browser">The <see cref="T:CefSharp.IBrowser"/> instance this method extends.</param>
|
<param name="searchText">text to search for</param>
|
<param name="forward">indicates whether to search forward or backward within the page</param>
|
<param name="matchCase">indicates whether the search should be case-sensitive</param>
|
<param name="findNext">indicates whether this is the first request or a follow-up</param>
|
<remarks>The <see cref="T:CefSharp.IFindHandler"/> instance, if any, will be called to report find results.</remarks>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Find(CefSharp.IChromiumWebBrowserBase,System.String,System.Boolean,System.Boolean,System.Boolean)">
|
<summary>
|
Search for text within the current page.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="searchText">text to search for</param>
|
<param name="forward">indicates whether to search forward or backward within the page</param>
|
<param name="matchCase">indicates whether the search should be case-sensitive</param>
|
<param name="findNext">indicates whether this is the first request or a follow-up</param>
|
<remarks>The <see cref="T:CefSharp.IFindHandler"/> instance, if any, will be called to report find results.</remarks>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.StopFinding(CefSharp.IBrowser,System.Boolean)">
|
<summary>
|
Cancel all searches that are currently going on.
|
</summary>
|
<param name="browser">The <see cref="T:CefSharp.IBrowser"/> instance this method extends.</param>
|
<param name="clearSelection">clear the current search selection.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.StopFinding(CefSharp.IChromiumWebBrowserBase,System.Boolean)">
|
<summary>
|
Cancel all searches that are currently going on.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="clearSelection">clear the current search selection.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Print(CefSharp.IBrowser)">
|
<summary>
|
Opens a Print Dialog which if used (can be user cancelled) will print the browser contents.
|
</summary>
|
<param name="browser">The browser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.Print(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Opens a Print Dialog which if used (can be user cancelled) will print the browser contents.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.PrintToPdfAsync(CefSharp.IBrowser,System.String,CefSharp.PdfPrintSettings)">
|
<summary>
|
Asynchronously prints the current browser contents to the PDF file specified. The caller is responsible for deleting the file
|
when done.
|
</summary>
|
<param name="browser">The <see cref="T:CefSharp.IBrowser"/> object this method extends.</param>
|
<param name="path">Output file location.</param>
|
<param name="settings">(Optional) Print Settings.</param>
|
<returns>
|
A task that represents the asynchronous print operation. The result is true on success or false on failure to generate the
|
Pdf.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.PrintToPdfAsync(CefSharp.IChromiumWebBrowserBase,System.String,CefSharp.PdfPrintSettings)">
|
<summary>
|
Asynchronously prints the current browser contents to the PDF file specified. The caller is responsible for deleting the file
|
when done.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="path">Output file location.</param>
|
<param name="settings">(Optional) Print Settings.</param>
|
<returns>
|
A task that represents the asynchronous print operation. The result is true on success or false on failure to generate the
|
Pdf.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.ShowDevTools(CefSharp.IBrowser,CefSharp.IWindowInfo,System.Int32,System.Int32)">
|
<summary>
|
Open developer tools in its own window.
|
</summary>
|
<param name="browser">The <see cref="T:CefSharp.IBrowser"/> instance this method extends.</param>
|
<param name="windowInfo">(Optional) window info used for showing dev tools.</param>
|
<param name="inspectElementAtX">(Optional) x coordinate (used for inspectElement)</param>
|
<param name="inspectElementAtY">(Optional) y coordinate (used for inspectElement)</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.ShowDevTools(CefSharp.IChromiumWebBrowserBase,CefSharp.IWindowInfo,System.Int32,System.Int32)">
|
<summary>
|
Open developer tools in its own window.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="windowInfo">(Optional) window info used for showing dev tools.</param>
|
<param name="inspectElementAtX">(Optional) x coordinate (used for inspectElement)</param>
|
<param name="inspectElementAtY">(Optional) y coordinate (used for inspectElement)</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.CloseDevTools(CefSharp.IBrowser)">
|
<summary>
|
Explicitly close the developer tools window if one exists for this browser instance.
|
</summary>
|
<param name="browser">The <see cref="T:CefSharp.IBrowser"/> instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.CloseDevTools(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Explicitly close the developer tools window if one exists for this browser instance.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.ReplaceMisspelling(CefSharp.IBrowser,System.String)">
|
<summary>
|
If a misspelled word is currently selected in an editable node calling this method will replace it with the specified word.
|
</summary>
|
<param name="browser">The <see cref="T:CefSharp.IBrowser"/> instance this method extends.</param>
|
<param name="word">The new word that will replace the currently selected word.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.ReplaceMisspelling(CefSharp.IChromiumWebBrowserBase,System.String)">
|
<summary>
|
If a misspelled word is currently selected in an editable node calling this method will replace it with the specified word.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="word">The new word that will replace the currently selected word.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.AddWordToDictionary(CefSharp.IBrowser,System.String)">
|
<summary>
|
Add the specified word to the spelling dictionary.
|
</summary>
|
<param name="browser">The <see cref="T:CefSharp.IBrowser"/> instance this method extends.</param>
|
<param name="word">The new word that will be added to the dictionary.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.AddWordToDictionary(CefSharp.IChromiumWebBrowserBase,System.String)">
|
<summary>
|
Add the specified word to the spelling dictionary.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="word">The new word that will be added to the dictionary.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.GetBrowserHost(CefSharp.IChromiumWebBrowserBase)">
|
<summary>
|
Shortcut method to get the browser IBrowserHost.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<returns>
|
browserHost or null.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.SendMouseWheelEvent(CefSharp.IChromiumWebBrowserBase,System.Int32,System.Int32,System.Int32,System.Int32,CefSharp.CefEventFlags)">
|
<summary>
|
Send a mouse wheel event to the browser.
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="x">The x coordinate relative to upper-left corner of view.</param>
|
<param name="y">The y coordinate relative to upper-left corner of view.</param>
|
<param name="deltaX">The delta x coordinate.</param>
|
<param name="deltaY">The delta y coordinate.</param>
|
<param name="modifiers">The modifiers.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.SendMouseWheelEvent(CefSharp.IBrowser,System.Int32,System.Int32,System.Int32,System.Int32,CefSharp.CefEventFlags)">
|
<summary>
|
Send a mouse wheel event to the browser.
|
</summary>
|
<param name="browser">The <see cref="T:CefSharp.IBrowser"/> instance this method extends.</param>
|
<param name="x">The x coordinate relative to upper-left corner of view.</param>
|
<param name="y">The y coordinate relative to upper-left corner of view.</param>
|
<param name="deltaX">The delta x coordinate.</param>
|
<param name="deltaY">The delta y coordinate.</param>
|
<param name="modifiers">The modifiers.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.SendMouseWheelEvent(CefSharp.IBrowserHost,System.Int32,System.Int32,System.Int32,System.Int32,CefSharp.CefEventFlags)">
|
<summary>
|
Send a mouse wheel event to the browser.
|
</summary>
|
<param name="host">browserHost.</param>
|
<param name="x">The x coordinate relative to upper-left corner of view.</param>
|
<param name="y">The y coordinate relative to upper-left corner of view.</param>
|
<param name="deltaX">The delta x coordinate.</param>
|
<param name="deltaY">The delta y coordinate.</param>
|
<param name="modifiers">The modifiers.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.SendMouseClickEvent(CefSharp.IBrowserHost,System.Int32,System.Int32,CefSharp.MouseButtonType,System.Boolean,System.Int32,CefSharp.CefEventFlags)">
|
<summary>
|
Send a mouse click event to the browser.
|
</summary>
|
<param name="host">browserHost.</param>
|
<param name="x">The x coordinate relative to upper-left corner of view.</param>
|
<param name="y">The y coordinate relative to upper-left corner of view.</param>
|
<param name="mouseButtonType">Type of the mouse button.</param>
|
<param name="mouseUp">True to mouse up.</param>
|
<param name="clickCount">Number of clicks.</param>
|
<param name="modifiers">The modifiers.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.SendMouseMoveEvent(CefSharp.IBrowserHost,System.Int32,System.Int32,System.Boolean,CefSharp.CefEventFlags)">
|
<summary>
|
Send a mouse move event to the browser.
|
</summary>
|
<param name="host">browserHost.</param>
|
<param name="x">The x coordinate relative to upper-left corner of view.</param>
|
<param name="y">The y coordinate relative to upper-left corner of view.</param>
|
<param name="mouseLeave">mouse leave.</param>
|
<param name="modifiers">The modifiers.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.EvaluateScriptAsPromiseAsync(CefSharp.IWebBrowser,System.String,System.Nullable{System.TimeSpan})">
|
<summary>
|
Evaluate Javascript in the context of the MainFrame of the ChromiumWebBrowser. The script will be executed
|
asynchronously and the method returns a Task encapsulating the response from the Javascript. The result of the script execution
|
in javascript is Promise.resolve so even no promise values will be treated as a promise. Your javascript should return a value.
|
The javascript will be wrapped in an Immediately Invoked Function Expression.
|
When the promise either trigger then/catch this returned Task will be completed.
|
</summary>
|
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when one or more arguments are outside the required range.</exception>
|
<param name="chromiumWebBrowser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="script">The Javascript code that should be executed.</param>
|
<param name="timeout">(Optional) The timeout after which the Javascript code execution should be aborted.</param>
|
<returns>
|
<see cref="T:System.Threading.Tasks.Task`1"/> that can be awaited to perform the script execution.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.EvaluateScriptAsPromiseAsync(CefSharp.IBrowser,System.String,System.Nullable{System.TimeSpan})">
|
<summary>
|
Evaluate Javascript in the context of this Browsers Main Frame. The script will be executed
|
asynchronously and the method returns a Task encapsulating the response from the Javascript. The result of the script execution
|
in javascript is Promise.resolve so even no promise values will be treated as a promise. Your javascript should return a value.
|
The javascript will be wrapped in an Immediately Invoked Function Expression.
|
When the promise either trigger then/catch this returned Task will be completed.
|
</summary>
|
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when one or more arguments are outside the required range.</exception>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
<param name="script">The Javascript code that should be executed.</param>
|
<param name="timeout">(Optional) The timeout after which the Javascript code execution should be aborted.</param>
|
<returns>
|
<see cref="T:System.Threading.Tasks.Task`1"/> that can be awaited to perform the script execution.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.EvaluateScriptAsPromiseAsync(CefSharp.IFrame,System.String,System.Nullable{System.TimeSpan},System.String)">
|
<summary>
|
Evaluate Javascript in the context of this Browsers Main Frame. The script will be executed
|
asynchronously and the method returns a Task encapsulating the response from the Javascript. The result of the script execution
|
in javascript is Promise.resolve so even no promise values will be treated as a promise. Your javascript should return a value.
|
The javascript will be wrapped in an Immediately Invoked Function Expression.
|
When the promise either trigger then/catch this returned Task will be completed.
|
</summary>
|
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when one or more arguments are outside the required range.</exception>
|
<param name="frame">The <seealso cref="T:CefSharp.IFrame"/> instance this method extends.</param>
|
<param name="script">The Javascript code that should be executed.</param>
|
<param name="timeout">(Optional) The timeout after which the Javascript code execution should be aborted.</param>
|
<param name="javascriptBindingApiGlobalObjectName">
|
Only required if a custom value was specified for <see cref="P:CefSharp.JavascriptBinding.JavascriptBindingSettings.JavascriptBindingApiGlobalObjectName"/>
|
then this param must match that value. Otherwise exclude passing a value for this param or pass in null.
|
</param>
|
<returns>
|
<see cref="T:System.Threading.Tasks.Task`1"/> that can be awaited to perform the script execution.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.EvaluateScriptAsync(CefSharp.IChromiumWebBrowserBase,System.String,System.Nullable{System.TimeSpan},System.Boolean)">
|
<summary>
|
Evaluate Javascript in the context of this Browsers Main Frame. The script will be executed
|
asynchronously and the method returns a Task encapsulating the response from the Javascript
|
</summary>
|
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when one or more arguments are outside the required range.</exception>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="script">The Javascript code that should be executed.</param>
|
<param name="timeout">(Optional) The timeout after which the Javascript code execution should be aborted.</param>
|
<param name="useImmediatelyInvokedFuncExpression">When true the script is wrapped in a self executing function.
|
Make sure to use a return statement in your javascript. e.g. (function () { return 42; })();
|
When false don't include a return statement e.g. 42;
|
</param>
|
<returns>
|
<see cref="T:System.Threading.Tasks.Task`1"/> that can be awaited to obtain the result of the script execution.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.EvaluateScriptAsync(CefSharp.IBrowser,System.String,System.Nullable{System.TimeSpan},System.Boolean)">
|
<summary>
|
Evaluate some Javascript code in the context of the MainFrame of the ChromiumWebBrowser. The script will be executed
|
asynchronously and the method returns a Task encapsulating the response from the Javascript
|
</summary>
|
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when one or more arguments are outside the required range.</exception>
|
<param name="browser">The IBrowser instance this method extends.</param>
|
<param name="script">The Javascript code that should be executed.</param>
|
<param name="timeout">(Optional) The timeout after which the Javascript code execution should be aborted.</param>
|
<param name="useImmediatelyInvokedFuncExpression">When true the script is wrapped in a self executing function.
|
Make sure to use a return statement in your javascript. e.g. (function () { return 42; })();
|
When false don't include a return statement e.g. 42;
|
</param>
|
<returns>
|
<see cref="T:System.Threading.Tasks.Task`1"/> that can be awaited to obtain the result of the script execution.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.EvaluateScriptAsync(CefSharp.IChromiumWebBrowserBase,System.String,System.Object[])">
|
<summary>
|
Evaluate some Javascript code in the context of this WebBrowser. The script will be executed asynchronously and the method
|
returns a Task encapsulating the response from the Javascript This simple helper extension will encapsulate params in single
|
quotes (unless int, uint, etc)
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="methodName">The javascript method name to execute.</param>
|
<param name="args">the arguments to be passed as params to the method.</param>
|
<returns>
|
<see cref="T:System.Threading.Tasks.Task`1"/> that can be awaited to obtain the result of the script execution.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.EvaluateScriptAsync(CefSharp.IChromiumWebBrowserBase,System.Nullable{System.TimeSpan},System.String,System.Object[])">
|
<summary>
|
Evaluate Javascript code in the context of this WebBrowser using the specified timeout. The script will be executed
|
asynchronously and the method returns a Task encapsulating the response from the Javascript This simple helper extension will
|
encapsulate params in single quotes (unless int, uint, etc).
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
<param name="timeout">The timeout after which the Javascript code execution should be aborted.</param>
|
<param name="methodName">The javascript method name to execute.</param>
|
<param name="args">the arguments to be passed as params to the method. Args are encoded using
|
<see cref="P:CefSharp.WebBrowserExtensions.EncodeScriptParam"/>, you can provide a custom implementation if you require a custom implementation.</param>
|
<returns>
|
<see cref="T:System.Threading.Tasks.Task`1"/> that can be awaited to perform the script execution.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.SetAsPopup(CefSharp.IWebBrowser)">
|
<summary>
|
An IWebBrowser extension method that sets the <see cref="P:CefSharp.Internals.IWebBrowserInternal.HasParent"/>
|
property used when passing a ChromiumWebBrowser instance to <see cref="M:CefSharp.ILifeSpanHandler.OnBeforePopup(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.String,System.String,CefSharp.WindowOpenDisposition,System.Boolean,CefSharp.IPopupFeatures,CefSharp.IWindowInfo,CefSharp.IBrowserSettings,System.Boolean@,CefSharp.IWebBrowser@)"/>
|
</summary>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.DisposeDevToolsContext(CefSharp.Internals.IWebBrowserInternal)">
|
<summary>
|
Dispose of the DevToolsContext (if any). Used in conjunction with CefSharp.Dom
|
</summary>
|
<param name="webBrowserInternal">ChromiumWebBrowser instance</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.FreeDevToolsContext(CefSharp.Internals.IWebBrowserInternal)">
|
<summary>
|
Set the <see cref="P:CefSharp.Internals.IWebBrowserInternal.DevToolsContext"/> property to null. Used in conjunction with CefSharp.Dom
|
</summary>
|
<param name="webBrowserInternal">ChromiumWebBrowser instance</param>
|
</member>
|
<member name="P:CefSharp.WebBrowserExtensions.EncodeScriptParam">
|
<summary>
|
Function used to encode the params passed to <see cref="!:ExecuteScriptAsync(IWebBrowser, string, object[])"/>,
|
<see cref="!:EvaluateScriptAsync(IWebBrowser, string, object[])"/> and
|
<see cref="!:EvaluateScriptAsync(IWebBrowser, TimeSpan?, string, object[])"/>
|
Provide your own custom function to perform custom encoding. You can use your choice of JSON encoder here if you should so
|
choose.
|
</summary>
|
<value>
|
A function delegate that yields a string.
|
</value>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.IsNumeric(System.Object)">
|
<summary>
|
Checks if the given object is a numerical object.
|
</summary>
|
<param name="value">The object to check.</param>
|
<returns>
|
True if numeric, otherwise false.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.GetScriptForJavascriptMethodWithArgs(System.String,System.Object[])">
|
<summary>
|
Transforms the methodName and arguments into valid Javascript code. Will encapsulate params in single quotes (unless int,
|
uint, etc)
|
</summary>
|
<param name="methodName">The javascript method name to execute.</param>
|
<param name="args">the arguments to be passed as params to the method.</param>
|
<returns>
|
The Javascript code.
|
</returns>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.ThrowExceptionIfFrameNull(CefSharp.IFrame)">
|
<summary>
|
Throw exception if frame null.
|
</summary>
|
<exception cref="T:System.Exception">Thrown when an exception error condition occurs.</exception>
|
<param name="frame">The <seealso cref="T:CefSharp.IFrame"/> instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.ThrowExceptionIfBrowserNull(CefSharp.IBrowser)">
|
<summary>
|
An IBrowser extension method that throw exception if browser null.
|
</summary>
|
<exception cref="T:System.Exception">Thrown when an exception error condition occurs.</exception>
|
<param name="browser">The ChromiumWebBrowser instance this method extends.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.ThrowExceptionIfBrowserHostNull(CefSharp.IBrowserHost)">
|
<summary>
|
Throw exception if browser host null.
|
</summary>
|
<exception cref="T:System.Exception">Thrown when an exception error condition occurs.</exception>
|
<param name="browserHost">The browser host.</param>
|
</member>
|
<member name="M:CefSharp.WebBrowserExtensions.ThrowExceptionIfCanExecuteJavascriptInMainFrameFalse">
|
<summary>
|
Throw exception if can execute javascript in main frame false.
|
</summary>
|
<exception cref="T:System.Exception">Thrown when an exception error condition occurs.</exception>
|
</member>
|
<member name="T:CefSharp.Web.HtmlString">
|
<summary>
|
Represents an raw Html (not already encoded)
|
When passed to a ChromiumWebBrowser constructor, the html will be converted to a Data Uri
|
and loaded in the browser.
|
See https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs for details
|
</summary>
|
</member>
|
<member name="M:CefSharp.Web.HtmlString.#ctor(System.String,System.Boolean,System.String)">
|
<summary>
|
Initializes a new instance of the HtmlString class.
|
</summary>
|
<param name="html">raw html string (not already encoded)</param>
|
<param name="base64Encode">if true the html string will be base64 encoded using UTF8 encoding.</param>
|
<param name="charSet">if not null then charset will specified. e.g. UTF-8</param>
|
</member>
|
<member name="M:CefSharp.Web.HtmlString.ToDataUriString">
|
<summary>
|
The html as a Data Uri encoded string
|
</summary>
|
<returns>data Uri string suitable for passing to <see cref="M:CefSharp.IWebBrowser.Load(System.String)"/></returns>
|
</member>
|
<member name="M:CefSharp.Web.HtmlString.op_Explicit(System.String)~CefSharp.Web.HtmlString">
|
<summary>
|
HtmlString that will be base64 encoded
|
</summary>
|
<param name="html">raw html (not already encoded)</param>
|
</member>
|
<member name="M:CefSharp.Web.HtmlString.FromFile(System.String)">
|
<summary>
|
Creates a HtmlString for the given file name
|
Uses <see cref="M:System.IO.File.ReadAllText(System.String,System.Text.Encoding)"/> to read the
|
text using <see cref="P:System.Text.Encoding.UTF8"/> encoding.
|
</summary>
|
<param name="fileName">file name</param>
|
<returns>HtmlString</returns>
|
</member>
|
<member name="T:CefSharp.Web.JsonString">
|
<summary>
|
Represents a JsonString that is converted to a V8 Object
|
Used as a return type of bound methods
|
</summary>
|
</member>
|
<member name="P:CefSharp.Web.JsonString.Json">
|
<summary>
|
JSON String
|
</summary>
|
</member>
|
<member name="M:CefSharp.Web.JsonString.#ctor(System.String)">
|
<summary>
|
Default constructor
|
</summary>
|
<param name="json">JSON string</param>
|
</member>
|
<member name="M:CefSharp.Web.JsonString.ToString">
|
<inheritdoc/>
|
</member>
|
<member name="M:CefSharp.Web.JsonString.FromObject(System.Object,System.Runtime.Serialization.Json.DataContractJsonSerializerSettings)">
|
<summary>
|
Create a JsonString from the specfied object using the build in <see cref="T:System.Runtime.Serialization.Json.DataContractJsonSerializer"/>
|
</summary>
|
<param name="obj">object to seriaize</param>
|
<param name="settings">optional settings</param>
|
<returns>If <paramref name="obj"/> is null then return nulls otherwise a JsonString.</returns>
|
</member>
|
</members>
|
</doc>
|
