From Xojo Documentation

Revision as of 20:24, 23 July 2021 by Gperlman (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
You are currently browsing the old Xojo documentation site. Please visit the new Xojo documentation site!

Class (inherits from DesktopUIControl)

New in 2021r3

Used to display an image in a window.

Closing FocusLost MouseExit
ConstructContextualMenu FocusReceived MouseMove
ContextualMenuItemSelected KeyDown MouseUp
DragEnter KeyUp MouseWheel
DragExit MouseDown Opening
DragOver MouseDrag
DropObject MouseEnter

Active fa-lock-32.png LockBottom TabIndex
AllowAutoDeactivate LockLeft Tooltip
AllowTabStop LockRight Top
Enabled LockTop Transparent
Handle fa-lock-32.png MouseCursor Visible
Height Name fa-lock-32.png Width
Image PanelIndex Window fa-lock-32.png
Index fa-lock-32.png Parent
Left Scope fa-lock-32.png


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


The following line of code in the Opening event of a DesktopImageViewer displays a picture of a prancing stallion. The image had been added to the Project Editor.

Me.Image = Ferrari

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

In the Opening event handler of the DesktopImageViewers, 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.


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
Return True // Allow the drag

See Also

DesktopUIControl class; DesktopCanvas control.