Dynamsoft.Twain.xml 179 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Dynamsoft.Twain</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Dynamsoft.TWAIN.Business.TwainBase">
  8. <summary>
  9. Summary description for TwainBase.
  10. </summary>
  11. </member>
  12. <member name="M:Dynamsoft.TWAIN.Business.TwainBase.SelectSourceByIndex(System.Int32)">
  13. <summary>
  14. open the data source in m_idSourceList
  15. </summary>
  16. <param name="index"></param>
  17. <returns></returns>
  18. </member>
  19. <member name="M:Dynamsoft.TWAIN.Business.TwainBase.OpenSource">
  20. <summary>
  21. open the default data source
  22. </summary>
  23. <returns></returns>
  24. </member>
  25. <member name="M:Dynamsoft.TWAIN.Business.TwainBase.OpenSourceManager">
  26. <summary>
  27. Function name: OpenSourceManager
  28. Description: Load source manager and open it
  29. Return: TRUE: successful,
  30. FALSE: failed. The client should call GetErrorCode and GetErrorString to get more information
  31. Steps: 1. load source manager
  32. 2. open it
  33. 3. populate source list
  34. Comment: there is not a callable function of LoadSourceManager
  35. </summary>
  36. <returns></returns>
  37. </member>
  38. <member name="T:Dynamsoft.TWAIN.Business.TwainOperateWrapper">
  39. <summary>
  40. Summary description for TwainOperateWrapper.
  41. </summary>
  42. </member>
  43. <member name="M:Dynamsoft.Common.CImage.Dispose">
  44. <summary>
  45. Dispose the object.
  46. </summary>
  47. <remarks><para>Frees unmanaged resources used by the object. The object becomes unusable
  48. after that.</para>
  49. <par><note>The method needs to be called only in the case if unmanaged image was allocated
  50. using <see cref="!:Create"/> method. In the case if the class instance was created using constructor,
  51. this method does not free unmanaged memory.</note></par>
  52. </remarks>
  53. </member>
  54. <member name="M:Dynamsoft.Common.CImage.Dispose(System.Boolean)">
  55. <summary>
  56. Dispose the object.
  57. </summary>
  58. <param name="disposing">Indicates if disposing was initiated manually.</param>
  59. </member>
  60. <member name="T:Dynamsoft.Common.ConstStringHelper">
  61. <summary>
  62. Summary description for ConstStringHelper.
  63. </summary>
  64. </member>
  65. <member name="T:Dynamsoft.Common.Margin">
  66. <summary>
  67. stores a set of four integers that represent the location and size of a rect.
  68. </summary>
  69. </member>
  70. <member name="P:Dynamsoft.Common.Margin.Left">
  71. <summary>
  72. Gets the x-coorindate of the upper-left corner of the rect.
  73. </summary>
  74. </member>
  75. <member name="P:Dynamsoft.Common.Margin.Top">
  76. <summary>
  77. Gets the y-coorindate of the upper-left corner of the rect.
  78. </summary>
  79. </member>
  80. <member name="P:Dynamsoft.Common.Margin.Right">
  81. <summary>
  82. Gets the y-coorindate of the bottom-right corner of the rect.
  83. </summary>
  84. </member>
  85. <member name="P:Dynamsoft.Common.Margin.Bottom">
  86. <summary>
  87. Gets the x-coorindate of the bottom-right corner of the rect.
  88. </summary>
  89. </member>
  90. <!-- Badly formed XML comment ignored for member "F:Dynamsoft.Common.SImageInfo.last_c_index" -->
  91. <member name="T:Dynamsoft.Common.Util">
  92. <summary>
  93. Summary description for Util.
  94. </summary>
  95. </member>
  96. <member name="M:Dynamsoft.Common.Util.Clone(System.Drawing.Bitmap)">
  97. <summary>
  98. Clone image.
  99. </summary>
  100. <param name="source">Source image.</param>
  101. <returns>Return clone of the source image.</returns>
  102. <remarks>The original <see cref="M:System.Drawing.Bitmap.Clone(System.Drawing.Rectangle,System.Drawing.Imaging.PixelFormat)">Bitmap.Clone()</see>
  103. does not produce the desired result - it does not create an actual clone (it does not create a copy
  104. of the image). That is why this method was implemented to provide the functionality.</remarks>
  105. </member>
  106. <member name="M:Dynamsoft.Common.Util.Clone(System.Drawing.Imaging.BitmapData)">
  107. <summary>
  108. Clone image.
  109. </summary>
  110. <param name="sourceData">Source image data.</param>
  111. <returns>Clones image from source image data. The message does not clone pallete in the
  112. case if the source image has indexed pixel format.</returns>
  113. </member>
  114. <member name="M:Dynamsoft.Common.Util.CopyUnmanagedMemory(System.IntPtr,System.IntPtr,System.Int32)">
  115. <summary>
  116. Copy block of unmanaged memory.
  117. </summary>
  118. <param name="dst">Destination pointer.</param>
  119. <param name="src">Source pointer.</param>
  120. <param name="count">Memory block's length to copy.</param>
  121. <returns>Return's value of <paramref name="dst"/> - pointer to destination.</returns>
  122. <remarks><para>This function is required because of the fact that .NET does
  123. not provide any way to copy unmanaged blocks, but provides only methods to
  124. copy from unmanaged memory to managed memory and vise versa.</para></remarks>
  125. </member>
  126. <member name="T:Dynamsoft.TWAIN.TwainManager">
  127. <summary>
  128. A class that provides functionality to get image data from all TWAIN compatible devices.
  129. </summary>
  130. </member>
  131. <member name="M:Dynamsoft.TWAIN.TwainManager.AcquireImage(Dynamsoft.TWAIN.Interface.IAcquireCallback)">
  132. <summary>
  133. Displays the source's built-in interface to acquire image.
  134. </summary>
  135. <returns>
  136. True indicates success. False indicates failure.
  137. </returns>
  138. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  139. When an error occurs, please check TwainException.
  140. </exception>
  141. <remarks>
  142. This method does the same thing as EnableSource().
  143. This method is used to help users to handle Twain-compliant image acquisition devices without knowing the terms used in Twain specification.
  144. </remarks>
  145. </member>
  146. <member name="M:Dynamsoft.TWAIN.TwainManager.CapGet">
  147. <summary>
  148. Gets the information of the capability specified by the Capability property.
  149. </summary>
  150. <returns>
  151. True indicates success. False indicates failure.
  152. </returns>
  153. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  154. When an error occurs, please check TwainException.
  155. </exception>
  156. <remarks>
  157. Please set Capability property before invoking CapGet().
  158. If only one type for the returned value of this capability is supported, there is no need to set CapType property since it will be returned from the source when CapGet() is called.
  159. </remarks>
  160. </member>
  161. <member name="M:Dynamsoft.TWAIN.TwainManager.CapGetCurrent">
  162. <summary>
  163. Returns the current value of the specified capability for the source.
  164. </summary>
  165. <returns>
  166. True indicates success. False indicates failure.
  167. </returns>
  168. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  169. When an error occurs, please check TwainException.
  170. </exception>
  171. <remarks>
  172. Please set Capability property before invoking CapGetCurrent().
  173. After calling CapGetCurrent(), please check CapType property for the type this capability supports.
  174. This process is similar to CapGet(), please refer to CapType property.
  175. </remarks>
  176. </member>
  177. <member name="M:Dynamsoft.TWAIN.TwainManager.CapGetDefault">
  178. <summary>
  179. Returns the default value for the specified capability of the source.
  180. </summary>
  181. <returns>
  182. True indicates success. False indicates failure.
  183. </returns>
  184. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  185. When an error occurs, please check TwainException.
  186. </exception>
  187. <remarks>
  188. Please set Capability property before invoking CapGetDefault().
  189. </remarks>
  190. </member>
  191. <member name="M:Dynamsoft.TWAIN.TwainManager.CapIfSupported(Dynamsoft.TWAIN.Enums.TWQC)">
  192. <summary>
  193. Checks if the source supports a particular operation of the capability.
  194. </summary>
  195. <param name="enumMessageType">
  196. TWQC type: specifies the type of capability operation.
  197. Value Description
  198. TWQC_GET (1): If CapGet() is supported by the capability.
  199. TWQC_SET (2): If CapSet() is supported by the capability.
  200. TWQC_GETDEFAULT (4): If CapGetDefault() is supported by the capability.
  201. TWQC_GETCURRENT (8): If CapGetCurrent() is supported by the capability.
  202. TWQC_RESET (16): If CapReset() is supported by the capability.
  203. </param>
  204. <returns>
  205. True indicates success. False indicates failure.
  206. </returns>
  207. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  208. When an error occur, please check TwainException.
  209. </exception>
  210. <remarks>
  211. Please set Capability property before calling CapIfSupported().
  212. </remarks>
  213. </member>
  214. <member name="M:Dynamsoft.TWAIN.TwainManager.CapReset">
  215. <summary>
  216. Resets the current capability.
  217. </summary>
  218. <returns>True indicates success. False indicates failure.</returns>
  219. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  220. When an error occurs, please check TwainException.
  221. </exception>
  222. <remarks>
  223. Please set Capability property before invoking CapReset.
  224. </remarks>
  225. </member>
  226. <member name="M:Dynamsoft.TWAIN.TwainManager.CapSet">
  227. <summary>
  228. Sets the detailed information of the specified capability.
  229. </summary>
  230. <returns>
  231. True indicates success. False indicates failure.
  232. </returns>
  233. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  234. When an error occurs, please check TwainException.
  235. </exception>
  236. <remarks>
  237. Please refer to How to Negotiate Capability with Different Capability Container Types for details.
  238. </remarks>
  239. </member>
  240. <member name="M:Dynamsoft.TWAIN.TwainManager.CapSetFrame(System.Int32,Dynamsoft.Common.Margin)">
  241. <summary>
  242. Sets the values of the specified frame.
  243. </summary>
  244. <param name="iIndex">
  245. Specifies which frame to set. The index is 0-based.
  246. </param>
  247. <param name="fLeft">
  248. Specifies the value (in ICAP_UNITS) of the left edge of the specified frame.
  249. </param>
  250. <param name="fTop">
  251. Specifies the value (in ICAP_UNITS) of the top edge of the specified frame.
  252. </param>
  253. <param name="fRight">
  254. Specifies the value (in ICAP_UNITS) of the right edge of the specified frame.
  255. </param>
  256. <param name="fBottom">
  257. Specifies the value (in ICAP_UNITS) of the bottom edge of the specified frame.
  258. </param>
  259. <returns>
  260. True indicates success. False indicates failure.
  261. </returns>
  262. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  263. When an error occurs, please check TwainException.
  264. </exception>
  265. <remarks>
  266. The default unit is "inches" unless it has been otherwise negotiated between the application and the source.
  267. </remarks>
  268. </member>
  269. <member name="M:Dynamsoft.TWAIN.TwainManager.CloseSource">
  270. <summary>
  271. Closes Data Source.
  272. </summary>
  273. <returns>
  274. True indicates success. False indicates failure.
  275. </returns>
  276. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  277. When an error occurs, please check TwainException.
  278. </exception>
  279. <remarks>
  280. CloseSource() will be called automatically when exiting the application since Dynamic .NET TWAIN has a built-in Wizard Mode.
  281. </remarks>
  282. </member>
  283. <member name="M:Dynamsoft.TWAIN.TwainManager.CloseSourceManager">
  284. <summary>
  285. Closes and unloads Data Source Manager.
  286. </summary>
  287. <returns>
  288. True indicates success. False indicates failure.
  289. </returns>
  290. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  291. When an error occurs, please check TwainException.
  292. </exception>
  293. <remarks>
  294. CloseSourceManager() will be called automatically when exiting the application if it is not called explicitly by the application.
  295. </remarks>
  296. </member>
  297. <member name="M:Dynamsoft.TWAIN.TwainManager.DisableSource">
  298. <summary>
  299. Disables the source. If the source's user interface is displayed when the source is enabled, it will be closed.
  300. </summary>
  301. <returns>
  302. True indicates success. False indicates failure.
  303. </returns>
  304. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  305. When an error occurs, please check TwainException.
  306. </exception>
  307. <remarks>
  308. After DisableSource() is called, the Source will be in State 4(Source is opened but not enabled) where you can do capability negotiationn.
  309. </remarks>
  310. </member>
  311. <member name="M:Dynamsoft.TWAIN.TwainManager.EnableSource(Dynamsoft.TWAIN.Interface.IAcquireCallback)">
  312. <summary>
  313. Enables the source which means start the scanning process.
  314. </summary>
  315. <returns>
  316. True indicates success. False indicates failure.
  317. </returns>
  318. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  319. When an error occurs, please check TwainException.
  320. </exception>
  321. modified by soul/Vincy
  322. </member>
  323. <member name="M:Dynamsoft.TWAIN.TwainManager.FeedPage">
  324. <summary>
  325. Ejects the current page and begins scanning the next page in the document feeder.
  326. </summary>
  327. <returns>
  328. True indicates success. False indicates failure.
  329. </returns>
  330. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  331. When an error occurs, please check TwainException.
  332. </exception>
  333. <remarks>
  334. Please set this method after opening the Data Source (see OpenSource() method) and IfFeederEnabled property is set to true.
  335. </remarks>
  336. </member>
  337. <member name="M:Dynamsoft.TWAIN.TwainManager.OpenSource">
  338. <summary>
  339. Loads the currently selected source into main memory and initialize it for image acquisition.
  340. If no source is specified (neither SelectSource() nor SelectSourceByIndex() has been called), the default source will be loaded.
  341. </summary>
  342. <returns>True indicates success. False indicates failure. </returns>
  343. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  344. When an error occurs, please check TwainException.
  345. </exception>
  346. <remarks>
  347. OpenSource() should be called before capability negotiation.
  348. The capability is available after OpenSource is called.
  349. </remarks>
  350. modified by soul/Vincy
  351. </member>
  352. <member name="M:Dynamsoft.TWAIN.TwainManager.SetOpenSourceTimeout(System.Int32)">
  353. <summary>
  354. Set the time-out used to open a specified Data Source.
  355. </summary>
  356. <param name="iMilliseconds"></param>
  357. </member>
  358. <member name="M:Dynamsoft.TWAIN.TwainManager.OpenSourceManager">
  359. <summary>
  360. Loads and opens Data Source Manager.
  361. </summary>
  362. <returns>
  363. True indicates success. False indicates failure.
  364. </returns>
  365. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  366. When an error occurs, please check TwainException.
  367. </exception>
  368. <remarks>
  369. If application identification information needs to be set, it should be set before OpenSourceManager().
  370. Dynamic .NET TWAIN has a built-in Wizard Mode. With Wizard Mode, OpenSourceManager() is called automatically when needed by methods like EnableSource() or SelectSource().
  371. OpenSourceManager() populates Source NameItems property with a list of installed sources. SourceNameItems property along with other properties and methods can be used to customize source selection interface.
  372. </remarks>
  373. </member>
  374. <member name="M:Dynamsoft.TWAIN.TwainManager.ResetImageLayout">
  375. <summary>
  376. Resets the image layout in the Data Source to default.
  377. </summary>
  378. <returns>True indicates success. False indicates failure. </returns>
  379. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  380. When an error occurs, please check TwainException.
  381. </exception>
  382. </member>
  383. <member name="M:Dynamsoft.TWAIN.TwainManager.RewindPage">
  384. <summary>
  385. If IfFeederEnabled is true, the source will return the current page to the input side of the document feeder and feed the last page from the outside of the feeder back into the acquisition area.
  386. </summary>
  387. <returns>
  388. True indicates success. False indicates failure.
  389. </returns>
  390. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  391. When an error occurs, please check TwainException.
  392. </exception>
  393. </member>
  394. <member name="M:Dynamsoft.TWAIN.TwainManager.SelectSource">
  395. <summary>
  396. Brings up the TWAIN Data Source Manager's Source Selection User Interface (UI) so that the user can choose which Data Source to be the current Source.
  397. </summary>
  398. <returns>True indicates success. False indicates failure.</returns>
  399. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  400. When an error occurs, please check TwainException.
  401. </exception>
  402. // modified by soul/Vincy
  403. </member>
  404. <member name="M:Dynamsoft.TWAIN.TwainManager.SelectSourceByIndex(System.Int32)">
  405. <summary>
  406. Selects a Data Source by its index in the Data Source Managet.
  407. </summary>
  408. <param name="iIndex">int iIndex. It is the index of the target Data Source in SourceNameItems property.</param>
  409. <returns>True indicates success. False indicates failure.</returns>
  410. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  411. When an error occurs, please check TwainException.
  412. </exception>
  413. <remarks>
  414. The index is 0-based.
  415. </remarks>
  416. </member>
  417. <!-- Badly formed XML comment ignored for member "M:Dynamsoft.TWAIN.TwainManager.SetFileXFERInfo(System.String,Dynamsoft.TWAIN.Enums.TWICapFileFormat)" -->
  418. <member name="M:Dynamsoft.TWAIN.TwainManager.SetImageLayout(Dynamsoft.Common.Margin)">
  419. <summary>
  420. Sets the left, top, right, and bottom sides of the image layout rectangle for the current Data Source. In other words, sets which area will be scanned.
  421. </summary>
  422. <param name="fLeft">Float fLeft: specifies the floating-point number for the left side of the image layout rectangle.</param>
  423. <param name="fTop">Float fTop: specifies the floating-point number for the top side of the image layout rectangle.</param>
  424. <param name="fRight">Float fRight: specifies the floating-point number for the right side of the image layout rectangle.</param>
  425. <param name="fBottom">Float fBottom: specifies the floating-point number for the bottom side of the image layout rectangle.</param>
  426. <returns>True indicates success. False indicates failure.</returns>
  427. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  428. When an error occurs, please check TwainException.
  429. </exception>
  430. <remarks>The image layout rectangle defines what portion of the Data Source's scanning area is acquired. Please set unit property before using this method</remarks>
  431. </member>
  432. <member name="M:Dynamsoft.TWAIN.TwainManager.LoadCustomDSData(System.String)">
  433. <summary>
  434. Loads the configurations of the source's users interface saved by SaveCustomDSData or SaveCustomDSDataEx.
  435. </summary>
  436. <param name="strFileName">The path of the file used for storing custom Data Source data.e.g."C:\\webtwain.jpg"
  437. </param>
  438. <returns>
  439. True indicates success. False indicates failure.
  440. </returns>
  441. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  442. When an error occurs, please check TwainException.
  443. </exception>
  444. <remarks>
  445. You can set IfShowUI to true to display the user interface of the source.
  446. </remarks>
  447. </member>
  448. <member name="M:Dynamsoft.TWAIN.TwainManager.LoadCustomDSDataEx(System.Byte[])">
  449. <summary>
  450. Loads the configurations of the source's users interface saved by SaveCustomDSData or SaveCustomDSDataEx.
  451. </summary>
  452. <param name="bytData">The string of the file which represents the custom Data Source data.
  453. </param>
  454. <returns>
  455. True indicates success. False indicates failure.
  456. </returns>
  457. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  458. When an error occurs, please check TwainException.
  459. </exception>
  460. <remarks>
  461. You can set IfShowUI to true to display the user interface of the source.
  462. </remarks>
  463. </member>
  464. <member name="M:Dynamsoft.TWAIN.TwainManager.SaveCustomDSData(System.String)">
  465. <summary>
  466. Saves the settings of the source's user interface.
  467. </summary>
  468. <param name="strSaveFileName">The absolute path of the file where the custom Data Source data is stored.
  469. </param>
  470. <returns>
  471. True indicates success. False indicates failure.
  472. </returns>
  473. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  474. When an error occurs, please check TwainException.
  475. </exception>
  476. <remarks>
  477. You can set IfShowUI to true to display the user interface of the source.
  478. After saving the settings of the UI, you can use LoadCustomDSData or LoadCustomDSDataEx to restore the configurations.
  479. </remarks>
  480. </member>
  481. <member name="M:Dynamsoft.TWAIN.TwainManager.SaveCustomDSDataEx(System.Byte[]@)">
  482. <summary>
  483. Saves the settings of the source's user interface.
  484. </summary>
  485. <param name="bytData">The string of the file which represents the custom Data Source data.
  486. </param>
  487. <returns>
  488. True indicates success. False indicates failure.
  489. </returns>
  490. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  491. When an error occurs, please check TwainException.
  492. </exception>
  493. <remarks>
  494. You can set IfShowUI to true to display the user interface of the source.
  495. After saving the settings of the UI, you can use LoadCustomDSData or LoadCustomDSDataEx to restore the configurations.
  496. </remarks>
  497. </member>
  498. <member name="M:Dynamsoft.TWAIN.TwainManager.GetDefaultImageLayout">
  499. <summary>
  500. Retrieves the left, top, right, and bottom sides of the current Data Source's default image layout rectangle.
  501. </summary>
  502. <param name="fLeft">The floating-point number for the left side of the default image layout rectangle. </param>
  503. <param name="fTop">The floating-point number for the top side of the default image layout rectangle. </param>
  504. <param name="fRight">The floating-point number for the right side of the default image layout rectangle. </param>
  505. <param name="fBottom">The floating-point number for the bottom side of the default image layout rectangle. </param>
  506. <returns>
  507. True indicates success. False indicates failure.
  508. </returns>
  509. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  510. When an error occurs, please check TwainException.
  511. </exception>
  512. <remarks>
  513. The image layout rectangle defines what portion of the Data Source's scanning area is acquired.
  514. </remarks>
  515. </member>
  516. <member name="M:Dynamsoft.TWAIN.TwainManager.GetImageLayout">
  517. <summary>
  518. Retrieves the left, top, right, and bottom sides of the image layout rectangle for the current Data Source.
  519. </summary>
  520. <param name="fLeft">The floating-point number for the left side of the image layout rectangle.</param>
  521. <param name="fTop">The floating-point number for the top side of the image layout rectangle.</param>
  522. <param name="fRight">The floating-point number for the right side of the image layout rectangle.</param>
  523. <param name="fBottom">The floating-point number for the bottom side of the image layout rectangle.</param>
  524. <returns>
  525. True indicates success. False indicates failure.
  526. </returns>
  527. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  528. When an error occurs, please check TwainException.
  529. </exception>
  530. <remarks>
  531. The image layout rectangle defines the portion of the Data Source's scanning area.
  532. </remarks>
  533. </member>
  534. <member name="M:Dynamsoft.TWAIN.TwainManager.SourceNameItems(System.Int16)">
  535. <summary>
  536. Holds an array of source names.
  537. </summary>
  538. <param name="sIndex">The index is 0-based and can not be larger than SourceCount property.</param>
  539. <returns>
  540. A list of source names.
  541. </returns>
  542. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  543. When an error occurs, please check TwainException.
  544. </exception>
  545. <remarks>
  546. This property has a parameter.
  547. </remarks>
  548. </member>
  549. <member name="M:Dynamsoft.TWAIN.TwainManager.GetCapItems(System.Int32)">
  550. <summary>
  551. Returns an array of values of the capability specified by Capability property, when the value of the CapType property is TWON_ARRAY or TWON_ENUMERATION.
  552. This is a runtime property.
  553. </summary>
  554. <param name="iIndex">The index is 0-based.</param>
  555. <returns>
  556. Capability property value.
  557. </returns>
  558. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  559. When an error occurs, please check TwainException.
  560. </exception>
  561. <remarks>
  562. Please check this property after calling CapGet() method.
  563. This property has a parameter. The data type of the parameter is int and it is 0-based.
  564. The GetCapItems is used to return the result in Double, Single(Float), Long, Integer and Boolean types. To return String type, please use GetCapItemsString.
  565. When using Double type for Boolean type, 1 indicates true, 0 indicates false. The constant true/false of Visual Basic can NOT be used.
  566. This property is similar to CapValue property and CapValueString property. CapValueString property is used to present String type while CapValue is used to present other types. CapValue property and CapValueString property are used when the container type is TWON_ONEVALUE.
  567. </remarks>
  568. </member>
  569. <member name="M:Dynamsoft.TWAIN.TwainManager.SetCapItems(System.Int32,System.Double)">
  570. <summary>
  571. Sets an array of values of the capability specified by Capability property, when the value of the CapType property is TWON_ARRAY or TWON_ENUMERATION.
  572. This is a runtime property.
  573. </summary>
  574. <param name="iIndex">The index is 0-based.</param>
  575. <param name="dbValue">Capability property value.</param>
  576. <returns>
  577. True indicates success. False indicates failure.
  578. </returns>
  579. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  580. When an error occurs, please check TwainException.
  581. </exception>
  582. <remarks>
  583. After setting this property, call CapSet() method to set the value.
  584. The SetCapItems property is used to return the results of Double, Single(Float), Long, Integer and Boolean types. To return String type, please use SetCapItemsString.
  585. When using Double type for Boolean type, 1 indicates true, 0 indicates false. The constant true/false of Visual Basic can NOT be used.
  586. This property is similar to CapValue property and CapValueString property. CapValueString property is used to present String type while CapValue is used to present other types. CapValue property and CapValueString property are used when the container type is TWON_ONEVALUE.
  587. </remarks>
  588. </member>
  589. <member name="M:Dynamsoft.TWAIN.TwainManager.GetCapItemsString(System.Int32)">
  590. <summary>
  591. Returns or sets an array of values of the capability specified by Capability property, when the value of the CapType property is TWON_ARRAY or TWON_ENUMERATION.
  592. This is a runtime property.
  593. </summary>
  594. <param name="iIndex">The index is 0-based.</param>
  595. <returns>
  596. Capability property value.
  597. </returns>
  598. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  599. When an error occurs, please check TwainException.
  600. </exception>
  601. <remarks>
  602. Please check this property after calling CapGet() method.
  603. This property has a parameter. The data type of the parameter is int and it is 0-based.
  604. GetCapItemsString is used to return String values. For other data types, please use GetCapItems.
  605. </remarks>
  606. </member>
  607. <member name="M:Dynamsoft.TWAIN.TwainManager.SetCapItemsString(System.Int32,System.String)">
  608. <summary>
  609. Sets an array of values of the capability specified by Capability property, when the value of the CapType property is TWON_ARRAY or TWON_ENUMERATION.
  610. This is a runtime property.
  611. </summary>
  612. <param name="iIndex">The index is 0-based.</param>
  613. <param name="strValue">Capability property value.</param>
  614. <returns>
  615. True indicates success. False indicates failure.
  616. </returns>
  617. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  618. When an error occurs, please check TwainException.
  619. </exception>
  620. <remarks>
  621. After setting this property, please call CapSet() method to set the value.
  622. SetCapItemsString property is used to set String type values. For other data types, please use SetCapItems property.
  623. </remarks>
  624. </member>
  625. <member name="M:Dynamsoft.TWAIN.TwainManager.GetBarcodeText(System.Int32)">
  626. <summary>
  627. Gets barcode content by specified index. It's only valid in OnPostTransfer event.
  628. </summary>
  629. <param name="barcodeIndex">Specifies the index of barcode in image. The index is 0-based.</param>
  630. <returns>
  631. Barcode content.
  632. </returns>
  633. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  634. When an error occurs, please check TwainException.
  635. </exception>
  636. <remarks>
  637. An empty string will be returned if the Source doesn't support barcode detection or the image data doesn't contain barcode.
  638. GetBarcodeText method along with other properties about information of the current image is valid only in OnPostTransfer event.
  639. </remarks>
  640. </member>
  641. <member name="M:Dynamsoft.TWAIN.TwainManager.GetBarcodeInfo(Dynamsoft.TWAIN.Enums.TWEIBarcode,System.Int32)">
  642. <summary>
  643. Gets barcode type value by specified index and type. The index is 0-based. It's only valid in OnPostTransfer event.
  644. </summary>
  645. <param name="barcodeInfoType">Defined in TWAIN specification.</param>
  646. <param name="barcodeIndex">Specifies the index of barcode in image. The index is 0-based.</param>
  647. <returns>
  648. No limit
  649. </returns>
  650. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  651. When an error occurs, please check TwainException.
  652. </exception>
  653. <remarks>
  654. GetBarcodeInfo method along with other properties about information of the current image is valid only in OnPostTransfer event.
  655. </remarks>
  656. </member>
  657. <member name="M:Dynamsoft.TWAIN.TwainManager.EnableSourceUI">
  658. <summary>
  659. Displays the user interface of the source to change and save the settings for DPI, paper size, etc.
  660. </summary>
  661. <returns>
  662. True indicates success. False indicates failure.
  663. </returns>
  664. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  665. When an error occurs, please check TwainException.
  666. </exception>
  667. modified by ellie/Vincy
  668. </member>
  669. <member name="M:Dynamsoft.TWAIN.TwainManager.SetWindowHandle(System.IntPtr)">
  670. <summary>
  671. Sets an application window handle. It's not required by default. Please call it when the scanning process fails to start. e.g. ScanInNewProcess is set to false or the source is not available.
  672. </summary>
  673. <param name="handle">Application window handle</param>
  674. </member>
  675. <member name="M:Dynamsoft.TWAIN.TwainManager.ProcessMessage(System.IntPtr,System.Int32,System.IntPtr,System.IntPtr)">
  676. <summary>
  677. It's not required by default. Please call it when the scanning process fails to start. e.g. ScanInNewProcess is set to false or the source is not available.
  678. </summary>
  679. <param name="hwnd"></param>
  680. <param name="message"></param>
  681. <param name="wParam"></param>
  682. <param name="lParam"></param>
  683. <returns></returns>
  684. </member>
  685. <member name="P:Dynamsoft.TWAIN.TwainManager.BitDepth">
  686. <summary>
  687. Returns or sets the pixel bit depth for the current value of PixelType property.
  688. This is a runtime property.
  689. </summary>
  690. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  691. When an error occurs, please check TwainException.
  692. </exception>
  693. <remarks>
  694. Please set this property after calling OpenSource() method and before calling AcquireImage().
  695. This property supports 1,8,24,32bit.
  696. </remarks>
  697. </member>
  698. <member name="P:Dynamsoft.TWAIN.TwainManager.Brightness">
  699. <summary>
  700. Returns or sets the brightness for scanning by the Data Source.
  701. This is a runtime property.
  702. </summary>
  703. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  704. When an error occurs, please check TwainException.
  705. </exception>
  706. <remarks>
  707. Please set this property after calling OpenSource() method and before calling AcquireImage().
  708. </remarks>
  709. </member>
  710. <member name="P:Dynamsoft.TWAIN.TwainManager.Capability">
  711. <summary>
  712. Specifies the capability to be negotiated. This is a runtime property.
  713. </summary>
  714. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  715. When an error occurs, please check TwainException.
  716. </exception>
  717. <remarks>
  718. Prior to negotiating capability, OpenSource() needs to be called to make Dynamic .NET TWAIN ready for capability negotiation.
  719. </remarks>
  720. </member>
  721. <member name="P:Dynamsoft.TWAIN.TwainManager.CapCurrentIndex">
  722. <summary>
  723. Returns or sets the index (0-based) of the current value of a capability. It will return a list to indicate the Current Value when the value of the CapType property is TWON_ENUMERATION.
  724. If the data type of the capability is String, the list is in GetCapItemsString.
  725. For other data types, the list is in GetCapItems.
  726. This is a runtime property.
  727. </summary>
  728. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  729. When an error occurs, please check TwainException.
  730. </exception>
  731. <remarks>
  732. Please check this property after calling CapGet() method. After setting this property, you can call CapSet() method to set its value.
  733. The CapCurrentIndex property is 0-based.
  734. It is valid only when the CapType property is TWON_ENUMERATION.
  735. For information of which properties are valid for different container types, please refer to CapType property.
  736. </remarks>
  737. </member>
  738. <member name="P:Dynamsoft.TWAIN.TwainManager.CapCurrentValue">
  739. <summary>
  740. Returns or sets the current value in a range when the value of the CapType property is TWON_RANGE.
  741. This is a runtime property.
  742. </summary>
  743. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  744. When an error occurs, please check TwainException.
  745. </exception>
  746. <remarks>
  747. Please check this property after calling CapGet() method.
  748. After setting this property, you can call CapSet() method to set its value.
  749. CapCurrentValue property is valid only when the value of the CapType property is TWON_RANGE.
  750. For information of which properties are valid for different container types, please refer to CapType property.
  751. </remarks>
  752. </member>
  753. <member name="P:Dynamsoft.TWAIN.TwainManager.CapDefaultIndex">
  754. <summary>
  755. Returns the index (0-based) of the default value of a capbility. It will return a list to indicate the Default Value when the value of the CapType property is TWON_ENUMERATION. when the value of the CapType property is TWON_ENUMERATION. If the data type of the capability is String, the list is in GetCapItemsString. For other data types, the list is in GetCapItems property.
  756. This is a runtime, read-only property.
  757. </summary>
  758. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  759. When an error occurs, please check TwainException.
  760. </exception>
  761. <remarks>
  762. Please check this property after calling CapGet() method.
  763. The CapDefaultIndex property is 0-based and read-only.
  764. It is valid only when the CapType property is TWON_ENUMERATION.
  765. For information of which properties are valid for different container types, please refer to CapType property.
  766. </remarks>
  767. </member>
  768. <member name="P:Dynamsoft.TWAIN.TwainManager.CapDefaultValue">
  769. <summary>
  770. Returns the default value in a range when the value of the CapType property is TWON_RANGE.
  771. This is a runtime, read-only property.
  772. </summary>
  773. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  774. When an error occurs, please check TwainException.
  775. </exception>
  776. <remarks>
  777. Please check this property after calling CapGet() method.
  778. Default value reflects the source's power-on value. It can NOT be set.
  779. CapDefaultValue property is valid only when the value of the CapType property is TWON_RANGE.
  780. For information of which properties are valid for different container types, please refer to CapType property.
  781. </remarks>
  782. </member>
  783. <member name="P:Dynamsoft.TWAIN.TwainManager.CapMaxValue">
  784. <summary>
  785. Returns or sets the maximum value in a range when the value of the CapType property is TWON_RANGE.
  786. This is a runtime property.
  787. </summary>
  788. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  789. When an error occurs, please check TwainException.
  790. </exception>
  791. <remarks>
  792. Please check this property after calling CapGet() method. After setting this property, please call CapSet() method to set the value.
  793. CapMaxValue property is valid only when the value of the CapType property is TWON_RANGE.
  794. To see the properties valid for different container types, please refer to CapType property.
  795. </remarks>
  796. </member>
  797. <member name="P:Dynamsoft.TWAIN.TwainManager.CapMinValue">
  798. <summary>
  799. Returns or sets the minimum value in a range when the value of the CapType property is TWON_RANGE.
  800. This is a runtime property.
  801. </summary>
  802. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  803. When an error occurs, please check TwainException.
  804. </exception>
  805. <remarks>
  806. Please check this property after calling CapGet() method. After setting this property, please call CapSet() method to set the value.
  807. CapMinValue property is valid only when the value of the CapType property is TWON_RANGE.
  808. To see the properties valid for different container types, please refer to CapType property.
  809. </remarks>
  810. </member>
  811. <member name="P:Dynamsoft.TWAIN.TwainManager.CapNumItems">
  812. <summary>
  813. Returns or sets how many items are in the list when the value of the CapType property is TWON_ARRAY or TWON_ENUMERATION. For String data type, the list is in GetCapItemsString. For other data types, the list is in GetCapItems.
  814. This is a runtime property.
  815. </summary>
  816. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  817. When an error occurs, please check TwainException.
  818. </exception>
  819. <remarks>
  820. Please check this property after calling CapGet() method.
  821. After setting this property, please call CapSet() method to set the value.
  822. </remarks>
  823. </member>
  824. <member name="P:Dynamsoft.TWAIN.TwainManager.CapStepSize">
  825. <summary>
  826. Returns or sets the step size in a range when the value of the CapType property is TWON_RANGE.
  827. This is a runtime property.
  828. </summary>
  829. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  830. When an error occurs, please check TwainException.
  831. </exception>
  832. <remarks>
  833. Please read this property after calling CapGet() method. After setting this property, please call CapSet() method to set the value.
  834. CapStepSize property is valid only when the value of the CapType property is TWON_RANGE.
  835. To see the properties valid for different container types, please refer to CapType property.
  836. </remarks>
  837. </member>
  838. <member name="P:Dynamsoft.TWAIN.TwainManager.CapType">
  839. <summary>
  840. Returns or sets the type of capability container used to exchange capability information between application and source.
  841. This is a runtime property.
  842. </summary>
  843. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  844. When an error occurs, please check TwainException.
  845. </exception>
  846. <remarks>
  847. <list type="table">
  848. <listheader>
  849. <term>Allowed Values</term>
  850. <description>Description</description>
  851. </listheader>
  852. <item><term>TWON_ARRAY(3)</term>
  853. <description>
  854. An array of associated individual values.
  855. CapNumItems property, GetCapItems/SetCapItems/GetCapItemsString/SetCapItemsString methods are valid.</description></item>
  856. <item><term>TWON_ENUMERATION(4)</term>
  857. <description>A group of associated individual values. The values are ordered from the lowest to highest, but the step size between every two values might not be the same.
  858. CapNumItems property, CapCurrentIndex property, CapDefaultIndex property, GetCapItems/SetCapItems/GetCapItemsString/SetCapItemsString methods are valid.
  859. </description></item>
  860. <item><term>TWON_ONEVALUE(5)</term>
  861. <description>A single value. CapValue property and CapValueString property are valid.</description>
  862. </item>
  863. <item><term>TWON_RANGE(6)</term>
  864. <description>A range of individual values.
  865. CapMinValue property, CapMaxValue property, CapStepSize property, CapDefaultValue property and CapCurrentValue property are valid.
  866. </description></item>
  867. </list>
  868. <br/>
  869. Please set CapType when setting a capability with CapSet. Please check CapType after reading a capability by CapGet.
  870. CapDefaultIndex property and CapDefaultValue property reflect power-on values and are not available with CapSet().
  871. </remarks>
  872. </member>
  873. <member name="P:Dynamsoft.TWAIN.TwainManager.CapValueType">
  874. <summary>
  875. Returns or sets the value type for reading the value of a capability. This is a runtime property.
  876. </summary>
  877. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  878. When an error occurs, please check TwainException.
  879. </exception>
  880. <remarks>
  881. Please check this property after calling CapGet() method. After setting this property, please call CapSet() method to set the value.
  882. </remarks>
  883. </member>
  884. <member name="P:Dynamsoft.TWAIN.TwainManager.CapValue">
  885. <summary>
  886. Returns or sets the value of the capability specified by Capability property when the value of the CapType property is TWON_ONEVALUE.
  887. This is a runtime property.
  888. </summary>
  889. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  890. When an error occurs, please check TwainException.
  891. </exception>
  892. <remarks>
  893. Please check this property after calling CapGet() method. After setting this property, please call CapSet() method to set the value.
  894. The Double type of CapValue property is used to present Double, Single(Float), Long, Integer and Boolean types. For String type, please use CapValueString property.
  895. When using Double type for Boolean type, 1 indicates true, 0 indicates false. The constant true/false of Visual Basic can NOT be used.
  896. This property is similar to GetCapItems and GetCapItemsString. GetCapItemsString is used to present String type while GetCapItems is used to present other types. GetCapItems and GetCapItemsString are used when the container type is TWON_ARRAY or TWON_ENUMERATION.
  897. </remarks>
  898. </member>
  899. <member name="P:Dynamsoft.TWAIN.TwainManager.CapValueString">
  900. <summary>
  901. Returns or sets the string value for a capability when the value of the CapType property is TWON_ONEVALUE.
  902. This is a runtime property.
  903. </summary>
  904. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  905. When an error occurs, please check TwainException.
  906. </exception>
  907. <remarks>
  908. Please check this property after calling CapGet() method. After setting this property, please call CapSet() method to set the value.
  909. CapValueString property is used to set or return String type value. For any other data types when the CapType property is TWON_ONEVALUE, please use CapValue property.
  910. </remarks>
  911. </member>
  912. <member name="P:Dynamsoft.TWAIN.TwainManager.Contrast">
  913. <summary>
  914. Returns or sets the contrast of the Source.
  915. This is a runtime property.
  916. </summary>
  917. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  918. When an error occurs, please check TwainException.
  919. </exception>
  920. <remarks>
  921. Please set this property after calling OpenSource() method and before calling AcquireImage().
  922. </remarks>
  923. ??? note remove WebcamManager
  924. </member>
  925. <member name="P:Dynamsoft.TWAIN.TwainManager.CurrentSourceName">
  926. <summary>
  927. Returns the device name of the current source.
  928. This is a runtime, read-only property.
  929. </summary>
  930. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  931. When an error occurs, please check TwainException.
  932. </exception>
  933. <remarks>
  934. If no source is currently selected, CurrentSourceName property will return "".
  935. </remarks>
  936. </member>
  937. <member name="P:Dynamsoft.TWAIN.TwainManager.DataSourceStatus">
  938. <summary>
  939. Returns a value indicating the data source status.
  940. This is a runtime, read-only property.
  941. </summary>
  942. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  943. When an error occurs, please check TwainException.
  944. </exception>
  945. <remarks>
  946. Allowed values are between 0 and 3, defined in TWDataSourceStatus.
  947. 0, indicates the data source is closed.
  948. 1, indicates the data source is opened.
  949. 2, indicates the data source is enabled.
  950. 3, indicates the data source is acquiring image.
  951. </remarks>
  952. </member>
  953. <member name="P:Dynamsoft.TWAIN.TwainManager.DefaultSourceName">
  954. <summary>
  955. Returns the name of default source.
  956. This is a runtime, read-only property.
  957. </summary>
  958. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  959. When an error occurs, please check TwainException.
  960. </exception>
  961. ????
  962. </member>
  963. <member name="P:Dynamsoft.TWAIN.TwainManager.Duplex">
  964. <summary>
  965. Returns whether the source supports duplex.
  966. If yes, it further returns the level of duplex the Source supports (one pass or two pass duplex). This is a runtime, read-only property.
  967. </summary>
  968. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  969. When an error occurs, please check TwainException.
  970. </exception>
  971. <remarks>
  972. <list type="table">
  973. <listheader>
  974. <term>Values</term>
  975. <description>Duplex</description>
  976. </listheader>
  977. <item><term>0</term>
  978. <description>Duplex is not supported </description></item>
  979. <item><term>1</term>
  980. <description>1-pass duplex</description></item>
  981. <item><term>2</term>
  982. <description>2-pass duplex</description>
  983. </item>
  984. </list>
  985. Please set this property after calling OpenSource() method and before calling AcquireImage().
  986. </remarks>
  987. </member>
  988. <member name="P:Dynamsoft.TWAIN.TwainManager.IfAutoBright">
  989. <summary>
  990. Returns or sets whether to enable Auto-brightness feature for the Data Source. This is a runtime property.
  991. </summary>
  992. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  993. When an error occurs, please check TwainException.
  994. </exception>
  995. <remarks>
  996. Please set this property after calling OpenSource() method and before calling AcquireImage().
  997. </remarks>
  998. </member>
  999. <member name="P:Dynamsoft.TWAIN.TwainManager.IfAutoFeed">
  1000. <summary>
  1001. Returns or sets whether to enable the automatic document feeding process for the Data Source. This is a runtime property.
  1002. </summary>
  1003. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1004. When an error occurs, please check TwainException.
  1005. </exception>
  1006. <remarks>
  1007. If the value of this property is true, the Source will automatically feed the next page from the document feeder after the previous page is acquired.
  1008. Please set this property after opening the Data Source and checking if IfFeederEnabled property is true.
  1009. </remarks>
  1010. </member>
  1011. <member name="P:Dynamsoft.TWAIN.TwainManager.IfAutoScan">
  1012. <summary>
  1013. Returns or sets whether to enables the automatic document scanning process for the Data Source. This is a runtime property.
  1014. </summary>
  1015. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1016. When an error occurs, please check TwainException.
  1017. </exception>
  1018. <remarks>
  1019. If the value of this property is true, the Source will automatically feed the next page from the document feeder after the previous page is acquired.
  1020. Please set this property after opening the Data Source and checking if IfFeederEnabled property is true.
  1021. </remarks>
  1022. </member>
  1023. <member name="P:Dynamsoft.TWAIN.TwainManager.IfDeviceOnline">
  1024. <summary>
  1025. Returns whether the Source is attached, powered on and communicating. This is a runtime, read-only property.
  1026. </summary>
  1027. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1028. When an error occurs, please check TwainException.
  1029. </exception>
  1030. </member>
  1031. <member name="P:Dynamsoft.TWAIN.TwainManager.IfDisableSourceAfterAcquire">
  1032. <summary>
  1033. Returns or sets whether to close the User Interface after all images have been scanned and transferred. The default value of this property is false.
  1034. </summary>
  1035. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1036. When an error occurs, please check TwainException.
  1037. </exception>
  1038. <remarks>
  1039. IfShowUI IfDisableSourceAfterAcquire Actions
  1040. true false UI will be shown, one or many images will be acquired(if supported by the DataSource), UI will not be closed automatically and needs to be closed manually.
  1041. true true UI will be shown, one or many images will be acquired(if supported by the DataSource), UI will be closed automatically.
  1042. false false UI will not be shown, one or many images will be acquired(if supported by the DataSource), UI will not be closed automatically and needs to be closed manually.
  1043. false true UI will not be shown, one or many images will be acquired(if supported by the DataSource), UI will be closed automatically.
  1044. </remarks>
  1045. </member>
  1046. <member name="P:Dynamsoft.TWAIN.TwainManager.IfDuplexEnabled">
  1047. <summary>
  1048. Returns or sets whether the Source supports duplex. If true, the scanner scans both sides of a paper. Otherwise, the scanner will scan only one side of the paper. This is a runtime property.
  1049. </summary>
  1050. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1051. When an error occurs, please check TwainException.
  1052. </exception>
  1053. <remarks>
  1054. Call OpenSource() method and confirm that the duplex is supported before using this property.
  1055. </remarks>
  1056. </member>
  1057. <member name="P:Dynamsoft.TWAIN.TwainManager.IfFeederEnabled">
  1058. <summary>
  1059. Returns or sets whether the Automatic Document Feeder (ADF) is enabled. This is a runtime property.
  1060. </summary>
  1061. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1062. When an error occurs, please check TwainException.
  1063. </exception>
  1064. <remarks>
  1065. If the property is set to true, the Data Source will try acquiring images from the document feeder first and other feeder related capabilities can be used. If the value of this property is false, the Data Source will try acquiring data from the flatbed first and none of the feeder related capabilities can be used.
  1066. Call OpenSource() method before using this property.
  1067. </remarks>
  1068. </member>
  1069. <member name="P:Dynamsoft.TWAIN.TwainManager.IfFeederLoaded">
  1070. <summary>
  1071. Returns whether or not there are documents loaded in the Data Source's feeder when IfFeederEnabled and IfPaperDetectable are true. This is a runtime, read-only property.
  1072. </summary>
  1073. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1074. When an error occurs, please check TwainException.
  1075. </exception>
  1076. <remarks>
  1077. Call OpenSource() method before using this property.
  1078. </remarks>
  1079. </member>
  1080. <member name="P:Dynamsoft.TWAIN.TwainManager.IfModalUI">
  1081. <summary>
  1082. Returns or sets whether the UI (User Interface) of Source runs in modal state. The default value of this property is true.
  1083. </summary>
  1084. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1085. When an error occurs, please check TwainException.
  1086. </exception>
  1087. <remarks>
  1088. If the property is true, the TWAIN Data Source will display its User Interface in modal window when invoking AcquireImage method.
  1089. </remarks>
  1090. </member>
  1091. <member name="P:Dynamsoft.TWAIN.TwainManager.IfPaperDetectable">
  1092. <summary>
  1093. Returns whether the Source has a paper sensor that can detect documents on the ADF or Flatbed. This is a runtime, read-only property.
  1094. </summary>
  1095. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1096. When an error occurs, please check TwainException.
  1097. </exception>
  1098. <remarks>
  1099. Please set this property after calling OpenSource() method.
  1100. </remarks>
  1101. </member>
  1102. <member name="P:Dynamsoft.TWAIN.TwainManager.IfShowIndicator">
  1103. <summary>
  1104. Returns or sets whether the Source displays a progress indicator during acquisition and transfer regardless of the status of the Source's user interface. This is a runtime property.
  1105. </summary>
  1106. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1107. When an error occurs, please check TwainException.
  1108. </exception>
  1109. <remarks>
  1110. Please set this property after calling OpenSource() method and before calling AcquireImage().
  1111. </remarks>
  1112. </member>
  1113. <member name="P:Dynamsoft.TWAIN.TwainManager.IfShowUI">
  1114. <summary>
  1115. Returns or sets whether the Source displays the User Interface.
  1116. </summary>
  1117. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1118. When an error occurs, please check TwainException.
  1119. </exception>
  1120. <remarks>
  1121. If the property is true, the TWAIN Data Source will display its User Interface when invoking the AcquireImage method.
  1122. If the property is false, the Data Source UI will not be displayed and scanning will begin immediately using the current settings.
  1123. </remarks>
  1124. </member>
  1125. <member name="P:Dynamsoft.TWAIN.TwainManager.IfUIControllable">
  1126. <summary>
  1127. Returns whether the Source supports acquisitions with the UI (User Interface) disabled.
  1128. 'False' indicates that this Source can only support acquisitions with the UI enabled. This is a runtime, read-only property.
  1129. </summary>
  1130. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1131. When an error occurs, please check TwainException.
  1132. </exception>
  1133. <remarks>
  1134. Please set this property after calling OpenSource() method.
  1135. </remarks>
  1136. </member>
  1137. <member name="P:Dynamsoft.TWAIN.TwainManager.ImageBitsPerPixel">
  1138. <summary>
  1139. Returns the number of bits in each image pixel (or bit depth). This is a runtime, read-only property.
  1140. </summary>
  1141. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1142. When an error occurse, please check TwainException.
  1143. </exception>
  1144. <remarks>
  1145. BitsPerPixel of a 24-bit RGB image is 24. BitsPerPixel for an 8-bit Grayscale image is 8. BitsPerPixel for a Black and White image is 1.
  1146. ImageBitsPerPixel property along with other properties about information of the current image is valid only in OnPreTransfer and OnPostTransfer event.
  1147. </remarks>
  1148. </member>
  1149. <member name="P:Dynamsoft.TWAIN.TwainManager.ImageLayoutDocumentNumber">
  1150. <summary>
  1151. Returns the document number of the current image. This is a runtime, read-only property.
  1152. </summary>
  1153. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1154. When an error occurs, please check TwainException.
  1155. </exception>
  1156. <remarks>
  1157. Usually, increment when a group of new pages is placed into the document feeder (usually tell this has happened when the feeder empties).
  1158. ImageLayoutDocumentNumber property, along with other properties about information of the current image, is valid only in OnPreTransfer and OnPostTransfer event.
  1159. </remarks>
  1160. </member>
  1161. <member name="P:Dynamsoft.TWAIN.TwainManager.ImageLayoutFrameNumber">
  1162. <summary>
  1163. Returns the frame number of the current image. This is a runtime, read-only property.
  1164. </summary>
  1165. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1166. When an error occurs, please check TwainException.
  1167. </exception>
  1168. <remarks>
  1169. The frames are acquired from the same page. The number will be reset when a new page is acquired.
  1170. ImageLayoutFrameNumber property along with other properties about information of the current image is valid only in OnPreTransfer and OnPostTransfer event.
  1171. The frame information here is only about the current frame. To get the information about all the frames transferred in an acquire session, please use capability ICAP_FRAMES instead. Please refer to How To Negotiate ICAP_FRAMES for details and sample code.
  1172. </remarks>
  1173. </member>
  1174. <member name="P:Dynamsoft.TWAIN.TwainManager.ImageLayoutPageNumber">
  1175. <summary>
  1176. Returns the page number of the current image. This is a runtime, read-only property.
  1177. </summary>
  1178. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1179. When an error occurs, please check TwainException.
  1180. </exception>
  1181. <remarks>
  1182. This property will increase as the acquired page number increased.
  1183. ImageLayoutPageNumber property along with other properties about information of the current image is valid only in OnPreTransfer and OnPostTransfer event.
  1184. </remarks>
  1185. </member>
  1186. <member name="P:Dynamsoft.TWAIN.TwainManager.ImageLength">
  1187. <summary>
  1188. Returns the height of the image in pixel. This is a runtime, read-only property.
  1189. </summary>
  1190. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1191. When an error occurs, please check TwainException.
  1192. </exception>
  1193. <remarks>
  1194. If the Source such as handheld scanners failed to calculate the length of the image, -1 will be returned.
  1195. ImageLength property along with other properties about information of the current imag, is valid only in OnPreTransfer and OnPostTransfer event.
  1196. </remarks>
  1197. </member>
  1198. <member name="P:Dynamsoft.TWAIN.TwainManager.ImagePixelType">
  1199. <summary>
  1200. Returns the pixel type of the current image. This is a runtime, read-only property.
  1201. </summary>
  1202. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1203. When an error occurs, please check TwainException.
  1204. </exception>
  1205. <remarks>
  1206. <list type="table">
  1207. <listheader>
  1208. <term>Values</term>
  1209. <description>Description</description>
  1210. </listheader>
  1211. <item><term>TWPT_BW(0)</term>
  1212. <description>Black and White</description></item>
  1213. <item><term>TWPT_GRAY(1)</term>
  1214. <description>Grayscaled</description></item>
  1215. <item><term>TWPT_RGB(2)</term>
  1216. <description>RGB</description>
  1217. </item>
  1218. </list>
  1219. <br/>
  1220. ImagePixelType property along with other properties about information of the current image is valid only in OnPreTransfer and OnPostTransfer event.
  1221. </remarks>
  1222. </member>
  1223. <member name="P:Dynamsoft.TWAIN.TwainManager.ImageWidth">
  1224. <summary>
  1225. Returns the width of the image in pixel. This is a runtime, read-only property.
  1226. </summary>
  1227. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1228. When an error occurs, please check TwainException.
  1229. </exception>
  1230. <remarks>
  1231. If the Source such as handheld scanners failed to calculate the length of the image, -1 will be returned.
  1232. ImageWidth property along with other properties about information of the current image is valid only in OnPreTransfer and OnPostTransfer event.
  1233. </remarks>
  1234. </member>
  1235. <member name="P:Dynamsoft.TWAIN.TwainManager.ImageXResolution">
  1236. <summary>
  1237. Returns the X resolution of the current image. X resolution is the number of pixels per ICAP_UNITS in the horizontal direction. This is a runtime, read-only property.
  1238. </summary>
  1239. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1240. When an error occurs, please check TwainException.
  1241. </exception>
  1242. <remarks>
  1243. The unit of ImageXResolution property is set by ICAP_UNITS capability.
  1244. The default unit is "inches" unless it has been otherwise negotiated between the application and source.
  1245. ImageXResolution property along with other properties about information of the current image is valid only in OnPreTransfer and OnPostTransfer event.
  1246. </remarks>
  1247. </member>
  1248. <member name="P:Dynamsoft.TWAIN.TwainManager.ImageYResolution">
  1249. <summary>
  1250. Returns the Y resolution of the current image. Y resolution is the number of pixels per ICAP_UNITS in the vertical direction. This is a runtime, read-only property.
  1251. </summary>
  1252. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1253. When an error occurs, please check TwainException.
  1254. </exception>
  1255. <remarks>
  1256. The unit of ImageYResolution property is set by ICAP_UNITS capability.
  1257. The default unit is "inches" unless it has been otherwise negotiated between the application and source.
  1258. ImageYResolution property along with other properties about information of the current image is valid only in OnPreTransfer and OnPostTransfer event.
  1259. </remarks>
  1260. </member>
  1261. <member name="P:Dynamsoft.TWAIN.TwainManager.PageSize">
  1262. <summary>
  1263. Returns or sets the page size(s) the Source uses to acquire image data. This is a runtime property.
  1264. Please set the pagesize value in enum <see cref="T:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes"/>.
  1265. </summary>
  1266. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1267. When an error occurs, please check TwainException.
  1268. </exception>
  1269. <remarks>
  1270. Please set this property after calling OpenSource() method and before calling AcquireImage().
  1271. </remarks>
  1272. </member>
  1273. <member name="P:Dynamsoft.TWAIN.TwainManager.PendingXFERs">
  1274. <summary>
  1275. Returns the number of transfers the Source is ready to supply, upon demand. This is a runtime, read-only property.
  1276. </summary>
  1277. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1278. When an error occurs, please check TwainException.
  1279. </exception>
  1280. <remarks>
  1281. This property is valid only in OnPostTransfer event.
  1282. The Data Source will return -1 if it is not sure how many transfers are pending. Scanners with ADF (Automatic Document Feeder) will typically return -1 if the current image is not the last one.
  1283. </remarks>
  1284. </member>
  1285. <member name="P:Dynamsoft.TWAIN.TwainManager.PixelFlavor">
  1286. <summary>
  1287. Returns or sets the pixel flavor for acquired images. This is a runtime property.
  1288. </summary>
  1289. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1290. When an error occurs, please check TwainException.
  1291. </exception>
  1292. <remarks>
  1293. Please set this property after calling OpenSource() method and before calling AcquireImage().
  1294. <list type="table">
  1295. <listheader>
  1296. <term>Allowed Values</term>
  1297. <description>Description</description>
  1298. </listheader>
  1299. <item><term>0</term>
  1300. <description>Chocolate. Zero pixel represents darkest shade.</description></item>
  1301. <item><term>1</term>
  1302. <description>Vanilla. Zero pixel represents lightest shade.</description></item>
  1303. </list>
  1304. The default value is 0 i.e. the default value of PixelFlavor is Chocolate.
  1305. </remarks>
  1306. </member>
  1307. <member name="P:Dynamsoft.TWAIN.TwainManager.PixelType">
  1308. <summary>
  1309. Returns or sets the pixel type of acquired images. This is a runtime property.
  1310. </summary>
  1311. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1312. When an error occurs, please check TwainException.
  1313. </exception>
  1314. <remarks>
  1315. Please set this property after calling OpenSource() method and before calling AcquireImage().
  1316. <list type="table">
  1317. <listheader>
  1318. <term>Allowed Values</term>
  1319. <description>PixelType TWICapPixelType</description>
  1320. </listheader>
  1321. <item><term>0</term>
  1322. <description>BW</description></item>
  1323. <item><term>1</term>
  1324. <description>GRAY</description></item>
  1325. <item><term>2</term>
  1326. <description>RGB</description></item>
  1327. <item><term>3</term>
  1328. <description>PALETTE</description></item>
  1329. <item><term>4</term>
  1330. <description>CMY</description></item>
  1331. <item><term>5</term>
  1332. <description>CMYK</description></item>
  1333. <item><term>6</term>
  1334. <description>YUV</description></item>
  1335. <item><term>7</term>
  1336. <description>YUVK</description></item>
  1337. <item><term>8</term>
  1338. <description>CIEXYZ</description></item>
  1339. </list>
  1340. </remarks>
  1341. </member>
  1342. <member name="P:Dynamsoft.TWAIN.TwainManager.Resolution">
  1343. <summary>
  1344. Returns or sets the current resolution for image acquisition. This is a runtime property.
  1345. </summary>
  1346. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1347. When an error occurs, please check TwainException.
  1348. </exception>
  1349. <remarks>
  1350. Please set this property after calling OpenSource() method and before calling AcquireImage().
  1351. </remarks>
  1352. </member>
  1353. <member name="P:Dynamsoft.TWAIN.TwainManager.SourceCount">
  1354. <summary>
  1355. Returns how many sources are available on the local system. This is a runtime, read-only property.
  1356. </summary>
  1357. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1358. When an error occurs, please check TwainException.
  1359. </exception>
  1360. <remarks>
  1361. If SourceCount is 0, it means no source is available or the Source Manager is not open.
  1362. </remarks>
  1363. </member>
  1364. <member name="P:Dynamsoft.TWAIN.TwainManager.TransferMode">
  1365. <summary>
  1366. Returns or sets the transfer mode. Please set the value of transfer mode in enum <see cref="T:Dynamsoft.TWAIN.Enums.TWICapSetupXFer"/>.
  1367. </summary>
  1368. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1369. When an error occurs, please check TwainException.
  1370. </exception>
  1371. <remarks>
  1372. The default value for TransferMode property is TWSX_NATIVE (0).
  1373. For DISK FILE mode, since it is not required by TWAIN, the application needs to make sure it is supported by the current Source. One way to do this is checking the TransferMode property after OpenSource() to see if it is still TWSX_FILE.
  1374. </remarks>
  1375. </member>
  1376. <member name="P:Dynamsoft.TWAIN.TwainManager.Unit">
  1377. <summary>
  1378. Returns or sets the unit of measure. This is a runtime property.
  1379. </summary>
  1380. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1381. When an error occurs, please check TwainException.
  1382. </exception>
  1383. <remarks>
  1384. <list type="table">
  1385. <listheader>
  1386. <term>Allowed Values</term>
  1387. <description>Unit</description>
  1388. </listheader>
  1389. <item><term>0</term>
  1390. <description>INCHES</description></item>
  1391. <item><term>1</term>
  1392. <description>CENTIMETERS</description></item>
  1393. <item><term>2</term>
  1394. <description>PICAS</description>
  1395. </item>
  1396. <item><term>3</term>
  1397. <description>POINTS</description>
  1398. </item>
  1399. <item><term>4</term>
  1400. <description>TWIPS</description>
  1401. </item>
  1402. <item><term>5</term>
  1403. <description>PIXELS</description>
  1404. </item>
  1405. </list>
  1406. Please set this property after calling OpenSource() method and before calling AcquireImage().
  1407. </remarks>
  1408. </member>
  1409. <member name="P:Dynamsoft.TWAIN.TwainManager.XferCount">
  1410. <summary>
  1411. Returns and sets the number of images your application will transfer per session. This is a runtime property.
  1412. </summary>
  1413. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1414. When an error occurs, please check TwainException.
  1415. </exception>
  1416. <remarks>
  1417. Allowed values are between -1 and 32767.
  1418. 'N' indicates N images.
  1419. '-1' indicates multiple images.
  1420. Please set this property after calling OpenSource() method.
  1421. </remarks>
  1422. </member>
  1423. <member name="P:Dynamsoft.TWAIN.TwainManager.BlankImageMaxStdDev">
  1424. <summary>
  1425. Returns or sets the maximum standard deviation threshold of the pixels in an image which will be used to determine whether an image is blank.
  1426. </summary>
  1427. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1428. When an error occurs, please check TwainException.
  1429. </exception>
  1430. <remarks>
  1431. The allowed values are from 0 to 100. 0 means it is a single-color image. The default value is 1.
  1432. </remarks>
  1433. </member>
  1434. <member name="P:Dynamsoft.TWAIN.TwainManager.BlankImageThreshold">
  1435. <summary>
  1436. Returns or sets the dividing line between black and white. The default value is 128.
  1437. </summary>
  1438. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1439. When an error occurs, please check TwainException.
  1440. </exception>
  1441. <remarks>
  1442. The allowed values are from 0 to 255. The default value is 128.
  1443. </remarks>
  1444. </member>
  1445. <member name="P:Dynamsoft.TWAIN.TwainManager.Manufacturer">
  1446. <summary>
  1447. Returns or sets the manufacture string for the application identity.
  1448. </summary>
  1449. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1450. When an error occurs, please check TwainException.
  1451. </exception>
  1452. <remarks>
  1453. The Manufacturer property is a part of the application identity. The application identity consists of the Manufacturer, ProductFamily, ProductName and VersionInfo properties. These information may be shown in Source's interface.
  1454. </remarks>
  1455. </member>
  1456. <member name="P:Dynamsoft.TWAIN.TwainManager.ProductFamily">
  1457. <summary>
  1458. Returns or sets the product family string for the application identity.
  1459. </summary>
  1460. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1461. When an error occurs, please check TwainException.
  1462. </exception>
  1463. <remarks>
  1464. The ProductFamily property is a part of the application identity. The application identity consists of the Manufacturer, ProductFamily, ProductName and VersionInfo properties. These information may be shown in Source's interface.
  1465. </remarks>
  1466. </member>
  1467. <member name="P:Dynamsoft.TWAIN.TwainManager.ProductName">
  1468. <summary>
  1469. Returns or sets the product name string for the application identity.
  1470. </summary>
  1471. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1472. When an error occurs, please check TwainException.
  1473. </exception>
  1474. <remarks>
  1475. The ProductName property is a part of the application identity. The application identity consists of the Manufacturer, ProductFamily, ProductName and VersionInfo properties. These information may be shown in Source's interface.
  1476. </remarks>
  1477. </member>
  1478. <member name="P:Dynamsoft.TWAIN.TwainManager.VersionInfo">
  1479. <summary>
  1480. Returns or sets the version info string for the application identity.
  1481. </summary>
  1482. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1483. When an error occurs, please check TwainException.
  1484. </exception>
  1485. <remarks>
  1486. The VersionInfo property is a part of the application identity. The application identity consists of the Manufacturer, ProductFamily, ProductName and VersionInfo properties. These information may be shown in Source's interface.
  1487. </remarks>
  1488. </member>
  1489. <member name="P:Dynamsoft.TWAIN.TwainManager.BarcodeCount">
  1490. <summary>
  1491. Returns the number of barcode detected in an image. It's only valid in OnPostTransfer event.
  1492. </summary>
  1493. <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1494. When an error occurs, please check TwainException.
  1495. </exception>
  1496. <remarks>
  1497. If the Source doesn't contain barcode or doesn't supported barcode, 0 will be returned.
  1498. BarcodeCount property along with other properties about information of the current image is valid only in OnPostTransfer event.
  1499. </remarks>
  1500. </member>
  1501. <member name="P:Dynamsoft.TWAIN.TwainManager.LogLevel">
  1502. <summary>
  1503. Returns or sets whether enable the debug mode of Dynamic .NET TWAIN.
  1504. </summary>
  1505. // <exception cref="T:Dynamsoft.TWAIN.TwainException">
  1506. When an error occurs, please check TwainException.
  1507. </exception>
  1508. <remarks>
  1509. The default value is 0. When the value i is set to 1, Dynamic .NET TWAIN will send all messages to an external Debugger tool for display. (eg. DgbView.exe)
  1510. </remarks>
  1511. </member>
  1512. <member name="P:Dynamsoft.TWAIN.TwainManager.MagType">
  1513. <summary>
  1514. Returns the magnetic type if the scanner supports magnetic data recognition. This is a read-only property.
  1515. </summary>
  1516. <remarks>Only valid when ScanInNewProcess is true</remarks>
  1517. </member>
  1518. <member name="P:Dynamsoft.TWAIN.TwainManager.MagData">
  1519. <summary>
  1520. Returns the magnetic data if the scanner supports magnetic data recognition. This is a read-only property.
  1521. </summary>
  1522. <remarks>This property needs scanner suppor and is valid only when ScanInNewProcess is true</remarks>
  1523. </member>
  1524. <member name="P:Dynamsoft.TWAIN.TwainManager.ScanInNewProcess">
  1525. <summary>
  1526. Acquires image in a new separate process. Default value is true.
  1527. </summary>
  1528. <remarks>
  1529. ScanInNewProcess should be called prior to negotiating capability.
  1530. </remarks>
  1531. </member>
  1532. <member name="P:Dynamsoft.TWAIN.TwainManager.ExtendedImageInfoQueryLevel">
  1533. <summary>
  1534. It's used to set how much information is returned by the scanner in case IAcquireCallback.IfGetExtImageInfo is true.
  1535. By default, it's 0 and that means the basic info will be retrived.
  1536. If set to 1, it will try to query all the defined info in TWAIN.
  1537. If set to 2, it will try to query all the defined info in TWAIN and the custom info.
  1538. </summary>
  1539. </member>
  1540. <member name="P:Dynamsoft.TWAIN.TwainManager.AlwaysOnTop">
  1541. <summary>
  1542. Returns or sets whether to prevent other windows covering the Scanner UI. The default value of this property is true.
  1543. </summary>
  1544. </member>
  1545. <member name="T:Dynamsoft.TWAIN.Enums.TWCapType">
  1546. <summary>
  1547. Capabilities exist in many varieties but all of them have a Default Value and a Current Value and may also have other values available.
  1548. To help categorize the supported values into clear structures, TWAIN defines four types of containers for capabilities:
  1549. TW_ONEVALUE, TW_ARRAY, TW_RANGE and TW_ENUMERATION.
  1550. </summary>
  1551. </member>
  1552. <member name="F:Dynamsoft.TWAIN.Enums.TWCapType.TWON_NONE">
  1553. <summary>
  1554. Nothing.
  1555. </summary>
  1556. </member>
  1557. <member name="F:Dynamsoft.TWAIN.Enums.TWCapType.TWON_ARRAY">
  1558. <summary>
  1559. A rectangular array of values that describe a logical item. It is similar to the TW_ONEVALUE because the current and default values are the same and
  1560. there are no other values to select from. For example, a list of the names, such as the supported capabilities list returned by the CAP_SUPPORTEDCAPS
  1561. capability, would use this type of container.
  1562. </summary>
  1563. </member>
  1564. <member name="F:Dynamsoft.TWAIN.Enums.TWCapType.TWON_ENUMERATION">
  1565. <summary>
  1566. This is the most general type because it defines a list of values from which the Current Value can be chosen.
  1567. The values do not increase uniformly through a range and there is no constant step-size between 2 values.
  1568. For example, if the step size of a Source's resolution is not the same, then the enumeration can be used (for example, 150, 400, and 600).
  1569. </summary>
  1570. </member>
  1571. <member name="F:Dynamsoft.TWAIN.Enums.TWCapType.TWON_ONEVALUE">
  1572. <summary>
  1573. A single value whose current and default values are coincident. The range of available values for this type of capability is simply this single value.
  1574. For example, a capability that indicates the presence of a document feeder could be of this type.
  1575. </summary>
  1576. </member>
  1577. <member name="F:Dynamsoft.TWAIN.Enums.TWCapType.TWON_RANGE">
  1578. <summary>
  1579. Many capabilities allow users to select their current value from a range of regularly spaced values.
  1580. The capability can specify the minimum and maximum acceptable values and the incremental step size between the values.
  1581. For example, resolution might be supported from 100 to 600 in steps of 50 (100, 150, 200, ..., 550, 600).
  1582. </summary>
  1583. </member>
  1584. <member name="T:Dynamsoft.TWAIN.Enums.TWCapability">
  1585. <summary>
  1586. Capabilities.
  1587. </summary>
  1588. </member>
  1589. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_NONE">
  1590. <summary>
  1591. Nothing.
  1592. </summary>
  1593. </member>
  1594. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_XFERCOUNT">
  1595. <summary>
  1596. The application is willing to accept this number of images.
  1597. </summary>
  1598. </member>
  1599. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_COMPRESSION">
  1600. <summary>
  1601. Allows the application and Source to identify which compression schemes they have in
  1602. common for Buffered Memory and File transfers.
  1603. Note for File transfers:
  1604. Since only certain file formats support compression, this capability must be negotiated after
  1605. setting the desired file format with ICAP_IMAGEFILEFORMAT.
  1606. </summary>
  1607. </member>
  1608. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_PIXELTYPE">
  1609. <summary>
  1610. The type of pixel data that a Source is capable of acquiring (for example, black and white, gray, RGB, etc.).
  1611. </summary>
  1612. </member>
  1613. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_UNITS">
  1614. <summary>
  1615. Unless a quantity is dimensionless or uses a specified unit of measure, ICAP_UNITS determines
  1616. the unit of measure for all quantities.
  1617. </summary>
  1618. </member>
  1619. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_XFERMECH">
  1620. <summary>
  1621. Allows the application and Source to identify which transfer mechanisms the source supports.
  1622. </summary>
  1623. </member>
  1624. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_AUTHOR">
  1625. <summary>
  1626. The name or other identifying information about the Author of the image. It may include a copyright string.
  1627. </summary>
  1628. </member>
  1629. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_CAPTION">
  1630. <summary>
  1631. A general note about the acquired image.
  1632. </summary>
  1633. </member>
  1634. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_FEEDERENABLED">
  1635. <summary>
  1636. If TRUE, Source must acquire data from the document feeder acquire area and other feeder
  1637. capabilities can be used. If FALSE, Source must acquire data from the non-feeder acquire area
  1638. and no other feeder capabilities can be used.
  1639. </summary>
  1640. </member>
  1641. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_FEEDERLOADED">
  1642. <summary>
  1643. Reflects whether there are documents loaded in the Source’s feeder.
  1644. </summary>
  1645. </member>
  1646. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_TIMEDATE">
  1647. <summary>
  1648. The date and time the image was acquired.
  1649. Stored in the form “YYYY/MM/DD HH:mm:SS.sss” where YYYY is the year, MM is the
  1650. numerical month, DD is the numerical day, HH is the hour, mm is the minute, SS is the second,
  1651. and sss is the millisecond.
  1652. </summary>
  1653. </member>
  1654. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_SUPPORTEDCAPS">
  1655. <summary>
  1656. Returns a list of all the capabilities for which the Source will answer inquiries. Does not indicate
  1657. which capabilities the Source will allow to be set by the application. Some capabilities can only
  1658. be set if certain setup work has been done so the Source cannot globally answer which
  1659. capabilities are “set-able.”
  1660. </summary>
  1661. </member>
  1662. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_EXTENDEDCAPS">
  1663. <summary>
  1664. Allows the application and Source to negotiate capabilities to be used in States 5 and 6.
  1665. </summary>
  1666. </member>
  1667. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_AUTOFEED">
  1668. <summary>
  1669. If TRUE, the Source will automatically feed the next page from the document feeder after the
  1670. number of frames negotiated for capture from each page are acquired. CAP_FEEDERENABLED
  1671. must be TRUE to use this capability.
  1672. </summary>
  1673. </member>
  1674. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_CLEARPAGE">
  1675. <summary>
  1676. If TRUE, the Source will eject the current page being acquired from and will leave the feeder
  1677. acquire area empty.
  1678. If CAP_AUTOFEED is TRUE, a fresh page will be advanced.
  1679. CAP_FEEDERENABLED must equal TRUE to use this capability.
  1680. This capability must have been negotiated as an extended capability to be used in States 5 and 6.
  1681. </summary>
  1682. </member>
  1683. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_FEEDPAGE">
  1684. <summary>
  1685. If TRUE, the Source will eject the current page and advance the next page in the document feeder
  1686. into the feeder acquire area.
  1687. If CAP_AUTOFEED is TRUE, the same action just described will occur and CAP_AUTOFEED will
  1688. remain active.
  1689. CAP_FEEDERENABLED must equal TRUE to use this capability.
  1690. This capability must have been negotiated as an extended capability to be used in States 5 and 6.
  1691. </summary>
  1692. 20170104
  1693. </member>
  1694. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_REWINDPAGE">
  1695. <summary>
  1696. If TRUE, the Source will return the current page to the input side of the document feeder and
  1697. feed the last page from the output side of the feeder back into the acquisition area.
  1698. If CAP_AUTOFEED is TRUE, automatic feeding will continue after all negotiated frames from this
  1699. page are acquired.
  1700. CAP_FEEDERENABLED must equal TRUE to use this capability.
  1701. This capability must have been negotiated as an extended capability to be used in States 5 and 6.
  1702. </summary>
  1703. </member>
  1704. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_INDICATORS">
  1705. <summary>
  1706. If TRUE, the Source will display a progress indicator during acquisition and transfer, regardless
  1707. of whether the Source’s user interface is active. If FALSE, the progress indicator will be
  1708. suppressed if the Source’s user interface is inactive.
  1709. The Source will continue to display device-specific instructions and error messages even with
  1710. the Source user interface and progress indicators turned off.
  1711. </summary>
  1712. </member>
  1713. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_SUPPORTEDCAPSEXT">
  1714. <summary>
  1715. Returns a list of all the capabilities for which the Source will answer inquiries. Does not indicate
  1716. which capabilities the Source will allow to be set by the application. Some capabilities can only
  1717. be set if certain setup work has been done so the Source cannot globally answer which
  1718. capabilities are “set-able.”
  1719. </summary>
  1720. </member>
  1721. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_PAPERDETECTABLE">
  1722. <summary>
  1723. This capability determines whether the device has a paper sensor that can detect documents on the ADF or Flatbed.
  1724. </summary>
  1725. </member>
  1726. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_UICONTROLLABLE">
  1727. <summary>
  1728. If TRUE, indicates that this Source supports acquisition with the UI disabled; i.e.,
  1729. TW_USERINTERFACE’s ShowUI field can be set to FALSE. If FALSE, indicates that this Source
  1730. can only support acquisition with the UI enabled.
  1731. </summary>
  1732. </member>
  1733. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_DEVICEONLINE">
  1734. <summary>
  1735. If TRUE, the physical hardware (e.g., scanner, digital camera, image database, etc.) that
  1736. represents the image source is attached, powered on, and communicating.
  1737. </summary>
  1738. </member>
  1739. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_AUTOSCAN">
  1740. <summary>
  1741. This capability is intended to boost the performance of a Source. The fundamental assumption
  1742. behind AutoScan is that the device is able to capture the number of images indicated by the
  1743. value of CAP_XFERCOUNT without waiting for the Application to request the image transfers.
  1744. This is only possible if the device has internal buffers capable of caching the images it captures.
  1745. The default behavior is undefined, because some high volume devices are incapable of anything
  1746. but CAP_AUTOSCAN being equal to TRUE. However, if a Source supports FALSE, it should use it
  1747. as the mandatory default, since this best describes the behavior of pre-1.8 TWAIN Applications.
  1748. </summary>
  1749. </member>
  1750. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_THUMBNAILSENABLED">
  1751. <summary>
  1752. Allows an application to request the delivery of thumbnail representations for the set of images
  1753. that are to be delivered.
  1754. Setting CAP_THUMBNAILSENABLED to TRUE turns on thumbnail mode. Images transferred
  1755. thereafter will be sent at thumbnail size (exact thumbnail size is determined by the Data Source).
  1756. Setting this capability to FALSE turns thumbnail mode off and returns full size images.
  1757. </summary>
  1758. </member>
  1759. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_DUPLEX">
  1760. <summary>
  1761. This indicates whether the scanner supports duplex. If so, it further indicates whether one-path
  1762. or two-path duplex is supported.
  1763. </summary>
  1764. </member>
  1765. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_DUPLEXENABLED">
  1766. <summary>
  1767. The user can set the duplex option to be TRUE or FALSE. If TRUE, the scanner scans both sides
  1768. of a paper; otherwise, the scanner will scan only one side of the image.
  1769. </summary>
  1770. </member>
  1771. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_ENABLEDSUIONLY">
  1772. <summary>
  1773. Allows an application to query a source to see if it implements the new user interface settings dialog.
  1774. </summary>
  1775. </member>
  1776. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_ENDORSER">
  1777. <summary>
  1778. Allows the application to specify the starting endorser / imprinter number. All other endorser/
  1779. imprinter properties should be handled through the data source’s user interface.
  1780. The user can set the starting number for the endorser.
  1781. </summary>
  1782. </member>
  1783. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_ALARMS">
  1784. <summary>
  1785. Turns specific audible alarms on and off.
  1786. </summary>
  1787. </member>
  1788. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_ALARMVOLUME">
  1789. <summary>
  1790. The volume of a device’s audible alarm. Note that this control affects the volume of all alarms;
  1791. no specific volume control for individual types of alarms is provided.
  1792. </summary>
  1793. </member>
  1794. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_AUTOMATICCAPTURE">
  1795. <summary>
  1796. The number of images to automatically capture. This does not refer to the number of images to
  1797. be sent to the Application, use CAP_XFERCOUNT for that.
  1798. </summary>
  1799. </member>
  1800. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_TIMEBEFOREFIRSTCAPTURE">
  1801. <summary>
  1802. For automatic capture, this value selects the number of milliseconds before the first picture is to
  1803. be taken, or the first image is to be scanned.
  1804. </summary>
  1805. </member>
  1806. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_TIMEBETWEENCAPTURES">
  1807. <summary>
  1808. For automatic capture, this value selects the milliseconds to wait between pictures taken, or images scanned.
  1809. </summary>
  1810. </member>
  1811. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_CLEARBUFFERS">
  1812. <summary>
  1813. CapGet() reports the presence of data in the scanner's buffers. CapSet() with a value of TWCB_CLEAR immediately clears the buffers.
  1814. </summary>
  1815. </member>
  1816. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_MAXBATCHBUFFERS">
  1817. <summary>
  1818. Describes the number of pages that the scanner can buffer when CAP_AUTOSCAN is enabled.
  1819. </summary>
  1820. </member>
  1821. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_DEVICETIMEDATE">
  1822. <summary>
  1823. The date and time of the device’s clock.
  1824. Managed in the form “YYYY/MM/DD HH:mm:SS:sss” where YYYY is the year, MM is the
  1825. numerical month, DD is the numerical day, HH is the hour, mm is the minute, SS is the second,
  1826. and sss is the millisecond.
  1827. </summary>
  1828. </member>
  1829. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_POWERSUPPLY">
  1830. <summary>
  1831. CapGet() reports the kinds of power available to the device. CapGetCurrent() reports the current power supply in use.
  1832. </summary>
  1833. </member>
  1834. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_CAMERAPREVIEWUI">
  1835. <summary>
  1836. This capability queries the Source for UI support for preview mode. If TRUE, the Source supports preview UI.
  1837. </summary>
  1838. </member>
  1839. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_SERIALNUMBER">
  1840. <summary>
  1841. A string containing the serial number of the currently selected device in the Source. Multiple
  1842. devices may all report the same serial number.
  1843. </summary>
  1844. </member>
  1845. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_PRINTER">
  1846. <summary>
  1847. CapGet() returns the current list of available printer devices, along with the one currently being used for negotiation.
  1848. CapSet() selects the current device for negotiation, and optionally constrains the list.
  1849. Top/Bottom refers to duplex devices, and indicates if the printer is writing on the top or the bottom of the sheet of paper.
  1850. Simplex devices use the top settings. Before/After indicates whether printing occurs before or after the sheet of paper has been scanned.
  1851. </summary>
  1852. </member>
  1853. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_PRINTERENABLED">
  1854. <summary>
  1855. Turns the current CAP_PRINTER device on or off.
  1856. </summary>
  1857. </member>
  1858. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_PRINTERINDEX">
  1859. <summary>
  1860. The User can set the starting number for the current CAP_PRINTER device.
  1861. </summary>
  1862. </member>
  1863. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_PRINTERMODE">
  1864. <summary>
  1865. Specifies the appropriate current CAP_PRINTER device mode.
  1866. Note:
  1867. • TWPM_SINGLESTRING specifies that the printed text will consist of a single string.
  1868. • TWPM _MULTISTRING specifies that the printed text will consist of an enumerated list of
  1869. strings to be printed in order.
  1870. • TWPM _COMPOUNDSTRING specifies that the printed string will consist of a compound of a
  1871. String followed by a value followed by a suffix string.
  1872. </summary>
  1873. </member>
  1874. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_PRINTERSTRING">
  1875. <summary>
  1876. Specifies the string(s) that are to be used in the string component when the current
  1877. CAP_PRINTER device is enabled.
  1878. </summary>
  1879. </member>
  1880. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_PRINTERSUFFIX">
  1881. <summary>
  1882. Specifies the string that shall be used as the current CAP_PRINTER device’s suffix.
  1883. </summary>
  1884. </member>
  1885. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_LANGUAGE">
  1886. <summary>
  1887. Allows Application and Source to identify which languages they have in common for the exchange of string data,
  1888. and to select the language of the internal UI. Since the TWLG_xxxx codes include language and country data, there is no separate
  1889. capability for selecting the country.
  1890. </summary>
  1891. </member>
  1892. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_FEEDERALIGNMENT">
  1893. <summary>
  1894. Helps the Application determine any special actions it may need to take when negotiating
  1895. frames with the Source. Allowed values are listed in <see cref="T:Dynamsoft.TWAIN.Enums.TWCapFeederAlignment"/>.
  1896. TWFA_NONE: The alignment is free-floating. Applications should assume
  1897. that the origin for frames is on the left.
  1898. TWFA_LEFT: The alignment is to the left.
  1899. TWFA_CENTER: The alignment is centered. This means that the paper will
  1900. be fed in the middle of the ICAP_PHYSICALWIDTH of the
  1901. device. If this is set, then the Application should calculate
  1902. any frames with a left offset of zero.
  1903. TWFA_RIGHT: The alignment is to the right.
  1904. </summary>
  1905. </member>
  1906. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_FEEDERORDER">
  1907. <summary>
  1908. TWFO_FIRSTPAGEFIRST if the feeder starts with the top of the first page.
  1909. TWFO_LASTPAGEFIRST is the feeder starts with the top of the last page.
  1910. </summary>
  1911. </member>
  1912. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_REACQUIREALLOWED">
  1913. <summary>
  1914. Indicates whether the physical hardware (e.g. scanner, digital camera) is capable of acquiring
  1915. multiple images of the same page without changes to the physical registration of that page.
  1916. </summary>
  1917. </member>
  1918. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_BATTERYMINUTES">
  1919. <summary>
  1920. The minutes of battery power remaining to the device.
  1921. </summary>
  1922. </member>
  1923. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.CAP_BATTERYPERCENTAGE">
  1924. <summary>
  1925. When used with CapGet(), return the percentage of battery power level on camera. If -1 is returned, it indicates that the battery is not present.
  1926. </summary>
  1927. </member>
  1928. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_AUTOBRIGHT">
  1929. <summary>
  1930. TRUE enables and FALSE disables the Source’s Auto-brightness function (if any).
  1931. </summary>
  1932. </member>
  1933. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_BRIGHTNESS">
  1934. <summary>
  1935. The brightness values available within the Source.
  1936. </summary>
  1937. </member>
  1938. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_CONTRAST">
  1939. <summary>
  1940. The contrast values available within the Source.
  1941. </summary>
  1942. </member>
  1943. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_CUSTHALFTONE">
  1944. <summary>
  1945. Specifies the square-cell halftone (dithering) matrix the Source should use to halftone the image.
  1946. </summary>
  1947. </member>
  1948. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_EXPOSURETIME">
  1949. <summary>
  1950. Specifies the exposure time used to capture the image, in seconds.
  1951. </summary>
  1952. </member>
  1953. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_FILTER">
  1954. <summary>
  1955. Describes the color characteristic of the subtractive filter applied to the image data. Multiple
  1956. filters may be applied to a single acquisition.
  1957. </summary>
  1958. </member>
  1959. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_FLASHUSED">
  1960. <summary>
  1961. Specifies whether or not the image was acquired using a flash.
  1962. </summary>
  1963. </member>
  1964. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_GAMMA">
  1965. <summary>
  1966. Gamma correction value for the image data.
  1967. </summary>
  1968. </member>
  1969. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_HALFTONES">
  1970. <summary>
  1971. A list of names of the halftone patterns available within the Source.
  1972. </summary>
  1973. </member>
  1974. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_HIGHLIGHT">
  1975. <summary>
  1976. Specifies which value in an image should be interpreted as the lightest “highlight.” All values
  1977. “lighter” than this value will be clipped to this value. Whether lighter values are smaller or
  1978. larger can be determined by examining the Current value of ICAP_PIXELFLAVOR.
  1979. </summary>
  1980. </member>
  1981. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_IMAGEFILEFORMAT">
  1982. <summary>
  1983. Informs the application which file formats the Source can generate (CapGet()). Tells the Source which file formats the application can handle (CapSet()).
  1984. TWFF_TIFF Used for document
  1985. TWFF_PICT Native Macintosh
  1986. TWFF_BMP Native Microsoft
  1987. TWFF_XBM Used for document
  1988. TWFF_JFIF Wrapper for JPEG
  1989. TWFF_FPX FlashPix, used with digital
  1990. TWFF_TIFFMULTI Multi-page TIFF files
  1991. TWFF_PNG An image format standard intended for use on the web, replaces GIF
  1992. TWFF_SPIFF A standard from JPEG, intended to replace JFIF, also supports JBIG
  1993. TWFF_EXIF File format for use with digital cameras.
  1994. </summary>
  1995. </member>
  1996. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_LAMPSTATE">
  1997. <summary>
  1998. TRUE means the lamp is currently, or should be set to ON. Sources may not support CapSet() operations.
  1999. </summary>
  2000. </member>
  2001. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_LIGHTSOURCE">
  2002. <summary>
  2003. Describes the general color characteristic of the light source used to acquire the image.
  2004. </summary>
  2005. </member>
  2006. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_ORIENTATION">
  2007. <summary>
  2008. Defines which edge of the "paper" the image's "top" is aligned with. This information is used to adjust the frames to match the
  2009. scanning orientation of the paper. For instance, if an ICAP_SUPPORTEDSIZE of TWSS_ISOA4 has been negotiated,
  2010. and ICAP_ORIENTATION is set to TWOR_LANDSCAPE, then the Source must rotate the frame it downloads to the scanner to reflect the
  2011. orientation of the paper. Please note that setting ICAP_ORIENTATION does not affect the values reported by ICAP_FRAMES;
  2012. it just causes the Source to use them in a different way. The upper-left of the image is defined as the location where both the primary and
  2013. secondary scans originate. (The X axis is the primary scan direction and the Y axis is the secondary scan direction.)
  2014. For a flatbed scanner, the light bar moves in the secondary scan direction. For a handheld scanner, the scanner is drug in the
  2015. secondary scan direction. For a digital camera, the secondary direction is the vertical axis when the viewed image is considered upright.
  2016. </summary>
  2017. </member>
  2018. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_PHYSICALWIDTH">
  2019. <summary>
  2020. The maximum physical width (X-axis) the Source can acquire (measured in units of ICAP_UNITS).
  2021. </summary>
  2022. </member>
  2023. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_PHYSICALHEIGHT">
  2024. <summary>
  2025. The maximum physical height (Y-axis) the Source can acquire (measured in units of ICAP_UNITS).
  2026. </summary>
  2027. </member>
  2028. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_SHADOW">
  2029. <summary>
  2030. Specifies which value in an image should be interpreted as the darkest “shadow.” All values
  2031. “darker” than this value will be clipped to this value.
  2032. </summary>
  2033. </member>
  2034. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_FRAMES">
  2035. <summary>
  2036. The list of frames the Source will acquire on each page.
  2037. </summary>
  2038. </member>
  2039. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_XNATIVERESOLUTION">
  2040. <summary>
  2041. The native optical resolution along the X-axis of the device being controlled by the Source. Most
  2042. devices will respond with a single value (TW_ONEVALUE).
  2043. This is NOT a list of all resolutions that can be generated by the device. Rather, this is the
  2044. resolution of the device’s optics. Measured in units of pixels per unit as defined by
  2045. ICAP_UNITS (pixels per TWUN_PIXELS yields dimensionless data).
  2046. </summary>
  2047. </member>
  2048. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_YNATIVERESOLUTION">
  2049. <summary>
  2050. The native optical resolution along the Y-axis of the device being controlled by the Source.
  2051. Measured in units of pixels per unit as defined by ICAP_UNITS (pixels per TWUN_PIXELS
  2052. yields dimensionless data).
  2053. </summary>
  2054. </member>
  2055. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_XRESOLUTION">
  2056. <summary>
  2057. All the X-axis resolutions the Source can provide.
  2058. Measured in units of pixels per unit as defined by ICAP_UNITS (pixels per TWUN_PIXELS
  2059. yields dimensionless data). That is, when the units are TWUN_PIXELS, both
  2060. ICAP_XRESOLUTION and ICAP_YRESOLUTION shall report 1 pixel/pixel. Some data sources
  2061. like to report the actual number of pixels that the device reports, but that response is more
  2062. appropriate in ICAP_PHYSICALHEIGHT and ICAP_PHYSICALWIDTH.
  2063. </summary>
  2064. </member>
  2065. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_YRESOLUTION">
  2066. <summary>
  2067. All the Y-axis resolutions the Source can provide.
  2068. Measured in units of pixels per unit as defined by ICAP_UNITS (pixels per TWUN_PIXELS
  2069. yields dimensionless data). That is, when the units are TWUN_PIXELS, both
  2070. ICAP_XRESOLUTION and ICAP_YRESOLUTION shall report 1 pixel/pixel. Some data sources
  2071. like to report the actual number of pixels that the device reports, but that response is more
  2072. appropriate in ICAP_PHYSICALHEIGHT and ICAP_PHYSICALWIDTH.
  2073. </summary>
  2074. </member>
  2075. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_MAXFRAMES">
  2076. <summary>
  2077. The maximum number of frames the Source can provide or the application can accept per page.
  2078. This is a bounding capability only. It does not establish current or future behavior.
  2079. </summary>
  2080. </member>
  2081. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_TILES">
  2082. <summary>
  2083. This is used with buffered memory transfers. If TRUE, Source can provide application with tiled image data.
  2084. </summary>
  2085. </member>
  2086. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_BITORDER">
  2087. <summary>
  2088. Specifies how the bytes in an image are filled by the Source. TWBO_MSBFIRST indicates that the leftmost bit in the byte (usually bit 7) is
  2089. the byte's Most Significant Bit.
  2090. </summary>
  2091. </member>
  2092. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_CCITTKFACTOR">
  2093. <summary>
  2094. Used for CCITT Group 3 2-dimensional compression. The ‘K’ factor indicates how often the
  2095. new compression baseline should be re-established. A value of 2 or 4 is common in facsimile
  2096. communication. A value of zero in this field will indicate an infinite K factor—the baseline is
  2097. only calculated at the beginning of the transfer.
  2098. </summary>
  2099. </member>
  2100. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_LIGHTPATH">
  2101. <summary>
  2102. Describes whether the image was captured transmissively or reflectively.
  2103. </summary>
  2104. </member>
  2105. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_PIXELFLAVOR">
  2106. <summary>
  2107. Sense of the pixel whose numeric value is zero (minimum data value).
  2108. </summary>
  2109. </member>
  2110. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_PLANARCHUNKY">
  2111. <summary>
  2112. Allows the application and Source to identify which color data formats are available. There are
  2113. two options, “planar” and “chunky.”
  2114. </summary>
  2115. </member>
  2116. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_ROTATION">
  2117. <summary>
  2118. How the Source can/should rotate the scanned image data prior to transfer. This doesn’t use
  2119. ICAP_UNITS. It is always measured in degrees. Any applied value is additive with any
  2120. rotation specified in ICAP_ORIENTATION.
  2121. </summary>
  2122. </member>
  2123. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_SUPPORTEDSIZES">
  2124. <summary>
  2125. For devices that support fixed frame sizes.
  2126. Defined sizes match typical page sizes. This specifies the size(s) the Source can/should use to acquire image data.
  2127. </summary>
  2128. </member>
  2129. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_THRESHOLD">
  2130. <summary>
  2131. Specifies the dividing line between black and white. This is the value the Source will use to
  2132. threshold, if needed, when ICAP_PIXELTYPE = TWPT_BW.
  2133. The value is normalized so there are no units of measure associated with this ICAP.
  2134. </summary>
  2135. </member>
  2136. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_XSCALING">
  2137. <summary>
  2138. All the X-axis scaling values available. A value of ‘1.0’ is equivalent to 100% scaling. Do not use values less than or equal to zero.
  2139. </summary>
  2140. </member>
  2141. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_YSCALING">
  2142. <summary>
  2143. All the Y-axis scaling values available. A value of ‘1.0’ is equivalent to 100% scaling. Do not use values less than or equal to zero.
  2144. There are no units inherent with this data as it is normalized to 1.0 being “unscaled.”
  2145. </summary>
  2146. </member>
  2147. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_BITORDERCODES">
  2148. <summary>
  2149. Used for CCITT data compression only. Indicates the bit order representation of the stored compressed codes.
  2150. </summary>
  2151. </member>
  2152. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_PIXELFLAVORCODES">
  2153. <summary>
  2154. Used only for CCITT data compression. Specifies whether the compressed codes’ pixel “sense”
  2155. will be inverted from the Current value of ICAP_PIXELFLAVOR prior to transfer.
  2156. </summary>
  2157. </member>
  2158. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_JPEGPIXELTYPE">
  2159. <summary>
  2160. Allows the application and Source to agree upon a common set of color descriptors that are
  2161. made available by the Source. This ICAP is only useful for JPEG-compressed buffered memory image transfers.
  2162. </summary>
  2163. </member>
  2164. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_TIMEFILL">
  2165. <summary>
  2166. Used only with CCITT data compression. Specifies the minimum number of words of compressed codes (compressed data) to be transmitted per line.
  2167. </summary>
  2168. </member>
  2169. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_BITDEPTH">
  2170. <summary>
  2171. Specifies the pixel bit depths for the Current value of ICAP_PIXELTYPE. For example, when
  2172. using ICAP_PIXELTYPE = TWPT_GRAY, this capability specifies whether this is 8-bit gray or 4-bit gray.
  2173. This depth applies to all the data channels (for instance, the R, G, and B channels will all have
  2174. this same bit depth for RGB data).
  2175. </summary>
  2176. </member>
  2177. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_BITDEPTHREDUCTION">
  2178. <summary>
  2179. Specifies the Reduction Method the Source should use to reduce the bit depth of the data. Most
  2180. commonly used with ICAP_PIXELTYPE = TWPT_BW to reduce gray data to black and white.
  2181. </summary>
  2182. </member>
  2183. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_UNDEFINEDIMAGESIZE">
  2184. <summary>
  2185. If TRUE the Source will issue a MSG_XFERREADY before starting the scan.
  2186. Note: The Source may need to scan the image before initiating the transfer. This is the case if
  2187. the scanned image is rotated or merged with another scanned image.
  2188. </summary>
  2189. </member>
  2190. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_EXTIMAGEINFO">
  2191. <summary>
  2192. Allows the application to query the data source to see if it supports extended image attribute capabilities,
  2193. such as Barcode Recognition, Shaded Area Detection and Removal, Skew detection and Removal, and so on.
  2194. </summary>
  2195. </member>
  2196. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_MINIMUMHEIGHT">
  2197. <summary>
  2198. Allows the source to define the minimum height (Y-axis) that the source can acquire.
  2199. </summary>
  2200. </member>
  2201. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_MINIMUMWIDTH">
  2202. <summary>
  2203. Allows the source to define theminimum width (X-axis) that the source can acquire.
  2204. </summary>
  2205. </member>
  2206. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_AUTODISCARDBLANKPAGES">
  2207. <summary>
  2208. Use this capability to have the Source discard blank images. The Application never sees these
  2209. images during the scanning session.
  2210. TWBP_DISABLE – this must be the default state for the Source. It indicates that all images will
  2211. be delivered to the Application, none of them will be discarded.
  2212. TWBP_AUTO – if this is used, then the Source will decide if an image is blank or not and discard
  2213. as appropriate.
  2214. If the specified value is a positive number in the range 0 to 231–1, then this capability will use it
  2215. as the byte size cutoff point to identify which images are to be discarded. If the size of the image
  2216. is less than or equal to this value, then it will be discarded. If the size of the image is greater
  2217. than this value, then it will be kept so that it can be transferred to the Application.
  2218. </summary>
  2219. </member>
  2220. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_FLIPROTATION">
  2221. <summary>
  2222. Flip rotation is used to properly orient images that flip orientation every other image.
  2223. TWFR_BOOK The images to be scanned are viewed in book form, flipping each page from left to right or right to left.
  2224. TWFR_FANFOLD The images to be scanned are viewed in fanfold paper style, flipping each page up or down.
  2225. </summary>
  2226. </member>
  2227. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_BARCODEDETECTIONENABLED">
  2228. <summary>
  2229. Turns bar code detection on and off.
  2230. </summary>
  2231. </member>
  2232. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_SUPPORTEDBARCODETYPES">
  2233. <summary>
  2234. Provides a list of bar code types that can be detected by the current Data Source.
  2235. </summary>
  2236. </member>
  2237. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_BARCODEMAXSEARCHPRIORITIES">
  2238. <summary>
  2239. The maximum number of supported search priorities.
  2240. </summary>
  2241. </member>
  2242. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_BARCODESEARCHPRIORITIES">
  2243. <summary>
  2244. A prioritized list of bar code types dictating the order in which bar codes will be sought.
  2245. </summary>
  2246. </member>
  2247. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_BARCODESEARCHMODE">
  2248. <summary>
  2249. Restricts bar code searching to certain orientations, or prioritizes one orientation over the other.
  2250. </summary>
  2251. </member>
  2252. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_BARCODEMAXRETRIES">
  2253. <summary>
  2254. Restricts the number of times a search will be retried if none are found on each page.
  2255. </summary>
  2256. </member>
  2257. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_BARCODETIMEOUT">
  2258. <summary>
  2259. Restricts the total time spent on searching for a bar code on each page.
  2260. </summary>
  2261. </member>
  2262. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_ZOOMFACTOR">
  2263. <summary>
  2264. When used with CapGet(), returns all camera supported lens zooming range.
  2265. </summary>
  2266. </member>
  2267. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_PATCHCODEDETECTIONENABLED">
  2268. <summary>
  2269. Turns patch code detection on and off.
  2270. </summary>
  2271. </member>
  2272. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_SUPPORTEDPATCHCODETYPES">
  2273. <summary>
  2274. A list of patch code types that may be detected by the current Data Source.
  2275. </summary>
  2276. </member>
  2277. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_PATCHCODEMAXSEARCHPRIORITIES">
  2278. <summary>
  2279. The maximum number of supported search priorities.
  2280. </summary>
  2281. </member>
  2282. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_PATCHCODESEARCHPRIORITIES">
  2283. <summary>
  2284. A prioritized list of patch code types dictating the order in which patch codes will be sought.
  2285. </summary>
  2286. </member>
  2287. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_PATCHCODESEARCHMODE">
  2288. <summary>
  2289. Restricts patch code searching to certain orientations, or prioritizes one orientation over the other.
  2290. </summary>
  2291. </member>
  2292. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_PATCHCODEMAXRETRIES">
  2293. <summary>
  2294. Restricts the number of times a search will be retried if none are found on each page.
  2295. </summary>
  2296. </member>
  2297. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_PATCHCODETIMEOUT">
  2298. <summary>
  2299. Restricts the total time spent on searching for a patch code on each page.
  2300. </summary>
  2301. </member>
  2302. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_FLASHUSED2">
  2303. <summary>
  2304. For devices that support flash. CapSet() selects the flash to be used (if any). CapGet() reports the current setting.
  2305. This capability replaces ICAP_FLASHUSED, which is only able to negotiate the flash being on or off.
  2306. </summary>
  2307. </member>
  2308. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_IMAGEFILTER">
  2309. <summary>
  2310. For devices that support image enhancement filtering. This capability selects the algorithm used to improve the quality of the image.
  2311. </summary>
  2312. </member>
  2313. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_NOISEFILTER">
  2314. <summary>
  2315. For devices that support noise filtering. This capability selects the algorithm used to remove noise.
  2316. </summary>
  2317. </member>
  2318. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_OVERSCAN">
  2319. <summary>
  2320. Overscan is used to scan outside of the boundaries described by ICAP_FRAMES, and is used to help acquire image data that
  2321. may be lost because of skewing.
  2322. This is primarily of use for transport scanners which rely on edge detection to begin scanning.
  2323. If overscan is supported, then the device is capable of scanning in the inter-document gap to get the skewed image information.
  2324. </summary>
  2325. </member>
  2326. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_AUTOMATICBORDERDETECTION">
  2327. <summary>
  2328. Turns automatic border detection on and off.
  2329. </summary>
  2330. </member>
  2331. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_AUTOMATICDESKEW">
  2332. <summary>
  2333. Turns automatic deskew correction on and off.
  2334. </summary>
  2335. </member>
  2336. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_AUTOMATICROTATE">
  2337. <summary>
  2338. When TRUE this capability depends on intelligent features within the Source to automatically
  2339. rotate the image to the correct position.
  2340. </summary>
  2341. </member>
  2342. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_JPEGQUALITY">
  2343. <summary>
  2344. Use this capability as a shortcut to select JPEG quantization tables that tradeoff quality versus
  2345. compressed image size. Used in concert with DAT_JPEGCOMPRESSION it is possible for an Application
  2346. to obtain the tables that are appropriate for varying percentages of quality within a given source.
  2347. </summary>
  2348. </member>
  2349. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_FEEDERTYPE">
  2350. <summary>
  2351. Allows the Application to set scan parameters depending upon the type of feeder.
  2352. If the Source has a general type of the feeder only, default scan parameters can depend upon the type
  2353. of scan (general document or photo). In this case, negotiating this capability will allow the Source
  2354. adjusting the settings accordingly. It is advised, therefore, that this capabiliry be negotiated prior
  2355. to the capabilities related to specific Sourve settings (like ICAP_*RESOLUTION, ICAP_PIXELTYPE, etc.)
  2356. but after the other feeder-related capabilities (CAP_FEEDERENABLED, CAP_FEEDERLOADED).
  2357. </summary>
  2358. </member>
  2359. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_ICCPROFILE">
  2360. <summary>
  2361. Informs the application if the source has an ICC profile and can embed or link it in the current
  2362. ICAP_IMAGEFILEFORMAT. Tells the source if the application would like an ICC profile embedded or linked
  2363. into the image file the source will write.
  2364. </summary>
  2365. </member>
  2366. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_AUTOSIZE">
  2367. <summary>
  2368. Forces the output image dimensions to match either the current value of ICAP_SUPPORTEDSIZES or any of its
  2369. current allowed values.
  2370. </summary>
  2371. </member>
  2372. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_AUTOMATICCROPUSESFRAME">
  2373. <summary>
  2374. Sets True is DAT_IMAGELAYOUT, ICAP_SUPPORTEDSIZE or ICAP_FRAMES reduces the amount of data captured from
  2375. the device, potentially improving the performance of the driver, even if any automatic detection capability
  2376. like ICAP_AUTOMATICBORFERDETECTION is set to TRUE.
  2377. </summary>
  2378. </member>
  2379. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_AUTOMATICLENGTHDETECTION">
  2380. <summary>
  2381. Controls the automatic detection of the length of a document, this is intended for use with an Automatic
  2382. Document Feeder.
  2383. </summary>
  2384. </member>
  2385. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_AUTOMATICCOLORENABLED">
  2386. <summary>
  2387. The source automatically detects the pixel type of the image and returns either a color image or a non-color
  2388. image sprcified by ICAP_AUTOMATICCOLORNONCOLORPIXELTYPE.
  2389. </summary>
  2390. </member>
  2391. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_AUTOMATICCOLORNONCOLORPIXELTYPE">
  2392. <summary>
  2393. Specifies the non-color pixel type to use when automatic color is enabled.
  2394. </summary>
  2395. </member>
  2396. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_COLORMANAGEMENTENABLED">
  2397. <summary>
  2398. Disables the source's color and gamma tables for color and grayscale images, resulting in
  2399. output that could you be termed "raw".
  2400. </summary>
  2401. </member>
  2402. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_IMAGEMERGE">
  2403. <summary>
  2404. Merges the front and rear image of a document in one of four orientations: from on the top,
  2405. front on the bottom, from on the left or front on the right.
  2406. </summary>
  2407. </member>
  2408. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_IMAGEMERGEHEIGHTTHRESHOLD">
  2409. <summary>
  2410. Specifies a Y-Offset in ICAP_UNITS units. Front and rear images less than or equal to this
  2411. value are merged according to the settings of ICAP_IMAGEMERGE. If either the front or the rear
  2412. image is greater than this value, they are not merged.
  2413. </summary>
  2414. </member>
  2415. <member name="F:Dynamsoft.TWAIN.Enums.TWCapability.ICAP_SUPPORTEDEXTIMAGEINFO">
  2416. <summary>
  2417. Allows the application to query the data source to see if it supports the operation triplet
  2418. DG_IMAGE / DAT_EXTMAGEINFO / MSG_GET. Support is only available if the capabiliry is supported
  2419. and the value TRUE is allowed
  2420. When set to TRUE, the source supports the DG_IMAGE / DAT_EXTIMAGEINFO / MSG_GET message. and data
  2421. will be returned by this call for any supported TWEI_ items.
  2422. When set to FALSE, the application is indicating that it will make no calls to DG_IMAGE /
  2423. DAT_EXTIMAGEINFO / MSG_GET. FALSE is the default.
  2424. </summary>
  2425. </member>
  2426. <member name="T:Dynamsoft.TWAIN.Enums.TWCapLanguage">
  2427. <summary>
  2428. CAP_LANGUAGE values.
  2429. </summary>
  2430. </member>
  2431. <member name="T:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes">
  2432. <summary>
  2433. TWAIN Supported sizes.
  2434. </summary>
  2435. </member>
  2436. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_NONE">
  2437. <summary>
  2438. 0
  2439. </summary>
  2440. </member>
  2441. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_A4LETTER">
  2442. <summary>
  2443. 1
  2444. </summary>
  2445. </member>
  2446. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_B5LETTER">
  2447. <summary>
  2448. 2
  2449. </summary>
  2450. </member>
  2451. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_USLETTER">
  2452. <summary>
  2453. 3
  2454. </summary>
  2455. </member>
  2456. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_USLEGAL">
  2457. <summary>
  2458. 4
  2459. </summary>
  2460. </member>
  2461. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_A5">
  2462. <summary>
  2463. 5
  2464. </summary>
  2465. </member>
  2466. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_B4">
  2467. <summary>
  2468. 6
  2469. </summary>
  2470. </member>
  2471. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_B6">
  2472. <summary>
  2473. 7
  2474. </summary>
  2475. </member>
  2476. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_USLEDGER">
  2477. <summary>
  2478. 9
  2479. </summary>
  2480. </member>
  2481. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_USEXECUTIVE">
  2482. <summary>
  2483. 10
  2484. </summary>
  2485. </member>
  2486. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_A3">
  2487. <summary>
  2488. 11
  2489. </summary>
  2490. </member>
  2491. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_B3">
  2492. <summary>
  2493. 12
  2494. </summary>
  2495. </member>
  2496. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_A6">
  2497. <summary>
  2498. 13
  2499. </summary>
  2500. </member>
  2501. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_C4">
  2502. <summary>
  2503. 14
  2504. </summary>
  2505. </member>
  2506. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_C5">
  2507. <summary>
  2508. 15
  2509. </summary>
  2510. </member>
  2511. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_C6">
  2512. <summary>
  2513. 16
  2514. </summary>
  2515. </member>
  2516. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_4A0">
  2517. <summary>
  2518. 17
  2519. </summary>
  2520. </member>
  2521. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_2A0">
  2522. <summary>
  2523. 18
  2524. </summary>
  2525. </member>
  2526. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_A0">
  2527. <summary>
  2528. 19
  2529. </summary>
  2530. </member>
  2531. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_A1">
  2532. <summary>
  2533. 20
  2534. </summary>
  2535. </member>
  2536. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_A2">
  2537. <summary>
  2538. 21
  2539. </summary>
  2540. </member>
  2541. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_A4">
  2542. <summary>
  2543. 1
  2544. </summary>
  2545. </member>
  2546. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_A7">
  2547. <summary>
  2548. 22
  2549. </summary>
  2550. </member>
  2551. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_A8">
  2552. <summary>
  2553. 23
  2554. </summary>
  2555. </member>
  2556. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_A9">
  2557. <summary>
  2558. 24
  2559. </summary>
  2560. </member>
  2561. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_A10">
  2562. <summary>
  2563. 25
  2564. </summary>
  2565. </member>
  2566. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_ISOB0">
  2567. <summary>
  2568. 26
  2569. </summary>
  2570. </member>
  2571. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_ISOB1">
  2572. <summary>
  2573. 27
  2574. </summary>
  2575. </member>
  2576. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_ISOB2">
  2577. <summary>
  2578. 28
  2579. </summary>
  2580. </member>
  2581. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_ISOB3">
  2582. <summary>
  2583. 12
  2584. </summary>
  2585. </member>
  2586. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_ISOB4">
  2587. <summary>
  2588. 6
  2589. </summary>
  2590. </member>
  2591. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_ISOB5">
  2592. <summary>
  2593. 29
  2594. </summary>
  2595. </member>
  2596. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_ISOB6">
  2597. <summary>
  2598. 7
  2599. </summary>
  2600. </member>
  2601. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_ISOB7">
  2602. <summary>
  2603. 30
  2604. </summary>
  2605. </member>
  2606. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_ISOB8">
  2607. <summary>
  2608. 31
  2609. </summary>
  2610. </member>
  2611. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_ISOB9">
  2612. <summary>
  2613. 32
  2614. </summary>
  2615. </member>
  2616. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_ISOB10">
  2617. <summary>
  2618. 33
  2619. </summary>
  2620. </member>
  2621. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_JISB0">
  2622. <summary>
  2623. 34
  2624. </summary>
  2625. </member>
  2626. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_JISB1">
  2627. <summary>
  2628. 35
  2629. </summary>
  2630. </member>
  2631. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_JISB2">
  2632. <summary>
  2633. 36
  2634. </summary>
  2635. </member>
  2636. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_JISB3">
  2637. <summary>
  2638. 37
  2639. </summary>
  2640. </member>
  2641. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_JISB4">
  2642. <summary>
  2643. 38
  2644. </summary>
  2645. </member>
  2646. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_JISB5">
  2647. <summary>
  2648. 2
  2649. </summary>
  2650. </member>
  2651. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_JISB6">
  2652. <summary>
  2653. 39
  2654. </summary>
  2655. </member>
  2656. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_JISB7">
  2657. <summary>
  2658. 40
  2659. </summary>
  2660. </member>
  2661. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_JISB8">
  2662. <summary>
  2663. 41
  2664. </summary>
  2665. </member>
  2666. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_JISB9">
  2667. <summary>
  2668. 42
  2669. </summary>
  2670. </member>
  2671. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_JISB10">
  2672. <summary>
  2673. 43
  2674. </summary>
  2675. </member>
  2676. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_C0">
  2677. <summary>
  2678. 44
  2679. </summary>
  2680. </member>
  2681. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_C1">
  2682. <summary>
  2683. 45
  2684. </summary>
  2685. </member>
  2686. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_C2">
  2687. <summary>
  2688. 46
  2689. </summary>
  2690. </member>
  2691. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_C3">
  2692. <summary>
  2693. 47
  2694. </summary>
  2695. </member>
  2696. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_C7">
  2697. <summary>
  2698. 48
  2699. </summary>
  2700. </member>
  2701. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_C8">
  2702. <summary>
  2703. 49
  2704. </summary>
  2705. </member>
  2706. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_C9">
  2707. <summary>
  2708. 50
  2709. </summary>
  2710. </member>
  2711. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_C10">
  2712. <summary>
  2713. 51
  2714. </summary>
  2715. </member>
  2716. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_USSTATEMENT">
  2717. <summary>
  2718. 52
  2719. </summary>
  2720. </member>
  2721. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_BUSINESSCARD">
  2722. <summary>
  2723. 53
  2724. </summary>
  2725. </member>
  2726. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSupportedSizes.TWSS_MAXSIZE">
  2727. <summary>
  2728. 54
  2729. </summary>
  2730. </member>
  2731. <member name="T:Dynamsoft.TWAIN.Enums.TWICapDuplex">
  2732. <summary>
  2733. ICAP_DUPLEX values.
  2734. </summary>
  2735. </member>
  2736. <member name="T:Dynamsoft.TWAIN.Enums.TWCapFeederAlignment">
  2737. <summary>
  2738. CAP_FEEDERALIGNMENT values.
  2739. </summary>
  2740. </member>
  2741. <member name="F:Dynamsoft.TWAIN.Enums.TWCapFeederAlignment.TWFA_NONE">
  2742. <summary>
  2743. The alignment is free-floating. Applications should assume that the origin for frames is on the left.
  2744. </summary>
  2745. </member>
  2746. <member name="F:Dynamsoft.TWAIN.Enums.TWCapFeederAlignment.TWFA_LEFT">
  2747. <summary>
  2748. The alignment is to the left.
  2749. </summary>
  2750. </member>
  2751. <member name="F:Dynamsoft.TWAIN.Enums.TWCapFeederAlignment.TWFA_CENTER">
  2752. <summary>
  2753. The alignment is centered. This means that the paper will be fed in the middle of the ICAP_PHYSICALWIDTH of the
  2754. device. If this is set, then the Application should calculate any frames with a left offset of zero.
  2755. </summary>
  2756. </member>
  2757. <member name="F:Dynamsoft.TWAIN.Enums.TWCapFeederAlignment.TWFA_RIGHT">
  2758. <summary>
  2759. The alignment is to the right.
  2760. </summary>
  2761. </member>
  2762. <member name="T:Dynamsoft.TWAIN.Enums.TWCapFeederOrder">
  2763. <summary>
  2764. CAP_FEEDERORDER values.
  2765. </summary>
  2766. </member>
  2767. <member name="F:Dynamsoft.TWAIN.Enums.TWCapFeederOrder.TWFO_FIRSTPAGEFIRST">
  2768. <summary>
  2769. The feeder starts with the top of the first page.
  2770. </summary>
  2771. </member>
  2772. <member name="F:Dynamsoft.TWAIN.Enums.TWCapFeederOrder.TWFO_LASTPAGEFIRST">
  2773. <summary>
  2774. The feeder starts with the top of the last page.
  2775. </summary>
  2776. </member>
  2777. <member name="T:Dynamsoft.TWAIN.Enums.TWICapSetupXFer">
  2778. <summary>
  2779. ICAP_XFERMECH values.
  2780. </summary>
  2781. </member>
  2782. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSetupXFer.TWSX_NATIVE">
  2783. <summary>
  2784. Native transfers require the data to be transferred to a single large block of RAM. Therefore,
  2785. they always face the risk of having an inadequate amount of RAM available to perform the transfer successfully.
  2786. </summary>
  2787. </member>
  2788. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSetupXFer.TWSX_FILE">
  2789. <summary>
  2790. Disk File Mode Transfers.
  2791. </summary>
  2792. </member>
  2793. <member name="F:Dynamsoft.TWAIN.Enums.TWICapSetupXFer.TWSX_MEMORY">
  2794. <summary>
  2795. Buffered Memory Mode Transfers.
  2796. </summary>
  2797. </member>
  2798. <member name="T:Dynamsoft.TWAIN.Enums.TWICapFileFormat">
  2799. <summary>
  2800. ICAP_IMAGEFILEFORMAT values.
  2801. </summary>
  2802. </member>
  2803. <member name="F:Dynamsoft.TWAIN.Enums.TWICapFileFormat.TWFF_TIFF">
  2804. <summary>
  2805. Used for document imaging.
  2806. </summary>
  2807. </member>
  2808. <member name="F:Dynamsoft.TWAIN.Enums.TWICapFileFormat.TWFF_PICT">
  2809. <summary>
  2810. Native Macintosh format.
  2811. </summary>
  2812. </member>
  2813. <member name="F:Dynamsoft.TWAIN.Enums.TWICapFileFormat.TWFF_BMP">
  2814. <summary>
  2815. Native Microsoft format.
  2816. </summary>
  2817. </member>
  2818. <member name="F:Dynamsoft.TWAIN.Enums.TWICapFileFormat.TWFF_XBM">
  2819. <summary>
  2820. Used for document imaging.
  2821. </summary>
  2822. </member>
  2823. <member name="F:Dynamsoft.TWAIN.Enums.TWICapFileFormat.TWFF_JFIF">
  2824. <summary>
  2825. Wrapper for JPEG images.
  2826. </summary>
  2827. </member>
  2828. <member name="F:Dynamsoft.TWAIN.Enums.TWICapFileFormat.TWFF_FPX">
  2829. <summary>
  2830. FlashPix, used with digital cameras.
  2831. </summary>
  2832. </member>
  2833. <member name="F:Dynamsoft.TWAIN.Enums.TWICapFileFormat.TWFF_TIFFMULTI">
  2834. <summary>
  2835. Multi-page TIFF files.
  2836. </summary>
  2837. </member>
  2838. <member name="F:Dynamsoft.TWAIN.Enums.TWICapFileFormat.TWFF_PNG">
  2839. <summary>
  2840. An image format standard intended for use on the web, replaces GIF.
  2841. </summary>
  2842. </member>
  2843. <member name="F:Dynamsoft.TWAIN.Enums.TWICapFileFormat.TWFF_SPIFF">
  2844. <summary>
  2845. A standard from JPEG, intended to replace JFIF, also supports JBIG.
  2846. </summary>
  2847. </member>
  2848. <member name="F:Dynamsoft.TWAIN.Enums.TWICapFileFormat.TWFF_EXIF">
  2849. <summary>
  2850. File format for use with digital cameras.
  2851. </summary>
  2852. </member>
  2853. <member name="F:Dynamsoft.TWAIN.Enums.TWICapFileFormat.TWFF_PDF">
  2854. <summary>
  2855. A file format from Adobe.
  2856. </summary>
  2857. </member>
  2858. <member name="F:Dynamsoft.TWAIN.Enums.TWICapFileFormat.TWFF_JP2">
  2859. <summary>
  2860. A file format from the Joint Photographic Experts Group.
  2861. </summary>
  2862. </member>
  2863. <member name="F:Dynamsoft.TWAIN.Enums.TWICapFileFormat.TWFF_DEJAVU">
  2864. <summary>
  2865. A file format from LizardTech.
  2866. </summary>
  2867. </member>
  2868. <member name="F:Dynamsoft.TWAIN.Enums.TWICapFileFormat.TWFF_PDFA">
  2869. <summary>
  2870. A file format from Adobe.
  2871. </summary>
  2872. </member>
  2873. <member name="T:Dynamsoft.TWAIN.Enums.TWCapPrinter">
  2874. <summary>
  2875. CAP_PRINTER values.
  2876. </summary>
  2877. </member>
  2878. <member name="T:Dynamsoft.TWAIN.Enums.TWCapPrinterMode">
  2879. <summary>
  2880. CAP_PRINTERMODE values.
  2881. </summary>
  2882. </member>
  2883. <member name="F:Dynamsoft.TWAIN.Enums.TWCapPrinterMode.TWPM_SINGLESTRING">
  2884. <summary>
  2885. Specifies that the printed text will consist of a single string.
  2886. </summary>
  2887. </member>
  2888. <member name="F:Dynamsoft.TWAIN.Enums.TWCapPrinterMode.TWPM_MULTISTRING">
  2889. <summary>
  2890. Specifies that the printed text will consist of an enumerated list of strings to be printed in order.
  2891. </summary>
  2892. </member>
  2893. <member name="F:Dynamsoft.TWAIN.Enums.TWCapPrinterMode.TWPM_COMPOUNDSTRING">
  2894. <summary>
  2895. Specifies that the printed string will consist of a compound of a String followed by a value followed by a suffix string.
  2896. </summary>
  2897. </member>
  2898. <member name="T:Dynamsoft.TWAIN.Enums.TWICapBitdepthReduction">
  2899. <summary>
  2900. ICAP_BITDEPTHREDUCTION values.
  2901. </summary>
  2902. </member>
  2903. <member name="T:Dynamsoft.TWAIN.Enums.TWICapBitOrder">
  2904. <summary>
  2905. ICAP_BITORDER values.
  2906. </summary>
  2907. </member>
  2908. <member name="F:Dynamsoft.TWAIN.Enums.TWICapBitOrder.TWBO_MSBFIRST">
  2909. <summary>
  2910. Indicates that the leftmost bit in the byte (usually bit 7) is the byte’s Most Significant Bit.
  2911. </summary>
  2912. </member>
  2913. <member name="T:Dynamsoft.TWAIN.Enums.TWICapFilterType">
  2914. <summary>
  2915. ICAP_FILTER values.
  2916. </summary>
  2917. </member>
  2918. <member name="T:Dynamsoft.TWAIN.Enums.TWICapFlash">
  2919. <summary>
  2920. ICAP_FLASHUSED2 values.
  2921. </summary>
  2922. </member>
  2923. <member name="T:Dynamsoft.TWAIN.Enums.TWICapFlipRotation">
  2924. <summary>
  2925. ICAP_FLIPROTATION values.
  2926. </summary>
  2927. </member>
  2928. <member name="F:Dynamsoft.TWAIN.Enums.TWICapFlipRotation.TWFR_BOOK">
  2929. <summary>
  2930. The images to be scanned are viewed in book form, flipping each page from left to right or right to left.
  2931. </summary>
  2932. </member>
  2933. <member name="F:Dynamsoft.TWAIN.Enums.TWICapFlipRotation.TWFR_FANFOLD">
  2934. <summary>
  2935. The images to be scanned are viewed in fanfold paper style, flipping each page up or down.
  2936. </summary>
  2937. </member>
  2938. <member name="T:Dynamsoft.TWAIN.Enums.TWICapImageFilter">
  2939. <summary>
  2940. ICAP_IMAGEFILTER values.
  2941. </summary>
  2942. </member>
  2943. <member name="F:Dynamsoft.TWAIN.Enums.TWICapImageFilter.TWIF_LOWPASS">
  2944. <summary>
  2945. Good for halftone images.
  2946. </summary>
  2947. </member>
  2948. <member name="F:Dynamsoft.TWAIN.Enums.TWICapImageFilter.TWIF_BANDPASS">
  2949. <summary>
  2950. Good for improving text.
  2951. </summary>
  2952. </member>
  2953. <member name="F:Dynamsoft.TWAIN.Enums.TWICapImageFilter.TWIF_HIGHPASS">
  2954. <summary>
  2955. Good for improving fine lines.
  2956. </summary>
  2957. </member>
  2958. <member name="T:Dynamsoft.TWAIN.Enums.TWICapLightPath">
  2959. <summary>
  2960. ICAP_LIGHTPATH values.
  2961. </summary>
  2962. </member>
  2963. <member name="T:Dynamsoft.TWAIN.Enums.TWICapLightSource">
  2964. <summary>
  2965. ICAP_LIGHTSOURCE values.
  2966. </summary>
  2967. </member>
  2968. <member name="T:Dynamsoft.TWAIN.Enums.TWEIMagType">
  2969. <summary>
  2970. TWEI_MAGTYPE values. (MD_ means Mag Type) Added 2.0
  2971. </summary>
  2972. </member>
  2973. <member name="T:Dynamsoft.TWAIN.Enums.TWICapNoiseFilter">
  2974. <summary>
  2975. ICAP_NOISEFILTER values.
  2976. </summary>
  2977. </member>
  2978. <member name="T:Dynamsoft.TWAIN.Enums.TWICapORientation">
  2979. <summary>
  2980. ICAP_ORIENTATION values.
  2981. </summary>
  2982. </member>
  2983. <member name="T:Dynamsoft.TWAIN.Enums.TWICapOverscan">
  2984. <summary>
  2985. ICAP_OVERSCAN values.
  2986. </summary>
  2987. </member>
  2988. <member name="T:Dynamsoft.TWAIN.Enums.TWICapPixelFlavor">
  2989. <summary>
  2990. ICAP_PIXELFLAVOR values.
  2991. </summary>
  2992. </member>
  2993. <member name="F:Dynamsoft.TWAIN.Enums.TWICapPixelFlavor.TWPF_CHOCOLATE">
  2994. <summary>
  2995. Zero pixel represents darkest shade.
  2996. </summary>
  2997. </member>
  2998. <member name="F:Dynamsoft.TWAIN.Enums.TWICapPixelFlavor.TWPF_VANILLA">
  2999. <summary>
  3000. Zero pixel represents lightest shade.
  3001. </summary>
  3002. </member>
  3003. <member name="T:Dynamsoft.TWAIN.Enums.TWICapPixelType">
  3004. <summary>
  3005. ICAP_PIXELTYPE values.
  3006. </summary>
  3007. </member>
  3008. <member name="T:Dynamsoft.TWAIN.Enums.TWICapPlanarChunky">
  3009. <summary>
  3010. ICAP_PLANARCHUNKY values.
  3011. </summary>
  3012. </member>
  3013. <member name="T:Dynamsoft.TWAIN.Enums.TWICapUNits">
  3014. <summary>
  3015. ICAP_UNITS values.
  3016. </summary>
  3017. </member>
  3018. <member name="T:Dynamsoft.TWAIN.Enums.TWQC">
  3019. <summary>
  3020. For query the operation that are supported by the data source on a capability .
  3021. Application gets these through DG_CONTROL/DAT_CAPABILITY/MSG_QUERYSUPPORT
  3022. </summary>
  3023. </member>
  3024. <member name="T:Dynamsoft.TWAIN.Enums.TWDataSourceStatus">
  3025. <summary>
  3026. Data source status.
  3027. </summary>
  3028. </member>
  3029. <member name="F:Dynamsoft.TWAIN.Enums.TWDataSourceStatus.TWDSS_CLOSED">
  3030. <summary>
  3031. Indicate the data source is closed.
  3032. </summary>
  3033. </member>
  3034. <member name="F:Dynamsoft.TWAIN.Enums.TWDataSourceStatus.TWDSS_OPENED">
  3035. <summary>
  3036. Indicate the data source is opened.
  3037. </summary>
  3038. </member>
  3039. <member name="F:Dynamsoft.TWAIN.Enums.TWDataSourceStatus.TWDSS_ENABLED">
  3040. <summary>
  3041. Indicate the data source is enabled.
  3042. </summary>
  3043. </member>
  3044. <member name="F:Dynamsoft.TWAIN.Enums.TWDataSourceStatus.TWDSS_ACQUIRING">
  3045. <summary>
  3046. Indicate the data source is acquiring image.
  3047. </summary>
  3048. </member>
  3049. <member name="T:Dynamsoft.TWAIN.Enums.TWEIBarcode">
  3050. <summary>
  3051. Barcode type
  3052. </summary>
  3053. </member>
  3054. <member name="F:Dynamsoft.TWAIN.Enums.TWEIBarcode.TWEI_BARCODEX">
  3055. <summary>
  3056. </summary>
  3057. </member>
  3058. <member name="F:Dynamsoft.TWAIN.Enums.TWEIBarcode.TWEI_BARCODEY">
  3059. <summary>
  3060. </summary>
  3061. </member>
  3062. <member name="F:Dynamsoft.TWAIN.Enums.TWEIBarcode.TWEI_BARCODETEXT">
  3063. <summary>
  3064. </summary>
  3065. </member>
  3066. <member name="F:Dynamsoft.TWAIN.Enums.TWEIBarcode.TWEI_BARCODETYPE">
  3067. <summary>
  3068. </summary>
  3069. </member>
  3070. <member name="F:Dynamsoft.TWAIN.Enums.TWEIBarcode.TWEI_BARCODECOUNT">
  3071. <summary>
  3072. Returns the number of bar codes found on the document image. A
  3073. value of 0 means the bar code engine was enabled but that no bar
  3074. codes were found. A value of -1 means the bar code engine was not enabled.
  3075. </summary>
  3076. </member>
  3077. <member name="F:Dynamsoft.TWAIN.Enums.TWEIBarcode.TWEI_BARCODECONFIDENCE">
  3078. <summary>
  3079. This number reflects the degree of certainty the bar code engine has in
  3080. the accuracy of the information obtained from the scanned image and
  3081. ranges from 0 (no confidence) to 100 (supreme confidence). The Source may
  3082. return a value of -1 if it does not support confidence reporting.
  3083. TWBCOR_ROT0 Normal reading orientation
  3084. TWBCOR_ROT90 Rotated 90 degrees clockwise
  3085. TWBCOR_ROT180 Rotated 180 degrees clockwise
  3086. TWBCOR_ROT270 Rotated 270 degrees clockwise
  3087. TWBCOR_ROTX The orientation is not known.
  3088. </summary>
  3089. </member>
  3090. <member name="F:Dynamsoft.TWAIN.Enums.TWEIBarcode.TWEI_BARCODEROTATION">
  3091. <summary>
  3092. The bar code’s orientation on the scanned image is described in
  3093. reference to a Western-style interpretation of the image.
  3094. </summary>
  3095. </member>
  3096. <member name="F:Dynamsoft.TWAIN.Enums.TWEIBarcode.TWEI_BARCODETEXTLENGTH">
  3097. <summary>
  3098. </summary>
  3099. </member>
  3100. <member name="T:Dynamsoft.TWAIN.Enums.ErrorCode">
  3101. <summary>
  3102. DynamicDotNetTWAIN error code.
  3103. </summary>
  3104. </member>
  3105. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.Succeed">
  3106. <summary>
  3107. Successful.
  3108. </summary>
  3109. </member>
  3110. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_SUCCESS">
  3111. <summary>
  3112. Successful.
  3113. </summary>
  3114. </member>
  3115. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_BUMMER">
  3116. <summary>
  3117. General error.
  3118. </summary>
  3119. </member>
  3120. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_LOWMEMORY">
  3121. <summary>
  3122. No enough memory to perform the required operation.
  3123. </summary>
  3124. </member>
  3125. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_NODS">
  3126. <summary>
  3127. Source Manager is unable to find the specified Source.
  3128. </summary>
  3129. </member>
  3130. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_MAXCONNECTIONS">
  3131. <summary>
  3132. Source is connected to maximum supported number of applications.
  3133. </summary>
  3134. </member>
  3135. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_OPERATIONERROR">
  3136. <summary>
  3137. Source or Source Manager reported an error to the user and handled the error.
  3138. </summary>
  3139. </member>
  3140. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_BADCAP">
  3141. <summary>
  3142. Capability is not supported by Source or the specified operation is not supported by the capability, or capability had dependencies on other capabilities and cannot be operated upon at this time.
  3143. </summary>
  3144. </member>
  3145. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_BADPROTOCOL">
  3146. <summary>
  3147. Unrecognized operation triplet.
  3148. </summary>
  3149. </member>
  3150. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_BADVALUE">
  3151. <summary>
  3152. Data parameter out of supported range.
  3153. </summary>
  3154. </member>
  3155. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_SEQERROR">
  3156. <summary>
  3157. Operation out of expected sequence.
  3158. </summary>
  3159. </member>
  3160. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_BADDEST">
  3161. <summary>
  3162. Unknown destination in DSM_Entry.
  3163. </summary>
  3164. </member>
  3165. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_CAPUNSUPPORTED">
  3166. <summary>
  3167. Capability is not supported by source.
  3168. </summary>
  3169. </member>
  3170. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_CAPBADOPERATION">
  3171. <summary>
  3172. Operation is not supported by the capability.
  3173. </summary>
  3174. </member>
  3175. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_CAPSEQERROR">
  3176. <summary>
  3177. Capability has dependencies on other capabilities and cannot be operated upon at this time.
  3178. </summary>
  3179. </member>
  3180. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_DENIED">
  3181. <summary>
  3182. File System operation is denied (file is protected).
  3183. </summary>
  3184. </member>
  3185. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_FILEEXISTS">
  3186. <summary>
  3187. Operation failed because file already exists.
  3188. </summary>
  3189. </member>
  3190. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_FILENOTFOUND">
  3191. <summary>
  3192. File not found.
  3193. </summary>
  3194. </member>
  3195. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_NOTEMPTY">
  3196. <summary>
  3197. Operation failed because directory is not empty.
  3198. </summary>
  3199. </member>
  3200. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_PAPERJAM">
  3201. <summary>
  3202. The feeder is jammed.
  3203. </summary>
  3204. </member>
  3205. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_PAPERDOUBLEFEED">
  3206. <summary>
  3207. The feeder detected multiple pages.
  3208. </summary>
  3209. </member>
  3210. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_FILEWRITEERROR">
  3211. <summary>
  3212. Error writing file.
  3213. </summary>
  3214. </member>
  3215. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWCC_CHECKDEVICEONLINE">
  3216. <summary>
  3217. The device went offline prior to or during this operation.
  3218. </summary>
  3219. </member>
  3220. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_GeneralError">
  3221. <summary>
  3222. General error.
  3223. </summary>
  3224. </member>
  3225. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_SystemException">
  3226. <summary>
  3227. System exception.
  3228. </summary>
  3229. </member>
  3230. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_INVALID_LICENSE">
  3231. <summary>
  3232. Invalid license.
  3233. </summary>
  3234. </member>
  3235. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_OPENDSM">
  3236. <summary>
  3237. Can not open Source Manager. TWain_32.dll is missing or is in use by another application.
  3238. </summary>
  3239. </member>
  3240. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_SEQUENCE">
  3241. <summary>
  3242. Sequence error. The operation can not be performed upon the current Source Manager or Source state.
  3243. </summary>
  3244. </member>
  3245. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_CANCEL">
  3246. <summary>
  3247. User cancelled the operation.
  3248. </summary>
  3249. </member>
  3250. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_INDEX">
  3251. <summary>
  3252. Invalid index.
  3253. </summary>
  3254. </member>
  3255. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_VALUE">
  3256. <summary>
  3257. Invalid value.
  3258. </summary>
  3259. </member>
  3260. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_BADPARAMETER">
  3261. <summary>
  3262. Data parameter out of supported range.
  3263. </summary>
  3264. </member>
  3265. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_MAXIMAGESEXCEEDED">
  3266. <summary>
  3267. The number of images exceeds the max value.
  3268. </summary>
  3269. </member>
  3270. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_MOUSESHAPETRUE">
  3271. <summary>
  3272. MouseShape is true. Need to set MouseShape to false.
  3273. </summary>
  3274. </member>
  3275. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_EXTENSION">
  3276. <summary>
  3277. Unrecognized file extension.
  3278. </summary>
  3279. </member>
  3280. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_BMP">
  3281. <summary>
  3282. BMP format error or not supported.
  3283. </summary>
  3284. </member>
  3285. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_NOTSUPPORTIMAGE">
  3286. <summary>
  3287. Image format is not supported.
  3288. </summary>
  3289. </member>
  3290. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_INVALID_IMAGE">
  3291. <summary>
  3292. Invalid image index. Original image does't exist.
  3293. </summary>
  3294. </member>
  3295. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_OPERATION_TIMEOUT">
  3296. <summary>
  3297. The operation time out.
  3298. </summary>
  3299. </member>
  3300. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_UPLOADFAILEDFORTOOBIG">
  3301. <summary>
  3302. The file too big for upload.
  3303. </summary>
  3304. </member>
  3305. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_FTP_HANDSHAKEEXCEPTION">
  3306. <summary>
  3307. Handshake exception.
  3308. </summary>
  3309. </member>
  3310. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_FTP_INVALIDPROXYUSERNAMEORPASSWORD">
  3311. <summary>
  3312. Proxy username or password invalid.
  3313. </summary>
  3314. </member>
  3315. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_FTP_PROTOCOLREQUESTNOTPASS">
  3316. <summary>
  3317. Protocol request is not passed.
  3318. </summary>
  3319. </member>
  3320. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_FTP_NOTCONNECTREMOTESERVER">
  3321. <summary>
  3322. Can't connect to remote server.
  3323. </summary>
  3324. </member>
  3325. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_FTP_MALFORMEDPASVRESULT">
  3326. <summary>
  3327. Malformed PASV result:
  3328. </summary>
  3329. </member>
  3330. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_FTP_MALFORMEDPASVRESULTNOTSUPPORTED">
  3331. <summary>
  3332. Malformed PASV result (not supported):
  3333. </summary>
  3334. </member>
  3335. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_PDF_ERRORINREADPDF">
  3336. <summary>
  3337. Error in reading PDF file.
  3338. </summary>
  3339. </member>
  3340. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_PDF_ERRORINWRITEPDF">
  3341. <summary>
  3342. Error in writing PDF file.
  3343. </summary>
  3344. </member>
  3345. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_IMAGE_ERRORBIGIMAGE">
  3346. <summary>
  3347. The image too big for resample.
  3348. </summary>
  3349. </member>
  3350. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.WEBCAM_ERROR">
  3351. <summary>
  3352. The image too big for resample.
  3353. </summary>
  3354. </member>
  3355. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.OCR_ERROR">
  3356. <summary>
  3357. Failed to do OCR.
  3358. </summary>
  3359. </member>
  3360. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_DEVICE_NOT_SUPPORT">
  3361. <summary>
  3362. The current selected device type not supports the method or property.
  3363. </summary>
  3364. </member>
  3365. <member name="F:Dynamsoft.TWAIN.Enums.ErrorCode.TWERR_PRINT_NO_PAGE">
  3366. <summary>
  3367. There is no page to be printed.
  3368. </summary>
  3369. </member>
  3370. <member name="T:Dynamsoft.TWAIN.TwainException">
  3371. <summary>
  3372. TWAIN exception class definition.
  3373. </summary>
  3374. </member>
  3375. <member name="M:Dynamsoft.TWAIN.TwainException.#ctor">
  3376. <summary>
  3377. Initializes a new instance of the TwainException class.
  3378. </summary>
  3379. </member>
  3380. <member name="M:Dynamsoft.TWAIN.TwainException.#ctor(System.String)">
  3381. <summary>
  3382. Initializes a new instance of the TwainException class with a specified error message.
  3383. </summary>
  3384. <param name="strError">The message that describes the error.</param>
  3385. </member>
  3386. <member name="M:Dynamsoft.TWAIN.TwainException.#ctor(System.String,Dynamsoft.TWAIN.Enums.ErrorCode)">
  3387. <summary>
  3388. Initializes a new instance of the TwainException class with a specified error message and error code.
  3389. </summary>
  3390. <param name="strError">The message that describes the error.</param>
  3391. <param name="errCode">The error code.</param>
  3392. </member>
  3393. <member name="P:Dynamsoft.TWAIN.TwainException.Code">
  3394. <summary>
  3395. Get and set error code.
  3396. </summary>
  3397. </member>
  3398. <member name="P:Dynamsoft.TWAIN.TwainException.Message">
  3399. <summary>
  3400. Gets a message that describes the current exception.
  3401. </summary>
  3402. </member>
  3403. <member name="P:Dynamsoft.TWAIN.TwainException.StackTrace">
  3404. <summary>
  3405. Gets a string representation of the frames on the call stack at the time the current exception was thrown.
  3406. </summary>
  3407. </member>
  3408. <member name="T:Dynamsoft.TWAIN.Interface.IAcquireCallback">
  3409. <summary>
  3410. The callback function of the scan task.
  3411. </summary>
  3412. </member>
  3413. <member name="M:Dynamsoft.TWAIN.Interface.IAcquireCallback.OnPreAllTransfers">
  3414. <summary>
  3415. TwainManager object calls OnPreAllTransfers before all images are scanned.
  3416. </summary>
  3417. </member>
  3418. <member name="M:Dynamsoft.TWAIN.Interface.IAcquireCallback.OnPreTransfer">
  3419. <summary>
  3420. TwainManager object calls OnPreTransfer before each image is scanned.
  3421. </summary>
  3422. <returns>If it returns true, the scan job will continue. Otherwise, it will break.</returns>
  3423. </member>
  3424. <member name="M:Dynamsoft.TWAIN.Interface.IAcquireCallback.OnPostTransfer(System.Drawing.Bitmap,System.String)">
  3425. <summary>
  3426. TwainManager object calls OnPostTransfer after each image is scanned.
  3427. </summary>
  3428. <param name="bit">Scanner returned image</param>
  3429. <param name="info">Scanner returned image info and extended info</param>
  3430. <returns>If it returns true, the scan job will continue. Otherwise, it will break.</returns>
  3431. </member>
  3432. <member name="M:Dynamsoft.TWAIN.Interface.IAcquireCallback.OnPostAllTransfers">
  3433. <summary>
  3434. TwainManager object calls OnPostAllTransfer after all images are scanned.
  3435. </summary>
  3436. </member>
  3437. <member name="M:Dynamsoft.TWAIN.Interface.IAcquireCallback.OnSourceUIClose">
  3438. <summary>
  3439. TwainManager object calls OnSourceUIClose when the user clicks on the "Close" button of the Source's user interface.
  3440. </summary>
  3441. </member>
  3442. <member name="M:Dynamsoft.TWAIN.Interface.IAcquireCallback.OnTransferCancelled">
  3443. <summary>
  3444. TwainManager object calls OnTransferCancelled when the transfer is cancelled by the user.
  3445. </summary>
  3446. </member>
  3447. <member name="M:Dynamsoft.TWAIN.Interface.IAcquireCallback.OnTransferError">
  3448. <summary>
  3449. TwainManager object calls OnTransferError when an error occurs during the process of transfer.
  3450. </summary>
  3451. </member>
  3452. <member name="P:Dynamsoft.TWAIN.Interface.IAcquireCallback.IfGetImageInfo">
  3453. <summary>
  3454. If it is set to true the image info will be returned during scanning.
  3455. </summary>
  3456. </member>
  3457. <member name="P:Dynamsoft.TWAIN.Interface.IAcquireCallback.IfGetExtImageInfo">
  3458. <summary>
  3459. If it is set to true the extended image info will be returned during scanning.
  3460. </summary>
  3461. </member>
  3462. <member name="M:Dynamsoft.TWAIN.Interface.IImageEvent.OnTransferError">
  3463. <summary>
  3464. This event is triggered when the transfer
  3465. </summary>
  3466. </member>
  3467. <member name="T:Dynamsoft.TWAIN.Interface.ITwainException">
  3468. <summary>
  3469. DynamicDotNetTWAIN exception interface definition.
  3470. </summary>
  3471. </member>
  3472. <member name="P:Dynamsoft.TWAIN.Interface.ITwainException.Code">
  3473. <summary>
  3474. Get exception error code.
  3475. </summary>
  3476. <returns>
  3477. Exception error code.
  3478. </returns>
  3479. </member>
  3480. <member name="P:Dynamsoft.TWAIN.Interface.ITwainException.Message">
  3481. <summary>
  3482. Get exception error string.
  3483. </summary>
  3484. <returns>
  3485. Exception error string.
  3486. </returns>
  3487. </member>
  3488. <member name="P:Dynamsoft.TWAIN.Interface.ITwainException.StackTrace">
  3489. <summary>
  3490. Get exception stack trace as string.
  3491. </summary>
  3492. <returns>
  3493. Exception stack trace.
  3494. </returns>
  3495. </member>
  3496. <member name="T:DynamsoftLicense.EnumProductType">
  3497. <summary>
  3498. from license v1, change to unsigned int64
  3499. </summary>
  3500. </member>
  3501. <member name="T:DynamsoftLicense.EnumOSType">
  3502. <summary>
  3503. from license v1, change to unsigned short
  3504. </summary>
  3505. </member>
  3506. <member name="T:DynamsoftLicense.EnumReserved">
  3507. <summary>
  3508. from license v1, change to unsigned int64
  3509. </summary>
  3510. </member>
  3511. <member name="T:DynamsoftLicense.EnumDistributeType">
  3512. <summary>
  3513. from license v1, change to unsigned int
  3514. </summary>
  3515. </member>
  3516. <member name="T:Dynamsoft.TWAIN.Properties.Resources">
  3517. <summary>
  3518. A strongly-typed resource class, for looking up localized strings, etc.
  3519. </summary>
  3520. </member>
  3521. <member name="P:Dynamsoft.TWAIN.Properties.Resources.ResourceManager">
  3522. <summary>
  3523. Returns the cached ResourceManager instance used by this class.
  3524. </summary>
  3525. </member>
  3526. <member name="P:Dynamsoft.TWAIN.Properties.Resources.Culture">
  3527. <summary>
  3528. Overrides the current thread's CurrentUICulture property for all
  3529. resource lookups using this strongly typed resource class.
  3530. </summary>
  3531. </member>
  3532. <member name="P:Dynamsoft.TWAIN.Properties.Resources.dnt_about">
  3533. <summary>
  3534. Looks up a localized resource of type System.Drawing.Bitmap.
  3535. </summary>
  3536. </member>
  3537. <member name="P:Dynamsoft.TWAIN.Properties.Resources.ds_logo4">
  3538. <summary>
  3539. Looks up a localized resource of type System.Drawing.Bitmap.
  3540. </summary>
  3541. </member>
  3542. <member name="P:Dynamsoft.TWAIN.Properties.Resources.DynamicNETTWAIN_logo">
  3543. <summary>
  3544. Looks up a localized resource of type System.Drawing.Bitmap.
  3545. </summary>
  3546. </member>
  3547. <member name="P:Dynamsoft.TWAIN.Properties.Resources.DynamsoftScanning">
  3548. <summary>
  3549. Looks up a localized resource of type System.Byte[].
  3550. </summary>
  3551. </member>
  3552. <member name="P:Dynamsoft.TWAIN.Properties.Resources.TWAINDSM">
  3553. <summary>
  3554. Looks up a localized resource of type System.Byte[].
  3555. </summary>
  3556. </member>
  3557. <member name="P:Dynamsoft.TWAIN.Properties.Resources.watermark_greyscale">
  3558. <summary>
  3559. Looks up a localized resource of type System.Drawing.Bitmap.
  3560. </summary>
  3561. </member>
  3562. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_IDENTITY">
  3563. <summary>
  3564. /* DAT_IDENTITY. Identifies the program/library/code resource. */
  3565. </summary>
  3566. </member>
  3567. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_SETUPFILEXFER">
  3568. <summary>
  3569. /* DAT_SETUPFILEXFER. Sets up DS to application data transfer via a file. */
  3570. </summary>
  3571. </member>
  3572. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_CAPABILITY">
  3573. <summary>
  3574. /* DAT_CAPABILITY. Used by application to get/set capability from/in a data source. */
  3575. </summary>
  3576. </member>
  3577. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_ARRAY">
  3578. <summary>
  3579. /* TWON_ARRAY. Container for array of values (a simplified TW_ENUMERATION) */
  3580. </summary>
  3581. </member>
  3582. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_ENUMERATION">
  3583. <summary>
  3584. /* TWON_ENUMERATION. Container for a collection of values. */
  3585. </summary>
  3586. </member>
  3587. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_STATUS">
  3588. <summary>
  3589. /* DAT_STATUS. Application gets detailed status info from a data source with this. */
  3590. </summary>
  3591. </member>
  3592. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_USERINTERFACE">
  3593. <summary>
  3594. /* DAT_USERINTERFACE. Coordinates UI between application and data source. */
  3595. </summary>
  3596. </member>
  3597. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_IMAGEINFO">
  3598. <summary>
  3599. /* DAT_IMAGEINFO. Application gets detailed image info from DS with this. */
  3600. </summary>
  3601. </member>
  3602. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_PENDINGXFERS">
  3603. <summary>
  3604. /* DAT_PENDINGXFERS. Used with MSG_ENDXFER to indicate additional data. */
  3605. </summary>
  3606. </member>
  3607. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_RANGE">
  3608. <summary>
  3609. /* TWON_RANGE. Container for a range of values. */
  3610. </summary>
  3611. </member>
  3612. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_IMAGEMEMXFER">
  3613. <summary>
  3614. /* DAT_IMAGEMEMXFER. Used to pass image data (e.g. in strips) from DS to application.*/
  3615. </summary>
  3616. </member>
  3617. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_SETUPMEMXFER">
  3618. <summary>
  3619. /* DAT_SETUPMEMXFER. Sets up DS to application data transfer via a memory buffer. */
  3620. </summary>
  3621. </member>
  3622. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_PALETTE8">
  3623. <summary>
  3624. /* DAT_PALETTE8. Color palette when TWPT_PALETTE pixels xfer'd in mem buf. */
  3625. </summary>
  3626. </member>
  3627. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_VERSION">
  3628. <summary>
  3629. /* No DAT needed. Describes version of software currently running. */
  3630. </summary>
  3631. </member>
  3632. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_HANDLE">
  3633. <summary>
  3634. Memory handle define
  3635. </summary>
  3636. </member>
  3637. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_FIX32">
  3638. <summary>
  3639. /* Fixed point structure type. */
  3640. </summary>
  3641. </member>
  3642. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_EVENT">
  3643. <summary>
  3644. /* DAT_EVENT. For passing events down from the application to the DS. */
  3645. </summary>
  3646. </member>
  3647. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_FRAME">
  3648. <summary>
  3649. /* No DAT. Defines a frame rectangle in ICAP_UNITS coordinates. */
  3650. </summary>
  3651. </member>
  3652. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_ONEVALUE">
  3653. <summary>
  3654. /* TWON_ONEVALUE. Container for one value. */
  3655. </summary>
  3656. </member>
  3657. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_MEMORY">
  3658. <summary>
  3659. /* No DAT needed. Used to manage memory buffers. */
  3660. </summary>
  3661. </member>
  3662. <member name="T:Dynamsoft.TWAIN.TwainDefine.TW_ELEMENT8">
  3663. <summary>
  3664. /* No DAT needed. */
  3665. </summary>
  3666. </member>
  3667. </members>
  3668. </doc>