CefSharp.WinForms.XML 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>CefSharp.WinForms</name>
  5. </assembly>
  6. <members>
  7. <member name="T:CefSharp.WinForms.Internals.DefaultFocusHandler">
  8. <summary>
  9. Default implementation of <see cref="T:CefSharp.IFocusHandler"/>
  10. for the WinForms implementation
  11. </summary>
  12. <seealso cref="T:CefSharp.IFocusHandler"/>
  13. </member>
  14. <member name="F:CefSharp.WinForms.Internals.DefaultFocusHandler.browser">
  15. <summary>
  16. The browser
  17. </summary>
  18. </member>
  19. <member name="M:CefSharp.WinForms.Internals.DefaultFocusHandler.#ctor(CefSharp.WinForms.ChromiumWebBrowser)">
  20. <summary>
  21. Initializes a new instance of the <see cref="T:CefSharp.WinForms.Internals.DefaultFocusHandler"/> class.
  22. </summary>
  23. <param name="browser">The browser.</param>
  24. </member>
  25. <member name="M:CefSharp.WinForms.Internals.DefaultFocusHandler.OnGotFocus">
  26. <summary>
  27. Called when the browser component has received focus.
  28. </summary>
  29. <remarks>Try to avoid needing to override this logic in a subclass. The implementation in
  30. DefaultFocusHandler relies on very detailed behavior of how WinForms and
  31. Windows interact during window activation.</remarks>
  32. </member>
  33. <member name="M:CefSharp.WinForms.Internals.DefaultFocusHandler.OnSetFocus(CefSharp.CefFocusSource)">
  34. <summary>
  35. Called when the browser component is requesting focus.
  36. </summary>
  37. <param name="source">Indicates where the focus request is originating from.</param>
  38. <returns>Return false to allow the focus to be set or true to cancel setting the focus.</returns>
  39. </member>
  40. <member name="M:CefSharp.WinForms.Internals.DefaultFocusHandler.OnTakeFocus(System.Boolean)">
  41. <summary>
  42. Called when the browser component is about to lose focus.
  43. For instance, if focus was on the last HTML element and the user pressed the TAB key.
  44. </summary>
  45. <param name="next">Will be true if the browser is giving focus to the next component
  46. and false if the browser is giving focus to the previous component.</param>
  47. </member>
  48. <member name="T:CefSharp.WinForms.Internals.ControlExtensions">
  49. <summary>
  50. ControlExtensions.
  51. </summary>
  52. </member>
  53. <member name="M:CefSharp.WinForms.Internals.ControlExtensions.InvokeOnUiThreadIfRequired(System.Windows.Forms.Control,System.Action)">
  54. <summary>
  55. Executes the Action asynchronously on the UI thread, does not block execution on the calling thread.
  56. </summary>
  57. <param name="control">the control for which the update is required</param>
  58. <param name="action">action to be performed on the control</param>
  59. </member>
  60. <member name="M:CefSharp.WinForms.Internals.ControlExtensions.Activate(System.Windows.Forms.Control)">
  61. <summary>
  62. Activates the specified control.
  63. </summary>
  64. <param name="control">The control.</param>
  65. <returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
  66. </member>
  67. <member name="M:CefSharp.WinForms.Internals.ControlExtensions.IsActiveControl(System.Windows.Forms.Control)">
  68. <summary>
  69. Returns whether the supplied control is the currently
  70. active control.
  71. </summary>
  72. <param name="control">the control to check</param>
  73. <returns>true if the control is the currently active control</returns>
  74. </member>
  75. <member name="M:CefSharp.WinForms.Internals.ControlExtensions.SelectNextControl(System.Windows.Forms.Control,System.Boolean)">
  76. <summary>
  77. Selects the next control.
  78. </summary>
  79. <param name="control">The control.</param>
  80. <param name="next">if set to <c>true</c> [next].</param>
  81. </member>
  82. <member name="T:CefSharp.WinForms.Internals.ParentFormMessageInterceptor">
  83. <summary>
  84. ParentFormMessageInterceptor - hooks into the parent forms
  85. message loop to incercept messages like WM_MOVE
  86. </summary>
  87. <seealso cref="T:System.Windows.Forms.NativeWindow"/>
  88. <seealso cref="T:System.IDisposable"/>
  89. </member>
  90. <member name="F:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.isMoving">
  91. <summary>
  92. Keep track of whether a move is in progress.
  93. </summary>
  94. </member>
  95. <member name="F:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.movingRectangle">
  96. <summary>
  97. Used to determine the coordinates involved in the move
  98. </summary>
  99. </member>
  100. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.#ctor(CefSharp.WinForms.ChromiumWebBrowser)">
  101. <summary>
  102. Initializes a new instance of the <see cref="T:CefSharp.WinForms.Internals.ParentFormMessageInterceptor"/> class.
  103. </summary>
  104. <param name="browser">The browser.</param>
  105. </member>
  106. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.RefindParentForm">
  107. <summary>
  108. Call to force refinding of the parent Form.
  109. (i.e. top level window that owns the ChromiumWebBrowserControl)
  110. </summary>
  111. </member>
  112. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.ParentParentChanged(System.Object,System.EventArgs)">
  113. <summary>
  114. Adjust the form to listen to if the ChromiumWebBrowserControl's parent changes.
  115. </summary>
  116. <param name="sender">The ChromiumWebBrowser whose parent has changed.</param>
  117. <param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
  118. </member>
  119. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.OnHandleCreated(System.Object,System.EventArgs)">
  120. <summary>
  121. Handles the <see cref="E:HandleCreated"/> event.
  122. </summary>
  123. <param name="sender">The sender.</param>
  124. <param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
  125. </member>
  126. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.OnHandleDestroyed(System.Object,System.EventArgs)">
  127. <summary>
  128. Handles the <see cref="E:HandleDestroyed"/> event.
  129. </summary>
  130. <param name="sender">The sender.</param>
  131. <param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
  132. </member>
  133. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.WndProc(System.Windows.Forms.Message@)">
  134. <summary>
  135. Invokes the default window procedure associated with this window.
  136. </summary>
  137. <param name="m">A <see cref="T:System.Windows.Forms.Message" /> that is associated with the current Windows message.</param>
  138. </member>
  139. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.OnMoving">
  140. <summary>
  141. Called when [moving].
  142. </summary>
  143. </member>
  144. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.Dispose">
  145. <summary>
  146. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
  147. </summary>
  148. </member>
  149. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.Dispose(System.Boolean)">
  150. <summary>
  151. Releases unmanaged and - optionally - managed resources.
  152. </summary>
  153. <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
  154. </member>
  155. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.OnThreadException(System.Exception)">
  156. <summary>
  157. When overridden in a derived class, manages an unhandled thread exception.
  158. </summary>
  159. <param name="e">An <see cref="T:System.Exception" /> that specifies the unhandled thread exception.</param>
  160. </member>
  161. <member name="P:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.Browser">
  162. <summary>
  163. Gets or sets the browser.
  164. </summary>
  165. <value>The browser.</value>
  166. </member>
  167. <member name="P:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.ParentForm">
  168. <summary>
  169. Gets or sets the parent form.
  170. </summary>
  171. <value>The parent form.</value>
  172. </member>
  173. <member name="T:CefSharp.WinForms.Internals.NativeMethods">
  174. <summary>
  175. Class NativeMethods.
  176. </summary>
  177. </member>
  178. <member name="F:CefSharp.WinForms.Internals.NativeMethods.WM_MOVE">
  179. <summary>
  180. The w m_ move
  181. </summary>
  182. </member>
  183. <member name="F:CefSharp.WinForms.Internals.NativeMethods.WM_MOVING">
  184. <summary>
  185. The w m_ moving
  186. </summary>
  187. </member>
  188. <member name="F:CefSharp.WinForms.Internals.NativeMethods.WM_ACTIVATE">
  189. <summary>
  190. The w m_ activate
  191. </summary>
  192. </member>
  193. <!-- Badly formed XML comment ignored for member "T:CefSharp.WinForms.IWinFormsWebBrowser" -->
  194. <member name="E:CefSharp.WinForms.IWinFormsWebBrowser.TitleChanged">
  195. <summary>
  196. Occurs when the browser title changed.
  197. 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
  198. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  199. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  200. </summary>
  201. </member>
  202. <member name="E:CefSharp.WinForms.IWinFormsWebBrowser.AddressChanged">
  203. <summary>
  204. Occurs when the browser address changed.
  205. 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
  206. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  207. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  208. </summary>
  209. </member>
  210. <member name="T:CefSharp.WinForms.ChromiumWebBrowser">
  211. <summary>
  212. ChromiumWebBrowser is the WinForms web browser control
  213. </summary>
  214. <seealso cref="T:System.Windows.Forms.Control"/>
  215. <seealso cref="T:CefSharp.Internals.IWebBrowserInternal"/>
  216. <seealso cref="T:CefSharp.WinForms.IWinFormsWebBrowser"/>
  217. </member>
  218. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.managedCefBrowserAdapter">
  219. <summary>
  220. The managed cef browser adapter
  221. </summary>
  222. </member>
  223. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.parentFormMessageInterceptor">
  224. <summary>
  225. The parent form message interceptor
  226. </summary>
  227. </member>
  228. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.browser">
  229. <summary>
  230. The browser
  231. </summary>
  232. </member>
  233. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.#cctor">
  234. <summary>
  235. Initializes static members of the <see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/> class.
  236. </summary>
  237. </member>
  238. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.OnApplicationExit(System.Object,System.EventArgs)">
  239. <summary>
  240. Handles the <see cref="E:ApplicationExit"/> event.
  241. </summary>
  242. <param name="sender">The sender.</param>
  243. <param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
  244. </member>
  245. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.#ctor(System.String)">
  246. <summary>
  247. Initializes a new instance of the <see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/> class.
  248. </summary>
  249. <param name="address">The address.</param>
  250. <exception cref="T:System.InvalidOperationException">Cef::Initialize() failed</exception>
  251. </member>
  252. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.Dispose(System.Boolean)">
  253. <summary>
  254. Releases the unmanaged resources used by the <see cref="T:System.Windows.Forms.Control" /> and its child controls and optionally releases the managed resources.
  255. </summary>
  256. <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
  257. </member>
  258. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.Load(System.String)">
  259. <summary>
  260. Loads the specified URL.
  261. </summary>
  262. <param name="url">The URL to be loaded.</param>
  263. </member>
  264. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.RegisterJsObject(System.String,System.Object,System.Boolean)">
  265. <summary>
  266. Registers a Javascript object in this specific browser instance.
  267. </summary>
  268. <param name="name">The name of the object. (e.g. "foo", if you want the object to be accessible as window.foo).</param>
  269. <param name="objectToBind">The object to be made accessible to Javascript.</param>
  270. <param name="camelCaseJavascriptNames">camel case the javascript names of properties/methods, defaults to true</param>
  271. <exception cref="T:System.Exception">Browser is already initialized. RegisterJsObject must be +
  272. called before the underlying CEF browser is created.</exception>
  273. </member>
  274. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.RegisterAsyncJsObject(System.String,System.Object,System.Boolean)">
  275. <summary>
  276. <para>Asynchronously registers a Javascript object in this specific browser instance.</para>
  277. <para>Only methods of the object will be availabe.</para>
  278. </summary>
  279. <param name="name">The name of the object. (e.g. "foo", if you want the object to be accessible as window.foo).</param>
  280. <param name="objectToBind">The object to be made accessible to Javascript.</param>
  281. <param name="camelCaseJavascriptNames">camel case the javascript names of methods, defaults to true</param>
  282. <exception cref="T:System.Exception">Browser is already initialized. RegisterJsObject must be +
  283. called before the underlying CEF browser is created.</exception>
  284. <remarks>The registered methods can only be called in an async way, they will all return immeditaly and the resulting
  285. object will be a standard javascript Promise object which is usable to wait for completion or failure.</remarks>
  286. </member>
  287. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.OnHandleCreated(System.EventArgs)">
  288. <summary>
  289. Raises the <see cref="E:System.Windows.Forms.Control.HandleCreated" /> event.
  290. </summary>
  291. <param name="e">An <see cref="T:System.EventArgs" /> that contains the event data.</param>
  292. </member>
  293. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnAfterBrowserCreated(CefSharp.IBrowser)">
  294. <summary>
  295. Called after browser created.
  296. </summary>
  297. <param name="browser">The browser.</param>
  298. </member>
  299. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#SetAddress(CefSharp.AddressChangedEventArgs)">
  300. <summary>
  301. Sets the address.
  302. </summary>
  303. <param name="args">The <see cref="T:CefSharp.AddressChangedEventArgs"/> instance containing the event data.</param>
  304. </member>
  305. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#SetLoadingStateChange(CefSharp.LoadingStateChangedEventArgs)">
  306. <summary>
  307. Sets the loading state change.
  308. </summary>
  309. <param name="args">The <see cref="T:CefSharp.LoadingStateChangedEventArgs"/> instance containing the event data.</param>
  310. </member>
  311. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#SetTitle(CefSharp.TitleChangedEventArgs)">
  312. <summary>
  313. Sets the title.
  314. </summary>
  315. <param name="args">The <see cref="T:CefSharp.TitleChangedEventArgs"/> instance containing the event data.</param>
  316. </member>
  317. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#SetTooltipText(System.String)">
  318. <summary>
  319. Sets the tooltip text.
  320. </summary>
  321. <param name="tooltipText">The tooltip text.</param>
  322. </member>
  323. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnFrameLoadStart(CefSharp.FrameLoadStartEventArgs)">
  324. <summary>
  325. Handles the <see cref="E:FrameLoadStart"/> event.
  326. </summary>
  327. <param name="args">The <see cref="T:CefSharp.FrameLoadStartEventArgs"/> instance containing the event data.</param>
  328. </member>
  329. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnFrameLoadEnd(CefSharp.FrameLoadEndEventArgs)">
  330. <summary>
  331. Handles the <see cref="E:FrameLoadEnd"/> event.
  332. </summary>
  333. <param name="args">The <see cref="T:CefSharp.FrameLoadEndEventArgs"/> instance containing the event data.</param>
  334. </member>
  335. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnConsoleMessage(CefSharp.ConsoleMessageEventArgs)">
  336. <summary>
  337. Handles the <see cref="E:ConsoleMessage"/> event.
  338. </summary>
  339. <param name="args">The <see cref="T:CefSharp.ConsoleMessageEventArgs"/> instance containing the event data.</param>
  340. </member>
  341. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnStatusMessage(CefSharp.StatusMessageEventArgs)">
  342. <summary>
  343. Handles the <see cref="E:StatusMessage"/> event.
  344. </summary>
  345. <param name="args">The <see cref="T:CefSharp.StatusMessageEventArgs"/> instance containing the event data.</param>
  346. </member>
  347. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnLoadError(CefSharp.LoadErrorEventArgs)">
  348. <summary>
  349. Handles the <see cref="E:LoadError"/> event.
  350. </summary>
  351. <param name="args">The <see cref="T:CefSharp.LoadErrorEventArgs"/> instance containing the event data.</param>
  352. </member>
  353. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.OnSizeChanged(System.EventArgs)">
  354. <summary>
  355. Raises the <see cref="E:System.Windows.Forms.Control.SizeChanged" /> event.
  356. </summary>
  357. <param name="e">An <see cref="T:System.EventArgs" /> that contains the event data.</param>
  358. </member>
  359. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.ResizeBrowser">
  360. <summary>
  361. Resizes the browser.
  362. </summary>
  363. </member>
  364. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.OnGotFocus(System.EventArgs)">
  365. <summary>
  366. Raises the <see cref="E:System.Windows.Forms.Control.GotFocus" /> event.
  367. </summary>
  368. <param name="e">An <see cref="T:System.EventArgs" /> that contains the event data.</param>
  369. </member>
  370. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.GetBrowser">
  371. <summary>
  372. Returns the current IBrowser Instance
  373. </summary>
  374. <returns>browser instance or null</returns>
  375. </member>
  376. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.IsActivating">
  377. <summary>
  378. Set to true while handing an activating WM_ACTIVATE message.
  379. MUST ONLY be cleared by DefaultFocusHandler.
  380. </summary>
  381. <value><c>true</c> if this instance is activating; otherwise, <c>false</c>.</value>
  382. </member>
  383. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.BrowserSettings">
  384. <summary>
  385. Gets or sets the browser settings.
  386. </summary>
  387. <value>The browser settings.</value>
  388. </member>
  389. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.RequestContext">
  390. <summary>
  391. Gets or sets the request context.
  392. </summary>
  393. <value>The request context.</value>
  394. </member>
  395. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.IsLoading">
  396. <summary>
  397. A flag that indicates whether the control is currently loading one or more web pages (true) or not (false).
  398. </summary>
  399. <value><c>true</c> if this instance is loading; otherwise, <c>false</c>.</value>
  400. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  401. binding.</remarks>
  402. </member>
  403. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.TooltipText">
  404. <summary>
  405. The text that will be displayed as a ToolTip
  406. </summary>
  407. <value>The tooltip text.</value>
  408. </member>
  409. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.Address">
  410. <summary>
  411. The address (URL) which the browser control is currently displaying.
  412. Will automatically be updated as the user navigates to another page (e.g. by clicking on a link).
  413. </summary>
  414. <value>The address.</value>
  415. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  416. binding.</remarks>
  417. </member>
  418. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.DialogHandler">
  419. <summary>
  420. Implement <see cref="T:CefSharp.IDialogHandler"/> and assign to handle dialog events.
  421. </summary>
  422. <value>The dialog handler.</value>
  423. </member>
  424. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.JsDialogHandler">
  425. <summary>
  426. Implement <see cref="T:CefSharp.IJsDialogHandler"/> and assign to handle events related to JavaScript Dialogs.
  427. </summary>
  428. <value>The js dialog handler.</value>
  429. </member>
  430. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.KeyboardHandler">
  431. <summary>
  432. Implement <see cref="T:CefSharp.IKeyboardHandler"/> and assign to handle events related to key press.
  433. </summary>
  434. <value>The keyboard handler.</value>
  435. </member>
  436. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.RequestHandler">
  437. <summary>
  438. Implement <see cref="T:CefSharp.IRequestHandler"/> and assign to handle events related to browser requests.
  439. </summary>
  440. <value>The request handler.</value>
  441. </member>
  442. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.DownloadHandler">
  443. <summary>
  444. Implement <see cref="T:CefSharp.IDownloadHandler"/> and assign to handle events related to downloading files.
  445. </summary>
  446. <value>The download handler.</value>
  447. </member>
  448. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.LoadHandler">
  449. <summary>
  450. Implement <see cref="T:CefSharp.ILoadHandler"/> and assign to handle events related to browser load status.
  451. </summary>
  452. <value>The load handler.</value>
  453. </member>
  454. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.LifeSpanHandler">
  455. <summary>
  456. Implement <see cref="T:CefSharp.ILifeSpanHandler"/> and assign to handle events related to popups.
  457. </summary>
  458. <value>The life span handler.</value>
  459. </member>
  460. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.DisplayHandler">
  461. <summary>
  462. Implement <see cref="T:CefSharp.IDisplayHandler"/> and assign to handle events related to browser display state.
  463. </summary>
  464. <value>The display handler.</value>
  465. </member>
  466. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.MenuHandler">
  467. <summary>
  468. Implement <see cref="T:CefSharp.IContextMenuHandler"/> and assign to handle events related to the browser context menu
  469. </summary>
  470. <value>The menu handler.</value>
  471. </member>
  472. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.RenderProcessMessageHandler">
  473. <summary>
  474. Implement <see cref="T:CefSharp.IRenderProcessMessageHandler"/> and assign to handle messages from the render process.
  475. </summary>
  476. <value>The render process message handler.</value>
  477. </member>
  478. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.FindHandler">
  479. <summary>
  480. Implement <see cref="T:CefSharp.IFindHandler"/> to handle events related to find results.
  481. </summary>
  482. <value>The find handler.</value>
  483. </member>
  484. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.FocusHandler">
  485. <summary>
  486. The <see cref="T:CefSharp.IFocusHandler"/> for this ChromiumWebBrowser.
  487. </summary>
  488. <value>The focus handler.</value>
  489. <remarks>If you need customized focus handling behavior for WinForms, the suggested
  490. best practice would be to inherit from DefaultFocusHandler and try to avoid
  491. needing to override the logic in OnGotFocus. The implementation in
  492. DefaultFocusHandler relies on very detailed behavior of how WinForms and
  493. Windows interact during window activation.</remarks>
  494. </member>
  495. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.DragHandler">
  496. <summary>
  497. Implement <see cref="T:CefSharp.IDragHandler"/> and assign to handle events related to dragging.
  498. </summary>
  499. <value>The drag handler.</value>
  500. </member>
  501. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.ResourceHandlerFactory">
  502. <summary>
  503. Implement <see cref="T:CefSharp.IResourceHandlerFactory"/> and control the loading of resources
  504. </summary>
  505. <value>The resource handler factory.</value>
  506. </member>
  507. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.GeolocationHandler">
  508. <summary>
  509. Implement <see cref="T:CefSharp.IGeolocationHandler"/> and assign to handle requests for permission to use geolocation.
  510. </summary>
  511. <value>The geolocation handler.</value>
  512. </member>
  513. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.LoadError">
  514. <summary>
  515. Event handler that will get called when the resource load for a navigation fails or is canceled.
  516. 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
  517. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  518. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  519. </summary>
  520. </member>
  521. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.FrameLoadStart">
  522. <summary>
  523. Event handler that will get called when the browser begins loading a frame. Multiple frames may be loading at the same
  524. time. Sub-frames may start or continue loading after the main frame load has ended. This method may not be called for a
  525. particular frame if the load request for that frame fails. For notification of overall browser load status use
  526. OnLoadingStateChange instead.
  527. 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
  528. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  529. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  530. </summary>
  531. <remarks>Whilst this may seem like a logical place to execute js, it's called before the DOM has been loaded, implement
  532. <see cref="M:CefSharp.IRenderProcessMessageHandler.OnContextCreated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)"/> as it's called when the underlying V8Context is created
  533. (Only called for the main frame at this stage)</remarks>
  534. </member>
  535. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.FrameLoadEnd">
  536. <summary>
  537. Event handler that will get called when the browser is done loading a frame. Multiple frames may be loading at the same
  538. time. Sub-frames may start or continue loading after the main frame load has ended. This method will always be called
  539. for all frames irrespective of whether the request completes successfully.
  540. 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
  541. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  542. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  543. </summary>
  544. </member>
  545. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.LoadingStateChanged">
  546. <summary>
  547. Event handler that will get called when the Loading state has changed.
  548. This event will be fired twice. Once when loading is initiated either programmatically or
  549. by user action, and once when loading is terminated due to completion, cancellation of failure.
  550. 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
  551. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  552. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  553. </summary>
  554. </member>
  555. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.ConsoleMessage">
  556. <summary>
  557. Event handler for receiving Javascript console messages being sent from web pages.
  558. 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
  559. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  560. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  561. (The exception to this is when your running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
  562. </summary>
  563. </member>
  564. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.StatusMessage">
  565. <summary>
  566. Event handler for changes to the status message.
  567. 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
  568. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.
  569. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  570. (The exception to this is when your running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
  571. </summary>
  572. </member>
  573. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.AddressChanged">
  574. <summary>
  575. Occurs when the browser address changed.
  576. 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
  577. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  578. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  579. </summary>
  580. </member>
  581. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.TitleChanged">
  582. <summary>
  583. Occurs when the browser title changed.
  584. 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
  585. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  586. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  587. </summary>
  588. </member>
  589. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.IsBrowserInitializedChanged">
  590. <summary>
  591. Occurs when [is browser initialized changed].
  592. 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
  593. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  594. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  595. </summary>
  596. </member>
  597. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CanGoForward">
  598. <summary>
  599. A flag that indicates whether the state of the control currently supports the GoForward action (true) or not (false).
  600. </summary>
  601. <value><c>true</c> if this instance can go forward; otherwise, <c>false</c>.</value>
  602. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  603. binding.</remarks>
  604. </member>
  605. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CanGoBack">
  606. <summary>
  607. A flag that indicates whether the state of the control current supports the GoBack action (true) or not (false).
  608. </summary>
  609. <value><c>true</c> if this instance can go back; otherwise, <c>false</c>.</value>
  610. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  611. binding.</remarks>
  612. </member>
  613. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.IsBrowserInitialized">
  614. <summary>
  615. A flag that indicates whether the WebBrowser is initialized (true) or not (false).
  616. </summary>
  617. <value><c>true</c> if this instance is browser initialized; otherwise, <c>false</c>.</value>
  618. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  619. binding.</remarks>
  620. </member>
  621. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#BrowserAdapter">
  622. <summary>
  623. Gets the browser adapter.
  624. </summary>
  625. <value>The browser adapter.</value>
  626. </member>
  627. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#HasParent">
  628. <summary>
  629. Gets or sets a value indicating whether this instance has parent.
  630. </summary>
  631. <value><c>true</c> if this instance has parent; otherwise, <c>false</c>.</value>
  632. </member>
  633. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.Focused">
  634. <summary>
  635. Manually implement Focused because cef does not implement it.
  636. </summary>
  637. <value><c>true</c> if focused; otherwise, <c>false</c>.</value>
  638. <remarks>This is also how the Microsoft's WebBrowserControl implements the Focused property.</remarks>
  639. </member>
  640. </members>
  641. </doc>