DevComponents.DotNetBar.Keyboard.XML 63 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>DevComponents.DotNetBar.Keyboard</name>
  5. </assembly>
  6. <members>
  7. <member name="T:DevComponents.DotNetBar.Keyboard.Key">
  8. <summary>
  9. Holds information about a single virtual keyboard Key.
  10. </summary>
  11. </member>
  12. <member name="M:DevComponents.DotNetBar.Keyboard.Key.#ctor(System.String,System.String,System.String,DevComponents.DotNetBar.Keyboard.KeyStyle,System.Int32,System.Int32)">
  13. <summary>
  14. Creates a new Key object.
  15. </summary>
  16. <param name="caption">The text displayed on the key.</param>
  17. <param name="info">The information that will be sent to the attached control.</param>
  18. <param name="hint">The text in the upper part of the key, that provides a hint for the user about what the key does.</param>
  19. <param name="style">The way the key looks.</param>
  20. <param name="changeToLayout">The index of the layout to switch to.</param>
  21. </member>
  22. <member name="M:DevComponents.DotNetBar.Keyboard.Key.ToString">
  23. <summary>
  24. Returns a string that represents the current Key.
  25. </summary>
  26. <returns>A string that represents the current Key.</returns>
  27. </member>
  28. <member name="P:DevComponents.DotNetBar.Keyboard.Key.Caption">
  29. <summary>
  30. Gets the caption on the key.
  31. </summary>
  32. </member>
  33. <member name="P:DevComponents.DotNetBar.Keyboard.Key.Info">
  34. <summary>
  35. Gets the actual key-information that is sent to the attached control. The format of this information
  36. must confirm to the description for the SendKeys.Send function. For more details, see:
  37. http://msdn.microsoft.com/en-us/library/system.windows.forms.sendkeys.aspx
  38. </summary>
  39. </member>
  40. <member name="P:DevComponents.DotNetBar.Keyboard.Key.Bounds">
  41. <summary>
  42. Gets the bounds of the key.
  43. </summary>
  44. </member>
  45. <member name="P:DevComponents.DotNetBar.Keyboard.Key.Style">
  46. <summary>
  47. Gets a value representing the way the key looks on the virtual keyboard. A key might look normal,
  48. lighter, darker or with a pressed effect.
  49. </summary>
  50. </member>
  51. <member name="P:DevComponents.DotNetBar.Keyboard.Key.ChangeToLayout">
  52. <summary>
  53. Gets the index of the layout to change to, if this key is pressed. A positive value represents a new layout.
  54. KeyboardLayout.NoChange and KeyboardLayout.PreviousLayout constants can also be used with special meaning.
  55. </summary>
  56. <remarks>
  57. If this is a positive integer ( >= 0 ), it represents the index of the layout to switch to when this key
  58. is pressed. In this case, the keyboard does not send any key information to the attached control (the Info
  59. field is ignored), only changes the layout.
  60. If this is KeyboardLayout.NoChange the keyboard will send the info to the attached control.
  61. If this is KeyboardLayout.PreviousLayout the keyboard will switch to the previous set layout. The keyboard
  62. maintains internally a stack of all used layouts. If no more layouts in the stakc, the keyboard switches to
  63. the layout with index 0.
  64. </remarks>
  65. </member>
  66. <member name="P:DevComponents.DotNetBar.Keyboard.Key.ChangeToLayoutEx">
  67. <summary>
  68. Gets the index of the layout to change to, when this key is double clicked. A positive value represents a new layout.
  69. KeyboardLayout.NoChange and KeyboardLayout.PreviousLayout constants can also be used with special meaning.
  70. </summary>
  71. <remarks>
  72. If this is a positive integer ( >= 0 ), it represents the index of the layout to switch to when this key
  73. is pressed. In this case, the keyboard does not send any key information to the attached control (the Info
  74. field is ignored), only changes the layout.
  75. If this is KeyboardLayout.NoChange the keyboard will send the info to the attached control.
  76. If this is KeyboardLayout.PreviousLayout the keyboard will switch to the previous set layout. The keyboard
  77. maintains internally a stack of all used layouts. If no more layouts in the stakc, the keyboard switches to
  78. the layout with index 0.
  79. </remarks>
  80. </member>
  81. <member name="P:DevComponents.DotNetBar.Keyboard.Key.Hint">
  82. <summary>
  83. Gets the text that will be displayed in the upper part of the keyboard, as a hint for what the key does,
  84. usually in combination with a modifier key (e.g. Underline, Undo, etc).
  85. </summary>
  86. </member>
  87. <member name="T:DevComponents.DotNetBar.Keyboard.KeyStyle">
  88. <summary>
  89. Specifies the way a key looks, specifically what color it uses from the ColorTable.
  90. </summary>
  91. </member>
  92. <member name="F:DevComponents.DotNetBar.Keyboard.KeyStyle.Normal">
  93. <summary>
  94. Key should be drawn as a normal key colors.
  95. </summary>
  96. </member>
  97. <member name="F:DevComponents.DotNetBar.Keyboard.KeyStyle.Light">
  98. <summary>
  99. Key should be drawn with lighter colors.
  100. </summary>
  101. </member>
  102. <member name="F:DevComponents.DotNetBar.Keyboard.KeyStyle.Dark">
  103. <summary>
  104. Key should be drawn with darker colors.
  105. </summary>
  106. </member>
  107. <member name="F:DevComponents.DotNetBar.Keyboard.KeyStyle.Pressed">
  108. <summary>
  109. Key should be drawn with the pressed color.
  110. </summary>
  111. </member>
  112. <member name="F:DevComponents.DotNetBar.Keyboard.KeyStyle.Toggled">
  113. <summary>
  114. Key should be drawn with the toggled color.
  115. </summary>
  116. </member>
  117. <member name="T:DevComponents.DotNetBar.Keyboard.KeyboardLayout">
  118. <summary>
  119. Represents a layout for a virtual keyboard.
  120. </summary>
  121. The Keys have coordinates in the KeyboardLayout specified in logical layout units. By default for this version
  122. of the control, a normal key is 10 logical units (LUs) width and 10 LUs height. A space between two keys is 1 LU.
  123. When rendering, we assume the whole Layout is stretched over the Keyboard control, so we need to change from
  124. LUs (ranging from 0 to layout.LogicalWidth) to pixels (ranging from 0 to control.Width).
  125. This allows the layout to be resized to almost any sizes.
  126. </member>
  127. <member name="F:DevComponents.DotNetBar.Keyboard.KeyboardLayout.PreviousLayout">
  128. <summary>
  129. Indicates that a key should switch the Keyboard to the previous layout.
  130. </summary>
  131. </member>
  132. <member name="F:DevComponents.DotNetBar.Keyboard.KeyboardLayout.NoChange">
  133. <summary>
  134. Indicates that a key does not switch to any layout.
  135. </summary>
  136. </member>
  137. <member name="M:DevComponents.DotNetBar.Keyboard.KeyboardLayout.KeyHitTest(System.Int32,System.Int32)">
  138. <summary>
  139. Tests if a certain point hits a key on the virtual keyboard.
  140. </summary>
  141. <param name="x">The x-coordinate of the hit point (in logical units of this KeyboardLayout)</param>
  142. <param name="y">The y-coordinate of the hit point (in logical units of this KeyboardLayout)</param>
  143. <returns>Returns the key that was hit, or null if the point didn't hit any keys.</returns>
  144. </member>
  145. <member name="P:DevComponents.DotNetBar.Keyboard.KeyboardLayout.Keys">
  146. <summary>
  147. Gets the collection of the Keys in this KeyboardLayout.
  148. </summary>
  149. </member>
  150. <member name="P:DevComponents.DotNetBar.Keyboard.KeyboardLayout.LogicalWidth">
  151. <summary>
  152. Gets the logical width of this KeyboardLayout.
  153. </summary>
  154. </member>
  155. <member name="P:DevComponents.DotNetBar.Keyboard.KeyboardLayout.LogicalHeight">
  156. <summary>
  157. Gets the logical height of this KeyboardLayout.
  158. </summary>
  159. </member>
  160. <member name="T:DevComponents.DotNetBar.Keyboard.LinearKeyboardLayout">
  161. <summary>
  162. Represents a layout for a virtual keyboard in which keys are defined in a linear way. This class
  163. allows creation of layouts in which keys can be ordered from left to right and from top to bottom.
  164. </summary>
  165. <remarks>
  166. With the linear layout, the keys are allowed to have any width. The height, however, must be the same.
  167. This layout is build by adding to it spaces, keys and new lines.
  168. A key represents a virtual key AND a space after it.
  169. A space represents a placeholder between two keys and it is used when there is need for a larger space
  170. between two certain keys
  171. A new line represents the fact that a new line of keys should be defined.
  172. </remarks>
  173. <example>
  174. The default virtual keyboard of the VirtualKeyboard control is defined in the following way:
  175. <code>
  176. AddKey("q");
  177. AddKey("w");
  178. AddKey("e");
  179. // ...
  180. AddKey("p");
  181. AddKey("Backspace");
  182. AddLine(); // Starts a new row of keys.
  183. AddSpace(4); // Creates a larger space at the beginning of the second row.
  184. AddKey("a");
  185. AddKey("s");
  186. // ...
  187. </code>
  188. </example>
  189. </member>
  190. <member name="F:DevComponents.DotNetBar.Keyboard.LinearKeyboardLayout.SpaceSize">
  191. <summary>
  192. The logical size of the space between two keys.
  193. </summary>
  194. </member>
  195. <member name="F:DevComponents.DotNetBar.Keyboard.LinearKeyboardLayout.NormalKeySize">
  196. <summary>
  197. The logical size of a key.
  198. </summary>
  199. </member>
  200. <member name="M:DevComponents.DotNetBar.Keyboard.LinearKeyboardLayout.AddSpace(System.Int32)">
  201. <summary>
  202. Adds a space to this LinearKeyboardLayout.
  203. </summary>
  204. <param name="width">The size of the space, in logical units.</param>
  205. </member>
  206. <member name="M:DevComponents.DotNetBar.Keyboard.LinearKeyboardLayout.AddLine">
  207. <summary>
  208. Starts a new row of keys in this LinearKeyboardLayout.
  209. </summary>
  210. </member>
  211. <member name="M:DevComponents.DotNetBar.Keyboard.LinearKeyboardLayout.AddKey(System.String,System.String,System.String,System.Int32,System.Int32,DevComponents.DotNetBar.Keyboard.KeyStyle,System.Int32,System.Int32)">
  212. <summary>
  213. Adds a new key to this LinearKeayboardLayout.
  214. </summary>
  215. <param name="caption">The text displayed on the key.</param>
  216. <param name="info">The information that will be sent to the attached control.</param>
  217. <param name="hint">The text in the upper part of the key, that provides a hint for the user about what the key does.</param>
  218. <param name="width">The width of the key, in logical units.</param>
  219. <param name="height">The height of the key, in logical units.</param>
  220. <param name="style">The way the key looks.</param>
  221. <param name="changeToLayout">The index of the layout to switch to.</param>
  222. <param name="changeToLayoutEx">The index of the layout to switch to, when key is double clicked.</param>
  223. </member>
  224. <member name="T:DevComponents.DotNetBar.Keyboard.Keyboard">
  225. <summary>
  226. Represents a Virtual Keyboard.
  227. </summary>
  228. Each Keyboard has a collection of KeyboardLayout objects. The Keyboard also maintains the current Layout among all its layouts.
  229. </member>
  230. <member name="M:DevComponents.DotNetBar.Keyboard.Keyboard.ChangeToPreviousLayout">
  231. <summary>
  232. Switches the Keyboard to the previous layout.
  233. </summary>
  234. </member>
  235. <member name="M:DevComponents.DotNetBar.Keyboard.Keyboard.ResetLayoutStack">
  236. <summary>
  237. Switches the Keyboard to the first layout and resets the layout stack.
  238. </summary>
  239. </member>
  240. <member name="M:DevComponents.DotNetBar.Keyboard.Keyboard.CreateDefaultKeyboard">
  241. <summary>
  242. Creates the default Keyboard populated with common layouts and functionality.
  243. </summary>
  244. <returns>A new Keyboard instance representing a default keyboard.</returns>
  245. </member>
  246. <member name="P:DevComponents.DotNetBar.Keyboard.Keyboard.Layouts">
  247. <summary>
  248. Gets the collection of the keyboard layouts in this Keyboard.
  249. </summary>
  250. </member>
  251. <member name="P:DevComponents.DotNetBar.Keyboard.Keyboard.CurrentLayoutIndex">
  252. <summary>
  253. Gets or sets the current layout index of this Keyboard.
  254. </summary>
  255. </member>
  256. <member name="P:DevComponents.DotNetBar.Keyboard.Keyboard.CurrentLayout">
  257. <summary>
  258. Gets the current layout of this Keyboard.
  259. </summary>
  260. </member>
  261. <member name="T:DevComponents.DotNetBar.Keyboard.KeysCollection">
  262. <summary>
  263. Contains a collection of Key objects.
  264. </summary>
  265. </member>
  266. <member name="T:DevComponents.DotNetBar.Keyboard.KeyboardLayoutsCollection">
  267. <summary>
  268. Contains a collection of KeyboardLayout objects.
  269. </summary>
  270. </member>
  271. <member name="M:DevComponents.DotNetBar.Keyboard.PopupVirtualKeyboard.#ctor">
  272. <summary>
  273. Creates a new floating virtual keyboard.
  274. </summary>
  275. </member>
  276. <member name="T:DevComponents.DotNetBar.Keyboard.Renderer">
  277. <summary>
  278. Represents a renderer for a VirtualKeyboard.
  279. </summary>
  280. </member>
  281. <member name="M:DevComponents.DotNetBar.Keyboard.Renderer.DrawTopBar(DevComponents.DotNetBar.Keyboard.TopBarRendererEventArgs)">
  282. <summary>
  283. Draws the top bar of the VirtualKeyboard.
  284. </summary>
  285. <param name="args"></param>
  286. </member>
  287. <member name="M:DevComponents.DotNetBar.Keyboard.Renderer.DrawBackground(DevComponents.DotNetBar.Keyboard.BackgroundRendererEventArgs)">
  288. <summary>
  289. Draws the background of the VirtualKeyboard.
  290. </summary>
  291. <param name="args">Provides context information.</param>
  292. </member>
  293. <member name="M:DevComponents.DotNetBar.Keyboard.Renderer.DrawKey(DevComponents.DotNetBar.Keyboard.KeyRendererEventArgs)">
  294. <summary>
  295. Draws a key of the VirtualKeyboard.
  296. </summary>
  297. <param name="args">Provides context information.</param>
  298. </member>
  299. <member name="M:DevComponents.DotNetBar.Keyboard.Renderer.BeginFrame(DevComponents.DotNetBar.Keyboard.BeginFrameRendererEventArgs)">
  300. <summary>
  301. Called when the control starts rendering a new frame.
  302. </summary>
  303. <param name="args">Provides context information.</param>
  304. </member>
  305. <member name="M:DevComponents.DotNetBar.Keyboard.Renderer.EndFrame">
  306. <summary>
  307. Called after the control finished rendering the frame.
  308. </summary>
  309. </member>
  310. <member name="P:DevComponents.DotNetBar.Keyboard.Renderer.ColorTable">
  311. <summary>
  312. Gets or sets the ColorTable used by this renderer to render the virtual keyboard.
  313. </summary>
  314. </member>
  315. <member name="T:DevComponents.DotNetBar.Keyboard.FlatStyleRenderer">
  316. <summary>
  317. Represents a VirtualKeyboard renderer with a flat style.
  318. </summary>
  319. </member>
  320. <member name="M:DevComponents.DotNetBar.Keyboard.FlatStyleRenderer.BeginFrame(DevComponents.DotNetBar.Keyboard.BeginFrameRendererEventArgs)">
  321. <summary>
  322. Starts rendering a new frame with the black style. This gives the renderer a chance to cash some resources.
  323. </summary>
  324. </member>
  325. <member name="M:DevComponents.DotNetBar.Keyboard.FlatStyleRenderer.EndFrame">
  326. <summary>
  327. Ends rendering a new frame with the black style. This gives the renderer a chance to free resources used during the frame.
  328. </summary>
  329. </member>
  330. <member name="M:DevComponents.DotNetBar.Keyboard.FlatStyleRenderer.#ctor">
  331. <summary>
  332. Creates a new renderer for the black style.
  333. </summary>
  334. </member>
  335. <member name="M:DevComponents.DotNetBar.Keyboard.FlatStyleRenderer.DrawBackground(DevComponents.DotNetBar.Keyboard.BackgroundRendererEventArgs)">
  336. <summary>
  337. Draws the background of a VirtualKeyboard.
  338. </summary>
  339. <param name="args">Provides context information.</param>
  340. </member>
  341. <member name="M:DevComponents.DotNetBar.Keyboard.FlatStyleRenderer.DrawKey(DevComponents.DotNetBar.Keyboard.KeyRendererEventArgs)">
  342. <summary>
  343. Draws the key of a VirtualKeyboard.
  344. </summary>
  345. <param name="args">Provides context information.</param>
  346. </member>
  347. <member name="P:DevComponents.DotNetBar.Keyboard.FlatStyleRenderer.ForceAntiAlias">
  348. <summary>
  349. Gets or sets whether anti-alias smoothing is used while painting. Default value is true.
  350. </summary>
  351. </member>
  352. <member name="T:DevComponents.DotNetBar.Keyboard.KeyRendererEventArgs">
  353. <summary>
  354. Provides data for Key rendering.
  355. </summary>
  356. </member>
  357. <member name="M:DevComponents.DotNetBar.Keyboard.KeyRendererEventArgs.#ctor(System.Drawing.Graphics,DevComponents.DotNetBar.Keyboard.Key,System.Boolean,System.Drawing.Rectangle,System.Drawing.Rectangle)">
  358. <summary>
  359. Creates a new instance and initializes it with provided values.
  360. </summary>
  361. <param name="graphics">The Graphics object to be used for rendering.</param>
  362. <param name="key">The Key instance being rendered.</param>
  363. <param name="isDown">Indicates if the key is currently hold down.</param>
  364. <param name="clipRectangle">The rectangle in which to paint.</param>
  365. </member>
  366. <member name="P:DevComponents.DotNetBar.Keyboard.KeyRendererEventArgs.Key">
  367. <summary>
  368. Gets a reference to the Key instance being rendered.
  369. </summary>
  370. </member>
  371. <member name="P:DevComponents.DotNetBar.Keyboard.KeyRendererEventArgs.Graphics">
  372. <summary>
  373. Gets a reference to the Graphics object to be used for rendering.
  374. </summary>
  375. </member>
  376. <member name="P:DevComponents.DotNetBar.Keyboard.KeyRendererEventArgs.IsDown">
  377. <summary>
  378. Gets a value indicating if this key is currently down.
  379. </summary>
  380. </member>
  381. <member name="P:DevComponents.DotNetBar.Keyboard.KeyRendererEventArgs.ClipRectangle">
  382. <summary>
  383. Gets the rectangle in which to paint.
  384. </summary>
  385. </member>
  386. <member name="T:DevComponents.DotNetBar.Keyboard.BackgroundRendererEventArgs">
  387. <summary>
  388. Provides data for rendering the background of a VirtualKeyboard.
  389. </summary>
  390. </member>
  391. <member name="M:DevComponents.DotNetBar.Keyboard.BackgroundRendererEventArgs.#ctor(System.Drawing.Graphics,System.Drawing.Rectangle,System.Drawing.Rectangle)">
  392. <summary>
  393. Creates a new instance and initializes it with provided values.
  394. </summary>
  395. <param name="graphics">The Graphics object to be used for rendering.</param>
  396. <param name="size">The area where the background should be drawn.</param>
  397. </member>
  398. <member name="P:DevComponents.DotNetBar.Keyboard.BackgroundRendererEventArgs.Graphics">
  399. <summary>
  400. Gets a reference to the Graphics object to be used for rendering.
  401. </summary>
  402. </member>
  403. <member name="P:DevComponents.DotNetBar.Keyboard.BackgroundRendererEventArgs.ClipRectangle">
  404. <summary>
  405. Gets the rectangle in which to paint.
  406. </summary>
  407. </member>
  408. <member name="M:DevComponents.DotNetBar.Keyboard.BeginFrameRendererEventArgs.#ctor(System.Drawing.Graphics,System.Drawing.Rectangle,System.Drawing.Rectangle,System.Drawing.Font,DevComponents.DotNetBar.Keyboard.KeyboardLayout)">
  409. <summary>
  410. Creates a new instance and initializes it with provided values.
  411. </summary>
  412. <param name="size">The size of the background area.</param>
  413. <param name="font">The font of the control.</param>
  414. <param name="layout">The current KeyboardLayout that will be rendered in this frame.</param>
  415. </member>
  416. <member name="P:DevComponents.DotNetBar.Keyboard.BeginFrameRendererEventArgs.Graphics">
  417. <summary>
  418. Gets a reference to the Graphics object to be used for rendering.
  419. </summary>
  420. </member>
  421. <member name="P:DevComponents.DotNetBar.Keyboard.BeginFrameRendererEventArgs.ClipRectangle">
  422. <summary>
  423. Gets the rectangle in which to paint.
  424. </summary>
  425. </member>
  426. <member name="P:DevComponents.DotNetBar.Keyboard.BeginFrameRendererEventArgs.Bounds">
  427. <summary>
  428. Gets the size of the background area in which to render the keyboard.
  429. </summary>
  430. </member>
  431. <member name="P:DevComponents.DotNetBar.Keyboard.BeginFrameRendererEventArgs.Font">
  432. <summary>
  433. Gets the font on the control.
  434. </summary>
  435. </member>
  436. <member name="P:DevComponents.DotNetBar.Keyboard.BeginFrameRendererEventArgs.Layout">
  437. <summary>
  438. Gets the current KeyboardLayout which will be rendered in this frame.
  439. </summary>
  440. </member>
  441. <member name="P:DevComponents.DotNetBar.Keyboard.TopBarRendererEventArgs.Graphics">
  442. <summary>
  443. Gets a reference to the Graphics object to be used for rendering.
  444. </summary>
  445. </member>
  446. <member name="P:DevComponents.DotNetBar.Keyboard.TopBarRendererEventArgs.ClipRectangle">
  447. <summary>
  448. Gets the rectangle in which to paint.
  449. </summary>
  450. </member>
  451. <member name="P:DevComponents.DotNetBar.Keyboard.TopBarRendererEventArgs.Font">
  452. <summary>
  453. Gets the font on the control.
  454. </summary>
  455. </member>
  456. <member name="P:DevComponents.DotNetBar.Keyboard.CloseButtonRendererEventArgs.Graphics">
  457. <summary>
  458. Gets a reference to the Key instance being rendered.
  459. </summary>
  460. </member>
  461. <member name="P:DevComponents.DotNetBar.Keyboard.CloseButtonRendererEventArgs.ClipRectangle">
  462. <summary>
  463. Gets the area where background should be drawn.
  464. </summary>
  465. </member>
  466. <member name="P:DevComponents.DotNetBar.Keyboard.CloseButtonRendererEventArgs.IsDown">
  467. <summary>
  468. Gets a value indicating if this key is currently down.
  469. </summary>
  470. </member>
  471. <member name="M:DevComponents.DotNetBar.Keyboard.TouchKeyboard.OnSendingKey(DevComponents.DotNetBar.Keyboard.KeyboardKeyCancelEventArgs)">
  472. <summary>
  473. Raises SendingKey event.
  474. </summary>
  475. <param name="e">Provides event arguments.</param>
  476. </member>
  477. <member name="M:DevComponents.DotNetBar.Keyboard.TouchKeyboard.OnKeySent(DevComponents.DotNetBar.Keyboard.KeyboardKeyEventArgs)">
  478. <summary>
  479. Raises KeySent event.
  480. </summary>
  481. <param name="e">Provides event arguments.</param>
  482. </member>
  483. <member name="M:DevComponents.DotNetBar.Keyboard.TouchKeyboard.AttachTo(System.Windows.Forms.Control)">
  484. <summary>
  485. Attaches the Keyboard to the specified control. The keyboard will automatically appear when the control receives input focus.
  486. </summary>
  487. <param name="control">The control to which the Keyboard will be attached.</param>
  488. </member>
  489. <member name="M:DevComponents.DotNetBar.Keyboard.TouchKeyboard.DetachFrom(System.Windows.Forms.Control)">
  490. <summary>
  491. Detaches the Keyboard from the specified control.
  492. </summary>
  493. <param name="control">The control from which the Keyboard will be detached.</param>
  494. </member>
  495. <member name="M:DevComponents.DotNetBar.Keyboard.TouchKeyboard.OnKeyboardOpening(DevComponents.DotNetBar.Keyboard.CancelKeyboardEventArgs)">
  496. <summary>
  497. Raises KeyboardOpening event.
  498. </summary>
  499. <param name="e">Provides event arguments.</param>
  500. </member>
  501. <member name="M:DevComponents.DotNetBar.Keyboard.TouchKeyboard.OnKeyboardOpened(System.EventArgs)">
  502. <summary>
  503. Raises KeyboardOpened event.
  504. </summary>
  505. <param name="e">Provides event arguments.</param>
  506. </member>
  507. <member name="M:DevComponents.DotNetBar.Keyboard.TouchKeyboard.OnKeyboardClosing(System.ComponentModel.CancelEventArgs)">
  508. <summary>
  509. Raises KeyboardClosing event.
  510. </summary>
  511. <param name="e">Provides event arguments.</param>
  512. </member>
  513. <member name="M:DevComponents.DotNetBar.Keyboard.TouchKeyboard.OnKeyboardClosed(System.EventArgs)">
  514. <summary>
  515. Raises KeyboardClosed event.
  516. </summary>
  517. <param name="e">Provides event arguments.</param>
  518. </member>
  519. <member name="M:DevComponents.DotNetBar.Keyboard.TouchKeyboard.HideKeyboard">
  520. <summary>
  521. Hides the keyboard.
  522. </summary>
  523. </member>
  524. <member name="M:DevComponents.DotNetBar.Keyboard.TouchKeyboard.Dispose(System.Boolean)">
  525. <summary>
  526. Clean up any resources being used.
  527. </summary>
  528. <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
  529. </member>
  530. <member name="M:DevComponents.DotNetBar.Keyboard.TouchKeyboard.GetShowTouchKeyboard(System.Windows.Forms.Control)">
  531. <summary>
  532. Retursn the way the keyboard will be shown when controls receive focus.
  533. </summary>
  534. <param name="extendee">The control for which to retrieve the value.</param>
  535. <returns>A TouchKeyboardStyle value defining the way the keyboard appears.</returns>
  536. </member>
  537. <member name="M:DevComponents.DotNetBar.Keyboard.TouchKeyboard.SetShowTouchKeyboard(System.Windows.Forms.Control,DevComponents.DotNetBar.Keyboard.TouchKeyboardStyle)">
  538. <summary>
  539. Sets the way the keyboard will be shown when controls receive focus. If the control is a Form,
  540. all controls on the Form will support this way of displaying the touch keyboard.
  541. </summary>
  542. <param name="extendee">The control for which this value is specified.</param>
  543. <param name="value">A TouchKeyboardStyle value defining the way the keyboard appears.</param>
  544. </member>
  545. <member name="M:DevComponents.DotNetBar.Keyboard.TouchKeyboard.OnTextChanged">
  546. <summary>
  547. Raises the TextChanged event.
  548. </summary>
  549. </member>
  550. <member name="E:DevComponents.DotNetBar.Keyboard.TouchKeyboard.SendingKey">
  551. <summary>
  552. Occurs before the key pressed on keyboard is sent to target control and allows cancellation of the message
  553. </summary>
  554. </member>
  555. <member name="E:DevComponents.DotNetBar.Keyboard.TouchKeyboard.KeySent">
  556. <summary>
  557. Occurs after the key is sent to target control.
  558. </summary>
  559. </member>
  560. <member name="P:DevComponents.DotNetBar.Keyboard.TouchKeyboard.KeyboardControl">
  561. <summary>
  562. Gets the reference to internal keyboard control that is used to provide Keyboard visual.
  563. </summary>
  564. </member>
  565. <member name="E:DevComponents.DotNetBar.Keyboard.TouchKeyboard.KeyboardOpening">
  566. <summary>
  567. Occurs before keyboard is shown and allows canceling of opening.
  568. </summary>
  569. </member>
  570. <member name="E:DevComponents.DotNetBar.Keyboard.TouchKeyboard.KeyboardOpened">
  571. <summary>
  572. Occurs after keyboard is shown.
  573. </summary>
  574. </member>
  575. <member name="P:DevComponents.DotNetBar.Keyboard.TouchKeyboard.CurrentKeyboardTarget">
  576. <summary>
  577. Gets keyboard target control.
  578. </summary>
  579. </member>
  580. <member name="E:DevComponents.DotNetBar.Keyboard.TouchKeyboard.KeyboardClosing">
  581. <summary>
  582. Occurs before the keyboard is closed and allows canceling of keyboard closing.
  583. </summary>
  584. </member>
  585. <member name="E:DevComponents.DotNetBar.Keyboard.TouchKeyboard.KeyboardClosed">
  586. <summary>
  587. Occurs after keyboard is closed.
  588. </summary>
  589. </member>
  590. <member name="P:DevComponents.DotNetBar.Keyboard.TouchKeyboard.ColorTable">
  591. <summary>
  592. Gets or set the ColorTable used to draw the keyboard.
  593. </summary>
  594. </member>
  595. <member name="P:DevComponents.DotNetBar.Keyboard.TouchKeyboard.Renderer">
  596. <summary>
  597. Gets or set the Renderer used to draw the keyboard.
  598. </summary>
  599. </member>
  600. <member name="P:DevComponents.DotNetBar.Keyboard.TouchKeyboard.Size">
  601. <summary>
  602. Gets or sets the size of the keyboard, when shown inline.
  603. </summary>
  604. </member>
  605. <member name="P:DevComponents.DotNetBar.Keyboard.TouchKeyboard.Location">
  606. <summary>
  607. Gets or sets the coordinates of the upper-left corner of the keyboard when shown inline, relative to the form.
  608. </summary>
  609. </member>
  610. <member name="P:DevComponents.DotNetBar.Keyboard.TouchKeyboard.Dock">
  611. <summary>
  612. Defines which borders of the keyboard are bound to the container.
  613. </summary>
  614. </member>
  615. <member name="P:DevComponents.DotNetBar.Keyboard.TouchKeyboard.FloatingLocation">
  616. <summary>
  617. Gets or sets the coordinates of the upper-left corner of the keyboard when shown floating, relative to the screen.
  618. </summary>
  619. </member>
  620. <member name="P:DevComponents.DotNetBar.Keyboard.TouchKeyboard.TouchEnabled">
  621. <summary>
  622. Indicates whether touch support is enabled when provided by hardware.
  623. </summary>
  624. </member>
  625. <member name="P:DevComponents.DotNetBar.Keyboard.TouchKeyboard.FloatingSize">
  626. <summary>
  627. Gets or sets the size of the keyboard, when shown floating.
  628. </summary>
  629. </member>
  630. <member name="P:DevComponents.DotNetBar.Keyboard.TouchKeyboard.Text">
  631. <summary>
  632. Gets or sets a text associated with this control.
  633. </summary>
  634. </member>
  635. <member name="E:DevComponents.DotNetBar.Keyboard.TouchKeyboard.TextChanged">
  636. <summary>
  637. Occurs when the Text property has changed.
  638. </summary>
  639. </member>
  640. <member name="E:DevComponents.DotNetBar.Keyboard.TouchKeyboard.SizeChanged">
  641. <summary>
  642. Occurs when the Size property has changed.
  643. </summary>
  644. </member>
  645. <member name="E:DevComponents.DotNetBar.Keyboard.TouchKeyboard.LocationChanged">
  646. <summary>
  647. Occurs when the Location property has changed.
  648. </summary>
  649. </member>
  650. <member name="E:DevComponents.DotNetBar.Keyboard.TouchKeyboard.DockChanged">
  651. <summary>
  652. Occurs when the Dock property has changed.
  653. </summary>
  654. </member>
  655. <member name="E:DevComponents.DotNetBar.Keyboard.TouchKeyboard.FloatingSizeChanged">
  656. <summary>
  657. Occurs when the FloatingSize property has changed.
  658. </summary>
  659. </member>
  660. <member name="E:DevComponents.DotNetBar.Keyboard.TouchKeyboard.FloatingLocationChanged">
  661. <summary>
  662. Occurs when the FloatingLocation property has changed.
  663. </summary>
  664. </member>
  665. <member name="T:DevComponents.DotNetBar.Keyboard.TouchKeyboardStyle">
  666. <summary>
  667. Defines the way the touch keyboard will appear when attached to controls.
  668. </summary>
  669. </member>
  670. <member name="F:DevComponents.DotNetBar.Keyboard.TouchKeyboardStyle.No">
  671. <summary>
  672. Touch keyboard will not be visible.
  673. </summary>
  674. </member>
  675. <member name="F:DevComponents.DotNetBar.Keyboard.TouchKeyboardStyle.Inline">
  676. <summary>
  677. Touch keyboard will appear inline in the form.
  678. </summary>
  679. </member>
  680. <member name="F:DevComponents.DotNetBar.Keyboard.TouchKeyboardStyle.Floating">
  681. <summary>
  682. Touch keyboard will appear floating on the screen.
  683. </summary>
  684. </member>
  685. <member name="T:DevComponents.DotNetBar.Keyboard.CancelKeyboardEventHandler">
  686. <summary>
  687. Defines delegate for keyboard events.
  688. </summary>
  689. </member>
  690. <member name="T:DevComponents.DotNetBar.Keyboard.CancelKeyboardEventArgs">
  691. <summary>
  692. Defines event arguments for keyboard based events.
  693. </summary>
  694. </member>
  695. <member name="M:DevComponents.DotNetBar.Keyboard.CancelKeyboardEventArgs.#ctor(System.Windows.Forms.Control,DevComponents.DotNetBar.Keyboard.TouchKeyboardStyle)">
  696. <summary>
  697. Initializes a new instance of the CancelKeyboardEventArgs class.
  698. </summary>
  699. <param name="targetControl"></param>
  700. <param name="style"></param>
  701. </member>
  702. <member name="F:DevComponents.DotNetBar.Keyboard.CancelKeyboardEventArgs.TargetControl">
  703. <summary>
  704. Gets or sets the keyboard target control.
  705. </summary>
  706. </member>
  707. <member name="F:DevComponents.DotNetBar.Keyboard.CancelKeyboardEventArgs.Style">
  708. <summary>
  709. Gets or sets the keyboard style.
  710. </summary>
  711. </member>
  712. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.OnPanBegin(DevComponents.DotNetBar.Touch.GestureEventArgs)">
  713. <summary>
  714. Raises PanBegin event.
  715. </summary>
  716. <param name="e">Provides event arguments.</param>
  717. </member>
  718. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.OnPanEnd(DevComponents.DotNetBar.Touch.GestureEventArgs)">
  719. <summary>
  720. Raises PanBegin event.
  721. </summary>
  722. <param name="e">Provides event arguments.</param>
  723. </member>
  724. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.OnPan(DevComponents.DotNetBar.Touch.GestureEventArgs)">
  725. <summary>
  726. Raises PanBegin event.
  727. </summary>
  728. <param name="e">Provides event arguments.</param>
  729. </member>
  730. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.OnBegin(DevComponents.DotNetBar.Touch.GestureEventArgs)">
  731. <summary>
  732. Raises Begin event.
  733. </summary>
  734. <param name="e">Provides event arguments.</param>
  735. </member>
  736. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.OnEnd(DevComponents.DotNetBar.Touch.GestureEventArgs)">
  737. <summary>
  738. Raises End event.
  739. </summary>
  740. <param name="e">Provides event arguments.</param>
  741. </member>
  742. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.OnPressAndTap(DevComponents.DotNetBar.Touch.GestureEventArgs)">
  743. <summary>
  744. Raises PressAndTap event.
  745. </summary>
  746. <param name="e">Provides event arguments.</param>
  747. </member>
  748. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.OnRotateBegin(DevComponents.DotNetBar.Touch.GestureEventArgs)">
  749. <summary>
  750. Raises RotateBegin event.
  751. </summary>
  752. <param name="e">Provides event arguments.</param>
  753. </member>
  754. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.OnRotate(DevComponents.DotNetBar.Touch.GestureEventArgs)">
  755. <summary>
  756. Raises Rotate event.
  757. </summary>
  758. <param name="e">Provides event arguments.</param>
  759. </member>
  760. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.OnRotateEnd(DevComponents.DotNetBar.Touch.GestureEventArgs)">
  761. <summary>
  762. Raises RotateEnd event.
  763. </summary>
  764. <param name="e">Provides event arguments.</param>
  765. </member>
  766. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.OnTwoFingerTap(DevComponents.DotNetBar.Touch.GestureEventArgs)">
  767. <summary>
  768. Raises TwoFingerTap event.
  769. </summary>
  770. <param name="e">Provides event arguments.</param>
  771. </member>
  772. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.OnZoomBegin(DevComponents.DotNetBar.Touch.GestureEventArgs)">
  773. <summary>
  774. Raises ZoomBegin event.
  775. </summary>
  776. <param name="e">Provides event arguments.</param>
  777. </member>
  778. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.OnZoom(DevComponents.DotNetBar.Touch.GestureEventArgs)">
  779. <summary>
  780. Raises Zoom event.
  781. </summary>
  782. <param name="e">Provides event arguments.</param>
  783. </member>
  784. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.OnZoomEnd(DevComponents.DotNetBar.Touch.GestureEventArgs)">
  785. <summary>
  786. Raises ZoomEnd event.
  787. </summary>
  788. <param name="e">Provides event arguments.</param>
  789. </member>
  790. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.OnTouchDown(DevComponents.DotNetBar.Touch.TouchEventArgs)">
  791. <summary>
  792. Raises TouchDown event.
  793. </summary>
  794. <param name="e">Provides event arguments.</param>
  795. </member>
  796. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.OnTouchUp(DevComponents.DotNetBar.Touch.TouchEventArgs)">
  797. <summary>
  798. Raises TouchDown event.
  799. </summary>
  800. <param name="e">Provides event arguments.</param>
  801. </member>
  802. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.OnTouchMove(DevComponents.DotNetBar.Touch.TouchEventArgs)">
  803. <summary>
  804. Raises TouchDown event.
  805. </summary>
  806. <param name="e">Provides event arguments.</param>
  807. </member>
  808. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.#ctor(System.Windows.Forms.Control)">
  809. <summary>
  810. Initializes a new instance of the TouchHandler class.
  811. </summary>
  812. <param name="parentControl"></param>
  813. </member>
  814. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.#ctor(System.Windows.Forms.Control,DevComponents.DotNetBar.Touch.eTouchHandlerType)">
  815. <summary>
  816. Initializes a new instance of the TouchHandler class.
  817. </summary>
  818. <param name="parentControl"></param>
  819. </member>
  820. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.Initialize">
  821. <summary>
  822. Initializes handler
  823. </summary>
  824. </member>
  825. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.WindowProc(System.IntPtr,System.Int32,System.IntPtr,System.IntPtr)">
  826. <summary>
  827. The Windows message handler.
  828. </summary>
  829. </member>
  830. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.DecodeMessage(System.IntPtr,System.Int32,System.IntPtr,System.IntPtr,System.Single,System.Single)">
  831. <summary>
  832. Decode the message and create a collection of event arguments
  833. </summary>
  834. </member>
  835. <member name="F:DevComponents.DotNetBar.Touch.TouchHandler._LastEventArgs">
  836. <summary>
  837. The last event in the current gesture event sequence
  838. </summary>
  839. </member>
  840. <member name="M:DevComponents.DotNetBar.Touch.TouchHandler.RegisterTouchWindow">
  841. <summary>
  842. Register for touch event
  843. </summary>
  844. <returns>true if succeeded</returns>
  845. </member>
  846. <member name="P:DevComponents.DotNetBar.Touch.TouchHandler.LastBeginEventArgs">
  847. <summary>
  848. The event arguments that started the current gesture
  849. </summary>
  850. </member>
  851. <member name="P:DevComponents.DotNetBar.Touch.TouchHandler.DisablePalmRejection">
  852. <summary>
  853. Gets or sets whether palm rejection is enabled.
  854. </summary>
  855. </member>
  856. <member name="P:DevComponents.DotNetBar.Touch.TouchHandler.IsTouchEnabled">
  857. <summary>
  858. Check if Multi-touch support device is ready
  859. </summary>
  860. </member>
  861. <member name="M:DevComponents.DotNetBar.Touch.GestureEventArgs.#ctor(DevComponents.DotNetBar.Touch.TouchHandler,DevComponents.DotNetBar.Touch.WinApi.GESTUREINFO@)">
  862. <summary>
  863. Create new gesture event instance and decode the gesture info structure
  864. </summary>
  865. <param name="handler">The gesture handler</param>
  866. <param name="gestureInfo">The gesture information</param>
  867. </member>
  868. <member name="F:DevComponents.DotNetBar.Touch.GestureEventArgs._RotateAngle">
  869. <summary>
  870. Gesture relative rotation angle for Rotate event.
  871. </summary>
  872. </member>
  873. <member name="F:DevComponents.DotNetBar.Touch.GestureEventArgs._Center">
  874. <summary>
  875. Indicates calculated gesture center.
  876. </summary>
  877. </member>
  878. <member name="F:DevComponents.DotNetBar.Touch.GestureEventArgs._ZoomFactor">
  879. <summary>
  880. Gesture zoom factor for Zoom event.
  881. </summary>
  882. </member>
  883. <member name="F:DevComponents.DotNetBar.Touch.GestureEventArgs._PanTranslation">
  884. <summary>
  885. Gesture relative panning translation for Pan event.
  886. </summary>
  887. </member>
  888. <member name="F:DevComponents.DotNetBar.Touch.GestureEventArgs._PanVelocity">
  889. <summary>
  890. Gesture velocity vector of the pan gesture for custom inertia implementations.
  891. </summary>
  892. </member>
  893. <member name="F:DevComponents.DotNetBar.Touch.GestureEventArgs._LastEvent">
  894. <summary>
  895. The last touch arguments in this gesture event sequence.
  896. </summary>
  897. </member>
  898. <member name="P:DevComponents.DotNetBar.Touch.GestureEventArgs.Location">
  899. <summary>
  900. The client location of gesture.
  901. </summary>
  902. </member>
  903. <member name="P:DevComponents.DotNetBar.Touch.GestureEventArgs.IsBegin">
  904. <summary>
  905. Is this the first event of a gesture.
  906. </summary>
  907. </member>
  908. <member name="P:DevComponents.DotNetBar.Touch.GestureEventArgs.IsEnd">
  909. <summary>
  910. It this last event of a gesture.
  911. </summary>
  912. </member>
  913. <member name="P:DevComponents.DotNetBar.Touch.GestureEventArgs.IsInertia">
  914. <summary>
  915. Has gesture triggered inertia.
  916. </summary>
  917. </member>
  918. <member name="P:DevComponents.DotNetBar.Touch.GestureEventArgs.LastBeginEvent">
  919. <summary>
  920. The first touch arguments in this gesture event sequence.
  921. </summary>
  922. </member>
  923. <member name="T:DevComponents.DotNetBar.Touch.TouchEventArgs">
  924. <summary>
  925. EventArgs passed to Touch handlers
  926. </summary>
  927. </member>
  928. <member name="M:DevComponents.DotNetBar.Touch.TouchEventArgs.#ctor(DevComponents.DotNetBar.Touch.TouchHandler,System.Single,System.Single,DevComponents.DotNetBar.Touch.WinApi.TOUCHINPUT@)">
  929. <summary>
  930. Create new touch event argument instance
  931. </summary>
  932. <param name="hWndWrapper">The target control</param>
  933. <param name="touchInput">one of the inner touch input in the message</param>
  934. </member>
  935. <member name="F:DevComponents.DotNetBar.Touch.TouchEventArgs._Location">
  936. <summary>
  937. Touch client coordinate in pixels
  938. </summary>
  939. </member>
  940. <member name="F:DevComponents.DotNetBar.Touch.TouchEventArgs._Id">
  941. <summary>
  942. A touch point identifier that distinguishes a particular touch input
  943. </summary>
  944. </member>
  945. <member name="F:DevComponents.DotNetBar.Touch.TouchEventArgs._Flags">
  946. <summary>
  947. A set of bit flags that specify various aspects of touch point
  948. press, release, and motion.
  949. </summary>
  950. </member>
  951. <member name="F:DevComponents.DotNetBar.Touch.TouchEventArgs._Mask">
  952. <summary>
  953. mask which fields in the structure are valid
  954. </summary>
  955. </member>
  956. <member name="F:DevComponents.DotNetBar.Touch.TouchEventArgs._AbsoluteTime">
  957. <summary>
  958. touch event time
  959. </summary>
  960. </member>
  961. <member name="F:DevComponents.DotNetBar.Touch.TouchEventArgs._Time">
  962. <summary>
  963. touch event time from system up
  964. </summary>
  965. </member>
  966. <member name="F:DevComponents.DotNetBar.Touch.TouchEventArgs._ContactSize">
  967. <summary>
  968. the size of the contact area in pixels
  969. </summary>
  970. </member>
  971. <member name="P:DevComponents.DotNetBar.Touch.TouchEventArgs.IsPrimaryContact">
  972. <summary>
  973. Is Primary Contact (The first touch sequence)
  974. </summary>
  975. </member>
  976. <member name="P:DevComponents.DotNetBar.Touch.TouchEventArgs.IsTouchMove">
  977. <summary>
  978. Specifies that movement occurred
  979. </summary>
  980. </member>
  981. <member name="P:DevComponents.DotNetBar.Touch.TouchEventArgs.IsTouchDown">
  982. <summary>
  983. Specifies that the corresponding touch point was established through a new contact
  984. </summary>
  985. </member>
  986. <member name="P:DevComponents.DotNetBar.Touch.TouchEventArgs.IsTouchUp">
  987. <summary>
  988. Specifies that a touch point was removed
  989. </summary>
  990. </member>
  991. <member name="P:DevComponents.DotNetBar.Touch.TouchEventArgs.IsTouchInRange">
  992. <summary>
  993. Specifies that a touch point is in range
  994. </summary>
  995. </member>
  996. <member name="P:DevComponents.DotNetBar.Touch.TouchEventArgs.IsTouchNoCoalesce">
  997. <summary>
  998. specifies that this input was not coalesced.
  999. </summary>
  1000. </member>
  1001. <member name="P:DevComponents.DotNetBar.Touch.TouchEventArgs.IsTouchPen">
  1002. <summary>
  1003. Specifies that the touch point is associated with a pen contact
  1004. </summary>
  1005. </member>
  1006. <member name="P:DevComponents.DotNetBar.Touch.TouchEventArgs.IsTouchPalm">
  1007. <summary>
  1008. The touch event came from the user's palm
  1009. </summary>
  1010. <remarks>Set <see cref="!:DisablePalmRejection"/> to true</remarks>
  1011. </member>
  1012. <member name="M:DevComponents.DotNetBar.Touch.WinApi.GetDigitizerStatus">
  1013. <summary>
  1014. Get the current Digitizer Status
  1015. </summary>
  1016. </member>
  1017. <member name="M:DevComponents.DotNetBar.Touch.WinApi.GESTURECONFIG.#ctor(System.UInt32,System.UInt32,System.UInt32)">
  1018. <summary>
  1019. Initializes a new instance of the GESTURECONFIG structure.
  1020. </summary>
  1021. <param name="dwID"></param>
  1022. <param name="dwWant"></param>
  1023. <param name="dwBlock"></param>
  1024. </member>
  1025. <member name="T:DevComponents.DotNetBar.Touch.WinApi.DigitizerStatus">
  1026. <summary>
  1027. Specifies available digitizer capabilities
  1028. </summary>
  1029. </member>
  1030. <member name="T:DevComponents.DotNetBar.Touch.WinApi.GESTUREINFO">
  1031. <summary>
  1032. Gesture Info Interop Structure
  1033. </summary>
  1034. </member>
  1035. <member name="T:DevComponents.DotNetBar.Touch.WinApi.POINTS">
  1036. <summary>
  1037. A Simple POINTS Interop structure
  1038. </summary>
  1039. </member>
  1040. <member name="T:DevComponents.DotNetBar.Touch.WinApi.POINT">
  1041. <summary>
  1042. A Simple POINT Interop structure
  1043. </summary>
  1044. </member>
  1045. <member name="T:DevComponents.DotNetBar.Touch.WinApi.TOUCHINPUT">
  1046. <summary>
  1047. Touch API defined structures [winuser.h]
  1048. </summary>
  1049. </member>
  1050. <member name="T:DevComponents.DotNetBar.Keyboard.KeyboardControl">
  1051. <summary>
  1052. Represents virtual keyboard control.
  1053. </summary>
  1054. </member>
  1055. <member name="F:DevComponents.DotNetBar.Keyboard.KeyboardControl.DefaultWidth">
  1056. <summary>
  1057. Default width for the keyboard in pixels.
  1058. </summary>
  1059. </member>
  1060. <member name="F:DevComponents.DotNetBar.Keyboard.KeyboardControl.DefaultHeight">
  1061. <summary>
  1062. Default height for the keyboard in pixels.
  1063. </summary>
  1064. </member>
  1065. <member name="M:DevComponents.DotNetBar.Keyboard.KeyboardControl.#ctor">
  1066. <summary>
  1067. Creates a new VirtualKeyboard control.
  1068. </summary>
  1069. </member>
  1070. <member name="M:DevComponents.DotNetBar.Keyboard.KeyboardControl.OnTouchEnabledChanged(System.Boolean,System.Boolean)">
  1071. <summary>
  1072. Called when TouchEnabled property has changed.
  1073. </summary>
  1074. <param name="oldValue">Old property value</param>
  1075. <param name="newValue">New property value</param>
  1076. </member>
  1077. <member name="M:DevComponents.DotNetBar.Keyboard.KeyboardControl.HitTest(System.Drawing.Point)">
  1078. <summary>
  1079. Returns the Key at given location. Location expected is in control coordinates.
  1080. </summary>
  1081. <param name="location">Location is control coordinates.</param>
  1082. <returns>Key if there is a key at given location or null/nothing if no key exists at given location.</returns>
  1083. </member>
  1084. <member name="M:DevComponents.DotNetBar.Keyboard.KeyboardControl.AttachTo(System.Windows.Forms.Control)">
  1085. <summary>
  1086. Attaches the Keyboard to the specified control. The keyboard will automatically appear when the control receives input focus.
  1087. </summary>
  1088. <param name="control">The control to which the Keyboard will be attached.</param>
  1089. </member>
  1090. <member name="M:DevComponents.DotNetBar.Keyboard.KeyboardControl.DetachFrom(System.Windows.Forms.Control)">
  1091. <summary>
  1092. Detaches the Keyboard from the specified control.
  1093. </summary>
  1094. <param name="control">The control from which the Keyboard will be detached.</param>
  1095. </member>
  1096. <member name="M:DevComponents.DotNetBar.Keyboard.KeyboardControl.OnKeyboardClosing(System.ComponentModel.CancelEventArgs)">
  1097. <summary>
  1098. Raises KeyboardClosing event.
  1099. </summary>
  1100. <param name="e">Provides event arguments.</param>
  1101. </member>
  1102. <member name="M:DevComponents.DotNetBar.Keyboard.KeyboardControl.OnKeyboardClosed(System.EventArgs)">
  1103. <summary>
  1104. Raises KeyboardClosed event.
  1105. </summary>
  1106. <param name="e">Provides event arguments.</param>
  1107. </member>
  1108. <member name="M:DevComponents.DotNetBar.Keyboard.KeyboardControl.OnSendingKey(DevComponents.DotNetBar.Keyboard.KeyboardKeyCancelEventArgs)">
  1109. <summary>
  1110. Raises SendingKey event.
  1111. </summary>
  1112. <param name="e">Provides event arguments.</param>
  1113. </member>
  1114. <member name="M:DevComponents.DotNetBar.Keyboard.KeyboardControl.OnKeySent(DevComponents.DotNetBar.Keyboard.KeyboardKeyEventArgs)">
  1115. <summary>
  1116. Raises KeySent event.
  1117. </summary>
  1118. <param name="e">Provides event arguments.</param>
  1119. </member>
  1120. <member name="P:DevComponents.DotNetBar.Keyboard.KeyboardControl.Keyboard">
  1121. <summary>
  1122. Gets or sets the Keyboard object that describes the VirtualKeyboard.
  1123. </summary>
  1124. </member>
  1125. <member name="P:DevComponents.DotNetBar.Keyboard.KeyboardControl.ColorTable">
  1126. <summary>
  1127. Gets or set the ColorTable used to draw the keyboard.
  1128. </summary>
  1129. </member>
  1130. <member name="P:DevComponents.DotNetBar.Keyboard.KeyboardControl.Renderer">
  1131. <summary>
  1132. Gets or sets the Renderer used to render the keyboard.
  1133. </summary>
  1134. </member>
  1135. <member name="P:DevComponents.DotNetBar.Keyboard.KeyboardControl.IsTopBarVisible">
  1136. <summary>
  1137. Gets or sets a value indicating if the top bar of the keyboard is visible.
  1138. </summary>
  1139. </member>
  1140. <member name="P:DevComponents.DotNetBar.Keyboard.KeyboardControl.CaptionHeight">
  1141. <summary>
  1142. Indicates the height of the keyboard caption which hosts the close button.
  1143. </summary>
  1144. </member>
  1145. <member name="P:DevComponents.DotNetBar.Keyboard.KeyboardControl.TouchEnabled">
  1146. <summary>
  1147. Indicates whether touch support is enabled when provided by hardware.
  1148. </summary>
  1149. </member>
  1150. <member name="E:DevComponents.DotNetBar.Keyboard.KeyboardControl.KeyboardClosing">
  1151. <summary>
  1152. Occurs before the keyboard is closed and allows canceling of keyboard closing.
  1153. </summary>
  1154. </member>
  1155. <member name="E:DevComponents.DotNetBar.Keyboard.KeyboardControl.KeyboardClosed">
  1156. <summary>
  1157. Occurs after keyboard is closed.
  1158. </summary>
  1159. </member>
  1160. <member name="E:DevComponents.DotNetBar.Keyboard.KeyboardControl.SendingKey">
  1161. <summary>
  1162. Occurs before the key pressed on keyboard is sent to target control and allows cancellation of the message
  1163. </summary>
  1164. </member>
  1165. <member name="E:DevComponents.DotNetBar.Keyboard.KeyboardControl.KeySent">
  1166. <summary>
  1167. Occurs after the key is sent to target control.
  1168. </summary>
  1169. </member>
  1170. <member name="T:DevComponents.DotNetBar.Keyboard.KeyEventHandler">
  1171. <summary>
  1172. Defines delegate for key-related events.
  1173. </summary>
  1174. <param name="sender"></param>
  1175. <param name="e"></param>
  1176. </member>
  1177. <member name="T:DevComponents.DotNetBar.Keyboard.KeyboardKeyEventArgs">
  1178. <summary>
  1179. Provides data for key related events.
  1180. </summary>
  1181. </member>
  1182. <member name="F:DevComponents.DotNetBar.Keyboard.KeyboardKeyEventArgs.Key">
  1183. <summary>
  1184. Gets the key being pressed. The format of this information
  1185. must confirm to the description for the SendKeys.Send function. For more details, see:
  1186. http://msdn.microsoft.com/en-us/library/system.windows.forms.sendkeys.aspx
  1187. </summary>
  1188. </member>
  1189. <member name="M:DevComponents.DotNetBar.Keyboard.KeyboardKeyEventArgs.#ctor(System.String)">
  1190. <summary>
  1191. Initializes a new instance of the KeyboardKeyEventArgs class.
  1192. </summary>
  1193. <param name="key"></param>
  1194. </member>
  1195. <member name="T:DevComponents.DotNetBar.Keyboard.KeyCancelEventHandler">
  1196. <summary>
  1197. Defines delegate for key-related events.
  1198. </summary>
  1199. <param name="sender"></param>
  1200. <param name="e"></param>
  1201. </member>
  1202. <member name="T:DevComponents.DotNetBar.Keyboard.KeyboardKeyCancelEventArgs">
  1203. <summary>
  1204. Provides data for key related events.
  1205. </summary>
  1206. </member>
  1207. <member name="F:DevComponents.DotNetBar.Keyboard.KeyboardKeyCancelEventArgs.Key">
  1208. <summary>
  1209. Gets the key being pressed. The format of this information
  1210. must confirm to the description for the SendKeys.Send function. For more details, see:
  1211. http://msdn.microsoft.com/en-us/library/system.windows.forms.sendkeys.aspx
  1212. </summary>
  1213. </member>
  1214. <member name="M:DevComponents.DotNetBar.Keyboard.KeyboardKeyCancelEventArgs.#ctor(System.String)">
  1215. <summary>
  1216. Initializes a new instance of the KeyCancelEventArgs class.
  1217. </summary>
  1218. <param name="key"></param>
  1219. </member>
  1220. <member name="T:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable">
  1221. <summary>
  1222. Defines the VirtualKeyboard colors.
  1223. </summary>
  1224. <remarks>
  1225. This class maintains internally a Brush for each Color. These Brush objects are disposed internally when not needed anymore.
  1226. A Brush of a certain color is obtained by setting the same Color property to that color.
  1227. Maintaining the brushes here helps to have less GDI handles created / destroyed on each drawing of the keyboard.
  1228. </remarks>
  1229. </member>
  1230. <member name="M:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.#ctor">
  1231. <summary>
  1232. Creates a new color table for the VirtualKeyoard.
  1233. </summary>
  1234. </member>
  1235. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.BackgroundColor">
  1236. <summary>
  1237. Gets or sets the color used to draw the background of the keyboard.
  1238. </summary>
  1239. </member>
  1240. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.BackgroundBrush">
  1241. <summary>
  1242. Gets a brush used for drawing the background of the keyboard.
  1243. </summary>
  1244. </member>
  1245. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.KeysColor">
  1246. <summary>
  1247. Gets or sets the color used for drawing normal keys.
  1248. </summary>
  1249. </member>
  1250. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.KeysBrush">
  1251. <summary>
  1252. Gets a brush used for drawing normal keys.
  1253. </summary>
  1254. </member>
  1255. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.LightKeysColor">
  1256. <summary>
  1257. Gets or sets the color used for drawing light keys.
  1258. </summary>
  1259. </member>
  1260. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.LightKeysBrush">
  1261. <summary>
  1262. Gets a brush used for drawing light keys.
  1263. </summary>
  1264. </member>
  1265. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.DarkKeysColor">
  1266. <summary>
  1267. Gets or sets the color used for drawing dark keys.
  1268. </summary>
  1269. </member>
  1270. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.DarkKeysBrush">
  1271. <summary>
  1272. Gets a brush used for drawing dark keys.
  1273. </summary>
  1274. </member>
  1275. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.PressedKeysColor">
  1276. <summary>
  1277. Gets or sets a brush used for drawing pressed keys.
  1278. </summary>
  1279. </member>
  1280. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.PressedKeysBrush">
  1281. <summary>
  1282. Gets a brush used for drawing pressed keys.
  1283. </summary>
  1284. </member>
  1285. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.DownKeysColor">
  1286. <summary>
  1287. Gets or sets a brush used for drawing pressed key when the key is down.
  1288. </summary>
  1289. </member>
  1290. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.DownKeysBrush">
  1291. <summary>
  1292. Gets a brush used for drawing pressed key when the key is down.
  1293. </summary>
  1294. </member>
  1295. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.TextColor">
  1296. <summary>
  1297. Gets or sets a color used for drawing the text on the keys.
  1298. </summary>
  1299. </member>
  1300. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.TextBrush">
  1301. <summary>
  1302. Gets a brush used for drawing the text on the keys.
  1303. </summary>
  1304. </member>
  1305. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.DownTextColor">
  1306. <summary>
  1307. Gets or sets a color used for drawing the text on a key when the key is down.
  1308. </summary>
  1309. </member>
  1310. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.DownTextBrush">
  1311. <summary>
  1312. Gets a brush used for drawing the text on a key when the key is down.
  1313. </summary>
  1314. </member>
  1315. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.TopBarTextColor">
  1316. <summary>
  1317. Gets or sets a color used for drawing the text on the top bar.
  1318. </summary>
  1319. </member>
  1320. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.TopBarTextBrush">
  1321. <summary>
  1322. Gets a brush used for drawing the text on the top bar.
  1323. </summary>
  1324. </member>
  1325. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.ToggleTextColor">
  1326. <summary>
  1327. Gets or sets a color used for drawing the text on a key when the key is in its toggled state.
  1328. </summary>
  1329. </member>
  1330. <member name="P:DevComponents.DotNetBar.Keyboard.VirtualKeyboardColorTable.ToggleTextBrush">
  1331. <summary>
  1332. Gets a brush used for drawing the text on a key when the key is in its toggled state.
  1333. </summary>
  1334. </member>
  1335. </members>
  1336. </doc>