Dynamsoft.Forms.Viewer Defines a class provides functions for managing the annotations on viewer. This event is triggered when an annotation is selected. This event is triggered when one or more annotations is deselected. This event is triggered when an annotation is created. This event is triggered when an annotation is moved. This event is triggered when an annotation is resized. This event is triggered when the text in an annotation is changed. Returns or sets the annotation type. To use the property, the property MouseShape should be set to false. When an error occurs, please check TwainException.
Allowed Values Annotation Types
enumNone(default) Select an area
enumPointer(Pointer) Select an existing annotation. Press "Ctrl" to multi-select annotations.
enumText(Text) Create a text.The annotation type will be set back to 1 once the annotation is completed..
enumLine(Line) Create a line.The annotation type will be set back to 1 once the annotation is completed..
enumRectangle(Rectangle) Create a rectangle.The annotation type will be set back to 1 once the annotation is completed..
enumEllipse(Ellipse) Create a ellipse.The annotation type will be set back to 1 once the annotation is completed..

Returns or sets the font of the annotation text. This property is only valid when the annotation type is set to 2(Text). When an error occurs, please check TwainException. Returns or sets the color for the annotation text. This property is only valid when the annotation type is set to 2(Text). When an error occurs, please check TwainException. 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). When an error occurs, please check TwainException. By default, the color is black and the width is 1; 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). When an error occurs, please check TwainException. By default, the color is white and not transparent. Summary description for ConstStringHelper. Implements the IIndexList interface using an array whose size is dynamically increased as required. Represents a non-generic collection of objects that can be individually accessed by index. Inserts an element into the list at the specified index. The zero-based index at which value should be inserted. The value to be inserted. true indicates success. false indicates failure. When an error occurs and IfThrowException property is true, an exception will be thrown. When IfThrowException property is false, please check ErrorCode and ErrorString. Adds an int value to the end of the list. The value to be added to the end of the list. The list index at which the value has been added. -1 indicates failure. When an error occurs and IfThrowException property is true, an exception will be thrown. When IfThrowException property is false, please check ErrorCode and ErrorString. Removes the element at the specified index of the list. The zero-based index of the element to be removed. true indicates success. false indicates failure. When an error occurs and IfThrowException property is true, an exception will be thrown. When IfThrowException property is false, please check ErrorCode and ErrorString. Removes the first occurrence of a specific value from the list. The value to be removed from the list. true indicates success. false indicates failure. When an error occurs and IfThrowException property is true, an exception will be thrown. When IfThrowException property is false, please check ErrorCode and ErrorString. Returns an enumerator for the entire list. An IEnumerator for the entire list. When an error occurs and IfThrowException property is true, an exception will be thrown. When IfThrowException property is false, please check ErrorCode and ErrorString. Gets the number of elements actually contained in the list. When an error occurs and IfThrowException property is true, an exception will be thrown. When IfThrowException property is false, please check ErrorCode and ErrorString. Gets or sets the element at the specified index. The zero-based index of the element to get or set. When an error occurs and IfThrowException property is true, an exception will be thrown. When IfThrowException property is false, please check ErrorCode and ErrorString. Summary description for Util. Clone image. Source image. Return clone of the source image. The original Bitmap.Clone() does not produce the desired result - it does not create an actual clone (it does not create a copy of the image). That is why this method was implemented to provide the functionality. Clone image. Source image data. Clones image from source image data. The message does not clone pallete in the case if the source image has indexed pixel format. Copy block of unmanaged memory. Destination pointer. Source pointer. Memory block's length to copy. Return's value of - pointer to destination. This function is required because of the fact that .NET does not provide any way to copy unmanaged blocks, but provides only methods to copy from unmanaged memory to managed memory and vise versa. Group selection rectangle. Used for drawing. http://www.google.com Flas is set to true if group selection rectangle should be drawn. Active drawing tool. List of graphics objects. Sample Defines a class providing functions for managing image viewer. Required designer variable. Required method for Designer support - do not modify the contents of this method with the code editor. Shows the GUI of Image Printer with the default printer settings. Boolean. True indicates success. False indicates failure. When an error occurs, please check ViewerException. Depending on the property IfShowPrintUI, the User Interface of the printer may or may not show when you invoke this method. Shows the GUI of Image Printer with custom printer settings. Custom printer settings Boolean. True indicates success. False indicates failure. When an error occurs, please check ViewerException. Depending on the property IfShowPrintUI, the User Interface of the printer may or may not show when you invoke this method. Gets the view mode that images are displayed in the viewer. the short number for the columns can be displayed in the viewer. the short number for the rows can be displayed in the viewer. When an error occurs, please check ViewerException. If the view mode is set to -1*-1, the returned value of sHorizontalImageCount is -1, and so is sVerticalImageCount. Sets the view mode that images are displayed in the viewer. You can use this method to display multiple images in the viewer. Specifies how many columns can be displayed in the viewer. Specifies how many rows can be displayed in the viewer. When an error occurs, please check ViewerException. The default value is 1 by 1. When the view mode is set to -1 by -1, the viewer only shows the current image and no scroll bar is provided to navigate to other images. Programmatically selects an area or resizes the selection rectangle. Note: To enable this function, MouseShape property should be set to false. Specifies the index of the image in buffer. The X axis of the left border. The Y axis of the top border. The X axis of the right border. The Y axis of the bottom border. Returns a boolean value that indicates whether the operation succeeds or not. When an error occurs, please check ViewerException. Gets the selected area on the specified image in buffer. Specifies the index of the image in buffer. Returns a Rectangle value that indicates the selected area. Rectangle.Empty means that no area is selected on the specified index image. When an error occurs, please check ViewerException. Clears the selected area on the specified image in buffer. Specifies the index of the image in buffer. Returns a boolean value that indicates whether the operation succeeds or not. When an error occurs, please check ViewerException. Binds Viewer module with ImageCore module. When an error occurs, please check ViewerException. Once the bind function is called, the image in the buffer will be automatically loaded into the viewer. Returns the picture object of the image of a specified index in buffer. specifies the index of the image in buffer. The index is 0-based When an error occurs, please check ViewerException. The picture property implements the iPictureDisp interface. This event is triggered when the selected area of the specified image is deselected. The event is triggered when the keyborad button is pressed. This event is triggered when an area of the specified image is selected. This event is triggered when the mouse clicks on an image. This event is triggered when the mouse double clicks on an image. This event is triggered when the mouse moves onto an image. This event is triggered when the mouse right clicks on an image. This event is triggered when the current top image displayed in the viewer is changed and the view mode is NOT set to -1 by -1. Returns or sets the selection rectangle aspect ratio. The ratio refers to width/height (e.g. to keep width/height = 3/2, please set the ratio to 1.5). This is a runtime property. When an error occurs, please checkViewerException. Please make sure the value is 0 or positive number. 0 means no limitation on the aspect ratio. Returns or sets the shape of the mouse. When an error occurs, please check ViewerException. When the value of the property is set to true, the cursor is set as a hand. If the width or height of the image is bigger than the control size, scroll bars will be shown and you can drag the image to adjust the position in the control. When the value of the property is set to false, the cursor is set as an arrow. You can select an area in the viewer directly and the OnImageAreaSelected event will be triggered. Indicates whether the vertical scroll bar is visible when the images are larger than the page size. When an error occurs, please check ViewerException. The default value is true. If the view mode is -1 * -1, please ignore this setting. Returns or sets the border color of the selected image. It is a value specifying the 32-bit ARGB value. When an error occurs, please check ViewerException. The default value is Navy. The byte-ordering of the 32-bit ARGB value is AARRGGBB. The most significant byte (MSB), represented by AA, is the alpha component value. The second, third, and fourth bytes, represented by RR, GG, and BB, are the color components of red, green, and blue respectively. Returns or sets current selected image indices in buffer. When an error occurs, please check ViewerException. If there is no image in buffer, the returned array count will be zero. Returns or sets whether multiple selection is supported. This property is invalid when the view mode is set to -1 by -1 or 1 by 1. When an error occurs, please check ViewerException. The default value is false. If it is true, when a user selects multiple images, the CurrentImageIndexInBuffer is always the minimum index among the selected images. Returns or sets whether to resize the image to fit the size of window when the view mode is set to -1 by -1. When an error occurs, please check ViewerException. The default value of the IfFitWindow property is true. When the value is False, the image will be displayed in its full size and scroll bars will be shown if necessary (the width or height of the image is bigger than the control size). Returns or sets the border style. When an error occurs, please check ViewerException. Allowed Values Description None (0) No border SingleFlat (1) Flat border Single3D (2) 3D border The default value of the BorderStyle property is None (0). This property supports changing the border style of the control instead of the border style of each image in the view mode. Returns or sets whether or not responds to keyboard events. The events here mean those defined in the dll. For example, navigate to the next image when the "Right" key is pressed. When an error occurs, please check ViewerException. 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. When an error occurs, please check ViewerException.
Allowed Values Fit Window Type
0(default) Fits the image to the width and height of the window
1 Fits the image to the height of the window
2 Fits the image to the width of the window
Returns or sets the background color of the main control. It is a value specifying the 32-bit ARGB value. When an error occurs, please check ViewerException. The default value is White. The byte-ordering of the 32-bit ARGB value is AARRGGBB. The most significant byte (MSB), represented by AA, is the alpha component value. The second, third, and fourth bytes, represented by RR, GG, and BB, are the color components red, green, and blue respectively. Returns or sets the margin between images when multiple images are displayed in the viewer. When an error occurs, please check ViewerException. The default value will change automatically. Returns or sets zoom factor for the current image. Please set the property when the view mode is set to -1 by -1. This is a runtime property. When an error occurs, please check ViewerException. The zoom value is expressed as a percentage. The valid range is from 2 to 6500 percent (Value: 0.02 ~ 65.0); the default value is 100 percent (Value: 1.0). The zoom value can be specified before or after an image is displayed. When the zoom value is changed, the displayed image will refresh automatically. Returns or sets whether the user can zoom the image using hot key. When an error occurs, please check ViewerException. If it is set to true. The user can use hot key like "Ctrl + Mouse Wheel" or "Alt + Mouse Wheel" to zoom in/out the image, use "+" (small keyboard) to zoom in the image, and use "-" (small keyboard) to zoom out the image. The default value of this property is true. Returns or sets whether print annotations when calling print method. When an error occurs, please check ViewerException. If the property is false(default), annotations will not be printed. If the property is true, annotations will be printed. Gets the annotation object. When an error occurs, please check ViewerException. Summary description for ImageControl. Summary description for ImageWindow. Required designer variable. Clean up any resources being used. Required method for Designer support - do not modify the contents of this method with the code editor. Required designer variable. Clean up any resources being used. Required method for Designer support - do not modify the contents of this method with the code editor. Summary description for ImageViewer. Required designer variable. Clean up any resources being used. Required method for Designer support - do not modify the contents of this method with the code editor. Group selection rectangle. Used for drawing. http://www.google.com Flas is set to true if group selection rectangle should be drawn. Active drawing tool. Don't set ZoomX and ZoomY directly usually. Instead, set them with Zoom unless they need to be set different values. Don't set ZoomX and ZoomY directly usually. Instead, set them with Zoom unless they need to be set different values. Image window border style. No border. Flat border. 3D border. FitWindow type. Fit the image to both the width and height of the viewer. Fit the image to the height of the viewer. Fit the image to the width of the viewer. Annotation type. Text annotation. Line annotation. Rectangle annotation. Ellipse annotation. Rotate text annotaion DynamicDotNetTWAIN error code. Successful. General error. Data parameter out of supported range. General error. User cancelled the operation. Invalid index. Invalid value. Data parameter out of supported range. This image format is not supported. Invalid image index. Original image does't exist. There is no page to be printed. DynamicDotNetTWAIN exception class definition. Initializes a new instance of the ViewerException class. Initializes a new instance of the ViewerException class with a specified error message. The message that describes the error. Initializes a new instance of the ViewerException class with a specified error message and error code. The message that describes the error. The error code. Gets and sets error code. Gets a message that describes the current exception. Gets a string representation of the frames on the call stack at the time the current exception was thrown. Rectangle graphic object Summary description for DrawGDIObject. Draw object Get handle point by 1-based number Get handle rectangle by 1-based number Draw tracker for selected object Hit test. Return value: -1 - no hit 0 - hit anywhere > 1 - handle number Test whether point is inside of the object Get curesor for the handle Test whether object intersects with rectangle Move object Move handle to the point Dump (for debugging) Normalize object. Call this function in the end of object resizing. Save object to serialization stream Load object from serialization stream Initialization Selection flag Color Pen width Annotation fill color Annotation Text color Annotation Text Font Number of handles Last used m_color Last used pen width Draw m_rcRectangle Get handle point by 1-based number Hit test. Return value: -1 - no hit 0 - hit anywhere > 1 - handle number Get cursor for the handle Move handle to new point (resizing) Make sure m_rcRectangle size great than minimum size return delta x return delta y Move object Normalize m_rcRectangle Save objevt to serialization stream LOad object from serialization stream Get number of handles Draw m_rcRectangle Summary description for DrawImageControl. Draw object Get handle point by 1-based number Get handle rectangle by 1-based number Draw tracker for selected object Hit test. Return value: -1 - no hit 0 - hit anywhere > 1 - handle number Test whether point is inside of the object Get curesor for the handle Test whether object intersects with rectangle Move object Move handle to the point Normalize object. Call this function in the end of object resizing. Graphic objects for hit test Get handle point by 1-based number Hit test. Return value: -1 - no hit 0 - hit anywhere > 1 - handle number Invalidate object. When object is invalidated, path used for hit test is released and should be created again. Create graphic objects used from hit test. Summary description for DrawSelectRectangle. first init the inner rectangle Jeremy The new constructor for drawing the select rectangle with a certain ratio Draw m_rcRectangle Jeremy set the rectangle parameter with the handle number. Hit test. Return value: -1 - no hit 0 - hit anywhere > 1 - handle number Move handle to new point (resizing) Move object Jeremy normalize the ratio when the new rectangle is to be drawed with a certain ratio Summary description for TextBoxEx. Construct TextBox take a Get first char index of the specified line The following is an example of initializing a DocumentationSample type: // Create the type. DocumentationSample ds = new DocumentationSample(); if ( null == ds ) return; return ds.MyMethod( ?someString? ); A type representing a value. if is null pointer. if is empty. line index in TextBox, A type char index Get line index from the specified char index char index in TextBox line index Get total lines count total lines count Base class for all drawing tools Left nous button is pressed Mouse is moved, left mouse button is pressed or none button is pressed Left mouse button is released Base class for all tools which create new graphic object Add new object to draw area. Function is called when user left-clicks draw area, and one of ToolObject-derived tools is active. Left mouse is released. New object is created and resized. Tool m_cursor. Color Pen width Pointer tool Left mouse button is pressed Mouse is moved. None button is pressed, ot left button is pressed. Right mouse button is released Clear all objects in the list true if at least one object is deleted Delete selected items true if at least one object is deleted Move selected items to front (beginning of the list) true if at least one object is moved Move selected items to back (end of the list) true if at least one object is moved Count and this [nIndex] allow to read all graphics objects from GraphicsList in the loop. SelectedCount and GetSelectedObject allow to read selected objects in the loop Draw m_rcRectangle Provides the base interface for firing DynamicDotNetTWAIN events. Provides the cancel interface for event OnInternetTransferPercentage. If you want to cancel upload or download, please set its value as true. Occurs when the mouse clicks on an image. Specifies the index of image in buffer. The index is 0-based. Short sImageIndex >=0. When the value of sImageIndex equals -1, it indicates that no image is clicked. Occurs when the mouse moves onto an image. Specifies the index of image in buffer. The index is 0-based. Short sImageIndex >=0. When the value of sImageIndex equals -1, it indicates that mouse is not on any image. Occurs when the mouse right clicks on an image. Specifies the index of image in buffer. The index is 0-based. Short sImageIndex >=0. When the value of sImageIndex equals -1, it indicates that no image is right-clicked. Occurs when the mouse right clicks on an image. Specifies the index of image in buffer. The index is 0-based. Provide data for OnMouseRightClick event. Short sImageIndex >=0. When the value of sImageIndex equals -1, it indicates that no image is right-clicked. Occurs when the mouse double clicks on an image. Specifies the index of image in buffer. The index is 0-based. Short sImageIndex >=0. When the value of sImageIndex equals -1, it indicates that no image is double-clicked. Occurs when the current top image displayed in Dynamic .Net TWAIN is changed and the view mode is NOT set to -1 by -1. Specifies the index of image in buffer. The index is 0-based. Short sImageIndex >=0. Occurs when an area of the specified image is selected and the value of the property is set to false. Specifies the index of image in buffer. The index is 0-based. The long point number for the left side of the rectangle are the mouse selects. The long point number for the top side of the rectangle are the mouse selects. The long point number for the right side of the rectangle are the mouse selects. The long point number for the bottom side of the rectangle are the mouse selects. Short sImageIndex >=0. Occurs when the selected area of the specified image is deselected and the value of the property is set to false. Specifies the index of image in buffer. The index is 0-based. Short sImageIndex >=0. Occurs when annotaions is selected. The guid of the selected annotations object. Occurs when one or more annotations is deselected. The guid of the deselected annotation object. Occurs when an annotation is created. The guid of the created annotation object. Occurs when an annotation is moved. The guid of the moved annotation object. Occurs when an annotation is resized. The guid of the resized annotation Occurs when text in an annotation is changed. The guid of the text annotation. Occurs when the user clicks on the "Close" button of the Source's user interface. DynamicDotNetTWAIN exception interface definition. Get exception error code. Exception error code. Get exception error string. Exception error string. Get exception stack trace as string. Exception stack trace. A strongly-typed resource class, for looking up localized strings, etc. Returns the cached ResourceManager instance used by this class. Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. Looks up a localized resource of type System.Drawing.Bitmap. Looks up a localized resource of type System.Drawing.Bitmap. Looks up a localized resource of type System.Drawing.Bitmap. Looks up a localized resource of type System.Byte[]. Looks up a localized resource of type System.Byte[]. Looks up a localized resource of type System.Drawing.Bitmap.