CefSharp.Core.xml 47 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. "CefSharp.Core"
  5. </assembly>
  6. <members>
  7. <member name="M:CefSharp.Internals.StringUtils.CreateExceptionString(CefRefPtr&lt;CefV8Exception&gt;)">
  8. <summary>
  9. Creates a detailed expection string from a provided Cef V8 exception.
  10. </summary>
  11. <param name="exception">The exception which will be used as base for the message</param>
  12. </member>
  13. <member name="M:CefSharp.Internals.StringUtils.AssignNativeFromClr(_cef_string_utf16_t*!System.Runtime.CompilerServices.IsImplicitlyDereferenced,System.String)">
  14. <summary>
  15. Assigns the provided cef_string_t object from the given .NET string.
  16. </summary>
  17. <param name="cefStr">The cef_string_t that should be updated.</param>
  18. <param name="str">The .NET string whose value should be used to update cefStr.</param>
  19. </member>
  20. <member name="M:CefSharp.Internals.StringUtils.ToNative(System.Collections.Generic.IEnumerable`1{System.String})">
  21. <summary>
  22. Converts a .NET List of strings to native (unmanaged) format.
  23. </summary>
  24. <param name="str">The List of strings that should be converted.</param>
  25. <returns>An unmanaged representation of the provided List of strings, or an empty List if the input is a nullptr.</returns>
  26. </member>
  27. <member name="M:CefSharp.Internals.StringUtils.ToNative(System.String)">
  28. <summary>
  29. Converts a .NET string to native (unmanaged) format. Note that this method does not allocate a new copy of the
  30. </summary>
  31. <param name="str">The string that should be converted.</param>
  32. <returns>An unmanaged representation of the provided string, or an empty string if the input string is a nullptr.</returns>
  33. </member>
  34. <member name="M:CefSharp.Internals.StringUtils.ToClr(std.vector&lt;CefStringBase&lt;CefStringTraitsUTF16&gt;,std.allocator&lt;CefStringBase&lt;CefStringTraitsUTF16&gt;&gt;&gt;!System.Runtime.CompilerServices.IsConst*!System.Runtime.CompilerServices.IsImplicitlyDereferenced)">
  35. <summary>
  36. Converts an unmanaged vector of strings to a (managed) .NET List of strings.
  37. </summary>
  38. <param name="cefStr">The vector of strings that should be converted.</param>
  39. <returns>A .NET List of strings.</returns>
  40. </member>
  41. <member name="M:CefSharp.Internals.StringUtils.ToClr(CefStringBase&lt;CefStringTraitsUTF16&gt;!System.Runtime.CompilerServices.IsConst*!System.Runtime.CompilerServices.IsImplicitlyDereferenced)">
  42. <summary>
  43. Converts an unmanaged string to a (managed) .NET string.
  44. </summary>
  45. <param name="cefStr">The string that should be converted.</param>
  46. <returns>A .NET string.</returns>
  47. </member>
  48. <member name="M:CefSharp.Internals.StringUtils.ToClr(_cef_string_utf16_t!System.Runtime.CompilerServices.IsConst*!System.Runtime.CompilerServices.IsImplicitlyDereferenced)">
  49. <summary>
  50. Converts an unmanaged string to a (managed) .NET string.
  51. </summary>
  52. <param name="cefStr">The string that should be converted.</param>
  53. <returns>A .NET string.</returns>
  54. </member>
  55. <member name="T:CefSharp.PopupFeatures">
  56. <summary>
  57. Class representing popup window features.
  58. </summary>
  59. </member>
  60. <member name="P:CefSharp.BrowserSettings.OffScreenTransparentBackground">
  61. <summary>
  62. When the WPF/OffScreen browser is created, specify if the background supports
  63. transparency
  64. </summary>
  65. </member>
  66. <member name="P:CefSharp.BrowserSettings.WindowlessFrameRate">
  67. <summary>
  68. The maximum rate in frames per second (fps) that CefRenderHandler::OnPaint
  69. will be called for a windowless browser. The actual fps may be lower if
  70. the browser cannot generate frames at the requested rate. The minimum
  71. value is 1 and the maximum value is 60 (default 30). This value can also be
  72. changed dynamically via IBrowserHost.SetWindowlessFrameRate.
  73. </summary>
  74. </member>
  75. <member name="P:CefSharp.BrowserSettings.AcceptLanguageList">
  76. <summary>
  77. Comma delimited ordered list of language codes without any whitespace that
  78. will be used in the "Accept-Language" HTTP header. May be overridden on a
  79. per-browser basis using the CefBrowserSettings.AcceptLanguageList value.
  80. If both values are empty then "en-US,en" will be used. Can be overridden
  81. for individual RequestContext instances via the
  82. RequestContextSettings.AcceptLanguageList value.
  83. </summary>
  84. </member>
  85. <member name="P:CefSharp.BrowserSettings.BackgroundColor">
  86. <summary>
  87. Opaque background color used for the browser before a document is loaded
  88. and when no document color is specified. By default the background color
  89. will be the same as CefSettings.background_color. Only the RGB compontents
  90. of the specified value will be used. The alpha component must greater than
  91. 0 to enable use of the background color but will be otherwise ignored.
  92. </summary>
  93. </member>
  94. <member name="P:CefSharp.BrowserSettings.WebGl">
  95. <summary>
  96. Controls whether WebGL can be used. Note that WebGL requires hardware
  97. support and may not work on all systems even when enabled. Also
  98. configurable using the "disable-webgl" command-line switch.
  99. </summary>
  100. </member>
  101. <member name="P:CefSharp.BrowserSettings.ApplicationCache">
  102. <summary>
  103. Controls whether the application cache can be used. Also configurable using
  104. the "disable-application-cache" command-line switch.
  105. </summary>
  106. </member>
  107. <member name="P:CefSharp.BrowserSettings.Databases">
  108. <summary>
  109. Controls whether databases can be used. Also configurable using the
  110. "disable-databases" command-line switch.
  111. </summary>
  112. </member>
  113. <member name="P:CefSharp.BrowserSettings.LocalStorage">
  114. <summary>
  115. Controls whether local storage can be used. Also configurable using the
  116. "disable-local-storage" command-line switch.
  117. </summary>
  118. </member>
  119. <member name="P:CefSharp.BrowserSettings.TabToLinks">
  120. <summary>
  121. Controls whether the tab key can advance focus to links. Also configurable
  122. using the "disable-tab-to-links" command-line switch.
  123. </summary>
  124. </member>
  125. <member name="P:CefSharp.BrowserSettings.TextAreaResize">
  126. <summary>
  127. Controls whether text areas can be resized. Also configurable using the
  128. "disable-text-area-resize" command-line switch.
  129. </summary>
  130. </member>
  131. <member name="P:CefSharp.BrowserSettings.ImageShrinkStandaloneToFit">
  132. <summary>
  133. Controls whether standalone images will be shrunk to fit the page. Also
  134. configurable using the "image-shrink-standalone-to-fit" command-line
  135. switch.
  136. </summary>
  137. </member>
  138. <member name="P:CefSharp.BrowserSettings.ImageLoading">
  139. <summary>
  140. Controls whether image URLs will be loaded from the network. A cached image
  141. will still be rendered if requested. Also configurable using the
  142. "disable-image-loading" command-line switch.
  143. </summary>
  144. </member>
  145. <member name="P:CefSharp.BrowserSettings.WebSecurity">
  146. <summary>
  147. Controls whether web security restrictions (same-origin policy) will be
  148. enforced. Disabling this setting is not recommend as it will allow risky
  149. security behavior such as cross-site scripting (XSS). Also configurable
  150. using the "disable-web-security" command-line switch.
  151. </summary>
  152. </member>
  153. <member name="P:CefSharp.BrowserSettings.FileAccessFromFileUrls">
  154. <summary>
  155. Controls whether file URLs will have access to other file URLs. Also
  156. configurable using the "allow-access-from-files" command-line switch.
  157. </summary>
  158. </member>
  159. <member name="P:CefSharp.BrowserSettings.UniversalAccessFromFileUrls">
  160. <summary>
  161. Controls whether file URLs will have access to all URLs. Also configurable
  162. using the "allow-universal-access-from-files" command-line switch.
  163. </summary>
  164. </member>
  165. <member name="P:CefSharp.BrowserSettings.Plugins">
  166. <summary>
  167. Controls whether any plugins will be loaded. Also configurable using the
  168. "disable-plugins" command-line switch.
  169. </summary>
  170. </member>
  171. <member name="P:CefSharp.BrowserSettings.CaretBrowsing">
  172. <summary>
  173. Controls whether the caret position will be drawn. Also configurable using
  174. the "enable-caret-browsing" command-line switch.
  175. </summary>
  176. </member>
  177. <member name="P:CefSharp.BrowserSettings.JavascriptDomPaste">
  178. <summary>
  179. Controls whether DOM pasting is supported in the editor via
  180. execCommand("paste"). The |javascript_access_clipboard| setting must also
  181. be enabled. Also configurable using the "disable-javascript-dom-paste"
  182. command-line switch.
  183. </summary>
  184. </member>
  185. <member name="P:CefSharp.BrowserSettings.JavascriptAccessClipboard">
  186. <summary>
  187. Controls whether JavaScript can access the clipboard. Also configurable
  188. using the "disable-javascript-access-clipboard" command-line switch.
  189. </summary>
  190. </member>
  191. <member name="P:CefSharp.BrowserSettings.JavascriptCloseWindows">
  192. <summary>
  193. Controls whether JavaScript can be used to close windows that were not
  194. opened via JavaScript. JavaScript can still be used to close windows that
  195. were opened via JavaScript. Also configurable using the
  196. "disable-javascript-close-windows" command-line switch.
  197. </summary>
  198. </member>
  199. <member name="P:CefSharp.BrowserSettings.JavascriptOpenWindows">
  200. <summary>
  201. Controls whether JavaScript can be used for opening windows. Also
  202. configurable using the "disable-javascript-open-windows" command-line
  203. switch.
  204. </summary>
  205. </member>
  206. <member name="P:CefSharp.BrowserSettings.Javascript">
  207. <summary>
  208. Controls whether JavaScript can be executed.
  209. (Disable javascript)
  210. </summary>
  211. </member>
  212. <member name="P:CefSharp.BrowserSettings.RemoteFonts">
  213. <summary>
  214. Controls the loading of fonts from remote sources. Also configurable using
  215. the "disable-remote-fonts" command-line switch.
  216. </summary>
  217. </member>
  218. <member name="P:CefSharp.BrowserSettings.DefaultEncoding">
  219. <summary>
  220. Default encoding for Web content. If empty "ISO-8859-1" will be used. Also
  221. configurable using the "default-encoding" command-line switch.
  222. </summary>
  223. </member>
  224. <member name="P:CefSharp.BrowserSettings.MinimumLogicalFontSize">
  225. <summary>
  226. MinimumLogicalFontSize
  227. </summary>
  228. </member>
  229. <member name="P:CefSharp.BrowserSettings.MinimumFontSize">
  230. <summary>
  231. MinimumFontSize
  232. </summary>
  233. </member>
  234. <member name="P:CefSharp.BrowserSettings.DefaultFixedFontSize">
  235. <summary>
  236. DefaultFixedFontSize
  237. </summary>
  238. </member>
  239. <member name="P:CefSharp.BrowserSettings.DefaultFontSize">
  240. <summary>
  241. DefaultFontSize
  242. </summary>
  243. </member>
  244. <member name="P:CefSharp.BrowserSettings.FantasyFontFamily">
  245. <summary>
  246. FantasyFontFamily
  247. </summary>
  248. </member>
  249. <member name="P:CefSharp.BrowserSettings.CursiveFontFamily">
  250. <summary>
  251. CursiveFontFamily
  252. </summary>
  253. </member>
  254. <member name="P:CefSharp.BrowserSettings.SansSerifFontFamily">
  255. <summary>
  256. SansSerifFontFamily
  257. </summary>
  258. </member>
  259. <member name="P:CefSharp.BrowserSettings.SerifFontFamily">
  260. <summary>
  261. SerifFontFamily
  262. </summary>
  263. </member>
  264. <member name="P:CefSharp.BrowserSettings.FixedFontFamily">
  265. <summary>
  266. FixedFontFamily
  267. </summary>
  268. </member>
  269. <member name="P:CefSharp.BrowserSettings.StandardFontFamily">
  270. <summary>
  271. StandardFontFamily
  272. </summary>
  273. </member>
  274. <member name="M:CefSharp.BrowserSettings.#ctor(CefStructBase&lt;CefBrowserSettingsTraits&gt;*)">
  275. <summary>
  276. Internal Constructor
  277. </summary>
  278. </member>
  279. <member name="M:CefSharp.BrowserSettings.#ctor">
  280. <summary>
  281. Default Constructor
  282. </summary>
  283. </member>
  284. <member name="T:CefSharp.BrowserSettings">
  285. <summary>
  286. Browser initialization settings. Specify NULL or 0 to get the recommended
  287. default values. The consequences of using custom values may not be well
  288. tested. Many of these and other settings can also configured using command-
  289. line switches.
  290. </summary>
  291. </member>
  292. <member name="M:CefSharp.Cef.GetGlobalRequestContext">
  293. <summary>
  294. Gets the Global Request Context. Make sure to Dispose of this object when finished.
  295. </summary>
  296. <return>Returns the global request context or null.</return>
  297. </member>
  298. <member name="M:CefSharp.Cef.CurrentlyOnThread(CefSharp.CefThreadIds)">
  299. <summary>
  300. Returns true if called on the specified CEF thread.
  301. </summary>
  302. <return>Returns true if called on the specified thread.</return>
  303. </member>
  304. <member name="M:CefSharp.Cef.GetGeolocationAsync">
  305. <summary>
  306. Request a one-time geolocation update.
  307. This function bypasses any user permission checks so should only be
  308. used by code that is allowed to access location information.
  309. </summary>
  310. <return>Returns 'best available' location info or, if the location update failed, with error info.</return>
  311. </member>
  312. <member name="M:CefSharp.Cef.EnableHighDPISupport">
  313. <summary>
  314. Call during process startup to enable High-DPI support on Windows 7 or newer.
  315. Older versions of Windows should be left DPI-unaware because they do not
  316. support DirectWrite and GDI fonts are kerned very badly.
  317. </summary>
  318. </member>
  319. <member name="M:CefSharp.Cef.UnregisterInternalWebPlugin(System.String)">
  320. <summary>
  321. Unregister an internal plugin. This may be undone the next time RefreshWebPlugins() is called.
  322. </summary>
  323. <param name="path">Path (directory + file).</param>
  324. </member>
  325. <member name="M:CefSharp.Cef.RefreshWebPlugins">
  326. <summary>
  327. Cause the plugin list to refresh the next time it is accessed regardless of whether it has already been loaded.
  328. </summary>
  329. </member>
  330. <member name="M:CefSharp.Cef.GetPlugins">
  331. <summary>
  332. Async returns a list containing Plugin Information
  333. (Wrapper around CefVisitWebPluginInfo)
  334. </summary>
  335. <return>Returns List of <see cref="T:CefSharp.Plugin" /> structs.</return>
  336. </member>
  337. <member name="M:CefSharp.Cef.ClearSchemeHandlerFactories">
  338. <summary>
  339. Clear all registered scheme handler factories.
  340. </summary>
  341. <return>Returns false on error.</return>
  342. </member>
  343. <member name="M:CefSharp.Cef.Shutdown">
  344. <summary>
  345. Shuts down CefSharp and the underlying CEF infrastructure. This method is safe to call multiple times; it will only
  346. shut down CEF on the first call (all subsequent calls will be ignored).
  347. This function should be called on the main application thread to shut down the CEF browser process before the application exits.
  348. </summary>
  349. </member>
  350. <member name="M:CefSharp.Cef.GetGlobalCookieManager">
  351. <summary>
  352. Returns the global cookie manager.
  353. </summary>
  354. </member>
  355. <member name="M:CefSharp.Cef.ClearCrossOriginWhitelist">
  356. <summary>Remove all entries from the cross-origin access whitelist.</summary>
  357. <remarks>
  358. Remove all entries from the cross-origin access whitelist. Returns false if
  359. the whitelist cannot be accessed.
  360. </remarks>
  361. </member>
  362. <member name="M:CefSharp.Cef.RemoveCrossOriginWhitelistEntry(System.String,System.String,System.String,System.Boolean)">
  363. <summary>Remove entry from cross-origin whitelist</summary>
  364. <param name="sourceOrigin">The origin allowed to be accessed by the target protocol/domain.</param>
  365. <param name="targetProtocol">The target protocol allowed to access the source origin.</param>
  366. <param name="targetDomain">The optional target domain allowed to access the source origin.</param>
  367. <param name="allowTargetSubdomains">If set to true would allow a blah.example.com if the
  368. <paramref name="targetDomain" /> was set to example.com
  369. </param>
  370. <remarks>
  371. Remove an entry from the cross-origin access whitelist. Returns false if
  372. <paramref name="sourceOrigin" /> is invalid or the whitelist cannot be accessed.
  373. </remarks>
  374. </member>
  375. <member name="M:CefSharp.Cef.AddCrossOriginWhitelistEntry(System.String,System.String,System.String,System.Boolean)">
  376. <summary>Add an entry to the cross-origin whitelist.</summary>
  377. <param name="sourceOrigin">The origin allowed to be accessed by the target protocol/domain.</param>
  378. <param name="targetProtocol">The target protocol allowed to access the source origin.</param>
  379. <param name="targetDomain">The optional target domain allowed to access the source origin.</param>
  380. <param name="allowTargetSubdomains">If set to true would allow a blah.example.com if the
  381. <paramref name="targetDomain" /> was set to example.com
  382. </param>
  383. <remarks>
  384. The same-origin policy restricts how scripts hosted from different origins
  385. (scheme + domain + port) can communicate. By default, scripts can only access
  386. resources with the same origin. Scripts hosted on the HTTP and HTTPS schemes
  387. (but no other schemes) can use the "Access-Control-Allow-Origin" header to
  388. allow cross-origin requests. For example, https://source.example.com can make
  389. XMLHttpRequest requests on http://target.example.com if the
  390. http://target.example.com request returns an "Access-Control-Allow-Origin:
  391. https://source.example.com" response header.
  392. Scripts in separate frames or iframes and hosted from the same protocol and
  393. domain suffix can execute cross-origin JavaScript if both pages set the
  394. document.domain value to the same domain suffix. For example,
  395. scheme://foo.example.com and scheme://bar.example.com can communicate using
  396. JavaScript if both domains set document.domain="example.com".
  397. This method is used to allow access to origins that would otherwise violate
  398. the same-origin policy. Scripts hosted underneath the fully qualified
  399. <paramref name="sourceOrigin" /> URL (like http://www.example.com) will be allowed access to
  400. all resources hosted on the specified <paramref name="targetProtocol" /> and <paramref name="targetDomain" />.
  401. If <paramref name="targetDomain" /> is non-empty and <paramref name="allowTargetSubdomains" /> if false only
  402. exact domain matches will be allowed. If <paramref name="targetDomain" /> contains a top-
  403. level domain component (like "example.com") and <paramref name="allowTargetSubdomains" /> is
  404. true sub-domain matches will be allowed. If <paramref name="targetDomain" /> is empty and
  405. <paramref name="allowTargetSubdomains" /> if true all domains and IP addresses will be
  406. allowed.
  407. This method cannot be used to bypass the restrictions on local or display
  408. isolated schemes. See the comments on <see cref="T:CefSharp.CefCustomScheme" /> for more
  409. information.
  410. This function may be called on any thread. Returns false if <paramref name="sourceOrigin" />
  411. is invalid or the whitelist cannot be accessed.
  412. </remarks>
  413. </member>
  414. <member name="M:CefSharp.Cef.ExecuteProcess">
  415. <summary>
  416. This function should be called from the application entry point function to execute a secondary process.
  417. It can be used to run secondary processes from the browser client executable (default behavior) or
  418. from a separate executable specified by the CefSettings.browser_subprocess_path value.
  419. If called for the browser process (identified by no "type" command-line value) it will return immediately with a value of -1.
  420. If called for a recognized secondary process it will block until the process should exit and then return the process exit code.
  421. 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).
  422. </summary>
  423. </member>
  424. <member name="M:CefSharp.Cef.DoMessageLoopWork">
  425. <summary>Perform a single iteration of CEF message loop processing. This function is
  426. used to integrate the CEF message loop into an existing application message
  427. loop. Care must be taken to balance performance against excessive CPU usage.
  428. This function should only be called on the main application thread and only
  429. if CefInitialize() is called with a CefSettings.multi_threaded_message_loop
  430. value of false. This function will not block.</summary>
  431. </member>
  432. <member name="M:CefSharp.Cef.Initialize(CefSharp.CefSettings,System.Boolean,System.Boolean)">
  433. <summary>
  434. Initializes CefSharp with user-provided settings.
  435. This function should be called on the main application thread to initialize the CEF browser process.
  436. </summary>
  437. <param name="cefSettings">CefSharp configuration settings.</param>
  438. <param name="shutdownOnProcessExit">When the Current AppDomain (relative to the thread called on)
  439. Exits(ProcessExit event) then Shudown will be called.</param>
  440. <param name="performDependencyCheck">Check that all relevant dependencies avaliable, throws exception if any are missing</param>
  441. <return>true if successful; otherwise, false.</return>
  442. </member>
  443. <member name="M:CefSharp.Cef.Initialize(CefSharp.CefSettings)">
  444. <summary>
  445. Initializes CefSharp with user-provided settings.
  446. This function should be called on the main application thread to initialize the CEF browser process.
  447. </summary>
  448. <param name="cefSettings">CefSharp configuration settings.</param>
  449. <return>true if successful; otherwise, false.</return>
  450. </member>
  451. <member name="M:CefSharp.Cef.Initialize">
  452. <summary>
  453. Initializes CefSharp with the default settings.
  454. This function should be called on the main application thread to initialize the CEF browser process.
  455. </summary>
  456. <return>true if successful; otherwise, false.</return>
  457. </member>
  458. <member name="P:CefSharp.Cef.CefCommitHash">
  459. <summary>
  460. Gets a value that indicates the Git Hash for CEF version currently being used.
  461. </summary>
  462. <value>The Git Commit Hash</value>
  463. </member>
  464. <member name="P:CefSharp.Cef.ChromiumVersion">
  465. <summary>Gets a value that indicates the Chromium version currently being used.</summary>
  466. <value>The Chromium version.</value>
  467. </member>
  468. <member name="P:CefSharp.Cef.CefVersion">
  469. <summary>Gets a value that indicates the CEF version currently being used.</summary>
  470. <value>The CEF Version</value>
  471. </member>
  472. <member name="P:CefSharp.Cef.CefSharpVersion">
  473. <summary>Gets a value that indicates the version of CefSharp currently being used.</summary>
  474. <value>The CefSharp version.</value>
  475. </member>
  476. <member name="P:CefSharp.Cef.IsInitialized">
  477. <summary>Gets a value that indicates whether CefSharp is initialized.</summary>
  478. <value>true if CefSharp is initialized; otherwise, false.</value>
  479. </member>
  480. <member name="P:CefSharp.Cef.OnContextInitialized">
  481. <summary>
  482. Called on the CEF UI thread immediately after the CEF context has been initialized.
  483. You can now access the Global RequestContext through Cef.GetGlobalRequestContext() - this is the
  484. first place you can set Preferences (e.g. proxy settings, spell check dictionaries).
  485. </summary>
  486. </member>
  487. <member name="M:CefSharp.RequestContext.ResolveHostCached(System.Uri,System.Collections.Generic.IList`1{System.String}@)">
  488. <summary>
  489. Attempts to resolve origin to a list of associated IP addresses using
  490. cached data. This method must be called on the CEF IO thread. Use
  491. Cef.IOThreadTaskFactory to execute on that thread.
  492. </summary>
  493. <param name="origin">host name to resolve</param>
  494. <param name="resolvedIpAddresses">list of resolved IP
  495. addresses or empty list if no cached data is available.</param>
  496. <returns> Returns <see cref="!:CefErrorCode.None" /> on success</returns>
  497. </member>
  498. <member name="M:CefSharp.RequestContext.ResolveHostAsync(System.Uri)">
  499. <summary>
  500. Attempts to resolve origin to a list of associated IP addresses.
  501. </summary>
  502. <param name="origin">host name to resolve</param>
  503. <return>A task that represents the Resoolve Host operation. The value of the TResult parameter contains ResolveCallbackResult.</return>
  504. </member>
  505. <member name="M:CefSharp.RequestContext.CloseAllConnections(CefSharp.ICompletionCallback)">
  506. <summary>
  507. Clears all active and idle connections that Chromium currently has.
  508. This is only recommended if you have released all other CEF objects but
  509. don't yet want to call Cef.Shutdown().
  510. </summary>
  511. <param name="callback">If is non-NULL it will be executed on the CEF UI thread after
  512. completion. This param is optional</param>
  513. </member>
  514. <member name="M:CefSharp.RequestContext.ClearCertificateExceptions(CefSharp.ICompletionCallback)">
  515. <summary>
  516. Clears all certificate exceptions that were added as part of handling
  517. <see cref="!:IRequestHandler.OnCertificateError" />. If you call this it is
  518. recommended that you also call <see cref="!:IRequestContext.CloseAllConnections" /> or you risk not
  519. being prompted again for server certificates if you reconnect quickly.
  520. </summary>
  521. <param name="callback">If is non-NULL it will be executed on the CEF UI thread after
  522. completion. This param is optional</param>
  523. </member>
  524. <member name="M:CefSharp.RequestContext.SetPreference(System.String,System.Object,System.String@)">
  525. <summary>
  526. Set the value associated with preference name. If value is null the
  527. preference will be restored to its default value. If setting the preference
  528. fails then error will be populated with a detailed description of the
  529. problem. This method must be called on the CEF UI thread.
  530. Preferences set via the command-line usually cannot be modified.
  531. </summary>
  532. <param name="name">preference key</param>
  533. <param name="value">preference value</param>
  534. <param name="error">out error</param>
  535. <returns>Returns true if the value is set successfully and false otherwise.</returns>
  536. /// <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
  537. Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
  538. executed on the CEF UI thread, so can be called directly.
  539. When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
  540. application thread will be the CEF UI thread.</remarks></member>
  541. <member name="M:CefSharp.RequestContext.CanSetPreference(System.String)">
  542. <summary>
  543. Returns true if the preference with the specified name can be modified
  544. using SetPreference. As one example preferences set via the command-line
  545. usually cannot be modified. This method must be called on the CEF UI thread.
  546. </summary>
  547. <param name="name">preference key</param>
  548. <returns>Returns true if the preference with the specified name can be modified
  549. using SetPreference</returns>
  550. <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
  551. Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
  552. executed on the CEF UI thread, so can be called directly.
  553. When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
  554. application thread will be the CEF UI thread.</remarks>
  555. </member>
  556. <member name="M:CefSharp.RequestContext.GetAllPreferences(System.Boolean)">
  557. <summary>
  558. Returns all preferences as a dictionary. The returned
  559. object contains a copy of the underlying preference values and
  560. modifications to the returned object will not modify the underlying
  561. preference values. This method must be called on the browser process UI
  562. thread.
  563. </summary>
  564. <param name="includeDefaults">If true then
  565. preferences currently at their default value will be included.</param>
  566. <returns>Preferences (dictionary can have sub dictionaries)</returns>
  567. </member>
  568. <member name="M:CefSharp.RequestContext.GetPreference(System.String)">
  569. <summary>
  570. Returns the value for the preference with the specified name. Returns
  571. NULL if the preference does not exist. The returned object contains a copy
  572. of the underlying preference value and modifications to the returned object
  573. will not modify the underlying preference value. This method must be called
  574. on the CEF UI thread.
  575. </summary>
  576. <param name="name">preference name</param>
  577. <returns>Returns the value for the preference with the specified name</returns>
  578. <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
  579. Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
  580. executed on the CEF UI thread, so can be called directly.
  581. When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
  582. application thread will be the CEF UI thread.</remarks>
  583. </member>
  584. <member name="M:CefSharp.RequestContext.HasPreference(System.String)">
  585. <summary>
  586. Returns true if a preference with the specified name exists. This method
  587. must be called on the CEF UI thread.
  588. </summary>
  589. <param name="name">name of preference</param>
  590. <returns>bool if the preference exists</returns>
  591. <remarks>Use Cef.UIThreadTaskFactory to execute this method if required,
  592. Cef.OnContextInitialized and ChromiumWebBrowser.IsBrowserInitializedChanged are both
  593. executed on the CEF UI thread, so can be called directly.
  594. When CefSettings.MultiThreadedMessageLoop == false (the default is true) then the main
  595. application thread will be the CEF UI thread.</remarks>
  596. </member>
  597. <member name="M:CefSharp.RequestContext.PurgePluginListCache(System.Boolean)">
  598. <summary>
  599. Tells all renderer processes associated with this context to throw away
  600. their plugin list cache. If reloadPages is true they will also reload
  601. all pages with plugins. RequestContextHandler.OnBeforePluginLoad may
  602. be called to rebuild the plugin list cache.
  603. </summary>
  604. <param name="reloadPages">reload any pages with pluginst</param>
  605. </member>
  606. <member name="P:CefSharp.RequestContext.CachePath">
  607. <summary>
  608. Returns the cache path for this object. If empty an "incognito mode"
  609. in-memory cache is being used.
  610. </summary>
  611. </member>
  612. <member name="M:CefSharp.RequestContext.ClearSchemeHandlerFactories">
  613. <summary>
  614. Clear all registered scheme handler factories.
  615. </summary>
  616. <returns>Returns false on error.</returns>
  617. </member>
  618. <member name="M:CefSharp.RequestContext.RegisterSchemeHandlerFactory(System.String,System.String,CefSharp.ISchemeHandlerFactory)">
  619. <summary>
  620. Register a scheme handler factory for the specified schemeName and optional domainName.
  621. An empty domainName value for a standard scheme will cause the factory to match all domain
  622. names. The domainName value will be ignored for non-standard schemes. If schemeName is
  623. a built-in scheme and no handler is returned by factory then the built-in scheme handler
  624. factory will be called. If schemeName is a custom scheme then you must also implement the
  625. CefApp::OnRegisterCustomSchemes() method in all processes. This function may be called multiple
  626. times to change or remove the factory that matches the specified schemeName and optional
  627. domainName.
  628. </summary>
  629. <param name="schemeName">Scheme Name</param>
  630. <param name="domainName">Optional domain name</param>
  631. <param name="factory">Scheme handler factory</param>
  632. <returns>Returns false if an error occurs.</returns>
  633. </member>
  634. <member name="P:CefSharp.RequestContext.IsGlobal">
  635. <summary>
  636. Returns true if this object is the global context. The global context is
  637. used by default when creating a browser or URL request with a NULL context
  638. argument.
  639. </summary>
  640. </member>
  641. <member name="M:CefSharp.RequestContext.GetDefaultCookieManager(CefSharp.ICompletionCallback)">
  642. <summary>
  643. Returns the default cookie manager for this object. This will be the global
  644. cookie manager if this object is the global request context. Otherwise,
  645. this will be the default cookie manager used when this request context does
  646. not receive a value via IRequestContextHandler.GetCookieManager().
  647. </summary>
  648. <param name="callback">If callback is non-NULL it will be executed asnychronously on the CEF IO thread
  649. after the manager's storage has been initialized.</param>
  650. <returns>Returns the default cookie manager for this object</returns>
  651. </member>
  652. <member name="M:CefSharp.RequestContext.IsSharingWith(CefSharp.IRequestContext)">
  653. <summary>
  654. Returns true if this object is sharing the same storage as the specified context.
  655. </summary>
  656. <param name="context">context to compare</param>
  657. <returns>Returns true if same storage</returns>
  658. </member>
  659. <member name="M:CefSharp.RequestContext.IsSame(CefSharp.IRequestContext)">
  660. <summary>
  661. Returns true if this object is pointing to the same context object.
  662. </summary>
  663. <param name="context">context to compare</param>
  664. <returns>Returns true if the same</returns>
  665. </member>
  666. <member name="T:CefSharp.RequestContext">
  667. <summary>
  668. A request context provides request handling for a set of related browser objects.
  669. A request context is specified when creating a new browser object via the CefBrowserHost
  670. static factory methods. Browser objects with different request contexts will never be
  671. hosted in the same render process. Browser objects with the same request context may or
  672. may not be hosted in the same render process depending on the process model.
  673. Browser objects created indirectly via the JavaScript window.open function or targeted
  674. links will share the same render process and the same request context as the source browser.
  675. When running in single-process mode there is only a single render process (the main process)
  676. and so all browsers created in single-process mode will share the same request context.
  677. This will be the first request context passed into a CefBrowserHost static factory method
  678. and all other request context objects will be ignored.
  679. </summary>
  680. </member>
  681. <member name="P:CefSharp.RequestContextSettings.IgnoreCertificateErrors">
  682. <summary>
  683. Set to true to ignore errors related to invalid SSL certificates.
  684. Enabling this setting can lead to potential security vulnerabilities like
  685. "man in the middle" attacks. Applications that load content from the
  686. internet should not enable this setting. Can be set globally using the
  687. CefSettings.IgnoreCertificateErrors value. This value will be ignored if
  688. CachePath matches the CefSettings.cache_path value.
  689. </summary>
  690. </member>
  691. <member name="P:CefSharp.RequestContextSettings.AcceptLanguageList">
  692. <summary>
  693. Comma delimited ordered list of language codes without any whitespace that
  694. will be used in the "Accept-Language" HTTP header. Can be set globally
  695. using the CefSettings.accept_language_list value or overridden on a per-
  696. browser basis using the BrowserSettings.AcceptLanguageList value. If
  697. all values are empty then "en-US,en" will be used. This value will be
  698. ignored if CachePath matches the CefSettings.CachePath value.
  699. </summary>
  700. </member>
  701. <member name="P:CefSharp.RequestContextSettings.CachePath">
  702. <summary>
  703. The location where cache data will be stored on disk. If empty then
  704. browsers will be created in "incognito mode" where in-memory caches are
  705. used for storage and no data is persisted to disk. HTML5 databases such as
  706. localStorage will only persist across sessions if a cache path is
  707. specified. To share the global browser cache and related configuration set
  708. this value to match the CefSettings.CachePath value.
  709. </summary>
  710. </member>
  711. <member name="P:CefSharp.RequestContextSettings.PersistUserPreferences">
  712. <summary>
  713. To persist user preferences as a JSON file in the cache path directory set
  714. this value to true. Can be set globally using the
  715. CefSettings.PersistUserPreferences value. This value will be ignored if
  716. CachePath is empty or if it matches the CefSettings.CachePath value.
  717. </summary>
  718. </member>
  719. <member name="P:CefSharp.RequestContextSettings.PersistSessionCookies">
  720. <summary>
  721. To persist session cookies (cookies without an expiry date or validity
  722. interval) by default when using the global cookie manager set this value to
  723. true. Session cookies are generally intended to be transient and most
  724. Web browsers do not persist them. Can be set globally using the
  725. CefSettings.PersistSessionCookies value. This value will be ignored if
  726. CachePath is empty or if it matches the CefSettings.CachePath value.
  727. </summary>
  728. </member>
  729. <member name="M:CefSharp.RequestContextSettings.#ctor">
  730. <summary>
  731. Default constructor
  732. </summary>
  733. </member>
  734. <member name="T:CefSharp.RequestContextSettings">
  735. <summary>
  736. RequestContextSettings
  737. </summary>
  738. </member>
  739. <member name="M:CefSharp.CefSettings.EnableInternalPdfViewerOffScreen">
  740. <summary>
  741. Disable Surfaces so internal PDF viewer works for OSR
  742. https://bitbucket.org/chromiumembedded/cef/issues/1689
  743. </summary>
  744. </member>
  745. <member name="M:CefSharp.CefSettings.SetOffScreenRenderingBestPerformanceArgs">
  746. <summary>
  747. Set command line arguments for best OSR (Offscreen and WPF) Rendering performance
  748. This will disable WebGL, look at the source to determine which flags best suite
  749. your requirements.
  750. </summary>
  751. </member>
  752. <member name="M:CefSharp.CefSettings.RegisterExtension(CefSharp.CefExtension)">
  753. <summary>
  754. Registers an extension with the provided settings.
  755. </summary>
  756. <param name="extension">The CefExtension that contains the extension code.</param>
  757. </member>
  758. <member name="M:CefSharp.CefSettings.RegisterScheme(CefSharp.CefCustomScheme)">
  759. <summary>
  760. Registers a custom scheme using the provided settings.
  761. </summary>
  762. <param name="cefCustomScheme">The CefCustomScheme which provides the details about the scheme.</param>
  763. </member>
  764. <member name="P:CefSharp.CefSettings.FocusedNodeChangedEnabled">
  765. <summary>
  766. If true a message will be sent from the render subprocess to the
  767. browser when a DOM node (or no node) gets focus. The default is
  768. false.
  769. </summary>
  770. </member>
  771. <member name="P:CefSharp.CefSettings.AcceptLanguageList">
  772. <summary>
  773. Comma delimited ordered list of language codes without any whitespace that
  774. will be used in the "Accept-Language" HTTP header. May be set globally
  775. using the CefSettings.AcceptLanguageList value. If both values are
  776. empty then "en-US,en" will be used.
  777. </summary>
  778. </member>
  779. <member name="P:CefSharp.CefSettings.PersistUserPreferences">
  780. <summary>
  781. To persist user preferences as a JSON file in the cache path directory set
  782. this value to true. A CachePath value must also be specified
  783. to enable this feature. Also configurable using the
  784. "persist-user-preferences" command-line switch. Can be overridden for
  785. individual RequestContext instances via the
  786. RequestContextSettings.PersistUserPreferences value.
  787. </summary>
  788. </member>
  789. <member name="P:CefSharp.CefSettings.PersistSessionCookies">
  790. <summary>
  791. To persist session cookies (cookies without an expiry date or validity
  792. interval) by default when using the global cookie manager set this value to
  793. true. Session cookies are generally intended to be transient and most
  794. Web browsers do not persist them. A CachePath value must also be
  795. specified to enable this feature. Also configurable using the
  796. "persist-session-cookies" command-line switch. Can be overridden for
  797. individual RequestContext instances via the
  798. RequestContextSettings.PersistSessionCookies value.
  799. </summary>
  800. </member>
  801. <member name="P:CefSharp.CefSettings.WindowlessRenderingEnabled">
  802. <summary>
  803. Set to true (1) to enable windowless (off-screen) rendering support. Do not
  804. enable this value if the application does not use windowless rendering as
  805. it may reduce rendering performance on some systems.
  806. </summary>
  807. </member>
  808. <member name="P:CefSharp.CefSettings.UserAgent">
  809. <summary>
  810. Value that will be returned as the User-Agent HTTP header. If empty the
  811. default User-Agent string will be used. Also configurable using the
  812. "user-agent" command-line switch.
  813. </summary>
  814. </member>
  815. <member name="P:CefSharp.CefSettings.UncaughtExceptionStackSize">
  816. <summary>
  817. The number of stack trace frames to capture for uncaught exceptions.
  818. Specify a positive value to enable the CefRenderProcessHandler::
  819. OnUncaughtException() callback. Specify 0 (default value) and
  820. OnUncaughtException() will not be called. Also configurable using the
  821. "uncaught-exception-stack-size" command-line switch.
  822. </summary>
  823. </member>
  824. <member name="P:CefSharp.CefSettings.RemoteDebuggingPort">
  825. <summary>
  826. Set to a value between 1024 and 65535 to enable remote debugging on the
  827. specified port. For example, if 8080 is specified the remote debugging URL
  828. will be http://localhost:8080. CEF can be remotely debugged from any CEF or
  829. Chrome browser window. Also configurable using the "remote-debugging-port"
  830. command-line switch.
  831. </summary>
  832. </member>
  833. <member name="P:CefSharp.CefSettings.ProductVersion">
  834. <summary>
  835. Value that will be inserted as the product portion of the default
  836. User-Agent string. If empty the Chromium product version will be used. If
  837. |userAgent| is specified this value will be ignored. Also configurable
  838. using the "product-version" command-line switch.
  839. </summary>
  840. </member>
  841. <member name="P:CefSharp.CefSettings.PackLoadingDisabled">
  842. <summary>
  843. Set to true to disable loading of pack files for resources and locales.
  844. A resource bundle handler must be provided for the browser and render
  845. processes via CefApp::GetResourceBundleHandler() if loading of pack files
  846. is disabled. Also configurable using the "disable-pack-loading" command-
  847. line switch.
  848. </summary>
  849. </member>
  850. <member name="P:CefSharp.CefSettings.JavascriptFlags">
  851. <summary>
  852. Custom flags that will be used when initializing the V8 JavaScript engine.
  853. The consequences of using custom flags may not be well tested. Also
  854. configurable using the "js-flags" command-line switch.
  855. </summary>
  856. </member>
  857. <member name="P:CefSharp.CefSettings.LogSeverity">
  858. <summary>
  859. The log severity. Only messages of this severity level or higher will be
  860. logged. Also configurable using the "log-severity" command-line switch with
  861. a value of "verbose", "info", "warning", "error", "error-report" or
  862. "disable".
  863. </summary>
  864. </member>
  865. <member name="P:CefSharp.CefSettings.LogFile">
  866. <summary>
  867. The directory and file name to use for the debug log. If empty a default
  868. log file name and location will be used. On Windows and Linux a "debug.log"
  869. file will be written in the main executable directory.
  870. Also configurable using the"log-file" command-line switch.
  871. </summary>
  872. </member>
  873. <member name="P:CefSharp.CefSettings.ResourcesDirPath">
  874. <summary>
  875. The fully qualified path for the resources directory. If this value is
  876. empty the cef.pak and/or devtools_resources.pak files must be located in
  877. the module directory. Also configurable using the "resources-dir-path" command-line
  878. switch.
  879. </summary>
  880. </member>
  881. <member name="P:CefSharp.CefSettings.LocalesDirPath">
  882. <summary>
  883. The fully qualified path for the locales directory. If this value is empty
  884. the locales directory must be located in the module directory.
  885. Also configurable using the "locales-dir-path" command-line switch.
  886. </summary>
  887. </member>
  888. <member name="P:CefSharp.CefSettings.Locale">
  889. <summary>
  890. The locale string that will be passed to WebKit. If empty the default
  891. locale of "en-US" will be used. Also configurable using the "lang"
  892. command-line switch.
  893. </summary>
  894. </member>
  895. <member name="P:CefSharp.CefSettings.IgnoreCertificateErrors">
  896. <summary>
  897. Set to true in order to completely ignore SSL certificate errors.
  898. This is NOT recommended.
  899. </summary>
  900. </member>
  901. <member name="P:CefSharp.CefSettings.UserDataPath">
  902. <summary>
  903. The location where user data such as spell checking dictionary files will
  904. be stored on disk. If empty then the default platform-specific user data
  905. directory will be used ("~/.cef_user_data" directory on Linux,
  906. "~/Library/Application Support/CEF/User Data" directory on Mac OS X,
  907. "Local Settings\Application Data\CEF\User Data" directory under the user
  908. profile directory on Windows).
  909. </summary>
  910. </member>
  911. <member name="P:CefSharp.CefSettings.CachePath">
  912. <summary>
  913. The location where cache data will be stored on disk. If empty then
  914. browsers will be created in "incognito mode" where in-memory caches are
  915. used for storage and no data is persisted to disk. HTML5 databases such as
  916. localStorage will only persist across sessions if a cache path is
  917. specified. Can be overridden for individual CefRequestContext instances via
  918. the RequestContextSettings.CachePath value.
  919. </summary>
  920. </member>
  921. <member name="P:CefSharp.CefSettings.BrowserSubprocessPath">
  922. <summary>
  923. The path to a separate executable that will be launched for sub-processes.
  924. By default the browser process executable is used. See the comments on
  925. Cef.ExecuteProcess() for details. Also configurable using the
  926. "browser-subprocess-path" command-line switch. Default is CefSharp.BrowserSubprocess.exe
  927. </summary>
  928. </member>
  929. <member name="P:CefSharp.CefSettings.MultiThreadedMessageLoop">
  930. <summary>
  931. thread. If false than the CefDoMessageLoopWork() function must be
  932. called from your application message loop. This option is only supported on
  933. Windows. The default value is true
  934. </summary>
  935. </member>
  936. <member name="P:CefSharp.CefSettings.CommandLineArgsDisabled">
  937. <summary>
  938. Set to true to disable configuration of browser process features using
  939. standard CEF and Chromium command-line arguments. Configuration can still
  940. be specified using CEF data structures or by adding to CefCommandLineArgs
  941. </summary>
  942. </member>
  943. <member name="P:CefSharp.CefSettings.CefCommandLineArgs">
  944. <summary>
  945. Add custom command line argumens to this collection, they will be
  946. added in OnBeforeCommandLineProcessing.
  947. </summary>
  948. </member>
  949. <member name="P:CefSharp.CefSettings.Extensions">
  950. <summary>
  951. Add CefExtensions to be registered
  952. </summary>
  953. </member>
  954. <member name="P:CefSharp.CefSettings.CefCustomSchemes">
  955. <summary>
  956. Add Customs schemes to this collection
  957. </summary>
  958. </member>
  959. <member name="M:CefSharp.CefSettings.#ctor">
  960. <summary>
  961. Default Constructor
  962. </summary>
  963. </member>
  964. <member name="T:CefSharp.CefSettings">
  965. <summary>
  966. Initialization settings. Many of these and other settings can also configured
  967. using command-line switches.
  968. </summary>
  969. </member>
  970. <member name="M:CefSharp.ResourceHandlerWrapper.#ctor(CefSharp.IResourceHandler)">
  971. <summary>
  972. Constructor that accepts IBrowser, IFrame, IRequest in order to be the CefSharp
  973. lifetime management container (i.e. calling .Dispose at the correct time) on
  974. managed objects that contain MCefRefPtrs.
  975. </summary>
  976. </member>
  977. <member name="M:CefSharp.Internals.CefFrameWrapper.LoadRequest(CefSharp.IRequest)">
  978. Load the request represented by the |request| object.
  979. </member>
  980. </members>
  981. </doc>