EZTwainX ::  Technical Reference :: Properties
Overview  Download  How To Buy  Demo  Code Examples  Technical Reference

See also: creation, methods, events, deployment, Image class

Name Type R/W  Description Ver.
AccumulateImages Bool RW During Load, Acquire, Paste, etc. do not clear existing images. Default: False 1.49
ActiveImage Image RW The currently selected/displayed/active image in the control. 1.48
AppendToExistingFiles Bool RW True if EZTwainX should append images to any TIFF, PDF or DCX file, if it already exists. When False, writing to an existing file overwrites the file contents. Default: False. 1.43
AppTitle String RW Name of the calling application if any. To redistribute EZTwainX as part of an application (client-resident software), this string must be set along with a corresponding LicenseKey (see below). You obtain such a license key by buying an EZTwainX Application License. 1.20
BackColor OLE_COLOR RW Stock property - The color used for interior of control but outside the displayed image. 1.44
BarcodeCount Long R Number of barcode symbols (patches) detected on currently selected page (see PageIndex). 1.39
BarcodeText(Long i) String R Text of ith barcode on current page. 1.39
BarcodeType(Long i) Long R Type (symbology code) of ith barcode on current page. 1.39
BlankPageThreshold Double RW Fraction of dark pixels below which a page is considered 'blank'. Values are from 0.0 to 1.0. (Note - it's not a percent value.)
Example: A threshold of 0.02 means any page with < 2% 'dark' pixels is considered blank.
see ScanDiscardBlankPages below.
1.54
CanPaste Bool R True if EZTwainX can paste the contents of the clipboard, False otherwise. 1.34
CurrentPage Image R The currently selected/displayed/active Image object in the control. 1.48
DefaultSourceDevice String R System-wide default TWAIN device. 1.34
Domain String R The first-level domain of the page containing this control, if any. For example, "dosadi.com" on this website.
EZTwainX figures this out for itself.
To use EZTwainX on a web page, the LicenseKey property must be set to a value that corresponds to the Domain.
1.34
EnableLogging Bool RW True if EZTwainX is writing a log file. Set to True to start logging. The log file is called eztwainx.log and is written to the user's temp folder. The environment variables TMP and TEMP normally specify this folder. 1.00
EZTwainVersion Long R Version of the underlying EZTwain Pro library times 100 e.g. 325 means version 3.25 1.31
File File Object R Child object that provides file operations. 1.59
Folder Folder Object R Child object that provides folder (directory) operations. 1.60
Height Long R Height of the current image, in pixels. Renamed PixelHeight in 1.44 1.43
HostURL String R The full URL of the webpage containing the control, if any. 1.22
Image(Long i) Image R The ith Image object in the control. i = 0, ... 1.48
ImageCount Long R The number of images in the control (same as PageCount) 1.55
Images Images R The set of images in the control - an array-style container, indexed from 0. 1.48
InstalledSources Array R Array of names of available TWAIN devices. Note: A device is still listed, even if it is unplugged or turned off. 1.35
JpegAvailable Bool R True if support for reading and writing JPEG files is installed. 1.00
JpegQuality Long RW Approximate quality level for JPEG compression, on a scale from 1 to 100. Controls the quality level used when EZTwainX writes in any form that uses JPEG compression. 1 is minimum quality and size, 100 is nearly perfect quality and maximum size. JPEG files of course use JPEG compression, but JPEG compression is also used when grayscale and color images are written to PDF, and JPEG can be selected as an alternate compression mode in TIFF files. 1.01
LastErrorText String RW Detailed text about last error inside EZTwainX. 1.50
Licensee String RW Name of Licensee, under EZTwainX Universal License. 1.53
LicenseKey Long RW Numeric license key. To continue using EZTwainX after the trial period, you must set this property to a key obtained from Dosadi - See EZTwainX Licensing. 1.20
PageCount Long R Number of pages stored in control. 1.31
PageIndex Long RW Index of currently selected/active page, starting from 0. Will be -1 if PageCount = 0. 1.31
PdfAvailable Bool R True if support for reading and writing PDF files is installed. Note: Typically only PDF files written by Dosadi software can be read by Dosadi software, including EZTwainX. 1.00
PixelBits Long R Bits per pixel of active image 1.45
PixelHeight Long R Height of the active image, in pixels 1.44
PixelType PixelType RW Type of pixels in active image. Set this property to convert image. 1.54
PixelWidth Long R Width of the active image, in pixels 1.44
PngAvailable Bool R True if support for reading and writing PNG files is installed. 1.00
PrintToFit Bool RW When printing, shrink images to fit inside the printer's printable area 1.48
Scan Scan Object R Child object that contains settings and methods for scanning. 1.62
ScanAutoCrop Long RW 1 = auto-crop each page during scanning, 0 = don't. Default=0. 1.55
ScanDeskew Long RW 1 = deskew each page during scanning, 0 = don't deskew. Default=0. 1.48
ScanDiscardBlankPages Long RW 1 = discard blank pages during scanning, 0 = don't discard. Default=0. See BlankPageThreshold above. 1.48
ScanDPI Double RW Desired resolution (DPI) for next scan job. 1.00
ScanDuplex Long RW Desired use of duplex (double-sided) scanning:
-1 = Don't Care, 0 = Simplex (no duplex), 1 = Duplex.
1.00
ScanFeeder Long RW Desired use of automatic document feeder: -1=Don't Care, 0=Don't Use, 1=Use Feeder. 1.00
ScanPaperSize Long RW Desired paper size in next scan job. -1=Don't Care 1.39
ScanType Long RW Desired type of pixel to scan or acquire in next scan job. 1.00
ScanWithUI Bool RW True if the scanner or TWAIN device should show its user interface i.e. scan dialog. 1.00
SourceDevice String RW Set this property to specify a particular device (taken from the InstalledSources property). Its default value is "" which tells EZTwainX to use the system-wide default TWAIN device. 1.34
Tiff Tiff Object R Child object that controls TIFF settings 1.56
TiffAvailable Bool R True if support for reading and writing TIFF files is installed. 1.00
ToolMode ToolMode RW Selects the cursor shape and behavior of the mouse when it is over the control. 1.44
TwainAvailable Bool R True if TWAIN support is present on the system. (Does not imply that there are any TWAIN devices...) 1.00
UploadResponse String R Text returned by server in response to last upload (see Uploading) 1.46
UploadShowProgress Bool RW Set True if a progress bar should be shown during uploads, False otherwise. 1.55
Version Long R Version of EZTwainX, times 100 - so for example version 1.3 of the control returns Version = 130 1.00
VersionString String R Version of EZTwainX, as a string e.g. 1.43b1 1.35
Width Long R Width of the current image, in pixels. Renamed to PixelWidth in 1.44 1.43
ZoomFactor Double RW Magnification of displayed image. A value of 1 means that each image pixel is displayed as one screen pixel. If you set ZoomFactor to 0, EZTwainX chooses the largest ZoomFactor <= 1 that displays the entire active image. 1.44


 Privacy Policy Copyright © 2002-2008 by Dosadi. All rights reserved.