Dynamsoft.FormsViewer.XML 79 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Dynamsoft.Forms.Viewer</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Dynamsoft.Forms.Annotation">
  8. <summary>
  9. Defines a class provides functions for managing the annotations on viewer.
  10. </summary>
  11. </member>
  12. <member name="M:Dynamsoft.Forms.Interface.IAnnotationEvent.OnAnnotationSelected(System.Collections.Generic.List{Dynamsoft.Core.Annotation.AnnotationData})">
  13. <summary>
  14. </summary>
  15. <param name="annotations"></param>
  16. </member>
  17. <member name="E:Dynamsoft.Forms.Annotation.OnAnnotationSelected">
  18. <summary>
  19. This event is triggered when an annotation is selected.
  20. </summary>
  21. </member>
  22. <member name="E:Dynamsoft.Forms.Annotation.OnAnnotationDeselected">
  23. <summary>
  24. This event is triggered when one or more annotations is deselected.
  25. </summary>
  26. </member>
  27. <member name="E:Dynamsoft.Forms.Annotation.OnAnnotationCreated">
  28. <summary>
  29. This event is triggered when an annotation is created.
  30. </summary>
  31. </member>
  32. <member name="E:Dynamsoft.Forms.Annotation.OnAnnotationMoved">
  33. <summary>
  34. This event is triggered when an annotation is moved.
  35. </summary>
  36. </member>
  37. <member name="E:Dynamsoft.Forms.Annotation.OnAnnotationResized">
  38. <summary>
  39. This event is triggered when an annotation is resized.
  40. </summary>
  41. </member>
  42. <member name="E:Dynamsoft.Forms.Annotation.OnAnnotationTextChanged">
  43. <summary>
  44. This event is triggered when the text in an annotation is changed.
  45. </summary>
  46. </member>
  47. <member name="P:Dynamsoft.Forms.Annotation.Type">
  48. <summary>
  49. Returns or sets the annotation type. To use the property, the property MouseShape should be set to false.
  50. </summary>
  51. <exception cref="!:Dynamsoft.Viewer.TwainException">
  52. When an error occurs, please check TwainException.
  53. </exception>
  54. <remarks>
  55. <div class="tablediv">
  56. <table>
  57. <tr valign="center">
  58. <th>Allowed Values</th>
  59. <th>Annotation Types</th>
  60. </tr>
  61. <tr valign="center">
  62. <td>enumNone(default)</td>
  63. <td>Select an area</td>
  64. </tr>
  65. <tr valign="center">
  66. <td>enumPointer(Pointer)</td>
  67. <td>Select an existing annotation. Press "Ctrl" to multi-select annotations.</td>
  68. </tr>
  69. <tr valign="center">
  70. <td>enumText(Text)</td>
  71. <td>Create a text.The annotation type will be set back to 1 once the annotation is completed..</td>
  72. </tr>
  73. <tr valign="center">
  74. <td>enumLine(Line)</td>
  75. <td>Create a line.The annotation type will be set back to 1 once the annotation is completed..</td>
  76. </tr>
  77. <tr valign="center">
  78. <td>enumRectangle(Rectangle)</td>
  79. <td>Create a rectangle.The annotation type will be set back to 1 once the annotation is completed..</td>
  80. </tr>
  81. <tr valign="center">
  82. <td>enumEllipse(Ellipse)</td>
  83. <td>Create a ellipse.The annotation type will be set back to 1 once the annotation is completed..</td>
  84. </tr>
  85. </table>
  86. </div>
  87. <br/>
  88. </remarks>
  89. </member>
  90. <member name="P:Dynamsoft.Forms.Annotation.TextFont">
  91. <summary>
  92. Returns or sets the font of the annotation text. This property is only valid when the annotation type is set to 2(Text).
  93. </summary>
  94. <exception cref="!:Dynamsoft.Viewer.TwainException">
  95. When an error occurs, please check TwainException.
  96. </exception>
  97. </member>
  98. <member name="P:Dynamsoft.Forms.Annotation.TextColor">
  99. <summary>
  100. Returns or sets the color for the annotation text. This property is only valid when the annotation type is set to 2(Text).
  101. </summary>
  102. <exception cref="!:Dynamsoft.Viewer.TwainException">
  103. When an error occurs, please check TwainException.
  104. </exception>
  105. </member>
  106. <member name="P:Dynamsoft.Forms.Annotation.Pen">
  107. <summary>
  108. Returns or sets the color and width of the pen for drawing the annotation rectangle/ellipse/line. This property is only valid when the annotation type is NOT 2(Text).
  109. </summary>
  110. <exception cref="!:Dynamsoft.Viewer.TwainException">
  111. When an error occurs, please check TwainException.
  112. </exception>
  113. <remarks>
  114. By default, the color is black and the width is 1;
  115. </remarks>
  116. </member>
  117. <member name="P:Dynamsoft.Forms.Annotation.FillColor">
  118. <summary>
  119. Returns or sets the fill color and transparency for the area inside the annotation rectangle/ellipse. This property is only valid when the annotation type is NOT 2(Text).
  120. </summary>
  121. <exception cref="!:Dynamsoft.Viewer.TwainException">
  122. When an error occurs, please check TwainException.
  123. </exception>
  124. <remarks>
  125. By default, the color is white and not transparent.
  126. </remarks>
  127. </member>
  128. <member name="T:Dynamsoft.Common.ConstStringHelper">
  129. <summary>
  130. Summary description for ConstStringHelper.
  131. </summary>
  132. </member>
  133. <member name="T:Dynamsoft.Common.IndexList">
  134. <summary>
  135. Implements the IIndexList interface using an array whose size is dynamically increased as required.
  136. </summary>
  137. </member>
  138. <member name="T:Dynamsoft.Forms.Interface.IIndexList">
  139. <summary>
  140. Represents a non-generic collection of objects that can be individually accessed by index.
  141. </summary>
  142. </member>
  143. <member name="M:Dynamsoft.Forms.Interface.IIndexList.Insert(System.Int32,System.Int32)">
  144. <summary>
  145. Inserts an element into the list at the specified index.
  146. </summary>
  147. <param name="index">The zero-based index at which value should be inserted.</param>
  148. <param name="value">The value to be inserted.</param>
  149. <returns>
  150. true indicates success. false indicates failure.
  151. </returns>
  152. <exception cref="!:Dynamsoft.Form.ViewerException">
  153. When an error occurs and IfThrowException property is true, an exception will be thrown.
  154. When IfThrowException property is false, please check ErrorCode and ErrorString.
  155. </exception>
  156. </member>
  157. <member name="M:Dynamsoft.Forms.Interface.IIndexList.Add(System.Int32)">
  158. <summary>
  159. Adds an int value to the end of the list.
  160. </summary>
  161. <param name="value">
  162. The value to be added to the end of the list.
  163. </param>
  164. <returns>
  165. The list index at which the value has been added. -1 indicates failure.
  166. </returns>
  167. <exception cref="!:Dynamsoft.Form.ViewerException">
  168. When an error occurs and IfThrowException property is true, an exception will be thrown.
  169. When IfThrowException property is false, please check ErrorCode and ErrorString.
  170. </exception>
  171. </member>
  172. <member name="M:Dynamsoft.Forms.Interface.IIndexList.RemoveAt(System.Int32)">
  173. <summary>
  174. Removes the element at the specified index of the list.
  175. </summary>
  176. <param name="index">The zero-based index of the element to be removed.</param>
  177. <returns>
  178. true indicates success. false indicates failure.
  179. </returns>
  180. <exception cref="!:Dynamsoft.Form.ViewerException">
  181. When an error occurs and IfThrowException property is true, an exception will be thrown.
  182. When IfThrowException property is false, please check ErrorCode and ErrorString.
  183. </exception>
  184. </member>
  185. <member name="M:Dynamsoft.Forms.Interface.IIndexList.Remove(System.Int32)">
  186. <summary>
  187. Removes the first occurrence of a specific value from the list.
  188. </summary>
  189. <param name="value">The value to be removed from the list.</param>
  190. <returns>
  191. true indicates success. false indicates failure.
  192. </returns>
  193. <exception cref="!:Dynamsoft.Form.ViewerException">
  194. When an error occurs and IfThrowException property is true, an exception will be thrown.
  195. When IfThrowException property is false, please check ErrorCode and ErrorString.
  196. </exception>
  197. </member>
  198. <member name="M:Dynamsoft.Forms.Interface.IIndexList.GetEnumerator">
  199. <summary>
  200. Returns an enumerator for the entire list.
  201. </summary>
  202. <returns>
  203. An IEnumerator for the entire list.
  204. </returns>
  205. <exception cref="!:Dynamsoft.Form.ViewerException">
  206. When an error occurs and IfThrowException property is true, an exception will be thrown.
  207. When IfThrowException property is false, please check ErrorCode and ErrorString.
  208. </exception>
  209. </member>
  210. <member name="P:Dynamsoft.Forms.Interface.IIndexList.Count">
  211. <summary>
  212. Gets the number of elements actually contained in the list.
  213. </summary>
  214. <exception cref="!:Dynamsoft.Form.ViewerException">
  215. When an error occurs and IfThrowException property is true, an exception will be thrown.
  216. When IfThrowException property is false, please check ErrorCode and ErrorString.
  217. </exception>
  218. </member>
  219. <member name="P:Dynamsoft.Forms.Interface.IIndexList.Item(System.Int32)">
  220. <summary>
  221. Gets or sets the element at the specified index.
  222. </summary>
  223. <param name="index">The zero-based index of the element to get or set.</param>
  224. <exception cref="!:Dynamsoft.Form.ViewerException">
  225. When an error occurs and IfThrowException property is true, an exception will be thrown.
  226. When IfThrowException property is false, please check ErrorCode and ErrorString.
  227. </exception>
  228. </member>
  229. <member name="T:Dynamsoft.Common.Util">
  230. <summary>
  231. Summary description for Util.
  232. </summary>
  233. </member>
  234. <member name="M:Dynamsoft.Common.Util.Clone(System.Drawing.Bitmap)">
  235. <summary>
  236. Clone image.
  237. </summary>
  238. <param name="source">Source image.</param>
  239. <returns>Return clone of the source image.</returns>
  240. <remarks>The original <see cref="M:System.Drawing.Bitmap.Clone(System.Drawing.Rectangle,System.Drawing.Imaging.PixelFormat)">Bitmap.Clone()</see>
  241. does not produce the desired result - it does not create an actual clone (it does not create a copy
  242. of the image). That is why this method was implemented to provide the functionality.</remarks>
  243. </member>
  244. <member name="M:Dynamsoft.Common.Util.Clone(System.Drawing.Imaging.BitmapData)">
  245. <summary>
  246. Clone image.
  247. </summary>
  248. <param name="sourceData">Source image data.</param>
  249. <returns>Clones image from source image data. The message does not clone pallete in the
  250. case if the source image has indexed pixel format.</returns>
  251. </member>
  252. <member name="M:Dynamsoft.Common.Util.CopyUnmanagedMemory(System.IntPtr,System.IntPtr,System.Int32)">
  253. <summary>
  254. Copy block of unmanaged memory.
  255. </summary>
  256. <param name="dst">Destination pointer.</param>
  257. <param name="src">Source pointer.</param>
  258. <param name="count">Memory block's length to copy.</param>
  259. <returns>Return's value of <paramref name="dst"/> - pointer to destination.</returns>
  260. <remarks><para>This function is required because of the fact that .NET does
  261. not provide any way to copy unmanaged blocks, but provides only methods to
  262. copy from unmanaged memory to managed memory and vise versa.</para></remarks>
  263. </member>
  264. <member name="P:Dynamsoft.Forms.Controls.controller.ControllerImageWindow.NetRectangle">
  265. <summary>
  266. Group selection rectangle. Used for drawing.
  267. http://www.google.com
  268. </summary>
  269. </member>
  270. <member name="P:Dynamsoft.Forms.Controls.controller.ControllerImageWindow.DrawNetRectangle">
  271. <summary>
  272. Flas is set to true if group selection rectangle should be drawn.
  273. </summary>
  274. </member>
  275. <member name="P:Dynamsoft.Forms.Controls.controller.ControllerImageWindow.ActiveTool">
  276. <summary>
  277. Active drawing tool.
  278. </summary>
  279. </member>
  280. <member name="P:Dynamsoft.Forms.Controls.controller.ControllerImageWindow.GraphicsList">
  281. <summary>
  282. List of graphics objects.
  283. </summary>
  284. </member>
  285. <member name="P:Dynamsoft.Forms.Controls.controller.ControllerImageViewer.OneByOneMode">
  286. <summary>
  287. Sample
  288. </summary>
  289. </member>
  290. <member name="T:Dynamsoft.Forms.DSViewer">
  291. <summary>
  292. Defines a class providing functions for managing image viewer.
  293. </summary>
  294. </member>
  295. <member name="F:Dynamsoft.Forms.DSViewer.components">
  296. <summary>
  297. Required designer variable.
  298. </summary>
  299. </member>
  300. <member name="M:Dynamsoft.Forms.DSViewer.InitializeComponent">
  301. <summary>
  302. Required method for Designer support - do not modify
  303. the contents of this method with the code editor.
  304. </summary>
  305. </member>
  306. <member name="M:Dynamsoft.Forms.DSViewer.Print">
  307. <summary>
  308. Shows the GUI of Image Printer with the default printer settings.
  309. </summary>
  310. <returns>
  311. Boolean.
  312. True indicates success. False indicates failure.
  313. </returns>
  314. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  315. When an error occurs, please check ViewerException.
  316. </exception>
  317. <remarks>
  318. Depending on the property IfShowPrintUI, the User Interface of the printer may or may not show when you invoke this method.
  319. </remarks>
  320. </member>
  321. <member name="M:Dynamsoft.Forms.DSViewer.Print(System.Drawing.Printing.PrinterSettings)">
  322. <summary>
  323. Shows the GUI of Image Printer with custom printer settings.
  324. </summary>
  325. <param name="printerSettings">Custom printer settings</param>
  326. <returns>
  327. Boolean.
  328. True indicates success. False indicates failure.
  329. </returns>
  330. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  331. When an error occurs, please check ViewerException.
  332. </exception>
  333. <remarks>
  334. Depending on the property IfShowPrintUI, the User Interface of the printer may or may not show when you invoke this method.
  335. </remarks>
  336. </member>
  337. <member name="M:Dynamsoft.Forms.DSViewer.GetViewMode(System.Int16@,System.Int16@)">
  338. <summary>
  339. Gets the view mode that images are displayed in the viewer.
  340. </summary>
  341. <param name="sHorizontalImageCount">the short number for the columns can be displayed in the viewer. </param>
  342. <param name="sVerticalImageCount">the short number for the rows can be displayed in the viewer.</param>
  343. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  344. When an error occurs, please check ViewerException.
  345. </exception>
  346. <remarks>
  347. If the view mode is set to -1*-1, the returned value of sHorizontalImageCount is -1, and so is sVerticalImageCount.
  348. </remarks>
  349. </member>
  350. <member name="M:Dynamsoft.Forms.DSViewer.SetViewMode(System.Int16,System.Int16)">
  351. <summary>
  352. Sets the view mode that images are displayed in the viewer. You can use this method to display multiple images in the viewer.
  353. </summary>
  354. <param name="sHorizontalImageCount">Specifies how many columns can be displayed in the viewer.</param>
  355. <param name="sVerticalImageCount">Specifies how many rows can be displayed in the viewer.</param>
  356. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  357. When an error occurs, please check ViewerException.
  358. </exception>
  359. <remarks>The default value is 1 by 1.
  360. When the view mode is set to -1 by -1, the viewer only shows the current image and no scroll bar is provided to navigate to other images.
  361. </remarks>
  362. </member>
  363. <member name="M:Dynamsoft.Forms.DSViewer.SetSelectionRectPosition(System.Int16,System.Int32,System.Int32,System.Int32,System.Int32)">
  364. <summary>
  365. Programmatically selects an area or resizes the selection rectangle.
  366. Note: To enable this function, MouseShape property should be set to false.
  367. </summary>
  368. <param name="sImageIndex">Specifies the index of the image in buffer.</param>
  369. <param name="iLeft">The X axis of the left border.</param>
  370. <param name="iTop">The Y axis of the top border.</param>
  371. <param name="iRight">The X axis of the right border.</param>
  372. <param name="iBottom">The Y axis of the bottom border.</param>
  373. <returns>
  374. Returns a boolean value that indicates whether the operation succeeds or not.
  375. </returns>
  376. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  377. When an error occurs, please check ViewerException.
  378. </exception>
  379. </member>
  380. <member name="M:Dynamsoft.Forms.DSViewer.GetSelectionRect(System.Int16)">
  381. <summary>
  382. Gets the selected area on the specified image in buffer.
  383. </summary>
  384. <param name="sImageIndex">Specifies the index of the image in buffer.</param>
  385. <returns>Returns a Rectangle value that indicates the selected area. Rectangle.Empty means that no area is selected on the specified index image.</returns>
  386. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  387. When an error occurs, please check ViewerException.
  388. </exception>
  389. </member>
  390. <member name="M:Dynamsoft.Forms.DSViewer.ClearSelectionRect(System.Int16)">
  391. <summary>
  392. Clears the selected area on the specified image in buffer.
  393. </summary>
  394. <param name="sImageIndex">Specifies the index of the image in buffer.</param>
  395. <returns>Returns a boolean value that indicates whether the operation succeeds or not.</returns>
  396. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  397. When an error occurs, please check ViewerException.
  398. </exception>
  399. </member>
  400. <member name="M:Dynamsoft.Forms.DSViewer.Bind(Dynamsoft.Core.ImageCore)">
  401. <summary>
  402. Binds Viewer module with ImageCore module.
  403. </summary>
  404. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  405. When an error occurs, please check ViewerException.
  406. </exception>
  407. <remarks>
  408. Once the bind function is called, the image in the buffer will be automatically loaded into the viewer.
  409. </remarks>
  410. </member>
  411. <member name="M:Dynamsoft.Forms.DSViewer.Picture(System.Int16)">
  412. <summary>
  413. Returns the picture object of the image of a specified index in buffer.
  414. </summary>
  415. <param name="sIndex">specifies the index of the image in buffer. The index is 0-based</param>
  416. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  417. When an error occurs, please check ViewerException.
  418. </exception>
  419. <remarks>
  420. The picture property implements the iPictureDisp interface.
  421. </remarks>
  422. </member>
  423. <member name="E:Dynamsoft.Forms.DSViewer.OnImageAreaDeselected">
  424. <summary>
  425. This event is triggered when the selected area of the specified image is deselected.
  426. </summary>
  427. </member>
  428. <member name="E:Dynamsoft.Forms.DSViewer.OnViewerKeyDown">
  429. <summary>
  430. The event is triggered when the keyborad button is pressed.
  431. </summary>
  432. </member>
  433. <member name="E:Dynamsoft.Forms.DSViewer.OnImageAreaSelected">
  434. <summary>
  435. This event is triggered when an area of the specified image is selected.
  436. </summary>
  437. </member>
  438. <member name="E:Dynamsoft.Forms.DSViewer.OnMouseClick">
  439. <summary>
  440. This event is triggered when the mouse clicks on an image.
  441. </summary>
  442. </member>
  443. <member name="E:Dynamsoft.Forms.DSViewer.OnMouseDoubleClick">
  444. <summary>
  445. This event is triggered when the mouse double clicks on an image.
  446. </summary>
  447. </member>
  448. <member name="E:Dynamsoft.Forms.DSViewer.OnMouseMove">
  449. <summary>
  450. This event is triggered when the mouse moves onto an image.
  451. </summary>
  452. </member>
  453. <member name="E:Dynamsoft.Forms.DSViewer.OnMouseRightClick">
  454. <summary>
  455. This event is triggered when the mouse right clicks on an image.
  456. </summary>
  457. </member>
  458. <member name="E:Dynamsoft.Forms.DSViewer.OnTopImageInTheViewChanged">
  459. <summary>
  460. This event is triggered when the current top image displayed in the viewer is changed and the view mode is NOT set to -1 by -1.
  461. </summary>
  462. </member>
  463. <member name="P:Dynamsoft.Forms.DSViewer.SelectionRectAspectRatio">
  464. <summary>
  465. Returns or sets the selection rectangle aspect ratio. The ratio refers to width/height (e.g. to keep width/height = 3/2, please set the ratio to 1.5).
  466. This is a runtime property.
  467. </summary>
  468. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  469. When an error occurs, please checkViewerException.
  470. </exception>
  471. <remarks>
  472. Please make sure the value is 0 or positive number. 0 means no limitation on the aspect ratio.
  473. </remarks>
  474. </member>
  475. <member name="P:Dynamsoft.Forms.DSViewer.MouseShape">
  476. <summary>
  477. Returns or sets the shape of the mouse.
  478. </summary>
  479. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  480. When an error occurs, please check ViewerException.
  481. </exception>
  482. <remarks>
  483. When the value of the property is set to true, the cursor is set as a hand. If the width or height of the image is bigger than the control size, scroll bars will be shown and you can drag the image to adjust the position in the control.
  484. When the value of the property is set to false, the cursor is set as an arrow. You can select an area in the viewer directly and the OnImageAreaSelected event will be triggered.
  485. </remarks>
  486. </member>
  487. <member name="P:Dynamsoft.Forms.DSViewer.VScrollBar">
  488. <summary>
  489. Indicates whether the vertical scroll bar is visible when the images are larger than the page size.
  490. </summary>
  491. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  492. When an error occurs, please check ViewerException.
  493. </exception>
  494. <remarks>
  495. The default value is true. If the view mode is -1 * -1, please ignore this setting.
  496. </remarks>
  497. </member>
  498. <member name="P:Dynamsoft.Forms.DSViewer.SelectionImageBorderColor">
  499. <summary>
  500. Returns or sets the border color of the selected image. It is a value specifying the 32-bit ARGB value.
  501. </summary>
  502. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  503. When an error occurs, please check ViewerException.
  504. </exception>
  505. <remarks>
  506. The default value is Navy. The byte-ordering of the 32-bit ARGB value is AARRGGBB. The most significant byte (MSB),
  507. represented by AA, is the alpha component value. The second, third, and fourth bytes, represented by RR, GG, and BB,
  508. are the color components of red, green, and blue respectively.
  509. </remarks>
  510. </member>
  511. <member name="P:Dynamsoft.Forms.DSViewer.CurrentSelectedImageIndicesInBuffer">
  512. <summary>
  513. Returns or sets current selected image indices in buffer.
  514. </summary>
  515. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  516. When an error occurs, please check ViewerException.
  517. </exception>
  518. <remarks>
  519. If there is no image in buffer, the returned array count will be zero.
  520. </remarks>
  521. </member>
  522. <member name="P:Dynamsoft.Forms.DSViewer.AllowMultiSelect">
  523. <summary>
  524. Returns or sets whether multiple selection is supported. This property is invalid when the view mode is set to -1 by -1 or 1 by 1.
  525. </summary>
  526. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  527. When an error occurs, please check ViewerException.
  528. </exception>
  529. <remarks>
  530. The default value is false. If it is true, when a user selects multiple images, the CurrentImageIndexInBuffer is always the minimum
  531. index among the selected images.
  532. </remarks>
  533. </member>
  534. <member name="P:Dynamsoft.Forms.DSViewer.IfFitWindow">
  535. <summary>
  536. Returns or sets whether to resize the image to fit the size of window when the view mode is set to -1 by -1.
  537. </summary>
  538. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  539. When an error occurs, please check ViewerException.
  540. </exception>
  541. <remarks>
  542. The default value of the IfFitWindow property is true.
  543. When the value is False, the image will be displayed in its full size and scroll bars will be shown if necessary (the width or height of the image is bigger than the control size).
  544. </remarks>
  545. </member>
  546. <member name="P:Dynamsoft.Forms.DSViewer.BorderStyle">
  547. <summary>
  548. Returns or sets the border style.
  549. </summary>
  550. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  551. When an error occurs, please check ViewerException.
  552. </exception>
  553. <remarks>
  554. <list type="table">
  555. <listheader>
  556. <term>Allowed Values</term>
  557. <description>Description</description>
  558. </listheader>
  559. <item><term>None (0)</term>
  560. <description>No border</description></item>
  561. <item><term>SingleFlat (1)</term>
  562. <description>Flat border</description></item>
  563. <item><term>Single3D (2)</term>
  564. <description>3D border</description></item>
  565. </list>
  566. The default value of the BorderStyle property is None (0).
  567. This property supports changing the border style of the control instead of the border style of each image in the view mode.
  568. </remarks>
  569. </member>
  570. <member name="P:Dynamsoft.Forms.DSViewer.EnableKeyboardInteractive">
  571. <summary>
  572. Returns or sets whether or not responds to keyboard events. The events here mean those defined in the dll. For example, navigate to the next image
  573. when the "Right" key is pressed.
  574. </summary>
  575. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  576. When an error occurs, please check ViewerException.
  577. </exception>
  578. </member>
  579. <member name="P:Dynamsoft.Forms.DSViewer.FitWindowType">
  580. <summary>
  581. Returns or sets whether to resize the image to fit the image to the width or height of window. To use the property,the view mode should be set to -1 by -1.
  582. </summary>
  583. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  584. When an error occurs, please check ViewerException.
  585. </exception>
  586. <remarks>
  587. <div class="tablediv">
  588. <table>
  589. <tr valign="center">
  590. <th>Allowed Values</th>
  591. <th>Fit Window Type</th>
  592. </tr>
  593. <tr valign="center">
  594. <td>0(default)</td>
  595. <td>Fits the image to the width and height of the window</td>
  596. </tr>
  597. <tr valign="center">
  598. <td>1</td>
  599. <td>Fits the image to the height of the window</td>
  600. </tr>
  601. <tr valign="center">
  602. <td>2</td>
  603. <td>Fits the image to the width of the window</td>
  604. </tr>
  605. </table>
  606. </div>
  607. </remarks>
  608. </member>
  609. <member name="P:Dynamsoft.Forms.DSViewer.BackgroundColor">
  610. <summary>
  611. Returns or sets the background color of the main control. It is a value specifying the 32-bit ARGB value.
  612. </summary>
  613. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  614. When an error occurs, please check ViewerException.
  615. </exception>
  616. <remarks>
  617. The default value is White. The byte-ordering of the 32-bit ARGB value is AARRGGBB. The most significant byte (MSB),
  618. represented by AA, is the alpha component value. The second, third, and fourth bytes, represented by RR, GG, and BB,
  619. are the color components red, green, and blue respectively.
  620. </remarks>
  621. </member>
  622. <member name="P:Dynamsoft.Forms.DSViewer.ImageMargin">
  623. <summary>
  624. Returns or sets the margin between images when multiple images are displayed in the viewer.
  625. </summary>
  626. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  627. When an error occurs, please check ViewerException.
  628. </exception>
  629. <remarks>
  630. The default value will change automatically.
  631. </remarks>
  632. </member>
  633. <member name="P:Dynamsoft.Forms.DSViewer.Zoom">
  634. <summary>
  635. Returns or sets zoom factor for the current image. Please set the property when the view mode is set to -1 by -1. This is a runtime property.
  636. </summary>
  637. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  638. When an error occurs, please check ViewerException.
  639. </exception>
  640. <remarks>
  641. The zoom value is expressed as a percentage. The valid range is from 2 to 6500 percent (Value: 0.02 ~ 65.0); the default value is 100 percent (Value: 1.0). The zoom value can be specified before or after an image is displayed. When the zoom value is changed, the displayed image will refresh automatically.
  642. </remarks>
  643. </member>
  644. <member name="P:Dynamsoft.Forms.DSViewer.EnableInteractiveZoom">
  645. <summary>
  646. Returns or sets whether the user can zoom the image using hot key.
  647. </summary>
  648. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  649. When an error occurs, please check ViewerException.
  650. </exception>
  651. <remarks>
  652. If it is set to true. The user can use hot key like "Ctrl + Mouse Wheel" or "Alt + Mouse Wheel" to zoom in/out the image, use "+" (small keyboard) to zoom in the image, and use "-" (small keyboard) to zoom out the image.
  653. The default value of this property is true.
  654. </remarks>
  655. </member>
  656. <member name="P:Dynamsoft.Forms.DSViewer.IfPrintAnnotations">
  657. <summary>
  658. Returns or sets whether print annotations when calling print method.
  659. </summary>
  660. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  661. When an error occurs, please check ViewerException.
  662. </exception>
  663. <remarks>
  664. If the property is false(default), annotations will not be printed. If the property is true, annotations will be printed.
  665. </remarks>
  666. </member>
  667. <member name="P:Dynamsoft.Forms.DSViewer.Annotation">
  668. <summary>
  669. Gets the annotation object.
  670. </summary>
  671. <exception cref="!:Dynamsoft.Viewer.ViewerException">
  672. When an error occurs, please check ViewerException.
  673. </exception>
  674. </member>
  675. <member name="T:Dynamsoft.Forms.Controls.ImageControl">
  676. <summary>
  677. Summary description for ImageControl.
  678. </summary>
  679. </member>
  680. <member name="T:Dynamsoft.Forms.Controls.ImageWindow">
  681. <summary>
  682. Summary description for ImageWindow.
  683. </summary>
  684. </member>
  685. <member name="F:Dynamsoft.Forms.Controls.ImageWindow.components">
  686. <summary>
  687. Required designer variable.
  688. </summary>
  689. </member>
  690. <member name="M:Dynamsoft.Forms.Controls.ImageWindow.Dispose(System.Boolean)">
  691. <summary>
  692. Clean up any resources being used.
  693. </summary>
  694. </member>
  695. <member name="M:Dynamsoft.Forms.Controls.ImageWindow.InitializeComponent">
  696. <summary>
  697. Required method for Designer support - do not modify
  698. the contents of this method with the code editor.
  699. </summary>
  700. </member>
  701. <member name="F:Dynamsoft.Forms.Controls.ImageControl.components">
  702. <summary>
  703. Required designer variable.
  704. </summary>
  705. </member>
  706. <member name="M:Dynamsoft.Forms.Controls.ImageControl.Dispose(System.Boolean)">
  707. <summary>
  708. Clean up any resources being used.
  709. </summary>
  710. </member>
  711. <member name="M:Dynamsoft.Forms.Controls.ImageControl.InitializeComponent">
  712. <summary>
  713. Required method for Designer support - do not modify
  714. the contents of this method with the code editor.
  715. </summary>
  716. </member>
  717. <member name="T:Dynamsoft.Forms.Controls.ImageViewer">
  718. <summary>
  719. Summary description for ImageViewer.
  720. </summary>
  721. </member>
  722. <member name="F:Dynamsoft.Forms.Controls.ImageViewer.components">
  723. <summary>
  724. Required designer variable.
  725. </summary>
  726. </member>
  727. <member name="M:Dynamsoft.Forms.Controls.ImageViewer.Dispose(System.Boolean)">
  728. <summary>
  729. Clean up any resources being used.
  730. </summary>
  731. </member>
  732. <member name="M:Dynamsoft.Forms.Controls.ImageViewer.InitializeComponent">
  733. <summary>
  734. Required method for Designer support - do not modify
  735. the contents of this method with the code editor.
  736. </summary>
  737. </member>
  738. <member name="P:Dynamsoft.Forms.Controls.Model.ModelImageWindow.NetRectangle">
  739. <summary>
  740. Group selection rectangle. Used for drawing.
  741. http://www.google.com
  742. </summary>
  743. </member>
  744. <member name="P:Dynamsoft.Forms.Controls.Model.ModelImageWindow.DrawNetRectangle">
  745. <summary>
  746. Flas is set to true if group selection rectangle should be drawn.
  747. </summary>
  748. </member>
  749. <member name="P:Dynamsoft.Forms.Controls.Model.ModelImageWindow.ActiveTool">
  750. <summary>
  751. Active drawing tool.
  752. </summary>
  753. </member>
  754. <member name="P:Dynamsoft.Forms.Controls.Model.ModelImageWindow.ZoomX">
  755. <summary>
  756. Don't set ZoomX and ZoomY directly usually. Instead, set them with Zoom unless they need to be set different values.
  757. </summary>
  758. </member>
  759. <member name="P:Dynamsoft.Forms.Controls.Model.ModelImageWindow.ZoomY">
  760. <summary>
  761. Don't set ZoomX and ZoomY directly usually. Instead, set them with Zoom unless they need to be set different values.
  762. </summary>
  763. </member>
  764. <member name="T:Dynamsoft.Forms.Enums.EnumWndBorderStyle">
  765. <summary>
  766. Image window border style.
  767. </summary>
  768. </member>
  769. <member name="F:Dynamsoft.Forms.Enums.EnumWndBorderStyle.None">
  770. <summary>
  771. No border.
  772. </summary>
  773. </member>
  774. <member name="F:Dynamsoft.Forms.Enums.EnumWndBorderStyle.SingleFlat">
  775. <summary>
  776. Flat border.
  777. </summary>
  778. </member>
  779. <member name="F:Dynamsoft.Forms.Enums.EnumWndBorderStyle.Single3D">
  780. <summary>
  781. 3D border.
  782. </summary>
  783. </member>
  784. <member name="T:Dynamsoft.Forms.Enums.EnumFitWindowType">
  785. <summary>
  786. FitWindow type.
  787. </summary>
  788. </member>
  789. <member name="F:Dynamsoft.Forms.Enums.EnumFitWindowType.enumFitWindow">
  790. <summary>
  791. Fit the image to both the width and height of the viewer.
  792. </summary>
  793. </member>
  794. <member name="F:Dynamsoft.Forms.Enums.EnumFitWindowType.enumFitWindowHeight">
  795. <summary>
  796. Fit the image to the height of the viewer.
  797. </summary>
  798. </member>
  799. <member name="F:Dynamsoft.Forms.Enums.EnumFitWindowType.enumFitWindowWidth">
  800. <summary>
  801. Fit the image to the width of the viewer.
  802. </summary>
  803. </member>
  804. <member name="T:Dynamsoft.Forms.Enums.EnumAnnotationType">
  805. <summary>
  806. Annotation type.
  807. </summary>
  808. </member>
  809. <member name="F:Dynamsoft.Forms.Enums.EnumAnnotationType.enumText">
  810. <summary>
  811. Text annotation.
  812. </summary>
  813. </member>
  814. <member name="F:Dynamsoft.Forms.Enums.EnumAnnotationType.enumLine">
  815. <summary>
  816. Line annotation.
  817. </summary>
  818. </member>
  819. <member name="F:Dynamsoft.Forms.Enums.EnumAnnotationType.enumRectangle">
  820. <summary>
  821. Rectangle annotation.
  822. </summary>
  823. </member>
  824. <member name="F:Dynamsoft.Forms.Enums.EnumAnnotationType.enumEllipse">
  825. <summary>
  826. Ellipse annotation.
  827. </summary>
  828. </member>
  829. <member name="T:Dynamsoft.Forms.Enums.EnumTextRotate">
  830. <summary>
  831. Rotate text annotaion
  832. </summary>
  833. </member>
  834. <member name="T:Dynamsoft.Forms.Enums.ErrorCode">
  835. <summary>
  836. DynamicDotNetTWAIN error code.
  837. </summary>
  838. </member>
  839. <member name="F:Dynamsoft.Forms.Enums.ErrorCode.Succeed">
  840. <summary>
  841. Successful.
  842. </summary>
  843. </member>
  844. <member name="F:Dynamsoft.Forms.Enums.ErrorCode.TWCC_BUMMER">
  845. <summary>
  846. General error.
  847. </summary>
  848. </member>
  849. <member name="F:Dynamsoft.Forms.Enums.ErrorCode.TWCC_BADVALUE">
  850. <summary>
  851. Data parameter out of supported range.
  852. </summary>
  853. </member>
  854. <member name="F:Dynamsoft.Forms.Enums.ErrorCode.TWERR_GeneralError">
  855. <summary>
  856. General error.
  857. </summary>
  858. </member>
  859. <member name="F:Dynamsoft.Forms.Enums.ErrorCode.TWERR_CANCEL">
  860. <summary>
  861. User cancelled the operation.
  862. </summary>
  863. </member>
  864. <member name="F:Dynamsoft.Forms.Enums.ErrorCode.TWERR_INDEX">
  865. <summary>
  866. Invalid index.
  867. </summary>
  868. </member>
  869. <member name="F:Dynamsoft.Forms.Enums.ErrorCode.TWERR_VALUE">
  870. <summary>
  871. Invalid value.
  872. </summary>
  873. </member>
  874. <member name="F:Dynamsoft.Forms.Enums.ErrorCode.TWERR_BADPARAMETER">
  875. <summary>
  876. Data parameter out of supported range.
  877. </summary>
  878. </member>
  879. <member name="F:Dynamsoft.Forms.Enums.ErrorCode.TWERR_NOTSUPPORTIMAGE">
  880. <summary>
  881. This image format is not supported.
  882. </summary>
  883. </member>
  884. <member name="F:Dynamsoft.Forms.Enums.ErrorCode.TWERR_INVALIDPRINTER">
  885. <summary>
  886. Invalid image index. Original image does't exist.
  887. </summary>
  888. </member>
  889. <member name="F:Dynamsoft.Forms.Enums.ErrorCode.TWERR_PRINT_NO_PAGE">
  890. <summary>
  891. There is no page to be printed.
  892. </summary>
  893. </member>
  894. <member name="T:Dynamsoft.Forms.ViewerException">
  895. <summary>
  896. DynamicDotNetTWAIN exception class definition.
  897. </summary>
  898. </member>
  899. <member name="M:Dynamsoft.Forms.ViewerException.#ctor">
  900. <summary>
  901. Initializes a new instance of the ViewerException class.
  902. </summary>
  903. </member>
  904. <member name="M:Dynamsoft.Forms.ViewerException.#ctor(System.String)">
  905. <summary>
  906. Initializes a new instance of the ViewerException class with a specified error message.
  907. </summary>
  908. <param name="strError">The message that describes the error.</param>
  909. </member>
  910. <member name="M:Dynamsoft.Forms.ViewerException.#ctor(System.String,Dynamsoft.Forms.Enums.ErrorCode)">
  911. <summary>
  912. Initializes a new instance of the ViewerException class with a specified error message and error code.
  913. </summary>
  914. <param name="strError">The message that describes the error.</param>
  915. <param name="errCode">The error code.</param>
  916. </member>
  917. <member name="P:Dynamsoft.Forms.ViewerException.Code">
  918. <summary>
  919. Gets and sets error code.
  920. </summary>
  921. </member>
  922. <member name="P:Dynamsoft.Forms.ViewerException.Message">
  923. <summary>
  924. Gets a message that describes the current exception.
  925. </summary>
  926. </member>
  927. <member name="P:Dynamsoft.Forms.ViewerException.StackTrace">
  928. <summary>
  929. Gets a string representation of the frames on the call stack at the time the current exception was thrown.
  930. </summary>
  931. </member>
  932. <member name="T:Dynamsoft.Forms.GDI.DrawRectangle">
  933. <summary>
  934. Rectangle graphic object
  935. </summary>
  936. </member>
  937. <member name="T:Dynamsoft.Forms.GDI.DrawGDIObject">
  938. <summary>
  939. Summary description for DrawGDIObject.
  940. </summary>
  941. </member>
  942. <member name="M:Dynamsoft.Forms.GDI.DrawGDIObject.Draw(Dynamsoft.Forms.Interface.IDynamDrawContext)">
  943. <summary>
  944. Draw object
  945. </summary>
  946. <param name="g"></param>
  947. </member>
  948. <member name="M:Dynamsoft.Forms.GDI.DrawGDIObject.GetHandle(System.Int32)">
  949. <summary>
  950. Get handle point by 1-based number
  951. </summary>
  952. <param name="handleNumber"></param>
  953. <returns></returns>
  954. </member>
  955. <member name="M:Dynamsoft.Forms.GDI.DrawGDIObject.GetHandleRectangle(System.Int32)">
  956. <summary>
  957. Get handle rectangle by 1-based number
  958. </summary>
  959. <param name="handleNumber"></param>
  960. <returns></returns>
  961. </member>
  962. <member name="M:Dynamsoft.Forms.GDI.DrawGDIObject.DrawTracker(Dynamsoft.Forms.Interface.IDynamDrawContext)">
  963. <summary>
  964. Draw tracker for selected object
  965. </summary>
  966. <param name="g"></param>
  967. </member>
  968. <member name="M:Dynamsoft.Forms.GDI.DrawGDIObject.HitTest(System.Drawing.Point)">
  969. <summary>
  970. Hit test.
  971. Return value: -1 - no hit
  972. 0 - hit anywhere
  973. > 1 - handle number
  974. </summary>
  975. <param name="point"></param>
  976. <returns></returns>
  977. </member>
  978. <member name="M:Dynamsoft.Forms.GDI.DrawGDIObject.PointInObject(System.Drawing.Point)">
  979. <summary>
  980. Test whether point is inside of the object
  981. </summary>
  982. <param name="point"></param>
  983. <returns></returns>
  984. </member>
  985. <member name="M:Dynamsoft.Forms.GDI.DrawGDIObject.GetHandleCursor(System.Int32)">
  986. <summary>
  987. Get curesor for the handle
  988. </summary>
  989. <param name="handleNumber"></param>
  990. <returns></returns>
  991. </member>
  992. <member name="M:Dynamsoft.Forms.GDI.DrawGDIObject.IntersectsWith(System.Drawing.Rectangle)">
  993. <summary>
  994. Test whether object intersects with rectangle
  995. </summary>
  996. <param name="rectangle"></param>
  997. <returns></returns>
  998. </member>
  999. <member name="M:Dynamsoft.Forms.GDI.DrawGDIObject.Move(System.Int32,System.Int32)">
  1000. <summary>
  1001. Move object
  1002. </summary>
  1003. <param name="deltaX"></param>
  1004. <param name="deltaY"></param>
  1005. </member>
  1006. <member name="M:Dynamsoft.Forms.GDI.DrawGDIObject.MoveHandleTo(System.Drawing.Point,System.Int32)">
  1007. <summary>
  1008. Move handle to the point
  1009. </summary>
  1010. <param name="point"></param>
  1011. <param name="handleNumber"></param>
  1012. </member>
  1013. <member name="M:Dynamsoft.Forms.GDI.DrawGDIObject.Dump">
  1014. <summary>
  1015. Dump (for debugging)
  1016. </summary>
  1017. </member>
  1018. <member name="M:Dynamsoft.Forms.GDI.DrawGDIObject.Normalize">
  1019. <summary>
  1020. Normalize object.
  1021. Call this function in the end of object resizing.
  1022. </summary>
  1023. </member>
  1024. <member name="M:Dynamsoft.Forms.GDI.DrawGDIObject.SaveToStream(System.Runtime.Serialization.SerializationInfo,System.Int32)">
  1025. <summary>
  1026. Save object to serialization stream
  1027. </summary>
  1028. <param name="info"></param>
  1029. <param name="orderNumber"></param>
  1030. </member>
  1031. <member name="M:Dynamsoft.Forms.GDI.DrawGDIObject.LoadFromStream(System.Runtime.Serialization.SerializationInfo,System.Int32)">
  1032. <summary>
  1033. Load object from serialization stream
  1034. </summary>
  1035. <param name="info"></param>
  1036. <param name="orderNumber"></param>
  1037. </member>
  1038. <member name="M:Dynamsoft.Forms.GDI.DrawGDIObject.Initialize">
  1039. <summary>
  1040. Initialization
  1041. </summary>
  1042. </member>
  1043. <member name="P:Dynamsoft.Forms.GDI.DrawGDIObject.Selected">
  1044. <summary>
  1045. Selection flag
  1046. </summary>
  1047. </member>
  1048. <member name="P:Dynamsoft.Forms.GDI.DrawGDIObject.PenColor">
  1049. <summary>
  1050. Color
  1051. </summary>
  1052. </member>
  1053. <member name="P:Dynamsoft.Forms.GDI.DrawGDIObject.PenWidth">
  1054. <summary>
  1055. Pen width
  1056. </summary>
  1057. </member>
  1058. <member name="P:Dynamsoft.Forms.GDI.DrawGDIObject.FillColor">
  1059. <summary>
  1060. Annotation fill color
  1061. </summary>
  1062. </member>
  1063. <member name="P:Dynamsoft.Forms.GDI.DrawGDIObject.TextColor">
  1064. <summary>
  1065. Annotation Text color
  1066. </summary>
  1067. </member>
  1068. <member name="P:Dynamsoft.Forms.GDI.DrawGDIObject.TextFont">
  1069. <summary>
  1070. Annotation Text Font
  1071. </summary>
  1072. </member>
  1073. <member name="P:Dynamsoft.Forms.GDI.DrawGDIObject.HandleCount">
  1074. <summary>
  1075. Number of handles
  1076. </summary>
  1077. </member>
  1078. <member name="P:Dynamsoft.Forms.GDI.DrawGDIObject.LastUsedColor">
  1079. <summary>
  1080. Last used m_color
  1081. </summary>
  1082. </member>
  1083. <member name="P:Dynamsoft.Forms.GDI.DrawGDIObject.LastUsedPenWidth">
  1084. <summary>
  1085. Last used pen width
  1086. </summary>
  1087. </member>
  1088. <member name="M:Dynamsoft.Forms.GDI.DrawRectangle.Draw(Dynamsoft.Forms.Interface.IDynamDrawContext)">
  1089. <summary>
  1090. Draw m_rcRectangle
  1091. </summary>
  1092. <param name="g"></param>
  1093. </member>
  1094. <member name="M:Dynamsoft.Forms.GDI.DrawRectangle.GetHandle(System.Int32)">
  1095. <summary>
  1096. Get handle point by 1-based number
  1097. </summary>
  1098. <param name="handleNumber"></param>
  1099. <returns></returns>
  1100. </member>
  1101. <member name="M:Dynamsoft.Forms.GDI.DrawRectangle.HitTest(System.Drawing.Point)">
  1102. <summary>
  1103. Hit test.
  1104. Return value: -1 - no hit
  1105. 0 - hit anywhere
  1106. > 1 - handle number
  1107. </summary>
  1108. <param name="point"></param>
  1109. <returns></returns>
  1110. </member>
  1111. <member name="M:Dynamsoft.Forms.GDI.DrawRectangle.GetHandleCursor(System.Int32)">
  1112. <summary>
  1113. Get cursor for the handle
  1114. </summary>
  1115. <param name="handleNumber"></param>
  1116. <returns></returns>
  1117. </member>
  1118. <member name="M:Dynamsoft.Forms.GDI.DrawRectangle.MoveHandleTo(System.Drawing.Point,System.Int32)">
  1119. <summary>
  1120. Move handle to new point (resizing)
  1121. </summary>
  1122. <param name="point"></param>
  1123. <param name="handleNumber"></param>
  1124. </member>
  1125. <member name="M:Dynamsoft.Forms.GDI.DrawRectangle.MakeSureMeetMinimumsize(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32@,System.Int32@)">
  1126. <summary>
  1127. Make sure m_rcRectangle size great than minimum size
  1128. </summary>
  1129. <param name="left"></param>
  1130. <param name="top"></param>
  1131. <param name="right"></param>
  1132. <param name="bottom"></param>
  1133. <param name="dx">return delta x</param>
  1134. <param name="dy">return delta y</param>
  1135. </member>
  1136. <member name="M:Dynamsoft.Forms.GDI.DrawRectangle.Move(System.Int32,System.Int32)">
  1137. <summary>
  1138. Move object
  1139. </summary>
  1140. <param name="deltaX"></param>
  1141. <param name="deltaY"></param>
  1142. </member>
  1143. <member name="M:Dynamsoft.Forms.GDI.DrawRectangle.Normalize">
  1144. <summary>
  1145. Normalize m_rcRectangle
  1146. </summary>
  1147. </member>
  1148. <member name="M:Dynamsoft.Forms.GDI.DrawRectangle.SaveToStream(System.Runtime.Serialization.SerializationInfo,System.Int32)">
  1149. <summary>
  1150. Save objevt to serialization stream
  1151. </summary>
  1152. <param name="info"></param>
  1153. <param name="orderNumber"></param>
  1154. </member>
  1155. <member name="M:Dynamsoft.Forms.GDI.DrawRectangle.LoadFromStream(System.Runtime.Serialization.SerializationInfo,System.Int32)">
  1156. <summary>
  1157. LOad object from serialization stream
  1158. </summary>
  1159. <param name="info"></param>
  1160. <param name="orderNumber"></param>
  1161. </member>
  1162. <member name="P:Dynamsoft.Forms.GDI.DrawRectangle.HandleCount">
  1163. <summary>
  1164. Get number of handles
  1165. </summary>
  1166. </member>
  1167. <member name="M:Dynamsoft.Forms.GDI.DrawEllipseAnnotation.Draw(Dynamsoft.Forms.Interface.IDynamDrawContext)">
  1168. <summary>
  1169. Draw m_rcRectangle
  1170. </summary>
  1171. <param name="g"></param>
  1172. </member>
  1173. <member name="T:Dynamsoft.Forms.GDI.DrawImageControl">
  1174. <summary>
  1175. Summary description for DrawImageControl.
  1176. </summary>
  1177. </member>
  1178. <member name="M:Dynamsoft.Forms.GDI.DrawImageControl.Draw(Dynamsoft.Forms.Interface.IDynamDrawContext)">
  1179. <summary>
  1180. Draw object
  1181. </summary>
  1182. <param name="g"></param>
  1183. </member>
  1184. <member name="M:Dynamsoft.Forms.GDI.DrawImageControl.GetHandle(System.Int32)">
  1185. <summary>
  1186. Get handle point by 1-based number
  1187. </summary>
  1188. <param name="handleNumber"></param>
  1189. <returns></returns>
  1190. </member>
  1191. <member name="M:Dynamsoft.Forms.GDI.DrawImageControl.GetHandleRectangle(System.Int32)">
  1192. <summary>
  1193. Get handle rectangle by 1-based number
  1194. </summary>
  1195. <param name="handleNumber"></param>
  1196. <returns></returns>
  1197. </member>
  1198. <member name="M:Dynamsoft.Forms.GDI.DrawImageControl.DrawTracker(Dynamsoft.Forms.Interface.IDynamDrawContext)">
  1199. <summary>
  1200. Draw tracker for selected object
  1201. </summary>
  1202. <param name="g"></param>
  1203. </member>
  1204. <member name="M:Dynamsoft.Forms.GDI.DrawImageControl.HitTest(System.Drawing.Point)">
  1205. <summary>
  1206. Hit test.
  1207. Return value: -1 - no hit
  1208. 0 - hit anywhere
  1209. > 1 - handle number
  1210. </summary>
  1211. <param name="point"></param>
  1212. <returns></returns>
  1213. </member>
  1214. <member name="M:Dynamsoft.Forms.GDI.DrawImageControl.PointInObject(System.Drawing.Point)">
  1215. <summary>
  1216. Test whether point is inside of the object
  1217. </summary>
  1218. <param name="point"></param>
  1219. <returns></returns>
  1220. </member>
  1221. <member name="M:Dynamsoft.Forms.GDI.DrawImageControl.GetHandleCursor(System.Int32)">
  1222. <summary>
  1223. Get curesor for the handle
  1224. </summary>
  1225. <param name="handleNumber"></param>
  1226. <returns></returns>
  1227. </member>
  1228. <member name="M:Dynamsoft.Forms.GDI.DrawImageControl.IntersectsWith(System.Drawing.Rectangle)">
  1229. <summary>
  1230. Test whether object intersects with rectangle
  1231. </summary>
  1232. <param name="rectangle"></param>
  1233. <returns></returns>
  1234. </member>
  1235. <member name="M:Dynamsoft.Forms.GDI.DrawImageControl.Move(System.Int32,System.Int32)">
  1236. <summary>
  1237. Move object
  1238. </summary>
  1239. <param name="deltaX"></param>
  1240. <param name="deltaY"></param>
  1241. </member>
  1242. <member name="M:Dynamsoft.Forms.GDI.DrawImageControl.MoveHandleTo(System.Drawing.Point,System.Int32)">
  1243. <summary>
  1244. Move handle to the point
  1245. </summary>
  1246. <param name="point"></param>
  1247. <param name="handleNumber"></param>
  1248. </member>
  1249. <member name="M:Dynamsoft.Forms.GDI.DrawImageControl.Normalize">
  1250. <summary>
  1251. Normalize object.
  1252. Call this function in the end of object resizing.
  1253. </summary>
  1254. </member>
  1255. <member name="F:Dynamsoft.Forms.GDI.DrawLineAnnotation.m_areaPath">
  1256. <summary>
  1257. Graphic objects for hit test
  1258. </summary>
  1259. </member>
  1260. <member name="M:Dynamsoft.Forms.GDI.DrawLineAnnotation.GetHandle(System.Int32)">
  1261. <summary>
  1262. Get handle point by 1-based number
  1263. </summary>
  1264. <param name="handleNumber"></param>
  1265. <returns></returns>
  1266. </member>
  1267. <member name="M:Dynamsoft.Forms.GDI.DrawLineAnnotation.HitTest(System.Drawing.Point)">
  1268. <summary>
  1269. Hit test.
  1270. Return value: -1 - no hit
  1271. 0 - hit anywhere
  1272. > 1 - handle number
  1273. </summary>
  1274. <param name="point"></param>
  1275. <returns></returns>
  1276. </member>
  1277. <member name="M:Dynamsoft.Forms.GDI.DrawLineAnnotation.Invalidate">
  1278. <summary>
  1279. Invalidate object.
  1280. When object is invalidated, path used for hit test
  1281. is released and should be created again.
  1282. </summary>
  1283. </member>
  1284. <member name="M:Dynamsoft.Forms.GDI.DrawLineAnnotation.CreateObjects">
  1285. <summary>
  1286. Create graphic objects used from hit test.
  1287. </summary>
  1288. </member>
  1289. <member name="T:Dynamsoft.Forms.GDI.DrawSelectRectangle">
  1290. <summary>
  1291. Summary description for DrawSelectRectangle.
  1292. </summary>
  1293. </member>
  1294. <member name="M:Dynamsoft.Forms.GDI.DrawSelectRectangle.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  1295. <summary>
  1296. first init the inner rectangle
  1297. </summary>
  1298. <param name="x"></param>
  1299. <param name="y"></param>
  1300. <param name="width"></param>
  1301. <param name="height"></param>
  1302. <param name="minX"></param>
  1303. <param name="maxX"></param>
  1304. <param name="minY"></param>
  1305. <param name="maxY"></param>
  1306. </member>
  1307. <member name="M:Dynamsoft.Forms.GDI.DrawSelectRectangle.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.Double)">
  1308. <summary>
  1309. Jeremy
  1310. The new constructor for drawing the select rectangle with a certain ratio
  1311. </summary>
  1312. <param name="x"></param>
  1313. <param name="y"></param>
  1314. <param name="width"></param>
  1315. <param name="height"></param>
  1316. <param name="minX"></param>
  1317. <param name="maxX"></param>
  1318. <param name="minY"></param>
  1319. <param name="maxY"></param>
  1320. <param name="keepRatio"></param>
  1321. <param name="ratio"></param>
  1322. </member>
  1323. <member name="M:Dynamsoft.Forms.GDI.DrawSelectRectangle.Draw(Dynamsoft.Forms.Interface.IDynamDrawContext)">
  1324. <summary>
  1325. Draw m_rcRectangle
  1326. </summary>
  1327. <param name="g"></param>
  1328. </member>
  1329. <member name="M:Dynamsoft.Forms.GDI.DrawSelectRectangle.SetRectangle(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  1330. <summary>
  1331. Jeremy
  1332. set the rectangle parameter with the handle number.
  1333. </summary>
  1334. <param name="x"></param>
  1335. <param name="y"></param>
  1336. <param name="width"></param>
  1337. <param name="height"></param>
  1338. <param name="handleNumber"></param>
  1339. </member>
  1340. <member name="M:Dynamsoft.Forms.GDI.DrawSelectRectangle.HitTest(System.Drawing.Point)">
  1341. <summary>
  1342. Hit test.
  1343. Return value: -1 - no hit
  1344. 0 - hit anywhere
  1345. > 1 - handle number
  1346. </summary>
  1347. <param name="point"></param>
  1348. <returns></returns>
  1349. </member>
  1350. <member name="M:Dynamsoft.Forms.GDI.DrawSelectRectangle.MoveHandleTo(System.Drawing.Point,System.Int32)">
  1351. <summary>
  1352. Move handle to new point (resizing)
  1353. </summary>
  1354. <param name="point"></param>
  1355. <param name="handleNumber"></param>
  1356. </member>
  1357. <member name="M:Dynamsoft.Forms.GDI.DrawSelectRectangle.Move(System.Int32,System.Int32)">
  1358. <summary>
  1359. Move object
  1360. </summary>
  1361. <param name="deltaX"></param>
  1362. <param name="deltaY"></param>
  1363. </member>
  1364. <member name="M:Dynamsoft.Forms.GDI.DrawSelectRectangle.NormalizeRatio(System.Int32)">
  1365. <summary>
  1366. Jeremy
  1367. normalize the ratio when the new rectangle is to be drawed with a certain ratio
  1368. </summary>
  1369. <param name="handleNumber"></param>
  1370. </member>
  1371. <member name="T:Dynamsoft.Forms.GDI.DrawTextBox">
  1372. <summary>
  1373. Summary description for TextBoxEx.
  1374. </summary>
  1375. </member>
  1376. <member name="M:Dynamsoft.Forms.GDI.DrawTextBox.#ctor(System.Windows.Forms.TextBox,Dynamsoft.Forms.Interface.IImageWindow,System.Int32,System.Int32,System.Int32,System.Int32)">
  1377. <summary>
  1378. Construct TextBox take a <see cref="T:System.Windows.Forms.TextBox"/> <seealso cref="!:"/>
  1379. <paramref name=""/>
  1380. <list type="Table"/>
  1381. <listheader></listheader>
  1382. </summary>
  1383. <param name="tb"></param>
  1384. <param name="x"></param>
  1385. <param name="y"></param>
  1386. <param name="width"></param>
  1387. <param name="height"></param>
  1388. <example>
  1389. <code>
  1390. </code>
  1391. </example>
  1392. </member>
  1393. <member name="M:Dynamsoft.Forms.GDI.DrawTextBox.GetFirstCharIndexOfLine(System.Int32)">
  1394. <summary>
  1395. Get first char index of the specified line
  1396. </summary>
  1397. <example>The following is an example of initializing a
  1398. <c>DocumentationSample</c> type:
  1399. <code>
  1400. // Create the type.
  1401. DocumentationSample ds = new DocumentationSample();
  1402. if ( null == ds )
  1403. return;
  1404. return ds.MyMethod( ?someString? );
  1405. </code>
  1406. </example>
  1407. <param name="someValue">
  1408. A <see cref="T:System.String"/> type representing a value.
  1409. </param>
  1410. <exception cref="T:System.ArgumentNullException">
  1411. if <paramref name="someValue"/> is <c><I><B>null pointer</B></I></c>.
  1412. </exception>
  1413. <exception cref="T:System.ArgumentException">
  1414. if <paramref name="someValue"/> is <c>empty</c>.
  1415. </exception>
  1416. <param name="line">line index in TextBox, A <see cref="!:TwainWnd"/> type </param>
  1417. <returns>char index</returns>
  1418. </member>
  1419. <member name="M:Dynamsoft.Forms.GDI.DrawTextBox.GetLineFromCharIndex(System.Int32)">
  1420. <summary>
  1421. Get line index from the specified char index
  1422. </summary>
  1423. <param name="index">char index in TextBox</param>
  1424. <returns>line index</returns>
  1425. </member>
  1426. <member name="M:Dynamsoft.Forms.GDI.DrawTextBox.GetLineCount">
  1427. <summary>
  1428. Get total lines count
  1429. </summary>
  1430. <returns>total lines count</returns>
  1431. </member>
  1432. <member name="T:Dynamsoft.Forms.GDI.DrawTool">
  1433. <summary>
  1434. Base class for all drawing tools
  1435. </summary>
  1436. </member>
  1437. <member name="M:Dynamsoft.Forms.GDI.DrawTool.OnMouseDown(Dynamsoft.Forms.Interface.IImageWindow,Dynamsoft.Forms.DynamType.MouseEventArgs)">
  1438. <summary>
  1439. Left nous button is pressed
  1440. </summary>
  1441. <param name="drawArea"></param>
  1442. <param name="e"></param>
  1443. </member>
  1444. <member name="M:Dynamsoft.Forms.GDI.DrawTool.OnMouseMove(Dynamsoft.Forms.Interface.IImageWindow,Dynamsoft.Forms.DynamType.MouseEventArgs)">
  1445. <summary>
  1446. Mouse is moved, left mouse button is pressed or none button is pressed
  1447. </summary>
  1448. <param name="drawArea"></param>
  1449. <param name="e"></param>
  1450. </member>
  1451. <member name="M:Dynamsoft.Forms.GDI.DrawTool.OnMouseUp(Dynamsoft.Forms.Interface.IImageWindow,Dynamsoft.Forms.DynamType.MouseEventArgs)">
  1452. <summary>
  1453. Left mouse button is released
  1454. </summary>
  1455. <param name="drawArea"></param>
  1456. <param name="e"></param>
  1457. </member>
  1458. <member name="T:Dynamsoft.Forms.GDI.DrawToolObject">
  1459. <summary>
  1460. Base class for all tools which create new graphic object
  1461. </summary>
  1462. </member>
  1463. <member name="M:Dynamsoft.Forms.GDI.DrawToolObject.SetObject(Dynamsoft.Forms.Interface.IImageWindow,Dynamsoft.Forms.GDI.DrawGDIObject)">
  1464. <summary>
  1465. Add new object to draw area.
  1466. Function is called when user left-clicks draw area,
  1467. and one of ToolObject-derived tools is active.
  1468. </summary>
  1469. <param name="drawArea"></param>
  1470. <param name="o"></param>
  1471. </member>
  1472. <member name="M:Dynamsoft.Forms.GDI.DrawToolObject.OnMouseUp(Dynamsoft.Forms.Interface.IImageWindow,Dynamsoft.Forms.DynamType.MouseEventArgs)">
  1473. <summary>
  1474. Left mouse is released.
  1475. New object is created and resized.
  1476. </summary>
  1477. <param name="drawArea"></param>
  1478. <param name="e"></param>
  1479. </member>
  1480. <member name="P:Dynamsoft.Forms.GDI.DrawToolObject.Cursor">
  1481. <summary>
  1482. Tool m_cursor.
  1483. </summary>
  1484. </member>
  1485. <member name="P:Dynamsoft.Forms.GDI.DrawToolObject.PenColor">
  1486. <summary>
  1487. Color
  1488. </summary>
  1489. </member>
  1490. <member name="P:Dynamsoft.Forms.GDI.DrawToolObject.PenWidth">
  1491. <summary>
  1492. Pen width
  1493. </summary>
  1494. </member>
  1495. <member name="T:Dynamsoft.Forms.GDI.DrawToolPointer">
  1496. <summary>
  1497. Pointer tool
  1498. </summary>
  1499. </member>
  1500. <member name="M:Dynamsoft.Forms.GDI.DrawToolPointer.OnMouseDown(Dynamsoft.Forms.Interface.IImageWindow,Dynamsoft.Forms.DynamType.MouseEventArgs)">
  1501. <summary>
  1502. Left mouse button is pressed
  1503. </summary>
  1504. <param name="imgWindow"></param>
  1505. <param name="e"></param>
  1506. </member>
  1507. <member name="M:Dynamsoft.Forms.GDI.DrawToolPointer.OnMouseMove(Dynamsoft.Forms.Interface.IImageWindow,Dynamsoft.Forms.DynamType.MouseEventArgs)">
  1508. <summary>
  1509. Mouse is moved.
  1510. None button is pressed, ot left button is pressed.
  1511. </summary>
  1512. <param name="imgWindow"></param>
  1513. <param name="e"></param>
  1514. </member>
  1515. <member name="M:Dynamsoft.Forms.GDI.DrawToolPointer.OnMouseUp(Dynamsoft.Forms.Interface.IImageWindow,Dynamsoft.Forms.DynamType.MouseEventArgs)">
  1516. <summary>
  1517. Right mouse button is released
  1518. </summary>
  1519. <param name="imgWindow"></param>
  1520. <param name="e"></param>
  1521. </member>
  1522. <member name="M:Dynamsoft.Forms.GDI.DrawToolTextBox.OnMouseDown(Dynamsoft.Forms.Interface.IImageWindow,Dynamsoft.Forms.DynamType.MouseEventArgs)">
  1523. <summary>
  1524. </summary>
  1525. <param name="imgWindow"></param>
  1526. <param name="e"></param>
  1527. </member>
  1528. <member name="M:Dynamsoft.Forms.GDI.GraphicsList.Clear">
  1529. <summary>
  1530. Clear all objects in the list
  1531. </summary>
  1532. <returns>
  1533. true if at least one object is deleted
  1534. </returns>
  1535. </member>
  1536. <member name="M:Dynamsoft.Forms.GDI.GraphicsList.DeleteSelection">
  1537. <summary>
  1538. Delete selected items
  1539. </summary>
  1540. <returns>
  1541. true if at least one object is deleted
  1542. </returns>
  1543. </member>
  1544. <member name="M:Dynamsoft.Forms.GDI.GraphicsList.MoveSelectionToFront">
  1545. <summary>
  1546. Move selected items to front (beginning of the list)
  1547. </summary>
  1548. <returns>
  1549. true if at least one object is moved
  1550. </returns>
  1551. </member>
  1552. <member name="M:Dynamsoft.Forms.GDI.GraphicsList.MoveSelectionToBack">
  1553. <summary>
  1554. Move selected items to back (end of the list)
  1555. </summary>
  1556. <returns>
  1557. true if at least one object is moved
  1558. </returns>
  1559. </member>
  1560. <member name="P:Dynamsoft.Forms.GDI.GraphicsList.Count">
  1561. <summary>
  1562. Count and this [nIndex] allow to read all graphics objects
  1563. from GraphicsList in the loop.
  1564. </summary>
  1565. </member>
  1566. <member name="P:Dynamsoft.Forms.GDI.GraphicsList.SelectionCount">
  1567. <summary>
  1568. SelectedCount and GetSelectedObject allow to read
  1569. selected objects in the loop
  1570. </summary>
  1571. </member>
  1572. <member name="M:Dynamsoft.Forms.GDI.DrawRectangleAnnotation.Draw(Dynamsoft.Forms.Interface.IDynamDrawContext)">
  1573. <summary>
  1574. Draw m_rcRectangle
  1575. </summary>
  1576. <param name="g"></param>
  1577. </member>
  1578. <member name="T:Dynamsoft.Forms.Interface.ITwainEvent">
  1579. <summary>
  1580. Provides the base interface for firing DynamicDotNetTWAIN events.
  1581. </summary>
  1582. </member>
  1583. <member name="T:Dynamsoft.Forms.Interface.ICancel">
  1584. <summary>
  1585. Provides the cancel interface for event OnInternetTransferPercentage.
  1586. </summary>
  1587. </member>
  1588. <member name="P:Dynamsoft.Forms.Interface.ICancel.Cancelled">
  1589. <summary>
  1590. If you want to cancel upload or download, please set its value as true.
  1591. </summary>
  1592. </member>
  1593. <member name="T:Dynamsoft.Forms.Delegate.OnMouseClickHandler">
  1594. <summary>
  1595. Occurs when the mouse clicks on an image.
  1596. </summary>
  1597. <param name="sImageIndex">Specifies the index of image in buffer. The index is 0-based.</param>
  1598. <remarks>
  1599. Short sImageIndex >=0. When the value of sImageIndex equals -1, it indicates that no image is clicked.
  1600. </remarks>
  1601. </member>
  1602. <member name="T:Dynamsoft.Forms.Delegate.OnMouseMoveHandler">
  1603. <summary>
  1604. Occurs when the mouse moves onto an image.
  1605. </summary>
  1606. <param name="sImageIndex">Specifies the index of image in buffer. The index is 0-based.</param>
  1607. <remarks>
  1608. Short sImageIndex >=0. When the value of sImageIndex equals -1, it indicates that mouse is not on any image.
  1609. </remarks>
  1610. </member>
  1611. <member name="T:Dynamsoft.Forms.Delegate.OnMouseRightClickHandler">
  1612. <summary>
  1613. Occurs when the mouse right clicks on an image.
  1614. </summary>
  1615. <param name="sImageIndex">Specifies the index of image in buffer. The index is 0-based.</param>
  1616. <remarks>
  1617. Short sImageIndex >=0. When the value of sImageIndex equals -1, it indicates that no image is right-clicked.
  1618. </remarks>
  1619. </member>
  1620. <member name="T:Dynamsoft.Forms.Delegate.OnMouseRightClickHandlerEx">
  1621. <summary>
  1622. Occurs when the mouse right clicks on an image.
  1623. </summary>
  1624. <param name="sImageIndex">Specifies the index of image in buffer. The index is 0-based.</param>
  1625. <param name="args">Provide data for OnMouseRightClick event.</param>
  1626. <remarks>
  1627. Short sImageIndex >=0. When the value of sImageIndex equals -1, it indicates that no image is right-clicked.
  1628. </remarks>
  1629. </member>
  1630. <member name="T:Dynamsoft.Forms.Delegate.OnMouseDoubleClickHandler">
  1631. <summary>
  1632. Occurs when the mouse double clicks on an image.
  1633. </summary>
  1634. <param name="sImageIndex">Specifies the index of image in buffer. The index is 0-based.</param>
  1635. <remarks>
  1636. Short sImageIndex >=0. When the value of sImageIndex equals -1, it indicates that no image is double-clicked.
  1637. </remarks>
  1638. </member>
  1639. <member name="T:Dynamsoft.Forms.Delegate.OnTopImageInTheViewChangedHandler">
  1640. <summary>
  1641. Occurs when the current top image displayed in Dynamic .Net TWAIN is changed and the view mode is NOT set to -1 by -1.
  1642. </summary>
  1643. <param name="sImageIndex">Specifies the index of image in buffer. The index is 0-based.</param>
  1644. <remarks>
  1645. Short sImageIndex >=0.
  1646. </remarks>
  1647. </member>
  1648. <member name="T:Dynamsoft.Forms.Delegate.OnImageAreaSelectedHandler">
  1649. <summary>
  1650. Occurs when an area of the specified image is selected and the value of the <see cref="!:Dynamsoft.Form.Interface.ITwain.MouseShape"/> property is set to false.
  1651. </summary>
  1652. <param name="sImageIndex">Specifies the index of image in buffer. The index is 0-based.</param>
  1653. <param name="left">The long point number for the left side of the rectangle are the mouse selects.</param>
  1654. <param name="top">The long point number for the top side of the rectangle are the mouse selects.</param>
  1655. <param name="right">The long point number for the right side of the rectangle are the mouse selects.</param>
  1656. <param name="bottom">The long point number for the bottom side of the rectangle are the mouse selects.</param>
  1657. <remarks>
  1658. Short sImageIndex &gt;=0.
  1659. </remarks>
  1660. </member>
  1661. <member name="T:Dynamsoft.Forms.Delegate.OnImageAreaDeselectedHandler">
  1662. <summary>
  1663. Occurs when the selected area of the specified image is deselected and the value of the <see cref="!:Dynamsoft.Form.Interface.ITwain.MouseShape"/> property is set to false.
  1664. </summary>
  1665. <param name="sImageIndex">Specifies the index of image in buffer. The index is 0-based.</param>
  1666. <remarks>
  1667. Short sImageIndex &gt;=0.
  1668. </remarks>
  1669. </member>
  1670. <member name="T:Dynamsoft.Forms.Delegate.OnAnnotationSelectedHandler">
  1671. <summary>
  1672. Occurs when annotaions is selected.
  1673. </summary>
  1674. <param name="annotationGuids">The guid of the selected annotations object.</param>
  1675. </member>
  1676. <member name="T:Dynamsoft.Forms.Delegate.OnAnnotationDeselectedHandler">
  1677. <summary>
  1678. Occurs when one or more annotations is deselected.
  1679. </summary>
  1680. <param name="annotationGuids">The guid of the deselected annotation object.</param>
  1681. </member>
  1682. <member name="T:Dynamsoft.Forms.Delegate.OnAnnotationCreatedHandler">
  1683. <summary>
  1684. Occurs when an annotation is created.
  1685. </summary>
  1686. <param name="annotationGuids">The guid of the created annotation object.</param>
  1687. </member>
  1688. <member name="T:Dynamsoft.Forms.Delegate.OnAnnotationMovedHandler">
  1689. <summary>
  1690. Occurs when an annotation is moved.
  1691. </summary>
  1692. <param name="annotationGuids">The guid of the moved annotation object.</param>
  1693. </member>
  1694. <member name="T:Dynamsoft.Forms.Delegate.OnAnnotationResizedHandler">
  1695. <summary>
  1696. Occurs when an annotation is resized.
  1697. </summary>
  1698. <param name="annotationGuids">The guid of the resized annotation</param>
  1699. </member>
  1700. <member name="T:Dynamsoft.Forms.Delegate.OnAnnotationTextChangedHandler">
  1701. <summary>
  1702. Occurs when text in an annotation is changed.
  1703. </summary>
  1704. <param name="annotationGuids">The guid of the text annotation.</param>
  1705. </member>
  1706. <member name="T:Dynamsoft.Forms.Delegate.OnViewerKeyDownHandler">
  1707. <summary>
  1708. Occurs when the user clicks on the "Close" button of the Source's user interface.
  1709. </summary>
  1710. </member>
  1711. <member name="T:Dynamsoft.Forms.Interface.IViewerException">
  1712. <summary>
  1713. DynamicDotNetTWAIN exception interface definition.
  1714. </summary>
  1715. </member>
  1716. <member name="P:Dynamsoft.Forms.Interface.IViewerException.Code">
  1717. <summary>
  1718. Get exception error code.
  1719. </summary>
  1720. <returns>
  1721. Exception error code.
  1722. </returns>
  1723. </member>
  1724. <member name="P:Dynamsoft.Forms.Interface.IViewerException.Message">
  1725. <summary>
  1726. Get exception error string.
  1727. </summary>
  1728. <returns>
  1729. Exception error string.
  1730. </returns>
  1731. </member>
  1732. <member name="P:Dynamsoft.Forms.Interface.IViewerException.StackTrace">
  1733. <summary>
  1734. Get exception stack trace as string.
  1735. </summary>
  1736. <returns>
  1737. Exception stack trace.
  1738. </returns>
  1739. </member>
  1740. <member name="T:Dynamsoft.WPF.Properties.Resources">
  1741. <summary>
  1742. A strongly-typed resource class, for looking up localized strings, etc.
  1743. </summary>
  1744. </member>
  1745. <member name="P:Dynamsoft.WPF.Properties.Resources.ResourceManager">
  1746. <summary>
  1747. Returns the cached ResourceManager instance used by this class.
  1748. </summary>
  1749. </member>
  1750. <member name="P:Dynamsoft.WPF.Properties.Resources.Culture">
  1751. <summary>
  1752. Overrides the current thread's CurrentUICulture property for all
  1753. resource lookups using this strongly typed resource class.
  1754. </summary>
  1755. </member>
  1756. <member name="P:Dynamsoft.WPF.Properties.Resources.dnt_about">
  1757. <summary>
  1758. Looks up a localized resource of type System.Drawing.Bitmap.
  1759. </summary>
  1760. </member>
  1761. <member name="P:Dynamsoft.WPF.Properties.Resources.ds_logo4">
  1762. <summary>
  1763. Looks up a localized resource of type System.Drawing.Bitmap.
  1764. </summary>
  1765. </member>
  1766. <member name="P:Dynamsoft.WPF.Properties.Resources.DynamicNETTWAIN_logo">
  1767. <summary>
  1768. Looks up a localized resource of type System.Drawing.Bitmap.
  1769. </summary>
  1770. </member>
  1771. <member name="P:Dynamsoft.WPF.Properties.Resources.DynamsoftScanning">
  1772. <summary>
  1773. Looks up a localized resource of type System.Byte[].
  1774. </summary>
  1775. </member>
  1776. <member name="P:Dynamsoft.WPF.Properties.Resources.TWAINDSM">
  1777. <summary>
  1778. Looks up a localized resource of type System.Byte[].
  1779. </summary>
  1780. </member>
  1781. <member name="P:Dynamsoft.WPF.Properties.Resources.watermark_greyscale">
  1782. <summary>
  1783. Looks up a localized resource of type System.Drawing.Bitmap.
  1784. </summary>
  1785. </member>
  1786. </members>
  1787. </doc>