# $ K Wang Image Edit Control
Properties   Methods   Events
The Wang Image Edit control adds imaging and image annotation functions to applications that support 32-bit OLE controls.  It enables end users to display, annotate, manipulate, and manage image files.
Image Display
The Image Edit control allows end users to display image files of various types.  Specifically, the control supports the following file types:
{bmc bullet.bmp}	BMP
{bmc bullet.bmp}	DCX
{bmc bullet.bmp}	JPG
{bmc bullet.bmp}	PCX
{bmc bullet.bmp}	TIFF
{bmc bullet.bmp}	XIF
Image Annotation
The control includes several properties, methods, and events that enable programmers to add annotation functions to application programs.  The annotation functions permit end users to annotate displayed images.  The control also includes an Annotation Tool Palette that can be optionally invoked to provide end users with a complete set of annotation tools.
The control supports the annotation types described in the following list:
Annotation Type	Description	
Attach-a-Note	Enters text into a background rectangle on an image	
Filled Rectangle	Covers a portion of an image	
Freehand Line	Draws a freehand line on a section of text or a portion of an image for emphasis	
Hollow Rectangle	Places a border around areas of an image for emphasis	
Image Embedded	Embeds an actual copy of another image in an image file	
Image Reference	Includes another image in an image file by reference (that is, it links to an external file that contains the image)	
Select Annotations	Selects annotation marks for deleting, modifying, moving, or resizing	
Straight Line	Underlines text, demarcates a section of a page, or draws callout lines	
Text	Enters text directly on an image	
Text From File	Enters text from a file on an image	
Text Stamp	Places a text stamp directly on an image	
Image Manipulation
The Image Edit control has properties, methods, and events that enable programmers to add image manipulation functions to application programs.  These functions permit end users to perform the following tasks on displayed images:
{bmc bullet.bmp}	Copy, cut, and paste to the Clipboard
{bmc bullet.bmp}	Flip
{bmc bullet.bmp}	Rotate
{bmc bullet.bmp}	Scale
{bmc bullet.bmp}	Scroll
{bmc bullet.bmp}	Zoom
File Management
The control also includes methods that enable programmers to add image and annotation file management functions to application programs.  These functions permit end users to retrieve, save, print, and delete image and annotation data.
Linking With the Image Edit Control
The Image Edit control is the main Imaging control.  The Wang Image Annotation Tool Button and Image Scan controls link to Image Edit control to perform several functions.
Image Annotation Tool Button Control
The Image Annotation Tool Button control links to the Image Edit control to permit the annotation of displayed images.  The Image Annotation Tool Button control sends messages to the Image Edit control that set annotation attributes, thereby changing all of the Image Edit annotation attributes to the values set within the Image Annotation Tool Button control.  When the Draw method is invoked, the Image Edit control draws the annotation.
Image Scan Control
The Image Scan control links to the Image Edit control to display images while they are being scanned.
Establishing the Link
To link the Image Annotation Tool Button control to the Image Edit control:
 1.	Set the DestImageControl property of the Image Annotation Tool Button control to the name of the desired Image Edit control.
 2.	Set the ImageControl property of the Image Edit control to the same Image Edit control name.
To link the Image Scan control to the Image Edit control:
 1.	Set the DestImageControl property of the Image Scan control to the name of the desired Image Edit control.
 2.	Set the ImageControl property of the Image Edit control to the same Image Edit control name.
See Also
Image Annotation Tool Button control
Image Scan control
Imaging Concepts

# $ K Properties (Image Edit control)
AnnotationBackColor	CompressionInfo	ImageScaleWidth	
AnnotationFillColor	CompressionType	ImageWidth	
AnnotationFillStyle	DisplayScaleAlgorithm	MouseIcon	
AnnotationFont	Enabled	MousePointer	
AnnotationFontColor	FileType	Page	
AnnotationGroupCount	hWnd	PageCount	
AnnotationImage	Image	PageType	
AnnotationLineColor	ImageControl	ScrollBars	
AnnotationLineStyle	ImageDisplayed	ScrollPositionX	
AnnotationLineWidth	ImageHeight	ScrollPositionY	
AnnotationStampText	ImageModified	ScrollShortcutsEnabled	
AnnotationTextFile	ImagePalette	SelectionRectangle	
AnnotationType	ImageResolutionX	StatusCode	
AutoRefresh	ImageResolutionY	Zoom	
BorderStyle	ImageScaleHeight		

# $ K AnnotationGroupCount Property
Returns the number of annotation groups that are on an image page.
Applies To
Image Edit control
Syntax
object.AnnotationGroupCount
Data Type
Integer
Remarks
The AnnotationGroupCount is used as the upper bound value when indexing through all of the annotation groups.
When a new annotation group is created, the AnnotationGroupCount is not incremented until at least one annotation mark is added to the group.
Available at run-time as read-only.
The Display method must be invoked prior to reading this property.
See Also
Annotations
Display method
GetAnnotationGroup method
GetAnnotationMarkCount method
SetCurrentAnnotationGroup method

# $ K AutoRefresh Property
Returns or sets whether a displayed image is refreshed immediately after changes are made to properties that can affect its visual appearance.
Applies To
Image Edit control
Syntax
object.AutoRefresh[={True|False}]
Data Type
Boolean
Setting	Description	
True	Refreshes the image immediately when changes are made to display-related properties	
False (default)	The image is not refreshed immediately	
Remarks
Set this property to True when you want the image to be refreshed every time a property is changed that affects its visual display.
Set this property to False when you do not want the image to be refreshed every time a property is changed that affects its visual display.  The image can be refreshed at any time by invoking the Refresh method, which updates the image using the current settings.
When the AutoRefresh property is set to True, changing the following properties causes the displayed image to be refreshed automatically:
DisplayScaleAlgorithm property	
ImagePalette property	
ImageResolutionX property	
ImageResolutionY property	
ScrollBars property	
ScrollPositionX property	
ScrollPositionY property	
Zoom property	
See Also
Refresh method

# $ K BorderStyle Property
Returns or sets whether the control is displayed with a border. 
Applies To
Image Edit control
Syntax
object.BorderStyle[=value]
Data Type
Integer (enumerated)
Setting	Description	
0	None	
 1 (default)	Fixed Single	
Remarks
Single-line, fixed-size is the only available border style.
Available at design-time only. 

# $ K CompressionInfo Property
Returns compression option information for the image specified in the Image property, and the page specified in the Page property.
Applies To
Image Edit control
Syntax
object.CompressionInfo
Data Type
Long
Property settings are expressed using the following bit-wise values:
Setting	Description	Notes	
0	No compression options set.	Applicable only to uncompressed image files	
1	EOL -- Include/expect End Of Line.  Each line is terminated with a standard end-of-line bit.	Not used for JPEG compression	
2	Packed Lines -- Byte-align new lines.	Not used for JPEG compression	
4	Prefixed EOL -- Include/expect, prefixed End Of Line.  Each strip of data is prefixed by a standard end-of-line bit sequence.	Not used for JPEG compression	
8	Compressed LTR -- Compressed bit order, Left-To-Right.  The bit order for the compressed data is the most significant bit to the least significant bit.	Not used for JPEG compression	
16	Expand LTR -- Expanded bit order, Left-To-Right.  The bit order for the expanded data is the most significant bit to the least significant bit.	Not used for JPEG compression	
32	Negate -- Invert black and white on expansion.  Indicates the setting of the Photometric Interpretation field of a TIFF file.	Not used for JPEG compression	
64	High Compression/High Quality	Used for JPEG compression only	
128	High Compression/Medium Quality	Used for JPEG compression only	
256	High Compression/Low Quality	Used for JPEG compression only	
512	Medium Compression/High Quality	Used for JPEG compression only	
1024	Medium Compression/Medium Quality	Used for JPEG compression only	
2048	Medium Compression/Low Quality	Used for JPEG compression only	
4096	Low Compression/High Quality	Used for JPEG compression only	
8192	Low Compression/Medium Quality	Used for JPEG compression only	
16384	Low Compression/Low Quality	Used for JPEG compression only	
Remarks
Image files with compression types other than JPEG can have CompressionInfo values between 1 and 63, in any combination.  Image files with the JPEG compression type can have only one specific value between 64 and 16384 (as indicated in the preceding list).
The CompressionInfo value is independent of an image being displayed.  If the image specified in the Image and Page properties is being displayed, the value indicates the compression of the displayed image.  If the image specified in the Image and Page properties is not being displayed, the value indicates the compression of the image specified in the Image property.
Available at run-time as read-only.
See Also
Compression
CompressionType property
Image property
Page property
SaveAs method

# $ K CompressionType Property
Returns the compression type of the image specified in the Image property, and the page specified in the Page property.
Applies To
Image Edit control
Syntax
object.CompressionType
Data Type
Integer (enumerated)
Property settings are expressed using the following values:
Setting	Description	
0	Unknown	
1	No compression	
2	Group3(1D)	
3	Group3(Modified Huffman)	
4	PackBits	
5	Group4(2D)	
6	JPEG	
7	Not used	
8	Group3(2D)	
9	LZW	
Remarks
The CompressionType value is independent of an image being displayed.  If the image specified in the Image and Page properties is being displayed, the value indicates the compression type of the displayed image.  If the image specified in the Image and Page properties is not being displayed, the value indicates the compression type of the image specified in the Image property.
Available at run-time as read-only. 
See Also
Compression
CompressionInfo property
Image property
Page property
SaveAs method

# $ K DisplayScaleAlgorithm Property
Returns or sets the scaling algorithm used when displaying images.
Applies To
Image Edit control
Syntax
object.DisplayScaleAlgorithm[=integer]
Data Type
Integer (enumerated)
Property settings are expressed using the following values:
Setting	Description	Notes	
0 (default)	Normal	Normal decimation	
1	Gray4	4-bit gray-scale, 16 shades of gray	
2	Gray8	8-bit gray-scale, 256 shades of gray	
3	Stamp	Used for thumbnail representation of images	
4	Optimize	Changes the display algorithm based on the image type of the displayed image	
Remarks
The DisplayScaleAlgorithm value can be specified before or after an image is displayed.  If the value is specified after an image is displayed, the displayed image may change visually.
When the AutoRefresh property is set to True, changing the DisplayScaleAlgorithm property causes the displayed image to be refreshed automatically.  Some settings may not be apparent until the image is scaled to a Zoom value under 100 percent.
See Also
AutoRefresh property
Display
Image property
Zoom property

# $ K FileType Property
Returns the file type of the image file specified in the Image property, and the page specified in the Page property.
Applies To
Image Edit control
Syntax
object.FileType
Data Type
Integer (enumerated)
Property settings are expressed using the following values:
Setting	Description	
1	TIFF	
2	Not used	
3	BMP	
4	PCX	
5	DCX	
6	JPG	
7	XIF	
Remarks
The FileType value is independent of an image being displayed.  If the image specified in the Image and Page properties is being displayed, the value indicates the file type of the displayed image.  If the image specified in the Image and Page properties is not being displayed, the value indicates the file type of the image specified in the Image property.
Available at run-time as read-only. 
See Also
Image property
Images
Page property
SaveAs method

# $ K Image Property
Returns the fully-qualified filename of an image file being displayed, or sets the fully-qualified filename of an image file to be displayed or otherwise operated on by the Image Edit control.
Applies To
Image Edit control
Syntax
object.Image[=filename]
Data Type
String
Remarks
The name must be a fully-qualified filename.
See Also
Display method
Images

# $ K ImageControl Property
Returns or sets the unique identifier to be specified for linking with another Imaging control.  The Wang Image Annotation Tool Button and Image Scan controls link to the Image Edit control in order to perform several functions.
Applies To
Image Edit control
Syntax
object.ImageControl[=controlname]
Data Type
String
Remarks
A unique default name is provided when you draw the control on a form.
See Also
DestImageControl property (Image Annotation Tool Button control)
DestImageControl property (Image Scan control)
Image Annotation Tool Button control
Image Scan control
Images

# $ K ImageDisplayed Property
Indicates whether an image is currently being displayed.
Applies To
Image Edit control
Syntax
object.ImageDisplayed
Data Type
Boolean
Setting	Description	
True	An image is being displayed	
False	An image is not being displayed	
Remarks
Available at run-time as read-only. 
See Also
Display method
Images

# $ K ImageHeight Property
Returns the height in full-size coordinates of the image being displayed.
Applies To
Image Edit control
Syntax
object.ImageHeight
Data Type
Long
Remarks
If an image is not being displayed, the ImageHeight property returns the full-size height of the image specified in the Image property.
If an image is not being displayed and the Image property does not contain the filename of an image, the ImageHeight property generates an error.
Available at run-time as read-only.
See Also
Image property
Images
ImageScaleHeight property
ImageWidth property

# $ K ImageModified Property
Indicates whether an image has been modified.
Applies To
Image Edit control
Syntax
object.ImageModified
Data Type
Boolean
Setting	Description	
True	The image has been modified	
False	The image has not been modified	
Remarks
Because the value of this property indicates whether an image file has been modified, you can use it to determine whether your program should prompt the end user to save the image file.
Available at run-time as read-only.
Changes to the following properties set the ImageModified property to True:
ImageResolutionX property	
ImageResolutionY property	
Invoking the following methods sets the ImageModifed property to True:
AddAnnotationGroup method	
BurnInAnnotations method	
ClipboardCut method	
ClipboardPaste method	
ConvertPageType method	
DeleteAnnotationGroup method	
DeleteImageData method	
DeleteSelectedAnnotations method	
Draw method	
EditSelectedAnnotationText method	
Flip method	
HideAnnotationGroup method	
RotateLeft method	
RotateRight method	
SetSelectedAnnotationBackColor method	
SetSelectedAnnotationFillColor method	
SetSelectedAnnotationFillStyle method	
SetSelectedAnnotationFont method	
SetSelectedAnnotationFontColor method	
SetSelectedAnnotationLineColor method	
SetSelectedAnnotationLineStyle method	
SetSelectedAnnotationLineWidth method	
ShowAnnotationGroup method	
Drawing an annotation using the standard Annotation Tool Palette sets the ImageModifed property to True.
See Also
Close event
Images
Save method
SaveAs method

# $ K ImagePalette Property
Returns or sets the palette to use when displaying an image. 
Applies To
Image Edit control
Syntax
object.ImagePalette[=value ]
Data Type
Integer (enumerated)
Property settings are expressed using the following values:
Setting	Description	Notes	
0 (default)	Custom	Selects a custom palette	
1	Common	Selects the common palette	
2	Gray8	Selects the 8-bit gray-scale, 256 shades-of-gray palette	
3	RGB24	Selects the 24-bit, millions-of-colors palette	
4	Black-and-white	Selects the black-and-white palette	
Remarks
The ImagePalette value can be specified before or after an image is displayed.  If the value is specified after an image is displayed, the displayed image may change visually.
When the AutoRefresh property is set to True, changing the ImagePalette property causes the displayed image to be refreshed automatically.
See Also
AutoRefresh property
Images
Palettes
SetImagePalette method

# $ K ImageResolutionX Property
Returns or sets the horizontal resolution of the image being displayed.
Applies To
Image Edit control
Syntax
object.ImageResolutionX[=integer ]
Data Type
Long
Remarks
When the AutoRefresh property is set to True, changing the ImageResolutionX property causes the displayed image to be refreshed automatically.
If an image is not being displayed, the ImageResolutionX property returns or sets the horizontal resolution of the image specified in the Image property.
If an image is not being displayed and the Image property does not contain the filename of an image, the ImageResolutionX property generates an error.
Available at run-time as read-and-write.
See Also
AutoRefresh property
Image property
ImageResolutionY property
Images

# $ K ImageResolutionY Property
Returns or sets the vertical resolution of the image being displayed.
Applies To
Image Edit control
Syntax
object.ImageResolutionY[=integer ]
Data Type
Long
Remarks
When the AutoRefresh property is set to True, changing the ImageResolutionY property causes the displayed image to be refreshed automatically.
If an image is not being displayed, the ImageResolutionY property returns or sets the vertical resolution of the image specified in the Image property.
If an image is not being displayed and the Image property does not contain the filename of an image, the ImageResolutionY property generates an error.
Available at run-time as read-and-write.
See Also
AutoRefresh property
Image property
ImageResolutionX property
Images

# $ K ImageScaleHeight Property
Returns the height in pixels of the image as it is displayed.
Applies To
Image Edit control
Syntax
object.ImageScaleHeight
Data Type
OLE_YSIZE_PIXELS
Remarks
The Display method must be invoked prior to using this property.
The ImageScaleHeight property differs from the ImageHeight property.  The ImageHeight property returns the height in full-size coordinates, while the ImageScaleHeight property value is affected by the current zoom factor.
The ImageScaleHeight and ImageHeight properties also differ for images with asymmetric resolutions.  For example, when an 8½- by 11-inch image with a resolution of 200 by 100 dots per inch (dpi) is displayed, the ImageHeight property returns a value of 1100, while the ImageScaleHeight property returns a value of 2200 due to pixel replication that occurs at display-time to optimize display quality.
Available at run-time as read-only. 
See Also
Display method
Image property
ImageHeight property
ImageResolutionX property
ImageResolutionY property
Images
ImageScaleWidth property
Zoom property

# $ K ImageScaleWidth Property
Returns the width in pixels of the image as it is displayed.
Applies To
Image Edit control
Syntax
object.ImageScaleWidth
Data Type
OLE_XSIZE_PIXELS
Remarks
The Display method must be invoked prior to using this property.
The ImageScaleWidth property differs from the ImageWidth property.  The ImageWidth property returns the width in full-size coordinates, while the ImageScaleWidth property value is affected by the current zoom factor.
The ImageScaleWidth and ImageWidth properties also differ for images with asymmetric resolutions.  For example, when an 8½- by 11-inch image with a resolution of 100 by 200 dots per inch (dpi) is displayed, the ImageWidth property returns a value of 850, while the ImageScaleWidth property returns a value of 1700 due to pixel replication that occurs at display-time to optimize display quality.
Available at run-time as read-only. 
See Also
Display method
Image property
ImageResolutionX property
ImageResolutionY property
Images
ImageScaleHeight property
ImageWidth property
Zoom property

# $ K ImageWidth Property
Returns the width in full-size coordinates of the image being displayed.
Applies To
Image Edit control
Syntax
object.ImageWidth
Data Type
Long
Remarks
If an image is not being displayed, the ImageWidth property returns the full-size width of the image specified in the Image property.
If an image is not being displayed and the Image property does not contain the filename of an image, the ImageWidth property generates an error.
Available at run-time as read-only. 
See Also
Image property
ImageHeight property
Images
ImageScaleWidth property

# $ K MouseIcon Property
Returns or sets the mouse icon to be displayed when the mouse pointer is moved over an Image Edit control.
Applies To
Image Edit control
Syntax
object.MouseIcon=LoadPicture(pathname) 
Data Type
String
The pathname is a string expression specifying the path and filename of the file containing the custom icon (.CUR or .ICO files).
Remarks
The MouseIcon property provides a custom icon that is used when the MousePointer property is set to 99.
See Also
MousePointer property

# $ K MousePointer Property
Returns or sets the type of mouse pointer to be displayed when the pointer is moved over an Image Edit control at run-time.
Applies To
Image Edit control
Syntax
object.MousePointer[=integer]
Data Type
Integer (enumerated)
Setting	Description	
0  (Default)	As determined by the value of the AnnotationType property	
1	Arrow	
2	Cross (cross-hair pointer)	
3	I-Beam	
4	Arrow	
5	Size (four-pointed arrow pointing North, South, East, and West)	
6	Size NE SW (double arrow pointing NorthEast and SouthWest)	
7	Size N S (double arrow pointing North and South)	
8	Size NW SE (double arrow pointing NorthWest and SouthEast)	
9	Size W E (double arrow pointing West and East)	
10	Up Arrow	
11	Hourglass (wait)	
12	No Drop	
13	Arrow and Hourglass	
14	Arrow and Question mark	
15	Size All	
16	Freehand Line	
17	Hollow Rectangle	
18	Filled Rectangle	
19	Text Stamp	
20	Text	
21	Text From File	
22	Attach-a-Note	
23	Hand	
24	Image Selection	
99	Custom pointer specified by the MouseIcon property.	
Remarks
The MouseIcon property must be set prior to setting the MousePointer property to 99.
Use this property to indicate changes in functionality as the mouse pointer passes over controls on a form or dialog box.  Use the Hourglass setting (11) to indicate that the end user should wait for a process or operation to finish.
See Also
AnnotationType property
MouseIcon property

# $ K Page Property
Returns the page number of an image file where an action was performed, or sets the page number of an image file where an action is to be performed.
Applies To
Image Edit control
Syntax
object.Page[=integer]
Data Type
Long
Remarks
The default value for this property is 1.  This property is typically used to specify the page to be displayed by the Display method.
See Also
Display method
Image Page
PageCount property

# $ K PageCount Property
Returns the total number of pages in the image file that is currently being displayed.
Applies To
Image Edit control
Syntax
object.PageCount
Data Type
Long
Remarks
If an image is not being displayed, the PageCount property returns the total number of pages in the image file specified in the Image property.
If an image is not being displayed and the Image property does not contain the filename of an image, the PageCount property generates an error.
Available at run-time as read-only.
See Also
Image Page
Image property
Page property

# $ K PageType Property
Returns the image type of the image specified in the Image property and the page specified in the Page property.
Applies To
Image Edit control
Syntax
object.PageType
Data Type
Integer (enumerated)
Property settings are expressed using the following values:
Setting	Description	
1	Black-and-white 	
2	Gray4	
3	Gray8	
4	Palettized4	
5	Palettized8	
6	RGB24	
7	BGR24	
Remarks
The PageType property value is independent of an image being displayed.  If the image page specified in the Page property is being displayed, the value is the image type of the displayed image.  If the image page specified in the Image and Page properties is not being displayed, the value is the image type of the page specified in the Image and Page properties.
Available at run-time as read-only.
See Also
ConvertPageType method
Image Page
Page property
SaveAs method

# $ K ScrollBars Property
Returns or sets whether a displayed image contains horizontal and/or vertical scroll bars.
Applies To
Image Edit control
Syntax
object.ScrollBars[={True|False}]
Data Type
Boolean
Setting	Description	
True (default)	Horizontal and/or vertical scroll bars are displayed	
False	No scroll bars are displayed	
Remarks
If this property is set to True, horizontal and/or vertical scroll bars are displayed only when the image extends beyond the object’s borders.
If the image has scroll bars and the ScrollShortcutsEnabled property is set to True, accelerator keys are provided to permit the end user to scroll an image using the keyboard.
When the AutoRefresh property is set to True, changing the ScrollBars property causes the displayed image to be refreshed automatically.
See Also
AutoRefresh property
Images
Scroll event
ScrollImage method
ScrollShortcutsEnabled property
ScrollPositionX property
ScrollPositionY property

# $ K ScrollPositionX Property
Returns or sets the horizontal scroll position in pixels.
Applies To
Image Edit control
Syntax
object.ScrollPositionX[=integer]
Data Type
Long
Remarks
Setting the ScrollPositionX property causes the displayed image to scroll horizontally to the pixel position specified.
To set the scroll position prior to displaying an image, the ScrollPositionX and ScrollPositionY properties must be set in the Load event.
When the image is first displayed using the Display method, this property is set to 0 by default.
When the AutoRefresh property is set to True, changing the ScrollPositionX property causes the displayed image to be refreshed automatically.
Available at run-time as read-and-write.
See Also
AutoRefresh property
Display method
Images
Load event
Scroll event
ScrollBars property
ScrollImage method
ScrollPositionY property

# $ K ScrollPositionY Property
Returns or sets the vertical scroll position in pixels.
Applies To
Image Edit control
Syntax
object.ScrollPositionY[=integer ]
Data Type
Long
Remarks
Setting the ScrollPositionY property causes the displayed image to scroll vertically to the pixel position specified.
To set the scroll position prior to displaying an image, the ScrollPositionX and ScrollPositionY properties must be set in the Load event.
When the image is first displayed using the Display method, this property is set to 0 by default.
When the AutoRefresh property is set to True, changing the ScrollPositionY property causes the displayed image to be refreshed automatically.
Available at run-time as read-and-write.
See Also
AutoRefresh property
Display method
Images
Load event
Scroll event
ScrollBars property
ScrollImage method
ScrollPositionX property

# $ K ScrollShortcutsEnabled Property
Returns or sets whether the object recognizes a set of accelerator keys for scrolling a displayed image provided horizontal and/or vertical scroll bars are present.
Applies To
Image Edit control
Syntax
object.ScrollShortcutsEnabled[={True|False}]
Data Type
Boolean
Setting	Description	
True (default)	Accelerator keys can be used to scroll an image	
False	Accelerator keys cannot be used	
Remarks
If this property and the ScrollBars property are set to True, and the image extends beyond the object’s borders, the end user can use accelerator keys to scroll the displayed image.
Under certain circumstances, it may be necessary to set the focus to the Image Edit control for the accelerator keys to function.
The following accelerator keys provide scrolling capabilities:
Accelerator Key	Description	
Page Down	Scrolls the image downward by one full screen	
Page Up	Scrolls the image upward by one full screen	
Ctrl + Page Down	Scrolls the image to the right by one full screen	
Ctrl + Page Up	Scrolls the image to the left by one full screen	
Right Arrow	Scrolls the image to the right by 4 pixels	
Left Arrow	Scrolls the image to the left by 4 pixels	
Up Arrow	Scrolls the image upward by 4 pixels	
Down Arrow	Scrolls the image downward by 4 pixels	
See Also
Images
Scroll event
ScrollBars property
ScrollImage method

# $ K SelectionRectangle Property
Indicates whether a selection box will be drawn when the end user clicks the left mouse button and drags the mouse pointer over a displayed image.
Applies To
Image Edit control
Syntax
object.SelectionRectangle[=boolean]
Data Type
Boolean
Setting	Description	
True (default)	Selection box drawing is enabled	
False	Selection box drawing is not enabled	
Remarks
Once the end user draws a selection box, cutting and copying to the Clipboard can be accomplished.
See Also
ClipboardCopy method
ClipboardCut method
SelectionRectDrawn event
ZoomToSelection method

# $ K StatusCode Property
Returns a status code, which identifies the error that occurred when the last property was set or read, or the last method was invoked.  A status code of 0 indicates that no error has occurred.
Applies To
Image Admin control, Image Annotation Tool Button control, Image Edit control, Image Scan control, Image Thumbnail control
Syntax
object.StatusCode
Data Type
Long
Remarks
The default value for this property is 0.
Available at run-time as read-only.

# $ K Zoom Property
Returns or sets the zoom factor for an image.
Applies To
Image Edit control
Syntax
object.Zoom[=value]
Data Type
Single
Remarks
The Zoom value is expressed as a percentage.  The valid range is from 2 to 6500 percent; the default value is 100 percent.
When invoked, the FitTo and ZoomToSelection methods update the value of the Zoom property.
A Zoom value can be specified before or after an image is displayed.  If the image currently specified in the Image property is being displayed when the Zoom value is changed, the displayed image may change visually.
When the AutoRefresh property is set to True, changing the Zoom property causes the displayed image to be refreshed automatically.
See Also
AutoRefresh property
Display
FitTo method
Image property
ZoomToSelection method

# $ K Methods (Image Edit control)
AboutBox	GetAnnotationMarkCount	ScrollImage	
AddAnnotationGroup	GetCurrentAnnotationGroup	SelectAnnotationGroup	
BurnInAnnotations	GetSelectedAnnotationBackColor	SelectTool	
ClearDisplay	GetSelectedAnnotationFillColor	SetCurrentAnnotationGroup	
ClipboardCopy	GetSelectedAnnotationFillStyle	SetImagePalette	
ClipboardCut	GetSelectedAnnotationFont	SetSelectedAnnotationBackColor	
ClipboardPaste	GetSelectedAnnotationFontColor	SetSelectedAnnotationFillColor	
CompletePaste	GetSelectedAnnotationImage	SetSelectedAnnotationFillStyle	
ConvertPageType	GetSelectedAnnotationLineColor	SetSelectedAnnotationFont	
DeleteAnnotationGroup	GetSelectedAnnotationLineStyle	SetSelectedAnnotationFontColor	
DeleteImageData	GetSelectedAnnotationLineWidth	SetSelectedAnnotationLineColor	
DeleteSelectedAnnotations	HideAnnotationGroup	SetSelectedAnnotationLineStyle	
Display	HideAnnotationToolPalette	SetSelectedAnnotationLineWidth	
DisplayBlankImage	IsClipboardDataAvailable	ShowAnnotationGroup	
Draw	PrintImage	ShowAnnotationToolPalette	
DrawSelectionRect	Refresh	ShowAttribsDialog	
EditSelectedAnnotationText	RotateLeft	ShowRubberStampDialog	
FitTo	RotateRight	ZoomToSelection	
Flip	Save		
GetAnnotationGroup	SaveAs		

# $ K AboutBox Method
Displays an About dialog box that contains the version number of the control. 
Applies To
Image Admin control, Image Annotation Tool Button control, Image Edit control, Image Scan control, Image Thumbnail control
Syntax
object.AboutBox
Arguments
None
Return Value
None

# $ K AddAnnotationGroup Method
Adds a new annotation group to an image page.
Applies To
Image Edit control
Syntax
object.AddAnnotationGroup GroupName
Argument
Parameter	Data Type	Setting	
GroupName	String	The name of the new annotation group	
Return Value
None
Remarks
The Display method must be invoked prior to calling this method.
The annotation group is not actually created until the first annotation mark is placed on the image.
See Also
Annotations
DeleteAnnotationGroup method
Display method
Images

# $ K BurnInAnnotations Method
Burns annotations onto an image, causing them to be permanently incorporated into the image.  Use this method with caution because once annotations are burned-in, they can no longer be removed or modified.
Applies To
Image Edit control
Syntax
object.BurnInAnnotations Option,MarkOption[,GroupName]
Arguments
Parameter	Data Type	Setting	Description	
Option	Integer
(enumerated)	0	All annotations marks, invisible and visible, are saved to the base image	
		1	All annotations that are visible are saved to the base image	
		2	All annotations that are selected are saved to the base image	
MarkOption
(Refer to the Notes section following this list for more information.)	Integer
(enumerated)	0	Changes annotations to black (on black-and-white images only)	
		1	Changes annotations to white (on black-and-white images only)	
		2	Default rendering -- Does not change the colors of annotations for non-bilevel images (for example, color and gray-scale images)	
GroupName	String	Name	The name of the group that contains the annotations (if specified, the Option parameter is ignored)	
Notes Regarding the Use of the MarkOption Parameter
MarkOption Set to 0
For black-and-white image types, the BurnInAnnotations method with a MarkOption of 0 changes annotations to black.
MarkOption Set to 1
For black-and-white image types, the BurnInAnnotations method with a MarkOption of 1 changes annotations to white.
MarkOption Set to 2
For black-and-white image types, the BurnInAnnotations method with a MarkOption of 2 changes annotations to black, white, or black-and-white dither patterns based on the type of annotation mark, its color, and its transparency setting.  Refer to the following list:
Annotation Type	MarkOption2 Burn-In Format	
Attach-a-Note	Burned-in as a black or white rectangle based on the original background color, with text burned-in as black or white based on the original color of the font.  Light colors, like yellow, are burned-in as white; dark colors, like red, are burned-in as black.  The underlying image data is obscured.
	
Freehand Line,
Hollow Rectangle,
Straight Line,
Text,
Text From File, and
Text Stamp
	Burned-in as black or white based on the original color of the annotation.  Light colors, like yellow, are burned-in as white; dark colors, like red, are burned-in as black.	
Filled Rectangle	Burned-in as black-and-white dithered rectangles.  The underlying image data is obscured.
	
Highlighter	Burned-in as black-and-white transparent dithered rectangles. The underlying image data is visible.
	
Image Embedded and
Image Reference	Burned-in as a black-and-white representation of the original image.	
For all other image types, the BurnInAnnotations method with a MarkOption of 2 burns annotations onto the image using the displayed colors.  Then it converts the image to a 24-bit color image (BGR24 or RGB24).  Because 24-bit color images require a large amount of memory and disk space, use caution when selecting this option.  To minimize the memory and disk space requirements of 24-bit color images, you can use the SaveAs method to save the 24-bit color images as 8-bit Palettized images.
To save color annotations on a black-and-white image, use the ConvertPageType method to convert the image to a page type other than black-and-white.  Then invoke the BurnInAnnotations method with a Mark Option of 2; the BurnInAnnotations method burns the annotations onto the image in color.
Return Value
None
Remarks
After invoking the BurnInAnnotations method, the Save or SaveAs method must be invoked to save the combined image and annotation.
When a GroupName is specified, the Option parameter is ignored and all annotation marks in the specified GroupName are burned-in.
See Also
Annotations
ConvertPageType method
Display method
Images
Save method
SaveAs method

# $ K ClearDisplay Method
Clears a displayed image in the control.
Applies To
Image Edit control
Syntax
object.ClearDisplay
Arguments
None
Return Value
None
Remarks
An image must be displayed before the ClearDisplay method can be invoked.
The ClearDisplay method does not save any changes that may have been made to an existing image, nor does it change the value of the Image property.  It does, however, trigger the Close event.
See Also
Close event
Display
Image property

# $ K ClipboardCopy Method
Copies the selected or specified portion of an image or annotation to the Clipboard.
Applies To
Image Edit control
Syntax
object.ClipboardCopy [Left,Top,Width,Height]
Arguments
Parameter	Data Type	Setting	
Left	Long	The upper-left corner of the selection rectangle in pixel coordinates of the displayed image	
Top	Long	The top of the selection rectangle in pixel coordinates of the displayed image	
Width	Long	The width of the selection rectangle in pixels	
Height	Long	The height of the selection rectangle in pixels	
Return Value
None
Remarks
If the ClipboardCopy method is invoked without parameters after an end user draws a selection rectangle, the image data bounded by the selection rectangle is copied to the Clipboard.
If the ClipboardCopy method is invoked without parameters and without an end user drawing a selection rectangle, the ClipboardCopy method generates an error.
To copy annotations to the Clipboard, the end user selects the desired annotation marks using the Select Annotations tool.
To copy image data to the Clipboard, the end user selects the desired area using the image selection rectangle, which is the default when no annotation tool is selected.
It is not possible to copy both image and annotation data to the Clipboard simultaneously.
See Also
ClipboardCut method
ClipboardPaste method
Display
DrawSelectionRect method
SelectionRectangle property
SelectionRectDrawn event

# $ K ClipboardCut Method
Copies the selected or specified portion of an image or annotation to the Clipboard and then clears (cuts) the portion from the image or annotation.
Applies To
Image Edit control
Syntax
object.ClipboardCut [Left,Top,Width,Height]
Arguments
Parameter	Data Type	Setting	
Left	Long	The upper-left corner of the selection rectangle in pixel coordinates of the displayed image	
Top	Long	The top of the selection rectangle in pixel coordinates of the displayed image	
Width	Long	The width of the selection rectangle in pixels	
Height	Long	The height of the selection rectangle in pixels	
Return Value
None
Remarks
If the ClipboardCut method is invoked without parameters after an end user draws a selection rectangle, the image data bounded by the selection rectangle is copied to the Clipboard and cleared from the image.
If the ClipboardCut method is invoked without parameters and without an end user drawing a selection rectangle, the ClipboardCut method generates an error.
To cut annotations to the Clipboard, the end user selects the desired annotation marks using the Select Annotations tool.
To cut image data to the Clipboard, the end user selects the desired area using the image selection rectangle, which is the default when no annotation tool is selected.
It is not possible to cut both image and annotation data to the Clipboard simultaneously.
See Also
ClipboardCopy method
ClipboardPaste method
Display
DrawSelectionRect method
SelectionRectangle property
SelectionRectDrawn event

# $ K ClipboardPaste Method
Pastes image or annotation data from the Clipboard.
Applies To
Image Edit control
Syntax
object.ClipboardPaste [Left,Top]
Arguments
Parameter	Data Type	Setting	
Left	Long	The left point of the displayed image in pixels	
Top	Long	The top point of the displayed image in pixels	
Return Value
None
Remarks
To determine if data is available for pasting from the Clipboard, invoke the IsClipboardDataAvailable method.
If the Left and Top parameters are not entered, the data is pasted at the left-top point of the displayed image.
See Also
ClipboardCopy method
ClipboardCut method
CompletePaste method
Display
IsClipboardDataAvailable method
PasteCompleted event

# $ K CompletePaste Method
Completes a Clipboard paste operation, making the pasted image or annotation data part of the original image.
Applies To
Image Edit control
Syntax
object.CompletePaste
Arguments
None
Return Value
None
Remarks
The ClipboardPaste method pastes image or annotation data from the Clipboard into the control.  After the image or annotation data appears in the control, it can be moved at will and is therefore not part of the original image.  To make the pasted image or annotation data part of the original image, the Clipboard paste operation must be completed.  When invoked, the CompletePaste method completes a Clipboard paste operation.
A Clipboard paste operation can also be completed by an end user clicking on the form, outside of the pasted data.
See Also
ClipboardPaste method
PasteCompleted event

# $ K ConvertPageType Method
Converts a displayed image to the page type specified and optionally repaints the image.
Applies To
Image Edit control
Syntax
object.ConvertPageType PageType[,Repaint]
Arguments
Parameter	Data Type	Setting	
PageType	Integer
(enumerated)	The desired PageType setting	
Repaint	Boolean	True -- Image is repainted (default)
False -- Image is not repainted	
Return Value
None
Remarks
An image must be displayed before the ConvertPageType method can be invoked.  If the Repaint parameter is not specified, True is entered as a default (the image is repainted).  Invoking this method sets the ImageModified property to True.
To save the converted image, the Save or SaveAs method must be invoked.
An image cannot be converted to a PageType of Palettized4 unless it presently has a 4-bit palette.
See Also
ImageModified property
Images
PageType property
Save method
SaveAs method

# $ K DeleteAnnotationGroup Method
Deletes an annotation group as well as its annotation marks, and then redisplays the image.
Applies To
Image Edit control
Syntax
object.DeleteAnnotationGroup GroupName
Argument
Parameter	Data Type	Setting	
GroupName	String	The name of the annotation group to delete	
Return Value
None
Remarks
The Display method must be invoked prior to calling this method.
To save the image without the annotation marks, the Save or SaveAs method must be invoked.
See Also
AddAnnotationGroup method
Annotations
DeleteSelectedAnnotations method
Display method
Save method
SaveAs method

# $ K DeleteImageData Method
Deletes a selected or specified portion of an image.
Applies To
Image Edit control
Syntax
object.DeleteImageData [Left,Top,Width,Height]
Arguments
Parameter	Data Type	Setting	
Left	Long	The upper-left corner of the selection rectangle in pixel coordinates of the displayed image	
Top	Long	The top of the selection rectangle in pixel coordinates of the displayed image	
Width	Long	The width of the selection rectangle in pixels	
Height	Long	The height of the selection rectangle in pixels	
Return Value
None
Remarks
If the DeleteImageData method is invoked without parameters after an end user draws a selection rectangle, the area bounded by the selection rectangle is deleted.  This method does not delete annotation data.
If the DeleteImageData method is invoked without parameters and without an end user drawing a selection rectangle, the DeleteImageData method generates an error.
After invoking the DeleteImageData method, the Save or SaveAs method must be invoked to save the altered image.
See Also
DeleteSelectedAnnotations method
DrawSelectionRect method
Images
Save method
SaveAs method
SelectionRectangle property
SelectionRectDrawn event

# $ K DeleteSelectedAnnotations Method
Deletes selected annotations.
Applies To
Image Edit control
Syntax
object.DeleteSelectedAnnotations
Arguments
None
Return Value
None
Remarks
To be deleted, annotations must first be selected using the Select Annotations tool.  If no annotations are selected, the DeleteSelectedAnnotations method generates an error.
After invoking the DeleteSelectedAnnotations method, the Save or SaveAs method must be invoked to save the altered image.
Note that annotations can also be deleted by invoking the DeleteAnnotationGroup method.
See Also
Annotations
DeleteAnnotationGroup method
Save method
SaveAs method

# $ K Display Method
Displays the image specified in the Image property. 
Applies To
Image Edit control
Syntax
object.Display
Arguments
None
Return Value
None
Remarks
The Display method triggers a Load event before the actual image is displayed.  End users can then hide or show any of the annotation groups before they are actually displayed, or set any other display-oriented properties (for example, Zoom, ScrollPosition, etc.).  If an image is already displayed, this method triggers a Close event.
See Also
Close event
Display
Load event
Image property
ImageDisplayed property
Page property

# $ K DisplayBlankImage Method
Displays a blank image according to the dimensions specified.
Applies To
Image Edit control
Syntax
object.DisplayBlankImage ImageWidth,ImageHeight[,ResolutionX,ResolutionY,PageType]
Arguments
Parameter	Data Type	Setting	
ImageWidth	Long	The width of the image in pixels at full-scale (100 percent)	
ImageHeight	Long	The height of the image in pixels at full-scale (100 percent)	
ResolutionX	Long	The horizontal resolution of the image in dots per inch	
ResolutionY	Long	The vertical resolution of the image in dots per inch	
PageType	Integer
(enumerated)	The desired PageType setting	
Return Value
None
Remarks
When the DisplayBlankImage method is invoked with an image already displayed, it triggers a Close event.  The displayed image file is closed without being saved, and the new image data is displayed.  The value of the Image property remains unchanged.
If the ResolutionX parameter or the ResolutionY parameter is not entered, a value of 200 is used as a default.  If the PageType parameter is not entered, the Black-and-White page type is used as a default.
See Also
Close event
Display

# $ K DrawSelectionRect Method
Draws a selection rectangle on an image.
Applies To
Image Edit control
Syntax
object.DrawSelectionRect Left,Top,Width,Height
Arguments
Parameter	Data Type	Setting	
Left	Long	The beginning horizontal position of the rectangle relative to the image window in pixels	
Top	Long	The beginning vertical position of the rectangle relative to the image window in pixels	
Width	Long	The width of the selection rectangle in pixels	
Height	Long	The height of the selection rectangle in pixels	
Return Value
None
Remarks
None
See Also
ClipboardCopy method
ClipboardCut method
DeleteImageData method
Images
SelectionRectangle property
SelectionRectDrawn event
ZoomToSelection method

# $ K EditSelectedAnnotationText Method
Displays a dialog box with the selected text annotation.  The dialog box enables the end user to modify the text.
Applies To
Image Edit control
Syntax
object.EditSelectedAnnotationText Left,Top
Arguments
Parameter	Data Type	Setting	
Left	Long	The beginning horizontal position of the mark to be edited	
Top	Long	The beginning vertical position of the mark to be edited	
Return Value
None
Remarks
The left and top coordinates of the annotation to be edited can be obtained from the MarkSelect event.
After invoking the EditSelectedAnnotationText method, the Save or SaveAs method must be invoked to save the altered annotation.
See Also
Annotations
MarkSelect event
Save method
SaveAs method

# $ K FitTo Method
Scales the image relative to the image window.
Applies To
Image Edit control
Syntax
object.FitTo Option[,Repaint]
Arguments
Parameter	Data Type	Setting	Description	
Option	Integer
(enumerated)	0
1
2
3	Best fit -- Fits the image to the size of the window
Fit to width -- Fits the image to the width of the window
Fit to height -- Fits the image to the height of the window
Inch to inch -- Maintains the relative size of the original image regardless of the resolution of the image	
Repaint	Boolean	True
False	Image is repainted (default)
Image is not repainted	
Return Value
None
Remarks
The Inch to inch setting calculates the size of the image dependent upon the dots per inch reported by the display driver.
When invoked, the FitTo method updates the Zoom property with the new zoom factor.
The FitTo method can be invoked before or after an image is displayed.  If an image is displayed when the method is invoked, and the Repaint parameter is set to True, the image is redisplayed using the Option setting specified.
See Also
Display
Zoom property
ZoomToSelection method

# $ K Flip Method
Rotates a displayed image by 180 degrees.
Applies To
Image Edit control
Syntax
object.Flip
Arguments
None
Return Value
None
Remarks
The Display method must be invoked prior to calling this method.
Invoking the Flip method modifies the displayed image.  The Save or SaveAs method must be invoked to save the modified image.
See Also
Display
Display method
RotateLeft method
RotateRight method
Save method
SaveAs method

# $ K GetAnnotationGroup Method
Returns the name of the annotation group based on the index specified.
Applies To
Image Edit control
Syntax
object.GetAnnotationGroup(Index)
Argument
Parameter	Data Type	Setting	
Index	Integer	The index value of the annotation group	
Return Value
String
Remarks
The Display method must be invoked prior to calling this method.
Index is a 0-based value, where 0 is the first annotation group in the array, 1 is the second, 2 is the third, and so on.  The upper bound value of the index can be obtained from the AnnotationGroupCount property.
The GetAnnotationGroup method is valid only at run-time.
See Also
AnnotationGroupCount property
Annotations
Display method
GetCurrentAnnotationGroup method
HideAnnotationGroup method
SelectAnnotationGroup method
SetCurrentAnnotationGroup method
ShowAnnotationGroup method

# $ K GetAnnotationMarkCount Method
Returns the number of annotation marks on an image page or in an annotation group.
Applies To
Image Edit control
Syntax
object.GetAnnotationMarkCount([GroupName,AnnotationType])
Arguments
Parameter	Data Type	Setting	
GroupName	String	The name of the annotation group	
AnnotationType	Integer
(enumerated)	The desired AnnotationType setting	
Return Value
Integer
Remarks
The Display method must be invoked prior to calling this method.
If the GroupName and Annotation Type parameters are both entered, the GetAnnotationMarkCount method returns the number of annotation marks of the type specified that are in the annotation group specified.
If the GroupName parameter is entered, but the Annotation Type is not entered, the GetAnnotationMarkCount method returns the total number of annotation marks that are in the annotation group specified.
If the GroupName parameter is not entered, but the Annotation Type is entered, the GetAnnotationMarkCount method returns the number of annotation marks of the type specified that are in all of the annotation groups.
If no parameters are entered, the GetAnnotationMarkCount method returns the total number of annotation marks that are on the page.
The GetAnnotationMarkCount method is valid only at run-time.
See Also
AnnotationGroupCount property
Annotations
AnnotationType property
Display method

# $ K GetCurrentAnnotationGroup Method
Returns the name of the annotation group to which subsequent annotations will belong.
Applies To
Image Edit control
Syntax
object.GetCurrentAnnotationGroup
Arguments
None
Return Value
String
Remarks
The GetCurrentAnnotationGroup method is valid only at run-time.
See Also
Annotations
BurnInAnnotations method
GetAnnotationGroup method
HideAnnotationGroup method
SetCurrentAnnotationGroup method
SelectAnnotationGroup method
ShowAnnotationGroup method

# $ K GetSelectedAnnotationBackColor Method
Returns the background color of a selected Attach-a-Note annotation.
Applies To
Image Edit control
Syntax
object.GetSelectedAnnotationBackColor
Arguments
None
Return Value
Color
Remarks
The GetSelectedAnnotationBackColor method is valid only at run-time.  It is used with annotations of the Attach-a-Note type.
Color is expressed using the Red-Green-Blue (R,G,B) format.
See Also
AnnotationBackColor property
Annotations
AnnotationType property
SetSelectedAnnotationBackColor method

# $ K GetSelectedAnnotationFillColor Method
Returns the color used to fill a selected Filled Rectangle annotation.
Applies To
Image Edit control
Syntax
object.GetSelectedAnnotationFillColor
Arguments
None
Return Value
Color
Remarks
The GetSelectedAnnotationFillColor method is valid only at run-time.  It is used with annotations of the Filled Rectangle type.
Color is expressed using the Red-Green-Blue (R,G,B) format.
See Also
AnnotationFillColor property
Annotations
AnnotationType property
SetSelectedAnnotationFillColor method

# $ K GetSelectedAnnotationFillStyle Method
Returns the style used to fill a selected image or Filled Rectangle annotation.
Applies To
Image Edit control
Syntax
object.GetSelectedAnnotationFillStyle
Arguments
None
Return Value
Integer (enumerated)
Value	Description	
0	Transparent	
1	Opaque	
Remarks
The GetSelectedAnnotationFillStyle method is valid only at run-time.  It is used with annotations of the following types:
Filled Rectangle	
Image Embedded	
Image Reference	
See Also
AnnotationFillStyle property
Annotations
AnnotationType property
SetSelectedAnnotationFillStyle method

# $ K GetSelectedAnnotationFont Method
Returns a font object’s properties.  Applies to selected text annotations.
Applies To
Image Edit control
Syntax
object.GetSelectedAnnotationFont
Arguments
None
Return Value
Font object
Remarks
For example, the following code returns the properties of the font object identified by the GetSelectedAnnotationFont method of an Image Edit object:
Dim x As Font
Set x = Imgedit1.GetSelectedAnnotationFont
CommonDialog1.FontBold = x.Bold
CommonDialog1.FontItalic = x.Italic
CommonDialog1.FontName = x.Name
CommonDialog1.FontSize = x.SIZE
CommonDialog1.FontUnderline = x.Underline
CommonDialog1.Font Strikethru = x.StrikeThrough
CommonDialog1.Flags = &H103&
CommonDialog1.ShowFont
The GetSelectedAnnotationFont method is valid only at run-time.  It is used with annotations of the following types:
Text	
Attach-a-Note	
Text From File	
Text Stamp	
See Also
AnnotationFont property
Annotations
AnnotationType property
SetSelectedAnnotationFont method

# $ K GetSelectedAnnotationFontColor Method
Returns the color used in a selected text annotation.
Applies To
Image Edit control
Syntax
object.GetSelectedAnnotationFontColor
Arguments
None
Return Value
Color
Remarks
The GetSelectedAnnotationFontColor method is valid only at run-time.  It is used with annotations of the following types:
Text	
Attach-a-Note	
Text From File	
Text Stamp	
Color is expressed using the Red-Green-Blue (R,G,B) format.
See Also
AnnotationFontColor property
Annotations
AnnotationType property
SetSelectedAnnotationFontColor method

# $ K GetSelectedAnnotationImage Method
Returns the fully-qualified filename of the image that is being used in a selected image annotation.
Applies To
Image Edit control
Syntax
object.GetSelectedAnnotationImage
Arguments
None
Return Value
String
Remarks
The GetSelectedAnnotationImage method is valid only at run-time.  It is used with annotations of the following types:
Image Embedded	
Image Reference	
See Also
AnnotationImage property
Annotations
AnnotationType property
Images

# $ K GetSelectedAnnotationLineColor Method
Returns the line color used in a selected line or Hollow Rectangle annotation.
Applies To
Image Edit control
Syntax
object.GetSelectedAnnotationLineColor
Arguments
None
Return Value
Color
Remarks
The GetSelectedAnnotationLineColor method is valid only at run-time.  It is used with annotations of the following types:
Freehand Line	
Hollow Rectangle	
Straight Line	
Color is expressed using the Red-Green-Blue (R,G,B) format.
See Also
AnnotationLineColor property
Annotations
AnnotationType property
SetSelectedAnnotationLineColor method

# $ K GetSelectedAnnotationLineStyle Method
Returns the line style used in a selected line or Hollow Rectangle annotation.
Applies To
Image Edit control
Syntax
object.GetSelectedAnnotationLineStyle
Arguments
None
Return Value
Integer (enumerated)
Value	Description	
0	Transparent	
1	Opaque	
Remarks
The GetSelectedAnnotationLineStyle method is valid only at run-time.  It is used with annotations of the following types:
Freehand Line	
Hollow Rectangle	
Straight Line	
See Also
AnnotationLineStyle property
Annotations
AnnotationType property
SetSelectedAnnotationLineStyle method

# $ K GetSelectedAnnotationLineWidth Method
Returns the line width in pixels used in a selected line or Hollow Rectangle annotation.
Applies To
Image Edit control
Syntax
object.GetSelectedAnnotationLineWidth
Arguments
None
Return Value
Integer
Remarks
The GetSelectedAnnotationLineWidth method is valid only at run-time.  It is used with annotations of the following types:
Freehand Line	
Hollow Rectangle	
Straight Line	
See Also
AnnotationLineWidth property
Annotations
AnnotationType property
SetSelectedAnnotationLineWidth method

# $ K HideAnnotationGroup Method
Hides an annotation group.
Applies To
Image Edit control
Syntax
object.HideAnnotationGroup [GroupName]
Argument
Parameter	Data Type	Setting	
GroupName	String	The name of the annotation group to hide	
Return Value
None
Remarks
The Display method must be invoked prior to calling this method.
If the GroupName parameter is not specified, the HideAnnotationGroup method hides all annotation groups.
See Also
Annotations
Display method
GetAnnotationGroup method
GetCurrentAnnotationGroup method
SetCurrentAnnotationGroup method
ShowAnnotationGroup method

# $ K HideAnnotationToolPalette Method
Hides the Annotation Tool Palette.
Applies To
Image Edit control
Syntax
object.HideAnnotationToolPalette
Arguments
None
Return Value
None
Remarks
The ShowAnnotationToolPalette method must be invoked prior to calling this method.
See Also
Annotations
ShowAnnotationToolPalette method
ToolPaletteHidden event

# $ K IsClipboardDataAvailable Method
Determines whether image or annotation data is present in the Clipboard.
Applies To
Image Edit control
Syntax
object.IsClipboardDataAvailable
Arguments
None
Return Value
Boolean
Value	Description	
True	Image or annotation data is in the clipboard	
False	Image or annotation data is not in the clipboard	
Remarks
Use the IsClipboardDataAvailable method to determine whether the ClipboardPaste method can be invoked.
See Also
Annotations
ClipboardCopy method
ClipboardCut method
ClipboardPaste method
Images

# $ K PrintImage Method
Prints the image being displayed.
Applies To
Image Edit control
Syntax
object.PrintImage [StartPage,EndPage,OutputFormat,Annotations,Printer,Driver,PortNumber]
Arguments
Parameter	Data Type	Setting	
StartPage	Long	The starting page in a range of pages to be printed	
EndPage	Long	The ending page in a range of pages to be printed	
OutputFormat	Integer
(enumerated)	The output format to be used:
0 -- Pixel to pixel
1 -- Inch to inch
2 -- Fit to page	
Annotations	Boolean	Whether annotations will be printed with the image:
True -- Annotations will be printed
False -- Annotations will not be printed	
Printer	String	The name of the printer	
Driver	String	The name of the printer driver	
PortNumber	String	The name of the output port	
Return Value
None
Remarks
If an image is displayed when the PrintImage method is invoked, the image is printed as it appears, including any changes made.
If an image is not being displayed, the PrintImage method prints the image specified in the Image property.  If an image is not being displayed and the Image property does not contain the filename of an image, the PrintImage method generates an error.
If the StartPage and EndPage parameters are not entered, this method prints all pages by default.
If the Annotations parameter is not specified, all annotations are printed by default.
See Also
Image property
Images

# $ K Refresh Method
Repaints the contents of the Image Edit control.
Applies To
Image Edit control
Syntax
object.Refresh
Arguments
None
Return Value
None
Remarks
The Display method must be invoked prior to calling this method.
See Also
Display method
DisplayScaleAlgorithm property
ImagePalette property
ImageResolutionX property
ImageResolutionY property
ScrollBars property
ScrollPositionX property
ScrollPositionY property
Zoom property

# $ K RotateLeft Method
Rotates the displayed image 90 degrees to the left.
Applies To
Image Edit control
Syntax
object.RotateLeft
Arguments
None
Return Value
None
Remarks
The Display method must be invoked prior to calling this method.
Invoking the RotateLeft method modifies the displayed image.  The Save or SaveAs method must be invoked to save the modified image.
See Also
Display
Display method
Flip method
RotateRight method
Save method
SaveAs method

# $ K RotateRight Method
Rotates the displayed image 90 degrees to the right.
Applies To
Image Edit control
Syntax
object.RotateRight
Arguments
None
Return Value
None
Remarks
The Display method must be invoked prior to calling this method.
Invoking the RotateRight method modifies the displayed image.  The Save or SaveAs method must be invoked to save the modified image.
See Also
Display
Display method
Flip method
RotateLeft method
Save method
SaveAs method

# $ K Save Method
Saves the displayed image (page) to the original path and file.
Applies To
Image Edit control
Syntax
object.Save [SaveAtZoom]
Argument
Parameter	Data Type	Setting	
SaveAtZoom	Boolean	Whether the image is saved using the current or original scale percentage value:
True -- The image is saved using the current scale percentage value, as specified in the Zoom property
False -- The image is saved using the original scale percentage value (Zoom value of 100 percent)	
Return Value
None
Remarks
The Display method must be invoked prior to calling this method.
For the TIFF file type, annotations are saved as annotation data.  For all other file types, annotations are lost unless the BurnInAnnotations method was invoked prior to calling the Save method.  The BurnInAnnotations method burns annotations onto an image, causing them to be permanently incorporated into the image.
The Save method saves the image to the same file from which it was opened.  The saved image remains in the display window at its original resolution.
If the SaveAtZoom parameter is not specified, the image is saved using the original zoom scale percentage value.
See Also
Annotations
BurnInAnnotations method
Close event
Display
Display method
ImageModified property
Images
SaveAs method
Zoom property

# $ K SaveAs Method
Saves the displayed image using the filename specified.
Applies To
Image Edit control
Syntax
object.SaveAs Image[,FileType,PageType,CompressionType,CompressionInfo,SaveAtZoom]
Arguments
Parameter	Data Type	Setting	
Image	String	The name of the image file being saved	
FileType	Integer
(enumerated)	The FileType the image is being saved as	
PageType	Integer
(enumerated)	The PageType the image is being saved as	
CompressionType	Integer
(enumerated)	The CompressionType at which the image is being saved	
CompressionInfo	Integer
(enumerated)	The CompressionInfo setting of the image being saved	
SaveAtZoom	Boolean	Whether the image is being saved using the current or original scale percentage value:
True -- The image is being saved using the current scale percentage value
False -- The image is being saved using the original scale percentage value	
Return Value
None
Remarks
The Display method must be invoked prior to calling this method.
The SaveAs method saves the image using the filename specified in the Image parameter.  If the file already exists, it is overwritten.
Upon successful completion of the SaveAs method, the image display window continues to display the original image; the Image property value remains unchanged.  Continuing to display the original image ensures that the image on display is the same as the image specified in the Image property.  For example, assume the currently displayed image is payroll.tif and the value of the Image property is also payroll.tif.  When the SaveAs method is invoked with its Image parameter set to payroll96.tif, the image is saved as payroll96.tif.  The image display window continues to display payroll.tif, and the Image property value remains unchanged at payroll.tif.
If a multipage image file (DCX, TIFF, or XIF) is saved as a file type that does not support multipage image files (for example, BMP), only the page currently being displayed is saved to the new file.
For the TIFF file type, annotations are saved as annotation data.  For all other file types, annotations are lost unless the BurnInAnnotations method is invoked prior to calling the SaveAs method.  The BurnInAnnotations method burns annotations onto an image, causing them to be permanently incorporated into the image.
If the FileType parameter is not entered, the SaveAs method uses the original FileType setting of the image as a default.  If the original FileType setting cannot be determined or is read-only, the method saves the image as a TIFF file.  (For example, the SaveAs method saves a XIF file as a TIFF file.)
If the PageType and FileType parameters are not entered, the SaveAs method uses the original PageType setting of the image as a default.  However, if a FileType is entered, the SaveAs method uses a PageType default setting that is associated with the FileType setting of the image.  The following list describes the default PageType settings:
FileType Setting	Default PageType Setting	
1 – TIFF	PageType setting of the displayed image	
3 – BMP	PageType setting of the displayed image	
If the CompressionType parameter is Group3(2D), the SaveAs method saves the image using the Group4(2D) compression type.  If the CompressionType parameter is LZW, the SaveAs method saves the image using no compression.
If the CompressionType parameter is not entered, the SaveAs method uses a default CompressionType setting that is associated with the FileType and PageType settings of the image.  The following list describes the default CompressionType settings:
FileType Setting	PageType Setting	Default CompressionType Setting	
3 – BMP	1,5,7 -- All supported PageTypes	1 -- No compression	
1 – TIFF	1 -- Black-and-white	2 -- Group3(1D)	
1 – TIFF	2 -- Gray4	1 -- No compression	
1 – TIFF	3 -- Gray8	6 -- JPEG	
1 – TIFF	4 -- Palettized4	1 -- No compression	
1 – TIFF	5 -- Palettized8	1 -- No compression	
1 – TIFF	6 -- RGB24	6 -- JPEG	
Note:  To use a PageType setting of 4 (Palettized4), the displayed image must already be a Palettized4 image.
If the CompressionInfo parameter is not entered, the SaveAs method uses a default CompressionInfo setting that is associated with the CompressionType setting of the image.  The following list describes the default CompressionInfo settings:
CompressionType Setting	CompressionInfo Default Setting	
1 -- No compression	0 -- No compression	
2 -- Group3(1D)	8 -- Compressed LTR,
16 -- Expand LTR,
1 -- EOL, and
4 -- Prefixed EOL	
3 -- Group3(Modified Huffman)	8 -- Compressed LTR and
16 -- Expand LTR	
4 -- PackBits	16 -- Expand LTR	
5 -- Group4(2D)	2 -- Packed Lines,
8 -- Compressed LTR, and
16 -- Expand LTR	
6 -- JPEG	1024 -- Medium Compression/Medium Quality	
When a CompressionInfo value of 0 is entered with the CompressionType parameter set to 1 (no compression), the file is saved using no compression.
When a CompressionInfo value of 0 is entered with the CompressionType parameter set to a value other than 1, the file is saved using the default CompressionInfo parameter settings that correspond to the setting of the CompressionType parameter (as explained in the preceding list).
For example, if the end user specifies a CompressionType value of 1 (no compression) and then a CompressionInfo value of 0, the file is saved using no compression.  If the end user specifies a CompressionType value of 2 (Group3[1D]) and then a CompressionInfo value of 0, the file is saved using the default CompressionInfo values for Group3(1D):
8 -- Compressed LTR,
16 -- Expand LTR,
1 -- EOL, and
4 -- Prefixed EOL
If the SaveAtZoom parameter is not specified, the image is saved using the original zoom scale percentage value.
See Also
BurnInAnnotations method
Compression
CompressionInfo property
CompressionType property
Close event
Display
Display method
FileType property
Image property
ImageModified property
Images
PageType property
Save method

# $ K ScrollImage Method
Scrolls a displayed image.
Applies To
Image Edit control
Syntax
object.ScrollImage Direction,ScrollAmount
Arguments
Parameter	Data Type	Setting	
Direction	Integer (enumerated)	The direction in which to scroll the image: 
0 -- Down
1 -- Up
2 -- Right
3 -- Left	
ScrollAmount	Long	The number of pixels to scroll the image	
Return Value
None
Remarks
The Display method must be invoked prior to calling this method.
See Also
Display method
Images
Scroll event
ScrollBars property
ScrollPositionX property
ScrollPositionY property
ScrollShortcutsEnabled property

# $ K SelectAnnotationGroup Method
Selects all annotation marks within a specific group on the image page.
Applies To
Image Edit control
Syntax
object.SelectAnnotationGroup GroupName
Argument
Parameter	Data Type	Setting	
GroupName	String	The name of the annotation group to select	
Return Value
None
Remarks
The Display method must be invoked prior to calling this method.
See Also
AddAnnotationGroup method
Annotations
Display method
GetAnnotationGroup method
GetCurrentAnnotationGroup method
MarkSelect event
SetCurrentAnnotationGroup method
ShowAnnotationGroup method

# $ K SelectTool Method
Selects an annotation tool from the Annotation Tool Palette.
Applies To
Image Edit control
Syntax
object.SelectTool ToolID
Argument
Parameter	Data Type	Setting	Description	
ToolID	Integer
(enumerated)	0
1
2
3
4
5
6
7
8
9
10	No Tool
Selection
Freehand Line
Highlighter
Straight Line
Hollow Rectangle
Filled Rectangle
Text
Attach-a-Note
Text From File
Text Stamp	
Return Value
None
Remarks
The Highlighter annotation type is composed of a Filled Rectangle annotation type with a transparent fill style.
When a tool is selected from the tool palette, the previous tool is deselected automatically.
The Annotation Tool Palette does not have to be visible to use this method.
See Also
Annotations
ShowAnnotationToolPalette method
ToolSelected event

# $ K SetCurrentAnnotationGroup Method
Sets the annotation group to which subsequent annotations will belong.
Applies To
Image Edit control
Syntax
object.SetCurrentAnnotationGroup GroupName
Argument
Parameter	Data Type	Setting	
GroupName	String	The name of the annotation group	
Return Value
None
Remarks
The SetCurrentAnnotationGroup method is valid only at run-time.
The names of the groups can be obtained from the GetAnnotationGroup method.
A new group can be created using the AddAnnotationGroup method.
See Also
AddAnnotationGroup method
Annotations
BurnInAnnotations method
GetAnnotationGroup method
GetCurrentAnnotationGroup method

# $ K SetImagePalette Method
Sets the palette to be used for the image currently being displayed, or an image to be displayed.
Applies To
Image Edit control
Syntax
object.SetImagePalette Option
Argument
Parameter	Data Type	Setting	Description	
Option	Integer
(enumerated)	0
1	Foreground
Background	
Return Value
None
Remarks
Images are displayed using the foreground palette by default.  When the default foreground palette is used, it is loaded into the Windows palette, which can cause other images or other color-aware objects to become distorted.  Setting the SetImagePalette Option value to 1 (Background) sets the existing palette, which has already been loaded by Windows.
See Also
ImagePalette property
Images
Palettes

# $ K SetSelectedAnnotationBackColor Method
Sets the background color of a selected Attach-a-Note annotation.
Applies To
Image Edit control
Syntax
object.SetSelectedAnnotationBackColor Color
Argument
Parameter	Data Type	Setting	
Color	Color	The desired Attach-a-Note color	
Return Value
None
Remarks
The SetSelectedAnnotationBackColor method is used with annotations of the Attach-a-Note type.
Use the RGB format.  To ensure that the text in an Attach-a-Note annotation will be visible against the background, specify a background color that is significantly different from the font color set using the SetSelectedAnnotationFontColor method.
See Also
AnnotationBackColor property
AnnotationType property
Annotations
GetSelectedAnnotationBackColor method
SetSelectedAnnotationFontColor method

# $ K SetSelectedAnnotationFillColor Method
Sets the color used to fill a selected Filled Rectangle annotation.
Applies To
Image Edit control
Syntax
object.SetSelectedAnnotationFillColor Color
Argument
Parameter	Data Type	Setting	
Color	Color	The desired Filled Rectangle color	
Return Value
None
Remarks
The SetSelectedAnnotationFillColor method is used with annotations of the Filled Rectangle annotation type.
Use the RGB format.
See Also
AnnotationFillColor property
Annotations
AnnotationType property
GetSelectedAnnotationFillColor method
SetSelectedAnnotationFontColor method

# $ K SetSelectedAnnotationFillStyle Method
Sets the style used to fill a selected image or Filled Rectangle annotation.
Applies To
Image Edit control
Syntax
object.SetSelectedAnnotationFillStyle Style
Argument
Parameter	Data Type	Setting	Description	
Style	Integer
(enumerated)	0
1	Transparent -- The underlying image data is visible
Opaque -- The underlying image data is obscured	
Return Value
None
Remarks
The SetSelectedAnnotationFillStyle method is used with annotations of the following types:
Filled Rectangle	
Image Embedded	
Image Reference	
See Also
AnnotationFillStyle property
Annotations
AnnotationType property
GetSelectedAnnotationFillStyle method

# $ K SetSelectedAnnotationFont Method
Sets a font object’s properties.  Applies to selected text annotations.
Applies To
Image Edit control
Syntax
object.SetSelectedAnnotationFont Font
Argument
Parameter	Data Type	Setting	
Font	Font object	The properties of the font object	
Return Value
None
Remarks
Use the SetSelectedAnnotationFont method to identify the specific font object whose properties you want to set.  The following list shows the properties you can set, along with their data types, descriptions, and defaults:
Property	Data Type	Description	Default	
Bold	Boolean	True -- Selects bold attribute
False -- Deselects bold attribute	False	
Italic	Boolean	True -- Selects italic attribute
False -- Deselects italic attribute	False	
Name	String	The desired font name	MS San Serif	
Size	Single	The desired font size in points (0 to 2048)	12	
Underline	Boolean	True -- Selects underline attribute
False -- Deselects underline attribute	False	
StrikeThrough	Boolean	True -- Selects strikethrough attribute
False -- Deselects strikethrough attribute	False	
For example, the following code sets the properties of the font object identified by the SetSelectedAnnotationFont method of an Image Edit object:
Dim x As Font
Set x = Form1.Font
x.Bold = True
x.Italic = True
x.Name = "Courier New"
x.SIZE = 14
x.Underline = True
x.StrikeThrough = True
Imgedit1.SetSelectedAnnotationFont x
The SetSelectedAnnotationFont method is used with annotations of the following types:
Text	
Attach-a-Note	
Text From File	
Text Stamp	
See Also
AnnotationFont property
Annotations
AnnotationType property
GetSelectedAnnotationFont method

# $ K SetSelectedAnnotationFontColor Method
Sets the font color used in a selected text annotation.
Applies To
Image Edit control
Syntax
object.SetSelectedAnnotationFontColor Color
Argument
Parameter	Data Type	Setting	
Color	Color	The desired font color	
Return Value
None
Remarks
The SetSelectedAnnotationFontColor method is used with annotations of the following types:
Text	
Attach-a-Note	
Text From File	
Text Stamp	
Use the RGB format.  To ensure that the text in an Attach-a-Note annotation will be visible against the background, specify a font color that is significantly different from the background color set using the SetSelectedAnnotationBackColor method.
See Also
AnnotationFontColor property
Annotations
AnnotationType property
GetSelectedAnnotationFontColor method
SetSelectedAnnotationBackColor method
SetSelectedAnnotationFillColor method

# $ K SetSelectedAnnotationLineColor Method
Sets the line color used in a selected line or Hollow Rectangle annotation.
Applies To
Image Edit control
Syntax
object.SetSelectedAnnotationLineColor Color
Argument
Parameter	Data Type	Setting	
Color	Color	The desired line color	
Return Value
None
Remarks
The SetSelectedAnnotationLineColor method is used with annotations of the following types:
Freehand Line	
Hollow Rectangle	
Straight Line	
Use the RGB format.
See Also
AnnotationLineColor property
Annotations
AnnotationType property
GetSelectedAnnotationLineColor method

# $ K SetSelectedAnnotationLineStyle Method
Sets the line style used in a selected line or Hollow Rectangle annotation.
Applies To
Image Edit control
Syntax
object.SetSelectedAnnotationLineStyle Style
Argument
Parameter	Data Type	Setting	Description	
Style	Integer
(enumerated)	0
1	Transparent -- The underlying image data is visible
Opaque -- The underlying image data is obscured	
Return Value
None
Remarks
The SetSelectedAnnotationLineStyle method is used with annotations of the following types:
Freehand Line	
Hollow Rectangle	
Straight Line	
See Also
AnnotationLineStyle property
Annotations
AnnotationType property
GetSelectedAnnotationLineStyle method

# $ K SetSelectedAnnotationLineWidth Method
Sets the line width used in a selected line or Hollow Rectangle annotation.
Applies To
Image Edit control
Syntax
object.SetSelectedAnnotationLineWidth Width
Argument
Parameter	Data Type	Setting	
Width	Integer	The desired line width in pixels	
Return Value
None
Remarks
The SetSelectedAnnotationLineWidth method is used with annotations of the following types:
Freehand Line	
Hollow Rectangle	
Straight Line	
See Also
AnnotationLineWidth property
Annotations
AnnotationType property
GetSelectedAnnotationLineWidth method

# $ K ShowAnnotationGroup Method
Shows the specified annotation group.
Applies To
Image Edit control
Syntax
object.ShowAnnotationGroup [GroupName]
Argument
Parameter	Data Type	Setting	
GroupName	String	The name of the desired annotation group	
Return Value
None
Remarks
The Display method must be invoked prior to calling this method.
If the GroupName parameter is not entered, the ShowAnnotationGroup method shows all annotation groups.
See Also
Annotations
Display method
GetAnnotationGroup method
GetCurrentAnnotationGroup method
HideAnnotationGroup method
SelectAnnotationGroup method

# $ K ShowAnnotationToolPalette Method
Shows the Annotation Tool Palette, which enables end users to edit images displayed in this control.
Applies To
Image Edit control
Syntax
object.ShowAnnotationToolPalette [ShowAttributesDialog,Left,Top,ToolTipText]
Arguments
Parameter	Data Type	Setting	
ShowAttributesDialog	Boolean	Whether the Annotation Attributes dialog box is invoked:
True -- When the end user clicks on a tool palette button using the right mouse button and selects properties from a pop-up menu, the Annotation Attributes dialog box appears.  When the end user clicks on the Rubber Stamp tool button, a pop-up menu appears that contains a list of previously defined stamps.
False -- The Annotation Attributes dialog box cannot be invoked.	
Left	Long	The horizontal position of the Annotation Tool Palette in pixels, relative to the upper-left corner of the Image Edit control.	
Top	Long	The vertical position of the Annotation Tool Palette in pixels, relative to the upper-left corner of the Image Edit control.	
ToolTipText	String	Contains the tool tip text used for each Annotation Tool Palette button.  Ten strings are required; use the vertical bar (|) character to separate each string.  If not specified, default strings are provided.	
Return Value
None
Remarks
The ShowAnnotationToolPalette method can be invoked only once per control.
If the ShowAttributesDialog parameter is not entered, it is set to True by default.
If the Left and Top parameters are not entered, the Annotation Tool Palette is displayed at Position 10,10 relative to the Image Edit control.
ToolTip strings are displayed by default only as long as the tool palette control has focus.  It is the responsibility of the calling application to insure that the control gets focus in the appropriate situations, either through explicit or implicit means.
To draw annotations using the Annotation Tool Palette, an annotation tool must be selected.  This can be accomplished by the end user clicking on a button on the tool palette, or by invoking the SelectTool method.  The annotation mark can then be drawn manually by the end user, or programatically by calling the Draw method.  Changing the AnnotationType property with the Annotation Tool Palette displayed will not achieve the desired results.
See Also
Annotations
Display method
Draw method
HideAnnotationToolPalette method
SelectTool method
ShowAttribsDialog method
ToolSelected event
ToolTip event

# $ K ShowAttribsDialog Method
Shows an Annotation Attributes dialog box, which the end user can use to change the attributes of the selected annotation mark.
Applies To
Image Edit control
Syntax
object.ShowAttribsDialog
Arguments
None
Return Value
None
Remarks
An annotation must be selected before invoking the ShowAttribsDialog method.
See Also
Annotations
SelectAnnotationGroup method
SelectTool method

# $ K ShowRubberStampDialog Method
Can be used in conjunction with the Annotation Tool Palette to show the Rubber Stamp Properties dialog box to allow the end user to create, delete, and edit Rubber Stamps.
Applies To
Image Edit control
Syntax
object.ShowRubberStampDialog
Arguments
None
Return Value
None
Remarks
None
See Also
Annotations
SelectTool method
ShowAnnotationToolPalette method

# $ K ZoomToSelection Method
Scales a selected portion of a displayed image so that it fits into the size of the control.
Applies To
Image Edit control
Syntax
object.ZoomToSelection
Arguments
None
Return Value
None
Remarks
A selection rectangle must be drawn on the image prior to calling the ZoomToSelection method.
The ZoomToSelection method updates the Zoom property with the zoom factor used.
See Also
Display
Display method
DrawSelectionRect method
FitTo method
SelectionRectDrawn event
Zoom property

# $ K Events (Image Edit control)
The following events used by the Image Edit control are all standard:
Click	KeyUp	
DblClick	MouseDown	
Error	MouseMove	
KeyDown	MouseUp	
KeyPress		
The Error event occurs only when an error condition triggers it.  It does not occur when a property is set or a method is invoked.
If you are using Visual Basic, it adds the DragDrop, DragOver, GotFocus, and LostFocus events.
The following list shows the custom, Image Edit control events:
Close	Scroll	
Load	SelectionRectDrawn	
MarkEnd	ToolPaletteHidden	
MarkSelect	ToolTip	
PasteCompleted	ToolSelected	

# $ K Close Event
This event occurs whenever one of the following methods is invoked:
{bmc bullet.bmp}	Display
{bmc bullet.bmp}	ClearDisplay
{bmc bullet.bmp}	DisplayBlankImage
The Close event can be used to indicate to the end user that the displayed image is about to be closed.
Applies To
Image Edit control
Syntax
Sub object_Close( )
Arguments
None
Remarks
Once a Close event occurs, any changes made to displayed images are lost unless the Save or SaveAs method is invoked.
If desired, your program can check the ImageModified property to see if any changes have been made to the displayed image.  If changes have been made, the program can be written so it prompts the end user to save the changes.
See Also
ClearDisplay method
Display
Display method
DisplayBlankImage method
ImageModified property
Save method
SaveAs method

# $ K Load Event
This event occurs immediately after the Display method is invoked.
Applies To
Image Edit control
Syntax
Sub object_Load(Zoom)
Argument
Parameter	Data Type	Setting	
Zoom	Double	Returns the default zoom factor of 100.
The Zoom parameter can also return the following values:
-1 -- Fit to width.  The image was fit to the width of the window when it was displayed.
-2 -- Fit to height.  The image was fit to the height of the window when it was displayed.
-3 -- No previously saved zoom factor.
Note:  Zoom values of -1 and -2 may not be compatible with some applications.	
Remarks
Once a Load event occurs, the visibility of the group can be changed, and other properties and methods can be set or invoked.
If desired, your program can use the returned zoom factor to set the Zoom property, or the Option parameter of the FitTo method, prior to displaying another image.
See Also
Display
Display method
FitTo method
Zoom property

# $ K MarkEnd Event
This event occurs immediately after the end user or program completes the drawing of an annotation mark.
Applies To
Image Edit control
Syntax
Sub object_MarkEnd(Left,Top,Width,Height,MarkType,GroupName)
Arguments
Parameter	Data Type	Setting	
Left	Long	The starting horizontal position of the annotation mark within the image in image pixels	
Top	Long	The starting vertical position of the annotation mark within the image in image pixels	
Width	Long	The ending horizontal position of the annotation mark within the image in image pixels	
Height	Long	The ending vertical position of the annotation mark within the image in image pixels	
MarkType	Integer	The AnnotationType of the annotation mark (except for the Select Annotations annotation type)	
GroupName	String	The name of the annotation group to which the annotation belongs	
Remarks
The MarkType parameter cannot be the Select Annotations annotation type.
A MarkEnd event does not occur if a Select Annotation rectangle is drawn (AnnotationType of 0).
See Also
Annotations
Draw method

# $ K PasteCompleted Event
This event occurs immediately after pasted image or annotation data is committed to a location on an image.  Pasted image or annotation data is committed when an end user clicks on a form, outside of a pasted image or annotation, or whenever the CompletePaste method is invoked.
Applies To
Image Edit control
Syntax
Sub object_PasteCompleted( )
Arguments
None
Remarks
The ClipboardPaste method must be invoked for this event to be triggered.
See Also
ClipboardPaste method
CompletePaste method

# $ K Scroll Event
This event occurs immediately after the end user or program scrolls an image in the control.
Applies To
Image Edit control
Syntax
Sub object_Scroll( )
Arguments
None
Remarks
None
See Also
ScrollBars property
ScrollImage method
ScrollShortcutsEnabled property
ScrollPositionX property
ScrollPositionY property

# $ K MarkSelect Event
This event occurs immediately after the end user or program selects an annotation mark.
Applies To
Image Edit control
Syntax
Sub object_MarkSelect(Button,Shift,Left,Top,Width,Height,MarkType,GroupName)
Arguments
Parameter	Data Type	Setting	
Button	Integer
(enumerated)	Specifies the mouse button pressed:
1 -- Left button
2 -- Right button
4 -- Middle button	
Shift	Integer
(enumerated)	Specifies whether the Shift, Ctrl, or Alt key is pressed:
1 -- Shift key
2 -- Ctrl key
4 -- Alt key	
Left	Long	The beginning horizontal position within the image in image pixels	
Top	Long	The beginning vertical position within the image in image pixels	
Width	Long	The ending horizontal position within the image in image pixels	
Height	Long	The ending vertical position within the image in image pixels	
MarkType	Integer	The AnnotationType of the annotation mark (except for the Select Annotations annotation type)	
GroupName	String	The name of the annotation group to which the annotation belongs	
Remarks
If multiple annotations are selected, a MarkType parameter value of 0 is returned.
The GroupName parameter is an empty string when multiple annotations are selected.
See Also
Annotations
SelectAnnotationGroup method

# $ K SelectionRectDrawn Event
This event occurs immediately after the end user presses the left mouse button, or the DrawSelectionRect method is invoked.
Applies To
Image Edit control
Syntax
Sub object_SelectionRectDrawn(Left,Top,Width,Height)
Arguments
Parameter	Data Type	Setting	
Left	Long	The beginning horizontal position within the image in image pixels relative to the upper-left corner of the Image Edit display window	
Top	Long	The beginning vertical position within the image in image pixels relative to the upper-left corner of the Image Edit display window	
Width	Long	The ending horizontal position within the image in image pixels relative to the upper-left corner of the Image Edit display window	
Height	Long	The ending vertical position within the image in image pixels relative to the upper-left corner of the Image Edit display window	
Remarks
The SelectionRectangle property must be set to True for this event to be triggered.
If the end user draws a selection rectangle of 3 pixels or less, no selection rectangle is drawn.  When this happens, the SelectionRectDrawn event is still triggered, but all of its parameters contain a value of 0.  Your program can use these 0 values to determine whether cut, copy, or delete operations should be enabled.
See Also
DrawSelectionRect method
Images
SelectionRectangle property

# $ K ToolPaletteHidden Event
This event occurs immediately after the Annotation Tool Palette has been hidden.
Applies To
Image Edit control
Syntax
Sub object_ToolPaletteHidden(Left,Top)
Arguments
Parameter	Data Type	Setting	
Left	Long	The horizontal position of the Annotation Tool Palette in pixels when it was closed, relative to the upper-left corner of the screen	
Top	Long	The vertical position of the Annotation Tool Palette in pixels when it was closed, relative to the upper-left corner of the screen	
Remarks
The Annotation Tool Palette can be hidden by invoking the HideAnnotationToolPalette method or by clicking on the Close icon on the Annotation Tool Palette caption bar.
See Also
Annotations
HideAnnotationToolPalette method

# $ K ToolTip Event
This event occurs immediately after a tool tip has been displayed on the Annotation Tool Palette.
Applies To
Image Edit control
Syntax
Sub object_ToolTip(Index)
Argument
Parameter	Data Type	Setting	
Index	Integer (enumerated)	Index value of the tool tip displayed, which corresponds to the Tool ID settings	
Remarks
The ShowAnnotationToolPalette method displays the Annotation Tool Palette.  The SelectTool method selects the annotation tool in the Annotation Tool Palette.
See Also
Annotations
SelectTool method
ShowAnnotationToolPalette method
ToolSelected event

# $ K ToolSelected Event
This event occurs immediately after the end user selects a tool from the Annotation Tool Palette.
Applies To
Image Edit control
Syntax
Sub object_ToolSelected(ToolID)
Argument
Parameter	Data Type	Setting	
ToolID	Integer (enumerated)	Identifier of the tool, which corresponds to the Tool ID settings	
Remarks
The ShowAnnotationToolPalette method does not have to be invoked to trigger this event.  The SelectTool method can be used to select the annotation tool in the Annotation Tool Palette.
See Also
Annotations
SelectTool method
ShowAnnotationToolPalette method
ToolTip event

# $ PageType Settings
The following list shows the valid PageType settings:
Setting	Description	
1	Black-and-white 	
2	Gray4	
3	Gray8	
4	Palettized4 (not available as a parameter for the ConvertPageType method unless the image presently has a 4-bit palette)	
5	Palettized8	
6	RGB24	
7	BGR24	

# $ PageType Settings
The valid PageType settings for the SaveAs method depend on the FileType setting entered.  The following list shows the valid PageType settings:
Setting	Description	Prerequisite FileType	
1	Black-and-white 	1 -- TIFF, or
3 -- BMP	
2	Gray4	1 -- TIFF	
3	Gray8	1 -- TIFF	
4	Palettized4	1 -- TIFF or
3 -- BMP	
5	Palettized8	1 -- TIFF or
3 -- BMP	
6	RGB24	1 -- TIFF	
7	BGR24	3 -- BMP	
To use a PageType setting of 4 (Palettized4), the displayed image must already be a Palettized4 image.

# $ Annotation Type Settings
The following list shows the valid AnnotationType settings:
Setting	Description	
0	None	
1	Straight Line	
2	Freehand Line	
3	Hollow Rectangle	
4	Filled Rectangle	
5	Image Embedded	
6	Image Reference	
7	Text	
8	Text Stamp	
9	Text From File	
10	Attach-a-Note	
11	Select Annotations	

# $ FileType Settings
The following list shows the valid FileType settings:
Setting	Description	
1	TIFF	
2	Not used	
3	BMP	
4	PCX (read only)	
5	DCX (read only)	
6	JPG (read only)	
7	XIF (read only)	
Displayed file types of PCX, DCX, JPG, or XIF must be
saved using a FileType setting of 1 (TIFF) or 3 (BMP).
If a multipage image file (DCX, TIFF, or XIF) is saved as a BMP file,
only the page currently being displayed is saved to the new file.

# $ CompressionType Settings
The following list shows the valid CompressionType settings:
Setting	Description	
1	No compression	
2	Group3(1D)	
3	Group3(Modified Huffman)	
4	PackBits	
5	Group4(2D)	
6	JPEG	
7	Not used	
8	Group3 (2D)	
9	LZW	
BMP files must be saved using a CompressionType setting of 1.
JPG files must be saved using a CompressionType setting of 6.

# $ CompressionInfo Settings
The following list shows the valid CompressionInfo settings (bit-wise values):
Setting	Description	
0	No compression -- If CompressionType is set to 1 (no compression)
Default compression -- If CompressionType is set to a value other than 1	
1	EOL	
2	Packed Lines	
4	Prefixed EOL	
8	Compressed LTR	
16	Expand LTR	
32	Negate	
64	High Compression/High Quality (JPEG compression only)	
128	High Compression/Medium Quality (JPEG compression only)	
256	High Compression/Low Quality (JPEG compression only)	
512	Medium Compression/High Quality (JPEG compression only)	
1024	Medium Compression/Medium Quality (JPEG compression only)	
2048	Medium Compression/Low Quality (JPEG compression only)	
4096	Low Compression/High Quality (JPEG compression only)	
8192	Low Compression/Medium Quality (JPEG compression only)	
16384	Low Compression/Low Quality (JPEG compression only)	
BMP and other uncompressed files must be saved using a CompressionInfo setting of 0.

# $ Tool ID Settings
The following list shows the valid Tool ID settings:
Parameter	Data Type	Setting	Description	
 ToolID	Integer
(enumerated)	0
1
2
3
4
5
6
7
8
9
10	No Tool
Select Annotations
Freehand Line
Highlighter
Straight Line
Hollow Rectangle
Filled Rectangle
Text
Attach-a-Note
Text From File
Rubber Stamp	

# K $ Annotation Tool Palette
Click on the components of the tool palette to see an explanation of each one.
{bmc palette.shg}

# $ Select Annotations
The only tool that does not draw an annotation, the Select Annotations tool is used to select single or multiple annotation marks.  You can select annotation marks by clicking on them, or by dragging a selection rectangle around them.

# $ Highlighter
The Highlighter tool is used to draw a transparent, filled rectangle for highlighting emphasis.

# $ Hollow Rectangle
The Hollow Rectangle tool is used to place a border around areas of an image for emphasis.

# $ Text
The Text tool is used to enter text directly on an image.

# $ Text From File
The Text From File tool is used to enter text from a file onto an image.

# $ Freehand Line
The Freehand Line tool is used to draw a freehand line on a section of text or a portion of an image for emphasis.

# $ Straight Line
The Straight Line tool is used to underline text, demarcate a section of a page, or draw callout lines.

# $ Filled Rectangle
The Filled Rectangle tool is used to create a color background for text annotations or to hide a portion of an image.

# $ Attach-a-Note
The Attach-a-Note tool is used to enter text into a background rectangle on an image.

# $ Rubber Stamp
The Rubber Stamp tool is used to place an image or text stamp onto an image.