CefSharp.Core.xml 101 KB

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