# GraffitiImageWell
Class Inherits GraffitiSuite.BaseCanvas
## About
GraffitiImageWell allows developers to quickly and easily incorporate an Image-Viewer UI in to their application, potentially saving 100s of hours of development time.
**
Features:
**
*
Built-in file loading
*
Built-in Zoom
*
Built-in image dragging
*
Animated caption bar for added style
*
Fully customizable colors and opacities
## Preview
Previous
Next
## Compatibility
### Framework API Version
| 1.0 | 2.0 |
| :---: | :---: |
| True | True |
### Desktop
| 32-Bit | 64-Bit |
| :---: | :---: |
| True | True |
## Event Definitions
| Name | Parameters | Return Type | Description |
| --- | :---: | :---: | --- |
| Click | (None) | (None) | Fires when the image is clicked. |
| ClickOpen | (None) | (None) | Fires when the Open button is clicked. |
| ValueChanged | (None) | (None) | Fires when the image is changed. |
## Methods
| Name | Parameters | Return Type | Description |
| --- | :---: | :---: | --- |
| CanZoomIn | (None) | Boolean | Returns whether the control can safely zoom in to the image further. |
| CanZoomOut | (None) | Boolean | Returns whether the control can safely zoom out of the image further. |
## Properties
| Name | Type | Default Value | Description |
| --- | :---: | :---: | --- |
| AllowDrag | Boolean | (None) | Determines whether control supports dragging the image around within the viewable area. |
| BGColor | Color | (None) | The background color drawn behind the image. |
| Border | Boolean | (None) | Determines whether a border is drawn around the class. |
| BorderColor | Color | (None) | The border color of the class. |
| Caption | String | (None) | Text to display in place of the file name for the caption. |
| CaptionBGColor | Color | (None) | The color drawn behind the caption text and Open/Zoom buttons. |
| CaptionForeColor | Color | (None) | The color used to draw the caption and Open/Zoom buttons. |
| CaptionOpacity | Integer | (None) | The visibility of the caption bar. 0-255 |
| EnableKeyboardMovement | Boolean | (None) | Determines whether the keyboard can be used to move the selected image. |
| GridColor | Color | (None) | The color of the overlay grid. |
| GridOpacity | Integer | (None) | The visibility of the overlay grid. 0-255 |
| GridSize | Integer | (None) | The size of the overlay grid squares in pixels. |
| Image | Picture | (None) | The image displayed within the class. |
| ImageX | Integer | (None) | The current X position of the image within the viewable area. |
| ImageY | Integer | (None) | The current Y position of the image within the viewable area. |
| LargeKeyboardMovement | Integer | (None) | The distance in pixels that the image is moved when using Shift+Arrow Keys to move the image. |
| ShowCaption | Boolean | (None) | Determines whether the caption bar is visible. |
| ShowCaptionOnHover | Boolean | (None) | When set to True, the caption will appear when the mouse is over the control. When set to False, the caption will either be always visible or always invisible. |
| ShowGrid | Boolean | (None) | Determines whether the overlay grid is visible. |
| ShowOpenInCaption | Boolean | (None) | Hide/Show the Open button in the caption bar. |
| ShowZoomInCaption | Boolean | (None) | Hide/Show the Zoom buttons in the caption bar. |
| SmallKeyboardMovement | Integer | (None) | Sets the distance in pixels that the image within the viewable area is moved while using the keyboard’s arrow keys. |
| SnapToGrid | Boolean | (None) | Sets whether the image contained within the viewable area will snap to the overlay grid or move freely. |
| ZoomLevel | Integer | (None) | Sets/Returns the current zoom level of the image contained within the viewable area. |
