CefSharp.Core.xml 82 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>CefSharp.Core</name>
  5. </assembly>
  6. <members>
  7. <member name="T:CefSharp.BrowserSettings">
  8. <inheritdoc/>
  9. </member>
  10. <member name="M:CefSharp.BrowserSettings.#ctor(System.Boolean)">
  11. <inheritdoc/>
  12. </member>
  13. <member name="P:CefSharp.BrowserSettings.StandardFontFamily">
  14. <inheritdoc/>
  15. </member>
  16. <member name="P:CefSharp.BrowserSettings.FixedFontFamily">
  17. <inheritdoc/>
  18. </member>
  19. <member name="P:CefSharp.BrowserSettings.SerifFontFamily">
  20. <inheritdoc/>
  21. </member>
  22. <member name="P:CefSharp.BrowserSettings.SansSerifFontFamily">
  23. <inheritdoc/>
  24. </member>
  25. <member name="P:CefSharp.BrowserSettings.CursiveFontFamily">
  26. <inheritdoc/>
  27. </member>
  28. <member name="P:CefSharp.BrowserSettings.FantasyFontFamily">
  29. <inheritdoc/>
  30. </member>
  31. <member name="P:CefSharp.BrowserSettings.DefaultFontSize">
  32. <inheritdoc/>
  33. </member>
  34. <member name="P:CefSharp.BrowserSettings.DefaultFixedFontSize">
  35. <inheritdoc/>
  36. </member>
  37. <member name="P:CefSharp.BrowserSettings.MinimumFontSize">
  38. <inheritdoc/>
  39. </member>
  40. <member name="P:CefSharp.BrowserSettings.MinimumLogicalFontSize">
  41. <inheritdoc/>
  42. </member>
  43. <member name="P:CefSharp.BrowserSettings.DefaultEncoding">
  44. <inheritdoc/>
  45. </member>
  46. <member name="P:CefSharp.BrowserSettings.RemoteFonts">
  47. <inheritdoc/>
  48. </member>
  49. <member name="P:CefSharp.BrowserSettings.Javascript">
  50. <inheritdoc/>
  51. </member>
  52. <member name="P:CefSharp.BrowserSettings.JavascriptCloseWindows">
  53. <inheritdoc/>
  54. </member>
  55. <member name="P:CefSharp.BrowserSettings.JavascriptAccessClipboard">
  56. <inheritdoc/>
  57. </member>
  58. <member name="P:CefSharp.BrowserSettings.JavascriptDomPaste">
  59. <inheritdoc/>
  60. </member>
  61. <member name="P:CefSharp.BrowserSettings.Plugins">
  62. <inheritdoc/>
  63. </member>
  64. <member name="P:CefSharp.BrowserSettings.UniversalAccessFromFileUrls">
  65. <inheritdoc/>
  66. </member>
  67. <member name="P:CefSharp.BrowserSettings.FileAccessFromFileUrls">
  68. <inheritdoc/>
  69. </member>
  70. <member name="P:CefSharp.BrowserSettings.WebSecurity">
  71. <inheritdoc/>
  72. </member>
  73. <member name="P:CefSharp.BrowserSettings.ImageLoading">
  74. <inheritdoc/>
  75. </member>
  76. <member name="P:CefSharp.BrowserSettings.ImageShrinkStandaloneToFit">
  77. <inheritdoc/>
  78. </member>
  79. <member name="P:CefSharp.BrowserSettings.TextAreaResize">
  80. <inheritdoc/>
  81. </member>
  82. <member name="P:CefSharp.BrowserSettings.TabToLinks">
  83. <inheritdoc/>
  84. </member>
  85. <member name="P:CefSharp.BrowserSettings.LocalStorage">
  86. <inheritdoc/>
  87. </member>
  88. <member name="P:CefSharp.BrowserSettings.Databases">
  89. <inheritdoc/>
  90. </member>
  91. <member name="P:CefSharp.BrowserSettings.ApplicationCache">
  92. <inheritdoc/>
  93. </member>
  94. <member name="P:CefSharp.BrowserSettings.WebGl">
  95. <inheritdoc/>
  96. </member>
  97. <member name="P:CefSharp.BrowserSettings.BackgroundColor">
  98. <inheritdoc/>
  99. </member>
  100. <member name="P:CefSharp.BrowserSettings.AcceptLanguageList">
  101. <inheritdoc/>
  102. </member>
  103. <member name="P:CefSharp.BrowserSettings.WindowlessFrameRate">
  104. <inheritdoc/>
  105. </member>
  106. <member name="P:CefSharp.BrowserSettings.IsDisposed">
  107. <inheritdoc/>
  108. </member>
  109. <member name="P:CefSharp.BrowserSettings.AutoDispose">
  110. <inheritdoc/>
  111. </member>
  112. <member name="M:CefSharp.BrowserSettings.Dispose">
  113. <inheritdoc/>
  114. </member>
  115. <member name="M:CefSharp.BrowserSettings.UnWrap">
  116. <summary>
  117. Used internally to get the underlying <see cref="T:CefSharp.IBrowserSettings"/> instance.
  118. Unlikely you'll use this yourself.
  119. </summary>
  120. <returns>the inner most instance</returns>
  121. </member>
  122. <member name="M:CefSharp.BrowserSettings.Create(System.Boolean)">
  123. <summary>
  124. Create a new instance of <see cref="T:CefSharp.IBrowserSettings"/>
  125. </summary>
  126. <param name="autoDispose">set to false if you plan to reuse the instance, otherwise true</param>
  127. <returns>BrowserSettings</returns>
  128. </member>
  129. <member name="T:CefSharp.BrowserSubprocess.SelfHost">
  130. <summary>
  131. SelfHost allows your application executable to be used as the BrowserSubProcess
  132. with minimal effort.
  133. </summary>
  134. <example>
  135. //WinForms Example
  136. public class Program
  137. {
  138. [STAThread]
  139. public static int Main(string[] args)
  140. {
  141. Cef.EnableHighDPISupport();
  142. var exitCode = CefSharp.BrowserSubprocess.SelfHost.Main(args);
  143. if (exitCode >= 0)
  144. {
  145. return exitCode;
  146. }
  147. var settings = new CefSettings();
  148. //Absolute path to your applications executable
  149. settings.BrowserSubprocessPath = System.Diagnostics.Process.GetCurrentProcess().MainModule.FileName;
  150. Cef.Initialize(settings);
  151. var browser = new BrowserForm(true);
  152. Application.Run(browser);
  153. return 0;
  154. }
  155. }
  156. </example>
  157. </member>
  158. <member name="M:CefSharp.BrowserSubprocess.SelfHost.Main(System.String[])">
  159. <summary>
  160. This function should be called from the application entry point function (typically Program.Main)
  161. to execute a secondary process e.g. gpu, plugin, renderer, utility
  162. This overload is specifically used for .Net Core. For hosting your own BrowserSubProcess
  163. it's preferable to use the Main method provided by this class.
  164. - Pass in command line args
  165. - To support High DPI Displays you should call Cef.EnableHighDPISupport before any other processing
  166. or add the relevant entries to your app.manifest
  167. </summary>
  168. <param name="args">command line args</param>
  169. <returns>
  170. If called for the browser process (identified by no "type" command-line value) it will return immediately
  171. with a value of -1. If called for a recognized secondary process it will block until the process should exit
  172. and then return the process exit code.
  173. </returns>
  174. </member>
  175. <member name="T:CefSharp.Cef">
  176. <summary>
  177. Global CEF methods are exposed through this class. e.g. CefInitalize maps to Cef.Initialize
  178. CEF API Doc https://magpcss.org/ceforum/apidocs3/projects/(default)/(_globals).html
  179. This class cannot be inherited.
  180. </summary>
  181. </member>
  182. <member name="P:CefSharp.Cef.IsInitialized">
  183. <summary>Gets a value that indicates whether CefSharp is initialized.</summary>
  184. <value>true if CefSharp is initialized; otherwise, false.</value>
  185. </member>
  186. <member name="P:CefSharp.Cef.CefSharpVersion">
  187. <summary>Gets a value that indicates the version of CefSharp currently being used.</summary>
  188. <value>The CefSharp version.</value>
  189. </member>
  190. <member name="P:CefSharp.Cef.CefVersion">
  191. <summary>Gets a value that indicates the CEF version currently being used.</summary>
  192. <value>The CEF Version</value>
  193. </member>
  194. <member name="P:CefSharp.Cef.ChromiumVersion">
  195. <summary>Gets a value that indicates the Chromium version currently being used.</summary>
  196. <value>The Chromium version.</value>
  197. </member>
  198. <member name="P:CefSharp.Cef.CefCommitHash">
  199. <summary>
  200. Gets a value that indicates the Git Hash for CEF version currently being used.
  201. </summary>
  202. <value>The Git Commit Hash</value>
  203. </member>
  204. <member name="M:CefSharp.Cef.Initialize(CefSharp.CefSettingsBase)">
  205. <summary>
  206. Initializes CefSharp with user-provided settings.
  207. It's important to note that Initialize and Shutdown <strong>MUST</strong> be called on your main
  208. application thread (typically the UI thread). If you call them on different
  209. threads, your application will hang. See the documentation for Cef.Shutdown() for more details.
  210. </summary>
  211. <param name="settings">CefSharp configuration settings.</param>
  212. <returns>true if successful; otherwise, false.</returns>
  213. </member>
  214. <member name="M:CefSharp.Cef.Initialize(CefSharp.CefSettingsBase,System.Boolean)">
  215. <summary>
  216. Initializes CefSharp with user-provided settings.
  217. It's important to note that Initialize/Shutdown <strong>MUST</strong> be called on your main
  218. application thread (typically the UI thread). If you call them on different
  219. threads, your application will hang. See the documentation for Cef.Shutdown() for more details.
  220. </summary>
  221. <param name="settings">CefSharp configuration settings.</param>
  222. <param name="performDependencyCheck">Check that all relevant dependencies available, throws exception if any are missing</param>
  223. <returns>true if successful; otherwise, false.</returns>
  224. </member>
  225. <member name="M:CefSharp.Cef.Initialize(CefSharp.CefSettingsBase,System.Boolean,CefSharp.IBrowserProcessHandler)">
  226. <summary>
  227. Initializes CefSharp with user-provided settings.
  228. It's important to note that Initialize/Shutdown <strong>MUST</strong> be called on your main
  229. application thread (typically the UI thread). If you call them on different
  230. threads, your application will hang. See the documentation for Cef.Shutdown() for more details.
  231. </summary>
  232. <param name="settings">CefSharp configuration settings.</param>
  233. <param name="performDependencyCheck">Check that all relevant dependencies available, throws exception if any are missing</param>
  234. <param name="browserProcessHandler">The handler for functionality specific to the browser process. Null if you don't wish to handle these events</param>
  235. <returns>true if successful; otherwise, false.</returns>
  236. </member>
  237. <member name="M:CefSharp.Cef.Initialize(CefSharp.CefSettingsBase,System.Boolean,CefSharp.IApp)">
  238. <summary>
  239. Initializes CefSharp with user-provided settings.
  240. It's important to note that Initialize/Shutdown <strong>MUST</strong> be called on your main
  241. application thread (typically the UI thread). If you call them on different
  242. threads, your application will hang. See the documentation for Cef.Shutdown() for more details.
  243. </summary>
  244. <param name="settings">CefSharp configuration settings.</param>
  245. <param name="performDependencyCheck">Check that all relevant dependencies available, throws exception if any are missing</param>
  246. <param name="cefApp">Implement this interface to provide handler implementations. Null if you don't wish to handle these events</param>
  247. <returns>true if successful; otherwise, false.</returns>
  248. </member>
  249. <member name="M:CefSharp.Cef.RunMessageLoop">
  250. <summary>
  251. Run the CEF message loop. Use this function instead of an application-
  252. provided message loop to get the best balance between performance and CPU
  253. usage. This function should only be called on the main application thread and
  254. only if Cef.Initialize() is called with a
  255. CefSettings.MultiThreadedMessageLoop value of false. This function will
  256. block until a quit message is received by the system.
  257. </summary>
  258. </member>
  259. <member name="M:CefSharp.Cef.QuitMessageLoop">
  260. <summary>
  261. Quit the CEF message loop that was started by calling Cef.RunMessageLoop().
  262. This function should only be called on the main application thread and only
  263. if Cef.RunMessageLoop() was used.
  264. </summary>
  265. </member>
  266. <member name="M:CefSharp.Cef.DoMessageLoopWork">
  267. <summary>
  268. Perform a single iteration of CEF message loop processing.This function is
  269. provided for cases where the CEF message loop must be integrated into an
  270. existing application message loop. Use of this function is not recommended
  271. for most users; use CefSettings.MultiThreadedMessageLoop if possible (the default).
  272. When using this function care must be taken to balance performance
  273. against excessive CPU usage. It is recommended to enable the
  274. CefSettings.ExternalMessagePump option when using
  275. this function so that IBrowserProcessHandler.OnScheduleMessagePumpWork()
  276. callbacks can facilitate the scheduling process. This function should only be
  277. called on the main application thread and only if Cef.Initialize() is called
  278. with a CefSettings.MultiThreadedMessageLoop value of false. This function
  279. will not block.
  280. </summary>
  281. </member>
  282. <member name="M:CefSharp.Cef.ExecuteProcess">
  283. <summary>
  284. This function should be called from the application entry point function to execute a secondary process.
  285. It can be used to run secondary processes from the browser client executable (default behavior) or
  286. from a separate executable specified by the CefSettings.browser_subprocess_path value.
  287. If called for the browser process (identified by no "type" command-line value) it will return immediately with a value of -1.
  288. If called for a recognized secondary process it will block until the process should exit and then return the process exit code.
  289. 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).
  290. </summary>
  291. </member>
  292. <member name="M:CefSharp.Cef.AddCrossOriginWhitelistEntry(System.String,System.String,System.String,System.Boolean)">
  293. <summary>Add an entry to the cross-origin whitelist.</summary>
  294. <param name="sourceOrigin">The origin allowed to be accessed by the target protocol/domain.</param>
  295. <param name="targetProtocol">The target protocol allowed to access the source origin.</param>
  296. <param name="targetDomain">The optional target domain allowed to access the source origin.</param>
  297. <param name="allowTargetSubdomains">If set to true would allow a blah.example.com if the
  298. <paramref name="targetDomain"/> was set to example.com
  299. </param>
  300. <returns>Returns false if is invalid or the whitelist cannot be accessed.</returns>
  301. <remarks>
  302. The same-origin policy restricts how scripts hosted from different origins
  303. (scheme + domain + port) can communicate. By default, scripts can only access
  304. resources with the same origin. Scripts hosted on the HTTP and HTTPS schemes
  305. (but no other schemes) can use the "Access-Control-Allow-Origin" header to
  306. allow cross-origin requests. For example, https://source.example.com can make
  307. XMLHttpRequest requests on http://target.example.com if the
  308. http://target.example.com request returns an "Access-Control-Allow-Origin:
  309. https://source.example.com" response header.
  310. Scripts in separate frames or iframes and hosted from the same protocol and
  311. domain suffix can execute cross-origin JavaScript if both pages set the
  312. document.domain value to the same domain suffix. For example,
  313. scheme://foo.example.com and scheme://bar.example.com can communicate using
  314. JavaScript if both domains set document.domain="example.com".
  315. This method is used to allow access to origins that would otherwise violate
  316. the same-origin policy. Scripts hosted underneath the fully qualified
  317. <paramref name="sourceOrigin"/> URL (like http://www.example.com) will be allowed access to
  318. all resources hosted on the specified <paramref name="targetProtocol"/> and <paramref name="targetDomain"/>.
  319. If <paramref name="targetDomain"/> is non-empty and <paramref name="allowTargetSubdomains"/> if false only
  320. exact domain matches will be allowed. If <paramref name="targetDomain"/> contains a top-
  321. level domain component (like "example.com") and <paramref name="allowTargetSubdomains"/> is
  322. true sub-domain matches will be allowed. If <paramref name="targetDomain"/> is empty and
  323. <paramref name="allowTargetSubdomains"/> if true all domains and IP addresses will be
  324. allowed.
  325. This method cannot be used to bypass the restrictions on local or display
  326. isolated schemes. See the comments on <see cref="T:CefSharp.CefCustomScheme"/> for more
  327. information.
  328. This function may be called on any thread. Returns false if <paramref name="sourceOrigin"/>
  329. is invalid or the whitelist cannot be accessed.
  330. </remarks>
  331. </member>
  332. <member name="M:CefSharp.Cef.RemoveCrossOriginWhitelistEntry(System.String,System.String,System.String,System.Boolean)">
  333. <summary>Remove entry from cross-origin whitelist</summary>
  334. <param name="sourceOrigin">The origin allowed to be accessed by the target protocol/domain.</param>
  335. <param name="targetProtocol">The target protocol allowed to access the source origin.</param>
  336. <param name="targetDomain">The optional target domain allowed to access the source origin.</param>
  337. <param name="allowTargetSubdomains">If set to true would allow a blah.example.com if the
  338. <paramref name="targetDomain"/> was set to example.com
  339. </param>
  340. <remarks>
  341. Remove an entry from the cross-origin access whitelist. Returns false if
  342. <paramref name="sourceOrigin"/> is invalid or the whitelist cannot be accessed.
  343. </remarks>
  344. </member>
  345. <member name="M:CefSharp.Cef.ClearCrossOriginWhitelist">
  346. <summary>Remove all entries from the cross-origin access whitelist.</summary>
  347. <remarks>
  348. Remove all entries from the cross-origin access whitelist. Returns false if
  349. the whitelist cannot be accessed.
  350. </remarks>
  351. </member>
  352. <member name="M:CefSharp.Cef.GetGlobalCookieManager(CefSharp.ICompletionCallback)">
  353. <summary>
  354. Returns the global cookie manager. By default data will be stored at CefSettings.CachePath if specified or in memory otherwise.
  355. Using this method is equivalent to calling Cef.GetGlobalRequestContext().GetCookieManager()
  356. The cookie managers storage is created in an async fashion, whilst this method may return a cookie manager instance,
  357. there may be a short delay before you can Get/Write cookies.
  358. To be sure the cookie manager has been initialized use one of the following
  359. - Access the ICookieManager after ICompletionCallback.OnComplete has been called
  360. - Access the ICookieManager instance in IBrowserProcessHandler.OnContextInitialized.
  361. - Use the ChromiumWebBrowser BrowserInitialized (OffScreen) or IsBrowserInitializedChanged (WinForms/WPF) events.
  362. </summary>
  363. <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>
  364. <returns>A the global cookie manager or null if the RequestContext has not yet been initialized.</returns>
  365. </member>
  366. <member name="M:CefSharp.Cef.PreShutdown">
  367. <summary>
  368. Called prior to calling Cef.Shutdown, this disposes of any remaining
  369. ChromiumWebBrowser instances. In WPF this is used from Dispatcher.ShutdownStarted
  370. to release the unmanaged resources held by the ChromiumWebBrowser instances.
  371. Generally speaking you don't need to call this yourself.
  372. </summary>
  373. </member>
  374. <member name="M:CefSharp.Cef.Shutdown">
  375. <summary>
  376. Shuts down CefSharp and the underlying CEF infrastructure. This method is safe to call multiple times; it will only
  377. shut down CEF on the first call (all subsequent calls will be ignored).
  378. This method should be called on the main application thread to shut down the CEF browser process before the application exits.
  379. If you are Using CefSharp.OffScreen then you must call this explicitly before your application exits or it will hang.
  380. This method must be called on the same thread as Initialize. If you don't call Shutdown explicitly then CefSharp.Wpf and CefSharp.WinForms
  381. versions will do their best to call Shutdown for you, if your application is having trouble closing then call thus explicitly.
  382. </summary>
  383. </member>
  384. <member name="M:CefSharp.Cef.ShutdownWithoutChecks">
  385. <summary>
  386. This method should only be used by advanced users, if you're unsure then use Cef.Shutdown().
  387. This function should be called on the main application thread to shut down
  388. the CEF browser process before the application exits. This method simply obtains a lock
  389. and calls the native CefShutdown method, only IsInitialized is checked. All ChromiumWebBrowser
  390. instances MUST be Disposed of before calling this method. If calling this method results in a crash
  391. or hangs then you're likely hanging on to some unmanaged resources or haven't closed all of your browser
  392. instances
  393. </summary>
  394. </member>
  395. <member name="M:CefSharp.Cef.ClearSchemeHandlerFactories">
  396. <summary>
  397. Clear all scheme handler factories registered with the global request context.
  398. Returns false on error. This function may be called on any thread in the browser process.
  399. Using this function is equivalent to calling Cef.GetGlobalRequestContext().ClearSchemeHandlerFactories().
  400. </summary>
  401. <returns>Returns false on error.</returns>
  402. </member>
  403. <member name="M:CefSharp.Cef.VisitWebPluginInfo(CefSharp.IWebPluginInfoVisitor)">
  404. <summary>
  405. Visit web plugin information. Can be called on any thread in the browser process.
  406. </summary>
  407. </member>
  408. <member name="M:CefSharp.Cef.GetPlugins">
  409. <summary>
  410. Async returns a list containing Plugin Information
  411. (Wrapper around CefVisitWebPluginInfo)
  412. </summary>
  413. <returns>Returns List of <see cref="T:CefSharp.WebPluginInfo"/> structs.</returns>
  414. </member>
  415. <member name="M:CefSharp.Cef.RefreshWebPlugins">
  416. <summary>
  417. Cause the plugin list to refresh the next time it is accessed regardless of whether it has already been loaded.
  418. </summary>
  419. </member>
  420. <member name="M:CefSharp.Cef.UnregisterInternalWebPlugin(System.String)">
  421. <summary>
  422. Unregister an internal plugin. This may be undone the next time RefreshWebPlugins() is called.
  423. </summary>
  424. <param name="path">Path (directory + file).</param>
  425. </member>
  426. <member name="M:CefSharp.Cef.EnableHighDPISupport">
  427. <summary>
  428. Call during process startup to enable High-DPI support on Windows 7 or newer.
  429. Older versions of Windows should be left DPI-unaware because they do not
  430. support DirectWrite and GDI fonts are kerned very badly.
  431. </summary>
  432. </member>
  433. <member name="M:CefSharp.Cef.CurrentlyOnThread(CefSharp.CefThreadIds)">
  434. <summary>
  435. Returns true if called on the specified CEF thread.
  436. </summary>
  437. <returns>Returns true if called on the specified thread.</returns>
  438. </member>
  439. <member name="M:CefSharp.Cef.GetGlobalRequestContext">
  440. <summary>
  441. Gets the Global Request Context. Make sure to Dispose of this object when finished.
  442. The earlier possible place to access the IRequestContext is in IBrowserProcessHandler.OnContextInitialized.
  443. Alternative use the ChromiumWebBrowser BrowserInitialized (OffScreen) or IsBrowserInitializedChanged (WinForms/WPF) events.
  444. </summary>
  445. <returns>Returns the global request context or null if the RequestContext has not been initialized yet.</returns>
  446. </member>
  447. <member name="M:CefSharp.Cef.ColorSetARGB(System.UInt32,System.UInt32,System.UInt32,System.UInt32)">
  448. <summary>
  449. Helper function (wrapper around the CefColorSetARGB macro) which combines
  450. the 4 color components into an uint32 for use with BackgroundColor property
  451. </summary>
  452. <param name="a">Alpha</param>
  453. <param name="r">Red</param>
  454. <param name="g">Green</param>
  455. <param name="b">Blue</param>
  456. <returns>Returns the color.</returns>
  457. </member>
  458. <member name="P:CefSharp.Cef.CrashReportingEnabled">
  459. <summary>
  460. Crash reporting is configured using an INI-style config file named
  461. crash_reporter.cfg. This file must be placed next to
  462. the main application executable. File contents are as follows:
  463. # Comments start with a hash character and must be on their own line.
  464. [Config]
  465. ProductName=&lt;Value of the &quot;prod&quot; crash key; defaults to &quot;cef&quot;&gt;
  466. ProductVersion=&lt;Value of the &quot;ver&quot; crash key; defaults to the CEF version&gt;
  467. AppName=&lt;Windows only; App-specific folder name component for storing crash
  468. information; default to &quot;CEF&quot;&gt;
  469. ExternalHandler=&lt;Windows only; Name of the external handler exe to use
  470. instead of re-launching the main exe; default to empty>
  471. ServerURL=&lt;crash server URL; default to empty&gt;
  472. RateLimitEnabled=&lt;True if uploads should be rate limited; default to true&gt;
  473. MaxUploadsPerDay=&lt;Max uploads per 24 hours, used if rate limit is enabled;
  474. default to 5&gt;
  475. MaxDatabaseSizeInMb=&lt;Total crash report disk usage greater than this value
  476. will cause older reports to be deleted; default to 20&gt;
  477. MaxDatabaseAgeInDays=&lt;Crash reports older than this value will be deleted;
  478. default to 5&gt;
  479. [CrashKeys]
  480. my_key1=&lt;small|medium|large&gt;
  481. my_key2=&lt;small|medium|large&gt;
  482. Config section:
  483. If &quot;ProductName&quot; and/or &quot;ProductVersion&quot; are set then the specified values
  484. will be included in the crash dump metadata.
  485. If &quot;AppName&quot; is set on Windows then crash report information (metrics,
  486. database and dumps) will be stored locally on disk under the
  487. &quot;C:\Users\[CurrentUser]\AppData\Local\[AppName]\User Data&quot; folder.
  488. If &quot;ExternalHandler&quot; is set on Windows then the specified exe will be
  489. launched as the crashpad-handler instead of re-launching the main process
  490. exe. The value can be an absolute path or a path relative to the main exe
  491. directory.
  492. If &quot;ServerURL&quot; is set then crashes will be uploaded as a multi-part POST
  493. request to the specified URL. Otherwise, reports will only be stored locally
  494. on disk.
  495. If &quot;RateLimitEnabled&quot; is set to true then crash report uploads will be rate
  496. limited as follows:
  497. 1. If &quot;MaxUploadsPerDay&quot; is set to a positive value then at most the
  498. specified number of crashes will be uploaded in each 24 hour period.
  499. 2. If crash upload fails due to a network or server error then an
  500. incremental backoff delay up to a maximum of 24 hours will be applied for
  501. retries.
  502. 3. If a backoff delay is applied and &quot;MaxUploadsPerDay&quot; is > 1 then the
  503. &quot;MaxUploadsPerDay&quot; value will be reduced to 1 until the client is
  504. restarted. This helps to avoid an upload flood when the network or
  505. server error is resolved.
  506. If &quot;MaxDatabaseSizeInMb&quot; is set to a positive value then crash report storage
  507. on disk will be limited to that size in megabytes. For example, on Windows
  508. each dump is about 600KB so a &quot;MaxDatabaseSizeInMb&quot; value of 20 equates to
  509. about 34 crash reports stored on disk.
  510. If &quot;MaxDatabaseAgeInDays&quot; is set to a positive value then crash reports older
  511. than the specified age in days will be deleted.
  512. CrashKeys section:
  513. Any number of crash keys can be specified for use by the application. Crash
  514. key values will be truncated based on the specified size (small = 63 bytes,
  515. medium = 252 bytes, large = 1008 bytes). The value of crash keys can be set
  516. from any thread or process using the Cef.SetCrashKeyValue function. These
  517. key/value pairs will be sent to the crash server along with the crash dump
  518. file. Medium and large values will be chunked for submission. For example,
  519. if your key is named &quot;mykey&quot; then the value will be broken into ordered
  520. chunks and submitted using keys named &quot;mykey-1&quot;, &quot;mykey-2&quot;, etc.
  521. </summary>
  522. <returns>Returns true if crash reporting is enabled.</returns>
  523. </member>
  524. <member name="M:CefSharp.Cef.SetCrashKeyValue(System.String,System.String)">
  525. <summary>
  526. Sets or clears a specific key-value pair from the crash metadata.
  527. </summary>
  528. </member>
  529. <member name="M:CefSharp.Cef.GetMinLogLevel">
  530. <summary>
  531. Gets the current log level.
  532. When <see cref="P:CefSharp.CefSettingsBase.LogSeverity"/> is set to <see cref="F:CefSharp.LogSeverity.Disable"/> then
  533. no messages will be written to the log file, but FATAL messages will still be output to stderr.
  534. When logging is disabled this method will return <see cref="F:CefSharp.LogSeverity.Fatal"/>.
  535. </summary>
  536. <returns>Current Log Level</returns>
  537. </member>
  538. <member name="M:CefSharp.Cef.RegisterWidevineCdm(System.String,CefSharp.IRegisterCdmCallback)">
  539. <summary>
  540. Register the Widevine CDM plugin.
  541. The client application is responsible for downloading an appropriate
  542. platform-specific CDM binary distribution from Google, extracting the
  543. contents, and building the required directory structure on the local machine.
  544. The <see cref="M:CefSharp.IBrowserHost.StartDownload(System.String)"/> method class can be used
  545. to implement this functionality in CefSharp. Contact Google via
  546. https://www.widevine.com/contact.html for details on CDM download.
  547. path is a directory that must contain the following files:
  548. 1. manifest.json file from the CDM binary distribution (see below).
  549. 2. widevinecdm file from the CDM binary distribution (e.g.
  550. widevinecdm.dll on Windows).
  551. 3. widevidecdmadapter file from the CEF binary distribution (e.g.
  552. widevinecdmadapter.dll on Windows).
  553. If any of these files are missing or if the manifest file has incorrect
  554. contents the registration will fail and callback will receive an ErrorCode
  555. value of <see cref="F:CefSharp.CdmRegistrationErrorCode.IncorrectContents"/>.
  556. The manifest.json file must contain the following keys:
  557. A. "os": Supported OS (e.g. "mac", "win" or "linux").
  558. B. "arch": Supported architecture (e.g. "ia32" or "x64").
  559. C. "x-cdm-module-versions": Module API version (e.g. "4").
  560. D. "x-cdm-interface-versions": Interface API version (e.g. "8").
  561. E. "x-cdm-host-versions": Host API version (e.g. "8").
  562. F. "version": CDM version (e.g. "1.4.8.903").
  563. G. "x-cdm-codecs": List of supported codecs (e.g. "vp8,vp9.0,avc1").
  564. A through E are used to verify compatibility with the current Chromium
  565. version. If the CDM is not compatible the registration will fail and
  566. callback will receive an ErrorCode value of <see cref="F:CefSharp.CdmRegistrationErrorCode.Incompatible"/>.
  567. If registration is not supported at the time that Cef.RegisterWidevineCdm() is called then callback
  568. will receive an ErrorCode value of <see cref="F:CefSharp.CdmRegistrationErrorCode.NotSupported"/>.
  569. </summary>
  570. <param name="path"> is a directory that contains the Widevine CDM files</param>
  571. <param name="callback">optional callback - <see cref="M:CefSharp.IRegisterCdmCallback.OnRegistrationComplete(CefSharp.CdmRegistration)"/>
  572. will be executed asynchronously once registration is complete</param>
  573. </member>
  574. <member name="M:CefSharp.Cef.RegisterWidevineCdmAsync(System.String)">
  575. <summary>
  576. Register the Widevine CDM plugin.
  577. See <see cref="M:CefSharp.Cef.RegisterWidevineCdm(System.String,CefSharp.IRegisterCdmCallback)"/> for more details.
  578. </summary>
  579. <param name="path"> is a directory that contains the Widevine CDM files</param>
  580. <returns>Returns a Task that can be awaited to receive the <see cref="T:CefSharp.CdmRegistration"/> response.</returns>
  581. </member>
  582. <member name="M:CefSharp.Cef.GetMimeType(System.String)">
  583. <summary>
  584. Returns the mime type for the specified file extension or an empty string if unknown.
  585. </summary>
  586. <param name="extension">file extension</param>
  587. <returns>Returns the mime type for the specified file extension or an empty string if unknown.</returns>
  588. </member>
  589. <member name="M:CefSharp.Cef.EnableWaitForBrowsersToClose">
  590. <summary>
  591. WaitForBrowsersToClose is not enabled by default, call this method
  592. before Cef.Initialize to enable. If you aren't calling Cef.Initialize
  593. explicitly then this should be called before creating your first
  594. ChromiumWebBrowser instance.
  595. </summary>
  596. </member>
  597. <member name="M:CefSharp.Cef.WaitForBrowsersToClose">
  598. <summary>
  599. Helper method to ensure all ChromiumWebBrowser instances have been
  600. closed/disposed, should be called before Cef.Shutdown.
  601. Disposes all remaining ChromiumWebBrowser instances
  602. then waits for CEF to release its remaining CefBrowser instances.
  603. Finally a small delay of 50ms to allow for CEF to finish it's cleanup.
  604. Should only be called when MultiThreadedMessageLoop = true;
  605. (Hasn't been tested when when CEF integrates into main message loop).
  606. </summary>
  607. </member>
  608. <member name="T:CefSharp.CefSettingsBase">
  609. <summary>
  610. Initialization settings. Many of these and other settings can also configured using command-line switches.
  611. WPF/WinForms/OffScreen each have their own CefSettings implementation that sets
  612. relevant settings e.g. OffScreen starts with audio muted.
  613. </summary>
  614. </member>
  615. <member name="M:CefSharp.CefSettingsBase.Dispose">
  616. <summary>
  617. Free the unmanaged CefSettingsBase instance.
  618. Under normal circumstances you shouldn't need to call this
  619. The unmanaged resource will be freed after <see cref="M:CefSharp.Cef.Initialize(CefSharp.CefSettingsBase)"/> (or one of the overloads) is called.
  620. </summary>
  621. </member>
  622. <member name="P:CefSharp.CefSettingsBase.CefCustomSchemes">
  623. <summary>
  624. Add Customs schemes to this collection.
  625. </summary>
  626. </member>
  627. <member name="P:CefSharp.CefSettingsBase.CefCommandLineArgs">
  628. <summary>
  629. Add custom command line argumens to this collection, they will be added in OnBeforeCommandLineProcessing. The
  630. CefSettings.CommandLineArgsDisabled value can be used to start with an empty command-line object. Any values specified in
  631. CefSettings that equate to command-line arguments will be set before this method is called.
  632. </summary>
  633. </member>
  634. <member name="P:CefSharp.CefSettingsBase.CommandLineArgsDisabled">
  635. <summary>
  636. Set to true to disable configuration of browser process features using standard CEF and Chromium command-line arguments.
  637. Configuration can still be specified using CEF data structures or by adding to CefCommandLineArgs.
  638. </summary>
  639. </member>
  640. <member name="P:CefSharp.CefSettingsBase.ExternalMessagePump">
  641. <summary>
  642. Set to true to control browser process main (UI) thread message pump scheduling via the
  643. IBrowserProcessHandler.OnScheduleMessagePumpWork callback. This option is recommended for use in combination with the
  644. Cef.DoMessageLoopWork() function in cases where the CEF message loop must be integrated into an existing application message
  645. loop (see additional comments and warnings on Cef.DoMessageLoopWork). Enabling this option is not recommended for most users;
  646. leave this option disabled and use either MultiThreadedMessageLoop (the default) if possible.
  647. </summary>
  648. </member>
  649. <member name="P:CefSharp.CefSettingsBase.MultiThreadedMessageLoop">
  650. <summary>
  651. Set to true to have the browser process message loop run in a separate thread. If false than the CefDoMessageLoopWork()
  652. function must be called from your application message loop. This option is only supported on Windows. The default value is
  653. true.
  654. </summary>
  655. </member>
  656. <member name="P:CefSharp.CefSettingsBase.BrowserSubprocessPath">
  657. <summary>
  658. The path to a separate executable that will be launched for sub-processes. By default the browser process executable is used.
  659. See the comments on Cef.ExecuteProcess() for details. If this value is non-empty then it must be an absolute path.
  660. Also configurable using the "browser-subprocess-path" command-line switch.
  661. Defaults to using the provided CefSharp.BrowserSubprocess.exe instance
  662. </summary>
  663. </member>
  664. <member name="P:CefSharp.CefSettingsBase.CachePath">
  665. <summary>
  666. The location where data for the global browser cache will be stored on disk. In this value is non-empty then it must be
  667. an absolute path that is must be either equal to or a child directory of CefSettings.RootCachePath (if RootCachePath is
  668. empty it will default to this value). If the value is empty then browsers will be created in "incognito mode" where
  669. in-memory caches are used for storage and no data is persisted to disk. HTML5 databases such as localStorage will only
  670. persist across sessions if a cache path is specified. Can be overridden for individual RequestContext instances via the
  671. RequestContextSettings.CachePath value.
  672. </summary>
  673. </member>
  674. <member name="P:CefSharp.CefSettingsBase.RootCachePath">
  675. <summary>
  676. The root directory that all CefSettings.CachePath and RequestContextSettings.CachePath values must have in common. If this
  677. value is empty and CefSettings.CachePath is non-empty then it will default to the CefSettings.CachePath value.
  678. If this value is non-empty then it must be an absolute path. Failure to set this value correctly may result in the sandbox
  679. blocking read/write access to the CachePath directory. NOTE: CefSharp does not implement the CHROMIUM SANDBOX. A non-empty
  680. RootCachePath can be used in conjuncation with an empty CefSettings.CachePath in instances where you would like browsers
  681. attached to the Global RequestContext (the default) created in "incognito mode" and instances created with a custom
  682. RequestContext using a disk based cache.
  683. </summary>
  684. </member>
  685. <member name="P:CefSharp.CefSettingsBase.UserDataPath">
  686. <summary>
  687. The location where user data such as spell checking dictionary files will be stored on disk. If this value is empty then the
  688. default user data directory will be used ("Local Settings\Application Data\CEF\User Data" directory under the user
  689. profile directory on Windows). If this value is non-empty then it must be an absolute path.
  690. </summary>
  691. </member>
  692. <member name="P:CefSharp.CefSettingsBase.IgnoreCertificateErrors">
  693. <summary>
  694. Set to true in order to completely ignore SSL certificate errors. This is NOT recommended.
  695. </summary>
  696. </member>
  697. <member name="P:CefSharp.CefSettingsBase.Locale">
  698. <summary>
  699. The locale string that will be passed to WebKit. If empty the default locale of "en-US" will be used. Also configurable using
  700. the "lang" command-line switch.
  701. </summary>
  702. </member>
  703. <member name="P:CefSharp.CefSettingsBase.LocalesDirPath">
  704. <summary>
  705. The fully qualified path for the locales directory. If this value is empty the locales directory must be located in the
  706. module directory. If this value is non-empty then it must be an absolute path. Also configurable using the "locales-dir-path"
  707. command-line switch.
  708. </summary>
  709. </member>
  710. <member name="P:CefSharp.CefSettingsBase.ResourcesDirPath">
  711. <summary>
  712. The fully qualified path for the resources directory. If this value is empty the cef.pak and/or devtools_resources.pak files
  713. must be located in the module directory. Also configurable using the "resources-dir-path" command-line switch.
  714. </summary>
  715. </member>
  716. <member name="P:CefSharp.CefSettingsBase.LogFile">
  717. <summary>
  718. 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
  719. a "debug.log" file will be written in the main executable directory. Also configurable using the"log-file" command- line
  720. switch.
  721. </summary>
  722. </member>
  723. <member name="P:CefSharp.CefSettingsBase.LogSeverity">
  724. <summary>
  725. The log severity. Only messages of this severity level or higher will be logged. When set to
  726. <see cref="F:CefSharp.LogSeverity.Disable"/> no messages will be written to the log file, but Fatal messages will still be
  727. output to stderr. Also configurable using the "log-severity" command-line switch with a value of "verbose", "info", "warning",
  728. "error", "fatal", "error-report" or "disable".
  729. </summary>
  730. </member>
  731. <member name="P:CefSharp.CefSettingsBase.JavascriptFlags">
  732. <summary>
  733. Custom flags that will be used when initializing the V8 JavaScript engine. The consequences of using custom flags may not be
  734. well tested. Also configurable using the "js-flags" command-line switch.
  735. </summary>
  736. </member>
  737. <member name="P:CefSharp.CefSettingsBase.PackLoadingDisabled">
  738. <summary>
  739. Set to true to disable loading of pack files for resources and locales. A resource bundle handler must be provided for the
  740. browser and render processes via CefApp.GetResourceBundleHandler() if loading of pack files is disabled. Also configurable
  741. using the "disable-pack-loading" command- line switch.
  742. </summary>
  743. </member>
  744. <member name="P:CefSharp.CefSettingsBase.ProductVersion">
  745. <summary>
  746. Value that will be inserted as the product portion of the default User-Agent string. If empty the Chromium product version
  747. will be used. If UserAgent is specified this value will be ignored. Also configurable using the "product-version" command-
  748. line switch.
  749. </summary>
  750. </member>
  751. <member name="P:CefSharp.CefSettingsBase.RemoteDebuggingPort">
  752. <summary>
  753. Set to a value between 1024 and 65535 to enable remote debugging on the specified port. For example, if 8080 is specified the
  754. remote debugging URL will be http://localhost:8080. CEF can be remotely debugged from any CEF or Chrome browser window. Also
  755. configurable using the "remote-debugging-port" command-line switch.
  756. </summary>
  757. </member>
  758. <member name="P:CefSharp.CefSettingsBase.UncaughtExceptionStackSize">
  759. <summary>
  760. The number of stack trace frames to capture for uncaught exceptions. Specify a positive value to enable the
  761. CefRenderProcessHandler. OnUncaughtException() callback. Specify 0 (default value) and OnUncaughtException() will not be
  762. called. Also configurable using the "uncaught-exception-stack-size" command-line switch.
  763. </summary>
  764. </member>
  765. <member name="P:CefSharp.CefSettingsBase.UserAgent">
  766. <summary>
  767. Value that will be returned as the User-Agent HTTP header. If empty the default User-Agent string will be used. Also
  768. configurable using the "user-agent" command-line switch.
  769. </summary>
  770. </member>
  771. <member name="P:CefSharp.CefSettingsBase.WindowlessRenderingEnabled">
  772. <summary>
  773. Set to true (1) to enable windowless (off-screen) rendering support. Do not enable this value if the application does not use
  774. windowless rendering as it may reduce rendering performance on some systems.
  775. </summary>
  776. </member>
  777. <member name="P:CefSharp.CefSettingsBase.PersistSessionCookies">
  778. <summary>
  779. To persist session cookies (cookies without an expiry date or validity interval) by default when using the global cookie
  780. manager set this value to true. Session cookies are generally intended to be transient and most Web browsers do not persist
  781. them. A CachePath value must also be specified to enable this feature. Also configurable using the "persist-session-cookies"
  782. command-line switch. Can be overridden for individual RequestContext instances via the
  783. RequestContextSettings.PersistSessionCookies value.
  784. </summary>
  785. </member>
  786. <member name="P:CefSharp.CefSettingsBase.PersistUserPreferences">
  787. <summary>
  788. To persist user preferences as a JSON file in the cache path directory set this value to true. A CachePath value must also be
  789. specified to enable this feature. Also configurable using the "persist-user-preferences" command-line switch. Can be
  790. overridden for individual RequestContext instances via the RequestContextSettings.PersistUserPreferences value.
  791. </summary>
  792. </member>
  793. <member name="P:CefSharp.CefSettingsBase.AcceptLanguageList">
  794. <summary>
  795. Comma delimited ordered list of language codes without any whitespace that will be used in the "Accept-Language" HTTP header.
  796. May be set globally using the CefSettings.AcceptLanguageList value. If both values are empty then "en-US,en" will be used.
  797. </summary>
  798. </member>
  799. <member name="P:CefSharp.CefSettingsBase.BackgroundColor">
  800. <summary>
  801. Background color used for the browser before a document is loaded and when no document color is specified. The alpha
  802. component must be either fully opaque (0xFF) or fully transparent (0x00). If the alpha component is fully opaque then the RGB
  803. components will be used as the background color. If the alpha component is fully transparent for a WinForms browser then the
  804. default value of opaque white be used. If the alpha component is fully transparent for a windowless (WPF/OffScreen) browser
  805. then transparent painting will be enabled.
  806. </summary>
  807. </member>
  808. <member name="P:CefSharp.CefSettingsBase.ApplicationClientIdForFileScanning">
  809. <summary>
  810. GUID string used for identifying the application. This is passed to the system AV function for scanning downloaded files. By
  811. default, the GUID will be an empty string and the file will be treated as an untrusted file when the GUID is empty.
  812. </summary>
  813. </member>
  814. <member name="M:CefSharp.CefSettingsBase.RegisterScheme(CefSharp.CefCustomScheme)">
  815. <summary>
  816. Registers a custom scheme using the provided settings.
  817. </summary>
  818. <param name="scheme">The CefCustomScheme which provides the details about the scheme.</param>
  819. </member>
  820. <member name="M:CefSharp.CefSettingsBase.DisableGpuAcceleration">
  821. <summary>
  822. Set command line argument to disable GPU Acceleration. WebGL will use
  823. software rendering via Swiftshader (https://swiftshader.googlesource.com/SwiftShader#introduction)
  824. </summary>
  825. </member>
  826. <member name="M:CefSharp.CefSettingsBase.EnablePrintPreview">
  827. <summary>
  828. Set command line argument to enable Print Preview See
  829. https://bitbucket.org/chromiumembedded/cef/issues/123/add-support-for-print-preview for details.
  830. </summary>
  831. </member>
  832. <member name="M:CefSharp.CefSettingsBase.SetOffScreenRenderingBestPerformanceArgs">
  833. <summary>
  834. Set command line arguments for best OSR (Offscreen and WPF) Rendering performance Swiftshader will be used for WebGL, look at the source
  835. to determine which flags best suite your requirements. See https://swiftshader.googlesource.com/SwiftShader#introduction for
  836. details on Swiftshader
  837. </summary>
  838. </member>
  839. <member name="T:CefSharp.DragData">
  840. <summary>
  841. Used to represent Drag Data.
  842. </summary>
  843. </member>
  844. <member name="M:CefSharp.DragData.Create">
  845. <summary>
  846. Create a new instance of <see cref="T:CefSharp.IDragData"/>
  847. </summary>
  848. <returns>DragData</returns>
  849. </member>
  850. <member name="T:CefSharp.ManagedCefBrowserAdapter">
  851. <summary>
  852. Create <see cref="T:CefSharp.Internals.IBrowserAdapter"/> instance via <see cref="M:CefSharp.ManagedCefBrowserAdapter.Create(CefSharp.Internals.IWebBrowserInternal,System.Boolean)"/>
  853. This is the primary object for bridging the ChromiumWebBrowser implementation and VC++
  854. </summary>
  855. </member>
  856. <member name="M:CefSharp.ManagedCefBrowserAdapter.Create(CefSharp.Internals.IWebBrowserInternal,System.Boolean)">
  857. <summary>
  858. Create a new <see cref="T:CefSharp.Internals.IBrowserAdapter"/> instance which is the main method of interaction between the unmanged
  859. CEF implementation and our ChromiumWebBrowser instances.
  860. </summary>
  861. <param name="webBrowserInternal">reference to the ChromiumWebBrowser instance</param>
  862. <param name="offScreenRendering">true for WPF/OffScreen, false for WinForms and other Hwnd based implementations</param>
  863. <returns>instance of <see cref="T:CefSharp.Internals.IBrowserAdapter"/></returns>
  864. </member>
  865. <member name="T:CefSharp.NativeMethodWrapper">
  866. <summary>
  867. Native static methods for low level operations, memory copy
  868. Avoids having to P/Invoke as we can call the C++ API directly.
  869. </summary>
  870. </member>
  871. <member name="T:CefSharp.PostData">
  872. <inheritdoc/>
  873. </member>
  874. <member name="P:CefSharp.PostData.Elements">
  875. <inheritdoc/>
  876. </member>
  877. <member name="P:CefSharp.PostData.IsReadOnly">
  878. <inheritdoc/>
  879. </member>
  880. <member name="P:CefSharp.PostData.IsDisposed">
  881. <inheritdoc/>
  882. </member>
  883. <member name="P:CefSharp.PostData.HasExcludedElements">
  884. <inheritdoc/>
  885. </member>
  886. <member name="M:CefSharp.PostData.AddElement(CefSharp.IPostDataElement)">
  887. <inheritdoc/>
  888. </member>
  889. <member name="M:CefSharp.PostData.CreatePostDataElement">
  890. <inheritdoc/>
  891. </member>
  892. <member name="M:CefSharp.PostData.Dispose">
  893. <inheritdoc/>
  894. </member>
  895. <member name="M:CefSharp.PostData.RemoveElement(CefSharp.IPostDataElement)">
  896. <inheritdoc/>
  897. </member>
  898. <member name="M:CefSharp.PostData.RemoveElements">
  899. <inheritdoc/>
  900. </member>
  901. <member name="M:CefSharp.PostData.UnWrap">
  902. <summary>
  903. Used internally to get the underlying <see cref="T:CefSharp.IPostData"/> instance.
  904. Unlikely you'll use this yourself.
  905. </summary>
  906. <returns>the inner most instance</returns>
  907. </member>
  908. <member name="M:CefSharp.PostData.Create">
  909. <summary>
  910. Create a new instance of <see cref="T:CefSharp.IPostData"/>
  911. </summary>
  912. <returns>PostData</returns>
  913. </member>
  914. <member name="T:CefSharp.PostDataElement">
  915. <summary>
  916. Class used to represent a single element in the request post data.
  917. The methods of this class may be called on any thread.
  918. </summary>
  919. </member>
  920. <member name="P:CefSharp.PostDataElement.File">
  921. <inheritdoc/>
  922. </member>
  923. <member name="P:CefSharp.PostDataElement.IsReadOnly">
  924. <inheritdoc/>
  925. </member>
  926. <member name="P:CefSharp.PostDataElement.Type">
  927. <inheritdoc/>
  928. </member>
  929. <member name="P:CefSharp.PostDataElement.Bytes">
  930. <inheritdoc/>
  931. </member>
  932. <member name="M:CefSharp.PostDataElement.Dispose">
  933. <inheritdoc/>
  934. </member>
  935. <member name="M:CefSharp.PostDataElement.SetToEmpty">
  936. <inheritdoc/>
  937. </member>
  938. <member name="M:CefSharp.PostDataElement.UnWrap">
  939. <summary>
  940. Used internally to get the underlying <see cref="T:CefSharp.IPostDataElement"/> instance.
  941. Unlikely you'll use this yourself.
  942. </summary>
  943. <returns>the inner most instance</returns>
  944. </member>
  945. <member name="M:CefSharp.PostDataElement.Create">
  946. <summary>
  947. Create a new instance of <see cref="T:CefSharp.IPostDataElement"/>
  948. </summary>
  949. <returns>PostDataElement</returns>
  950. </member>
  951. <member name="T:CefSharp.Core.ObjectFactory">
  952. <summary>
  953. Create instances of Public Api classes, <see cref="T:CefSharp.IBrowserSettings"/>,
  954. <see cref="T:CefSharp.IWindowInfo"/> etc.
  955. </summary>
  956. </member>
  957. <member name="M:CefSharp.Core.ObjectFactory.CreateBrowserSettings(System.Boolean)">
  958. <summary>
  959. Create a new instance of <see cref="T:CefSharp.IBrowserSettings"/>
  960. </summary>
  961. <param name="autoDispose">Dispose of browser setings after it has been used to create a browser</param>
  962. <returns>returns new instance of <see cref="T:CefSharp.IBrowserSettings"/></returns>
  963. </member>
  964. <member name="M:CefSharp.Core.ObjectFactory.CreateWindowInfo">
  965. <summary>
  966. Create a new instance of <see cref="T:CefSharp.IWindowInfo"/>
  967. </summary>
  968. <returns>returns new instance of <see cref="T:CefSharp.IWindowInfo"/></returns>
  969. </member>
  970. <member name="M:CefSharp.Core.ObjectFactory.CreatePostData">
  971. <summary>
  972. Create a new instance of <see cref="T:CefSharp.IPostData"/>
  973. </summary>
  974. <returns>returns new instance of <see cref="T:CefSharp.IPostData"/></returns>
  975. </member>
  976. <member name="M:CefSharp.Core.ObjectFactory.CreatePostDataElement">
  977. <summary>
  978. Create a new instance of <see cref="T:CefSharp.IPostDataElement"/>
  979. </summary>
  980. <returns>returns new instance of <see cref="T:CefSharp.IPostDataElement"/></returns>
  981. </member>
  982. <member name="M:CefSharp.Core.ObjectFactory.CreateRequest">
  983. <summary>
  984. Create a new instance of <see cref="T:CefSharp.IRequest"/>
  985. </summary>
  986. <returns>returns new instance of <see cref="T:CefSharp.IRequest"/></returns>
  987. </member>
  988. <member name="M:CefSharp.Core.ObjectFactory.CreateUrlRequest(CefSharp.IRequest,CefSharp.IUrlRequestClient)">
  989. <summary>
  990. Create a new instance of <see cref="T:CefSharp.IUrlRequest"/>
  991. </summary>
  992. <param name="request">request</param>
  993. <param name="urlRequestClient">url request client</param>
  994. <returns>returns new instance of <see cref="T:CefSharp.IUrlRequest"/></returns>
  995. </member>
  996. <member name="M:CefSharp.Core.ObjectFactory.CreateUrlRequest(CefSharp.IRequest,CefSharp.IUrlRequestClient,CefSharp.IRequestContext)">
  997. <summary>
  998. Create a new instance of <see cref="T:CefSharp.IUrlRequest"/>
  999. </summary>
  1000. <param name="request">request</param>
  1001. <param name="urlRequestClient">url request client</param>
  1002. <param name="requestContext">request context</param>
  1003. <returns>returns new instance of <see cref="T:CefSharp.IUrlRequest"/></returns>
  1004. </member>
  1005. <member name="M:CefSharp.Core.ObjectFactory.CreateDragData">
  1006. <summary>
  1007. Create a new instance of <see cref="T:CefSharp.IDragData"/>
  1008. </summary>
  1009. <returns>returns new instance of <see cref="T:CefSharp.IDragData"/></returns>
  1010. </member>
  1011. <member name="M:CefSharp.Core.ObjectFactory.ConfigureRequestContext">
  1012. <summary>
  1013. Create a new <see cref="T:CefSharp.RequestContextBuilder"/> which can be used to
  1014. create a new <see cref="T:CefSharp.IRequestContext"/> in a fluent flashion.
  1015. Call <see cref="M:CefSharp.RequestContextBuilder.Create"/> to create the actual
  1016. <see cref="T:CefSharp.IRequestContext"/> instance
  1017. </summary>
  1018. <returns>RequestContextBuilder</returns>
  1019. </member>
  1020. <member name="T:CefSharp.Request">
  1021. <inheritdoc/>
  1022. </member>
  1023. <member name="P:CefSharp.Request.Flags">
  1024. <inheritdoc/>
  1025. </member>
  1026. <member name="P:CefSharp.Request.Url">
  1027. <inheritdoc/>
  1028. </member>
  1029. <member name="P:CefSharp.Request.Identifier">
  1030. <inheritdoc/>
  1031. </member>
  1032. <member name="P:CefSharp.Request.Method">
  1033. <inheritdoc/>
  1034. </member>
  1035. <member name="P:CefSharp.Request.ReferrerUrl">
  1036. <inheritdoc/>
  1037. </member>
  1038. <member name="P:CefSharp.Request.ResourceType">
  1039. <inheritdoc/>
  1040. </member>
  1041. <member name="P:CefSharp.Request.ReferrerPolicy">
  1042. <inheritdoc/>
  1043. </member>
  1044. <member name="P:CefSharp.Request.Headers">
  1045. <inheritdoc/>
  1046. </member>
  1047. <member name="P:CefSharp.Request.PostData">
  1048. <inheritdoc/>
  1049. </member>
  1050. <member name="P:CefSharp.Request.TransitionType">
  1051. <inheritdoc/>
  1052. </member>
  1053. <member name="P:CefSharp.Request.IsDisposed">
  1054. <inheritdoc/>
  1055. </member>
  1056. <member name="P:CefSharp.Request.IsReadOnly">
  1057. <inheritdoc/>
  1058. </member>
  1059. <member name="M:CefSharp.Request.Dispose">
  1060. <inheritdoc/>
  1061. </member>
  1062. <member name="M:CefSharp.Request.GetHeaderByName(System.String)">
  1063. <inheritdoc/>
  1064. </member>
  1065. <member name="M:CefSharp.Request.InitializePostData">
  1066. <inheritdoc/>
  1067. </member>
  1068. <member name="M:CefSharp.Request.SetHeaderByName(System.String,System.String,System.Boolean)">
  1069. <inheritdoc/>
  1070. </member>
  1071. <member name="M:CefSharp.Request.SetReferrer(System.String,CefSharp.ReferrerPolicy)">
  1072. <inheritdoc/>
  1073. </member>
  1074. <member name="M:CefSharp.Request.UnWrap">
  1075. <summary>
  1076. Used internally to get the underlying <see cref="T:CefSharp.IRequest"/> instance.
  1077. Unlikely you'll use this yourself.
  1078. </summary>
  1079. <returns>the inner most instance</returns>
  1080. </member>
  1081. <member name="M:CefSharp.Request.Create">
  1082. <summary>
  1083. Create a new <see cref="T:CefSharp.IRequest"/> instance
  1084. </summary>
  1085. <returns>Request</returns>
  1086. </member>
  1087. <member name="T:CefSharp.RequestContext">
  1088. <inheritdoc/>
  1089. </member>
  1090. <member name="M:CefSharp.RequestContext.#ctor">
  1091. <inheritdoc/>
  1092. </member>
  1093. <member name="M:CefSharp.RequestContext.#ctor(CefSharp.IRequestContext)">
  1094. <inheritdoc/>
  1095. </member>
  1096. <member name="M:CefSharp.RequestContext.#ctor(CefSharp.IRequestContext,CefSharp.IRequestContextHandler)">
  1097. <inheritdoc/>
  1098. </member>
  1099. <member name="M:CefSharp.RequestContext.#ctor(CefSharp.IRequestContextHandler)">
  1100. <inheritdoc/>
  1101. </member>
  1102. <member name="M:CefSharp.RequestContext.#ctor(CefSharp.RequestContextSettings)">
  1103. <inheritdoc/>
  1104. </member>
  1105. <member name="M:CefSharp.RequestContext.#ctor(CefSharp.RequestContextSettings,CefSharp.IRequestContextHandler)">
  1106. <inheritdoc/>
  1107. </member>
  1108. <member name="M:CefSharp.RequestContext.Configure">
  1109. <summary>
  1110. Creates a new RequestContextBuilder which can be used to fluently set
  1111. preferences
  1112. </summary>
  1113. <returns>Returns a new RequestContextBuilder</returns>
  1114. </member>
  1115. <member name="P:CefSharp.RequestContext.IsGlobal">
  1116. <inheritdoc/>
  1117. </member>
  1118. <member name="P:CefSharp.RequestContext.CachePath">
  1119. <inheritdoc/>
  1120. </member>
  1121. <member name="M:CefSharp.RequestContext.IsSame(CefSharp.IRequestContext)">
  1122. <inheritdoc/>
  1123. </member>
  1124. <member name="M:CefSharp.RequestContext.IsSharingWith(CefSharp.IRequestContext)">
  1125. <inheritdoc/>
  1126. </member>
  1127. <member name="M:CefSharp.RequestContext.GetCookieManager(CefSharp.ICompletionCallback)">
  1128. <inheritdoc/>
  1129. </member>
  1130. <member name="M:CefSharp.RequestContext.RegisterSchemeHandlerFactory(System.String,System.String,CefSharp.ISchemeHandlerFactory)">
  1131. <inheritdoc/>
  1132. </member>
  1133. <member name="M:CefSharp.RequestContext.ClearSchemeHandlerFactories">
  1134. <inheritdoc/>
  1135. </member>
  1136. <member name="M:CefSharp.RequestContext.PurgePluginListCache(System.Boolean)">
  1137. <inheritdoc/>
  1138. </member>
  1139. <member name="M:CefSharp.RequestContext.HasPreference(System.String)">
  1140. <inheritdoc/>
  1141. </member>
  1142. <member name="M:CefSharp.RequestContext.GetPreference(System.String)">
  1143. <inheritdoc/>
  1144. </member>
  1145. <member name="M:CefSharp.RequestContext.GetAllPreferences(System.Boolean)">
  1146. <inheritdoc/>
  1147. </member>
  1148. <member name="M:CefSharp.RequestContext.CanSetPreference(System.String)">
  1149. <inheritdoc/>
  1150. </member>
  1151. <member name="M:CefSharp.RequestContext.SetPreference(System.String,System.Object,System.String@)">
  1152. <inheritdoc/>
  1153. </member>
  1154. <member name="M:CefSharp.RequestContext.ClearCertificateExceptions(CefSharp.ICompletionCallback)">
  1155. <inheritdoc/>
  1156. </member>
  1157. <member name="M:CefSharp.RequestContext.ClearHttpAuthCredentials(CefSharp.ICompletionCallback)">
  1158. <inheritdoc/>
  1159. </member>
  1160. <member name="M:CefSharp.RequestContext.CloseAllConnections(CefSharp.ICompletionCallback)">
  1161. <inheritdoc/>
  1162. </member>
  1163. <member name="M:CefSharp.RequestContext.ResolveHostAsync(System.Uri)">
  1164. <inheritdoc/>
  1165. </member>
  1166. <member name="M:CefSharp.RequestContext.DidLoadExtension(System.String)">
  1167. <inheritdoc/>
  1168. </member>
  1169. <member name="M:CefSharp.RequestContext.GetExtension(System.String)">
  1170. <inheritdoc/>
  1171. </member>
  1172. <member name="M:CefSharp.RequestContext.GetExtensions(System.Collections.Generic.IList{System.String}@)">
  1173. <inheritdoc/>
  1174. </member>
  1175. <member name="M:CefSharp.RequestContext.HasExtension(System.String)">
  1176. <inheritdoc/>
  1177. </member>
  1178. <member name="M:CefSharp.RequestContext.LoadExtension(System.String,System.String,CefSharp.IExtensionHandler)">
  1179. <inheritdoc/>
  1180. </member>
  1181. <member name="M:CefSharp.RequestContext.Dispose">
  1182. <inheritdoc/>
  1183. </member>
  1184. <member name="M:CefSharp.RequestContext.UnWrap">
  1185. <summary>
  1186. Used internally to get the underlying <see cref="T:CefSharp.IRequestContext"/> instance.
  1187. Unlikely you'll use this yourself.
  1188. </summary>
  1189. <returns>the inner most instance</returns>
  1190. </member>
  1191. <member name="T:CefSharp.RequestContextBuilder">
  1192. <summary>
  1193. Fluent style builder for creating IRequestContext instances.
  1194. </summary>
  1195. </member>
  1196. <member name="M:CefSharp.RequestContextBuilder.Create">
  1197. <summary>
  1198. Create the actual RequestContext instance
  1199. </summary>
  1200. <returns>Returns a new RequestContext instance.</returns>
  1201. </member>
  1202. <member name="M:CefSharp.RequestContextBuilder.OnInitialize(System.Action{CefSharp.IRequestContext})">
  1203. <summary>
  1204. Action is called in IRequestContextHandler.OnRequestContextInitialized
  1205. </summary>
  1206. <param name="action">called when the context has been initialized.</param>
  1207. <returns>Returns RequestContextBuilder instance</returns>
  1208. </member>
  1209. <member name="M:CefSharp.RequestContextBuilder.WithCachePath(System.String)">
  1210. <summary>
  1211. Sets the Cache Path
  1212. </summary>
  1213. <param name="cachePath">
  1214. The location where cache data for this request context will be stored on
  1215. disk. If this value is non-empty then it must be an absolute path that is
  1216. either equal to or a child directory of CefSettings.RootCachePath.
  1217. If the value is empty then browsers will be created in "incognito mode"
  1218. where in-memory caches are used for storage and no data is persisted to disk.
  1219. HTML5 databases such as localStorage will only persist across sessions if a
  1220. cache path is specified. To share the global browser cache and related
  1221. configuration set this value to match the CefSettings.CachePath value.
  1222. </param>
  1223. <returns>Returns RequestContextBuilder instance</returns>
  1224. </member>
  1225. <member name="M:CefSharp.RequestContextBuilder.PersistUserPreferences">
  1226. <summary>
  1227. Invoke this method tp persist user preferences as a JSON file in the cache path directory.
  1228. Can be set globally using the CefSettings.PersistUserPreferences value.
  1229. This value will be ignored if CachePath is empty or if it matches the CefSettings.CachePath value.
  1230. </summary>
  1231. <returns>Returns RequestContextBuilder instance</returns>
  1232. </member>
  1233. <member name="M:CefSharp.RequestContextBuilder.WithPreference(System.String,System.Object)">
  1234. <summary>
  1235. Set the value associated with preference name when the RequestContext
  1236. is initialzied. If value is null the preference will be restored to its
  1237. default value. If setting the preference fails no error is throw, you
  1238. must check the CEF Log file.
  1239. Preferences set via the command-line usually cannot be modified.
  1240. </summary>
  1241. <param name="name">preference key</param>
  1242. <param name="value">preference value</param>
  1243. <returns>Returns RequestContextBuilder instance</returns>
  1244. </member>
  1245. <member name="M:CefSharp.RequestContextBuilder.WithProxyServer(System.String)">
  1246. <summary>
  1247. Set the Proxy server when the RequestContext is initialzied.
  1248. If value is null the preference will be restored to its
  1249. default value. If setting the preference fails no error is throw, you
  1250. must check the CEF Log file.
  1251. Proxy set via the command-line cannot be modified.
  1252. </summary>
  1253. <param name="host">proxy host</param>
  1254. <returns>Returns RequestContextBuilder instance</returns>
  1255. </member>
  1256. <member name="M:CefSharp.RequestContextBuilder.WithProxyServer(System.String,System.Nullable{System.Int32})">
  1257. <summary>
  1258. Set the Proxy server when the RequestContext is initialzied.
  1259. If value is null the preference will be restored to its
  1260. default value. If setting the preference fails no error is throw, you
  1261. must check the CEF Log file.
  1262. Proxy set via the command-line cannot be modified.
  1263. </summary>
  1264. <param name="host">proxy host</param>
  1265. <param name="port">proxy port (optional)</param>
  1266. <returns>Returns RequestContextBuilder instance</returns>
  1267. </member>
  1268. <member name="M:CefSharp.RequestContextBuilder.WithProxyServer(System.String,System.String,System.Nullable{System.Int32})">
  1269. <summary>
  1270. Set the Proxy server when the RequestContext is initialzied.
  1271. If value is null the preference will be restored to its
  1272. default value. If setting the preference fails no error is throw, you
  1273. must check the CEF Log file.
  1274. Proxy set via the command-line cannot be modified.
  1275. </summary>
  1276. <param name="scheme">proxy scheme</param>
  1277. <param name="host">proxy host</param>
  1278. <param name="port">proxy port (optional)</param>
  1279. <returns>Returns RequestContextBuilder instance</returns>
  1280. </member>
  1281. <member name="M:CefSharp.RequestContextBuilder.WithSharedSettings(CefSharp.IRequestContext)">
  1282. <summary>
  1283. Shares storage with other RequestContext
  1284. </summary>
  1285. <param name="other">shares storage with this RequestContext</param>
  1286. <returns>Returns RequestContextBuilder instance</returns>
  1287. </member>
  1288. <member name="T:CefSharp.RequestContextSettings">
  1289. <summary>
  1290. RequestContext Settings
  1291. </summary>
  1292. </member>
  1293. <member name="P:CefSharp.RequestContextSettings.PersistSessionCookies">
  1294. <summary>
  1295. To persist session cookies (cookies without an expiry date or validity
  1296. interval) by default when using the global cookie manager set this value to
  1297. true. Session cookies are generally intended to be transient and most
  1298. Web browsers do not persist them. Can be set globally using the
  1299. CefSettings.PersistSessionCookies value. This value will be ignored if
  1300. CachePath is empty or if it matches the CefSettings.CachePath value.
  1301. </summary>
  1302. </member>
  1303. <member name="P:CefSharp.RequestContextSettings.PersistUserPreferences">
  1304. <summary>
  1305. To persist user preferences as a JSON file in the cache path directory set
  1306. this value to true. Can be set globally using the
  1307. CefSettings.PersistUserPreferences value. This value will be ignored if
  1308. CachePath is empty or if it matches the CefSettings.CachePath value.
  1309. </summary>
  1310. </member>
  1311. <member name="P:CefSharp.RequestContextSettings.CachePath">
  1312. <summary>
  1313. The location where cache data for this request context will be stored on
  1314. disk. If this value is non-empty then it must be an absolute path that is
  1315. either equal to or a child directory of CefSettings.RootCachePath.
  1316. If the value is empty then browsers will be created in "incognito mode"
  1317. where in-memory caches are used for storage and no data is persisted to disk.
  1318. HTML5 databases such as localStorage will only persist across sessions if a
  1319. cache path is specified. To share the global browser cache and related
  1320. configuration set this value to match the CefSettings.CachePath value.
  1321. </summary>
  1322. </member>
  1323. <member name="P:CefSharp.RequestContextSettings.AcceptLanguageList">
  1324. <summary>
  1325. Comma delimited ordered list of language codes without any whitespace that
  1326. will be used in the "Accept-Language" HTTP header. Can be set globally
  1327. using the CefSettings.accept_language_list value or overridden on a per-
  1328. browser basis using the BrowserSettings.AcceptLanguageList value. If
  1329. all values are empty then "en-US,en" will be used. This value will be
  1330. ignored if CachePath matches the CefSettings.CachePath value.
  1331. </summary>
  1332. </member>
  1333. <member name="P:CefSharp.RequestContextSettings.IgnoreCertificateErrors">
  1334. <summary>
  1335. Set to true to ignore errors related to invalid SSL certificates.
  1336. Enabling this setting can lead to potential security vulnerabilities like
  1337. "man in the middle" attacks. Applications that load content from the
  1338. internet should not enable this setting. Can be set globally using the
  1339. CefSettings.IgnoreCertificateErrors value. This value will be ignored if
  1340. CachePath matches the CefSettings.cache_path value.
  1341. </summary>
  1342. </member>
  1343. <member name="T:CefSharp.UrlRequest">
  1344. <inheritdoc/>
  1345. </member>
  1346. <member name="M:CefSharp.UrlRequest.#ctor(CefSharp.IRequest,CefSharp.IUrlRequestClient)">
  1347. <summary>
  1348. Create a new URL request that is not associated with a specific browser or frame.
  1349. Use <see cref="M:CefSharp.IFrame.CreateUrlRequest(CefSharp.IRequest,CefSharp.IUrlRequestClient)"/> instead if you want the
  1350. request to have this association, in which case it may be handled differently.
  1351. 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"/>.
  1352. POST data may only contain only a single element of type PDE_TYPE_FILE or PDE_TYPE_BYTES.
  1353. Uses the Global RequestContext
  1354. </summary>
  1355. <param name="request">request</param>
  1356. <param name="urlRequestClient">url request client</param>
  1357. </member>
  1358. <member name="M:CefSharp.UrlRequest.#ctor(CefSharp.IRequest,CefSharp.IUrlRequestClient,CefSharp.IRequestContext)">
  1359. <summary>
  1360. Create a new URL request that is not associated with a specific browser or frame.
  1361. Use <see cref="M:CefSharp.IFrame.CreateUrlRequest(CefSharp.IRequest,CefSharp.IUrlRequestClient)"/> instead if you want the
  1362. request to have this association, in which case it may be handled differently.
  1363. 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"/>.
  1364. POST data may only contain only a single element of type PDE_TYPE_FILE or PDE_TYPE_BYTES.
  1365. </summary>
  1366. <param name="request">request</param>
  1367. <param name="urlRequestClient">url request client</param>
  1368. <param name="requestContext">request context associated with this requets.</param>
  1369. </member>
  1370. <member name="P:CefSharp.UrlRequest.ResponseWasCached">
  1371. <inheritdoc/>
  1372. </member>
  1373. <member name="P:CefSharp.UrlRequest.Response">
  1374. <inheritdoc/>
  1375. </member>
  1376. <member name="P:CefSharp.UrlRequest.RequestStatus">
  1377. <inheritdoc/>
  1378. </member>
  1379. <member name="M:CefSharp.UrlRequest.Dispose">
  1380. <inheritdoc/>
  1381. </member>
  1382. <member name="M:CefSharp.UrlRequest.Create(CefSharp.IRequest,CefSharp.IUrlRequestClient)">
  1383. <summary>
  1384. Create a new URL request that is not associated with a specific browser or frame.
  1385. Use <see cref="M:CefSharp.IFrame.CreateUrlRequest(CefSharp.IRequest,CefSharp.IUrlRequestClient)"/> instead if you want the
  1386. request to have this association, in which case it may be handled differently.
  1387. 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"/>.
  1388. POST data may only contain only a single element of type PDE_TYPE_FILE or PDE_TYPE_BYTES.
  1389. Uses the Global RequestContext
  1390. </summary>
  1391. <param name="request">request</param>
  1392. <param name="urlRequestClient">url request client</param>
  1393. </member>
  1394. <member name="M:CefSharp.UrlRequest.Create(CefSharp.IRequest,CefSharp.IUrlRequestClient,CefSharp.IRequestContext)">
  1395. <summary>
  1396. Create a new URL request that is not associated with a specific browser or frame.
  1397. Use <see cref="M:CefSharp.IFrame.CreateUrlRequest(CefSharp.IRequest,CefSharp.IUrlRequestClient)"/> instead if you want the
  1398. request to have this association, in which case it may be handled differently.
  1399. 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"/>.
  1400. POST data may only contain only a single element of type PDE_TYPE_FILE or PDE_TYPE_BYTES.
  1401. </summary>
  1402. <param name="request">request</param>
  1403. <param name="urlRequestClient">url request client</param>
  1404. <param name="requestContext">request context associated with this requets.</param>
  1405. </member>
  1406. <member name="T:CefSharp.WebBrowserExtensionsEx">
  1407. <summary>
  1408. Extended WebBrowserExtensions
  1409. </summary>
  1410. </member>
  1411. <member name="M:CefSharp.WebBrowserExtensionsEx.GetVisibleNavigationEntryAsync(CefSharp.IWebBrowser)">
  1412. <summary>
  1413. Retrieve the current <see cref="T:CefSharp.NavigationEntry"/>. Contains information like
  1414. <see cref="P:CefSharp.NavigationEntry.HttpStatusCode"/> and <see cref="P:CefSharp.NavigationEntry.SslStatus"/>
  1415. </summary>
  1416. <param name="browser">The ChromiumWebBrowser instance this method extends.</param>
  1417. <returns>
  1418. <see cref="T:System.Threading.Tasks.Task`1"/> that when executed returns the current <see cref="T:CefSharp.NavigationEntry"/> or null
  1419. </returns>
  1420. </member>
  1421. <member name="T:CefSharp.WindowInfo">
  1422. <inheritdoc/>
  1423. </member>
  1424. <member name="P:CefSharp.WindowInfo.X">
  1425. <inheritdoc/>
  1426. </member>
  1427. <member name="P:CefSharp.WindowInfo.Y">
  1428. <inheritdoc/>
  1429. </member>
  1430. <member name="P:CefSharp.WindowInfo.Width">
  1431. <inheritdoc/>
  1432. </member>
  1433. <member name="P:CefSharp.WindowInfo.Height">
  1434. <inheritdoc/>
  1435. </member>
  1436. <member name="P:CefSharp.WindowInfo.Style">
  1437. <inheritdoc/>
  1438. </member>
  1439. <member name="P:CefSharp.WindowInfo.ExStyle">
  1440. <inheritdoc/>
  1441. </member>
  1442. <member name="P:CefSharp.WindowInfo.ParentWindowHandle">
  1443. <inheritdoc/>
  1444. </member>
  1445. <member name="P:CefSharp.WindowInfo.WindowlessRenderingEnabled">
  1446. <inheritdoc/>
  1447. </member>
  1448. <member name="P:CefSharp.WindowInfo.SharedTextureEnabled">
  1449. <inheritdoc/>
  1450. </member>
  1451. <member name="P:CefSharp.WindowInfo.ExternalBeginFrameEnabled">
  1452. <inheritdoc/>
  1453. </member>
  1454. <member name="P:CefSharp.WindowInfo.WindowHandle">
  1455. <inheritdoc/>
  1456. </member>
  1457. <member name="M:CefSharp.WindowInfo.Dispose">
  1458. <inheritdoc/>
  1459. </member>
  1460. <member name="M:CefSharp.WindowInfo.SetAsChild(System.IntPtr)">
  1461. <inheritdoc/>
  1462. </member>
  1463. <member name="M:CefSharp.WindowInfo.SetAsChild(System.IntPtr,System.Int32,System.Int32,System.Int32,System.Int32)">
  1464. <inheritdoc/>
  1465. </member>
  1466. <member name="M:CefSharp.WindowInfo.SetAsPopup(System.IntPtr,System.String)">
  1467. <inheritdoc/>
  1468. </member>
  1469. <member name="M:CefSharp.WindowInfo.SetAsWindowless(System.IntPtr)">
  1470. <inheritdoc/>
  1471. </member>
  1472. <member name="M:CefSharp.WindowInfo.Create">
  1473. <summary>
  1474. Create a new <see cref="T:CefSharp.IWindowInfo"/> instance
  1475. </summary>
  1476. <returns>WindowInfo</returns>
  1477. </member>
  1478. </members>
  1479. </doc>