Table of Contents

Class RenderControlDragEventArgs

Namespace
OFT.Rendering.Control
Assembly
OFT.Rendering.dll

Data of a drag-and-drop event of IRenderControl.

Added in ATAS 8.0.15.

public class RenderControlDragEventArgs : EventArgs
Inheritance
object
EventArgs
RenderControlDragEventArgs
Extension Methods

Constructors

RenderControlDragEventArgs(object?, int, int, int)

Creates drag event data with empty Message and MessageReplacementToken.

public RenderControlDragEventArgs(object? data, int keyState, int x, int y)

Parameters

data object

Framework data object of the operation.

keyState int

State of the modifier keys and mouse buttons.

x int

X coordinate of the pointer.

y int

Y coordinate of the pointer.

RenderControlDragEventArgs(object?, int, int, int, string?, string?)

Creates drag event data.

public RenderControlDragEventArgs(object? data, int keyState, int x, int y, string? message, string? messageReplacementToken)

Parameters

data object

Framework data object of the operation.

keyState int

State of the modifier keys and mouse buttons.

x int

X coordinate of the pointer.

y int

Y coordinate of the pointer.

message string

Optional message describing the drop.

messageReplacementToken string

Optional token in message to replace with the target name.

Properties

Data

Gets the framework data object of the operation (a WinForms data object in classic WPF, an Avalonia data transfer in ATAS X). Use GetData(object, Type) to extract the dragged object.

public object? Data { get; }

Property Value

object

Effects

Gets or sets the effect of the operation. Handlers of the enter, over and drop events set it to accept (Copy and others) or reject (None) the drop; in classic WPF the value is passed back to the drag source.

public RenderControlDragDropEffects Effects { get; set; }

Property Value

RenderControlDragDropEffects

KeyState

Gets the state of the modifier keys and mouse buttons as WinForms/Win32 MK_* bit flags (4 = Shift, 8 = Ctrl, 32 = Alt; on macOS in ATAS X, Command sets the Ctrl bit). In ATAS X only the modifier key bits are set.

public int KeyState { get; }

Property Value

int

Message

Gets or sets an optional message describing the drop. The built-in render controls do not display it.

public string? Message { get; set; }

Property Value

string

MessageReplacementToken

Gets or sets an optional token in Message to replace with the target name. The built-in render controls do not use it.

public string? MessageReplacementToken { get; set; }

Property Value

string

X

Gets the X coordinate of the pointer: screen coordinates in classic WPF, canvas pixels in ATAS X.

public int X { get; }

Property Value

int

Y

Gets the Y coordinate of the pointer: screen coordinates in classic WPF, canvas pixels in ATAS X.

public int Y { get; }

Property Value

int