CefSharp.Core.xml 54 KB

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