CefSharp.WinForms.XML 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710
  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. <member name="T:CefSharp.WinForms.IWinFormsWebBrowser">
  194. <summary>
  195. WinForms specific implementation, has events the
  196. <see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/> implementation exposes.
  197. </summary>
  198. <seealso cref="T:CefSharp.IWebBrowser"/>
  199. </member>
  200. <member name="E:CefSharp.WinForms.IWinFormsWebBrowser.TitleChanged">
  201. <summary>
  202. Occurs when the browser title changed.
  203. 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
  204. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  205. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  206. </summary>
  207. </member>
  208. <member name="E:CefSharp.WinForms.IWinFormsWebBrowser.AddressChanged">
  209. <summary>
  210. Occurs when the browser address changed.
  211. 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
  212. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  213. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  214. </summary>
  215. </member>
  216. <member name="T:CefSharp.WinForms.ChromiumWebBrowser">
  217. <summary>
  218. ChromiumWebBrowser is the WinForms web browser control
  219. </summary>
  220. <seealso cref="T:System.Windows.Forms.Control"/>
  221. <seealso cref="T:CefSharp.Internals.IWebBrowserInternal"/>
  222. <seealso cref="T:CefSharp.WinForms.IWinFormsWebBrowser"/>
  223. </member>
  224. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.managedCefBrowserAdapter">
  225. <summary>
  226. The managed cef browser adapter
  227. </summary>
  228. </member>
  229. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.parentFormMessageInterceptor">
  230. <summary>
  231. The parent form message interceptor
  232. </summary>
  233. </member>
  234. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.browser">
  235. <summary>
  236. The browser
  237. </summary>
  238. </member>
  239. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.designMode">
  240. <summary>
  241. A flag that indicates whether or not the designer is active
  242. NOTE: DesignMode becomes false by the time we get to the destructor/dispose so it gets stored here
  243. </summary>
  244. </member>
  245. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.initialized">
  246. <summary>
  247. A flag that indicates whether or not <see cref="M:CefSharp.WinForms.ChromiumWebBrowser.InitializeFieldsAndCefIfRequired"/> has been called.
  248. </summary>
  249. </member>
  250. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.browserCreated">
  251. <summary>
  252. Has the underlying Cef Browser been created (slightly different to initliazed in that
  253. the browser is initialized in an async fashion)
  254. </summary>
  255. </member>
  256. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.requestContext">
  257. <summary>
  258. The request context (we deliberately use a private variable so we can throw an exception if
  259. user attempts to set after browser created)
  260. </summary>
  261. </member>
  262. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.#cctor">
  263. <summary>
  264. Initializes static members of the <see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/> class.
  265. </summary>
  266. </member>
  267. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.OnApplicationExit(System.Object,System.EventArgs)">
  268. <summary>
  269. Handles the <see cref="E:ApplicationExit"/> event.
  270. </summary>
  271. <param name="sender">The sender.</param>
  272. <param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
  273. </member>
  274. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.#ctor">
  275. <summary>
  276. Initializes a new instance of the <see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/> class.
  277. NOTE: Should only be used by the designer
  278. </summary>
  279. </member>
  280. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.#ctor(System.String,CefSharp.IRequestContext)">
  281. <summary>
  282. Initializes a new instance of the <see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/> class.
  283. </summary>
  284. <param name="address">The address.</param>
  285. <param name="requestContext">Request context that will be used for this browser instance,
  286. if null the Global Request Context will be used</param>
  287. </member>
  288. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.InitializeFieldsAndCefIfRequired">
  289. <summary>
  290. Required for designer support - this method cannot be inlined as the designer
  291. will attempt to load libcef.dll and will subsiquently throw an exception.
  292. TODO: Still not happy with this method name, need something better
  293. </summary>
  294. </member>
  295. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.Dispose(System.Boolean)">
  296. <summary>
  297. Releases the unmanaged resources used by the <see cref="T:System.Windows.Forms.Control" /> and its child controls and optionally releases the managed resources.
  298. </summary>
  299. <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
  300. </member>
  301. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.RemoveFromListOfCefBrowsers">
  302. <summary>
  303. Required for designer support - this method cannot be inlined as the designer
  304. will attempt to load libcef.dll and will subsiquently throw an exception.
  305. </summary>
  306. </member>
  307. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.FreeUnmanagedResources">
  308. <summary>
  309. Required for designer support - this method cannot be inlined as the designer
  310. will attempt to load libcef.dll and will subsiquently throw an exception.
  311. </summary>
  312. </member>
  313. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.Load(System.String)">
  314. <summary>
  315. Loads the specified URL.
  316. </summary>
  317. <param name="url">The URL to be loaded.</param>
  318. </member>
  319. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.RegisterJsObject(System.String,System.Object,CefSharp.BindingOptions)">
  320. <summary>
  321. Registers a Javascript object in this specific browser instance.
  322. </summary>
  323. <param name="name">The name of the object. (e.g. "foo", if you want the object to be accessible as window.foo).</param>
  324. <param name="objectToBind">The object to be made accessible to Javascript.</param>
  325. <param name="options">binding options - camelCaseJavascriptNames default to true </param>
  326. <exception cref="T:System.Exception">Browser is already initialized. RegisterJsObject must be +
  327. called before the underlying CEF browser is created.</exception>
  328. </member>
  329. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.RegisterAsyncJsObject(System.String,System.Object,CefSharp.BindingOptions)">
  330. <summary>
  331. <para>Asynchronously registers a Javascript object in this specific browser instance.</para>
  332. <para>Only methods of the object will be availabe.</para>
  333. </summary>
  334. <param name="name">The name of the object. (e.g. "foo", if you want the object to be accessible as window.foo).</param>
  335. <param name="objectToBind">The object to be made accessible to Javascript.</param>
  336. <param name="options">binding options - camelCaseJavascriptNames default to true </param>
  337. <exception cref="T:System.Exception">Browser is already initialized. RegisterJsObject must be +
  338. called before the underlying CEF browser is created.</exception>
  339. <remarks>The registered methods can only be called in an async way, they will all return immeditaly and the resulting
  340. object will be a standard javascript Promise object which is usable to wait for completion or failure.</remarks>
  341. </member>
  342. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.OnHandleCreated(System.EventArgs)">
  343. <summary>
  344. Raises the <see cref="E:System.Windows.Forms.Control.HandleCreated" /> event.
  345. </summary>
  346. <param name="e">An <see cref="T:System.EventArgs" /> that contains the event data.</param>
  347. </member>
  348. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnAfterBrowserCreated(CefSharp.IBrowser)">
  349. <summary>
  350. Called after browser created.
  351. </summary>
  352. <param name="browser">The browser.</param>
  353. </member>
  354. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#SetAddress(CefSharp.AddressChangedEventArgs)">
  355. <summary>
  356. Sets the address.
  357. </summary>
  358. <param name="args">The <see cref="T:CefSharp.AddressChangedEventArgs"/> instance containing the event data.</param>
  359. </member>
  360. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#SetLoadingStateChange(CefSharp.LoadingStateChangedEventArgs)">
  361. <summary>
  362. Sets the loading state change.
  363. </summary>
  364. <param name="args">The <see cref="T:CefSharp.LoadingStateChangedEventArgs"/> instance containing the event data.</param>
  365. </member>
  366. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#SetTitle(CefSharp.TitleChangedEventArgs)">
  367. <summary>
  368. Sets the title.
  369. </summary>
  370. <param name="args">The <see cref="T:CefSharp.TitleChangedEventArgs"/> instance containing the event data.</param>
  371. </member>
  372. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#SetTooltipText(System.String)">
  373. <summary>
  374. Sets the tooltip text.
  375. </summary>
  376. <param name="tooltipText">The tooltip text.</param>
  377. </member>
  378. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnFrameLoadStart(CefSharp.FrameLoadStartEventArgs)">
  379. <summary>
  380. Handles the <see cref="E:FrameLoadStart"/> event.
  381. </summary>
  382. <param name="args">The <see cref="T:CefSharp.FrameLoadStartEventArgs"/> instance containing the event data.</param>
  383. </member>
  384. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnFrameLoadEnd(CefSharp.FrameLoadEndEventArgs)">
  385. <summary>
  386. Handles the <see cref="E:FrameLoadEnd"/> event.
  387. </summary>
  388. <param name="args">The <see cref="T:CefSharp.FrameLoadEndEventArgs"/> instance containing the event data.</param>
  389. </member>
  390. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnConsoleMessage(CefSharp.ConsoleMessageEventArgs)">
  391. <summary>
  392. Handles the <see cref="E:ConsoleMessage"/> event.
  393. </summary>
  394. <param name="args">The <see cref="T:CefSharp.ConsoleMessageEventArgs"/> instance containing the event data.</param>
  395. </member>
  396. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnStatusMessage(CefSharp.StatusMessageEventArgs)">
  397. <summary>
  398. Handles the <see cref="E:StatusMessage"/> event.
  399. </summary>
  400. <param name="args">The <see cref="T:CefSharp.StatusMessageEventArgs"/> instance containing the event data.</param>
  401. </member>
  402. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnLoadError(CefSharp.LoadErrorEventArgs)">
  403. <summary>
  404. Handles the <see cref="E:LoadError"/> event.
  405. </summary>
  406. <param name="args">The <see cref="T:CefSharp.LoadErrorEventArgs"/> instance containing the event data.</param>
  407. </member>
  408. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.OnSizeChanged(System.EventArgs)">
  409. <summary>
  410. Raises the <see cref="E:System.Windows.Forms.Control.SizeChanged" /> event.
  411. </summary>
  412. <param name="e">An <see cref="T:System.EventArgs" /> that contains the event data.</param>
  413. </member>
  414. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.ResizeBrowser">
  415. <summary>
  416. Resizes the browser.
  417. </summary>
  418. </member>
  419. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.OnGotFocus(System.EventArgs)">
  420. <summary>
  421. Raises the <see cref="E:System.Windows.Forms.Control.GotFocus" /> event.
  422. </summary>
  423. <param name="e">An <see cref="T:System.EventArgs" /> that contains the event data.</param>
  424. </member>
  425. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.GetBrowser">
  426. <summary>
  427. Returns the current IBrowser Instance
  428. </summary>
  429. <returns>browser instance or null</returns>
  430. </member>
  431. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.IsInputKey(System.Windows.Forms.Keys)">
  432. <summary>
  433. Makes certain keys as Input keys when CefSettings.MultiThreadedMessageLoop = false
  434. </summary>
  435. <param name="keyData">key data</param>
  436. <returns>true for a select list of keys otherwise defers to base.IsInputKey</returns>
  437. </member>
  438. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.IsActivating">
  439. <summary>
  440. Set to true while handing an activating WM_ACTIVATE message.
  441. MUST ONLY be cleared by DefaultFocusHandler.
  442. </summary>
  443. <value><c>true</c> if this instance is activating; otherwise, <c>false</c>.</value>
  444. </member>
  445. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.BrowserSettings">
  446. <summary>
  447. Gets or sets the browser settings.
  448. </summary>
  449. <value>The browser settings.</value>
  450. </member>
  451. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.RequestContext">
  452. <summary>
  453. Gets or sets the request context.
  454. </summary>
  455. <value>The request context.</value>
  456. </member>
  457. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.IsLoading">
  458. <summary>
  459. A flag that indicates whether the control is currently loading one or more web pages (true) or not (false).
  460. </summary>
  461. <value><c>true</c> if this instance is loading; otherwise, <c>false</c>.</value>
  462. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  463. binding.</remarks>
  464. </member>
  465. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.TooltipText">
  466. <summary>
  467. The text that will be displayed as a ToolTip
  468. </summary>
  469. <value>The tooltip text.</value>
  470. </member>
  471. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.Address">
  472. <summary>
  473. The address (URL) which the browser control is currently displaying.
  474. Will automatically be updated as the user navigates to another page (e.g. by clicking on a link).
  475. </summary>
  476. <value>The address.</value>
  477. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  478. binding.</remarks>
  479. </member>
  480. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.DialogHandler">
  481. <summary>
  482. Implement <see cref="T:CefSharp.IDialogHandler"/> and assign to handle dialog events.
  483. </summary>
  484. <value>The dialog handler.</value>
  485. </member>
  486. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.JsDialogHandler">
  487. <summary>
  488. Implement <see cref="T:CefSharp.IJsDialogHandler"/> and assign to handle events related to JavaScript Dialogs.
  489. </summary>
  490. <value>The js dialog handler.</value>
  491. </member>
  492. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.KeyboardHandler">
  493. <summary>
  494. Implement <see cref="T:CefSharp.IKeyboardHandler"/> and assign to handle events related to key press.
  495. </summary>
  496. <value>The keyboard handler.</value>
  497. </member>
  498. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.RequestHandler">
  499. <summary>
  500. Implement <see cref="T:CefSharp.IRequestHandler"/> and assign to handle events related to browser requests.
  501. </summary>
  502. <value>The request handler.</value>
  503. </member>
  504. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.DownloadHandler">
  505. <summary>
  506. Implement <see cref="T:CefSharp.IDownloadHandler"/> and assign to handle events related to downloading files.
  507. </summary>
  508. <value>The download handler.</value>
  509. </member>
  510. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.LoadHandler">
  511. <summary>
  512. Implement <see cref="T:CefSharp.ILoadHandler"/> and assign to handle events related to browser load status.
  513. </summary>
  514. <value>The load handler.</value>
  515. </member>
  516. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.LifeSpanHandler">
  517. <summary>
  518. Implement <see cref="T:CefSharp.ILifeSpanHandler"/> and assign to handle events related to popups.
  519. </summary>
  520. <value>The life span handler.</value>
  521. </member>
  522. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.DisplayHandler">
  523. <summary>
  524. Implement <see cref="T:CefSharp.IDisplayHandler"/> and assign to handle events related to browser display state.
  525. </summary>
  526. <value>The display handler.</value>
  527. </member>
  528. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.MenuHandler">
  529. <summary>
  530. Implement <see cref="T:CefSharp.IContextMenuHandler"/> and assign to handle events related to the browser context menu
  531. </summary>
  532. <value>The menu handler.</value>
  533. </member>
  534. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.RenderProcessMessageHandler">
  535. <summary>
  536. Implement <see cref="T:CefSharp.IRenderProcessMessageHandler"/> and assign to handle messages from the render process.
  537. </summary>
  538. <value>The render process message handler.</value>
  539. </member>
  540. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.FindHandler">
  541. <summary>
  542. Implement <see cref="T:CefSharp.IFindHandler"/> to handle events related to find results.
  543. </summary>
  544. <value>The find handler.</value>
  545. </member>
  546. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.FocusHandler">
  547. <summary>
  548. The <see cref="T:CefSharp.IFocusHandler"/> for this ChromiumWebBrowser.
  549. </summary>
  550. <value>The focus handler.</value>
  551. <remarks>If you need customized focus handling behavior for WinForms, the suggested
  552. best practice would be to inherit from DefaultFocusHandler and try to avoid
  553. needing to override the logic in OnGotFocus. The implementation in
  554. DefaultFocusHandler relies on very detailed behavior of how WinForms and
  555. Windows interact during window activation.</remarks>
  556. </member>
  557. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.DragHandler">
  558. <summary>
  559. Implement <see cref="T:CefSharp.IDragHandler"/> and assign to handle events related to dragging.
  560. </summary>
  561. <value>The drag handler.</value>
  562. </member>
  563. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.ResourceHandlerFactory">
  564. <summary>
  565. Implement <see cref="T:CefSharp.IResourceHandlerFactory"/> and control the loading of resources
  566. </summary>
  567. <value>The resource handler factory.</value>
  568. </member>
  569. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.GeolocationHandler">
  570. <summary>
  571. Implement <see cref="T:CefSharp.IGeolocationHandler"/> and assign to handle requests for permission to use geolocation.
  572. </summary>
  573. <value>The geolocation handler.</value>
  574. </member>
  575. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.LoadError">
  576. <summary>
  577. Event handler that will get called when the resource load for a navigation fails or is canceled.
  578. 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
  579. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  580. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  581. </summary>
  582. </member>
  583. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.FrameLoadStart">
  584. <summary>
  585. Event handler that will get called when the browser begins loading a frame. Multiple frames may be loading at the same
  586. time. Sub-frames may start or continue loading after the main frame load has ended. This method may not be called for a
  587. particular frame if the load request for that frame fails. For notification of overall browser load status use
  588. OnLoadingStateChange instead.
  589. 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
  590. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  591. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  592. </summary>
  593. <remarks>Whilst this may seem like a logical place to execute js, it's called before the DOM has been loaded, implement
  594. <see cref="M:CefSharp.IRenderProcessMessageHandler.OnContextCreated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)"/> as it's called when the underlying V8Context is created
  595. (Only called for the main frame at this stage)</remarks>
  596. </member>
  597. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.FrameLoadEnd">
  598. <summary>
  599. Event handler that will get called when the browser is done loading a frame. Multiple frames may be loading at the same
  600. time. Sub-frames may start or continue loading after the main frame load has ended. This method will always be called
  601. for all frames irrespective of whether the request completes successfully.
  602. 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
  603. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  604. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  605. </summary>
  606. </member>
  607. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.LoadingStateChanged">
  608. <summary>
  609. Event handler that will get called when the Loading state has changed.
  610. This event will be fired twice. Once when loading is initiated either programmatically or
  611. by user action, and once when loading is terminated due to completion, cancellation of failure.
  612. 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
  613. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  614. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  615. </summary>
  616. </member>
  617. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.ConsoleMessage">
  618. <summary>
  619. Event handler for receiving Javascript console messages being sent from web pages.
  620. 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
  621. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  622. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  623. (The exception to this is when your running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
  624. </summary>
  625. </member>
  626. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.StatusMessage">
  627. <summary>
  628. Event handler for changes to the status message.
  629. 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
  630. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.
  631. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  632. (The exception to this is when your running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
  633. </summary>
  634. </member>
  635. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.AddressChanged">
  636. <summary>
  637. Occurs when the browser address changed.
  638. 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
  639. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  640. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  641. </summary>
  642. </member>
  643. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.TitleChanged">
  644. <summary>
  645. Occurs when the browser title changed.
  646. 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
  647. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  648. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  649. </summary>
  650. </member>
  651. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.IsBrowserInitializedChanged">
  652. <summary>
  653. Occurs when [is browser initialized changed].
  654. 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
  655. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  656. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  657. </summary>
  658. </member>
  659. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CanGoForward">
  660. <summary>
  661. A flag that indicates whether the state of the control currently supports the GoForward action (true) or not (false).
  662. </summary>
  663. <value><c>true</c> if this instance can go forward; otherwise, <c>false</c>.</value>
  664. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  665. binding.</remarks>
  666. </member>
  667. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CanGoBack">
  668. <summary>
  669. A flag that indicates whether the state of the control current supports the GoBack action (true) or not (false).
  670. </summary>
  671. <value><c>true</c> if this instance can go back; otherwise, <c>false</c>.</value>
  672. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  673. binding.</remarks>
  674. </member>
  675. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.IsBrowserInitialized">
  676. <summary>
  677. A flag that indicates whether the WebBrowser is initialized (true) or not (false).
  678. </summary>
  679. <value><c>true</c> if this instance is browser initialized; otherwise, <c>false</c>.</value>
  680. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  681. binding.</remarks>
  682. </member>
  683. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CanExecuteJavascriptInMainFrame">
  684. <summary>
  685. A flag that indicates if you can execute javascript in the main frame.
  686. Flag is set to true in IRenderProcessMessageHandler.OnContextCreated.
  687. and false in IRenderProcessMessageHandler.OnContextReleased
  688. </summary>
  689. </member>
  690. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#BrowserAdapter">
  691. <summary>
  692. Gets the browser adapter.
  693. </summary>
  694. <value>The browser adapter.</value>
  695. </member>
  696. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#HasParent">
  697. <summary>
  698. Gets or sets a value indicating whether this instance has parent.
  699. </summary>
  700. <value><c>true</c> if this instance has parent; otherwise, <c>false</c>.</value>
  701. </member>
  702. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.Focused">
  703. <summary>
  704. Manually implement Focused because cef does not implement it.
  705. </summary>
  706. <value><c>true</c> if focused; otherwise, <c>false</c>.</value>
  707. <remarks>This is also how the Microsoft's WebBrowserControl implements the Focused property.</remarks>
  708. </member>
  709. </members>
  710. </doc>