CefSharp.WinForms.xml 50 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>CefSharp.WinForms</name>
  5. </assembly>
  6. <members>
  7. <member name="T:CefSharp.WinForms.ChromiumWebBrowser">
  8. <summary>
  9. ChromiumWebBrowser is the WinForms web browser control
  10. </summary>
  11. <seealso cref="T:System.Windows.Forms.Control" />
  12. <seealso cref="T:CefSharp.WinForms.IWinFormsWebBrowser" />
  13. </member>
  14. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.canExecuteJavascriptInMainFrameId">
  15. <summary>
  16. Used as workaround for issue https://github.com/cefsharp/CefSharp/issues/3021
  17. </summary>
  18. </member>
  19. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.browserInitialized">
  20. <summary>
  21. The browser initialized - boolean represented as 0 (false) and 1(true) as we use Interlocker to increment/reset
  22. </summary>
  23. </member>
  24. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CanExecuteJavascriptInMainFrame">
  25. <summary>
  26. A flag that indicates if you can execute javascript in the main frame.
  27. Flag is set to true in IRenderProcessMessageHandler.OnContextCreated.
  28. and false in IRenderProcessMessageHandler.OnContextReleased
  29. </summary>
  30. </member>
  31. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.DialogHandler">
  32. <summary>
  33. Implement <see cref="T:CefSharp.IDialogHandler" /> and assign to handle dialog events.
  34. </summary>
  35. <value>The dialog handler.</value>
  36. </member>
  37. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.JsDialogHandler">
  38. <summary>
  39. Implement <see cref="T:CefSharp.IJsDialogHandler" /> and assign to handle events related to JavaScript Dialogs.
  40. </summary>
  41. <value>The js dialog handler.</value>
  42. </member>
  43. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.KeyboardHandler">
  44. <summary>
  45. Implement <see cref="T:CefSharp.IKeyboardHandler" /> and assign to handle events related to key press.
  46. </summary>
  47. <value>The keyboard handler.</value>
  48. </member>
  49. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.RequestHandler">
  50. <summary>
  51. Implement <see cref="T:CefSharp.IRequestHandler" /> and assign to handle events related to browser requests.
  52. </summary>
  53. <value>The request handler.</value>
  54. </member>
  55. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.DownloadHandler">
  56. <summary>
  57. Implement <see cref="T:CefSharp.IDownloadHandler" /> and assign to handle events related to downloading files.
  58. </summary>
  59. <value>The download handler.</value>
  60. </member>
  61. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.LoadHandler">
  62. <summary>
  63. Implement <see cref="T:CefSharp.ILoadHandler" /> and assign to handle events related to browser load status.
  64. </summary>
  65. <value>The load handler.</value>
  66. </member>
  67. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.LifeSpanHandler">
  68. <summary>
  69. Implement <see cref="T:CefSharp.ILifeSpanHandler" /> and assign to handle events related to popups.
  70. </summary>
  71. <value>The life span handler.</value>
  72. </member>
  73. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.DisplayHandler">
  74. <summary>
  75. Implement <see cref="T:CefSharp.IDisplayHandler" /> and assign to handle events related to browser display state.
  76. </summary>
  77. <value>The display handler.</value>
  78. </member>
  79. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.MenuHandler">
  80. <summary>
  81. Implement <see cref="T:CefSharp.IContextMenuHandler" /> and assign to handle events related to the browser context menu
  82. </summary>
  83. <value>The menu handler.</value>
  84. </member>
  85. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.RenderProcessMessageHandler">
  86. <summary>
  87. Implement <see cref="T:CefSharp.IRenderProcessMessageHandler" /> and assign to handle messages from the render process.
  88. </summary>
  89. <value>The render process message handler.</value>
  90. </member>
  91. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.FindHandler">
  92. <summary>
  93. Implement <see cref="T:CefSharp.IFindHandler" /> to handle events related to find results.
  94. </summary>
  95. <value>The find handler.</value>
  96. </member>
  97. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.AudioHandler">
  98. <summary>
  99. Implement <see cref="T:CefSharp.IAudioHandler" /> to handle audio events.
  100. </summary>
  101. </member>
  102. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.FocusHandler">
  103. <summary>
  104. The <see cref="T:CefSharp.IFocusHandler" /> for this ChromiumWebBrowser.
  105. </summary>
  106. <value>The focus handler.</value>
  107. <remarks>If you need customized focus handling behavior for WinForms, the suggested
  108. best practice would be to inherit from DefaultFocusHandler and try to avoid
  109. needing to override the logic in OnGotFocus. The implementation in
  110. DefaultFocusHandler relies on very detailed behavior of how WinForms and
  111. Windows interact during window activation.</remarks>
  112. </member>
  113. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.DragHandler">
  114. <summary>
  115. Implement <see cref="T:CefSharp.IDragHandler" /> and assign to handle events related to dragging.
  116. </summary>
  117. <value>The drag handler.</value>
  118. </member>
  119. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.ResourceRequestHandlerFactory">
  120. <summary>
  121. Implement <see cref="T:CefSharp.IResourceRequestHandlerFactory" /> and control the loading of resources
  122. </summary>
  123. <value>The resource handler factory.</value>
  124. </member>
  125. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.LoadError">
  126. <summary>
  127. Event handler that will get called when the resource load for a navigation fails or is canceled.
  128. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
  129. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  130. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  131. </summary>
  132. </member>
  133. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.FrameLoadStart">
  134. <summary>
  135. Event handler that will get called when the browser begins loading a frame. Multiple frames may be loading at the same
  136. time. Sub-frames may start or continue loading after the main frame load has ended. This method may not be called for a
  137. particular frame if the load request for that frame fails. For notification of overall browser load status use
  138. OnLoadingStateChange instead.
  139. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
  140. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  141. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  142. </summary>
  143. <remarks>Whilst this may seem like a logical place to execute js, it's called before the DOM has been loaded, implement
  144. <see cref="M:CefSharp.IRenderProcessMessageHandler.OnContextCreated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)" /> as it's called when the underlying V8Context is created
  145. </remarks>
  146. </member>
  147. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.FrameLoadEnd">
  148. <summary>
  149. Event handler that will get called when the browser is done loading a frame. Multiple frames may be loading at the same
  150. time. Sub-frames may start or continue loading after the main frame load has ended. This method will always be called
  151. for all frames irrespective of whether the request completes successfully.
  152. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
  153. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  154. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  155. </summary>
  156. </member>
  157. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.LoadingStateChanged">
  158. <summary>
  159. Event handler that will get called when the Loading state has changed.
  160. This event will be fired twice. Once when loading is initiated either programmatically or
  161. by user action, and once when loading is terminated due to completion, cancellation of failure.
  162. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
  163. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  164. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  165. </summary>
  166. </member>
  167. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.ConsoleMessage">
  168. <summary>
  169. Event handler for receiving Javascript console messages being sent from web pages.
  170. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
  171. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  172. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  173. (The exception to this is when you're running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
  174. </summary>
  175. </member>
  176. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.StatusMessage">
  177. <summary>
  178. Event handler for changes to the status message.
  179. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
  180. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.
  181. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  182. (The exception to this is when you're running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
  183. </summary>
  184. </member>
  185. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.JavascriptMessageReceived">
  186. <summary>
  187. Event handler that will get called when the message that originates from CefSharp.PostMessage
  188. </summary>
  189. </member>
  190. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#IWebBrowser#IsBrowserInitialized">
  191. <summary>
  192. A flag that indicates whether the WebBrowser is initialized (true) or not (false).
  193. </summary>
  194. <value><c>true</c> if this instance is browser initialized; otherwise, <c>false</c>.</value>
  195. </member>
  196. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnFrameLoadStart(CefSharp.FrameLoadStartEventArgs)">
  197. <summary>
  198. Handles the <see cref="E:FrameLoadStart" /> event.
  199. </summary>
  200. <param name="args">The <see cref="T:CefSharp.FrameLoadStartEventArgs"/> instance containing the event data.</param>
  201. </member>
  202. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnFrameLoadEnd(CefSharp.FrameLoadEndEventArgs)">
  203. <summary>
  204. Handles the <see cref="E:FrameLoadEnd" /> event.
  205. </summary>
  206. <param name="args">The <see cref="T:CefSharp.FrameLoadEndEventArgs"/> instance containing the event data.</param>
  207. </member>
  208. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnConsoleMessage(CefSharp.ConsoleMessageEventArgs)">
  209. <summary>
  210. Handles the <see cref="E:ConsoleMessage" /> event.
  211. </summary>
  212. <param name="args">The <see cref="T:CefSharp.ConsoleMessageEventArgs"/> instance containing the event data.</param>
  213. </member>
  214. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnStatusMessage(CefSharp.StatusMessageEventArgs)">
  215. <summary>
  216. Handles the <see cref="E:StatusMessage" /> event.
  217. </summary>
  218. <param name="args">The <see cref="T:CefSharp.StatusMessageEventArgs"/> instance containing the event data.</param>
  219. </member>
  220. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnLoadError(CefSharp.LoadErrorEventArgs)">
  221. <summary>
  222. Handles the <see cref="E:LoadError" /> event.
  223. </summary>
  224. <param name="args">The <see cref="T:CefSharp.LoadErrorEventArgs"/> instance containing the event data.</param>
  225. </member>
  226. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#HasParent">
  227. <summary>
  228. Gets or sets a value indicating whether this instance has parent.
  229. </summary>
  230. <value><c>true</c> if this instance has parent; otherwise, <c>false</c>.</value>
  231. </member>
  232. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#BrowserAdapter">
  233. <summary>
  234. Gets the browser adapter.
  235. </summary>
  236. <value>The browser adapter.</value>
  237. </member>
  238. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.InternalIsBrowserInitialized">
  239. <summary>
  240. Check is browser is initialized
  241. </summary>
  242. <returns>true if browser is initialized</returns>
  243. </member>
  244. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.ThrowExceptionIfBrowserNotInitialized">
  245. <summary>
  246. Throw exception if browser not initialized.
  247. </summary>
  248. <exception cref="T:System.Exception">Thrown when an exception error condition occurs.</exception>
  249. </member>
  250. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.ThrowExceptionIfDisposed">
  251. <summary>
  252. Throw exception if disposed.
  253. </summary>
  254. <exception cref="T:System.ObjectDisposedException">Thrown when a supplied object has been disposed.</exception>
  255. </member>
  256. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.managedCefBrowserAdapter">
  257. <summary>
  258. The managed cef browser adapter
  259. </summary>
  260. </member>
  261. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.parentFormMessageInterceptor">
  262. <summary>
  263. The parent form message interceptor
  264. </summary>
  265. </member>
  266. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.browser">
  267. <summary>
  268. The browser
  269. </summary>
  270. </member>
  271. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.designMode">
  272. <summary>
  273. A flag that indicates whether or not the designer is active
  274. NOTE: DesignMode becomes false by the time we get to the destructor/dispose so it gets stored here
  275. </summary>
  276. </member>
  277. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.initialized">
  278. <summary>
  279. A flag that indicates whether or not <see cref="M:CefSharp.WinForms.ChromiumWebBrowser.InitializeFieldsAndCefIfRequired"/> has been called.
  280. </summary>
  281. </member>
  282. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.browserCreated">
  283. <summary>
  284. Has the underlying Cef Browser been created (slightly different to initialized in that
  285. the browser is initialized in an async fashion)
  286. </summary>
  287. </member>
  288. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.initialAddressLoaded">
  289. <summary>
  290. A flag indicating if the <see cref="P:CefSharp.WinForms.ChromiumWebBrowser.Address"/> was used when calling CreateBrowser
  291. If false and <see cref="P:CefSharp.WinForms.ChromiumWebBrowser.Address"/> contains a non empty string Load will be called
  292. on the main frame
  293. </summary>
  294. </member>
  295. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.removeExNoActivateStyle">
  296. <summary>
  297. If true the the WS_EX_NOACTIVATE style will be removed so that future mouse clicks
  298. inside the browser correctly activate and focus the window.
  299. </summary>
  300. </member>
  301. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.browserSettings">
  302. <summary>
  303. Browser initialization settings
  304. </summary>
  305. </member>
  306. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.requestContext">
  307. <summary>
  308. The request context (we deliberately use a private variable so we can throw an exception if
  309. user attempts to set after browser created)
  310. </summary>
  311. </member>
  312. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.disposeSignaled">
  313. <summary>
  314. The value for disposal, if it's 1 (one) then this instance is either disposed
  315. or in the process of getting disposed
  316. </summary>
  317. </member>
  318. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.parkingControl">
  319. <summary>
  320. Parking control used to temporarily host the CefBrowser instance
  321. when <see cref="!:RecreatingHandle"/> is <c>true</c>.
  322. </summary>
  323. </member>
  324. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.IsDisposed">
  325. <summary>
  326. Gets a value indicating whether this instance is disposed.
  327. </summary>
  328. <value><see langword="true" /> if this instance is disposed; otherwise, <see langword="false" />.</value>
  329. </member>
  330. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.IsActivating">
  331. <summary>
  332. Set to true while handing an activating WM_ACTIVATE message.
  333. MUST ONLY be cleared by DefaultFocusHandler.
  334. </summary>
  335. <value><c>true</c> if this instance is activating; otherwise, <c>false</c>.</value>
  336. </member>
  337. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.BrowserSettings">
  338. <summary>
  339. Gets or sets the browser settings.
  340. </summary>
  341. <value>The browser settings.</value>
  342. </member>
  343. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.ActivateBrowserOnCreation">
  344. <summary>
  345. Activates browser upon creation, the default value is false. Prior to version 73
  346. the default behaviour was to activate browser on creation (Equivalent of setting this property to true).
  347. To restore this behaviour set this value to true immediately after you create the <see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/> instance.
  348. https://bitbucket.org/chromiumembedded/cef/issues/1856/branch-2526-cef-activates-browser-window
  349. </summary>
  350. </member>
  351. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.RequestContext">
  352. <summary>
  353. Gets or sets the request context.
  354. </summary>
  355. <value>The request context.</value>
  356. </member>
  357. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.IsLoading">
  358. <summary>
  359. A flag that indicates whether the control is currently loading one or more web pages (true) or not (false).
  360. </summary>
  361. <value><c>true</c> if this instance is loading; otherwise, <c>false</c>.</value>
  362. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  363. binding.</remarks>
  364. </member>
  365. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.TooltipText">
  366. <summary>
  367. The text that will be displayed as a ToolTip
  368. </summary>
  369. <value>The tooltip text.</value>
  370. </member>
  371. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.Address">
  372. <summary>
  373. The address (URL) which the browser control is currently displaying.
  374. Will automatically be updated as the user navigates to another page (e.g. by clicking on a link).
  375. </summary>
  376. <value>The address.</value>
  377. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  378. binding.</remarks>
  379. </member>
  380. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.AddressChanged">
  381. <summary>
  382. Occurs when the browser address changed.
  383. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
  384. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  385. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  386. </summary>
  387. </member>
  388. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.TitleChanged">
  389. <summary>
  390. Occurs when the browser title changed.
  391. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
  392. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  393. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  394. </summary>
  395. </member>
  396. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.IsBrowserInitializedChanged">
  397. <summary>
  398. Event called after the underlying CEF browser instance has been created.
  399. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
  400. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  401. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  402. </summary>
  403. </member>
  404. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CanGoForward">
  405. <summary>
  406. A flag that indicates whether the state of the control currently supports the GoForward action (true) or not (false).
  407. </summary>
  408. <value><c>true</c> if this instance can go forward; otherwise, <c>false</c>.</value>
  409. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  410. binding.</remarks>
  411. </member>
  412. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CanGoBack">
  413. <summary>
  414. A flag that indicates whether the state of the control current supports the GoBack action (true) or not (false).
  415. </summary>
  416. <value><c>true</c> if this instance can go back; otherwise, <c>false</c>.</value>
  417. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  418. binding.</remarks>
  419. </member>
  420. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.IsBrowserInitialized">
  421. <summary>
  422. A flag that indicates whether the WebBrowser is initialized (true) or not (false).
  423. </summary>
  424. <value><c>true</c> if this instance is browser initialized; otherwise, <c>false</c>.</value>
  425. </member>
  426. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.UseParentFormMessageInterceptor">
  427. <summary>
  428. ParentFormMessageInterceptor hooks the Form handle and forwards
  429. the move/active messages to the browser, the default is true
  430. and should only be required when using <see cref="P:CefSharp.CefSettingsBase.MultiThreadedMessageLoop"/>
  431. set to true.
  432. </summary>
  433. </member>
  434. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.ParkControlOnHandleDestroyed">
  435. <summary>
  436. By default when <see cref="M:System.Windows.Forms.Control.OnHandleDestroyed(System.EventArgs)"/> is called
  437. the underlying Browser Hwnd is only parked (moved to a temp parent)
  438. when <see cref="P:System.Windows.Forms.Control.RecreatingHandle"/> is <c>true</c>, there are a few other
  439. cases where parking of the control is desired, you can force parking by setting
  440. this property to <c>true</c>.
  441. </summary>
  442. <remarks>
  443. You may wish to set this property to <c>true</c> when using the browser in conjunction
  444. with https://github.com/dockpanelsuite/dockpanelsuite
  445. </remarks>
  446. </member>
  447. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.#cctor">
  448. <summary>
  449. Initializes static members of the <see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/> class.
  450. </summary>
  451. </member>
  452. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.OnApplicationExit(System.Object,System.EventArgs)">
  453. <summary>
  454. Handles the <see cref="E:ApplicationExit" /> event.
  455. </summary>
  456. <param name="sender">The sender.</param>
  457. <param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
  458. </member>
  459. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.#ctor">
  460. <summary>
  461. This constructor exists as the WinForms designer requires a parameterless constructor, if you are instantiating
  462. an instance of this class in code then use the <see cref="M:CefSharp.WinForms.ChromiumWebBrowser.#ctor(System.String,CefSharp.IRequestContext)"/>
  463. constructor overload instead. Using this constructor in code is unsupported and you may experience <see cref="T:System.NullReferenceException"/>'s
  464. when attempting to access some of the properties immediately after instantiation.
  465. </summary>
  466. </member>
  467. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.#ctor(CefSharp.Web.HtmlString,CefSharp.IRequestContext)">
  468. <summary>
  469. Initializes a new instance of the <see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/> class.
  470. **Important** - When using this constructor the <see cref="P:System.Windows.Forms.Control.Dock"/> property
  471. will default to <see cref="F:System.Windows.Forms.DockStyle.Fill"/>.
  472. </summary>
  473. <param name="html">html string to be initially loaded in the browser.</param>
  474. <param name="requestContext">(Optional) Request context that will be used for this browser instance, if null the Global
  475. Request Context will be used.</param>
  476. </member>
  477. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.#ctor(System.String,CefSharp.IRequestContext)">
  478. <summary>
  479. Initializes a new instance of the <see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/> class.
  480. **Important** - When using this constructor the <see cref="P:System.Windows.Forms.Control.Dock"/> property
  481. will default to <see cref="F:System.Windows.Forms.DockStyle.Fill"/>.
  482. </summary>
  483. <param name="address">The address.</param>
  484. <param name="requestContext">(Optional) Request context that will be used for this browser instance, if null the Global
  485. Request Context will be used.</param>
  486. </member>
  487. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.InitializeFieldsAndCefIfRequired">
  488. <summary>
  489. Required for designer support - this method cannot be inlined as the designer
  490. will attempt to load libcef.dll and will subsequently throw an exception.
  491. TODO: Still not happy with this method name, need something better
  492. </summary>
  493. </member>
  494. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.Dispose(System.Boolean)">
  495. <summary>
  496. If not in design mode; Releases unmanaged and - optionally - managed resources for the <see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/>
  497. </summary>
  498. <param name="disposing"><see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
  499. </member>
  500. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.InternalDispose(System.Boolean)">
  501. <summary>
  502. Releases unmanaged and - optionally - managed resources for the <see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/>
  503. </summary>
  504. <param name="disposing"><see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
  505. <remarks>
  506. This method cannot be inlined as the designer will attempt to load libcef.dll and will subsequently throw an exception.
  507. </remarks>
  508. </member>
  509. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.Load(System.String)">
  510. <summary>
  511. Loads the specified URL.
  512. </summary>
  513. <param name="url">The URL to be loaded.</param>
  514. </member>
  515. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.JavascriptObjectRepository">
  516. <summary>
  517. The javascript object repository, one repository per ChromiumWebBrowser instance.
  518. </summary>
  519. </member>
  520. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.OnHandleCreated(System.EventArgs)">
  521. <summary>
  522. Raises the <see cref="E:System.Windows.Forms.Control.HandleCreated" /> event.
  523. </summary>
  524. <param name="e">An <see cref="T:System.EventArgs" /> that contains the event data.</param>
  525. </member>
  526. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CreateBrowserWindowInfo(System.IntPtr)">
  527. <summary>
  528. Override this method to handle creation of WindowInfo. This method can be used to customise aspects of
  529. browser creation including configuration of settings such as <see cref="P:CefSharp.IWindowInfo.ExStyle"/>.
  530. Window Activation is disabled by default, you can re-enable it by overriding and removing the
  531. WS_EX_NOACTIVATE style from <see cref="P:CefSharp.IWindowInfo.ExStyle"/>.
  532. </summary>
  533. <param name="handle">Window handle for the Control</param>
  534. <returns>Window Info</returns>
  535. <example>
  536. To re-enable Window Activation then remove WS_EX_NOACTIVATE from ExStyle
  537. <code>
  538. const uint WS_EX_NOACTIVATE = 0x08000000;
  539. windowInfo.ExStyle &amp;= ~WS_EX_NOACTIVATE;
  540. </code>
  541. </example>
  542. </member>
  543. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnAfterBrowserCreated(CefSharp.IBrowser)">
  544. <summary>
  545. Called after browser created.
  546. </summary>
  547. <param name="browser">The browser.</param>
  548. </member>
  549. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#SetAddress(CefSharp.AddressChangedEventArgs)">
  550. <summary>
  551. Sets the address.
  552. </summary>
  553. <param name="args">The <see cref="T:CefSharp.AddressChangedEventArgs"/> instance containing the event data.</param>
  554. </member>
  555. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#SetLoadingStateChange(CefSharp.LoadingStateChangedEventArgs)">
  556. <summary>
  557. Sets the loading state change.
  558. </summary>
  559. <param name="args">The <see cref="T:CefSharp.LoadingStateChangedEventArgs"/> instance containing the event data.</param>
  560. </member>
  561. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#SetTitle(CefSharp.TitleChangedEventArgs)">
  562. <summary>
  563. Sets the title.
  564. </summary>
  565. <param name="args">The <see cref="T:CefSharp.TitleChangedEventArgs"/> instance containing the event data.</param>
  566. </member>
  567. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#SetTooltipText(System.String)">
  568. <summary>
  569. Sets the tooltip text.
  570. </summary>
  571. <param name="tooltipText">The tooltip text.</param>
  572. </member>
  573. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.Focused">
  574. <summary>
  575. Manually implement Focused because cef does not implement it.
  576. </summary>
  577. <value><c>true</c> if focused; otherwise, <c>false</c>.</value>
  578. <remarks>This is also how the Microsoft's WebBrowserControl implements the Focused property.</remarks>
  579. </member>
  580. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.OnSizeChanged(System.EventArgs)">
  581. <summary>
  582. Raises the <see cref="E:System.Windows.Forms.Control.SizeChanged" /> event.
  583. </summary>
  584. <param name="e">An <see cref="T:System.EventArgs" /> that contains the event data.</param>
  585. </member>
  586. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.ResizeBrowser(System.Int32,System.Int32)">
  587. <summary>
  588. Resizes the browser.
  589. </summary>
  590. </member>
  591. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.HideInternal">
  592. <summary>
  593. When minimized set the browser window size to 0x0 to reduce resource usage.
  594. https://github.com/chromiumembedded/cef/blob/c7701b8a6168f105f2c2d6b239ce3958da3e3f13/tests/cefclient/browser/browser_window_std_win.cc#L87
  595. </summary>
  596. </member>
  597. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.ShowInternal">
  598. <summary>
  599. Show the browser (called after previous minimised)
  600. </summary>
  601. </member>
  602. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.OnGotFocus(System.EventArgs)">
  603. <summary>
  604. Raises the <see cref="E:System.Windows.Forms.Control.GotFocus" /> event.
  605. </summary>
  606. <param name="e">An <see cref="T:System.EventArgs" /> that contains the event data.</param>
  607. </member>
  608. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.GetBrowser">
  609. <summary>
  610. Returns the current IBrowser Instance
  611. </summary>
  612. <returns>browser instance or null</returns>
  613. </member>
  614. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.DefaultSize">
  615. <summary>
  616. Gets the default size of the control.
  617. </summary>
  618. <value>
  619. The default <see cref="T:System.Drawing.Size" /> of the control.
  620. </value>
  621. </member>
  622. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.IsInputKey(System.Windows.Forms.Keys)">
  623. <summary>
  624. Makes certain keys as Input keys when CefSettings.MultiThreadedMessageLoop = false
  625. </summary>
  626. <param name="keyData">key data</param>
  627. <returns>true for a select list of keys otherwise defers to base.IsInputKey</returns>
  628. </member>
  629. <member name="T:CefSharp.WinForms.CefSettings">
  630. <summary>
  631. Initialization settings. Many of these and other settings can also configured
  632. using command-line switches.
  633. </summary>
  634. </member>
  635. <member name="T:CefSharp.WinForms.ChromiumWebBrowserDesigner">
  636. <summary>
  637. ChromiumWebBrowser Control Designer
  638. </summary>
  639. </member>
  640. <member name="M:CefSharp.WinForms.ChromiumWebBrowserDesigner.OnPaintAdornments(System.Windows.Forms.PaintEventArgs)">
  641. <summary>
  642. Receives a call when the control that the designer is managing has painted its surface so the designer can paint any additional adornments on top of the control.
  643. </summary>
  644. <param name="pe">args</param>
  645. </member>
  646. <member name="M:CefSharp.WinForms.ChromiumWebBrowserDesigner.PreFilterProperties(System.Collections.IDictionary)">
  647. <summary>
  648. Adjusts the set of properties the component exposes through a TypeDescriptor.
  649. </summary>
  650. <param name="properties">properties</param>
  651. </member>
  652. <member name="T:CefSharp.WinForms.Internals.DefaultFocusHandler">
  653. <summary>
  654. Default implementation of <see cref="T:CefSharp.IFocusHandler" />
  655. for the WinForms implementation
  656. </summary>
  657. <seealso cref="T:CefSharp.IFocusHandler" />
  658. </member>
  659. <member name="M:CefSharp.WinForms.Internals.DefaultFocusHandler.OnGotFocus(CefSharp.IWebBrowser,CefSharp.IBrowser)">
  660. <summary>
  661. Called when the browser component has received focus.
  662. </summary>
  663. <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
  664. <param name="browser">the browser object</param>
  665. <remarks>Try to avoid needing to override this logic in a subclass. The implementation in
  666. DefaultFocusHandler relies on very detailed behavior of how WinForms and
  667. Windows interact during window activation.</remarks>
  668. </member>
  669. <member name="M:CefSharp.WinForms.Internals.DefaultFocusHandler.OnSetFocus(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefFocusSource)">
  670. <summary>
  671. Called when the browser component is requesting focus.
  672. </summary>
  673. <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
  674. <param name="browser">the browser object</param>
  675. <param name="source">Indicates where the focus request is originating from.</param>
  676. <returns>Return false to allow the focus to be set or true to cancel setting the focus.</returns>
  677. </member>
  678. <member name="M:CefSharp.WinForms.Internals.DefaultFocusHandler.OnTakeFocus(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Boolean)">
  679. <summary>
  680. Called when the browser component is about to lose focus.
  681. For instance, if focus was on the last HTML element and the user pressed the TAB key.
  682. </summary>
  683. <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
  684. <param name="browser">the browser object</param>
  685. <param name="next">Will be true if the browser is giving focus to the next component
  686. and false if the browser is giving focus to the previous component.</param>
  687. </member>
  688. <member name="T:CefSharp.WinForms.Internals.ControlExtensions">
  689. <summary>
  690. ControlExtensions.
  691. </summary>
  692. </member>
  693. <member name="M:CefSharp.WinForms.Internals.ControlExtensions.InvokeOnUiThreadIfRequired(System.Windows.Forms.Control,System.Action)">
  694. <summary>
  695. Executes the Action asynchronously on the UI thread, does not block execution on the calling thread.
  696. No action will be performed if the control doesn't have a valid handle or the control is Disposed/Disposing.
  697. </summary>
  698. <param name="control">the control for which the update is required</param>
  699. <param name="action">action to be performed on the control</param>
  700. </member>
  701. <member name="M:CefSharp.WinForms.Internals.ControlExtensions.Activate(System.Windows.Forms.Control)">
  702. <summary>
  703. Activates the specified control.
  704. </summary>
  705. <param name="control">The control.</param>
  706. <returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
  707. </member>
  708. <member name="M:CefSharp.WinForms.Internals.ControlExtensions.IsActiveControl(System.Windows.Forms.Control)">
  709. <summary>
  710. Returns whether the supplied control is the currently
  711. active control.
  712. </summary>
  713. <param name="control">the control to check</param>
  714. <returns>true if the control is the currently active control</returns>
  715. </member>
  716. <member name="M:CefSharp.WinForms.Internals.ControlExtensions.SelectNextControl(System.Windows.Forms.Control,System.Boolean)">
  717. <summary>
  718. Selects the next control.
  719. </summary>
  720. <param name="control">The control.</param>
  721. <param name="next">if set to <c>true</c> [next].</param>
  722. </member>
  723. <member name="T:CefSharp.WinForms.Internals.ParentFormMessageInterceptor">
  724. <summary>
  725. ParentFormMessageInterceptor - hooks into the parent forms
  726. message loop to incercept messages like WM_MOVE
  727. </summary>
  728. <seealso cref="T:System.Windows.Forms.NativeWindow" />
  729. <seealso cref="T:System.IDisposable" />
  730. </member>
  731. <member name="F:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.isMoving">
  732. <summary>
  733. Keep track of whether a move is in progress.
  734. </summary>
  735. </member>
  736. <member name="F:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.movingRectangle">
  737. <summary>
  738. Used to determine the coordinates involved in the move
  739. </summary>
  740. </member>
  741. <member name="F:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.previousWindowState">
  742. <summary>
  743. Store the previous window state, used to determine if the
  744. Windows was previously <see cref="F:System.Windows.Forms.FormWindowState.Minimized"/>
  745. and resume rendering
  746. </summary>
  747. </member>
  748. <member name="P:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.Browser">
  749. <summary>
  750. Gets or sets the browser.
  751. </summary>
  752. <value>The browser.</value>
  753. </member>
  754. <member name="P:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.ParentForm">
  755. <summary>
  756. Gets or sets the parent form.
  757. </summary>
  758. <value>The parent form.</value>
  759. </member>
  760. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.#ctor(CefSharp.WinForms.ChromiumWebBrowser)">
  761. <summary>
  762. Initializes a new instance of the <see cref="T:CefSharp.WinForms.Internals.ParentFormMessageInterceptor"/> class.
  763. </summary>
  764. <param name="browser">The browser.</param>
  765. </member>
  766. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.RefindParentForm">
  767. <summary>
  768. Call to force refinding of the parent Form.
  769. (i.e. top level window that owns the ChromiumWebBrowserControl)
  770. </summary>
  771. </member>
  772. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.ParentParentChanged(System.Object,System.EventArgs)">
  773. <summary>
  774. Adjust the form to listen to if the ChromiumWebBrowserControl's parent changes.
  775. </summary>
  776. <param name="sender">The ChromiumWebBrowser whose parent has changed.</param>
  777. <param name="e">The <see cref="T:System.EventArgs" /> instance containing the event data.</param>
  778. </member>
  779. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.OnHandleCreated(System.Object,System.EventArgs)">
  780. <summary>
  781. Handles the <see cref="E:HandleCreated" /> event.
  782. </summary>
  783. <param name="sender">The sender.</param>
  784. <param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
  785. </member>
  786. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.OnHandleDestroyed(System.Object,System.EventArgs)">
  787. <summary>
  788. Handles the <see cref="E:HandleDestroyed" /> event.
  789. </summary>
  790. <param name="sender">The sender.</param>
  791. <param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
  792. </member>
  793. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.WndProc(System.Windows.Forms.Message@)">
  794. <summary>
  795. Invokes the default window procedure associated with this window.
  796. </summary>
  797. <param name="m">A <see cref="T:System.Windows.Forms.Message" /> that is associated with the current Windows message.</param>
  798. </member>
  799. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.OnMoving">
  800. <summary>
  801. Called when [moving].
  802. </summary>
  803. </member>
  804. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.Dispose">
  805. <summary>
  806. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
  807. </summary>
  808. </member>
  809. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.Dispose(System.Boolean)">
  810. <summary>
  811. Releases unmanaged and - optionally - managed resources.
  812. </summary>
  813. <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
  814. </member>
  815. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.OnThreadException(System.Exception)">
  816. <summary>
  817. When overridden in a derived class, manages an unhandled thread exception.
  818. </summary>
  819. <param name="e">An <see cref="T:System.Exception" /> that specifies the unhandled thread exception.</param>
  820. </member>
  821. <member name="T:CefSharp.WinForms.Internals.NativeMethods">
  822. <summary>
  823. Class NativeMethods.
  824. </summary>
  825. </member>
  826. <member name="F:CefSharp.WinForms.Internals.NativeMethods.WM_MOVE">
  827. <summary>
  828. The w m_ move
  829. </summary>
  830. </member>
  831. <member name="F:CefSharp.WinForms.Internals.NativeMethods.WM_MOVING">
  832. <summary>
  833. The w m_ moving
  834. </summary>
  835. </member>
  836. <member name="F:CefSharp.WinForms.Internals.NativeMethods.WM_ACTIVATE">
  837. <summary>
  838. The w m_ activate
  839. </summary>
  840. </member>
  841. <member name="T:CefSharp.WinForms.IWinFormsWebBrowser">
  842. <summary>
  843. WinForms specific implementation, has events the
  844. <see cref="T:CefSharp.WinForms.ChromiumWebBrowser" /> implementation exposes.
  845. </summary>
  846. <seealso cref="T:CefSharp.IWebBrowser" />
  847. </member>
  848. <member name="E:CefSharp.WinForms.IWinFormsWebBrowser.TitleChanged">
  849. <summary>
  850. Occurs when the browser title changed.
  851. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
  852. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  853. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  854. </summary>
  855. </member>
  856. <member name="E:CefSharp.WinForms.IWinFormsWebBrowser.AddressChanged">
  857. <summary>
  858. Occurs when the browser address changed.
  859. It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
  860. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  861. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  862. </summary>
  863. </member>
  864. <member name="T:CefSharp.WinForms.WebBrowserExtensions">
  865. <summary>
  866. Helper extensions for performing common CefSharp related WinForms tasks
  867. </summary>
  868. </member>
  869. <member name="M:CefSharp.WinForms.WebBrowserExtensions.DestroyWindow(CefSharp.IWebBrowser)">
  870. <summary>
  871. Manually call https://docs.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-destroywindow
  872. passing in the handle returned from <see cref="M:CefSharp.IBrowserHost.GetWindowHandle"/>.
  873. This method can be used to manually close the underlying CefBrowser instance.
  874. This will avoid the WM_Close message that CEF sends by default to the top level window.
  875. (Which closes your application). This method should generally only be used in the WinForms version.
  876. </summary>
  877. <param name="chromiumWebBrowser">the ChromiumWebBrowser instance</param>
  878. <returns>If the function succeeds, the return value is true.</returns>
  879. <example>
  880. <code>
  881. //Invoke on the CEF UI Thread
  882. Cef.UIThreadTaskFactory.StartNew(() =>
  883. {
  884. var closed = chromiumWebBrowser.DestroyWindow();
  885. });
  886. </code>
  887. </example>
  888. </member>
  889. </members>
  890. </doc>