CefSharp.WinForms.XML 89 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>CefSharp.WinForms</name>
  5. </assembly>
  6. <members>
  7. <member name="T:CefSharp.WinForms.CefSettings">
  8. <summary>
  9. Initialization settings. Many of these and other settings can also configured
  10. using command-line switches.
  11. </summary>
  12. </member>
  13. <member name="T:CefSharp.WinForms.ChromiumWebBrowser">
  14. <summary>
  15. ChromiumWebBrowser is the WinForms web browser control
  16. </summary>
  17. <seealso cref="T:System.Windows.Forms.Control" />
  18. <seealso cref="T:CefSharp.WinForms.IWinFormsWebBrowser" />
  19. </member>
  20. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.managedCefBrowserAdapter">
  21. <summary>
  22. The managed cef browser adapter
  23. </summary>
  24. </member>
  25. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.parentFormMessageInterceptor">
  26. <summary>
  27. The parent form message interceptor
  28. </summary>
  29. </member>
  30. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.designMode">
  31. <summary>
  32. A flag that indicates whether or not the designer is active
  33. NOTE: DesignMode becomes false by the time we get to the destructor/dispose so it gets stored here
  34. </summary>
  35. </member>
  36. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.initialized">
  37. <summary>
  38. A flag that indicates whether or not <see cref="M:CefSharp.WinForms.ChromiumWebBrowser.InitializeFieldsAndCefIfRequired"/> has been called.
  39. </summary>
  40. </member>
  41. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.browserCreated">
  42. <summary>
  43. Has the underlying Cef Browser been created (slightly different to initialized in that
  44. the browser is initialized in an async fashion)
  45. </summary>
  46. </member>
  47. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.initialAddressLoaded">
  48. <summary>
  49. A flag indicating if the <see cref="P:CefSharp.WinForms.ChromiumWebBrowser.Address"/> was used when calling CreateBrowser
  50. If false and <see cref="P:CefSharp.WinForms.ChromiumWebBrowser.Address"/> contains a non empty string Load will be called
  51. on the main frame
  52. </summary>
  53. </member>
  54. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.removeExNoActivateStyle">
  55. <summary>
  56. If true the the WS_EX_NOACTIVATE style will be removed so that future mouse clicks
  57. inside the browser correctly activate and focus the window.
  58. </summary>
  59. </member>
  60. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.browserSettings">
  61. <summary>
  62. Browser initialization settings
  63. </summary>
  64. </member>
  65. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.requestContext">
  66. <summary>
  67. The request context (we deliberately use a private variable so we can throw an exception if
  68. user attempts to set after browser created)
  69. </summary>
  70. </member>
  71. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.parkingControl">
  72. <summary>
  73. Parking control used to temporarily host the CefBrowser instance
  74. when <see cref="!:RecreatingHandle"/> is <c>true</c>.
  75. </summary>
  76. </member>
  77. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.initialFocus">
  78. <summary>
  79. This flag is set when the browser gets focus before the underlying CEF browser
  80. has been initialized.
  81. </summary>
  82. </member>
  83. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.IsDisposed">
  84. <summary>
  85. Gets a value indicating whether this instance is disposed.
  86. </summary>
  87. <value><see langword="true" /> if this instance is disposed; otherwise, <see langword="false" />.</value>
  88. </member>
  89. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.BrowserSettings">
  90. <summary>
  91. Gets or sets the browser settings.
  92. </summary>
  93. <value>The browser settings.</value>
  94. </member>
  95. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.ActivateBrowserOnCreation">
  96. <summary>
  97. Activates browser upon creation, the default value is false. Prior to version 73
  98. the default behaviour was to activate browser on creation (Equivalent of setting this property to true).
  99. To restore this behaviour set this value to true immediately after you create the <see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/> instance.
  100. https://bitbucket.org/chromiumembedded/cef/issues/1856/branch-2526-cef-activates-browser-window
  101. </summary>
  102. </member>
  103. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.RequestContext">
  104. <summary>
  105. Gets or sets the request context.
  106. </summary>
  107. <value>The request context.</value>
  108. </member>
  109. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.IsLoading">
  110. <summary>
  111. A flag that indicates whether the control is currently loading one or more web pages (true) or not (false).
  112. </summary>
  113. <value><c>true</c> if this instance is loading; otherwise, <c>false</c>.</value>
  114. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  115. binding.</remarks>
  116. </member>
  117. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.TooltipText">
  118. <summary>
  119. The text that will be displayed as a ToolTip
  120. </summary>
  121. <value>The tooltip text.</value>
  122. </member>
  123. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.Address">
  124. <summary>
  125. The address (URL) which the browser control is currently displaying.
  126. Will automatically be updated as the user navigates to another page (e.g. by clicking on a link).
  127. </summary>
  128. <value>The address.</value>
  129. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  130. binding.</remarks>
  131. </member>
  132. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.AddressChanged">
  133. <summary>
  134. Occurs when the browser address changed.
  135. 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
  136. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  137. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  138. </summary>
  139. </member>
  140. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.TitleChanged">
  141. <summary>
  142. Occurs when the browser title changed.
  143. 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
  144. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  145. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  146. </summary>
  147. </member>
  148. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CanGoForward">
  149. <summary>
  150. A flag that indicates whether the state of the control currently supports the GoForward action (true) or not (false).
  151. </summary>
  152. <value><c>true</c> if this instance can go forward; otherwise, <c>false</c>.</value>
  153. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  154. binding.</remarks>
  155. </member>
  156. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CanGoBack">
  157. <summary>
  158. A flag that indicates whether the state of the control current supports the GoBack action (true) or not (false).
  159. </summary>
  160. <value><c>true</c> if this instance can go back; otherwise, <c>false</c>.</value>
  161. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  162. binding.</remarks>
  163. </member>
  164. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.IsBrowserInitialized">
  165. <summary>
  166. A flag that indicates whether the WebBrowser is initialized (true) or not (false).
  167. </summary>
  168. <value><c>true</c> if this instance is browser initialized; otherwise, <c>false</c>.</value>
  169. </member>
  170. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.UseParentFormMessageInterceptor">
  171. <summary>
  172. ParentFormMessageInterceptor hooks the Form handle and forwards
  173. the move/active messages to the browser, the default is true
  174. and should only be required when using <see cref="P:CefSharp.CefSettingsBase.MultiThreadedMessageLoop"/>
  175. set to true.
  176. </summary>
  177. </member>
  178. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.ParkControlOnHandleDestroyed">
  179. <summary>
  180. By default when <see cref="M:System.Windows.Forms.Control.OnHandleDestroyed(System.EventArgs)"/> is called
  181. the underlying Browser Hwnd is only parked (moved to a temp parent)
  182. when <see cref="P:System.Windows.Forms.Control.RecreatingHandle"/> is <c>true</c>, there are a few other
  183. cases where parking of the control is desired, you can force parking by setting
  184. this property to <c>true</c>.
  185. </summary>
  186. <remarks>
  187. You may wish to set this property to <c>true</c> when using the browser in conjunction
  188. with https://github.com/dockpanelsuite/dockpanelsuite
  189. </remarks>
  190. </member>
  191. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.#cctor">
  192. <summary>
  193. Initializes static members of the <see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/> class.
  194. </summary>
  195. </member>
  196. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.OnApplicationExit(System.Object,System.EventArgs)">
  197. <summary>
  198. Handles the <see cref="E:ApplicationExit" /> event.
  199. </summary>
  200. <param name="sender">The sender.</param>
  201. <param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
  202. </member>
  203. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.#ctor">
  204. <summary>
  205. This constructor exists as the WinForms designer requires a parameterless constructor, if you are instantiating
  206. an instance of this class in code then use the <see cref="M:CefSharp.WinForms.ChromiumWebBrowser.#ctor(System.String,CefSharp.IRequestContext)"/>
  207. constructor overload instead. Using this constructor in code is unsupported and you may experience <see cref="T:System.NullReferenceException"/>'s
  208. when attempting to access some of the properties immediately after instantiation.
  209. </summary>
  210. </member>
  211. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.#ctor(CefSharp.Web.HtmlString,CefSharp.IRequestContext)">
  212. <summary>
  213. Initializes a new instance of the <see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/> class.
  214. **Important** - When using this constructor the <see cref="P:System.Windows.Forms.Control.Dock"/> property
  215. will default to <see cref="F:System.Windows.Forms.DockStyle.Fill"/>.
  216. </summary>
  217. <param name="html">html string to be initially loaded in the browser.</param>
  218. <param name="requestContext">(Optional) Request context that will be used for this browser instance, if null the Global
  219. Request Context will be used.</param>
  220. </member>
  221. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.#ctor(System.String,CefSharp.IRequestContext)">
  222. <summary>
  223. Initializes a new instance of the <see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/> class.
  224. **Important** - When using this constructor the <see cref="P:System.Windows.Forms.Control.Dock"/> property
  225. will default to <see cref="F:System.Windows.Forms.DockStyle.Fill"/>.
  226. </summary>
  227. <param name="address">The address.</param>
  228. <param name="requestContext">(Optional) Request context that will be used for this browser instance, if null the Global
  229. Request Context will be used.</param>
  230. </member>
  231. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.InitializeFieldsAndCefIfRequired">
  232. <summary>
  233. Required for designer support - this method cannot be inlined as the designer
  234. will attempt to load libcef.dll and will subsequently throw an exception.
  235. TODO: Still not happy with this method name, need something better
  236. </summary>
  237. </member>
  238. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.Dispose(System.Boolean)">
  239. <summary>
  240. If not in design mode; Releases unmanaged and - optionally - managed resources for the <see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/>
  241. </summary>
  242. <param name="disposing"><see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
  243. </member>
  244. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.InternalDispose(System.Boolean)">
  245. <summary>
  246. Releases unmanaged and - optionally - managed resources for the <see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/>
  247. </summary>
  248. <param name="disposing"><see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
  249. <remarks>
  250. This method cannot be inlined as the designer will attempt to load libcef.dll and will subsequently throw an exception.
  251. </remarks>
  252. </member>
  253. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.Load(System.String)">
  254. <inheritdoc/>
  255. </member>
  256. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.JavascriptObjectRepository">
  257. <summary>
  258. The javascript object repository, one repository per ChromiumWebBrowser instance.
  259. </summary>
  260. </member>
  261. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.OnHandleCreated(System.EventArgs)">
  262. <summary>
  263. Raises the <see cref="E:System.Windows.Forms.Control.HandleCreated" /> event.
  264. </summary>
  265. <param name="e">An <see cref="T:System.EventArgs" /> that contains the event data.</param>
  266. </member>
  267. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CreateBrowserWindowInfo(System.IntPtr)">
  268. <summary>
  269. Override this method to handle creation of WindowInfo. This method can be used to customise aspects of
  270. browser creation including configuration of settings such as <see cref="P:CefSharp.IWindowInfo.ExStyle"/>.
  271. Window Activation is disabled by default, you can re-enable it by overriding and removing the
  272. WS_EX_NOACTIVATE style from <see cref="P:CefSharp.IWindowInfo.ExStyle"/>.
  273. </summary>
  274. <param name="handle">Window handle for the Control</param>
  275. <returns>Window Info</returns>
  276. <example>
  277. To re-enable Window Activation then remove WS_EX_NOACTIVATE from ExStyle
  278. <code>
  279. const uint WS_EX_NOACTIVATE = 0x08000000;
  280. windowInfo.ExStyle &amp;= ~WS_EX_NOACTIVATE;
  281. </code>
  282. </example>
  283. </member>
  284. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#SetAddress(CefSharp.AddressChangedEventArgs)">
  285. <summary>
  286. Sets the address.
  287. </summary>
  288. <param name="args">The <see cref="T:CefSharp.AddressChangedEventArgs"/> instance containing the event data.</param>
  289. </member>
  290. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#SetTitle(CefSharp.TitleChangedEventArgs)">
  291. <summary>
  292. Sets the title.
  293. </summary>
  294. <param name="args">The <see cref="T:CefSharp.TitleChangedEventArgs"/> instance containing the event data.</param>
  295. </member>
  296. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#SetTooltipText(System.String)">
  297. <summary>
  298. Sets the tooltip text.
  299. </summary>
  300. <param name="tooltipText">The tooltip text.</param>
  301. </member>
  302. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.Focused">
  303. <summary>
  304. Manually implement Focused because cef does not implement it.
  305. </summary>
  306. <value><c>true</c> if focused; otherwise, <c>false</c>.</value>
  307. <remarks>This is also how the Microsoft's WebBrowserControl implements the Focused property.</remarks>
  308. </member>
  309. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.ResizeBrowser(System.Int32,System.Int32)">
  310. <inheritdoc/>
  311. </member>
  312. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.HideInternal">
  313. <summary>
  314. When minimized set the browser window size to 0x0 to reduce resource usage.
  315. https://github.com/chromiumembedded/cef/blob/c7701b8a6168f105f2c2d6b239ce3958da3e3f13/tests/cefclient/browser/browser_window_std_win.cc#L87
  316. </summary>
  317. </member>
  318. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.ShowInternal">
  319. <summary>
  320. Show the browser (called after previous minimised)
  321. </summary>
  322. </member>
  323. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.OnGotFocus(System.EventArgs)">
  324. <inheritdoc/>
  325. </member>
  326. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.GetBrowser">
  327. <summary>
  328. Returns the current IBrowser Instance
  329. </summary>
  330. <returns>browser instance</returns>
  331. </member>
  332. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.canExecuteJavascriptInMainFrameId">
  333. <summary>
  334. Used as workaround for issue https://github.com/cefsharp/CefSharp/issues/3021
  335. </summary>
  336. </member>
  337. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.browserInitialized">
  338. <summary>
  339. The browser initialized - boolean represented as 0 (false) and 1(true) as we use Interlocker to increment/reset
  340. </summary>
  341. </member>
  342. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.disposeSignaled">
  343. <summary>
  344. The value for disposal, if it's 1 (one) then this instance is either disposed
  345. or in the process of getting disposed
  346. </summary>
  347. </member>
  348. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.browser">
  349. <summary>
  350. The browser
  351. </summary>
  352. </member>
  353. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.initialLoadTaskCompletionSource">
  354. <summary>
  355. Initial browser load task complection source
  356. </summary>
  357. </member>
  358. <member name="F:CefSharp.WinForms.ChromiumWebBrowser.initialLoadAction">
  359. <summary>
  360. Initial browser load action
  361. </summary>
  362. </member>
  363. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.BrowserCore">
  364. <summary>
  365. Get access to the core <see cref="T:CefSharp.IBrowser"/> instance.
  366. Maybe null if the underlying CEF Browser has not yet been
  367. created or if this control has been disposed. Check
  368. <see cref="P:CefSharp.IBrowser.IsDisposed"/> before accessing.
  369. </summary>
  370. </member>
  371. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CanExecuteJavascriptInMainFrame">
  372. <summary>
  373. A flag that indicates if you can execute javascript in the main frame.
  374. Flag is set to true in IRenderProcessMessageHandler.OnContextCreated.
  375. and false in IRenderProcessMessageHandler.OnContextReleased
  376. </summary>
  377. </member>
  378. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.DialogHandler">
  379. <summary>
  380. Implement <see cref="T:CefSharp.IDialogHandler" /> and assign to handle dialog events.
  381. </summary>
  382. <value>The dialog handler.</value>
  383. </member>
  384. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.JsDialogHandler">
  385. <summary>
  386. Implement <see cref="T:CefSharp.IJsDialogHandler" /> and assign to handle events related to JavaScript Dialogs.
  387. </summary>
  388. <value>The js dialog handler.</value>
  389. </member>
  390. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.KeyboardHandler">
  391. <summary>
  392. Implement <see cref="T:CefSharp.IKeyboardHandler" /> and assign to handle events related to key press.
  393. </summary>
  394. <value>The keyboard handler.</value>
  395. </member>
  396. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.RequestHandler">
  397. <summary>
  398. Implement <see cref="T:CefSharp.IRequestHandler" /> and assign to handle events related to browser requests.
  399. </summary>
  400. <value>The request handler.</value>
  401. </member>
  402. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.DownloadHandler">
  403. <summary>
  404. Implement <see cref="T:CefSharp.IDownloadHandler" /> and assign to handle events related to downloading files.
  405. </summary>
  406. <value>The download handler.</value>
  407. </member>
  408. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.LoadHandler">
  409. <summary>
  410. Implement <see cref="T:CefSharp.ILoadHandler" /> and assign to handle events related to browser load status.
  411. </summary>
  412. <value>The load handler.</value>
  413. </member>
  414. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.LifeSpanHandler">
  415. <summary>
  416. Implement <see cref="T:CefSharp.ILifeSpanHandler" /> and assign to handle events related to popups.
  417. </summary>
  418. <value>The life span handler.</value>
  419. </member>
  420. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.DisplayHandler">
  421. <summary>
  422. Implement <see cref="T:CefSharp.IDisplayHandler" /> and assign to handle events related to browser display state.
  423. </summary>
  424. <value>The display handler.</value>
  425. </member>
  426. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.MenuHandler">
  427. <summary>
  428. Implement <see cref="T:CefSharp.IContextMenuHandler" /> and assign to handle events related to the browser context menu
  429. </summary>
  430. <value>The menu handler.</value>
  431. </member>
  432. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.RenderProcessMessageHandler">
  433. <summary>
  434. Implement <see cref="T:CefSharp.IRenderProcessMessageHandler" /> and assign to handle messages from the render process.
  435. </summary>
  436. <value>The render process message handler.</value>
  437. </member>
  438. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.FindHandler">
  439. <summary>
  440. Implement <see cref="T:CefSharp.IFindHandler" /> to handle events related to find results.
  441. </summary>
  442. <value>The find handler.</value>
  443. </member>
  444. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.AudioHandler">
  445. <summary>
  446. Implement <see cref="T:CefSharp.IAudioHandler" /> to handle audio events.
  447. </summary>
  448. </member>
  449. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.FrameHandler">
  450. <summary>
  451. Implement <see cref="T:CefSharp.IFrameHandler" /> to handle frame events.
  452. </summary>
  453. </member>
  454. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.FocusHandler">
  455. <summary>
  456. The <see cref="T:CefSharp.IFocusHandler" /> for this ChromiumWebBrowser.
  457. </summary>
  458. <value>The focus handler.</value>
  459. <remarks>If you need customized focus handling behavior for WinForms, the suggested
  460. best practice would be to inherit from DefaultFocusHandler and try to avoid
  461. needing to override the logic in OnGotFocus. The implementation in
  462. DefaultFocusHandler relies on very detailed behavior of how WinForms and
  463. Windows interact during window activation.</remarks>
  464. </member>
  465. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.DragHandler">
  466. <summary>
  467. Implement <see cref="T:CefSharp.IDragHandler" /> and assign to handle events related to dragging.
  468. </summary>
  469. <value>The drag handler.</value>
  470. </member>
  471. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.ResourceRequestHandlerFactory">
  472. <summary>
  473. Implement <see cref="T:CefSharp.IResourceRequestHandlerFactory" /> and control the loading of resources
  474. </summary>
  475. <value>The resource handler factory.</value>
  476. </member>
  477. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.LoadError">
  478. <summary>
  479. Event handler that will get called when the resource load for a navigation fails or is canceled.
  480. 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
  481. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  482. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  483. </summary>
  484. </member>
  485. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.FrameLoadStart">
  486. <summary>
  487. Event handler that will get called when the browser begins loading a frame. Multiple frames may be loading at the same
  488. time. Sub-frames may start or continue loading after the main frame load has ended. This method may not be called for a
  489. particular frame if the load request for that frame fails. For notification of overall browser load status use
  490. OnLoadingStateChange instead.
  491. 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
  492. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  493. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  494. </summary>
  495. <remarks>Whilst this may seem like a logical place to execute js, it's called before the DOM has been loaded, implement
  496. <see cref="M:CefSharp.IRenderProcessMessageHandler.OnContextCreated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)" /> as it's called when the underlying V8Context is created
  497. </remarks>
  498. </member>
  499. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.FrameLoadEnd">
  500. <summary>
  501. Event handler that will get called when the browser is done loading a frame. Multiple frames may be loading at the same
  502. time. Sub-frames may start or continue loading after the main frame load has ended. This method will always be called
  503. for all frames irrespective of whether the request completes successfully.
  504. 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
  505. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  506. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  507. </summary>
  508. </member>
  509. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.LoadingStateChanged">
  510. <summary>
  511. Event handler that will get called when the Loading state has changed.
  512. This event will be fired twice. Once when loading is initiated either programmatically or
  513. by user action, and once when loading is terminated due to completion, cancellation of failure.
  514. 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
  515. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  516. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  517. </summary>
  518. </member>
  519. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.ConsoleMessage">
  520. <summary>
  521. Event handler for receiving Javascript console messages being sent from web pages.
  522. 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
  523. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  524. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  525. (The exception to this is when you're running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
  526. </summary>
  527. </member>
  528. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.StatusMessage">
  529. <summary>
  530. Event handler for changes to the status message.
  531. 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
  532. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.
  533. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  534. (The exception to this is when you're running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
  535. </summary>
  536. </member>
  537. <member name="E:CefSharp.WinForms.ChromiumWebBrowser.JavascriptMessageReceived">
  538. <summary>
  539. Event handler that will get called when the message that originates from CefSharp.PostMessage
  540. </summary>
  541. </member>
  542. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#IChromiumWebBrowserBase#IsBrowserInitialized">
  543. <summary>
  544. A flag that indicates whether the WebBrowser is initialized (true) or not (false).
  545. </summary>
  546. <value><c>true</c> if this instance is browser initialized; otherwise, <c>false</c>.</value>
  547. </member>
  548. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnFrameLoadStart(CefSharp.FrameLoadStartEventArgs)">
  549. <summary>
  550. Handles the <see cref="E:FrameLoadStart" /> event.
  551. </summary>
  552. <param name="args">The <see cref="T:CefSharp.FrameLoadStartEventArgs"/> instance containing the event data.</param>
  553. </member>
  554. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnFrameLoadEnd(CefSharp.FrameLoadEndEventArgs)">
  555. <summary>
  556. Handles the <see cref="E:FrameLoadEnd" /> event.
  557. </summary>
  558. <param name="args">The <see cref="T:CefSharp.FrameLoadEndEventArgs"/> instance containing the event data.</param>
  559. </member>
  560. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnConsoleMessage(CefSharp.ConsoleMessageEventArgs)">
  561. <summary>
  562. Handles the <see cref="E:ConsoleMessage" /> event.
  563. </summary>
  564. <param name="args">The <see cref="T:CefSharp.ConsoleMessageEventArgs"/> instance containing the event data.</param>
  565. </member>
  566. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnStatusMessage(CefSharp.StatusMessageEventArgs)">
  567. <summary>
  568. Handles the <see cref="E:StatusMessage" /> event.
  569. </summary>
  570. <param name="args">The <see cref="T:CefSharp.StatusMessageEventArgs"/> instance containing the event data.</param>
  571. </member>
  572. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#OnLoadError(CefSharp.LoadErrorEventArgs)">
  573. <summary>
  574. Handles the <see cref="E:LoadError" /> event.
  575. </summary>
  576. <param name="args">The <see cref="T:CefSharp.LoadErrorEventArgs"/> instance containing the event data.</param>
  577. </member>
  578. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#HasParent">
  579. <summary>
  580. Gets or sets a value indicating whether this instance has parent.
  581. </summary>
  582. <value><c>true</c> if this instance has parent; otherwise, <c>false</c>.</value>
  583. </member>
  584. <member name="P:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#BrowserAdapter">
  585. <summary>
  586. Gets the browser adapter.
  587. </summary>
  588. <value>The browser adapter.</value>
  589. </member>
  590. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.CefSharp#Internals#IWebBrowserInternal#SetLoadingStateChange(CefSharp.LoadingStateChangedEventArgs)">
  591. <summary>
  592. Sets the loading state change.
  593. </summary>
  594. <param name="args">The <see cref="T:CefSharp.LoadingStateChangedEventArgs"/> instance containing the event data.</param>
  595. </member>
  596. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.LoadUrl(System.String)">
  597. <inheritdoc/>
  598. </member>
  599. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.LoadUrlAsync(System.String)">
  600. <inheritdoc/>
  601. </member>
  602. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.WaitForInitialLoadAsync">
  603. <inheritdoc/>
  604. </member>
  605. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.OnAfterBrowserCreated(CefSharp.IBrowser)">
  606. <summary>
  607. Called after browser created.
  608. </summary>
  609. <param name="browser">The browser.</param>
  610. </member>
  611. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.SetLoadingStateChange(CefSharp.LoadingStateChangedEventArgs)">
  612. <summary>
  613. Sets the loading state change.
  614. </summary>
  615. <param name="args">The <see cref="T:CefSharp.LoadingStateChangedEventArgs"/> instance containing the event data.</param>
  616. </member>
  617. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.FreeHandlersExceptLifeSpanAndFocus">
  618. <summary>
  619. Sets the handler references to null.
  620. Where required also calls Dispose().
  621. </summary>
  622. </member>
  623. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.InternalIsBrowserInitialized">
  624. <summary>
  625. Check is browser is initialized
  626. </summary>
  627. <returns>true if browser is initialized</returns>
  628. </member>
  629. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.ThrowExceptionIfBrowserNotInitialized">
  630. <summary>
  631. Throw exception if browser not initialized.
  632. </summary>
  633. <exception cref="T:System.Exception">Thrown when an exception error condition occurs.</exception>
  634. </member>
  635. <member name="M:CefSharp.WinForms.ChromiumWebBrowser.ThrowExceptionIfDisposed">
  636. <summary>
  637. Throw exception if disposed.
  638. </summary>
  639. <exception cref="T:System.ObjectDisposedException">Thrown when a supplied object has been disposed.</exception>
  640. </member>
  641. <member name="T:CefSharp.WinForms.ChromiumWebBrowserDesigner">
  642. <summary>
  643. ChromiumWebBrowser Control Designer
  644. </summary>
  645. </member>
  646. <member name="M:CefSharp.WinForms.ChromiumWebBrowserDesigner.OnPaintAdornments(System.Windows.Forms.PaintEventArgs)">
  647. <summary>
  648. 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.
  649. </summary>
  650. <param name="pe">args</param>
  651. </member>
  652. <member name="M:CefSharp.WinForms.ChromiumWebBrowserDesigner.PreFilterProperties(System.Collections.IDictionary)">
  653. <summary>
  654. Adjusts the set of properties the component exposes through a TypeDescriptor.
  655. </summary>
  656. <param name="properties">properties</param>
  657. </member>
  658. <member name="T:CefSharp.WinForms.Experimental.ChromiumRenderWidgetHandleFinder">
  659. <summary>
  660. ChromiumWidgetHandleFinder is a helper class used to find the <see cref="F:CefSharp.WinForms.Experimental.ChromiumRenderWidgetHandleFinder.ChromeRenderWidgetHostClassName"/>
  661. child Hwnd for the browser instance.
  662. </summary>
  663. </member>
  664. <member name="F:CefSharp.WinForms.Experimental.ChromiumRenderWidgetHandleFinder.ChromeRenderWidgetHostClassName">
  665. <summary>
  666. Class Name of the Chrome_RenderWidgetHostHWND Child Window
  667. </summary>
  668. </member>
  669. <member name="T:CefSharp.WinForms.Experimental.ChromiumRenderWidgetHandleFinder.EnumWindowProc">
  670. <summary>
  671. EnumWindowProc delegate used by <see cref="M:CefSharp.WinForms.Experimental.ChromiumRenderWidgetHandleFinder.EnumChildWindows(System.IntPtr,CefSharp.WinForms.Experimental.ChromiumRenderWidgetHandleFinder.EnumWindowProc,System.IntPtr)"/>
  672. </summary>
  673. <param name="hwnd">A handle to a child window of the parent window specified in EnumChildWindows</param>
  674. <param name="lParam">The application-defined value given in EnumChildWindows</param>
  675. <returns>To continue enumeration, the callback function must return true; to stop enumeration, it must return false.</returns>
  676. </member>
  677. <member name="M:CefSharp.WinForms.Experimental.ChromiumRenderWidgetHandleFinder.TryFindHandle(CefSharp.IWebBrowser,System.IntPtr@)">
  678. <summary>
  679. Chromium's message-loop Window isn't created synchronously, so this may not find it.
  680. If so, you need to wait and try again later.
  681. </summary>
  682. <param name="chromiumWebBrowser">ChromiumWebBrowser instance</param>
  683. <param name="chromerRenderWidgetHostHandle">Handle of the child HWND with the name <see cref="F:CefSharp.WinForms.Experimental.ChromiumRenderWidgetHandleFinder.ChromeRenderWidgetHostClassName"/></param>
  684. <returns>returns true if the HWND was found otherwise false.</returns>
  685. </member>
  686. <member name="M:CefSharp.WinForms.Experimental.ChromiumRenderWidgetHandleFinder.TryFindHandle(CefSharp.IBrowser,System.IntPtr@)">
  687. <summary>
  688. Chromium's message-loop Window isn't created synchronously, so this may not find it.
  689. If so, you need to wait and try again later.
  690. </summary>
  691. <param name="browser">IBrowser instance</param>
  692. <param name="chromerRenderWidgetHostHandle">Handle of the child HWND with the name <see cref="F:CefSharp.WinForms.Experimental.ChromiumRenderWidgetHandleFinder.ChromeRenderWidgetHostClassName"/></param>
  693. <returns>returns true if the HWND was found otherwise false.</returns>
  694. </member>
  695. <member name="M:CefSharp.WinForms.Experimental.ChromiumRenderWidgetHandleFinder.TryFindHandle(System.IntPtr,System.String,System.IntPtr@)">
  696. <summary>
  697. Helper function used to find the child HWND with the ClassName matching <paramref name="chromeRenderWidgetHostClassName"/>
  698. Chromium's message-loop Window isn't created synchronously, so this may not find it.
  699. If so, you need to wait and try again later.
  700. In most cases you should use the <see cref="!:TryFindHandle(ChromiumWebBrowser, out IntPtr)"/> overload.
  701. </summary>
  702. <param name="chromiumWebBrowserHandle"><see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/> control Handle</param>
  703. <param name="chromeRenderWidgetHostClassName">class name used to match</param>
  704. <param name="chromerRenderWidgetHostHandle">Handle of the child HWND with the name <see cref="F:CefSharp.WinForms.Experimental.ChromiumRenderWidgetHandleFinder.ChromeRenderWidgetHostClassName"/></param>
  705. <returns>returns true if the HWND was found otherwise false.</returns>
  706. </member>
  707. <member name="T:CefSharp.WinForms.Experimental.ChromiumWidgetNativeWindow">
  708. <summary>
  709. Provides a convenient <see cref="T:System.Windows.Forms.NativeWindow"/> implement
  710. that can be used without having to create your own class
  711. </summary>
  712. </member>
  713. <member name="M:CefSharp.WinForms.Experimental.ChromiumWidgetNativeWindow.#ctor(System.Windows.Forms.Control,System.IntPtr)">
  714. <summary>
  715. ChromiumWidgetMessageInterceptor constructor
  716. </summary>
  717. <param name="control">Control is used to handled the <see cref="E:System.Windows.Forms.Control.HandleDestroyed"/> event so
  718. we can automatically call <see cref="M:System.Windows.Forms.NativeWindow.ReleaseHandle"/>. If null then you are responsible
  719. for calling <see cref="M:System.Windows.Forms.NativeWindow.ReleaseHandle"/></param>
  720. <param name="chromeWidgetHostHandle">Hwnd to intercept messages for.</param>
  721. </member>
  722. <member name="M:CefSharp.WinForms.Experimental.ChromiumWidgetNativeWindow.OnWndProc(System.Func{System.Windows.Forms.Message,System.Boolean})">
  723. <summary>
  724. Register a Func which is used to intercept <see cref="M:CefSharp.WinForms.Experimental.ChromiumWidgetNativeWindow.WndProc(System.Windows.Forms.Message@)"/>
  725. calls. <paramref name="wndProcHandler"/> should return true if the message
  726. was handled, otherwise false.
  727. </summary>
  728. <param name="wndProcHandler">Func to be used to intercept messages, null to clear an existing function.</param>
  729. </member>
  730. <member name="M:CefSharp.WinForms.Experimental.ChromiumWidgetNativeWindow.WndProc(System.Windows.Forms.Message@)">
  731. <inheritdoc/>
  732. </member>
  733. <member name="T:CefSharp.WinForms.Handler.DisplayHandler">
  734. <summary>
  735. A WinForms Specific <see cref="T:CefSharp.IDisplayHandler"/> implementation that simplifies
  736. the process of hosting a Popup as a Control/Tab. Use this implementation as a base
  737. for your own custom implementation if you are using <see cref="M:CefSharp.WinForms.Handler.LifeSpanHandler.Create"/>
  738. </summary>
  739. </member>
  740. <member name="M:CefSharp.WinForms.Handler.DisplayHandler.OnAddressChanged(CefSharp.IWebBrowser,CefSharp.AddressChangedEventArgs)">
  741. <inheritdoc />
  742. </member>
  743. <member name="M:CefSharp.WinForms.Handler.DisplayHandler.OnConsoleMessage(CefSharp.IWebBrowser,CefSharp.ConsoleMessageEventArgs)">
  744. <inheritdoc />
  745. </member>
  746. <member name="M:CefSharp.WinForms.Handler.DisplayHandler.OnTitleChanged(CefSharp.IWebBrowser,CefSharp.TitleChangedEventArgs)">
  747. <inheritdoc />
  748. </member>
  749. <member name="M:CefSharp.WinForms.Handler.DisplayHandler.OnStatusMessage(CefSharp.IWebBrowser,CefSharp.StatusMessageEventArgs)">
  750. <inheritdoc />
  751. </member>
  752. <member name="T:CefSharp.WinForms.Handler.OnPopupCreatedDelegate">
  753. <summary>
  754. Called when the <see cref="T:CefSharp.WinForms.Host.ChromiumHostControl"/> has been created.
  755. When called you must add the control to it's intended parent
  756. so the <see cref="P:System.Windows.Forms.Control.ClientRectangle"/> can be calculated to set the initial
  757. size correctly.
  758. </summary>
  759. <param name="control">popup host control</param>
  760. <param name="url">url</param>
  761. </member>
  762. <member name="T:CefSharp.WinForms.Handler.OnPopupBrowserCreatedDelegate">
  763. <summary>
  764. Called when the <see cref="T:CefSharp.IBrowser"/> instance has been created.
  765. The <see cref="T:CefSharp.IBrowser"/> reference will be valid until <see cref="T:CefSharp.WinForms.Handler.OnPopupDestroyedDelegate"/> is called
  766. </summary>
  767. <param name="control">popup host control, maybe null if Browser is hosted in a native Popup window.
  768. DevTools by default will be hosted in a native popup window.</param>
  769. <param name="browser">browser</param>
  770. </member>
  771. <member name="T:CefSharp.WinForms.Handler.OnPopupDestroyedDelegate">
  772. <summary>
  773. Called when the <see cref="T:CefSharp.WinForms.Host.ChromiumHostControl"/> is to be removed from it's parent.
  774. When called you must remove/dispose of the <see cref="T:CefSharp.WinForms.Host.ChromiumHostControl"/>.
  775. </summary>
  776. <param name="control">popup host control</param>
  777. <param name="browser">browser</param>
  778. </member>
  779. <member name="T:CefSharp.WinForms.Handler.LifeSpanHandler">
  780. <summary>
  781. A WinForms Specific <see cref="T:CefSharp.ILifeSpanHandler"/> implementation that simplifies
  782. the process of hosting a Popup as a Control/Tab.
  783. This <see cref="T:CefSharp.ILifeSpanHandler"/> implementation returns true in <see cref="M:CefSharp.ILifeSpanHandler.DoClose(CefSharp.IWebBrowser,CefSharp.IBrowser)"/>
  784. so no WM_CLOSE message is sent, this differs from the default CEF behaviour.
  785. </summary>
  786. </member>
  787. <member name="M:CefSharp.WinForms.Handler.LifeSpanHandler.DoClose(CefSharp.IWebBrowser,CefSharp.IBrowser)">
  788. <inheritdoc/>
  789. </member>
  790. <member name="M:CefSharp.WinForms.Handler.LifeSpanHandler.OnAfterCreated(CefSharp.IWebBrowser,CefSharp.IBrowser)">
  791. <inheritdoc/>
  792. </member>
  793. <member name="M:CefSharp.WinForms.Handler.LifeSpanHandler.OnBeforeClose(CefSharp.IWebBrowser,CefSharp.IBrowser)">
  794. <inheritdoc/>
  795. </member>
  796. <member name="M:CefSharp.WinForms.Handler.LifeSpanHandler.OnBeforePopup(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame,System.String,System.String,CefSharp.WindowOpenDisposition,System.Boolean,CefSharp.IPopupFeatures,CefSharp.IWindowInfo,CefSharp.IBrowserSettings,System.Boolean@,CefSharp.IWebBrowser@)">
  797. <inheritdoc/>
  798. <remarks>
  799. NOTE: DevTools popups DO NOT trigger OnBeforePopup.
  800. </remarks>
  801. </member>
  802. <member name="M:CefSharp.WinForms.Handler.LifeSpanHandler.OnPopupCreated(CefSharp.WinForms.Handler.OnPopupCreatedDelegate)">
  803. <summary>
  804. The <see cref="T:CefSharp.WinForms.Handler.OnPopupCreatedDelegate"/> will be called when the<see cref="T:CefSharp.WinForms.Host.ChromiumHostControl"/> has been
  805. created. When the <see cref="T:CefSharp.WinForms.Handler.OnPopupCreatedDelegate"/> is called you must add the control to it's intended parent
  806. so the <see cref="P:System.Windows.Forms.Control.ClientRectangle"/> can be calculated to set the initial
  807. size correctly.
  808. </summary>
  809. <param name="onPopupCreated">Action to be invoked when the Popup host has been created and is ready to be attached to it's parent..</param>
  810. <returns><see cref="T:CefSharp.WinForms.Handler.LifeSpanHandler"/> instance allowing you to chain method calls together</returns>
  811. </member>
  812. <member name="M:CefSharp.WinForms.Handler.LifeSpanHandler.OnPopupBrowserCreated(CefSharp.WinForms.Handler.OnPopupBrowserCreatedDelegate)">
  813. <summary>
  814. The <see cref="T:CefSharp.WinForms.Handler.OnPopupBrowserCreatedDelegate"/> will be called when the<see cref="T:CefSharp.IBrowser"/> has been
  815. created. The <see cref="T:CefSharp.IBrowser"/> instance is valid until <see cref="M:CefSharp.WinForms.Handler.LifeSpanHandler.OnPopupDestroyed(CefSharp.WinForms.Handler.OnPopupDestroyedDelegate)"/>
  816. is called. <see cref="T:CefSharp.IBrowser"/> provides low level access to the CEF Browser, you can access frames, view source,
  817. perform navigation (via frame) etc.
  818. </summary>
  819. <param name="onPopupBrowserCreated">Action to be invoked when the <see cref="T:CefSharp.IBrowser"/> has been created.</param>
  820. <returns><see cref="T:CefSharp.WinForms.Handler.LifeSpanHandler"/> instance allowing you to chain method calls together</returns>
  821. </member>
  822. <member name="M:CefSharp.WinForms.Handler.LifeSpanHandler.OnPopupDestroyed(CefSharp.WinForms.Handler.OnPopupDestroyedDelegate)">
  823. <summary>
  824. The <see cref="T:CefSharp.WinForms.Handler.OnPopupDestroyedDelegate"/> will be called when the <see cref="T:CefSharp.WinForms.Host.ChromiumHostControl"/> is to be
  825. removed from it's parent.
  826. When the <see cref="T:CefSharp.WinForms.Handler.OnPopupDestroyedDelegate"/> is called you must remove/dispose of the <see cref="T:CefSharp.WinForms.Host.ChromiumHostControl"/>.
  827. </summary>
  828. <param name="onPopupDestroyed">Action to be invoked when the Popup is to be destroyed.</param>
  829. <returns><see cref="T:CefSharp.WinForms.Handler.LifeSpanHandler"/> instance allowing you to chain method calls together</returns>
  830. </member>
  831. <member name="M:CefSharp.WinForms.Handler.LifeSpanHandler.Create">
  832. <summary>
  833. Create a new instance of the <see cref="T:CefSharp.WinForms.Handler.LifeSpanHandlerBuilder"/>
  834. which can be used to create a WinForms specific <see cref="T:CefSharp.ILifeSpanHandler"/>
  835. implementation that simplifies the process of hosting a Popup as a Control/Tab.
  836. </summary>
  837. <returns>LifeSpanHandlerBuilder</returns>
  838. </member>
  839. <member name="T:CefSharp.WinForms.Handler.LifeSpanHandlerBuilder">
  840. <summary>
  841. Fluent LifeSpanHandler Builder
  842. </summary>
  843. </member>
  844. <member name="M:CefSharp.WinForms.Handler.LifeSpanHandlerBuilder.OnPopupCreated(CefSharp.WinForms.Handler.OnPopupCreatedDelegate)">
  845. <summary>
  846. The <see cref="T:CefSharp.WinForms.Handler.OnPopupCreatedDelegate"/> will be called when the<see cref="!:ChromiumHostControl"/> has been
  847. created. When the <see cref="T:CefSharp.WinForms.Handler.OnPopupCreatedDelegate"/> is called you must add the control to it's intended parent
  848. so the <see cref="!:Control.ClientRectangle"/> can be calculated to set the initial
  849. size correctly.
  850. </summary>
  851. <param name="onPopupCreated">Action to be invoked when the Popup is to be destroyed.</param>
  852. <returns><see cref="T:CefSharp.WinForms.Handler.LifeSpanHandler"/> instance allowing you to chain method calls together</returns>
  853. </member>
  854. <member name="M:CefSharp.WinForms.Handler.LifeSpanHandlerBuilder.OnPopupBrowserCreated(CefSharp.WinForms.Handler.OnPopupBrowserCreatedDelegate)">
  855. <summary>
  856. The <see cref="T:CefSharp.WinForms.Handler.OnPopupBrowserCreatedDelegate"/> will be called when the<see cref="T:CefSharp.IBrowser"/> has been
  857. created. The <see cref="T:CefSharp.IBrowser"/> instance is valid until <see cref="M:CefSharp.WinForms.Handler.LifeSpanHandlerBuilder.OnPopupDestroyed(CefSharp.WinForms.Handler.OnPopupDestroyedDelegate)"/>
  858. is called. <see cref="T:CefSharp.IBrowser"/> provides low level access to the CEF Browser, you can access frames, view source,
  859. perform navigation (via frame) etc.
  860. </summary>
  861. <param name="onPopupBrowserCreated">Action to be invoked when the <see cref="T:CefSharp.IBrowser"/> has been created.</param>
  862. <returns><see cref="T:CefSharp.WinForms.Handler.LifeSpanHandler"/> instance allowing you to chain method calls together</returns>
  863. </member>
  864. <member name="M:CefSharp.WinForms.Handler.LifeSpanHandlerBuilder.OnPopupDestroyed(CefSharp.WinForms.Handler.OnPopupDestroyedDelegate)">
  865. <summary>
  866. The <see cref="T:CefSharp.WinForms.Handler.OnPopupDestroyedDelegate"/> will be called when the <see cref="!:ChromiumHostControl"/> is to be
  867. removed from it's parent.
  868. When the <see cref="T:CefSharp.WinForms.Handler.OnPopupDestroyedDelegate"/> is called you must remove/dispose of the <see cref="!:ChromiumHostControl"/>.
  869. </summary>
  870. <param name="onPopupDestroyed">Action to be invoked when the Popup is to be destroyed.</param>
  871. <returns><see cref="T:CefSharp.WinForms.Handler.LifeSpanHandler"/> instance allowing you to chain method calls together</returns>
  872. </member>
  873. <member name="M:CefSharp.WinForms.Handler.LifeSpanHandlerBuilder.Build">
  874. <summary>
  875. Creates an <see cref="T:CefSharp.ILifeSpanHandler"/> implementation
  876. that can be used to host popups as tabs/controls. The resulting
  877. <see cref="T:CefSharp.ILifeSpanHandler"/> returns true in <see cref="M:CefSharp.ILifeSpanHandler.DoClose(CefSharp.IWebBrowser,CefSharp.IBrowser)"/>
  878. so no WM_CLOSE message is sent, this differs from the default CEF behaviour.
  879. </summary>
  880. <returns>a <see cref="T:CefSharp.IDownloadHandler"/> instance</returns>
  881. </member>
  882. <member name="T:CefSharp.WinForms.Handler.LoadHandler">
  883. <summary>
  884. A WinForms Specific <see cref="T:CefSharp.ILoadHandler"/> implementation that simplifies
  885. the process of hosting a Popup as a Control/Tab.Use this implementation as a base
  886. for your own custom implementation if you are using <see cref="M:CefSharp.WinForms.Handler.LifeSpanHandler.Create"/>
  887. </summary>
  888. </member>
  889. <member name="M:CefSharp.WinForms.Handler.LoadHandler.OnFrameLoadEnd(CefSharp.IWebBrowser,CefSharp.FrameLoadEndEventArgs)">
  890. <inheritdoc />
  891. </member>
  892. <member name="M:CefSharp.WinForms.Handler.LoadHandler.OnFrameLoadStart(CefSharp.IWebBrowser,CefSharp.FrameLoadStartEventArgs)">
  893. <inheritdoc />
  894. </member>
  895. <member name="M:CefSharp.WinForms.Handler.LoadHandler.OnLoadError(CefSharp.IWebBrowser,CefSharp.LoadErrorEventArgs)">
  896. <inheritdoc />
  897. </member>
  898. <member name="M:CefSharp.WinForms.Handler.LoadHandler.OnLoadingStateChange(CefSharp.IWebBrowser,CefSharp.LoadingStateChangedEventArgs)">
  899. <inheritdoc />
  900. </member>
  901. <member name="T:CefSharp.WinForms.Host.ChromiumHostControl">
  902. <summary>
  903. Chromium Browser Host Control, used for hosting Popups in WinForms
  904. </summary>
  905. <seealso cref="T:System.Windows.Forms.Control" />
  906. </member>
  907. <member name="P:CefSharp.WinForms.Host.ChromiumHostControl.BrowserCore">
  908. <summary>
  909. Get access to the core <see cref="T:CefSharp.IBrowser"/> instance.
  910. Maybe null if the underlying CEF Browser has not yet been
  911. created or if this control has been disposed. Check
  912. <see cref="P:CefSharp.IBrowser.IsDisposed"/> before accessing.
  913. </summary>
  914. </member>
  915. <member name="E:CefSharp.WinForms.Host.ChromiumHostControl.LoadError">
  916. <summary>
  917. Event handler that will get called when the resource load for a navigation fails or is canceled.
  918. 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
  919. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  920. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  921. </summary>
  922. </member>
  923. <member name="E:CefSharp.WinForms.Host.ChromiumHostControl.FrameLoadStart">
  924. <summary>
  925. Event handler that will get called when the browser begins loading a frame. Multiple frames may be loading at the same
  926. time. Sub-frames may start or continue loading after the main frame load has ended. This method may not be called for a
  927. particular frame if the load request for that frame fails. For notification of overall browser load status use
  928. OnLoadingStateChange instead.
  929. 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
  930. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  931. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  932. </summary>
  933. <remarks>Whilst this may seem like a logical place to execute js, it's called before the DOM has been loaded, implement
  934. <see cref="M:CefSharp.IRenderProcessMessageHandler.OnContextCreated(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.IFrame)" /> as it's called when the underlying V8Context is created
  935. </remarks>
  936. </member>
  937. <member name="E:CefSharp.WinForms.Host.ChromiumHostControl.FrameLoadEnd">
  938. <summary>
  939. Event handler that will get called when the browser is done loading a frame. Multiple frames may be loading at the same
  940. time. Sub-frames may start or continue loading after the main frame load has ended. This method will always be called
  941. for all frames irrespective of whether the request completes successfully.
  942. 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
  943. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  944. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  945. </summary>
  946. </member>
  947. <member name="E:CefSharp.WinForms.Host.ChromiumHostControl.LoadingStateChanged">
  948. <summary>
  949. Event handler that will get called when the Loading state has changed.
  950. This event will be fired twice. Once when loading is initiated either programmatically or
  951. by user action, and once when loading is terminated due to completion, cancellation of failure.
  952. 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
  953. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  954. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  955. </summary>
  956. </member>
  957. <member name="E:CefSharp.WinForms.Host.ChromiumHostControl.ConsoleMessage">
  958. <summary>
  959. Event handler for receiving Javascript console messages being sent from web pages.
  960. 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
  961. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  962. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  963. (The exception to this is when you're running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
  964. </summary>
  965. </member>
  966. <member name="E:CefSharp.WinForms.Host.ChromiumHostControl.StatusMessage">
  967. <summary>
  968. Event handler for changes to the status message.
  969. 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
  970. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang.
  971. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  972. (The exception to this is when you're running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
  973. </summary>
  974. </member>
  975. <member name="E:CefSharp.WinForms.Host.ChromiumHostControl.AddressChanged">
  976. <summary>
  977. Occurs when the browser address changed.
  978. 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
  979. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  980. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  981. </summary>
  982. </member>
  983. <member name="E:CefSharp.WinForms.Host.ChromiumHostControl.TitleChanged">
  984. <summary>
  985. Occurs when the browser title changed.
  986. 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
  987. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  988. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  989. </summary>
  990. </member>
  991. <member name="P:CefSharp.WinForms.Host.ChromiumHostControl.IsLoading">
  992. <summary>
  993. A flag that indicates whether the control is currently loading one or more web pages (true) or not (false).
  994. </summary>
  995. <value><c>true</c> if this instance is loading; otherwise, <c>false</c>.</value>
  996. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  997. binding.</remarks>
  998. </member>
  999. <member name="P:CefSharp.WinForms.Host.ChromiumHostControl.Address">
  1000. <summary>
  1001. The address (URL) which the browser control is currently displaying.
  1002. Will automatically be updated as the user navigates to another page (e.g. by clicking on a link).
  1003. </summary>
  1004. <value>The address.</value>
  1005. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  1006. binding.</remarks>
  1007. </member>
  1008. <member name="P:CefSharp.WinForms.Host.ChromiumHostControl.CanGoForward">
  1009. <summary>
  1010. A flag that indicates whether the state of the control currently supports the GoForward action (true) or not (false).
  1011. </summary>
  1012. <value><c>true</c> if this instance can go forward; otherwise, <c>false</c>.</value>
  1013. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  1014. binding.</remarks>
  1015. </member>
  1016. <member name="P:CefSharp.WinForms.Host.ChromiumHostControl.CanGoBack">
  1017. <summary>
  1018. A flag that indicates whether the state of the control current supports the GoBack action (true) or not (false).
  1019. </summary>
  1020. <value><c>true</c> if this instance can go back; otherwise, <c>false</c>.</value>
  1021. <remarks>In the WPF control, this property is implemented as a Dependency Property and fully supports data
  1022. binding.</remarks>
  1023. </member>
  1024. <member name="P:CefSharp.WinForms.Host.ChromiumHostControl.IsBrowserInitialized">
  1025. <summary>
  1026. A flag that indicates whether the WebBrowser is initialized (true) or not (false).
  1027. </summary>
  1028. <value><c>true</c> if this instance is browser initialized; otherwise, <c>false</c>.</value>
  1029. </member>
  1030. <member name="M:CefSharp.WinForms.Host.ChromiumHostControl.OnFrameLoadStart(CefSharp.FrameLoadStartEventArgs)">
  1031. <summary>
  1032. Handles the <see cref="E:FrameLoadStart" /> event.
  1033. </summary>
  1034. <param name="args">The <see cref="T:CefSharp.FrameLoadStartEventArgs"/> instance containing the event data.</param>
  1035. </member>
  1036. <member name="M:CefSharp.WinForms.Host.ChromiumHostControl.OnFrameLoadEnd(CefSharp.FrameLoadEndEventArgs)">
  1037. <summary>
  1038. Handles the <see cref="E:FrameLoadEnd" /> event.
  1039. </summary>
  1040. <param name="args">The <see cref="T:CefSharp.FrameLoadEndEventArgs"/> instance containing the event data.</param>
  1041. </member>
  1042. <member name="M:CefSharp.WinForms.Host.ChromiumHostControl.OnConsoleMessage(CefSharp.ConsoleMessageEventArgs)">
  1043. <summary>
  1044. Handles the <see cref="E:ConsoleMessage" /> event.
  1045. </summary>
  1046. <param name="args">The <see cref="T:CefSharp.ConsoleMessageEventArgs"/> instance containing the event data.</param>
  1047. </member>
  1048. <member name="M:CefSharp.WinForms.Host.ChromiumHostControl.OnStatusMessage(CefSharp.StatusMessageEventArgs)">
  1049. <summary>
  1050. Handles the <see cref="E:StatusMessage" /> event.
  1051. </summary>
  1052. <param name="args">The <see cref="T:CefSharp.StatusMessageEventArgs"/> instance containing the event data.</param>
  1053. </member>
  1054. <member name="M:CefSharp.WinForms.Host.ChromiumHostControl.OnLoadError(CefSharp.LoadErrorEventArgs)">
  1055. <summary>
  1056. Handles the <see cref="E:LoadError" /> event.
  1057. </summary>
  1058. <param name="args">The <see cref="T:CefSharp.LoadErrorEventArgs"/> instance containing the event data.</param>
  1059. </member>
  1060. <member name="M:CefSharp.WinForms.Host.ChromiumHostControl.OnLoadingStateChange(CefSharp.LoadingStateChangedEventArgs)">
  1061. <summary>
  1062. Sets the loading state change.
  1063. </summary>
  1064. <param name="args">The <see cref="T:CefSharp.LoadingStateChangedEventArgs"/> instance containing the event data.</param>
  1065. </member>
  1066. <member name="M:CefSharp.WinForms.Host.ChromiumHostControl.OnTitleChanged(CefSharp.TitleChangedEventArgs)">
  1067. <summary>
  1068. Sets the title.
  1069. </summary>
  1070. <param name="args">The <see cref="T:CefSharp.TitleChangedEventArgs"/> instance containing the event data.</param>
  1071. </member>
  1072. <member name="M:CefSharp.WinForms.Host.ChromiumHostControl.OnAddressChanged(CefSharp.AddressChangedEventArgs)">
  1073. <summary>
  1074. Sets the address.
  1075. </summary>
  1076. <param name="args">The <see cref="T:CefSharp.AddressChangedEventArgs"/> instance containing the event data.</param>
  1077. </member>
  1078. <member name="M:CefSharp.WinForms.Host.ChromiumHostControl.LoadUrl(System.String)">
  1079. <summary>
  1080. Loads the specified <paramref name="url"/> in the Main Frame.
  1081. </summary>
  1082. <param name="url">The URL to be loaded.</param>
  1083. </member>
  1084. <member name="M:CefSharp.WinForms.Host.ChromiumHostControl.GetMainFrame">
  1085. <summary>
  1086. Returns the main (top-level) frame for the browser window.
  1087. </summary>
  1088. <returns> the main frame</returns>
  1089. </member>
  1090. <member name="M:CefSharp.WinForms.Host.ChromiumHostControl.FromBrowser(CefSharp.IBrowser)">
  1091. <summary>
  1092. Gets the <see cref="T:CefSharp.WinForms.Host.ChromiumHostControl"/> associated with
  1093. a specific <see cref="T:CefSharp.IBrowser"/> instance.
  1094. </summary>
  1095. <param name="browser">browser</param>
  1096. <returns>returns the assocaited <see cref="T:CefSharp.WinForms.Host.ChromiumHostControl"/> or null if Disposed or no host found.</returns>
  1097. </member>
  1098. <member name="T:CefSharp.WinForms.Host.ChromiumHostControlBase">
  1099. <summary>
  1100. Chromium Browser Host Control, provides base functionality for hosting a
  1101. CefBrowser instance (main browser and popups) in WinForms.
  1102. </summary>
  1103. <seealso cref="T:System.Windows.Forms.Control" />
  1104. </member>
  1105. <member name="P:CefSharp.WinForms.Host.ChromiumHostControlBase.BrowserHwnd">
  1106. <summary>
  1107. IntPtr that represents the CefBrowser Hwnd
  1108. Used for sending messages to the browser
  1109. e.g. resize
  1110. </summary>
  1111. </member>
  1112. <member name="P:CefSharp.WinForms.Host.ChromiumHostControlBase.IsActivating">
  1113. <summary>
  1114. Set to true while handing an activating WM_ACTIVATE message.
  1115. MUST ONLY be cleared by DefaultFocusHandler.
  1116. </summary>
  1117. <value><c>true</c> if this instance is activating; otherwise, <c>false</c>.</value>
  1118. </member>
  1119. <member name="E:CefSharp.WinForms.Host.ChromiumHostControlBase.IsBrowserInitializedChanged">
  1120. <summary>
  1121. Event called after the underlying CEF browser instance has been created.
  1122. 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
  1123. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  1124. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  1125. </summary>
  1126. </member>
  1127. <member name="P:CefSharp.WinForms.Host.ChromiumHostControlBase.DefaultSize">
  1128. <summary>
  1129. Gets the default size of the control.
  1130. </summary>
  1131. <value>
  1132. The default <see cref="T:System.Drawing.Size" /> of the control.
  1133. </value>
  1134. </member>
  1135. <member name="M:CefSharp.WinForms.Host.ChromiumHostControlBase.IsInputKey(System.Windows.Forms.Keys)">
  1136. <summary>
  1137. Makes certain keys as Input keys when CefSettings.MultiThreadedMessageLoop = false
  1138. </summary>
  1139. <param name="keyData">key data</param>
  1140. <returns>true for a select list of keys otherwise defers to base.IsInputKey</returns>
  1141. </member>
  1142. <member name="M:CefSharp.WinForms.Host.ChromiumHostControlBase.OnSizeChanged(System.EventArgs)">
  1143. <summary>
  1144. Raises the <see cref="E:System.Windows.Forms.Control.SizeChanged" /> event.
  1145. </summary>
  1146. <param name="e">An <see cref="T:System.EventArgs" /> that contains the event data.</param>
  1147. </member>
  1148. <member name="M:CefSharp.WinForms.Host.ChromiumHostControlBase.OnVisibleChanged(System.EventArgs)">
  1149. <inheritdoc />
  1150. </member>
  1151. <member name="M:CefSharp.WinForms.Host.ChromiumHostControlBase.ResizeBrowser(System.Int32,System.Int32)">
  1152. <summary>
  1153. Resizes the browser to the specified <paramref name="width"/> and <paramref name="height"/>.
  1154. If <paramref name="width"/> and <paramref name="height"/> are both 0 then the browser
  1155. will be hidden and resource usage will be minimised.
  1156. </summary>
  1157. <param name="width">width</param>
  1158. <param name="height">height</param>
  1159. </member>
  1160. <member name="M:CefSharp.WinForms.Host.ChromiumHostControlBase.ResizeBrowserInternal(System.Int32,System.Int32)">
  1161. <summary>
  1162. Resizes the browser.
  1163. </summary>
  1164. <param name="width">width</param>
  1165. <param name="height">height</param>
  1166. <remarks>
  1167. To avoid the Designer trying to load CefSharp.Core.Runtime we explicitly
  1168. ask for NoInlining.
  1169. </remarks>
  1170. </member>
  1171. <member name="M:CefSharp.WinForms.Host.ChromiumHostControlBase.HideInternal">
  1172. <summary>
  1173. When minimized set the browser window size to 0x0 to reduce resource usage.
  1174. https://github.com/chromiumembedded/cef/blob/c7701b8a6168f105f2c2d6b239ce3958da3e3f13/tests/cefclient/browser/browser_window_std_win.cc#L87
  1175. </summary>
  1176. </member>
  1177. <member name="M:CefSharp.WinForms.Host.ChromiumHostControlBase.ShowInternal">
  1178. <summary>
  1179. Show the browser (called after previous minimised)
  1180. </summary>
  1181. </member>
  1182. <member name="M:CefSharp.WinForms.Host.ChromiumHostControlBase.Dispose(System.Boolean)">
  1183. <inheritdoc/>
  1184. </member>
  1185. <member name="M:CefSharp.WinForms.Host.ChromiumHostControlBase.RaiseIsBrowserInitializedChangedEvent">
  1186. <summary>
  1187. Trigger the <see cref="E:CefSharp.WinForms.Host.ChromiumHostControlBase.IsBrowserInitializedChanged"/> event
  1188. </summary>
  1189. </member>
  1190. <member name="T:CefSharp.WinForms.Internals.ControlExtensions">
  1191. <summary>
  1192. ControlExtensions.
  1193. </summary>
  1194. </member>
  1195. <member name="M:CefSharp.WinForms.Internals.ControlExtensions.InvokeOnUiThreadIfRequired(System.Windows.Forms.Control,System.Action)">
  1196. <summary>
  1197. Executes the Action asynchronously on the UI thread, does not block execution on the calling thread.
  1198. No action will be performed if the control doesn't have a valid handle or the control is Disposed/Disposing.
  1199. </summary>
  1200. <param name="control">the control for which the update is required</param>
  1201. <param name="action">action to be performed on the control</param>
  1202. </member>
  1203. <member name="M:CefSharp.WinForms.Internals.ControlExtensions.InvokeSyncOnUiThreadIfRequired(System.Windows.Forms.Control,System.Action)">
  1204. <summary>
  1205. Executes the Action sync on the UI thread, blocks execution on the calling thread.
  1206. No action will be performed if the control doesn't have a valid handle or the control is Disposed/Disposing.
  1207. </summary>
  1208. <param name="control">the control for which the update is required</param>
  1209. <param name="action">action to be performed on the control</param>
  1210. </member>
  1211. <member name="M:CefSharp.WinForms.Internals.ControlExtensions.Activate(System.Windows.Forms.Control)">
  1212. <summary>
  1213. Activates the specified control.
  1214. </summary>
  1215. <param name="control">The control.</param>
  1216. <returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
  1217. </member>
  1218. <member name="M:CefSharp.WinForms.Internals.ControlExtensions.IsActiveControl(System.Windows.Forms.Control)">
  1219. <summary>
  1220. Returns whether the supplied control is the currently
  1221. active control.
  1222. </summary>
  1223. <param name="control">the control to check</param>
  1224. <returns>true if the control is the currently active control</returns>
  1225. </member>
  1226. <member name="M:CefSharp.WinForms.Internals.ControlExtensions.SelectNextControl(System.Windows.Forms.Control,System.Boolean)">
  1227. <summary>
  1228. Selects the next control.
  1229. </summary>
  1230. <param name="control">The control.</param>
  1231. <param name="next">if set to <c>true</c> [next].</param>
  1232. </member>
  1233. <member name="T:CefSharp.WinForms.Internals.DefaultFocusHandler">
  1234. <summary>
  1235. Default implementation of <see cref="T:CefSharp.IFocusHandler" />
  1236. for the WinForms implementation
  1237. </summary>
  1238. <seealso cref="T:CefSharp.IFocusHandler" />
  1239. </member>
  1240. <member name="M:CefSharp.WinForms.Internals.DefaultFocusHandler.OnGotFocus(CefSharp.IWebBrowser,CefSharp.IBrowser)">
  1241. <summary>
  1242. Called when the browser component has received focus.
  1243. </summary>
  1244. <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
  1245. <param name="browser">the browser object</param>
  1246. <remarks>Try to avoid needing to override this logic in a subclass. The implementation in
  1247. DefaultFocusHandler relies on very detailed behavior of how WinForms and
  1248. Windows interact during window activation.</remarks>
  1249. </member>
  1250. <member name="M:CefSharp.WinForms.Internals.DefaultFocusHandler.OnSetFocus(CefSharp.IWebBrowser,CefSharp.IBrowser,CefSharp.CefFocusSource)">
  1251. <summary>
  1252. Called when the browser component is requesting focus.
  1253. </summary>
  1254. <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
  1255. <param name="browser">the browser object</param>
  1256. <param name="source">Indicates where the focus request is originating from.</param>
  1257. <returns>Return false to allow the focus to be set or true to cancel setting the focus.</returns>
  1258. </member>
  1259. <member name="M:CefSharp.WinForms.Internals.DefaultFocusHandler.OnTakeFocus(CefSharp.IWebBrowser,CefSharp.IBrowser,System.Boolean)">
  1260. <summary>
  1261. Called when the browser component is about to lose focus.
  1262. For instance, if focus was on the last HTML element and the user pressed the TAB key.
  1263. </summary>
  1264. <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
  1265. <param name="browser">the browser object</param>
  1266. <param name="next">Will be true if the browser is giving focus to the next component
  1267. and false if the browser is giving focus to the previous component.</param>
  1268. </member>
  1269. <member name="T:CefSharp.WinForms.Internals.NativeMethods">
  1270. <summary>
  1271. Class NativeMethods.
  1272. </summary>
  1273. </member>
  1274. <member name="F:CefSharp.WinForms.Internals.NativeMethods.WM_MOVE">
  1275. <summary>
  1276. The w m_ move
  1277. </summary>
  1278. </member>
  1279. <member name="F:CefSharp.WinForms.Internals.NativeMethods.WM_MOVING">
  1280. <summary>
  1281. The w m_ moving
  1282. </summary>
  1283. </member>
  1284. <member name="F:CefSharp.WinForms.Internals.NativeMethods.WM_ACTIVATE">
  1285. <summary>
  1286. The w m_ activate
  1287. </summary>
  1288. </member>
  1289. <member name="T:CefSharp.WinForms.Internals.ParentFormMessageInterceptor">
  1290. <summary>
  1291. ParentFormMessageInterceptor - hooks into the parent forms
  1292. message loop to incercept messages like WM_MOVE
  1293. </summary>
  1294. <seealso cref="T:System.Windows.Forms.NativeWindow" />
  1295. <seealso cref="T:System.IDisposable" />
  1296. </member>
  1297. <member name="F:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.isMoving">
  1298. <summary>
  1299. Keep track of whether a move is in progress.
  1300. </summary>
  1301. </member>
  1302. <member name="F:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.movingRectangle">
  1303. <summary>
  1304. Used to determine the coordinates involved in the move
  1305. </summary>
  1306. </member>
  1307. <member name="F:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.previousWindowState">
  1308. <summary>
  1309. Store the previous window state, used to determine if the
  1310. Windows was previously <see cref="F:System.Windows.Forms.FormWindowState.Minimized"/>
  1311. and resume rendering
  1312. </summary>
  1313. </member>
  1314. <member name="P:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.Browser">
  1315. <summary>
  1316. Gets or sets the browser.
  1317. </summary>
  1318. <value>The browser.</value>
  1319. </member>
  1320. <member name="P:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.ParentForm">
  1321. <summary>
  1322. Gets or sets the parent form.
  1323. </summary>
  1324. <value>The parent form.</value>
  1325. </member>
  1326. <member name="E:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.Moving">
  1327. <summary>
  1328. Called when the parent form is moving
  1329. </summary>
  1330. </member>
  1331. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.#ctor(CefSharp.WinForms.Host.ChromiumHostControlBase)">
  1332. <summary>
  1333. Initializes a new instance of the <see cref="T:CefSharp.WinForms.Internals.ParentFormMessageInterceptor"/> class.
  1334. </summary>
  1335. <param name="browser">The browser.</param>
  1336. </member>
  1337. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.RefindParentForm">
  1338. <summary>
  1339. Call to force refinding of the parent Form.
  1340. (i.e. top level window that owns the ChromiumWebBrowserControl)
  1341. </summary>
  1342. </member>
  1343. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.ParentParentChanged(System.Object,System.EventArgs)">
  1344. <summary>
  1345. Adjust the form to listen to if the ChromiumWebBrowserControl's parent changes.
  1346. </summary>
  1347. <param name="sender">The ChromiumWebBrowser whose parent has changed.</param>
  1348. <param name="e">The <see cref="T:System.EventArgs" /> instance containing the event data.</param>
  1349. </member>
  1350. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.OnHandleCreated(System.Object,System.EventArgs)">
  1351. <summary>
  1352. Handles the <see cref="E:HandleCreated" /> event.
  1353. </summary>
  1354. <param name="sender">The sender.</param>
  1355. <param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
  1356. </member>
  1357. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.OnHandleDestroyed(System.Object,System.EventArgs)">
  1358. <summary>
  1359. Handles the <see cref="E:HandleDestroyed" /> event.
  1360. </summary>
  1361. <param name="sender">The sender.</param>
  1362. <param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
  1363. </member>
  1364. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.WndProc(System.Windows.Forms.Message@)">
  1365. <summary>
  1366. Invokes the default window procedure associated with this window.
  1367. </summary>
  1368. <param name="m">A <see cref="T:System.Windows.Forms.Message" /> that is associated with the current Windows message.</param>
  1369. </member>
  1370. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.OnMoving">
  1371. <summary>
  1372. Called when [moving].
  1373. </summary>
  1374. </member>
  1375. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.Dispose">
  1376. <summary>
  1377. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
  1378. </summary>
  1379. </member>
  1380. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.Dispose(System.Boolean)">
  1381. <summary>
  1382. Releases unmanaged and - optionally - managed resources.
  1383. </summary>
  1384. <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
  1385. </member>
  1386. <member name="M:CefSharp.WinForms.Internals.ParentFormMessageInterceptor.OnThreadException(System.Exception)">
  1387. <summary>
  1388. When overridden in a derived class, manages an unhandled thread exception.
  1389. </summary>
  1390. <param name="e">An <see cref="T:System.Exception" /> that specifies the unhandled thread exception.</param>
  1391. </member>
  1392. <member name="T:CefSharp.WinForms.IWinFormsWebBrowser">
  1393. <summary>
  1394. WinForms specific implementation, has events the
  1395. <see cref="T:CefSharp.WinForms.ChromiumWebBrowser" /> implementation exposes.
  1396. </summary>
  1397. <seealso cref="T:CefSharp.IWebBrowser" />
  1398. </member>
  1399. <member name="E:CefSharp.WinForms.IWinFormsWebBrowser.TitleChanged">
  1400. <summary>
  1401. Occurs when the browser title changed.
  1402. 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
  1403. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  1404. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  1405. </summary>
  1406. </member>
  1407. <member name="E:CefSharp.WinForms.IWinFormsWebBrowser.AddressChanged">
  1408. <summary>
  1409. Occurs when the browser address changed.
  1410. 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
  1411. thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
  1412. To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
  1413. </summary>
  1414. </member>
  1415. <member name="T:CefSharp.WinForms.WebBrowserExtensions">
  1416. <summary>
  1417. Helper extensions for performing common CefSharp related WinForms tasks
  1418. </summary>
  1419. </member>
  1420. <member name="M:CefSharp.WinForms.WebBrowserExtensions.DestroyWindow(CefSharp.IWebBrowser)">
  1421. <summary>
  1422. Manually call https://docs.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-destroywindow
  1423. passing in the handle returned from <see cref="M:CefSharp.IBrowserHost.GetWindowHandle"/>.
  1424. This method can be used to manually close the underlying CefBrowser instance.
  1425. This will avoid the WM_Close message that CEF sends by default to the top level window.
  1426. (Which closes your application). This method should generally only be used in the WinForms version.
  1427. </summary>
  1428. <param name="chromiumWebBrowser">the ChromiumWebBrowser instance</param>
  1429. <returns>If the function succeeds, the return value is true.</returns>
  1430. <example>
  1431. <code>
  1432. //Invoke on the CEF UI Thread
  1433. Cef.UIThreadTaskFactory.StartNew(() =>
  1434. {
  1435. var closed = chromiumWebBrowser.DestroyWindow();
  1436. });
  1437. </code>
  1438. </example>
  1439. </member>
  1440. <member name="M:CefSharp.WinForms.WebBrowserExtensions.ShowDevToolsDocked(CefSharp.IChromiumWebBrowserBase,System.Windows.Forms.Control,System.String,System.Windows.Forms.DockStyle,System.Int32,System.Int32)">
  1441. <summary>
  1442. Open DevTools using <paramref name="parentControl"/> as the parent control. If inspectElementAtX and/or inspectElementAtY are specified then
  1443. the element at the specified (x,y) location will be inspected.
  1444. For resize/moving to work correctly you will need to use the <see cref="T:CefSharp.WinForms.Handler.LifeSpanHandler"/> implementation.
  1445. (Set <see cref="P:CefSharp.WinForms.ChromiumWebBrowser.LifeSpanHandler"/> to an instance of <see cref="T:CefSharp.WinForms.Handler.LifeSpanHandler"/>)
  1446. </summary>
  1447. <param name="chromiumWebBrowser"><see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/> instance</param>
  1448. <param name="parentControl">Control used as the parent for DevTools (a custom control will be added to the <see cref="P:System.Windows.Forms.Control.Controls"/> collection)</param>
  1449. <param name="inspectElementAtX">x coordinate (used for inspectElement)</param>
  1450. <param name="inspectElementAtY">y coordinate (used for inspectElement)</param>
  1451. <returns>Returns the <see cref="T:System.Windows.Forms.Control"/> that hosts the DevTools instance if successful, otherwise returns null on error.</returns>
  1452. </member>
  1453. <member name="M:CefSharp.WinForms.WebBrowserExtensions.ShowDevToolsDocked(CefSharp.IChromiumWebBrowserBase,System.Action{CefSharp.WinForms.Host.ChromiumHostControl},System.String,System.Windows.Forms.DockStyle,System.Int32,System.Int32)">
  1454. <summary>
  1455. Open DevTools using your own Control as the parent. If inspectElementAtX and/or inspectElementAtY are specified then
  1456. the element at the specified (x,y) location will be inspected.
  1457. For resize/moving to work correctly you will need to use the <see cref="T:CefSharp.WinForms.Handler.LifeSpanHandler"/> implementation.
  1458. (Set <see cref="P:CefSharp.WinForms.ChromiumWebBrowser.LifeSpanHandler"/> to an instance of <see cref="T:CefSharp.WinForms.Handler.LifeSpanHandler"/>)
  1459. </summary>
  1460. <param name="chromiumWebBrowser"><see cref="T:CefSharp.WinForms.ChromiumWebBrowser"/> instance</param>
  1461. <param name="addParentControl">
  1462. Action that is Invoked when the DevTools Host Control has been created and needs to be added to it's parent.
  1463. It's important the control is added to it's intended parent at this point so the <see cref="P:System.Windows.Forms.Control.ClientRectangle"/>
  1464. can be calculated to set the initial display size.</param>
  1465. <param name="inspectElementAtX">x coordinate (used for inspectElement)</param>
  1466. <param name="inspectElementAtY">y coordinate (used for inspectElement)</param>
  1467. <returns>Returns the <see cref="T:System.Windows.Forms.Control"/> that hosts the DevTools instance if successful, otherwise returns null on error.</returns>
  1468. </member>
  1469. </members>
  1470. </doc>