CefSharp.Core.Runtime.xml 80 KB

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