CoreDragUIOverride CoreDragUIOverride CoreDragUIOverride CoreDragUIOverride Class

Definition

Contains methods and properties for customizing the drag and drop UI.

public : sealed class CoreDragUIOverride : ICoreDragUIOverridepublic sealed class CoreDragUIOverride : ICoreDragUIOverridePublic NotInheritable Class CoreDragUIOverride Implements ICoreDragUIOverride// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

Caption Caption Caption Caption

Gets or sets the caption for the drag UI.

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 for the drag UI.

IsCaptionVisible IsCaptionVisible IsCaptionVisible IsCaptionVisible

Gets or sets if the caption for the drag UI is visible.

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 is visible; otherwise, false.

IsContentVisible IsContentVisible IsContentVisible IsContentVisible

Gets or sets whether the drag content is visible.

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 drag content is visible; otherwise, false.

IsGlyphVisible IsGlyphVisible IsGlyphVisible IsGlyphVisible

Gets or sets whether the glyph is visible.

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 visible; otherwise, false.

Methods

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

Clears all existing custom UI overrides.

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

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

Sets custom drag UI content using a software bitmap.

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 custom drag UI content.

See Also

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

Sets custom drag UI content using a software bitmap.

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 custom UI drag content.

anchorPoint
Point Point Point Point

The relative position of the drag visual from the pointer. The anchor point cannot be outside of the content. For example, if the anchor point is (50, 50) and the position of the pointer is (x, y), the top left corner for the visual will be (x - 50, y - 50).

See Also