DragUIOverride DragUIOverride DragUIOverride DragUIOverride Class

Definition

Provides the visual representation of the data being dragged during a drag-and-drop operation, including feedback from the drop target.

public : sealed class DragUIOverride : IDragUIOverridepublic sealed class DragUIOverride : IDragUIOverridePublic NotInheritable Class DragUIOverride Implements IDragUIOverride// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

An instance of this class is passed to the DragEventHandler delegate in the DragEventArgs.DragUIOverride property.

Properties

Caption Caption Caption Caption

Gets or sets the caption text that overlays the drag visual. The text typically describes the drag-and-drop action.

public : PlatForm::String Caption { get; set; }public string Caption { get; set; }Public ReadWrite Property Caption As string// This API is not available in Javascript.
Value
PlatForm::String string string string

The caption text that overlays the drag visual.

IsCaptionVisible IsCaptionVisible IsCaptionVisible IsCaptionVisible

Gets or sets a value that indicates whether the caption text is shown.

public : PlatForm::Boolean IsCaptionVisible { get; set; }public bool IsCaptionVisible { get; set; }Public ReadWrite Property IsCaptionVisible As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

true if the caption text is shown; otherwise, false.

IsContentVisible IsContentVisible IsContentVisible IsContentVisible

Gets or sets a value that indicates whether the content of the drag visual is shown.

public : PlatForm::Boolean IsContentVisible { get; set; }public bool IsContentVisible { get; set; }Public ReadWrite Property IsContentVisible As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

true if the content is shown; otherwise, false.

IsGlyphVisible IsGlyphVisible IsGlyphVisible IsGlyphVisible

Gets or sets a value that indicates whether the glyph is shown.

public : PlatForm::Boolean IsGlyphVisible { get; set; }public bool IsGlyphVisible { get; set; }Public ReadWrite Property IsGlyphVisible As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

true if the glyph is shown; otherwise, false.

Methods

Clear() Clear() Clear() Clear()

Clears the content, caption, and glyph of the drag visual.

public : void Clear()public void Clear()Public Function Clear() As void// This API is not available in Javascript.

SetContentFromBitmapImage(BitmapImage) SetContentFromBitmapImage(BitmapImage) SetContentFromBitmapImage(BitmapImage) SetContentFromBitmapImage(BitmapImage)

Creates a visual element from a provided BitmapImage to represent the dragged data in a drag-and-drop operation.

public : void SetContentFromBitmapImage(BitmapImage bitmapImage)public void SetContentFromBitmapImage(BitmapImage bitmapImage)Public Function SetContentFromBitmapImage(bitmapImage As BitmapImage) As void// This API is not available in Javascript.
Parameters
bitmapImage
BitmapImage BitmapImage BitmapImage BitmapImage

The source image used to create the drag visual.

See Also

SetContentFromBitmapImage(BitmapImage, Point) SetContentFromBitmapImage(BitmapImage, Point) SetContentFromBitmapImage(BitmapImage, Point) SetContentFromBitmapImage(BitmapImage, Point)

Creates a visual element from a provided BitmapImage to represent the dragged data in a drag-and-drop operation, and sets the relative position of the visual from the pointer.

public : void SetContentFromBitmapImage(BitmapImage bitmapImage, Point anchorPoint)public void SetContentFromBitmapImage(BitmapImage bitmapImage, Point anchorPoint)Public Function SetContentFromBitmapImage(bitmapImage As BitmapImage, anchorPoint As Point) As void// This API is not available in Javascript.
Parameters
bitmapImage
BitmapImage BitmapImage BitmapImage BitmapImage

The source image used to create the drag visual.

anchorPoint
Point Point Point Point

The relative position of the drag visual from the pointer.

See Also

SetContentFromSoftwareBitmap(SoftwareBitmap) SetContentFromSoftwareBitmap(SoftwareBitmap) SetContentFromSoftwareBitmap(SoftwareBitmap) SetContentFromSoftwareBitmap(SoftwareBitmap)

Creates a visual element from a provided SoftwareBitmap to represent the dragged data in a drag-and-drop operation.

public : void SetContentFromSoftwareBitmap(SoftwareBitmap softwareBitmap)public void SetContentFromSoftwareBitmap(SoftwareBitmap softwareBitmap)Public Function SetContentFromSoftwareBitmap(softwareBitmap As SoftwareBitmap) As void// This API is not available in Javascript.
Parameters
softwareBitmap
SoftwareBitmap SoftwareBitmap SoftwareBitmap SoftwareBitmap

The source image used to create the drag visual.

See Also

SetContentFromSoftwareBitmap(SoftwareBitmap, Point) SetContentFromSoftwareBitmap(SoftwareBitmap, Point) SetContentFromSoftwareBitmap(SoftwareBitmap, Point) SetContentFromSoftwareBitmap(SoftwareBitmap, Point)

Creates a visual element from a provided SoftwareBitmap to represent the dragged data in a drag-and-drop operation, and sets the relative position of the visual from the pointer.

public : void SetContentFromSoftwareBitmap(SoftwareBitmap softwareBitmap, Point anchorPoint)public void SetContentFromSoftwareBitmap(SoftwareBitmap softwareBitmap, Point anchorPoint)Public Function SetContentFromSoftwareBitmap(softwareBitmap As SoftwareBitmap, anchorPoint As Point) As void// This API is not available in Javascript.
Parameters
softwareBitmap
SoftwareBitmap SoftwareBitmap SoftwareBitmap SoftwareBitmap

The source image used to create the drag visual.

anchorPoint
Point Point Point Point

The relative position of the drag visual from the pointer.

See Also

See Also