The DynamicDotNetTwain type exposes the following members.

Constructors

Methods

  Name Description
Public method AcquireImage
Displays the source's built-in interface to acquire image.
Public method AddBarcode
Public method CancelAllPendingTransfers
Cancels all pending transfers.
Public method CapGet
Gets information of the capability specified by the Capability property.
Public method CapGetCurrent
Returns the Source's current value for the specified capability.
Public method CapGetDefault
Returns the Source's default value for the specified capability. This is the Source's preferred default value.
Public method CapGetFrameBottom
Returns the value (in ICAP_UNITS) of the bottom-most edge of the specified frame.
Public method CapGetFrameLeft
Returns the value (in ICAP_UNITS) of the left-most edge of the specified frame.
Public method CapGetFrameRight
Returns the value (in ICAP_UNITS) of the right-most edge of the specified frame.
Public method CapGetFrameTop
Returns the value (in ICAP_UNITS) of the top-most edge of the specified frame.
Public method CapIfSupported
Queries whether the Source supports a particular operation on the capability.
Public method CapReset
Changes the Current Value of the capability specified by Capability property back to its power-on value.
Public method CapSet
Sets the current capability using the container type specified by CapType property. The current capability is specified by Capability property.
Public method CapSetFrame
Sets the values of the specified frame.
Public method ChangeAnnotationPosition
Change the position of an annotation on a specific image to a new position according to DWTAnnotationChangePosition.
Public method ChangeImageSize
Changes the display size of the image of a specified index in buffer.
Public method ClearAllHTTPFormField
Clears all the web forms which are used for image uploading.
Public method ClearSelectionRect
Clear the selected area on the specified image in buffer.
Public method CloseSource
Closes Data Source.
Public method CloseSourceManager
Closes and unloads Data Source Manager.
Public method ConvertPDFToImage(array<Byte>[]()[][], Single)
Converts the byte array of a PDF file into an image with specified resolution. This method is defined in the DynamicPDF.dll/DynamicPDFx64.dll assembly. To use this method, you need to use PDFRasterizerDllPath property to specify the PDF Rasterizer dll path first.
Public method ConvertPDFToImage(String, Single) Obsolete.
Converts a local PDF file into an image with specified resolution. This method is defined in the DynamicPDF.dll/DynamicPDFx64.dll assembly. To use this method, you need to use PDFRasterizerDllPath property to specify the PDF Rasterizer dll path first.
Public method CopyFrameToClipboard
Copies the image data in the specified area to the system clipboard in DIB format.
Public method CopyToClipboard
Copies the image of a specified index in buffer to clipboard in DIB format.
Public method CreateAnnotation
Creates an annotation on a specific image according to the annotation definition objAnnotation.
Public method Crop
Crops the image of a specified index in buffer.
Public method CropToClipboard
Crops the image of a specified index in buffer to clipboard in DIB format.
Public method CutFrameToClipboard
Cuts the image data in the specified area to the system clipboard in DIB format.
Public method CutToClipboard
Cuts the image of a specified index in buffer to clipboard in DIB format.
Public method DeleteAnnotations
Deletes the annotations on a specific image which are listed in the parameter aryAnnotation.
Public method DisableSource
Disables the source. If the source's user interface is displayed when the source is enabled, it will be closed.
Public method DisplayPropertyPage
Public method EnableSource
Enables the source to accept image.
Public method EnableSourceUI
Display the user interface of the source to change and save the settings for DPI, paper size, etc.
Public method EncryptPDFFile Encrypt a PDF file with password and permissions on disk and save the results as a new PDF file.
Public method Erase
Clears the specified area of a specified image, and fill the area with the fill color.
Public method FeedPage
Sets the Source to eject the current page and advance the next page in the document feeder into the feeder acquire area when IfFeederEnabled is true.
Public method Flip
Flips the image of a specified index in buffer.
Public method FocusOnArea
Focus on a specified Area,make the Area clearer.
Public method FTPDownload
Downloads an image from the FTP server.
Public method FTPDownloadEx
Downloads an image from the FTP server.
Public method FTPUpload
Uploads the image of a specified index in buffer to the FTP server.
Public method FTPUploadAllAsMultiPageTIFF
Uploads all images in buffer to the FTP server as a Multi-Page TIFF.
Public method FTPUploadAllAsPDF
Uploads all images in buffer to the FTP server as a Multi-Page PDF.
Public method FTPUploadAsMultiPagePDF
Uploads several images in buffer as a multi-page PDF file to the FTP server.
Public method FTPUploadAsMultiPageTIFF
Uploads several images in buffer as a multi-page TIFF file to the FTP server.
Public method FTPUploadEx
Uploads the image of a specified index in buffer to the FTP server as a specified image format.
Public method GetAllAnnotationDataList
Returns all the data of the annotations on a specific image.
Public method GetBarcodeInfo
Gets barcode type value by specified index and type. The index is 0-based. It's only valid in OnPostTransfer event.
Public method GetBarcodeText
Gets barcode content by specified index. It's only valid in OnPostTransfer event.
Public method GetCapItems
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. This is a runtime property.
Public method GetCapItemsString
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. This is a runtime property.
Public method GetDefaultImageLayout
Retrieves the left, top, right, and bottom sides of the current Data Source's default image layout rectangle.
Public method GetImage
Get the image of a specified index in buffer.
Public method GetImageControl
Public method GetImageGuidByIndex
Get the corresponding image GUID with index.
Public method GetImageIndexByGuid
Get the corresponding image index with GUID.
Public method GetImageLayout
Retrieves the left, top, right, and bottom sides of the image layout rectangle for the current Data Source.
Public method GetImageSize
Returns the file size of the new image resized from the image of a specified index in buffer.
Public method GetImageSizeWithSpecifiedType
Pre-calculates the file size of the local image file that is saved from an image of a specified index in buffer.
Public method GetInterfaceSafetyOptions
Public method GetOCRResultLineCount
Returns how many lines there are in the OCR result for a specified page in a pageset.
Public method GetOCRResultLineRect
Returns the coordinates for the rectangle that contains a specified line in a specified page of a pageset.
Public method GetOCRResultPageCount
Returns the number of pages that are OCR'ed in a specified pageset.
Public method GetOCRResultPageSetCount
Returns how many pagesets there are in the OCR result.
Public method GetOCRResultWordsCount
Returns how many words there are in a specified line in a specified page of a pageset.
Public method GetOCRResultWordsFontName
Returns the font name of a specified word in the OCR result.
Public method GetOCRResultWordsFontSize
Returns the font size of a specified word in the OCR result.
Public method GetOCRResultWordsRect
Returns the coordinates for the rectangle that contains a specified word.
Public method GetOCRResultWordsText
Returns the text of a specified word in the OCR result.
Public method GetSelectedAnnotationList
Returns the data of the selected annotations on a specific image.
Public method GetSelectionRect
Get the selected area on the specified image in buffer.
Public method GetSkewAngle(Int16)
Calculate the skew angle of the image of a specified index in buffer.
Public method GetSkewAngle(Int16, Int32, Int32, Int32, Int32)
Calculate the skew angle of the image of a specified index in buffer.
Public method GetSourceType
Return the source type.
Public method GetViewMode
Gets the view mode that images are displayed in Dynamic .NET TWAIN.
Public method GrayScale
Convert a specific image to a grayscale image.
Public method HTTPDownload
Downloads an image from the HTTP server.
Public method HTTPDownloadEx
Downloads an image from the HTTP server.
Public method HTTPUploadAllThroughPostAsMultiPageTIFF
Uploads all images in buffer to the HTTP server through HTTP Post method as Multi-Page TIFF.
Public method HTTPUploadAllThroughPostAsPDF
Uploads all images in buffer to the HTTP server through HTTP Post method as Multi-Page PDF.
Public method HTTPUploadAllThroughPutAsMultiPageTIFF
Uploads all images in buffer to the HTTP server through HTTP Put method as Multi-Page TIFF.
Public method HTTPUploadAllThroughPutAsPDF
Uploads all images in buffer to the HTTP server through HTTP Put method as Multi-Page PDF.
Public method HTTPUploadThroughPost
Uploads the image of a specified index in buffer to the HTTP server through HTTP POST method.
Public method HTTPUploadThroughPostAsMultiPagePDF
Uploads several images in buffer as a multi-page PDF file to the HTTP server via HTTP post method.
Public method HTTPUploadThroughPostAsMultiPageTIFF
Uploads several images in buffer as a multi-page TIFF file to the HTTP server via HTTP post method.
Public method HTTPUploadThroughPostEx
Uploads the image of a specified index in buffer to the HTTP server as a specified image format through HTTP POST method.
Public method HTTPUploadThroughPut
Uploads the image of a specified index in buffer to the HTTP server through HTTP PUT method.
Public method HTTPUploadThroughPutAsMultiPagePDF
Upload several images in buffer as a multi-page PDF file to the HTTP server via HTTP put method.
Public method HTTPUploadThroughPutAsMultiPageTIFF
Uploads several images in buffer as a multi-page TIFF file to the HTTP server via HTTP put method.
Public method HTTPUploadThroughPutEx
Uploads the image of a specified index in buffer to the HTTP server as a specified image format through HTTP PUT method.
Public method Invert
Invert the color of a specific image.
Public method IsBlankImage(Int16)
Detects whether an image is blank.
Public method IsBlankImage(Int16, Int32, Int32, Int32, Int32, Boolean)
Detects whether a certain area on an image is blank.
Public method LoadAnnotationDataList
Loads annotation data to a specific image from a data list.
Public method LoadCustomDSData
Loads the configurations of the source's users interface saved by SaveCustomDSData or SaveCustomDSDataEx.
Public method LoadCustomDSDataEx
Loads the configurations of the source's users interface saved by SaveCustomDSData or SaveCustomDSDataEx.
Public method LoadDibFromClipboard
Loads a DIB format image from Clipboard into Dynamic .NET TWAIN.
Public method LoadImage(Image)
Public method LoadImage(String)
Loads an image into the Dynamic .NET TWAIN. It supports loading encrypted pdf files.
Public method LoadImageEx
Loads an image into Dynamic .NET TWAIN. It supports loading encrypted pdf files.
Public method LoadImageFromBytes
Loads image from a byte array with the specified file format.
Public method MergePDFFiles
Merges PDF files on disk and save the merged document to a new file.
Public method Mirror
Mirrors the image of a specified index in buffer.
Public method MoveImage
Moves a specified image.
Public method OCR(array<String>[]()[][])
Do OCR with the image of a specified filenames.
Public method OCR(IndexList)
Do OCR with the image of a specified indices in buffer, and return PDF stream or ASCII string.
Public method OCR(Int16, Int32, Int32, Int32, Int32)
Do OCR on the given rectangle on a specified image, and return PDF stream or ASCII string.
Public method OpenSource
Loads the specified Source into main memory and starts its initialization, placing Dynamic .NET TWAIN into Capability Negotiation state. If no source is specified (no SelectSource() or SelectSourceByIndex() is called), opens the default source.
Public method OpenSourceManager
Loads and opens Data Source Manager.
Public method Picture
Returns the Picture object of the image of a specified index in buffer.
Public method PreFilterMessage
Public method Print()()()()
Shows the GUI of Image Printer with default printer settings.
Public method Print(PrinterSettings)
Shows the GUI of Image Printer with custom printer settings.
Public method ReadBarcode(Int16, BarcodeFormat) Obsolete.
Read the barcode with the specified barcode format from the image of a specified index in buffer.
Public method ReadBarcode(IndexList, BarcodeFormat) Obsolete.
Read the barcode with the specified barcode format from the image of a specified indices in buffer.
Public method ReadBarcode(Int16, Int32, Int32, Int32, Int32, BarcodeFormat) Obsolete.
Read the barcode with the specified barcode format from the image of a specified index in buffer.
Public method RemoveAllImages
Removes all images in buffer.
Public method RemoveImage
Removes the image of a specified index in buffer.
Public method RemoveImages
Deletes the images of specified indices in the array.
Public method ResetImageLayout
Reverts the current image layout to the Data Source's default.
Public method ResizeVideoWindow
Resize the video window to adapt its container.
Public method RewindPage
Sets the Source to 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 if IfFeederEnabled is true.
Public method Rotate
Rotates the image of a specified index in buffer by specified angle.
Public method RotateLeft
Rotates the image of a specified index in buffer by 90 degrees counter-clockwise.
Public method RotateRight
Rotates the image of a specified index in buffer by 90 degrees clockwise.
Public method RotateVideo
Rotates the video which is displayed by 90,180 or 270 degrees.
Public method SaveAllAsMultiPageTIFF
Saves all images in buffer as a MultiPage TIFF file.
Public method SaveAllAsMultiPageTIFFToBytes
Saves all images in buffer to a MultiPage TIFF byte array.
Public method SaveAllAsPDF
Saves all images in buffer as a Multi-Page PDF file.
Public method SaveAllAsPDFToBytes
Saves all images in buffer to a MultiPage PDF byte array.
Public method SaveAsBMP
Saves the image of a specified index in buffer as a BMP file.
Public method SaveAsJPEG
Saves the image of a specified index in buffer as a JPEG file.
Public method SaveAsMultiPagePDF
Saves several images in buffer as a multi-page PDF file.
Public method SaveAsMultiPagePDFToBytes
Saves the images of the specified indices in buffer to a MultiPage PDF byte array.
Public method SaveAsMultiPageTIFF
Saves several images in buffer as a multi-page TIFF file.
Public method SaveAsMultiPageTIFFToBytes
Saves the images of the specified indices in buffer to a MultiPage TIFF byte array.
Public method SaveAsPDF
Saves the image of a specified index in buffer as a PDF file.
Public method SaveAsPNG
Saves the image of a specified index in buffer as a PNG file.
Public method SaveAsTIFF
Saves the image of a specified index in buffer as a TIFF file.
Public method SaveCustomDSData
Saves the settings of the source's user interface.
Public method SaveCustomDSDataEx
Saves the settings of the source's user interface.
Public method SaveImageToBytes
Saves the image of a specified index in buffer to a byte array in the specified file format.
Public method SelectSource
Brings up the TWAIN Data Source Manager's Source Selection User Interface (UI) so that user can choose which Data Source to be the current Source.
Public method SelectSourceByIndex
Selects the index-the source in SourceNameItems property as the current source.
Public method SetCapItems
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. This is a runtime property.
Public method SetCapItemsString
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. This is a runtime property.
Public method SetFileXFERInfo
Sets file name and file format information used in File Transfer Mode
Public method SetHTTPFormField
Sets a text parameter of a web form. The text parameter is passed while uploading images.
Public method SetImage
Replace the image of a specified index in buffer.
Public method SetImageGuidByIndex
Set the image GUID with the corresponding index.
Public method SetImageLayout
Sets the left, top, right, and bottom sides of the image layout rectangle for the current Data Source.
Public method SetInterfaceSafetyOptions
Public method SetPDFResolution
Sets the output image resolution of the PDF Rasterizer.
Public method SetSelectionRectPosition
Programmatically select an area or resize selection rectangle. Note: To enable this function, MouseShape property should be set to false.
Public method SetVideoContainer
Only available when IfShowUI is true. The default value is null, the default UI will show in this situation. If set this method with designated control, the designated control will show instead default UI.
Public method SetViewMode
Sets the view mode that images are displayed in Dynamic .NET TWAIN. You can use this method to display multiple images in Dynamic .NET TWAIN.
Public method ShowImageEditor
Shows the GUI of Image Editor.
Public method SourceNameItems
Holds an array of source names.
Public method SwitchImage
Switch two images of specified indices in buffer.
Public method UpdateAnnotation
Updates an annotation on a specific image with the new annotation definition objNewAnnotation.

Properties

  Name Description
Public property AllowMultiSelect
Returns or sets whether support multiple select. This property is invalid when the view mode is set to -1 by -1 or 1 by 1.
Public property AnnotationFillColor
Returns or sets the fill color and transparency for the area inside the annotation rectangle/ellipse. This property is only valid when the annotation type is NOT 2(Text).
Public property AnnotationPen
Returns or sets the color and width of the pen for drawing the annotation rectangle/ellipse/line. This property is only valid when the annotation type is NOT 2(Text).
Public property AnnotationTextColor
Returns or sets the color for the annotation text. This property is only valid when the annotation type is set to 2(Text).
Public property AnnotationTextFont
Returns or sets the font for the annotation text. This property is only valid when the annotation type is set to 2(Text).
Public property AnnotationType
Returns or sets the annotation type. To use the property,the property MouseShape should be set to false.
Public property BackgroundColor
Returns or sets the background color of the main control. It is a value specifying the 32-bit ARGB value.
Public property BackgroundFillColor
Returns or sets the fill color of the selected area of an image when it is cut, erased, or rotated. It is a value specifying the 32-bit ARGB value.
Public property BarcodeCount
Returns the number of barcode detected in an image. It's only valid in OnPostTransfer event.
Public property BarcodeDllPath
Returns or sets the Barcode dll path, without file name.
Public property BitDepth
Returns or sets the pixel bit depth for the current value of PixelType property. This is a runtime property.
Public property BklightComp
Returns or sets the backlight compensation value available within the Source. This is a runtime property.
Public property BklightCompDefaultValue
Returns the default backlight compensation value available within the Source This is a readonly property
Public property BklightCompMaxValue
Returns the max backlight compensation value available within the Source This is a readonly property
Public property BklightCompMinValue
Returns the min backlight compensation value available within the Source This is a readonly property
Public property BklightCompStepDelta
Returns the stepping delta value of backlight compensation available within the Source This is a readonly property
Public property BlankImageMaxStdDev
Returns or sets the standard deviation of the pixels in the image.
Public property BlankImageThreshold
Returns or sets the dividing line between black and white. The default value is 128.
Public property BorderStyle
Returns or sets the border style.
Public property Brightness
Returns or sets the brightness value available within the Source. This is a runtime property.
Public property BrightnessDefaultValue
Returns the default brightness value available within the Source This is a readonly property
Public property BrightnessMaxValue
Returns the max brightness value available within the Source This is a readonly property
Public property BrightnessMinValue
Returns the min brightness value available within the Source This is a readonly property
Public property BrightnessStepDelta
Returns the stepping delta value of brightness available within the Source This is a readonly property
Public property Capability
Specifies the capability to be negotiated. This is a runtime property.
Public property CapCurrentIndex
Returns or sets the index (0-based) of a list to indicate the Current Value 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. This is a runtime property.
Public property CapCurrentValue
Returns or sets the current value in a range when the value of the CapType property is TWON_RANGE. This is a runtime property.
Public property CapDefaultIndex
Returns the index (0-based) of a list to indicate the Default Value 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. This is a runtime, read-only property.
Public property CapDefaultValue
Returns the default value in a range when the value of the CapType property is TWON_RANGE. This is a runtime, read-only property.
Public property CapMaxValue
Returns or sets the maximum value in a range when the value of the CapType property is TWON_RANGE. This is a runtime property.
Public property CapMinValue
Returns or sets the minimum value in a range when the value of the CapType property is TWON_RANGE. This is a runtime property.
Public property CapNumItems
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. This is a runtime property.
Public property CapStepSize
Returns or sets the step size in a range when the value of the CapType property is TWON_RANGE. This is a runtime property.
Public property CapType
Returns or sets the type of capability container used to exchange capability information between application and source. This is a runtime property.
Public property CapValue
Returns or sets the value of the capability specified by Capability property when the value of the CapType property is TWON_ONEVALUE. This is a runtime property.
Public property CapValueString
Returns or sets the string value for a capability when the value of the CapType property is TWON_ONEVALUE. This is a runtime property.
Public property CapValueType
Returns or sets the value type for reading the value of a capability. This is a runtime property.
Public property ColorEnable
Returns or sets the color enable value available within the Source. This is a runtime property.
Public property ColorEnableDefaultValue
Returns the default color enable value available within the Source This is a readonly property
Public property ColorEnableMaxValue
Returns the max color enable value available within the Source This is a readonly property
Public property ColorEnableMinValue
Returns the min color enable value available within the Source This is a readonly property
Public property ColorEnableStepDelta
Returns the stepping delta value of color enable available within the Source This is a readonly property
Public property Contrast
Returns or sets the contrast values available within the Source. This is a runtime property.
Public property ContrastDefaultValue
Returns the default contrast value available within the Source This is a readonly property
Public property ContrastMaxValue
Returns the max contrast value available within the Source This is a readonly property
Public property ContrastMinValue
Returns the min contrast value available within the Source This is a readonly property
Public property ContrastStepDelta
Returns the stepping delta value of contrast available within the Source This is a readonly property
Public property CurrentImageIndexInBuffer
Returns or sets current index of image in buffer. This is a runtime property.
Public property CurrentSelectedImageIndicesInBuffer
Returns or sets current selected image indices in buffer.
Public property CurrentSourceName
Returns the device name of current source. This is a runtime, read-only property.
Public property DataSourceStatus
Returns the value indicating the data source status. This is a runtime, read-only property.
Public property DefaultSourceName
Returns the device name of default source. This is a runtime, read-only property.
Public property Duplex
Returns whether the source supports duplex. If so, it further returns the level of duplex the Source supports (one pass or two pass duplex). This is a runtime, read-only property.
Public property EnableInteractiveZoom
Returns or sets whether the user can zoom image using hot key.
Public property EnableKeyboardInteractive
Whether or not respond to keyboard events. Here the events mean those defined in Dynamic .NET TWAIN. For example, navigate to the next image when the "Right" key is pressed.
Public property ErrorCode
Returns the error code. This is a runtime, read-only property.
Public property ErrorString
Returns the error string. This is a runtime, read-only property.
Public property Exposure
Returns or sets the exposure value available within the Source. This is a runtime property.
Public property ExposureDefaultValue
Returns the default exposure value available within the Source This is a readonly property
Public property ExposureMaxValue
Returns the max exposure value available within the Source This is a readonly property
Public property ExposureMinValue
Returns the min exposure value available within the Source This is a readonly property
Public property ExposureStepDelta
Returns the stepping delta value of exposure available within the Source This is a readonly property
Public property FitWindowType
Returns or sets whether to resize the image to fit the image to the width or height of window.To use the property,the view mode should be set to -1 by -1.
Public property Focus
Returns or sets the focus value available within the Source. This is a runtime property.
Public property FocusDefaultValue
Returns the default focus value available within the Source This is a readonly property
Public property FocusMaxValue
Returns the max focus value available within the Source This is a readonly property
Public property FocusMinValue
Returns the min focus value available within the Source This is a readonly property
Public property FocusStepDelta
Returns the stepping delta value of focus available within the Source This is a readonly property
Public property FrameRate
Returns camera's current framerate value available within the Source. This is a runtime property.
Public property FrameRateMaxValue
Returns the max framerate value available within the Source This is a readonly property
Public property FrameRateMinValue
Returns the min framerate value available within the Source This is a readonly property
Public property FTPPassword
Returns or sets the password used to log into the FTP server.
Public property FTPPort
Returns or sets the port number of the FTP server.
Public property FTPUserName
Returns or sets the user name used to log into the FTP server.
Public property Gain
Returns or sets the gain value available within the Source. This is a runtime property.
Public property GainDefaultValue
Returns the default gain value available within the Source This is a readonly property
Public property GainMaxValue
Returns the max gain value available within the Source This is a readonly property
Public property GainMinValue
Returns the min gamma value available within the Source This is a readonly property
Public property GainStepDelta
Returns the stepping delta value of gain available within the Source This is a readonly property
Public property Gamma
Returns or sets the gamma value available within the Source. This is a runtime property.
Public property GammaDefaultValue
Returns the default gamma value available within the Source This is a readonly property
Public property GammaMaxValue
Returns the max gamma value available within the Source This is a readonly property
Public property GammaMinValue
Returns the min gamma value available within the Source This is a readonly property
Public property GammaStepDelta
Returns the stepping delta value of gamma available within the Source This is a readonly property
Public property HookMessage
Hook thread message
Public property HowManyImagesInBuffer
Returns how many images are in buffer. This is a runtime, read-only property.
Public property HttpFieldNameOfUploadedImage
Specifies the field name of uploaded image through POST.
Public property HTTPPassword
Sets or returns the password used to log into the HTTP server.
Public property HTTPPort
Returns or sets the port number of the HTTP server.
Public property HTTPPostResponseString
Returns the response string from the HTTP server if an error occurs for HTTPUploadThroughPost() method. This is a runtime, read-only property.
Public property HTTPUserName
Returns or sets the user name used to log into the HTTP server.
Public property Hue
Returns or sets the Hue value available within the Source. This is a runtime property.
Public property HueDefaultValue
Returns the default hue value available within the Source This is a readonly property
Public property HueMaxValue
Returns the max hue value available within the Source This is a readonly property
Public property HueMinValue
Returns the min hue value available within the Source This is a readonly property
Public property HueStepDelta
Returns or sets the stepping delta value of hue available within the Source. This is a readonly property.
Public property IfAppendImage
Returns or sets whether insert or append new scanned images.
Public property IfAutoBklightComp
Returns or sets the backlight compensation value if auto available within the Source. This is a runtime property.
Public property IfAutoBright
Returns or sets whether the Source's Auto-brightness function is enabled. This is a runtime property.
Public property IfAutoBrightness
Returns or sets the brightness value if auto available within the Source. This is a runtime property.
Public property IfAutoColorEnable
Returns or sets the color enable value if auto available within the Source. This is a runtime property.
Public property IfAutoContrast
Returns or sets the contrast values if auto available within the Source. This is a runtime property.
Public property IfAutoExposure
Returns or sets the exposure value if auto available within the Source. This is a runtime property.
Public property IfAutoFeed
Returns or sets whether the Source enable automatic document feeding process. This is a runtime property.
Public property IfAutoFocus
Returns or sets the focus value if auto available within the Source. This is a runtime property.
Public property IfAutoGain
Returns or sets the gain value if auto available within the Source. This is a runtime property.
Public property IfAutoGamma
Returns or sets the gamma value if auto available within the Source. This is a runtime property.
Public property IfAutoHue
Returns or sets the hue value if auto available within the Source. This is a runtime property.
Public property IfAutoIris
Returns or sets the iris value if auto available within the Source. This is a runtime property.
Public property IfAutoPan
Returns or sets the pan value if auto available within the Source. This is a runtime property.
Public property IfAutoRoll
Returns or sets the roll value if auto available within the Source. This is a runtime property.
Public property IfAutoSaturation
Returns or sets the saturation value if auto available within the Source. This is a readonly property.
Public property IfAutoScan
Returns or sets whether the Source enables the automatic document scanning process. This is a runtime property.
Public property IfAutoSharpness
Returns or sets the sharpness value if auto available within the Source. This is a runtime property.
Public property IfAutoTilt
Returns or sets the tilt value if auto available within the Source. This is a runtime property.
Public property IfAutoWhiteBalance
Returns or sets the white balance value if auto available within the Source. This is a runtime property.
Public property IfAutoZoomForCam
Returns or sets the zoom value for camera if auto available within the Source. This is a runtime property.
Public property IfDeviceOnline
Returns whether the Source is attached, powered on, and communicating. This is a runtime, read-only property.
Public property IfDisableSourceAfterAcquire
Returns or sets whether close the Data Source User Interface after acquire all images. Default value of this property is false.
Public property IfDuplexEnabled
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 image. This is a runtime property.
Public property IfFeederEnabled
Returns or sets whether the Automatic Document Feeder (ADF) is enabled. This is a runtime property.
Public property IfFeederLoaded
Returns whether or not there are documents loaded in the Source's feeder when IfFeederEnabled and IfPaperDetectable are true. This is a runtime, read-only property.
Public property IfFitWindow
Returns or sets whether to resize the image to fit the size of window when the view mode is set to -1 by -1.
Public property IfFTPPassiveMode
Returns or sets whether FTP passive mode is enabled.
Public property IfModalImageEditor
Returns or sets whether the ImageEditor control is modal.
Public property IfModalUI
Returns or sets whether the UI (User Interface) of Source runs in modal state. Default value of this property is true.
Public property IfPaperDetectable
Returns the value whether the Source has a paper sensor that can detect documents on the ADF or Flatbed. This is a runtime, read-only property.
Public property IfPrintAnnotations
Returns or sets whether print annotations when calling print method.
Public property IfSaveAnnotations
Returns or sets whether save the created annotations.This property only applies to PDF files.
Public property IfShowCancelDialogWhenBarcodeOrOCR
Sets or returns whether to show the cancel dialog when reading barcode or performing OCR
Public property IfShowCancelDialogWhenImageTransfer
Sets or returns whether to show the cancel dialog when uploading images to server.
Public property IfShowIndicator
Returns or sets whether the Source displays a progress indicator during acquisition and transfer, regardless of whether the Source's user interface is active. This is a runtime property.
Public property IfShowPrintUI
Returns or sets whether the driver of the printer displays the User Interface.
Public property IfShowUI
Returns or sets whether the Source displays the User Interface.
Public property IfSSL
Returns or sets that an SSL connection should be used.
Public property IfThrowException
Returns or sets whether an exception will be thrown when an error occurs.
Public property IfTiffMultiPage
Returns or sets whether the Source allows to save many images in one TIFF file. The default value is false.
Public property IfUIControllable
Returns whether the Source supports acquisition with the UI (User Interface) disabled. If false, indicates that this Source can only support acquisition with the UI enabled. This is a runtime, read-only property.
Public property IfUseTwainDSM
Public property ImageBitsPerPixel
Returns the number of bits in each image pixel (or bit depth). This is a runtime, read-only property.
Public property ImageEditorIfEnableEnumerator
Returns or sets whether the image enumerator is enabled in Image Editor.
Public property ImageEditorIfReadonly
Returns or sets whether the Image Editor is read-only.
Public property ImageEditorWindowTitle
Returns or sets the title of Image Editor window.
Public property ImageLayoutDocumentNumber
Returns the document number of the current image. This is a runtime, read-only property.
Public property ImageLayoutFrameBottom
Returns the value of the bottom-most edge of the current image frame (in ICAP_UNITS). This is a read-only runtime property.
Public property ImageLayoutFrameLeft
Returns the value of the left-most edge of the current image frame (in ICAP_UNITS). This is a runtime, read-only property.
Public property ImageLayoutFrameNumber
Returns the frame number of the current image. This is a runtime, read-only property.
Public property ImageLayoutFrameRight
Returns the value of the right-most edge of the current image frame (in ICAP_UNITS). This is a runtime, read-only property.
Public property ImageLayoutFrameTop
Returns the value of the top-most edge of the current image frame (in ICAP_UNITS). This is a runtime, read-only property.
Public property ImageLayoutPageNumber
Returns the page number of the current image. This is a runtime, read-only property.
Public property ImageLength
Returns how tall/int, in pixels, the image is. This is a runtime, read-only property.
Public property ImageMargin
Returns or sets the margin between images when multiple images are displayed in Dynamic .NET TWAIN.
Public property ImagePixelType
Returns the pixel type of the current image. This is a runtime, read-only property.
Public property ImageWidth
Returns how width, in pixels, the image is. This is a runtime, read-only property.
Public property ImageXResolution
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.
Public property ImageYResolution
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.
Public property Iris
Returns or sets the iris value available within the Source. This is a runtime property.
Public property IrisDefaultValue
Returns the default iris value available within the Source This is a readonly property
Public property IrisMaxValue
Returns the max iris value available within the Source This is a readonly property
Public property IrisMinValue
Returns the min iris value available within the Source This is a readonly property
Public property IrisStepDelta
Returns the stepping delta value of iris available within the Source This is a readonly property
Public property JPEGQuality
Returns or sets the quality of the JPEG file.
Public property LicenseKeys
Set license information (serial number) in runtime. For multiple serial numbers, please use semicolon (;) to separate them. Note: please bind the license information before you call any Dynamic .NET TWAIN method.
Public property LogLevel
Returns or sets whether enable the debug mode of Dynamic .NET TWAIN.
Public property MagData
Returns the magnetic data if the scanner support magnetic data recognition. This is a read-only property.
Public property MagType
Returns the magnetic type if the scanner support magnetic data recognition. This is a read-only property.
Public property Manufacturer
Returns or sets the manufacture string for the application identity.
Public property MaxBarcodesToRead Obsolete.
Returns or sets the maximum number of barcodes to be detected. Default value is 0x7FFFFFFF(Max int).
Public property MaxImagesInBuffer
Returns or sets the maximum number of images can be held in buffer.
Public property MaxUploadImageSize
Returns or sets the maximum size of image can be upload.
Public property MediaType
Returns or sets the media type value available within the Source. This is a runtime property.
Public property MediaTypeList
Returns media type list available within the Source. This is a readonly property.
Public property MouseShape
Returns or sets the shape of the mouse.
Public property OCRDllPath
Returns or sets the OCR dll path, without file name.
Public property OCRLanguage
Returns or sets the language string. The language is (usually) an ISO 639-3 string, default is "eng".
Public property OCRNumericOnly
Returns or sets whether use the detected font.
Public property OCRPageSetMode
Returns or sets the possible modes for page layout analysis.
Public property OCRPdfFontSize
Returns or sets whether use the detected font.
Public property OCRResultFormat
Returns or sets the OCR output format.
Public property OCRTessDataPath
Returns or sets the tessdata path. The datapath must be the name of the parent directory of tessdata and must be end in / . Any name after the last / will be stripped.
Public property OCRUnicodeFontName
Returns or sets the unicode font name used in PDF file. For example, "Arial", "ArialUni".
Public property OCRUseDetectedFont
Returns or sets whether use the detected font.
Public property PageSize
Returns or sets the page size(s) the Source can/should use to acquire image data. This is a runtime property. Please set the pagesize value in enum TWICapSupportedSizes.
Public property Pan
Returns or sets the pan value available within the Source. This is a runtime property.
Public property PanDefaultValue
Returns the default pan value available within the Source This is a readonly property
Public property PanMaxValue
Returns the max pan value available within the Source This is a readonly property
Public property PanMinValue
Returns the min pan value available within the Source This is a readonly property
Public property PanStepDelta
Returns the stepping delta value of pan available within the Source This is a readonly property
Public property PDFAuthor
Returns or sets the name of the person who creates the PDF document.
Public property PDFCompressionType
Returns or sets the compression type of PDF files.
Public property PDFConvertMode
Returns or sets mode of PDF convert.
Public property PDFCreationDate
Returns or sets the date when the PDF document is created.
Public property PDFCreator
Returns or sets the name of the application that created the original document, if the PDF document is converted from another form.
Public property PDFKeywords
Returns or sets the keywords associated with the PDF document.
Public property PDFMarginBottom
Returns or sets the bottom margin of a PDF file.
Public property PDFMarginLeft
Returns or sets the left margin of a PDF file.
Public property PDFMarginRight
Returns or sets the right margin of a PDF file.
Public property PDFMarginTop
Public property PDFModifiedDate
Returns or sets the date when the PDF document is last modified.
Public property PDFPageSize
Returns or sets the page size of images which are going to be saved as PDF files.
Public property PDFProducer
Returns or sets the name of the application that converted the PDF document from its native.
Public property PDFRasterizerDllPath
Returns or sets the PDF Rasterizer dll path, without file name.
Public property PDFSubject
Returns or sets the subject of the PDF document.
Public property PDFTitle
Returns or sets the title of the PDF document.
Public property PDFVersion
Returns or sets the version of the PDF document.
Public property PDFXConformance
Public property PendingXFERs
Returns the number of transfers the Source is ready to supply, upon demand. This is a runtime, read-only property.
Public property PixelFlavor
Returns or sets the pixel flavor for acquired images. This is a runtime property.
Public property PixelType
Returns or sets the pixel type of acquired images. This is a runtime property.
Public property ProductFamily
Returns or sets the product family string for the application identity.
Public property ProductName
Returns or sets the product name string for the application identity.
Public property ProxyPassword
Sets or returns the password used to log into the Proxy server.
Public property ProxyServerName
Returns or sets the name of the proxy server.
Public property ProxyServerPort
Returns or sets the port number of the Proxy server.
Public property ProxyUserName
Returns or sets the user name used to log into the Proxy server.
Public property Resolution
Returns or sets the current resolution for image acquisition. This is a runtime property.
Public property ResolutionForCam
Returns or sets camera's current resolution value available within the Source. This is a runtime property.
Public property ResolutionForCamList
Returns camera's resolution list available within the Source. This is a readonly property.
Public property RightToLeft (Overrides Control..::..RightToLeft.)
Public property Roll
Returns or sets the roll value available within the Source. This is a runtime property.
Public property RollDefaultValue
Returns the default roll value available within the Source This is a readonly property
Public property RollMaxValue
Returns the max roll value available within the Source This is a readonly property
Public property RollMinValue
Returns the min roll value available within the Source This is a readonly property
Public property RollStepDelta
Returns the stepping delta value of roll available within the Source This is a readonly property
Public property Saturation
Returns or sets the saturation value available within the Source. This is a runtime property.
Public property SaturationDefaultValue
Returns the default saturation value available within the Source This is a readonly property
Public property SaturationMaxValue
Returns the max saturation value available within the Source This is a readonly property
Public property SaturationMinValue
Returns the min saturation value available within the Source This is a readonly property
Public property SaturationStepDelta
Returns the stepping delta value of saturation available within the Source This is a readonly property
Public property ScanInNewProcess
Acquire image in a new separate process
Public property ScanInNewThread
Acquire image in a new separate thread
Public property SelectionImageBorderColor
Returns or sets the border color of the selected image. It is a value specifying the 32-bit ARGB value.
Public property SelectionRectAspectRatio
Returns or sets the selection rectangle aspect ratio. The ratio is refer to width/height (e.g. to keep width/height 3/2, you can set the ratio to 1.5). This is a runtime property.
Public property Sharpness
Returns or sets the sharpness value available within the Source. This is a runtime property.
Public property SharpnessDefaultValue
Returns the default sharpness value available within the Source This is a readonly property
Public property SharpnessMaxValue
Returns the max sharpness value available within the Source This is a readonly property
Public property SharpnessMinValue
Returns the min sharpness value available within the Source This is a readonly property
Public property SharpnessStepDelta
Returns the stepping delta value of sharpness available within the Source This is a readonly property
Public property SourceCount
Returns how many sources are installed in the system. This is a runtime, read-only property.
Public property SupportedDeviceType
Returns or sets the supported device type. This is a runtime property.
Public property TIFFCompressionType
Returns or sets the compression type of TIFF files. To use DWTTIFFCompressionType.TIFF_JPEG, you need to use the DynamicImage dll, please put DynamicImage.dll/DynamicImagex64.dll in fully qualified path of the current working directory.
Public property Tilt
Returns or sets the tilt value available within the Source. This is a runtime property.
Public property TiltDefaultValue
Returns the default tilt value available within the Source This is a readonly property
Public property TiltMaxValue
Returns the max filt value available within the Source This is a readonly property
Public property TiltMinValue
Returns the min tilt value available within the Source This is a readonly property
Public property TiltStepDelta
Returns the stepping delta value of tilt available within the Source This is a readonly property
Public property TransferMode
Returns or sets the transfer mode. Please set the value of transfer mode in enum TWICapSetupXFer.
Public property Unit
Returns or sets the unit of measure. This is a runtime property.
Public property VersionInfo
Returns or sets the version info string for the application identity.
Public property VScrollBar
Indicates whether the vertical scroll bar is visible when the images are larger than page size.
Public property WhiteBalance
Returns or sets the white balance value available within the Source. This is a runtime property.
Public property WhiteBalanceDefaultValue
Returns the default white balance value available within the Source This is a readonly property
Public property WhiteBalanceMaxValue
Returns the max white balance value available within the Source This is a readonly property
Public property WhiteBalanceMinValue
Returns the min white balance value available within the Source This is a readonly property
Public property WhiteBalanceStepDelta
Returns the stepping delat value of white balance available within the Source This is a readonly property
Public property XferCount
Returns and sets the number of images you are willing to transfer per session. This is a runtime property.
Public property Zoom
Returns or sets zoom factor for the current image, only can set the property When the view mode is set to -1 by -1. This is a runtime property.
Public property ZoomForCam
Returns or sets the zoom value for camera available within the Source. This is a runtime property.
Public property ZoomForCamDefaultValue
Returns the default zoom value for camera available within the Source This is a readonly property
Public property ZoomForCamMaxValue
Returns the max zoom value for value available within the Source This is a readonly property
Public property ZoomForCamMinValue
Returns the min zomm value for camera available within the Source This is a readonly property
Public property ZoomForCamStepDelta
Returns the stepping delta value of zoom for camera available within the Source This is a readonly property

Events

  Name Description
Public event OnAnnotationCreated
Occurs when an annotation is created.
Public event OnAnnotationDeselected
Occurs when one or more annotations is deselected.
Public event OnAnnotationMoved
Occurs when an annotation is moved..
Public event OnAnnotationResized
Occurs when an annotation is resized..
Public event OnAnnotationSelected
Occurs when an annotation is selected.
Public event OnAnnotationTextChanged
Occurs when the text in an annotation is changed.
Public event OnDNTKeyDown
Public event OnFrameCapture
Occurs when webcam capture a frame.
Public event OnImageAreaDeselected
Occurs when the selected area of the specified image is deselected and the value of the MouseShape property is set to false.
Public event OnImageAreaSelected
Occurs when an area of the specified image is selected and the value of the MouseShape property is set to false.
Public event OnInternetTransferPercentage
Occurs when uploading or downloading images via HTTP or FTP.
Public event OnMouseClick
Occurs when the mouse clicks on an image.
Public event OnMouseDoubleClick
Occurs when the mouse double clicks on an image.
Public event OnMouseMove
Occurs when the mouse moves onto an image.
Public event OnMouseRightClick
Occurs when the mouse right clicks on an image.
Public event OnMouseRightClickEx
Occurs when the mouse right clicks on an image.
Public event OnPostAllTransfers
Occurs after all image are scanned.
Public event OnPostLoad
Occurs when images are loaded into the control from a local directory or memory.
Public event OnPostPageLoad
Occurs after loading images into control
Public event OnPostTransfer
Occurs when each image is scanned.
Public event OnPreAllTransfers
Occurs before all images are scanned.
Public event OnPrePageLoad
Occurs before loading image into control
Public event OnPreTransfer
Occurs before each image is scanned.
Public event OnSourceUIClose
Occurs when the user clicks on the "Close" button of the Source's user interface.
Public event OnTopImageInTheViewChanged
Occurs when the current top image displayed in Dynamic .Net TWAIN is changed and the view mode is NOT set to -1 by -1.
Public event OnTransferCancelled
Occurs when the transfer is cancelled by the user.
Public event OnTransferError
Occurs when an error occurs during the process of transfer.
Public event OnWaitForEnd
Occurs when doing OCR or Barcode.

See Also