Differences

This shows you the differences between two versions of the page.

Link to this comparison view

desktop:imagewell [2018/04/14 16:09] (current)
Line 1: Line 1:
 +==== Enumerations ====
 +^ Name      ^ Values ​      ^
 +|  | This class exposes no enumerations. |
 +
 +==== Constants ====
 +^ Name      ^ Type     ^ Value       ^
 +|  |  | This class exposes no constants. |
 +
 +==== Events ====
 +^ Definition ​     ^ Description ​      ^
 +| Click() | Fires when the image is clicked. |
 +| ClickOpen() | Fires when the Open button is clicked. |
 +| ValueChanged() | Fires when the image is changed. |
 +
 +==== Methods ====
 +^ Definition ​     ^ Description ​      ^
 +|  | This class does not expose any methods. |
 +
 +==== Properties ====
 +^ Name      ^ Type       ^ Default Value       ^ Description ​      ^
 +| AllowDrag | [[http://​developer.xojo.com/​boolean|Boolean]] | False | Determines whether control supports dragging the image around within the viewable area. |
 +| BGColor | [[http://​developer.xojo.com/​color|Color]] | &​c000000 | The background color drawn behind the image. |
 +| Border | [[http://​developer.xojo.com/​boolean|Boolean]] | False | Determines whether a border is drawn around the class. |
 +| BorderColor | [[http://​developer.xojo.com/​color|Color]] | &​c000000 | The border color of the class. |
 +| CanZoomIn | [[http://​developer.xojo.com/​boolean|Boolean]] | False (Read-Only) | Returns whether the image can be zoomed in further. |
 +| CanZoomOut | [[http://​developer.xojo.com/​boolean|Boolean]] | False (Read-Only) | Returns whether image can be zoomed out further. |
 +| Caption | [[http://​developer.xojo.com/​string|String]] | ""​ | Text to display in place of the file name for the caption. |
 +| CaptionBGColor | [[http://​developer.xojo.com/​color|Color]] | &​c000000 | The color drawn behind the caption text and Open/Zoom buttons. |
 +| CaptionForeColor | [[http://​developer.xojo.com/​color|Color]] | &​c000000 | The color used to draw the caption and Open/Zoom buttons. |
 +| CaptionOpacity | [[http://​developer.xojo.com/​integer|Integer]] | 0 | The visibility of the caption bar. 0-255 |
 +| EnableKeyboard | [[http://​developer.xojo.com/​boolean|Boolean]] | False | Determines whether the user's keyboard controls the class. |
 +| GridColor | [[http://​developer.xojo.com/​color|Color]] | &​c000000 | The color of the overlay grid. |
 +| GridOpacity | [[http://​developer.xojo.com/​integer|Integer]] | 0 | The visibility of the overlay grid. 0-255 |
 +| GridSize | [[http://​developer.xojo.com/​integer|Integer]] | 5 | The size of the overlay grid squares in pixels. |
 +| Image | [[http://​developer.xojo.com/​picture|Picture]] | Nil | The image displayed within the class. |
 +| ImageX | [[http://​developer.xojo.com/​integer|Integer]] | 0 | The current X position of the image within the viewable area. |
 +| ImageY | [[http://​developer.xojo.com/​integer|Integer]] | 0 | The current Y position of the image within the viewable area. |
 +| LargeKeyboardMovement | [[http://​developer.xojo.com/​integer|Integer]] | 10 | The distance in pixels that the image is moved when using Shift+Arrow Keys to move the image. |
 +| ShowCaption | [[http://​developer.xojo.com/​boolean|Boolean]] | False | Determines whether the caption bar is visible. |
 +| ShowCaptionOnHover | [[http://​developer.xojo.com/​boolean|Boolean]] | False | 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 | [[http://​developer.xojo.com/​boolean|Boolean]] | True | Determines whether the overlay grid is visible. |
 +| ShowOpenInCaption | [[http://​developer.xojo.com/​boolean|Boolean]] | False | Hide/Show the Open button in the caption bar. |
 +| ShowZoomInCaption | [[http://​developer.xojo.com/​boolean|Boolean]] | False | Hide/Show the Zoom buttons in the caption bar. |
 +| SmallKeyboardMovement | [[http://​developer.xojo.com/​integer|Integer]] | 1 | Sets the distance in pixels that the image within the viewable area is moved while using the keyboard’s arrow keys. |
 +| SnapToGrid | [[http://​developer.xojo.com/​boolean|Boolean]] | False | Sets whether the image contained within the viewable area will snap to the overlay grid or move freely. |
 +| ZoomLevel | [[http://​developer.xojo.com/​integer|Integer]] | 100 | Sets/​Returns the current zoom level of the image contained within the viewable area. |
 +
 +==== Examples ====
 +There are currently no examples for this class.