DragUIOverride Class

Definition

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

Equivalent WinUI class: Microsoft.UI.Xaml.DragUIOverride.

public ref class DragUIOverride sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
class DragUIOverride sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.WebHostHidden]
class DragUIOverride sealed
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
public sealed class DragUIOverride
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.WebHostHidden]
public sealed class DragUIOverride
Public NotInheritable Class DragUIOverride
Inheritance
DragUIOverride
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

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

Properties

Caption

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

Equivalent WinUI property: Microsoft.UI.Xaml.DragUIOverride.Caption.

IsCaptionVisible

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

Equivalent WinUI property: Microsoft.UI.Xaml.DragUIOverride.IsCaptionVisible.

IsContentVisible

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

Equivalent WinUI property: Microsoft.UI.Xaml.DragUIOverride.IsContentVisible.

IsGlyphVisible

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

Equivalent WinUI property: Microsoft.UI.Xaml.DragUIOverride.IsGlyphVisible.

Methods

Clear()

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

Equivalent WinUI method: Microsoft.UI.Xaml.DragUIOverride.Clear.

SetContentFromBitmapImage(BitmapImage)

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

Equivalent WinUI method: Microsoft.UI.Xaml.DragUIOverride.SetContentFromBitmapImage.

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.

Equivalent WinUI method: Microsoft.UI.Xaml.DragUIOverride.SetContentFromBitmapImage.

SetContentFromSoftwareBitmap(SoftwareBitmap)

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

Equivalent WinUI method: Microsoft.UI.Xaml.DragUIOverride.SetContentFromSoftwareBitmap.

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.

Equivalent WinUI method: Microsoft.UI.Xaml.DragUIOverride.SetContentFromSoftwareBitmap.

Applies to

See also