12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>CefSharp.Core</name>
- </assembly>
- <members>
- <member name="T:CefSharp.BrowserSettings">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.BrowserSettings.#ctor(System.Boolean)">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.StandardFontFamily">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.FixedFontFamily">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.SerifFontFamily">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.SansSerifFontFamily">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.CursiveFontFamily">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.FantasyFontFamily">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.DefaultFontSize">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.DefaultFixedFontSize">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.MinimumFontSize">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.MinimumLogicalFontSize">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.DefaultEncoding">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.RemoteFonts">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.Javascript">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.JavascriptCloseWindows">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.JavascriptAccessClipboard">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.JavascriptDomPaste">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.Plugins">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.UniversalAccessFromFileUrls">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.FileAccessFromFileUrls">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.WebSecurity">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.ImageLoading">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.ImageShrinkStandaloneToFit">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.TextAreaResize">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.TabToLinks">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.LocalStorage">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.Databases">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.ApplicationCache">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.WebGl">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.BackgroundColor">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.AcceptLanguageList">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.WindowlessFrameRate">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.IsDisposed">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.BrowserSettings.AutoDispose">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.BrowserSettings.Dispose">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.BrowserSettings.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="M:CefSharp.BrowserSettings.Create(System.Boolean)">
- <summary>
- Create a new instance of <see cref="T:CefSharp.IBrowserSettings"/>
- </summary>
- <param name="autoDispose">set to false if you plan to reuse the instance, otherwise true</param>
- <returns>BrowserSettings</returns>
- </member>
- <member name="T:CefSharp.BrowserSubprocess.SelfHost">
- <summary>
- SelfHost allows your application executable to be used as the BrowserSubProcess
- with minimal effort.
- </summary>
- <example>
- //WinForms Example
- public class Program
- {
- [STAThread]
- public static int Main(string[] args)
- {
- Cef.EnableHighDPISupport();
-
- var exitCode = CefSharp.BrowserSubprocess.SelfHost.Main(args);
-
- if (exitCode >= 0)
- {
- return exitCode;
- }
-
- var settings = new CefSettings();
- //Absolute path to your applications executable
- settings.BrowserSubprocessPath = System.Diagnostics.Process.GetCurrentProcess().MainModule.FileName;
-
- Cef.Initialize(settings);
-
- var browser = new BrowserForm(true);
- Application.Run(browser);
-
- return 0;
- }
- }
- </example>
- </member>
- <member name="M:CefSharp.BrowserSubprocess.SelfHost.Main(System.String[])">
- <summary>
- This function should be called from the application entry point function (typically Program.Main)
- to execute a secondary process e.g. gpu, plugin, renderer, utility
- This overload is specifically used for .Net Core. For hosting your own BrowserSubProcess
- it's preferable to use the Main method provided by this class.
- - Pass in command line args
- - To support High DPI Displays you should call Cef.EnableHighDPISupport before any other processing
- or add the relevant entries to your app.manifest
- </summary>
- <param name="args">command line args</param>
- <returns>
- If called for the browser process (identified by no "type" command-line value) it will return immediately
- with a value of -1. If called for a recognized secondary process it will block until the process should exit
- and then return the process exit code.
- </returns>
- </member>
- <member name="T:CefSharp.Cef">
- <summary>
- Global CEF methods are exposed through this class. e.g. CefInitalize maps to Cef.Initialize
- CEF API Doc https://magpcss.org/ceforum/apidocs3/projects/(default)/(_globals).html
- This class cannot be inherited.
- </summary>
- </member>
- <member name="P:CefSharp.Cef.IsInitialized">
- <summary>Gets a value that indicates whether CefSharp is initialized.</summary>
- <value>true if CefSharp is initialized; otherwise, false.</value>
- </member>
- <member name="P:CefSharp.Cef.CefSharpVersion">
- <summary>Gets a value that indicates the version of CefSharp currently being used.</summary>
- <value>The CefSharp version.</value>
- </member>
- <member name="P:CefSharp.Cef.CefVersion">
- <summary>Gets a value that indicates the CEF version currently being used.</summary>
- <value>The CEF Version</value>
- </member>
- <member name="P:CefSharp.Cef.ChromiumVersion">
- <summary>Gets a value that indicates the Chromium version currently being used.</summary>
- <value>The Chromium version.</value>
- </member>
- <member name="P:CefSharp.Cef.CefCommitHash">
- <summary>
- Gets a value that indicates the Git Hash for CEF version currently being used.
- </summary>
- <value>The Git Commit Hash</value>
- </member>
- <member name="M:CefSharp.Cef.Initialize(CefSharp.CefSettingsBase)">
- <summary>
- Initializes CefSharp with user-provided settings.
- It's important to note that Initialize and Shutdown <strong>MUST</strong> be called on your main
- application thread (typically the UI thread). If you call them on different
- threads, your application will hang. See the documentation for Cef.Shutdown() for more details.
- </summary>
- <param name="settings">CefSharp configuration settings.</param>
- <returns>true if successful; otherwise, false.</returns>
- </member>
- <member name="M:CefSharp.Cef.Initialize(CefSharp.CefSettingsBase,System.Boolean)">
- <summary>
- Initializes CefSharp with user-provided settings.
- It's important to note that Initialize/Shutdown <strong>MUST</strong> be called on your main
- application thread (typically the UI thread). If you call them on different
- threads, your application will hang. See the documentation for Cef.Shutdown() for more details.
- </summary>
- <param name="settings">CefSharp configuration settings.</param>
- <param name="performDependencyCheck">Check that all relevant dependencies available, throws exception if any are missing</param>
- <returns>true if successful; otherwise, false.</returns>
- </member>
- <member name="M:CefSharp.Cef.Initialize(CefSharp.CefSettingsBase,System.Boolean,CefSharp.IBrowserProcessHandler)">
- <summary>
- Initializes CefSharp with user-provided settings.
- It's important to note that Initialize/Shutdown <strong>MUST</strong> be called on your main
- application thread (typically the UI thread). If you call them on different
- threads, your application will hang. See the documentation for Cef.Shutdown() for more details.
- </summary>
- <param name="settings">CefSharp configuration settings.</param>
- <param name="performDependencyCheck">Check that all relevant dependencies available, throws exception if any are missing</param>
- <param name="browserProcessHandler">The handler for functionality specific to the browser process. Null if you don't wish to handle these events</param>
- <returns>true if successful; otherwise, false.</returns>
- </member>
- <member name="M:CefSharp.Cef.Initialize(CefSharp.CefSettingsBase,System.Boolean,CefSharp.IApp)">
- <summary>
- Initializes CefSharp with user-provided settings.
- It's important to note that Initialize/Shutdown <strong>MUST</strong> be called on your main
- application thread (typically the UI thread). If you call them on different
- threads, your application will hang. See the documentation for Cef.Shutdown() for more details.
- </summary>
- <param name="settings">CefSharp configuration settings.</param>
- <param name="performDependencyCheck">Check that all relevant dependencies available, throws exception if any are missing</param>
- <param name="cefApp">Implement this interface to provide handler implementations. Null if you don't wish to handle these events</param>
- <returns>true if successful; otherwise, false.</returns>
- </member>
- <member name="M:CefSharp.Cef.RunMessageLoop">
- <summary>
- Run the CEF message loop. Use this function instead of an application-
- provided message loop to get the best balance between performance and CPU
- usage. This function should only be called on the main application thread and
- only if Cef.Initialize() is called with a
- CefSettings.MultiThreadedMessageLoop value of false. This function will
- block until a quit message is received by the system.
- </summary>
- </member>
- <member name="M:CefSharp.Cef.QuitMessageLoop">
- <summary>
- Quit the CEF message loop that was started by calling Cef.RunMessageLoop().
- This function should only be called on the main application thread and only
- if Cef.RunMessageLoop() was used.
- </summary>
- </member>
- <member name="M:CefSharp.Cef.DoMessageLoopWork">
- <summary>
- Perform a single iteration of CEF message loop processing.This function is
- provided for cases where the CEF message loop must be integrated into an
- existing application message loop. Use of this function is not recommended
- for most users; use CefSettings.MultiThreadedMessageLoop if possible (the default).
- When using this function care must be taken to balance performance
- against excessive CPU usage. It is recommended to enable the
- CefSettings.ExternalMessagePump option when using
- this function so that IBrowserProcessHandler.OnScheduleMessagePumpWork()
- callbacks can facilitate the scheduling process. This function should only be
- called on the main application thread and only if Cef.Initialize() is called
- with a CefSettings.MultiThreadedMessageLoop value of false. This function
- will not block.
- </summary>
- </member>
- <member name="M:CefSharp.Cef.ExecuteProcess">
- <summary>
- This function should be called from the application entry point function to execute a secondary process.
- It can be used to run secondary processes from the browser client executable (default behavior) or
- from a separate executable specified by the CefSettings.browser_subprocess_path value.
- If called for the browser process (identified by no "type" command-line value) it will return immediately with a value of -1.
- If called for a recognized secondary process it will block until the process should exit and then return the process exit code.
- The |application| parameter may be empty. The |windows_sandbox_info| parameter is only used on Windows and may be NULL (see cef_sandbox_win.h for details).
- </summary>
- </member>
- <member name="M:CefSharp.Cef.AddCrossOriginWhitelistEntry(System.String,System.String,System.String,System.Boolean)">
- <summary>Add an entry to the cross-origin whitelist.</summary>
- <param name="sourceOrigin">The origin allowed to be accessed by the target protocol/domain.</param>
- <param name="targetProtocol">The target protocol allowed to access the source origin.</param>
- <param name="targetDomain">The optional target domain allowed to access the source origin.</param>
- <param name="allowTargetSubdomains">If set to true would allow a blah.example.com if the
- <paramref name="targetDomain"/> was set to example.com
- </param>
- <returns>Returns false if is invalid or the whitelist cannot be accessed.</returns>
- <remarks>
- The same-origin policy restricts how scripts hosted from different origins
- (scheme + domain + port) can communicate. By default, scripts can only access
- resources with the same origin. Scripts hosted on the HTTP and HTTPS schemes
- (but no other schemes) can use the "Access-Control-Allow-Origin" header to
- allow cross-origin requests. For example, https://source.example.com can make
- XMLHttpRequest requests on http://target.example.com if the
- http://target.example.com request returns an "Access-Control-Allow-Origin:
- https://source.example.com" response header.
-
- Scripts in separate frames or iframes and hosted from the same protocol and
- domain suffix can execute cross-origin JavaScript if both pages set the
- document.domain value to the same domain suffix. For example,
- scheme://foo.example.com and scheme://bar.example.com can communicate using
- JavaScript if both domains set document.domain="example.com".
-
- This method is used to allow access to origins that would otherwise violate
- the same-origin policy. Scripts hosted underneath the fully qualified
- <paramref name="sourceOrigin"/> URL (like http://www.example.com) will be allowed access to
- all resources hosted on the specified <paramref name="targetProtocol"/> and <paramref name="targetDomain"/>.
- If <paramref name="targetDomain"/> is non-empty and <paramref name="allowTargetSubdomains"/> if false only
- exact domain matches will be allowed. If <paramref name="targetDomain"/> contains a top-
- level domain component (like "example.com") and <paramref name="allowTargetSubdomains"/> is
- true sub-domain matches will be allowed. If <paramref name="targetDomain"/> is empty and
- <paramref name="allowTargetSubdomains"/> if true all domains and IP addresses will be
- allowed.
-
- This method cannot be used to bypass the restrictions on local or display
- isolated schemes. See the comments on <see cref="T:CefSharp.CefCustomScheme"/> for more
- information.
-
- This function may be called on any thread. Returns false if <paramref name="sourceOrigin"/>
- is invalid or the whitelist cannot be accessed.
- </remarks>
- </member>
- <member name="M:CefSharp.Cef.RemoveCrossOriginWhitelistEntry(System.String,System.String,System.String,System.Boolean)">
- <summary>Remove entry from cross-origin whitelist</summary>
- <param name="sourceOrigin">The origin allowed to be accessed by the target protocol/domain.</param>
- <param name="targetProtocol">The target protocol allowed to access the source origin.</param>
- <param name="targetDomain">The optional target domain allowed to access the source origin.</param>
- <param name="allowTargetSubdomains">If set to true would allow a blah.example.com if the
- <paramref name="targetDomain"/> was set to example.com
- </param>
- <remarks>
- Remove an entry from the cross-origin access whitelist. Returns false if
- <paramref name="sourceOrigin"/> is invalid or the whitelist cannot be accessed.
- </remarks>
- </member>
- <member name="M:CefSharp.Cef.ClearCrossOriginWhitelist">
- <summary>Remove all entries from the cross-origin access whitelist.</summary>
- <remarks>
- Remove all entries from the cross-origin access whitelist. Returns false if
- the whitelist cannot be accessed.
- </remarks>
- </member>
- <member name="M:CefSharp.Cef.GetGlobalCookieManager(CefSharp.ICompletionCallback)">
- <summary>
- Returns the global cookie manager. By default data will be stored at CefSettings.CachePath if specified or in memory otherwise.
- Using this method is equivalent to calling Cef.GetGlobalRequestContext().GetCookieManager()
- The cookie managers storage is created in an async fashion, whilst this method may return a cookie manager instance,
- there may be a short delay before you can Get/Write cookies.
- To be sure the cookie manager has been initialized use one of the following
- - Access the ICookieManager after ICompletionCallback.OnComplete has been called
- - Access the ICookieManager instance in IBrowserProcessHandler.OnContextInitialized.
- - Use the ChromiumWebBrowser BrowserInitialized (OffScreen) or IsBrowserInitializedChanged (WinForms/WPF) events.
- </summary>
- <param name="callback">If non-NULL it will be executed asynchronously on the CEF UI thread after the manager's storage has been initialized.</param>
- <returns>A the global cookie manager or null if the RequestContext has not yet been initialized.</returns>
- </member>
- <member name="M:CefSharp.Cef.PreShutdown">
- <summary>
- Called prior to calling Cef.Shutdown, this disposes of any remaining
- ChromiumWebBrowser instances. In WPF this is used from Dispatcher.ShutdownStarted
- to release the unmanaged resources held by the ChromiumWebBrowser instances.
- Generally speaking you don't need to call this yourself.
- </summary>
- </member>
- <member name="M:CefSharp.Cef.Shutdown">
- <summary>
- Shuts down CefSharp and the underlying CEF infrastructure. This method is safe to call multiple times; it will only
- shut down CEF on the first call (all subsequent calls will be ignored).
- This method should be called on the main application thread to shut down the CEF browser process before the application exits.
- If you are Using CefSharp.OffScreen then you must call this explicitly before your application exits or it will hang.
- This method must be called on the same thread as Initialize. If you don't call Shutdown explicitly then CefSharp.Wpf and CefSharp.WinForms
- versions will do their best to call Shutdown for you, if your application is having trouble closing then call thus explicitly.
- </summary>
- </member>
- <member name="M:CefSharp.Cef.ShutdownWithoutChecks">
- <summary>
- This method should only be used by advanced users, if you're unsure then use Cef.Shutdown().
- This function should be called on the main application thread to shut down
- the CEF browser process before the application exits. This method simply obtains a lock
- and calls the native CefShutdown method, only IsInitialized is checked. All ChromiumWebBrowser
- instances MUST be Disposed of before calling this method. If calling this method results in a crash
- or hangs then you're likely hanging on to some unmanaged resources or haven't closed all of your browser
- instances
- </summary>
- </member>
- <member name="M:CefSharp.Cef.ClearSchemeHandlerFactories">
- <summary>
- Clear all scheme handler factories registered with the global request context.
- Returns false on error. This function may be called on any thread in the browser process.
- Using this function is equivalent to calling Cef.GetGlobalRequestContext().ClearSchemeHandlerFactories().
- </summary>
- <returns>Returns false on error.</returns>
- </member>
- <member name="M:CefSharp.Cef.VisitWebPluginInfo(CefSharp.IWebPluginInfoVisitor)">
- <summary>
- Visit web plugin information. Can be called on any thread in the browser process.
- </summary>
- </member>
- <member name="M:CefSharp.Cef.GetPlugins">
- <summary>
- Async returns a list containing Plugin Information
- (Wrapper around CefVisitWebPluginInfo)
- </summary>
- <returns>Returns List of <see cref="T:CefSharp.WebPluginInfo"/> structs.</returns>
- </member>
- <member name="M:CefSharp.Cef.RefreshWebPlugins">
- <summary>
- Cause the plugin list to refresh the next time it is accessed regardless of whether it has already been loaded.
- </summary>
- </member>
- <member name="M:CefSharp.Cef.UnregisterInternalWebPlugin(System.String)">
- <summary>
- Unregister an internal plugin. This may be undone the next time RefreshWebPlugins() is called.
- </summary>
- <param name="path">Path (directory + file).</param>
- </member>
- <member name="M:CefSharp.Cef.EnableHighDPISupport">
- <summary>
- Call during process startup to enable High-DPI support on Windows 7 or newer.
- Older versions of Windows should be left DPI-unaware because they do not
- support DirectWrite and GDI fonts are kerned very badly.
- </summary>
- </member>
- <member name="M:CefSharp.Cef.CurrentlyOnThread(CefSharp.CefThreadIds)">
- <summary>
- Returns true if called on the specified CEF thread.
- </summary>
- <returns>Returns true if called on the specified thread.</returns>
- </member>
- <member name="M:CefSharp.Cef.GetGlobalRequestContext">
- <summary>
- Gets the Global Request Context. Make sure to Dispose of this object when finished.
- The earlier possible place to access the IRequestContext is in IBrowserProcessHandler.OnContextInitialized.
- Alternative use the ChromiumWebBrowser BrowserInitialized (OffScreen) or IsBrowserInitializedChanged (WinForms/WPF) events.
- </summary>
- <returns>Returns the global request context or null if the RequestContext has not been initialized yet.</returns>
- </member>
- <member name="M:CefSharp.Cef.ColorSetARGB(System.UInt32,System.UInt32,System.UInt32,System.UInt32)">
- <summary>
- Helper function (wrapper around the CefColorSetARGB macro) which combines
- the 4 color components into an uint32 for use with BackgroundColor property
- </summary>
- <param name="a">Alpha</param>
- <param name="r">Red</param>
- <param name="g">Green</param>
- <param name="b">Blue</param>
- <returns>Returns the color.</returns>
- </member>
- <member name="P:CefSharp.Cef.CrashReportingEnabled">
- <summary>
- Crash reporting is configured using an INI-style config file named
- crash_reporter.cfg. This file must be placed next to
- the main application executable. File contents are as follows:
-
- # Comments start with a hash character and must be on their own line.
-
- [Config]
- ProductName=<Value of the "prod" crash key; defaults to "cef">
- ProductVersion=<Value of the "ver" crash key; defaults to the CEF version>
- AppName=<Windows only; App-specific folder name component for storing crash
- information; default to "CEF">
- ExternalHandler=<Windows only; Name of the external handler exe to use
- instead of re-launching the main exe; default to empty>
- ServerURL=<crash server URL; default to empty>
- RateLimitEnabled=<True if uploads should be rate limited; default to true>
- MaxUploadsPerDay=<Max uploads per 24 hours, used if rate limit is enabled;
- default to 5>
- MaxDatabaseSizeInMb=<Total crash report disk usage greater than this value
- will cause older reports to be deleted; default to 20>
- MaxDatabaseAgeInDays=<Crash reports older than this value will be deleted;
- default to 5>
-
- [CrashKeys]
- my_key1=<small|medium|large>
- my_key2=<small|medium|large>
-
- Config section:
-
- If "ProductName" and/or "ProductVersion" are set then the specified values
- will be included in the crash dump metadata.
-
- If "AppName" is set on Windows then crash report information (metrics,
- database and dumps) will be stored locally on disk under the
- "C:\Users\[CurrentUser]\AppData\Local\[AppName]\User Data" folder.
-
- If "ExternalHandler" is set on Windows then the specified exe will be
- launched as the crashpad-handler instead of re-launching the main process
- exe. The value can be an absolute path or a path relative to the main exe
- directory.
-
- If "ServerURL" is set then crashes will be uploaded as a multi-part POST
- request to the specified URL. Otherwise, reports will only be stored locally
- on disk.
-
- If "RateLimitEnabled" is set to true then crash report uploads will be rate
- limited as follows:
- 1. If "MaxUploadsPerDay" is set to a positive value then at most the
- specified number of crashes will be uploaded in each 24 hour period.
- 2. If crash upload fails due to a network or server error then an
- incremental backoff delay up to a maximum of 24 hours will be applied for
- retries.
- 3. If a backoff delay is applied and "MaxUploadsPerDay" is > 1 then the
- "MaxUploadsPerDay" value will be reduced to 1 until the client is
- restarted. This helps to avoid an upload flood when the network or
- server error is resolved.
-
- If "MaxDatabaseSizeInMb" is set to a positive value then crash report storage
- on disk will be limited to that size in megabytes. For example, on Windows
- each dump is about 600KB so a "MaxDatabaseSizeInMb" value of 20 equates to
- about 34 crash reports stored on disk.
-
- If "MaxDatabaseAgeInDays" is set to a positive value then crash reports older
- than the specified age in days will be deleted.
-
- CrashKeys section:
-
- Any number of crash keys can be specified for use by the application. Crash
- key values will be truncated based on the specified size (small = 63 bytes,
- medium = 252 bytes, large = 1008 bytes). The value of crash keys can be set
- from any thread or process using the Cef.SetCrashKeyValue function. These
- key/value pairs will be sent to the crash server along with the crash dump
- file. Medium and large values will be chunked for submission. For example,
- if your key is named "mykey" then the value will be broken into ordered
- chunks and submitted using keys named "mykey-1", "mykey-2", etc.
- </summary>
- <returns>Returns true if crash reporting is enabled.</returns>
- </member>
- <member name="M:CefSharp.Cef.SetCrashKeyValue(System.String,System.String)">
- <summary>
- Sets or clears a specific key-value pair from the crash metadata.
- </summary>
- </member>
- <member name="M:CefSharp.Cef.GetMinLogLevel">
- <summary>
- Gets the current log level.
- When <see cref="P:CefSharp.CefSettingsBase.LogSeverity"/> is set to <see cref="F:CefSharp.LogSeverity.Disable"/> then
- no messages will be written to the log file, but FATAL messages will still be output to stderr.
- When logging is disabled this method will return <see cref="F:CefSharp.LogSeverity.Fatal"/>.
- </summary>
- <returns>Current Log Level</returns>
- </member>
- <member name="M:CefSharp.Cef.RegisterWidevineCdm(System.String,CefSharp.IRegisterCdmCallback)">
- <summary>
- Register the Widevine CDM plugin.
-
- The client application is responsible for downloading an appropriate
- platform-specific CDM binary distribution from Google, extracting the
- contents, and building the required directory structure on the local machine.
- The <see cref="M:CefSharp.IBrowserHost.StartDownload(System.String)"/> method class can be used
- to implement this functionality in CefSharp. Contact Google via
- https://www.widevine.com/contact.html for details on CDM download.
-
-
- path is a directory that must contain the following files:
- 1. manifest.json file from the CDM binary distribution (see below).
- 2. widevinecdm file from the CDM binary distribution (e.g.
- widevinecdm.dll on Windows).
- 3. widevidecdmadapter file from the CEF binary distribution (e.g.
- widevinecdmadapter.dll on Windows).
-
- If any of these files are missing or if the manifest file has incorrect
- contents the registration will fail and callback will receive an ErrorCode
- value of <see cref="F:CefSharp.CdmRegistrationErrorCode.IncorrectContents"/>.
-
- The manifest.json file must contain the following keys:
- A. "os": Supported OS (e.g. "mac", "win" or "linux").
- B. "arch": Supported architecture (e.g. "ia32" or "x64").
- C. "x-cdm-module-versions": Module API version (e.g. "4").
- D. "x-cdm-interface-versions": Interface API version (e.g. "8").
- E. "x-cdm-host-versions": Host API version (e.g. "8").
- F. "version": CDM version (e.g. "1.4.8.903").
- G. "x-cdm-codecs": List of supported codecs (e.g. "vp8,vp9.0,avc1").
-
- A through E are used to verify compatibility with the current Chromium
- version. If the CDM is not compatible the registration will fail and
- callback will receive an ErrorCode value of <see cref="F:CefSharp.CdmRegistrationErrorCode.Incompatible"/>.
-
- If registration is not supported at the time that Cef.RegisterWidevineCdm() is called then callback
- will receive an ErrorCode value of <see cref="F:CefSharp.CdmRegistrationErrorCode.NotSupported"/>.
- </summary>
- <param name="path"> is a directory that contains the Widevine CDM files</param>
- <param name="callback">optional callback - <see cref="M:CefSharp.IRegisterCdmCallback.OnRegistrationComplete(CefSharp.CdmRegistration)"/>
- will be executed asynchronously once registration is complete</param>
- </member>
- <member name="M:CefSharp.Cef.RegisterWidevineCdmAsync(System.String)">
- <summary>
- Register the Widevine CDM plugin.
-
- See <see cref="M:CefSharp.Cef.RegisterWidevineCdm(System.String,CefSharp.IRegisterCdmCallback)"/> for more details.
- </summary>
- <param name="path"> is a directory that contains the Widevine CDM files</param>
- <returns>Returns a Task that can be awaited to receive the <see cref="T:CefSharp.CdmRegistration"/> response.</returns>
- </member>
- <member name="M:CefSharp.Cef.GetMimeType(System.String)">
- <summary>
- Returns the mime type for the specified file extension or an empty string if unknown.
- </summary>
- <param name="extension">file extension</param>
- <returns>Returns the mime type for the specified file extension or an empty string if unknown.</returns>
- </member>
- <member name="M:CefSharp.Cef.EnableWaitForBrowsersToClose">
- <summary>
- WaitForBrowsersToClose is not enabled by default, call this method
- before Cef.Initialize to enable. If you aren't calling Cef.Initialize
- explicitly then this should be called before creating your first
- ChromiumWebBrowser instance.
- </summary>
- </member>
- <member name="M:CefSharp.Cef.WaitForBrowsersToClose">
- <summary>
- Helper method to ensure all ChromiumWebBrowser instances have been
- closed/disposed, should be called before Cef.Shutdown.
- Disposes all remaining ChromiumWebBrowser instances
- then waits for CEF to release its remaining CefBrowser instances.
- Finally a small delay of 50ms to allow for CEF to finish it's cleanup.
- Should only be called when MultiThreadedMessageLoop = true;
- (Hasn't been tested when when CEF integrates into main message loop).
- </summary>
- </member>
- <member name="T:CefSharp.CefSettingsBase">
- <summary>
- Initialization settings. Many of these and other settings can also configured using command-line switches.
- WPF/WinForms/OffScreen each have their own CefSettings implementation that sets
- relevant settings e.g. OffScreen starts with audio muted.
- </summary>
- </member>
- <member name="M:CefSharp.CefSettingsBase.Dispose">
- <summary>
- Free the unmanaged CefSettingsBase instance.
- Under normal circumstances you shouldn't need to call this
- The unmanaged resource will be freed after <see cref="M:CefSharp.Cef.Initialize(CefSharp.CefSettingsBase)"/> (or one of the overloads) is called.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.CefCustomSchemes">
- <summary>
- Add Customs schemes to this collection.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.CefCommandLineArgs">
- <summary>
- Add custom command line argumens to this collection, they will be added in OnBeforeCommandLineProcessing. The
- CefSettings.CommandLineArgsDisabled value can be used to start with an empty command-line object. Any values specified in
- CefSettings that equate to command-line arguments will be set before this method is called.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.CommandLineArgsDisabled">
- <summary>
- Set to true to disable configuration of browser process features using standard CEF and Chromium command-line arguments.
- Configuration can still be specified using CEF data structures or by adding to CefCommandLineArgs.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.ExternalMessagePump">
- <summary>
- Set to true to control browser process main (UI) thread message pump scheduling via the
- IBrowserProcessHandler.OnScheduleMessagePumpWork callback. This option is recommended for use in combination with the
- Cef.DoMessageLoopWork() function in cases where the CEF message loop must be integrated into an existing application message
- loop (see additional comments and warnings on Cef.DoMessageLoopWork). Enabling this option is not recommended for most users;
- leave this option disabled and use either MultiThreadedMessageLoop (the default) if possible.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.MultiThreadedMessageLoop">
- <summary>
- Set to true to have the browser process message loop run in a separate thread. If false than the CefDoMessageLoopWork()
- function must be called from your application message loop. This option is only supported on Windows. The default value is
- true.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.BrowserSubprocessPath">
- <summary>
- The path to a separate executable that will be launched for sub-processes. By default the browser process executable is used.
- See the comments on Cef.ExecuteProcess() for details. If this value is non-empty then it must be an absolute path.
- Also configurable using the "browser-subprocess-path" command-line switch.
- Defaults to using the provided CefSharp.BrowserSubprocess.exe instance
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.CachePath">
- <summary>
- The location where data for the global browser cache will be stored on disk. In this value is non-empty then it must be
- an absolute path that is must be either equal to or a child directory of CefSettings.RootCachePath (if RootCachePath is
- empty it will default to this value). If the value is empty then browsers will be created in "incognito mode" where
- in-memory caches are used for storage and no data is persisted to disk. HTML5 databases such as localStorage will only
- persist across sessions if a cache path is specified. Can be overridden for individual RequestContext instances via the
- RequestContextSettings.CachePath value.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.RootCachePath">
- <summary>
- The root directory that all CefSettings.CachePath and RequestContextSettings.CachePath values must have in common. If this
- value is empty and CefSettings.CachePath is non-empty then it will default to the CefSettings.CachePath value.
- If this value is non-empty then it must be an absolute path. Failure to set this value correctly may result in the sandbox
- blocking read/write access to the CachePath directory. NOTE: CefSharp does not implement the CHROMIUM SANDBOX. A non-empty
- RootCachePath can be used in conjuncation with an empty CefSettings.CachePath in instances where you would like browsers
- attached to the Global RequestContext (the default) created in "incognito mode" and instances created with a custom
- RequestContext using a disk based cache.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.UserDataPath">
- <summary>
- The location where user data such as spell checking dictionary files will be stored on disk. If this value is empty then the
- default user data directory will be used ("Local Settings\Application Data\CEF\User Data" directory under the user
- profile directory on Windows). If this value is non-empty then it must be an absolute path.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.IgnoreCertificateErrors">
- <summary>
- Set to true in order to completely ignore SSL certificate errors. This is NOT recommended.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.Locale">
- <summary>
- The locale string that will be passed to WebKit. If empty the default locale of "en-US" will be used. Also configurable using
- the "lang" command-line switch.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.LocalesDirPath">
- <summary>
- The fully qualified path for the locales directory. If this value is empty the locales directory must be located in the
- module directory. If this value is non-empty then it must be an absolute path. Also configurable using the "locales-dir-path"
- command-line switch.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.ResourcesDirPath">
- <summary>
- The fully qualified path for the resources directory. If this value is empty the cef.pak and/or devtools_resources.pak files
- must be located in the module directory. Also configurable using the "resources-dir-path" command-line switch.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.LogFile">
- <summary>
- The directory and file name to use for the debug log. If empty a default log file name and location will be used. On Windows
- a "debug.log" file will be written in the main executable directory. Also configurable using the"log-file" command- line
- switch.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.LogSeverity">
- <summary>
- The log severity. Only messages of this severity level or higher will be logged. When set to
- <see cref="F:CefSharp.LogSeverity.Disable"/> no messages will be written to the log file, but Fatal messages will still be
- output to stderr. Also configurable using the "log-severity" command-line switch with a value of "verbose", "info", "warning",
- "error", "fatal", "error-report" or "disable".
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.JavascriptFlags">
- <summary>
- Custom flags that will be used when initializing the V8 JavaScript engine. The consequences of using custom flags may not be
- well tested. Also configurable using the "js-flags" command-line switch.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.PackLoadingDisabled">
- <summary>
- Set to true to disable loading of pack files for resources and locales. A resource bundle handler must be provided for the
- browser and render processes via CefApp.GetResourceBundleHandler() if loading of pack files is disabled. Also configurable
- using the "disable-pack-loading" command- line switch.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.ProductVersion">
- <summary>
- Value that will be inserted as the product portion of the default User-Agent string. If empty the Chromium product version
- will be used. If UserAgent is specified this value will be ignored. Also configurable using the "product-version" command-
- line switch.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.RemoteDebuggingPort">
- <summary>
- Set to a value between 1024 and 65535 to enable remote debugging on the specified port. For example, if 8080 is specified the
- remote debugging URL will be http://localhost:8080. CEF can be remotely debugged from any CEF or Chrome browser window. Also
- configurable using the "remote-debugging-port" command-line switch.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.UncaughtExceptionStackSize">
- <summary>
- The number of stack trace frames to capture for uncaught exceptions. Specify a positive value to enable the
- CefRenderProcessHandler. OnUncaughtException() callback. Specify 0 (default value) and OnUncaughtException() will not be
- called. Also configurable using the "uncaught-exception-stack-size" command-line switch.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.UserAgent">
- <summary>
- Value that will be returned as the User-Agent HTTP header. If empty the default User-Agent string will be used. Also
- configurable using the "user-agent" command-line switch.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.WindowlessRenderingEnabled">
- <summary>
- Set to true (1) to enable windowless (off-screen) rendering support. Do not enable this value if the application does not use
- windowless rendering as it may reduce rendering performance on some systems.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.PersistSessionCookies">
- <summary>
- To persist session cookies (cookies without an expiry date or validity interval) by default when using the global cookie
- manager set this value to true. Session cookies are generally intended to be transient and most Web browsers do not persist
- them. A CachePath value must also be specified to enable this feature. Also configurable using the "persist-session-cookies"
- command-line switch. Can be overridden for individual RequestContext instances via the
- RequestContextSettings.PersistSessionCookies value.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.PersistUserPreferences">
- <summary>
- To persist user preferences as a JSON file in the cache path directory set this value to true. A CachePath value must also be
- specified to enable this feature. Also configurable using the "persist-user-preferences" command-line switch. Can be
- overridden for individual RequestContext instances via the RequestContextSettings.PersistUserPreferences value.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.AcceptLanguageList">
- <summary>
- Comma delimited ordered list of language codes without any whitespace that will be used in the "Accept-Language" HTTP header.
- May be set globally using the CefSettings.AcceptLanguageList value. If both values are empty then "en-US,en" will be used.
-
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.BackgroundColor">
- <summary>
- Background color used for the browser before a document is loaded and when no document color is specified. The alpha
- component must be either fully opaque (0xFF) or fully transparent (0x00). If the alpha component is fully opaque then the RGB
- components will be used as the background color. If the alpha component is fully transparent for a WinForms browser then the
- default value of opaque white be used. If the alpha component is fully transparent for a windowless (WPF/OffScreen) browser
- then transparent painting will be enabled.
- </summary>
- </member>
- <member name="P:CefSharp.CefSettingsBase.ApplicationClientIdForFileScanning">
- <summary>
- GUID string used for identifying the application. This is passed to the system AV function for scanning downloaded files. By
- default, the GUID will be an empty string and the file will be treated as an untrusted file when the GUID is empty.
- </summary>
- </member>
- <member name="M:CefSharp.CefSettingsBase.RegisterScheme(CefSharp.CefCustomScheme)">
- <summary>
- Registers a custom scheme using the provided settings.
- </summary>
- <param name="scheme">The CefCustomScheme which provides the details about the scheme.</param>
- </member>
- <member name="M:CefSharp.CefSettingsBase.DisableGpuAcceleration">
- <summary>
- Set command line argument to disable GPU Acceleration. WebGL will use
- software rendering via Swiftshader (https://swiftshader.googlesource.com/SwiftShader#introduction)
- </summary>
- </member>
- <member name="M:CefSharp.CefSettingsBase.EnablePrintPreview">
- <summary>
- Set command line argument to enable Print Preview See
- https://bitbucket.org/chromiumembedded/cef/issues/123/add-support-for-print-preview for details.
- </summary>
- </member>
- <member name="M:CefSharp.CefSettingsBase.SetOffScreenRenderingBestPerformanceArgs">
- <summary>
- Set command line arguments for best OSR (Offscreen and WPF) Rendering performance Swiftshader will be used for WebGL, look at the source
- to determine which flags best suite your requirements. See https://swiftshader.googlesource.com/SwiftShader#introduction for
- details on Swiftshader
- </summary>
- </member>
- <member name="T:CefSharp.DragData">
- <summary>
- Used to represent Drag Data.
- </summary>
- </member>
- <member name="M:CefSharp.DragData.Create">
- <summary>
- Create a new instance of <see cref="T:CefSharp.IDragData"/>
- </summary>
- <returns>DragData</returns>
- </member>
- <member name="T:CefSharp.ManagedCefBrowserAdapter">
- <summary>
- Create <see cref="T:CefSharp.Internals.IBrowserAdapter"/> instance via <see cref="M:CefSharp.ManagedCefBrowserAdapter.Create(CefSharp.Internals.IWebBrowserInternal,System.Boolean)"/>
- This is the primary object for bridging the ChromiumWebBrowser implementation and VC++
- </summary>
- </member>
- <member name="M:CefSharp.ManagedCefBrowserAdapter.Create(CefSharp.Internals.IWebBrowserInternal,System.Boolean)">
- <summary>
- Create a new <see cref="T:CefSharp.Internals.IBrowserAdapter"/> instance which is the main method of interaction between the unmanged
- CEF implementation and our ChromiumWebBrowser instances.
- </summary>
- <param name="webBrowserInternal">reference to the ChromiumWebBrowser instance</param>
- <param name="offScreenRendering">true for WPF/OffScreen, false for WinForms and other Hwnd based implementations</param>
- <returns>instance of <see cref="T:CefSharp.Internals.IBrowserAdapter"/></returns>
- </member>
- <member name="T:CefSharp.NativeMethodWrapper">
- <summary>
- Native static methods for low level operations, memory copy
- Avoids having to P/Invoke as we can call the C++ API directly.
- </summary>
- </member>
- <member name="T:CefSharp.PostData">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.PostData.Elements">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.PostData.IsReadOnly">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.PostData.IsDisposed">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.PostData.HasExcludedElements">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.PostData.AddElement(CefSharp.IPostDataElement)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.PostData.CreatePostDataElement">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.PostData.Dispose">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.PostData.RemoveElement(CefSharp.IPostDataElement)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.PostData.RemoveElements">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.PostData.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="M:CefSharp.PostData.Create">
- <summary>
- Create a new instance of <see cref="T:CefSharp.IPostData"/>
- </summary>
- <returns>PostData</returns>
- </member>
- <member name="T:CefSharp.PostDataElement">
- <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.PostDataElement.File">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.PostDataElement.IsReadOnly">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.PostDataElement.Type">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.PostDataElement.Bytes">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.PostDataElement.Dispose">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.PostDataElement.SetToEmpty">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.PostDataElement.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="M:CefSharp.PostDataElement.Create">
- <summary>
- Create a new instance of <see cref="T:CefSharp.IPostDataElement"/>
- </summary>
- <returns>PostDataElement</returns>
- </member>
- <member name="T:CefSharp.Core.ObjectFactory">
- <summary>
- Create instances of Public Api classes, <see cref="T:CefSharp.IBrowserSettings"/>,
- <see cref="T:CefSharp.IWindowInfo"/> etc.
- </summary>
- </member>
- <member name="M:CefSharp.Core.ObjectFactory.CreateBrowserSettings(System.Boolean)">
- <summary>
- Create a new instance of <see cref="T:CefSharp.IBrowserSettings"/>
- </summary>
- <param name="autoDispose">Dispose of browser setings after it has been used to create a browser</param>
- <returns>returns new instance of <see cref="T:CefSharp.IBrowserSettings"/></returns>
- </member>
- <member name="M:CefSharp.Core.ObjectFactory.CreateWindowInfo">
- <summary>
- Create a new instance of <see cref="T:CefSharp.IWindowInfo"/>
- </summary>
- <returns>returns new instance of <see cref="T:CefSharp.IWindowInfo"/></returns>
- </member>
- <member name="M:CefSharp.Core.ObjectFactory.CreatePostData">
- <summary>
- Create a new instance of <see cref="T:CefSharp.IPostData"/>
- </summary>
- <returns>returns new instance of <see cref="T:CefSharp.IPostData"/></returns>
- </member>
- <member name="M:CefSharp.Core.ObjectFactory.CreatePostDataElement">
- <summary>
- Create a new instance of <see cref="T:CefSharp.IPostDataElement"/>
- </summary>
- <returns>returns new instance of <see cref="T:CefSharp.IPostDataElement"/></returns>
- </member>
- <member name="M:CefSharp.Core.ObjectFactory.CreateRequest">
- <summary>
- Create a new instance of <see cref="T:CefSharp.IRequest"/>
- </summary>
- <returns>returns new instance of <see cref="T:CefSharp.IRequest"/></returns>
- </member>
- <member name="M:CefSharp.Core.ObjectFactory.CreateUrlRequest(CefSharp.IRequest,CefSharp.IUrlRequestClient)">
- <summary>
- Create a new instance of <see cref="T:CefSharp.IUrlRequest"/>
- </summary>
- <param name="request">request</param>
- <param name="urlRequestClient">url request client</param>
- <returns>returns new instance of <see cref="T:CefSharp.IUrlRequest"/></returns>
- </member>
- <member name="M:CefSharp.Core.ObjectFactory.CreateUrlRequest(CefSharp.IRequest,CefSharp.IUrlRequestClient,CefSharp.IRequestContext)">
- <summary>
- Create a new instance of <see cref="T:CefSharp.IUrlRequest"/>
- </summary>
- <param name="request">request</param>
- <param name="urlRequestClient">url request client</param>
- <param name="requestContext">request context</param>
- <returns>returns new instance of <see cref="T:CefSharp.IUrlRequest"/></returns>
- </member>
- <member name="M:CefSharp.Core.ObjectFactory.CreateDragData">
- <summary>
- Create a new instance of <see cref="T:CefSharp.IDragData"/>
- </summary>
- <returns>returns new instance of <see cref="T:CefSharp.IDragData"/></returns>
- </member>
- <member name="M:CefSharp.Core.ObjectFactory.ConfigureRequestContext">
- <summary>
- Create a new <see cref="T:CefSharp.RequestContextBuilder"/> which can be used to
- create a new <see cref="T:CefSharp.IRequestContext"/> in a fluent flashion.
- Call <see cref="M:CefSharp.RequestContextBuilder.Create"/> to create the actual
- <see cref="T:CefSharp.IRequestContext"/> instance
- </summary>
- <returns>RequestContextBuilder</returns>
- </member>
- <member name="T:CefSharp.Request">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.Request.Flags">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.Request.Url">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.Request.Identifier">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.Request.Method">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.Request.ReferrerUrl">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.Request.ResourceType">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.Request.ReferrerPolicy">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.Request.Headers">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.Request.PostData">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.Request.TransitionType">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.Request.IsDisposed">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.Request.IsReadOnly">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.Request.Dispose">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.Request.GetHeaderByName(System.String)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.Request.InitializePostData">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.Request.SetHeaderByName(System.String,System.String,System.Boolean)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.Request.SetReferrer(System.String,CefSharp.ReferrerPolicy)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.Request.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="M:CefSharp.Request.Create">
- <summary>
- Create a new <see cref="T:CefSharp.IRequest"/> instance
- </summary>
- <returns>Request</returns>
- </member>
- <member name="T:CefSharp.RequestContext">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.#ctor">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.#ctor(CefSharp.IRequestContext)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.#ctor(CefSharp.IRequestContext,CefSharp.IRequestContextHandler)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.#ctor(CefSharp.IRequestContextHandler)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.#ctor(CefSharp.RequestContextSettings)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.#ctor(CefSharp.RequestContextSettings,CefSharp.IRequestContextHandler)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.Configure">
- <summary>
- Creates a new RequestContextBuilder which can be used to fluently set
- preferences
- </summary>
- <returns>Returns a new RequestContextBuilder</returns>
- </member>
- <member name="P:CefSharp.RequestContext.IsGlobal">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.RequestContext.CachePath">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.IsSame(CefSharp.IRequestContext)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.IsSharingWith(CefSharp.IRequestContext)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.GetCookieManager(CefSharp.ICompletionCallback)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.RegisterSchemeHandlerFactory(System.String,System.String,CefSharp.ISchemeHandlerFactory)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.ClearSchemeHandlerFactories">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.PurgePluginListCache(System.Boolean)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.HasPreference(System.String)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.GetPreference(System.String)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.GetAllPreferences(System.Boolean)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.CanSetPreference(System.String)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.SetPreference(System.String,System.Object,System.String@)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.ClearCertificateExceptions(CefSharp.ICompletionCallback)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.ClearHttpAuthCredentials(CefSharp.ICompletionCallback)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.CloseAllConnections(CefSharp.ICompletionCallback)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.ResolveHostAsync(System.Uri)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.DidLoadExtension(System.String)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.GetExtension(System.String)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.GetExtensions(System.Collections.Generic.IList{System.String}@)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.HasExtension(System.String)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.LoadExtension(System.String,System.String,CefSharp.IExtensionHandler)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.Dispose">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.RequestContext.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.RequestContextBuilder">
- <summary>
- Fluent style builder for creating IRequestContext instances.
- </summary>
- </member>
- <member name="M:CefSharp.RequestContextBuilder.Create">
- <summary>
- Create the actual RequestContext instance
- </summary>
- <returns>Returns a new RequestContext instance.</returns>
- </member>
- <member name="M:CefSharp.RequestContextBuilder.OnInitialize(System.Action{CefSharp.IRequestContext})">
- <summary>
- Action is called in IRequestContextHandler.OnRequestContextInitialized
- </summary>
- <param name="action">called when the context has been initialized.</param>
- <returns>Returns RequestContextBuilder instance</returns>
- </member>
- <member name="M:CefSharp.RequestContextBuilder.WithCachePath(System.String)">
- <summary>
- Sets the Cache Path
- </summary>
- <param name="cachePath">
- The location where cache data for this request context will be stored on
- disk. If this value is non-empty then it must be an absolute path that is
- either equal to or a child directory of CefSettings.RootCachePath.
- If the value is empty then browsers will be created in "incognito mode"
- where in-memory caches are used for storage and no data is persisted to disk.
- HTML5 databases such as localStorage will only persist across sessions if a
- cache path is specified. To share the global browser cache and related
- configuration set this value to match the CefSettings.CachePath value.
- </param>
- <returns>Returns RequestContextBuilder instance</returns>
- </member>
- <member name="M:CefSharp.RequestContextBuilder.PersistUserPreferences">
- <summary>
- Invoke this method tp persist user preferences as a JSON file in the cache path directory.
- Can be set globally using the CefSettings.PersistUserPreferences value.
- This value will be ignored if CachePath is empty or if it matches the CefSettings.CachePath value.
- </summary>
- <returns>Returns RequestContextBuilder instance</returns>
- </member>
- <member name="M:CefSharp.RequestContextBuilder.WithPreference(System.String,System.Object)">
- <summary>
- Set the value associated with preference name when the RequestContext
- is initialzied. If value is null the preference will be restored to its
- default value. If setting the preference fails no error is throw, you
- must check the CEF Log file.
- Preferences set via the command-line usually cannot be modified.
- </summary>
- <param name="name">preference key</param>
- <param name="value">preference value</param>
- <returns>Returns RequestContextBuilder instance</returns>
- </member>
- <member name="M:CefSharp.RequestContextBuilder.WithProxyServer(System.String)">
- <summary>
- Set the Proxy server when the RequestContext is initialzied.
- If value is null the preference will be restored to its
- default value. If setting the preference fails no error is throw, you
- must check the CEF Log file.
- Proxy set via the command-line cannot be modified.
- </summary>
- <param name="host">proxy host</param>
- <returns>Returns RequestContextBuilder instance</returns>
- </member>
- <member name="M:CefSharp.RequestContextBuilder.WithProxyServer(System.String,System.Nullable{System.Int32})">
- <summary>
- Set the Proxy server when the RequestContext is initialzied.
- If value is null the preference will be restored to its
- default value. If setting the preference fails no error is throw, you
- must check the CEF Log file.
- Proxy set via the command-line cannot be modified.
- </summary>
- <param name="host">proxy host</param>
- <param name="port">proxy port (optional)</param>
- <returns>Returns RequestContextBuilder instance</returns>
- </member>
- <member name="M:CefSharp.RequestContextBuilder.WithProxyServer(System.String,System.String,System.Nullable{System.Int32})">
- <summary>
- Set the Proxy server when the RequestContext is initialzied.
- If value is null the preference will be restored to its
- default value. If setting the preference fails no error is throw, you
- must check the CEF Log file.
- Proxy set via the command-line cannot be modified.
- </summary>
- <param name="scheme">proxy scheme</param>
- <param name="host">proxy host</param>
- <param name="port">proxy port (optional)</param>
- <returns>Returns RequestContextBuilder instance</returns>
- </member>
- <member name="M:CefSharp.RequestContextBuilder.WithSharedSettings(CefSharp.IRequestContext)">
- <summary>
- Shares storage with other RequestContext
- </summary>
- <param name="other">shares storage with this RequestContext</param>
- <returns>Returns RequestContextBuilder instance</returns>
- </member>
- <member name="T:CefSharp.RequestContextSettings">
- <summary>
- RequestContext Settings
- </summary>
- </member>
- <member name="P:CefSharp.RequestContextSettings.PersistSessionCookies">
- <summary>
- To persist session cookies (cookies without an expiry date or validity
- interval) by default when using the global cookie manager set this value to
- true. Session cookies are generally intended to be transient and most
- Web browsers do not persist them. Can be set globally using the
- CefSettings.PersistSessionCookies value. This value will be ignored if
- CachePath is empty or if it matches the CefSettings.CachePath value.
- </summary>
- </member>
- <member name="P:CefSharp.RequestContextSettings.PersistUserPreferences">
- <summary>
- To persist user preferences as a JSON file in the cache path directory set
- this value to true. Can be set globally using the
- CefSettings.PersistUserPreferences value. This value will be ignored if
- CachePath is empty or if it matches the CefSettings.CachePath value.
- </summary>
- </member>
- <member name="P:CefSharp.RequestContextSettings.CachePath">
- <summary>
- The location where cache data for this request context will be stored on
- disk. If this value is non-empty then it must be an absolute path that is
- either equal to or a child directory of CefSettings.RootCachePath.
- If the value is empty then browsers will be created in "incognito mode"
- where in-memory caches are used for storage and no data is persisted to disk.
- HTML5 databases such as localStorage will only persist across sessions if a
- cache path is specified. To share the global browser cache and related
- configuration set this value to match the CefSettings.CachePath value.
- </summary>
- </member>
- <member name="P:CefSharp.RequestContextSettings.AcceptLanguageList">
- <summary>
- Comma delimited ordered list of language codes without any whitespace that
- will be used in the "Accept-Language" HTTP header. Can be set globally
- using the CefSettings.accept_language_list value or overridden on a per-
- browser basis using the BrowserSettings.AcceptLanguageList value. If
- all values are empty then "en-US,en" will be used. This value will be
- ignored if CachePath matches the CefSettings.CachePath value.
- </summary>
- </member>
- <member name="P:CefSharp.RequestContextSettings.IgnoreCertificateErrors">
- <summary>
- Set to true to ignore errors related to invalid SSL certificates.
- Enabling this setting can lead to potential security vulnerabilities like
- "man in the middle" attacks. Applications that load content from the
- internet should not enable this setting. Can be set globally using the
- CefSettings.IgnoreCertificateErrors value. This value will be ignored if
- CachePath matches the CefSettings.cache_path value.
- </summary>
- </member>
- <member name="T:CefSharp.UrlRequest">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.UrlRequest.#ctor(CefSharp.IRequest,CefSharp.IUrlRequestClient)">
- <summary>
- Create a new URL request that is not associated with a specific browser or frame.
- Use <see cref="M:CefSharp.IFrame.CreateUrlRequest(CefSharp.IRequest,CefSharp.IUrlRequestClient)"/> instead if you want the
- request to have this association, in which case it may be handled differently.
- For requests originating from the browser process: It may be intercepted by the client via <see cref="T:CefSharp.IResourceRequestHandler"/> or <see cref="T:CefSharp.ISchemeHandlerFactory"/>.
- POST data may only contain only a single element of type PDE_TYPE_FILE or PDE_TYPE_BYTES.
- Uses the Global RequestContext
- </summary>
- <param name="request">request</param>
- <param name="urlRequestClient">url request client</param>
- </member>
- <member name="M:CefSharp.UrlRequest.#ctor(CefSharp.IRequest,CefSharp.IUrlRequestClient,CefSharp.IRequestContext)">
- <summary>
- Create a new URL request that is not associated with a specific browser or frame.
- Use <see cref="M:CefSharp.IFrame.CreateUrlRequest(CefSharp.IRequest,CefSharp.IUrlRequestClient)"/> instead if you want the
- request to have this association, in which case it may be handled differently.
- For requests originating from the browser process: It may be intercepted by the client via <see cref="T:CefSharp.IResourceRequestHandler"/> or <see cref="T:CefSharp.ISchemeHandlerFactory"/>.
- POST data may only contain only a single element of type PDE_TYPE_FILE or PDE_TYPE_BYTES.
- </summary>
- <param name="request">request</param>
- <param name="urlRequestClient">url request client</param>
- <param name="requestContext">request context associated with this requets.</param>
- </member>
- <member name="P:CefSharp.UrlRequest.ResponseWasCached">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.UrlRequest.Response">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.UrlRequest.RequestStatus">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.UrlRequest.Dispose">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.UrlRequest.Create(CefSharp.IRequest,CefSharp.IUrlRequestClient)">
- <summary>
- Create a new URL request that is not associated with a specific browser or frame.
- Use <see cref="M:CefSharp.IFrame.CreateUrlRequest(CefSharp.IRequest,CefSharp.IUrlRequestClient)"/> instead if you want the
- request to have this association, in which case it may be handled differently.
- For requests originating from the browser process: It may be intercepted by the client via <see cref="T:CefSharp.IResourceRequestHandler"/> or <see cref="T:CefSharp.ISchemeHandlerFactory"/>.
- POST data may only contain only a single element of type PDE_TYPE_FILE or PDE_TYPE_BYTES.
- Uses the Global RequestContext
- </summary>
- <param name="request">request</param>
- <param name="urlRequestClient">url request client</param>
- </member>
- <member name="M:CefSharp.UrlRequest.Create(CefSharp.IRequest,CefSharp.IUrlRequestClient,CefSharp.IRequestContext)">
- <summary>
- Create a new URL request that is not associated with a specific browser or frame.
- Use <see cref="M:CefSharp.IFrame.CreateUrlRequest(CefSharp.IRequest,CefSharp.IUrlRequestClient)"/> instead if you want the
- request to have this association, in which case it may be handled differently.
- For requests originating from the browser process: It may be intercepted by the client via <see cref="T:CefSharp.IResourceRequestHandler"/> or <see cref="T:CefSharp.ISchemeHandlerFactory"/>.
- POST data may only contain only a single element of type PDE_TYPE_FILE or PDE_TYPE_BYTES.
- </summary>
- <param name="request">request</param>
- <param name="urlRequestClient">url request client</param>
- <param name="requestContext">request context associated with this requets.</param>
- </member>
- <member name="T:CefSharp.WebBrowserExtensionsEx">
- <summary>
- Extended WebBrowserExtensions
- </summary>
- </member>
- <member name="M:CefSharp.WebBrowserExtensionsEx.GetVisibleNavigationEntryAsync(CefSharp.IWebBrowser)">
- <summary>
- Retrieve the current <see cref="T:CefSharp.NavigationEntry"/>. Contains information like
- <see cref="P:CefSharp.NavigationEntry.HttpStatusCode"/> and <see cref="P:CefSharp.NavigationEntry.SslStatus"/>
- </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 current <see cref="T:CefSharp.NavigationEntry"/> or null
- </returns>
- </member>
- <member name="T:CefSharp.WindowInfo">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.WindowInfo.X">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.WindowInfo.Y">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.WindowInfo.Width">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.WindowInfo.Height">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.WindowInfo.Style">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.WindowInfo.ExStyle">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.WindowInfo.ParentWindowHandle">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.WindowInfo.WindowlessRenderingEnabled">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.WindowInfo.SharedTextureEnabled">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.WindowInfo.ExternalBeginFrameEnabled">
- <inheritdoc/>
- </member>
- <member name="P:CefSharp.WindowInfo.WindowHandle">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.WindowInfo.Dispose">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.WindowInfo.SetAsChild(System.IntPtr)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.WindowInfo.SetAsChild(System.IntPtr,System.Int32,System.Int32,System.Int32,System.Int32)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.WindowInfo.SetAsPopup(System.IntPtr,System.String)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.WindowInfo.SetAsWindowless(System.IntPtr)">
- <inheritdoc/>
- </member>
- <member name="M:CefSharp.WindowInfo.Create">
- <summary>
- Create a new <see cref="T:CefSharp.IWindowInfo"/> instance
- </summary>
- <returns>WindowInfo</returns>
- </member>
- </members>
- </doc>
|