Xojo Documentation Xojo Documentation

Class (inherits from RectControl)

Used to display an image in a window.

Events

Close DropObject MouseMove ConstructContextualMenu KeyDown MouseUp ContextualMenuAction KeyUp MouseWheel DragEnter MouseDown Open DragExit MouseEnter DragOver MouseExit

Properties

Active LockLeft TabIndex AllowAutoDeactivate LockRight Tooltip AllowTabStop LockTop Top Enabled MouseCursor Transparent Handle MouseX TrueWindow Height MouseY Visible Image Name Width Index PanelIndex Window Left Parent LockBottom Scope

Notes

Refer to the Picture class to see what image formats are supported for each platform.

Examples

The following line of code in the ImageWell’s Open event displays a picture of a prancing stallion in the ImageWell. The image had been added to the Project Editor.

Me.Image = Ferrari

The following example implements drag and drop between two ImageWells, a jpeg file dragged from the desktop to either ImageWell, and from one ImageWell to the other.

In the Open event handler of the ImageWells, the two statements tell the controls to accept either a dragged picture or a dragged file of type jpeg. The file type "image/jpeg" was defined previously in the File Type Sets Editor.

Me.AcceptPictureDrop
Me.AcceptFileDrop("image/jpeg")

The DropObject event handler is:

Sub DropObject(obj As DragItem)
If obj.PictureAvailable Then
Me.Image = obj.Picture
ElseIf obj.FolderItemAvailable Then
Me.Image = Picture.Open(obj.FolderItem)
End If
End Sub

The MouseDown event uses the DragItem constructor. It is:

Var d As DragItem
d = New DragItem(Self, Me.Left, Me.Top, Me.Width, Me.Height)
d.Picture = Me.Image
d.Drag
Return True // Allow the drag

See Also

RectControl class; Canvas control.