---
title: "DropDestination (Generic)"
canonical: "https://docs.cuesystem.com/space/CVCGC/419528724/DropDestination%20(Generic)"
format: markdown
---
> Macro (toc)
---
# Description
This object cooperates with DragSource. Please see the [Description section of DragSource](https://cue.atlassian.net/wiki/spaces/GOC/pages/419987464/DragSource#Description) for understanding how it works.
This object has its own BackgroundColor and Background Picture, which can be fitted to the object using methods described in section PictureBox. In this way, you can graphically customize your object.
If DragSource is dropped to DropDestinationt then some data from DragSource are used in this object for indication. First of all source picture is displayed over BackgroundPicture and it is zoomed automatically. Zoom factor is defined by property and it allows to adjust the source picture to destination object size. Text from DragSource can be displayed too with parameters set by properties (font, color, alignment, offsets, etc...).
# Properties
| | | | | |
| --- | --- | --- | --- | --- |
| Property Name | Data Type | Allowed Values | Default Value | Description |
| Behavior |
| Join | | Joins created for DragSource and DropDestination objects joining. | Nothing | It is used for joining DragSource and DropDestination objects.
It must be used for proper functionality. |
| Disable drop | Boolean | True
False | False | Enables or disables for joining DragSource and DropDestination objects. |
| Appearance |
| BackgroundColor | Long | Any | 0 (transparent) | Color of background |
| Fitting | Long | 0 = None
1 = Fit Object to Content 2 = Fit Content to Object 3 = Center Content
4 = Fit Content Proportionally
5 = Fill Object Proportionally | 0 | Method of picture fitting.
For more details about fitting methods please see object PictureBox. |
| Picture | AddressOf
_Picture | | Nothing | |
| DragSource Picture |
| Align | Long | Left-Top
Left-Middle
Left-Bottom
Center-Top
Center-Middle
Center-Bottom
Right-Top
Right-Middle
Right-Bottom | Center-Middle | Horizontal and vertical align of picture. |
| OffsetX | Long | Any | 0 | Horizontal offset of DragSource picture in pixels. |
| OffsetY | Long | Any | 0 | Vertical offset of DragSource picture in pixels. |
| Zoom | Double | Any non-negative | 1.0 | Zoom factor allows to adjust source picture to destination object size. |
| DragSource Text |
| Align | Long | Left-Top
Left-Middle
Left-Bottom
Center-Top
Center-Middle
Center-Bottom
Right-Top
Right-Middle
Right-Bottom | Center-Middle | Horizontal and vertical align of text. |
| Color | Long | Any | _COLOR_
BLACK | Color of DragSource text |
| Font | AddressOf
_Font | Any | fntDefault16 | DragSource text font. fntDefault16 is Verdana 16 pixels high. |
| LineSpacing | Double | Any non-negative | 1.2 | Vertical distance between two lines of multiline content Text. The value is multiple of the font height. |
| OffsetX | Long | Any | 0 | Horizontal offset of DragSource text in pixels. |
| OffsetY | Long | Any | 0 | Vertical offset of DragSource text in pixels. |
| Show | Boolean | True
False | True | Enables or disables to show source text. |
# Functions
## SetBackgroundColor
This function sets BackgroundColor to newbackgroundcolor. Function returns True.
#### Syntax
```visualbasic
Function SetBackgroundColor(newbackgroundcolor As Long) As Boolean
```
## GetBackgroundColor
This function returns current BackgroundColor.
#### Syntax
```visualbasic
Function GetBackgroundColor() As Long
```
## SetFitting
This function sets Fitting of Picture to newfitting. Possible parameters are
- 0 = None
- 1 = Fit Object to Content
- 2 = Fit Content to Object
- 3 = Center Content
- 4 = Fit Content Proportionally
- 5 = Fill Object Proportionally
Function returns True if parameter is 0 to 5, otherwise it returns False.
#### Syntax
```visualbasic
Function SetFitting(newfitting As Long) As Boolean
```
## GetFitting
This function returns current Fitting method.
#### Syntax
```visualbasic
Function GetFitting() As Long
```
## SetPicture
This function sets Picture to newpicture. Function returns True.
#### Syntax
```visualbasic
Function SetPicture(newpicture As AddressOf _Picture) As Boolean
```
## GetPicture
This function returns address of current Picture.
#### Syntax
```visualbasic
Function GetPicture() As AddressOf _Picture
```
## SetSource
This function sets Source to newsourceid. If newsourceid = 0, then not joining DraqSource. Function returns True.
#### Syntax
```visualbasic
Function SetSource(newsourceid As Long)
```
## GetSource
This function returns current Source.
#### Syntax
```visualbasic
Function GetSource() As Long
```
## SetSourcePictureAlign
This function sets SourcePictureAlign to newsourcepicturealign. You can use meaningful BitOr combinations of the following constants as parameters
- _TEXT_ALIGNLEFT, _TEXT_ALIGNHCENTER, _TEXT_ALIGNRIGHT
- _TEXT_ALIGNTOP, _TEXT_ALIGNVCENTER, _TEXT_ALIGNBOTTOM
Function returns True on success or False if an error occurs.
#### Syntax
```visualbasic
Function SetSourcePictureAlign(newsourcepicturealign As Long) As Boolean
```
## GetSourcePictureAlign
This function returns current SourcePictureAlign.
#### Syntax
```visualbasic
Function GetSourcePictureAlign() As Long
```
## SetSourcePictureOffsetX
This function sets SourcePictureOffsetX to newsourcepictureoffsetx. Function returns True.
#### Syntax
```visualbasic
Function SetSourcePictureOffsetX(newsourcepictureoffsetx As Long) As Boolean
```
## GetSourcePictureOffsetX
This function returns current SourcePictureOffsetX.
#### Syntax
```visualbasic
Function GetSourcePictureOffsetX() As Long
```
## SetSourcePictureOffsetY
This function sets SourcePictureOffsetY to newsourcepictureoffsety. Function returns True.
#### Syntax
```visualbasic
Function SetSourcePictureOffsetY(newsourcepictureoffsety As Long) As Boolean
```
## GetSourcePictureOffsetY
This function returns current SourcePictureOffsetX.
#### Syntax
```visualbasic
Function GetSourcePictureOffsetY() As Long
```
## SetSourcePictureOpacity
This function sets SourcePictureOpacity to newsourcepictureopacity. Function returns True.
#### Syntax
```visualbasic
Function SetSourcePictureOpacity(newsourcepictureopacity As Byte) As Boolean
```
## GetSourcePictureOpacity
This function returns current SourcePictureOpacity.
#### Syntax
```visualbasic
Function GetSourcePictureOpacity() As Byte
```
## SetSourcePictureZoom
This function sets SourcePictureZoom to newsourcepicturezoom. Function returns True if newsourcepicturezoom >= 0, otherwise it returns False.
#### Syntax
```visualbasic
Function SetSourcePictureZoom(newsourcepicturezoom As Double) As Boolean
```
## GetSourcePictureZoom
This function returns current SourcePictureZoom.
#### Syntax
```visualbasic
Function GetSourcePictureZoom() As Double
```
## SetSourceTextAlign
This function sets SourceTextAlign to newsourcetextalign. You can use meaningful BitOr combinations of the following constants as parameters
- _TEXT_ALIGNLEFT, _TEXT_ALIGNHCENTER, _TEXT_ALIGNRIGHT
- _TEXT_ALIGNTOP, _TEXT_ALIGNVCENTER, _TEXT_ALIGNBOTTOM
Function returns True on success or False if an error occurs.
#### Syntax
```visualbasic
Function SetSourceTextAlign(newsourcetextalign As Long) As Boolean
```
## GetSourceTextAlign
This function returns current SourceTextAlign.
#### Syntax
```visualbasic
Function GetSourceTextAlign() As Long
```
## SetSourceTextColor
This function sets SourceTextColor to newsourcetextcolor. Function returns True.
#### Syntax
```visualbasic
Function SetSourceTextColor(newsourcetextcolor As Long) As Boolean
```
## GetSourceTextColor
This function returns current SourceTextColor.
#### Syntax
```visualbasic
Function GetSourceTextColor() As Long
```
## SetSourceTextFont
This function sets SourceTextFont to newsourcetextfont. Function returns True.
#### Syntax
```visualbasic
Function SetSourceTextFont(newsourcetextfont As AddressOf _Font) As Boolean
```
## GetSourceTextFont
This function returns address of current SourceTextFont.
#### Syntax
```visualbasic
Function GetSourceTextFont() As AddressOf _Font
```
## SetSourceTextLineSpacing
This function sets SourceTextLineSpacing to newsourcetextlinespacing. Function returns True if newsourcetextlinespacing >= 0, otherwise it returns False.
#### Syntax
```visualbasic
Function SetSourceTextLineSpacing(newsourcetextlinespacing As Double) As Boolean
```
## GetSourceTextLineSpacing
This function returns current SourceTextLineSpacing.
#### Syntax
```visualbasic
Function GetSourceTextLineSpacing() As Double
```
## SetSourceTextOffsetX
This function sets SourceTextOffsetX to newsourcetextoffsetx. Function returns True.
#### Syntax
```visualbasic
Function SetSourceTextOffsetX(newsourcetextoffsetx As Long) As Boolean
```
## GetSourceTextOffsetX
This function returns current SourceTextOffsetX.
#### Syntax
```visualbasic
Function GetSourceTextOffsetX() As Long
```
## SetSourceTextOffsetY
This function sets SourceTextOffsetY to newsourcetextoffsety. Function returns True.
#### Syntax
```visualbasic
Function SetSourceTextOffsetY(newsourcetextoffsety As Long) As Boolean
```
## GetSourceTextOffsetY
This function returns current SourceTextOffsetY.
#### Syntax
```visualbasic
Function GetSourceTextOffsetY() As Long
```
## SetSourceTextShow
This function sets SourceTextShow to newsourcetextshow. Function returns True.
#### Syntax
```visualbasic
Function SetSourceTextShow(newsourcetextshow As Boolean) As Boolean
```
## GetSourceTextShow
This function returns current SourceTextShow.
#### Syntax
```visualbasic
Function GetSourceTextShow() As Boolean
```
## BringToFrontZOrder
This function temporarily brings the object to the very top position.
#### Syntax
```visualbasic
Function BringToFrontZOrder()
```
## RestoreZOrder
This function restores object’s z-order to value defined in design mode.
#### Syntax
```visualbasic
Function RestoreZOrder()
```
## SetDisableDrop
This function sets DisableDrop to disabled. Function returns True.
#### Syntax
```visualbasic
Function SetDisableDrop(disabled As Boolean) As Boolean
```
## GetDisableDrop
This function returns current DisableDrop.
#### Syntax
```visualbasic
Function GetDisableDrop() As Boolean
```
## SetDragSourceText
This function sets drag source text to newtext. Function returns True.
#### Syntax
```visualbasic
Function SetDragSourceText(newtext As Text) As Boolean
```
## GetDragSourceText
This function returns current drag source text.
#### Syntax
```visualbasic
Function GetDragSourceText() As AddressOf Text
```
# Events
## OnDropSource
This event is generated when object DragSource is dropped over the object DropDestination. ObjectID of the object DragSource is delivered in the parameter sourceid.
#### Syntax
```visualbasic
Event OnDropSource As Process(sourceid As Long)
```
## OnTouch
This event is generated when the object is touched.
#### Syntax
```visualbasic
Event OnTouch As Process()
```